Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

NameData TypeDescription
bdSeqLongThe last bdSeq number sent by the Edge Node in an NBIRTH message

Birth Count

Long

The number of NBIRTH messages since the last time the info metrics were reset via the Node Info/Reset Info tag

Current ServerStringThe current MQTT Server the Edge Node is connected to
Data Latency (ms)Long

The time in milliseconds between MQTT Engine receiving of the last message and the payload's reported time. Note: For this to be very accurate the edge node's clock and the system clock running MQTT Engine should be synced

Death CountLongThe number of NDEATH messages since the last time the info metrics were reset via the Node Info/Reset Info tag
Message SchemaStringThe schema associated with the Edge Node (e.g. Sparkplug B)
Offline DateTimeDateTimeThe time at which the last NDEATH message was received by MQTT Engine
OnlineBooleanWhether or not the Edge Node is online. This is determined by whether the last lifecycle message was an NBIRTH or NDEATH
Online DateTimeDateTimeThe time at which the last NBIRTH message was received by MQTT Engine
Reset InfoBooleanWritable tag to 'reset' the Node Info metrics
seqLongThe last Sparkplug seq number received from the Edge Node
Total Bytes Recvd (bytes)LongThe number of bytes received from the Edge Node since the last time the info metrics were reset via the Node Info/Reset Info tag
Total Bytes Xmit (bytes)Long

The number of bytes sent to the Edge Node since the last time the info metrics were reset via the Node Info/Reset Info tag

Transmission VersionStringThe version of MQTT Transmission installed at the Edge Node

Device Control

The tags in each Device Control folder are created based on a supplied metric within the DBIRTH message from the Edge Node. These will only appear if the Edge Node implementation supports them. It is up to the Edge Node implementation (MQTT Transmission for example) to support any functionality it supplies via the DBIRTH. If the Edge Node does not support the specific control, it should not include it in the DBIRTH payload.

NameData TypeDescription
RebirthBooleanWriteable tag to request the Device to resend its cached DBIRTH message without disconnecting or sending DEATH messages first

Device Info

The tags below are general information tags with respect to Sparkplug Devices. These are created, managed and updated by MQTT Engine based on messages arriving from each given Device.

...