Page History

...

• Alarm Event Enable

  • When enabled and alarms are enabled on tags, MQTT Engine will receive the contents of the triggered alarms at the Edge and creates an alarm event where MQTT Engine is installed.
    

• Alarm Display Path Type - added in 4.0.30
  • The format to use for the Alarm Display Path if the Display Path property is not configured at the Edge. If the Display Path is configured, it will be used by Engine.
    • EDGE - Sets the display path as the Edge tag path
      • Edge Nodes/Tag1/MyAlarm
    • ENGINE - Sets the display path as the Engine tag path which include the Sparkplug descriptors
      • Edge Nodes/GroupID/EdgeNodeID/DeviceID/Tag1/MyAlarm
    • IDS_ANd_EDGE AND_EDGE - Sets the display path to include the Sparkplug descriptors and the Edge tag path
      • GroupID/EdgeNodeID/DeviceID/Edge Nodes/Tag1/MyAlarm
• H2 Database Directory - added in 4.0.25
  • Directory to store the H2 Database in.
  • The AlarmStore is required to maintain the alarm events across MQTT Engine module disable/enable, module restart, or power loss.
  • The default base path for Linux is ~yourIgnitionInstance\data\modules and the database will be included in the Ignition GWBK
  • The default location for Windows Linux is ~yourIgnitionInstance\user-lib\modules and the database will not be included in the Ignition GWBK
  • The database file will be created in this directory under the base path com.cirrus-link\com.cirruslink.mqtt.engine.gateway\h2
• H2 Database Port
  • TCP Port to connect to internal H2 Database

...

Image RemovedImage Added

• 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 - added in release 4.0.23
  • The amount of time in milliseconds before another Sparkplug Rebirth request can be sent to an Edge Node
  • Available in version Releases prior to 4.0.23 and newer. Older releases have a hardcoded 5 second Rebirth Debounce Delay.
• Use Cirrus Link Encoder - added in release 4.0.30
  • Whether or not to use the Cirrus Link encoder for Sparkplug payloads. This property is enabled by default.
  • This is not Sparkplug compliant but will properly encode Ignition properties such as Dataset, Document and Array types.

Anchor
Servers Servers

Servers

...