IDEC Serial

7 min

Review the following information for setting up and configuring the IDEC Serial driver.

Litmus Edge Compatible Series

Compatibility Parameter	Compatible Items
Driver Type	Serial
Validated Devices/Series	IDEC Micro3

Note: To browse tags, you must export the tag list from the WindLDR programming software as a .txt file, then upload the file to the /ftp-data/devicehub/ folder.

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

Ensure the PLC device is configured for serial communication.

Note the serial port configuration parameters including baud rate, data bits, stop bits, and parity settings.

Identify the local serial port (for example, /dev/ttyS0) on your Litmus Edge gateway that will connect to the PLC.

Ensure proper physical connectivity between the PLC's serial port and the gateway's serial port.

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	IDEC
Driver	IDEC Serial
Station ID	Enter the CPU's station ID.
Exported PLC tag text file	Enter the name of the exported .txt tag file from WindLDR which was uploaded to /ftp-data/devicehub/
Device File	Select the serial device file for the connected port.
Baud rate	Select the baud rate that matches the setting on the controller.
Data Bits	Select the number of data bits that matches the setting on the controller.
Stop Bits	Select the number of stop bits that matches the setting on the controller.
Parity	Select the parity setting that matches the setting on the controller.

Step 3: Configure the list of registers

When you Add a Tag the connected device, refer to the following register table and tag parameters.

Refer to the following additional resources:

Device and tag metadata use case

Tag formula variables

Register table

Name	Value Types	Access Types	Min Address	Max Address	Description
I_bit	bit	OO	37	R/O	Input Bit/Words
I	word	OO	20	R/O	Input Words
Q_bit	bit	OO	37	R/W	Output Bits/Words
Q	word	OO	20	R/W	Output Words
M_bit	bit	OOO	317	R/W	Internal Relay Bits
M	word	OOO	300	R/W	Internal Relay Words
R_bit	bit	DD	63	R/W	Shift Register Bits
R	word	DD	48	R/W	Shift Register Words
D	word	DDDD	9999	R/W	Data Registers
C_bit	bit	DD	31	R/O	Counter
C	word	DD	31	R/O	Counter
CP	word	DD	31	R/W	Counter Presets
T_bit	bit	DD	31	R/O	Timer
T	word	DD	31	R/O	Timer
TP	word	DD	31	R/W	Timer Presets
W	word	D	6	R/W	Calendar/Clock

Tag parameters

Parameter	Value
Name	Select a register name from the drop-down list. Available options depend on the names in the register table.
Value Type	Select a data type from the drop-down list. 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 be in the decimal format within the allowed min/max range. Omit the leading zeros. 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 register values to read. A count higher than one will generate an array of values from the address value configured and respective subsequent address values.
Tag Formula	Enter a formula to process tag data. See Tag formula below.
Only Publish on Change of Value	Select the checkbox to publish NATS messages only 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 are not 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).

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:

Function	Description
sin	Sine
cos	Cosine
sqrt	Square root
tan	Tangent
power(x)	Performs the operation 10^x
log(x)	Natural logarithm (base e)
exp(x)	Performs the operation e^x