Opto22 MMIO Protocol Ethernet

7 min

Review the following information for setting up and configuring the Opto22 MMIO Protocol Ethernet driver. The driver connects to Opto22 controllers over TCP using the OptoMMP memory-map protocol.

Note: This driver is experimental. Some features might not work as expected.

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 (LE), 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 the device for Ethernet access.

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

Configure the following parameters when you Connect a DeviceConnect 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
NetworkAddress	The IP address of the device you defined in Step 1. Default value 192.168.0.1
NetworkPort	The TCP port of the device. Enter a value from 0 to 65535. Default value 2001

The following parameters are under Advanced Parameters.

Parameter	Value
ReadTimeout	How long the driver waits for a response, in milliseconds. Enter a value from 10 to 10000. Default value 2000
RetryCount	The number of times a failed request is retried. Enter a value from 0 to 5. Default value 0
PauseBetweenRetries	The pause between retries, in milliseconds. Enter a value from 0 to 2000. Default value 0
KeepAlive	The TCP keep-alive interval, in seconds. Enter a value from 0 to 7200. Enter 0 to disable keep-alive. Default value 5

For the Meta Data, Status Register, and Optional Settings options, see Connect a DeviceConnect a Device. By default, the status register is FEATURE, value type int32, address 0.

Step 3: Configure the list of registers

When you Add a TagAdd a Tag to the connected device, see the following register table and tag parameters. This driver does not support browsing tags.

See the following additional resources if necessary:

Organize Device and Tag Data by Using MetadataOrganize Device and Tag Data by Using Metadata

Tag Formula VariablesTag Formula Variables

Register table

