Versions Compared

Key

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

...

For each identified MQTT Client, the following tags are available:

NameData TypeDescription
Primary Host State > PrimaryHostNameFolderFolder named as the Primary Host Id configured in MQTT Engine
PayloadStringStatus of the Primary Host. Options are OFFLINE or ONLINE
RetainBooleanStatus of Retain status of the LWT message for the Primary Host
Connected NodesIntegerNumber of currently connected Sparkplug Edge Nodes to this MQTT Client 
Enable Latency CheckIntegerWritable tag to enabled message latency checking for each MQTT Client 
Message Processing Latency (ms)IntegerThe amount of time to process the last Sparkplug message
Messages Per SecondIntegerThe number of MQTT messages received by Engine per second 
MQTT Client IDStringThe Client ID for the MQTT Client
Offline DateTimeDateTimeThe last time at which the MQTT Client successfully disconnected from the MQTT Server
OnlineBooleanA read-only tag showing the connection status of the MQTT Client
Online DateTimeDateTimeThe last time at which the MQTT Client successfully connected to the MQTT Server
Server Latency (ms)IntegerThe amount of time that it takes for a test MQTT message to be sent and received back by MQTT Engine
Target Server URLStringThe URL of the target MQTT Server to connect to


For each identified MQTT Client, the following folders and tags are available:

NameNameData TypeDescription
Primary Host State/PrimaryHostName
FolderFolder named as the Primary Host ID configured in MQTT Engine

PayloadStringStatus of the Primary Host. Options are {"online":true,"timestamp":1681780081657} or {"online":true,"timestamp":1681780081657} where the timestamp is the time of the last status change

RetainBooleanRetain status of the LWT message for the Primary Host
Legacy Primary Host State/PrimaryHostName
FolderFolder named as the Primary Host ID configured in MQTT Engine if Enable Legacy State messages is True under the Severs > Legacy State configuration 

PayloadStringStatus of the Legacy Primary Host. Options are OFFLINE or ONLINE

RetainBooleanRetain status of the LWT message for the Primary Host