CODESYS V2 Ethernet Symbolic
Review the following information for setting up and configuring the CODESYS V2 Ethernet Symbolic (Gen1.3) driver.
Litmus Edge Compatible Series
Compatibility parameter | Compatible items |
|---|---|
Driver type | Ethernet |
Validated devices/series | ABB PM564 |
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
- Configure your CODESYS V2 device for Ethernet access and note its network parameters (IP address and port).
- Ensure the CODESYS device is accessible on the network from your Litmus Edge instance.
- (Optional) Export a symbol file from your CODESYS device to enable symbolic tag browsing:
- In your CODESYS programming environment, create a symbol configuration file.
- Export the symbol file in .SYM or .SDB format.
- Save this file for upload to Litmus Edge.
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 | CODESYS |
Driver | CODESYS V2 Ethernet Symbolic |
Motorola Byte Order | Enable if your CODESYS device uses Motorola (big-endian) byte order. Disable for Intel (little-endian) byte order. |
Network Address | The IP address of your CODESYS device (for example, 10.17.0.97) |
Path | /data/registers.sym (optional path to uploaded SYM or SDB file) |
Port | 1201 |
Protocol | Select the protocol variant that matches your CODESYS device configuration. |
Type | 0 |
Note: If you are using a SYM or SDB file for symbolic addressing, upload it to the path specified in the Path field before starting the device. If no file is provided, the driver will connect and browse using device information directly.
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
Note: This driver uses symbolic addressing based on the variable names defined in your CODESYS program (for example, PLC_PRG.test1, PLC_PRG.DWORD). When a SYM or SDB file is provided, it supplies the mapping between symbolic names and memory addresses. Without a symbol file, symbolic names are resolved directly from the device.
Name | Value Types | Access Types | Address Format | Min Address | Max Address | Description |
|---|---|---|---|---|---|---|
R | BOOL, BYTE, SINT, USINT, WORD, INT, UINT, DWORD, DINT, UDINT, REAL, STRING | R/W | Symbolic name (e.g., PLC_PRG.variableName) | 0 | 0 | Read/Write symbolic variables |
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 are:
- BOOL: Boolean value
- BYTE: 8-bit unsigned integer
- SINT: 8-bit signed integer
- USINT: 8-bit unsigned integer
- WORD: 16-bit unsigned integer
- INT: 16-bit signed integer
- UINT: 16-bit unsigned integer
- DWORD: 32-bit unsigned integer
- DINT: 32-bit signed integer
- UDINT: 32-bit unsigned integer
- REAL: 32-bit floating point
- STRING: Character string
- Polling Interval: Enter a value in milliseconds. This determines how often the tag should poll the register for data. Minimum value is 1000 ms.
- Tag Name: Enter a name for the tag.
- Description (Optional): Enter a description for the tag.
- Address: Enter the symbolic address of the variable as defined in your CODESYS program. Use the format: PLC_PRG.variableName (for example PLC_PRG.test1, PLC_PRG.D_STRING). If a SYM or SDB file has been uploaded, symbolic names must match those defined in that file. If no file is provided, names are resolved directly from the device.
- 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).