ME: Tags

MQTT Engine automatically creates a known set folders containing tags for Engine Control, Engine Info and Message Diagnostics.

For each connected Edge Node, a Node Control and Node Info folder containing tags is created along with a Device Info folder for each connected device.

The tables below describes these tags.

Node Control

The tags in each Node Control folder are created based on a supplied metric within the NBIRTH 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 NBIRTH. If the Edge Node does not support the specific control, it should not include it in the NBIRTH payload.

Name	Description
Next Server	Requests the Edge Node to walk to the next MQTT server
Rebirth	Requests the Edge Node to resend its NBIRTH and DBIRTH messages without disconnecting or sending DEATH messages first

Node Info

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

Name	Description
bdSeq	The last bdSeq number sent by the Edge Node in an NBIRTH message
Birth Count	The number of NBIRTH messages since the last time the info metrics were reset via the Node Info/Reset Info tag
Current Server	The current MQTT Server the Edge Node is connected to
Data Latency	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 Count	The number of NDEATH messages since the last time the info metrics were reset via the Node Info/Reset Info tag
Message Schema	The schema associated with the Edge Node (e.g. Sparkplug B)
Offline DateTime	The time at which the last NDEATH message was received by MQTT Engine
Online	Whether or not the Edge Node is online. This is determined by whether the last lifecycle message was an NBIRTH or NDEATH
Online DateTime	The time at which the last NBIRTH message was received by MQTT Engine
Reset Info	Writable tag to 'reset' the Node Info metrics
seq	The last Sparkplug seq number received from the Edge Node
Total Bytes Recvd	The 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	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

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.

Name	Description
Birth Count	The number of DBIRTH messages since the last time the info metrics were reset via the Device Info/Reset Info tag
Data Message Count	The number of DDATA messages since the last time the info metrics were reset via the Device Info/Reset Info tag
Death Count	The number of DDEATH messages since the last time the info metrics were reset via the Device Info/Reset Info tag
Last Command Size	The size in bytes of the last DCMD that was sent from MQTT Engine
Last Data Message Size	The size in bytes of the last DDATA that was received from the Device
Offline DateTime	The time at which the last DDEATH message was received by MQTT Engine
Online	Whether or not the Device is online. This is determined by whether the last lifecycle message was an DBIRTH or NBIRTH
Online DateTime	The time at which the last DBIRTH message was received by MQTT Engine
Reset Info	Writable tag to 'reset' the Device Info metrics

Engine Control

Primary Host

The tags below give general information with respect to the primary host configuration.

Name	Description
Enabled	Whether or not the Primary Host has been enabled in MQTT Engine
ID	The Primary Host name defined at MQTT Engine

Engine Info Tags

The tags below provide information regarding the MQTT Engine Devices, Edge Nodes, Latches, MQTT Client as well as information on MQTT Engine.

Name	Description
Redundancy Role	The redundancy configuration of the Ignition system that MQTT engine is installed on. Options are Independent, Master and Backup
Redundancy State	The redundancy status of the Ignition system that MQTT engine is installed on. Options are Active or Cold
System-Wide Reset Info	Writeable tag to 'reset' all Engine metrics
Total Bytes Recvd	The number of bytes received by Engine since the last time the info metrics were reset via the System-Wide Reset Info tag
Total Bytes Xmit	The number of bytes sent from Engine since the last time the info metrics were reset via the System-Wide Reset Info tag
Total Data Mesg Count	The number of messages received by Engine since the last time the info metrics were reset via the System-Wide Reset Info tag
Version	The version MQTT Engine currently installed

Devices

The Devices folder tags provide information on the connected devices.

Name	Description
DeviceCount	The number of Sparkplug edge devices as determined by the received DBIRTH messages
DevicesOffline	The number of Sparkplug edge devices that are offline. This is determined by whether the last lifecycle message was an DBIRTH or DDEATH
DevicesOnline	The number of Sparkplug edge devices that are online. This is determined by whether the last lifecycle message was an DBIRTH or DDEATH

Edge Nodes

The Edge Nodes folder tags provide information on the connected Edge Nodes

Name	Description
Last Node to Connect	The Sparkplug ID of the last node to connect
Last Node To Disconnect	The Sparkplug ID of the last node to disconnect
NodesOffline	The number of Sparkplug Edge Nodes offline. This is determined by whether the last lifecycle message was an NBIRTH or NDEATH
NodesOnline	The number of Sparkplug Edge Nodes online. This is determined by whether the last lifecycle message was an NBIRTH or NDEATH
NodeUnitCount	The total number of Sparkplug Edge Nodes as determined by the received NBIRTH messages
Offline Nodes	A dataset containing the Sparkplug ID and timestamp for all offline Sparkplug edge nodes
Online Nodes	A dataset containing the Sparkplug ID and timestamp for all online Sparkplug edge nodes

Latches

The Latches folder tags provide a tag path to any configured tag latches in the MQTT Engine configuration

Name	Description
TagName as defined in the MQTT Engine configuration	Writeable tag to 'reset' the tag latch

MQTT Clients

The MQTT Clients folder tags provide information on the connected MQTT Clients.

Name	Description
Latency Check Period	Frequency in milliseconds that the message latency for each MQTT Client is checked if the Enable Latency Check is checked

For each identified MQTT Client, the following tags are available

Name	Description
Primary Host State
Connected Nodes	Number of currently connected Sparkplug Edge Nodes to this MQTT Client
Enable Latency Check	Writable tag to enabled message latency checking for each MQTT Client
Message Processing Latency	The amount of time to process the last Sparkplug message
Messages Per Second	The number of MQTT messages received by Engine per second
MQTT Client ID	The Client ID for the MQTT Client
Offline DateTime	The last time at which the MQTT Client successfully disconnected from the MQTT Server
Online	A read-only tag showing the connection status of the MQTT Client
Online DateTime	The last time at which the MQTT Client successfully connected to the MQTT Server
Server Latency	The amount of time that it takes for a test MQTT message to be sent and received back by MQTT Engine
Target Server URL	The URL of the target MQTT Server to connect to

Message Diagnostics

The Message Diagnostics folder tags ...........

Name	Description
Message
Selected Node

Contents

Cirrus Link Resources

Inductive Resources