Koyo Ethernet (Gen1)

6 min

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

Litmus Edge Compatible Series

Compatibility parameter	Compatible items
Driver type	Ethernet
Validated devices/series	Koyo DirectLogic Series Automation Direct DirectLogic 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 DirectSoft6 V6.1 software 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 Device with this driver. Update default values to the specific setup of your device.

Parameter	Value
Type	Koyo
Driver	Koyo Ethernet (Gen1)
Network Address	The device address you defined during Step 1
Network Port	428784

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

Name	Value Types	Access Types	Address Format	Max Address	Description
CCM_31	word	R/W	HHHH	17056	V
CCM_32	word	R/W	HHH	512	GX, X, SP
CCM_33	word	R/W	HHH	832	GY,Y,C,S,T,CT
V	word	R/W	OOOOO	17055	V-memory
GX	bit	R/W	OOOO	2047	Global I/O
X	bit	R/W	OOOO	1023	Real Word Inputs
SP	bit	R/W	OOOO	1023	Special Purpose Relays
GY	bit	R/W	OOOO	2047	More Global I/O
Y	bit	R/W	OOOO	1023	Real Word Outputs
C	bit	R/W	OOOO	1023	Control Relays
S	bit	R/W	OOOO	1023	Stage Status Bits
T	bit	R/W	OOO	255	Timer Status Bits
CT	bit	R/W	OOO	255	Counter Status Bits

Tag parameters

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 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 register values to read. A count higher than 1 will generate an array of values from the address value configured and respective subsequent address values.

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