QuickStart Guide
...
Industrial Systems Connection ...
Opto Devices

Opto22 MMIO Protocol Ethernet (Gen1)

5min

Review the following information for setting up and configuring the Opto22 MMIO Protocol Ethernet (Gen1) driver.

Litmus Edge Compatible Series

Compatibility parameter

Compatible items

Driver type

Ethernet

Validated devices/series

OPTO22 SNAP PAC System

To set up and configure this device in Litmus Edge, you will need to do the following:

  • Step 1: Set up and Configure the PLC Device
  • Step 2: Set up the PLC Device in Litmus Edge DeviceHub
  • Step 3: Configure the List of Registers

Step 1: Set up and Configure the PLC Device

If the device is configured for Ethernet access, find its network parameters. Otherwise, use PLC software on your computer to configure your device for Ethernet access.

Step 2: Set up the PLC Device in Litmus Edge DeviceHub

Configure the following parameters when you Connect a Device with this driver. Update default values to the specific setup of your device.



Parameter

Value

Type

Opto Devices

Driver

Opto22 MMIO Protocol Ethernet (Gen1)

Network Address

The device address you defined during Step 1

Port

2001

Step 3: Configure the List of Registers

When you Add Tags to the connected device, refer to the following register table and tag parameters. You can also Search for Pre-defined Device Tags for the device.

Refer to the following additional resources:

Register Table



Name

Value Types

Address Format

Min Address

Max Address

STATE

bit

DD

0

63

ONLATCH

bit

DD

0

63

OFFLATCH

bit

DD

0

63

ACTIVECOUNTER

bit

DD

0

63

ONLATCH_READCLEAR

bit

DD

0

63

OFFLATCH_READCLEAR

bit

DD

0

63

HDD_STATE

bit

DDdd

0

1531

HDD_ONLATCH

bit

DDdd

0

1531

HDD_OFFLATCH

bit

DDdd

0

1531

HDD_ONLATCH_CLEAR

bit

DDdd

0

1531

HDD_OFFLATCH_CLEAR

bit

DDdd

0

1531

ALARM_HI_STATE

bit

DD

0

63

ALARM_HI_ENABLE

bit

DD

0

63

ALARM_LO_STATE

bit

DD

0

63

ALARM_LO_ENABLE

bit

DD

0

63

SP_BIT

bit

DD

0

63

EU

dword

DD

0

63

COUNTS

dword

DD

0

63

MIN

dword

DD

0

63

MAX

dword

DD

0

63

MIN_READCLEAR

dword

DD

0

63

MAX_READCLEAR

dword

DD

0

63

EU_4096

dword

DDDD

0

4095

COUNTS_4096

dword

DDDD

0

4095

MIN_4096

dword

DDDD

0

4095

MAX_4096

dword

DDDD

0

4095

MIN_READCLEAR_4096

dword

DDDD

0

4095

MAX_READCLEAR_4096

dword

DDDD

0

4095

COUNTERDATA

dword

DD

0

63

COUNTERDATA_READCLEAR

dword

DD

0

63

HDD_COUNTER

dword

DD

0

15

HDD_COUNTER_READCLEAR

dword

DD

0

15

HDD_BANK_STATE

dword

DD

0

15

HDD_BANK_ONLATCH

dword

DD

0

15

HDD_BANK_OFFLATCH

dword

DD

0

15

MODULETYPE

dword

DD

0

63

POINTTYPE

dword

DD

0

63

FEATURE

dword

DD

0

63

OFFSET

dword

DD

0

63

GAIN

dword

DD

0

63

HISCALE

dword

DD

0

63

LOSCALE

dword

DD

0

63

MODULETYPE_4096

dword

DDDD

0

4096

POINTTYPE_4096

dword

DDDD

0

4096

FEATURE_4096

dword

DDDD

0

4096

OFFSET_4096

dword

DDDD

0

4096

GAIN_4096

dword

DDDD

0

4096

MODUHISCALE_4096

dword

DDDD

0

4096

LOSCALE_4096

dword

DDDD

0

4096

ALARM_HI_SETPOINT

dword

DD

0

63

ALARM_HI_DEADBAND

dword

DD

0

63

ALARM_LO_SETPOINT

dword

DD

0

63

ALARM_LO_DEADBAND

