MQTT Transmission UNS Transmitter

The UNS Transmitter can be configured to read tags from the UNS structure created by MQTT Engine and publish tag changes over MQTT to any Enterprise consuming clients. Each transmitter is configured with a server Set and will attempt to maintain an MQTT client connection with one server in that Set at all times.

The UNS Transmitter will use the namespace unsAv1.0 and will prefix this to all publishes from MQTT Transmission

The configuration sections available are Tag Settings, Publish Settings, History Settings and Advanced Settings.

UNS Transmitters - Tag Settings

• Name
  • Unique name for the UNS Transmitter
• Enabled
  • Checkbox to enable/disable the UNS Transmitter. Selected by default.
• Tag Provider
  
  • The name of the tag provider that Transmission will monitor.
• Tag Path
  • Optional path to the root folder where the tag tree starts.
  • Transmitters also support a multi-tag path configuration. Reference the Transmitters with Multi-Tag Paths tutorial for configuration assistance.
• Set
  • The Set that the UNS Transmitter client will connect to.
• Discovery Delay
  • An optional startup delay, in milliseconds, to wait before scanning for Tags to monitor. This is useful when Tags are dynamically created on initial startup, as is the case when using the MQTT Engine module.

UNS Transmitters - Publish Settings

• Properties QoS
  • The MQTT Quality of Service to use for 'properties' messages
• Properties Retain
  • Whether or not to set the MQTT retain flag to true for 'properties' messages
• Data QoS
  • The MQTT Quality of Service to use for 'data' messages
• Data Retain
  • Whether or not to set the MQTT retain flag to true for 'data' messages

UNS Transmitters - History Settings

• History Store
  • The MQTT Transmission History Store to use with the UNS Transmitter.
• Enable History Storage by Default
  • Checkbox to enable/disable store and forward for all tags. Selected by default. 
  • Store and forward controls whether or not a tag is stored in the configured History Store when Transmission is offline. To override the global setting, individual tags will require a custom tag property 'StoreAndForward' (type: boolean) to be created and set to the reverse state of the global setting.

UNS Transmitters - Advanced Settings

• Send All Properties
  • Send all properties, including default properties, in .props messages
• Filtered Properties
  • A semicolon delimited list of Tag properties to filter/block from being published

  • By default the filtered properties list contains: 

    accessRights;clampMode;deadband;deadbandMode;formatString;historicalDeadband;historicalDeadbandMode;historicalDeadbandStyle;historyEnabled;historyMaxAge;historyMaxAgeUnits;historyProvider;historySampleRate;historySampleRateUnits;historyTagGroup;historyTimeDeadband;historyTimeDeadbandUnits;opcItemPath;opcServer;permissionModel;rawHigh;rawLow;sampleMode;scaleFactor;scaleMode;scaledHigh;scaledLow;tagGroup;valueSource;expression;expressionType;ConfiguredTagPath;eventScripts;readPermissions;writePermissions;eventScripts;parentEnabled;sourceTagPath

    
    

  • Tag properties are only published if different from the default Ignition tag property settings.

UNS Messages

UNS Data Message

A single UNS Data Message is published for each tag when QualifiedValue of the tag changes 

• Topic
  • Ignition tag path starting at the Tag Path defined in the transmitter
  • Example: unsAv1.0/Vancouver/Area1/Line1/Zone1/Asset1/T1

• Payload
  • JSON formatted payload containing tag name, dataType, value, timestamp and qualityCode
  • Example: {"name":"Vancouver/Area1/Line1/Zone1/Asset1/T1","dataType":"Int32","value":120,"timestamp":1727215043878,"qualityCode":192}

UNS Properties Message

Tag properties are only included if different from the default Ignition tag property settings unless configuration property Send All Properties is True

• Topic
  • Ignition tag path starting at the Tag Path defined in the transmitter extended by .props
  • Example: unsAv1.0/Vancouver/Area1/Line1/Zone1/Asset1/T1.props
• Payload
  • JSON formatted payload containing non default or custom property values 
  • Example: {"SparkplugEdgeNodeId":{"type":"String","value":"E1"},"SparkplugGroupId":{"type":"String","value":"G1"},"enabled":{"type":"Boolean","value":true},"SparkplugDeviceId":{"type":"String","value":"D1"}}