SAIA Ethernet (Gen1.3)

6 min

Review the following information for setting up and configuring the SAIA Ethernet (Gen1.3) driver.

Litmus Edge Compatible Series

Compatibility parameter	Compatible items
Driver type	Ethernet
Validated devices/series	SAIA PLC series

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 PG5 v2.3.165 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	SAIA
Driver	SAIA Ethernet (Gen1.3)
Network Address	The device address you defined during Step 1
Station ID	0

Step 3: Configure the List of Registers

When you Add a Tag to the connected device, see the following Register Table and Tag Parameters sections. See the following additional resources if necessary:

Organize Device and Tag Data by Using Metadata

Tag Formula Variables

Register Table

A Count field is available at the tag level for all register types to enable batch reads of consecutive registers as arrays. When you enter a count greater than 1, the driver reads that many consecutive registers starting from the specified address and returns the values as an array. For 32-bit float types, the driver skips the appropriate number of addresses to avoid reading overlapping data.

Name	Value Types	Address Format	Max Address
Register	word	DDDDD	16383
Counter	word	DDDD	1599
Timer	word	DDDD	1599
Reg_Float	float	DDDDD	16383
DB	word	DDDDDDDD	536016383
DB_String	string	DDDDDDDD	536016383
R_String	word	DDDDD	16383
DB_Float	float	DDDDDDDD	536016383
Flag	bit	DDDD	8191
Output	bit	DDDD	1023
Input	bit	DDDD	1023
Reg_Bit	bit	DDDDDdd	1638331
DB_Bit	bit	DDDDDDDDdd	53601638331

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.

Count: Enter the number of consecutive registers to read as an array. The default value is 1 (single register). For 32-bit float types, the driver skips the appropriate number of addresses to avoid overlapping.

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:

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 only publish NATS messages when the value parameter changes to a new value. 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. Metadata 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).