LioN-X
Review the following information for setting up and configuring the LioN-X driver.
Litmus Edge Compatible Series
Compatibility parameter | Compatible items |
|---|---|
Driver type | Ethernet |
Validated devices/series | When configuring tags for this driver, you must enter the case-sensitive register name exactly as it is defined in the PLC. See Step 3: Configure the List of Registers below to learn more. |
Step 1: Set up and Configure the Driver
To find the network parameters of the driver, you have the option of using the Device Discovery Tool. Otherwise, set up the device for Ethernet access and collect the network parameters.
To use the device discovery tool:
- Navigate to DeviceHub > Devices.
- Click the Connect a Device box. The Connect Device dialog box appears.
- Click the Device Type drop-down list and select Lumberg Automation.
- Click the Driver Name drop-down list, and select LioN-X.
- Click Device Discovery.
- The Device Discovery dialog box appears.
- Select only one of the following fields to use for discovering the device.
- Discovery Server URL (Servers and Endpoints Discovery): No prior setup/configuration is needed to use this field. Replace localhost with the appropriate IP address or domain name that will be used to search for the device. Ensure the correct port number is entered.
- Server URL (Endpoints Discovery): You'll need to enable/configure the server to use this field. Replace localhost with the appropriate IP address or domain name that will be used to search for the device. Ensure the correct port number is entered.
- Delete all text from the field not being used.
- Click Start discovery. When the search is complete, available servers with corresponding security policies will be listed.
- Click the appropriate server/security policy, and then click Update form with discovery results. The Connect Device dialog box appears with Server URL, Security Policy, and Security Mode pre-filled based on the discovery results.
- In the Driver Mode field, select either Polling or Subscription.
- Move onto Step 2 and continue configuring the driver with the remaining parameters.
Step 2: Set up the Driver 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.
General Parameters
Parameter | Value |
|---|---|
Type | Lumberg Automation |
Driver | LioN-X |
Driver Mode | Select Polling or Subscription |
Server URL | opc.tcp://localhost:48010 |
Security Policy | Select one of the following:
|
Security Mode | Select None, Sign, or SignAndEncrypt |
Session Certificate | Auto-generated |
Session Private Key | Auto-generated |
Auth Mode | Select Anonymous, Certificate, or Username |
Default Root | ns=0;i=84 Start node to browse the server |
Publishing Interval | Cyclic rate in milliseconds at which the subscription is requested to return notifications to the client |
Lifetime Count | Subscription lifetime count (LifetimeCount * PublishingInterval) |
Max Keep Alive Count | If the server has no notifications pending for the period of time defined by (MaxKeepAliveCount * PublishingInterval), the server send a keep alive message to the client |
Max Notifications Per Publish | Maximum number of notifications the client can receive in a single publish response |
Priority | Relative priority of this subscription within the session |
Override Registers Sampling Interval | Select Enable or Disable to override the registers sampling interval |
Registers Sampling Interval | The interval in milliseconds that defines the fastest rate at which the MonitoredItem(s) should be accessed and evaluated (0 - fastest practical rate) |
Advanced Parameters
Parameter | Value |
|---|---|
Disable Error Certificate Host Name Invalid | Select true or false Flag used to disable the check if the hostname the client connected to matches one of the hostnames or IP addresses in the server certificate. |
Disable Application Uri Check | Select true or false Flag used to disable the certificate ApplicationUri match check. |
Disable Encrypted Password Check | Select true or false Flag used to disable the check if the password of a UserPassword identity token is encrypted properly. |
Disable Error Certificate Revocation Unknown | Select true or false Flag used to disable the BadCertificateRevocationUnknown client certificate validation error . |
Disable Error Certificate Chain Incomplete | Select true or false Flag used to disable the error BadCertificateChainIncomplete certificate validation . |
Disable Error Certificate Untrusted | Select true or false Flag used to disable the BadCertificateUntrusted certificate validation error. |
Disable Error Certificate Time Invalid | Select true or false Flag used to disable the CertificateTimeInvalid certificate validation error . |
Step 3: Configure the List of Registers
Browse for tags to add to this FreeTag device. See Browse Tags to learn more.
Alternatively, when you Add Tags, for Name map the LioN-X server tags to the client using this format, where the semicolon is significant: ns=1;s=tagname.
Example: ns=2;s=Demo.Static.Scalar.Boolean
The following value types are supported:
- bool
- sbyte
- byte
- int16
- uint16
- int32
- uint32
- int64
- uint64
- float32
- float64
- string
- BLOB
- bool[]
- sbyte[]
- byte[]
- int16[]
- uint16[]
- int32[]
- uint32[]
- int64[]
- uint64[]
- float32[]
- float64[]
- string[]
- BLOB[]
Tag Parameters
- Name: Enter a name based on this format: ns=1;s=tagname.
- Example: ns=2;s=Demo.Static.Scalar.Boolean
- Value Type: Select a data type from the drop-down list.
- 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.
- 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 from a previous value 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).