CIP Ethernet
Review the following information for setting up and configuring the CIP Ethernet driver.
Litmus Edge Compatible Series
Compatibility parameter | Compatible items |
|---|---|
Driver type | Ethernet |
Validated devices/series | Rockwell Automation (Allen-Bradley) controllers supporting CIP protocol over Ethernet/IP |
Replaces Gen 1 driver(s) | N/A |
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 including the IP address and port number. The default port for CIP Ethernet/IP communication is typically 44818.
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 | ODVA |
Driver | CIP Ethernet |
Network Address | The device IP address you recorded in Step 1 |
Port | 44818 |
Read Timeout | 3000 (ms) |
Step 3: Configure the List of Registers
When you Add a Tag to the connected device, refer to the following register table and tag parameters. Refer to the following additional resources:
Register Table
Name | Value Types | Access Types | Description |
|---|---|---|---|
Attribute | bool, uint8, uint16, uint32, uint64, int8, int16, int32, int64, float32, float64, string, bit[], uint8[], uint16[], uint32[], uint64[], int8[], int16[], int32[], int64[], float32[], float64[] | R/W | Read or write individual CIP object attributes |
AttributeRange | string, uint8[], uint16[], uint32[], uint64[], int8[], int16[], int32[], int64[], float32[], float64[] | R/O | Read a range of CIP object attributes (read-only) |
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 milliseconds. 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.
- Class ID: Enter the CIP object class identifier. This specifies the type of object you want to access (for example, 1 for Identity Object, 4 for Assembly Object).
- Instance ID: Enter the CIP object instance identifier. This specifies which instance of the object class you want to access.
- Attribute ID: Enter the CIP attribute identifier. This specifies which attribute of the object instance you want to read or write.
- 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 customize NATS messages to be published only when the value parameter changes to a new one. 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. 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).