MQTT Transmission automatically creates a known set of folders (in the MQTT Transmission provider) containing tags for Transmission Control and Transmission Info.

The tables below describe the tags.

Transmission Control

NameData TypeDescription
Discover Edge NodesBooleanA writeable tag to request the BIRTH sequence for any new Edge Nodes to be published and the info tags created in the Transmission Info folder.
Discover Edge Nodes RequiredBooleanA tag indicating there are new Edge Nodes present on the gateway that have not birthed yet and a Discover Edge Nodes request is required
Last RefreshDateTimeThe time at which the last refresh request was completed
RefreshBooleanA writeable tag to request a MQTT Transmission refresh. This will force all Edge Nodes to disconnect and reconnect resulting in the sending of NDEATH, NBIRTH and DBIRTH messages

Transmission Info

NameData TypeDescription
Redundancy RoleStringThe redundancy configuration of the Ignition system that MQTT Transmission is installed on. Options are Independent, Master and Backup
Redundancy StateStringThe redundancy status of the Ignition system that MQTT Transmission is installed on. Options are Active or Cold
Refresh RequiredBooleanA tag indicating that new tags have been identified by Transmission and a refresh is required. The refresh can be accomplished with a full refresh of Transmission or by refreshing the individual Edge Node affected
VersionStringThe version MQTT Transmission currently installed

Transmitters

For each Transmitter, a tag tree will be created with the tag path of TransmitterName > Tag Path > GroupID > EdgeNodeID

NameData TypeDescription
Enable Tag TrackingBooleanWritable tag to control whether or not to update Tags Per Seconds (added 4.0.17)
Largest Mesg Xmit (bytes)LongThe largest message size in bytes sent by the Edge Node since the last time the metrics were reset via the Edge Node Reset Metrics tag
Largest Mesg Xmit TimestampDateTimeThe time at which the largest message was sent by the Edge Node since the last time the metrics were reset via the Edge Node Reset Metrics tag
Last RefreshDateTimeThe time at which the last Edge Node refresh request was completed
Refresh Edge NodeBooleanA writeable tag to request a refresh of the Edge Node. This will force the Edge Node to disconnect and reconnect resulting in the sending of NDEATH, NBIRTH and DBIRTH messages
Refresh RequiredBooleanA tag indicating the new tags have been identified by Transmission for this Edge Node and a refresh is required.
Reset MetricsBooleanA writable tag to reset the metrics for this Edge Node
Tag CountLongThe number of tags identified for this Edge Node
Tags Per SecondLongThe number of tags changes published per second with the value updated every two seconds (added 4.0.17)
Total Bytes Xmit (bytes)LongThe number of bytes sent by the Edge Node since the last time the metrics were reset via the Edge Node Reset Metrics tag
Total Mesg XmitLongThe number of messages sent by the Edge Node since the last time the metrics were reset via the Edge Node Reset Metrics tag

MQTT Client

NameData TypeDescription
Command Latency (ms)LongThe amount of time for a test MQTT command message to be sent and received back by the MQTT Client 
Enable Latency CheckBooleanWriteable tag to enable command latency checking for each MQTT Client
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
OnlineDateTimeDateTimeThe last time at which the MQTT Client successfully connected to the MQTT Server
Primary Host IDStringThe Primary Host ID configured for this MQTT Client
Target Server URLStringThe URL of the target MQTT Server to connect to

History Store

For each History Store, a folder will be created with the name of the History Store

NameData TypeDescription
Database SizeLong

(Added 4.0.22) Created if the History Store type is Disk_Backed and shows the total size of the data tables used.

This value may be smaller than the Disk Used metric as when flushed rows are marked for deletion they are only deleted from the H2 DB on its internal schedule. This is to minimize the writes on a flash/SSD drive. 

Disk UsedLong

Created if the History Store type is Disk_Backed and shows the size of the database file. This parameter will never go to zero for the following reasons:

  • The initial config of the DB will contain empty seeded tables based on the number of edge nodes and devices (table per edge node and per device) and at least one metadata table.

Memory UsedLongCreated if the History Store type is In_Memory and shows the memory used since last module restart


Under each of the History Store folders, for each Transmitter, a tag tree will be created with the tag path of GroupID > EdgeID  and/or > DeviceID

NameData TypeDescription
Metrics StoredLong

Number of Edge Node or Device level tag change events stored. For Disk_Backed History Store, this tag is updated every 30 seconds

Records StoredLong

Number of Edge Node or Device level records stored. For Disk_Backed History Store, this tag is updated every 30 seconds

Metrics Percentage UsedFloat(Deprecated 4.0.19) Number of Edge Node or Device level tag change events stored as a percentage of the configured Edge Node or Device Tag Capacity
Records Percentage UsedFloat(Deprecated 4.0.19) Number of Edge Node or Device level tag change events stored as a percentage of the configured Edge Node or Device Record Capacity
  • No labels

New to MQTT? Start Here!