Koyo Click Serial (Gen1.3)

6 min

Review the following information for setting up and configuring the Koyo Click Serial (Gen1.3) driver.

Litmus Edge Compatible Series

Compatibility parameter	Compatible items
Driver type	Serial
Validated devices/series	Koyo Click PLC series Automation Direct Click 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

Record the serial communication parameters for the device. Otherwise, follow the steps below.

To configure your device:

Record the following information and refer to it when needed.

Device: Koyo Click

Communication I/F: RS232. Refer to the following figures.

Koyo Click reference

Launch CLICK Programming v2.10 Software and click PLC > Connect.

Set up communication parameters and then click Connect.

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 Click Serial (Gen1.3)
Communication Port	Local Serial connection file path
Baud Rate	38400
Data Bits	8
Parity	Even, Odd, None
Stop Bits	1
Station	1

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	Min Address	Max Address	Description
X	bit	R/W	Ddd	1	816	Input Status (Read Only)
Y	bit	R/W	Ddd	1	816	Output Status
C	bit	R/W	DDDDD	1	2000	Control Bit
T	bit	R/W	DDDDD	1	500	Timer Status
CT	bit	R/W	DDDD	1	250	Counter Status
SC	bit	R/W	DDD	1	1000	System Control Bit
DS	word	R/W	DDDD	1	4500	Data Registers
DD	word	R/W	DDDD	1	1000	Data Registers (Double Word)
DH	word	R/W	DDD	1	500	Data Registers
DF	word	R/W	DDD	1	500	Data Registers (Double Word)
XD	word	R/W	D	0	8	Input Status Registers
YD	word	R/W	D	0	8	Output Status Registers
TD	word	R/W	DDD	1	500	Timer Current Values
CTD	word	R/W	DDD	1	250	Counter Current Values
SD	word	R/W	DDDD	1	1000	System Data Registers
TXT	word	R/W	DDDD	1	1000	Text Data Registers

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:

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).