Versions Compared

Key

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

MQTT Transmission automatically creates a known set of folders containing tags for Transmission Control and Transmission Info.

The tables below describe the tags.

Table of Contents

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 that new Edge Nodes have been added and identified by Transmission
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
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

Transmitters

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

NameData TypeDescription
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
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