Koyo Click Serial
Review the following information for setting up and configuring the Koyo Click Serial driver.
Litmus Edge Compatible Series
Compatibility parameter | Compatible items |
|---|---|
Driver type | Serial |
Validated devices/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.
- 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 |
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:
Register Table
Name | Value Types | Access Types | Address Format | Min Address | Max Address | Description |
|---|---|---|---|---|---|---|
C | bit | R/W | DDDD | 1 | 2000 | Control Relay |
T | bit | R/O | DDD | 1 | 500 | Timer Bit |
CT | bit | R/O | DDD | 1 | 250 | Counter Bit |
SC | bit | R/O | DDDD | 1 | 1000 | System Control relay |
DS | int16, uint16 | R/W | DDDD | 1 | 4500 | Data Register (single word) |
DD | int32, uint32 | R/W | DDDD | 1 | 1000 | Data Register (double word) |
DH | int16, uint16 | R/W | DDD | 1 | 500 | Data Register (hex) |
DF | float32 | R/W | DDD | 1 | 500 | Data Register (float) |
XD | int32, uint32 | R/O | D | 0 | 8 | Input Register |
XD_bit | bit | R/O | Ddd | 0 | 831 | Input Point |
YD | int32, uint32 | R/W | D | 0 | 8 | Output Register |
YD_bit | bit | R/O | Ddd | 0 | 831 | Output Point |
TD | int16, uint16 | R/W | DDD | 1 | 500 | Timer Current Value |
CTD | int32, uint32 | R/W | DDD | 1 | 250 | Counter Current Value |
SD | int16, uint16 | R/O | DDDD | 1 | 1000 | System Data Register |
TXT | string | R/W | DDDD | 1 | 1000 | Text Data |
Note: Tags with int16, uint16 or int32, uint32 have endianness field at the tag level. By default, the field has Swap Words as value. If your PLC configuration differs from the default behavior, then you can choose the appropriate option from Endianness field. Only for tags with TXT register to read/write data accurately, keep Endianness as Swap Bytes.
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:
- sin
- cos
- sqrt
- tan
- 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).