dword

DD

0

63

SP_INTEGER

dword

DDDDD

0

10239

SP_FLOAT

dword

DDDDD

0

10239

SP_STRING

dword

DDDD

0

6300

PID_CV_IN

dword

DDD

0

127

PID_CV_SP

dword

DDD

0

127

PID_CV_OUT

dword

DDD

0

127

PID_CV_FF

dword

DDD

0

127

PID_CV_ERROR

dword

DDD

0

127

PID_CV_P

dword

DDD

0

127

PID_CV_I

dword

DDD

0

127

PID_CV_D

dword

DDD

0

127

PID_CV_INTEGRAL

dword

DDD

0

127

PID_LSV_IN

dword

DDD

0

127

PID_LSV_SP

dword

DDD

0

127

PID_STATUS

dword

DDD

0

127

PID_STATUS_ON

dword

DDD

0

127

PID_STATUS_OFF

dword

DDD

0

127

PID_TUNE_P

dword

DDD

0

127

PID_TUNE_I

dword

DDD

0

127

PID_TUNE_D

dword

DDD

0

127

PID_TUNE_FF

dword

DDD

0

127

PID_CFG_MAX_OUT

dword

DDD

0

127

PID_CFG_MIN_OUT

dword

DDD

0

127

PID_CFG_SCAN_TIME

dword

DDD

0

127

PID_CFG_LOW_RANGE

dword

DDD

0

127

PID_CFG_HI_RANGE

dword

DDD

0

127

PID_CFG_ALG

dword

DDD

0

127

PID_CFG_MAN_MODE

dword

DDD

0

127

PID_CFG_FLAGS

dword

DDD

0

127

PID_CFG_FLAGS_ON

dword

DDD

0

127

PID-CFG_FLAGS_OFF

dword

DDD

0

127

PID_CFG_MM_IN

dword

DDD

0

127

PID_CFG_MM_SP

dword

DDD

0

127

PID_CFG_MM_OUT

dword

DDD

0

127

PID_SCALE_IN_LOW

dword

DDD

0

127

PID_SCALE_IN_HI

dword

DDD

0

127

PID_SCALE_OUT_LOW

dword

DDD

0

127

PID_SCALE_OUT_HI

dword

DDD

0

127

PID_SCAN_COUNTER

dword

DDD

0

127

Tag Parameters

  • Name: Select a register name from the drop-down list. The available options depend on the names in the register table.
  • Value Type: Select a data type from the drop-down list. The available options depend on the register name selected.
  • Polling Interval: Enter a value in seconds. This determines how often the tag should poll the register for data.
  • Tag Name: Enter a name for the tag.
  • Description (Optional): Enter a description for the tag.
  • Address: Enter a tag address. The value must in the decimal format, within the allowed min/max range. Omit the leading zeros. The device might use the decimal (D), hexadecimal (H), or octal (O) address format. See the Register Table at the bottom of the dialog box. For Bit tags, append the bit address without the bit separator. The lowercase letters in the address format indicate how many digits you should enter in the Bit address.
  • Tag Formula: Enter a formula for the tag to process the generated data. Two variables are permitted: value (current tag value) and timestamp (current tag UNIX time in milliseconds). The following math functions are available:
    • sin
    • cos
    • sqrt
    • tan
    • power: power(x) performs the operation 10^x.
    • log: log(x) is the natural logarithm (the logarithm is in base e).
    • exp: exp(x) performs the operation e^x.
  • Only Publish on Change of Value: Select the checkbox to customize NATS messages to be published only when the value parameter changes from a previous value to a new one. Change of Value only applies to boolean, numeric (such as int or float), and simple string data types. It does not apply to complex types, such as JSON or array. Poll-once topics will not be affected by Change of Value settings. These topics will still only see a single message.
  • Meta Data: Metadata summarizes basic information about data. This feature allows you to define key-value pair data for the device output payload later on. It can then be used to find, use, and reuse particular instances of data.

Note: If you use special characters in meta data key names, the special characters are replaced with underscore characters in the payload. This can cause two key names to be combined into one. For example, configuring the key names a**b and a&&b will cause only one key name to be created (a__b).





Updated 04 Oct 2023
PREVIOUS
Opto Devices
NEXT
OSI
Docs powered by Archbee