Name	Value Types	Address Format	Max Address	Access Type
ACTIVECOUNTER	bit	DD	63	R/W
ALARM_HI_DEADBAND	int32	DD	63	R/W
ALARM_HI_ENABLE	bit	DD	63	R/W
ALARM_HI_SETPOINT	int32	DD	63	R/W
ALARM_HI_STATE	bit	DD	63	R/O
ALARM_LO_DEADBAND	int32	DD	63	R/W
ALARM_LO_ENABLE	bit	DD	63	R/W
ALARM_LO_SETPOINT	int32	DD	63	R/W
ALARM_LO_STATE	bit	DD	63	R/O
COUNTERDATA	uint32	DD	63	R/O
COUNTERDATA_READCLEAR	int32	DD	63	R/O
COUNTS	int32	DD	63	R/W
COUNTS_4096	float32	DDDD	4095	R/O
EU	int32	DD	63	R/W
EU_4096	float32	DDDD	4095	R/O
FEATURE	int32	DD	63	R/W
FEATURE_4096	uint32	DDDD	4095	R/W
GAIN	int32	DD	63	R/W
GAIN_4096	float32	DDDD	4095	R/W
HDD_COUNTER	uint32	DDdd	1531	R/O
HDD_COUNTER_READCLEAR	uint32	DDdd	1531	R/O
HDD_OFFLATCH	bit	DDdd	1531	R/O
HDD_OFFLATCH_CLEAR	bit	DDdd	1531	R/O
HDD_ONLATCH	bit	DDdd	1531	R/O
HDD_ONLATCH_CLEAR	bit	DDdd	1531	R/O
HDD_STATE	bit	DDdd	1531	R/O
HISCALE	int32	DD	63	R/W
HISCALE_4096	float32	DDDD	4095	R/W
LOSCALE	int32	DD	63	R/W
LOSCALE_4096	float32	DDDD	4095	R/W
MAX	int32	DD	63	R/O
MAX_4096	float32	DDDD	4095	R/O
MAX_READCLEAR	int32	DD	63	R/O
MAX_READCLEAR_4096	float32	DDDD	4095	R/O
MIN	int32	DD	63	R/O
MIN_4096	float32	DDDD	4095	R/O
MIN_READCLEAR	int32	DD	63	R/O
MIN_READCLEAR_4096	float32	DDDD	4095	R/O
MODULETYPE	int32	DD	63	R/O
MODULETYPE_4096	uint32	DDDD	4095	R/O
OFFLATCH	bit	DD	63	R/O
OFFLATCH_READCLEAR	bit	DD	63	R/O
OFFSET	int32	DD	63	R/W
OFFSET_4096	float32	DDDD	4095	R/W
ONLATCH	bit	DD	63	R/O
ONLATCH_READCLEAR	bit	DD	63	R/O
PID_CFG_ALG	int32	DDD	127	R/W
PID_CFG_FLAGS	int32	DDD	127	R/W
PID_CFG_FLAGS_OFF	int32	DDD	127	R/W
PID_CFG_FLAGS_ON	int32	DDD	127	R/W
PID_CFG_HI_RANGE	int32	DDD	127	R/W
PID_CFG_LOW_RANGE	int32	DDD	127	R/W
PID_CFG_MAN_MODE	int32	DDD	127	R/W
PID_CFG_MAX_OUT	int32	DDD	127	R/W
PID_CFG_MIN_OUT	int32	DDD	127	R/W
PID_CFG_MM_IN	int32	DDD	127	R/W
PID_CFG_MM_OUT	int32	DDD	127	R/W
PID_CFG_MM_SP	int32	DDD	127	R/W
PID_CFG_SCAN_TIME	int32	DDD	127	R/W
PID_CV_D	int32	DDD	127	R/O
PID_CV_ERROR	int32	DDD	127	R/O
PID_CV_FF	int32	DDD	127	R/W
PID_CV_I	int32	DDD	127	R/O
PID_CV_IN	int32	DDD	127	R/O
PID_CV_INTEGRAL	int32	DDD	127	R/O
PID_CV_OUT	int32	DDD	127	R/W
PID_CV_P	int32	DDD	127	R/O
PID_CV_SP	int32	DDD	127	R/O
PID_LSV_IN	int32	DDD	127	R/W
PID_LSV_SP	int32	DDD	127	R/W
PID_SCALE_IN_HI	int32	DDD	127	R/W
PID_SCALE_IN_LOW	int32	DDD	127	R/W
PID_SCALE_OUT_HI	int32	DDD	127	R/W
PID_SCALE_OUT_LOW	int32	DDD	127	R/W
PID_SCAN_COUNTER	int32	DDD	127	R/W
PID_STATUS	int32	DDD	127	R/W
PID_STATUS_OFF	int32	DDD	127	R/W
PID_STATUS_ON	int32	DDD	127	R/W
PID_TUNE_D	int32	DDD	127	R/W
PID_TUNE_FF	int32	DDD	127	R/W
PID_TUNE_I	int32	DDD	127	R/W
PID_TUNE_P	int32	DDD	127	R/W
POINTTYPE	int32	DD	63	R/W
POINTTYPE_4096	uint32	DDDD	4095	R/W
QUALITY_4096	uint32	DDDD	4095	R/O
SP_BIT	bit	DD	63	R/W
SP_FLOAT	uint32	DDDDD	10239	R/W
SP_INTEGER	uint32	DDDDD	10239	R/W
STATE	bit	DD	63	R/W

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.

Address: Enter the register address in decimal format, within the min and max range in the register table. Omit leading zeros. For registers with a bit address format (lowercase d), add the bit number at the end.

PollingInterval: Enter how often the tag polls for data, in seconds. Enter 0 to disable polling. Default value 1

Tag Name: Enter a name for the tag.

Description (Optional): Enter a description for the tag.

Tag Formula: Enter a formula for the tag to process the generated data. You can use two variables: value (current tag value) and timestamp (current tag UNIX time in milliseconds). The following math functions are available:

sqrt

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 publish NATS messages only when the value parameter changes. 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 are not affected by Change of Value settings, and still receive a single message.

Meta Data: Define key-value pairs to add to the device output payload.

Note: If you use special characters in metadata 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 creates only one key name (a__b).