Versions Compared

Key

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

...

  • timestamp
    • The time stamp the payload was created
  • metrics
    • An array containing data specific to the message type being published
    • Parameters include:
      • name
        • Tag folder hierarchy not used in the topic namespace
        • Set to null in DATA messages if aliasing used
      • timestamp
        • Timestamp associated with the last tag change event
      • dataType
        • DataType associated with the tag
      • value
        • Value associated with the tag
      • alias
        • Numeric value representing the tag rather than a name
        • Set to null if aliasing not used
      • isHistorical
        • Flag denoting the metric represents a historical value
        • Set to null for live data and True for historical if metric has no historic data 
      • isTransient
        • Not used in Cirrus Link modules
        • Set to null 
      • isNull
        • Flag denoting the metric has a null value
      • metaData
        • Set to null
        • Included in BIRTH messages Includes if tag Meta Data (Tooltip and Documentation if they have been ) has changed from Ignition defaults
      • properties
        • Set to null if no changes from Ignition defaults.
        • See the Ignition default. See the Ignition Tag Properties reference for all available properties.
        properties
        • The Quality propertyMay be included in BIRTH and DATA messages
        • If the Quality property is not included, the quality of the tag data is considered Good. See the Ignition Tag Quality Code Reference for the Data Quality value reference
        • Additional property values

          Included only in BIRTH messages

          Included

          if they have been changed from the Ignition default or if they are custom properties.

          See the Ignition Tag Properties reference for all available properties.

           

          Tip
          If the Quality property is not included, the quality of the tag data is considered Good
  • seq
    • The message sequence number used to ensure that messages are processed in the correct order
  • uuid
    • Set to null
  • body
    • Set to null

...