Versions Compared

Key

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

...

  • Enable Tag Latching
    • Whether or not to enable Tag latching to synchronize MQTT Tag updates with events in Ignition.
  • Latch Timeout

    • The amount of time to wait for a Tag latch to be released before timing out.
  • Latch Tags

    • A semicolon separated list comma separated list of Trigger Tag and Latch Tag pairs.
  • Filtered Properties
    • A semicolon delimited list of Tag properties to filter/ignore on received Tags.
    • 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 from Transmission if different from the default Ignition tag property settings and are only published in BIRTH messages.
  • Enable BD Sequence Validation

    • Whether or not to enable BIRTH/DEATH sequence number validation (required by Sparkplug specification).
  • Enable Metric Timestamp Validation
    • Enables/disables validation of metric timestamps against the current tag value timestamp before writing. If enabled, tag writes will only occur if the new incoming metric timestamp is newer than the current tag timestamp.
  • Custom Properties
    • Do not use unless instructed to by Cirrus Link personnel.
  • Primary Host Control Tags
    • A semicolon separated list of comma separated Primary Host Control tags triples (e.g., tagPath1,tagDataType1,tagValue1;tagPath2,tagDataType2,tagValue2). Review MQTT Engine Primary Host Control for additional information.
    • Supported tag DataTypes are: Byte, Short, Integer, Long, Float, Double, Boolean and String
  • Rebirth Debounce Delay
    • The amount of time in milliseconds before another Sparkplug Rebirth request can be sent to an Edge Node
    • Available in version 4.0.23 and newer. Older releases have a hardcoded 5 second Rebirth Debounce Delay.

Anchor
Servers
Servers
Servers

...

Default namespaces are provided out of the box and can simply be enabled or disabled.  When when MQTT Engine is first installed, all non Sparkplug B default namespaces are disabled.

The Default tab has four parts - General, Filters, Files and String Conversions

...

Selecting Edit for Elecsys will bring up two tabs - General and Filters

Selecting Edit for Sparkplug A will bring up two tabs - General and Filters

Selecting Edit for Sparkplug B will bring up four tabs - General, Filters, Files and String Conversions

Selecting Edit for Xirgo will bring up one tabs - General


Anchor
NamespacesDefaultGeneralNonSparkplugB
NamespacesDefaultGeneralNonSparkplugB
Namespaces Default Non Sparkplug B - General

Image AddedImage Removed

  • Name
    • A friendly name of the namespace to easily identify it.
  • Enabled
    • Whether or not the namespace is enabled. 
    • If enabled, MQTT Engine will subscribe to the topics necessary to provide support for devices and data associated with that namespace.  If disabled, MQTT Engine will unsubscribe from those topics and no longer support the devices and data associated with that namespace.

Anchor
NamespacesDefaultGeneralSparkplugB
NamespacesDefaultGeneralSparkplugB
Namespaces Default Sparkplug B - General

Image Added


  • Name
    • A friendly name of the namespace to easily identify it.
  • Enabled
    • Whether or not the namespace is enabled. 
    • If enabled, MQTT Engine will subscribe to the topics necessary to provide support for devices and data associated with that namespace.  If disabled, MQTT Engine will unsubscribe from those topics and no longer support the devices and data associated with that namespace.
  • Default Tags Enabled
    • Included in release 4.0.23 and newer
    • Enable MQTT Engine tags in the 'Edge Nodes' folder prefixed by the Sparkplug IDs
  • UNS Tags Enabled
    • Included in release 4.0.23 and newer
    • Enable MQTT Engine tags in a specified folder using the metric path as the tag path
  • UNS Folder Prefix
    • Included in release 4.0.23 and newer
    • The MQTT Engine folder prefix to use for UNS tags

Anchor
NamespacesDefaultFilters
NamespacesDefaultFilters
Namespaces Default - Filters

...