Ping

6 min

Review the following information for setting up and configuring the Ping driver. The driver checks whether network hosts are reachable. It can send an ICMP echo (ping) to a host, or test whether a TCP port on a host is open. Each tag returns 1 or 0.

Note: This driver is experimental. Some features might not work as expected.

Litmus Edge compatible series

Compatibility parameter	Compatible items
Driver type	Network diagnostic (ICMP and TCP)
Compatible devices	Any host that Litmus Edge (LE) can reach over the network

To set up and configure this driver in LE, do the following:

Step 1: Set up the device in Litmus Edge DeviceHub

Step 2: Configure the list of registers

Step 1: Set up the device in Litmus Edge DeviceHub

Connect a DeviceConnect a Device with the following parameters. This driver has no connection settings. You set the host to check on each tag.

Parameter	Value
Type	Network Utility
Driver	Ping

For the Meta Data, Status Register, and Optional Settings options, see Connect a DeviceConnect a Device.

Step 2: Configure the list of registers

When you Add a TagAdd a Tag to the connected device, see the following register table and tag parameters. This driver does not support browsing tags.

See the following additional resources if necessary:

Organize Device and Tag Data by Using MetadataOrganize Device and Tag Data by Using Metadata

Tag Formula VariablesTag Formula Variables

Register table

Name	Value Types	Access Type	Description
Ping	bit	R/O	ICMP reachability check. 1 means the host is reachable, and 0 means it is not.
Port	bit	R/O	TCP port check. 1 means the port is open, and 0 means it is closed, refused, or filtered.

Tag parameters

Name: Select Ping or Port from the drop-down list.

Value Type: Select bit.

Host: Enter the IP address or hostname of the host to check.

Port: For the Port register only. Enter the TCP port to check, from 1 to 65535. Default value 8000

PollingInterval: Enter how often the tag checks the host, in seconds. Enter 0 to disable polling. Default value 1

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. You can use two variables: value (current tag value) and timestamp (current tag UNIX time in milliseconds). The following math functions are available:

sqrt

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 publish NATS messages only when the value parameter changes. 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, and still receive a single message.

Meta Data: Define key-value pairs to add to the device output payload.

Note: If you use special characters in metadata 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 creates only one key name (a__b).