Versions Compared

Key

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

...

  • timestamp
    • The time stamp that the payload was created
  • metrics
    • An array containing data specific to the message type being published
    • Each object in the array will include the following name/value pairs:
      • name
      • timestamp
      • dataType
      • value
    • Optional name/value pairs include:
      • metaData ****
        • NEED TO ADD DETAILS HERE
      • properties
        • The Quality property. See the Ignition Tag Property Enum Reference for the Data Quality value reference.
          • If the Quality property is not included, the quality of the tag data is considered Good.
        • Additional property values such as engHigh, engLow etc are included if they have been changed from the Ignition default. See the Ignition Tag Properties reference for all available properties.
  • seq
    • The message sequence number used to ensure that messages are processed in the correct order

...

Code Block
titleDevice BIRTH message
{
  "topic": {
      "namespace": "spBv1.0",
      "edgeNodeDescriptor": "G1/E1",
      "groupId": "G1",
      "edgeNodeId": "E1",
      "deviceId": "D1",
      "type": "DBIRTH"
  },
  "payload": {
    "timestamp": 1638223073192,
    "metrics": [
      {
        "name": "Tag 1",
        "timestamp": 1638223073192,
        "dataType": "Int32",
        "metaData": {},
        "properties": {
            "Quality": {
                "type": "Int32",
                "value": 192
            }
        },
        "value": 1
        },
      {
        "name": "Tag 2",
        "timestamp": 1638223073011,
        "dataType": "Boolean",
        "metaData": {},
        "properties": {
             "Quality": {
                 "type": "Int32",
                 "value": 192
             }
        },
        "value": false
      },
      {
        "name": "Tag 3",
        "timestamp": 1638223073041,
        "dataType": "Float",
        "metaData": {},
        "properties": {
             "Quality": {
                 "type": "Int32",
                 "value": 192
             }
        },
        "value": 1.23
      }
     ],
    "seq": 1
  }
}


Anchor
DDATA
DDATA
DDATA or NDATA

The metrics array for the Device DDATA or Edge Node NDATA message will contain: 

  • Any Device tags defined in either the Device folder or Edge Node folder that have changed, For example if we write the value 10 to Tag 1

...