Yokogawa MX Ethernet
Review the following information for setting up and configuring the Yokogawa MX Ethernet driver.
The driver reads channel data from a Yokogawa MX data acquisition unit over Ethernet, polling on the interval you set for each tag. Alongside the process value, it exposes the channel's alarm status, alarm setpoints, tag name, unit, scale limits, precision, and scan interval, so you can bring the instrument's own configuration into Litmus Edge (LE) rather than duplicating it by hand.
Note: This driver is experimental. Some features may not work as expected. It is also read-only. Writing to the instrument is not supported.
Compatibility
Compatibility Parameter | Compatible Items |
|---|---|
Driver Type | Ethernet |
Validated Devices/Series | Yokogawa MX100 |
How to configure the PLC
To set up and configure this device in Litmus Edge, you will need to do the following:
- Step 1: Set up and configure the device
- Step 2: Set up the device in Litmus Edge DeviceHub
- Step 3: Configure the list of registers
Step 1: Set up and configure the device
- Configure the MX unit for Ethernet access and record its IP address.
- Confirm the port the unit listens on. The default is 34316.
- Note which channels are in use and what each one measures. You enter a channel number as the Address on every tag. Note: The driver does not support device discovery. Enter the network address manually.
Step 2: Set up the 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 | Yokogawa |
Driver | Yokogawa MX Ethernet |
Network Address | IP address of the unit. Default: 192.168.0.1. |
Network Port | Port the unit listens on, from 0 to 65535. Default: 34316. |
Read Timeout (Optional) | Read timeout in milliseconds, from 10 to 10000. Default: 3000. |
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. You can also Browse and Add Tags from a Device for this device. Refer to the following additional resources:
Register table
Select the register name in the Name list, then enter the channel number in Address. Every register takes the same address, so PV at address 3 and Unit at address 3 refer to the same channel. All registers are read-only.
Name | Value Types | Access Types | Description |
|---|---|---|---|
PV | float32, float64 | R/O | Process value |
Alarm | int8, int16, int32 | R/O | Alarm summary |
Alarm1 | bool | R/O | Alarm level 1 status |
Alarm2 | bool | R/O | Alarm level 2 status |
ASP1 | float32, float64 | R/O | Alarm level 1 setpoint |
ASP2 | float32, float64 | R/O | Alarm level 2 setpoint |
Tag | string | R/O | Tag name of the channel |
TagComment | string | R/O | Tag comment of the channel |
Unit | string | R/O | Unit of the channel |
ScaleLo | float32, float64 | R/O | Lower scale value of the channel |
ScaleHi | float32, float64 | R/O | Upper scale value of the channel |
Precision | float32, float64 | R/O | Precision of the channel |
Interval | int8, int16, int32 | R/O | Scan interval of the channel |
Tag parameters
Parameter | Value |
|---|---|
Name | Register name from the drop-down list. Available options depend on the names in the register table. |
Value Type | Data type. Available options depend on the register name selected. |
Address | Channel number, from 1 to 60. |
Count | Number of channels to read, from 1 to 65535. Default: 1. A count higher than 1 generates an array of values from the channel configured and the channels that follow it. |
Polling Interval | Value in seconds. This determines how often the tag should poll the register for data. Enter 0 to disable polling. Default: 1000. |
Tag Formula | Formula to process tag data. See Tag formula below. |
Only Publish on Change of Value | Select the checkbox to publish NATS messages only 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 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). |
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:
Function | Description |
|---|---|
sin | Sine |
cos | Cosine |
sqrt | Square root |
tan | Tangent |
power(x) | Performs the operation 10^x |
log(x) | Natural logarithm (base e) |
exp(x) | Performs the operation e^x |