Internal data points of the MQTT Publisher

_MqttPublisher

An internal data point of this type is automatically created for each connection of the MQTT Publisher. The data point name is the same as the connection name.

Note: For accessing elements of the node .Config or .Command the set user bit 4 (Administration) is required.
Data point element Type Description
Config.Address string

JSON encoded mapping for the connection to the broker. Consists of

  • connection type [uint]

  • connection string [string]

  • user name [string]

  • encrypted password [blob]

  • certificate [string]
Config.Mode uint

  • 0: inactive

  • 1: automatically active (default)
Config.AutoIGQ bit32

The bits have following meaning:

  • 0 .. disabled
  • bit 1 .. publish-on-connect
  • bit 2 .. publish-on-redu-switch
Config.CNSViews dyn_string List of CNS view names; if empty, the DP group is used.
Config.RootTopic string By default an empty string; if defined, this topic name will be used as the root node
Config.EnableStatistics bool

Enables the statistical evaluation of data for this connection.

Default = TRUE
Config.PersistentSession bool Specifies if the publisher shall establish a persistent session to the broker.
Config.LifebeatTimeout uint Timeout in seconds.
Config.Default - Settings for all published messages, unless overwritten at CNS nodes
Config.Default.Transformation uint Value transformation
Config.Default.QoS short Quality of Service
Config.Default.Retain bool Retain flag
Config.LastWill.Topic string Topic of last will message, which is sent by the broker, if the connection to the publisher is lost.
Config.LastWill.Message string Last will message which shall be sent on connection loss.
Config.LastWill.QoS uint

Quality of Service level for the last will message.

  • 0: At most once

  • 1: At least once

  • 2: Exactly once
Config.LastWill.Retain bool Specifies if the last will message is retained i.e. kept by the broker and is sent to new subscribers.
Command.IGQ bool Triggers an inverse general query, which means that all output addresses are written.
State.ConnState uint

Connection state to broker:

  • 0: Inactive

  • 1: Disconnected

  • 2: Connecting

  • 3: Connected

  • 4: Disconnecting

  • 5: Failure

  • 6: Listening
State.CNSViews Dyn_int List of connection states to all CNS views.
State.Statistics.WritesSent float Sent publish requests since driver start.
State.Statistics.WritesRej float Rejected publish requests since driver start.
State.Statistics.NotificationsPerSec float Received topic notifications per second in the last interval.