JSON Format for Commands

A JSON object describing an MQTT command has the following syntax:

{
  "@Skill.MQTT.Topic": {
    "name": "Axis 1 Motor Temperature",
    "UUID": "d8cf1aa4-f484-4fc1-abe7-5f594640915a",
    "ACL": { ... },
    "topic": "axis-1/motor/temperature",
    "payload": ...,
    "extraAttributes": [
      "changeTime",
      "error"
    ],
    "QoS": 0,
    "retained": false,
    "requiredForBirth": false
  }
}

Object Members

name	A string value containing the name of the command. The name is used to construct the command’s primary key.
UUID	A string value containing the unique UUID of the command.
ACL	An optional JSON object containing the element ACL of the command. The format of the object is described under JSON Format for ACLs in the Xentara user manual.
topic	A string value containing the topic to subscribe to. See 3.3.2.1 Topic Name in the MQTT specification for details.
payload	A JSON array containing the data points to write when a message is received. Each array element is a JSON object containing information about a single data point. The objects are double nested JSON objects. The outer object has a single member whose name is "@DataPoint", and whose value is another JSON object that contains the actual configuration of the data point. The inner object has the following members: jsonPath A string value containing a JSONPath describing the location of the value within the message payload. dataPoint A string value describing the data point or skill data point the value should be written to. The string value must contain the primary key of the data point. asJSONText An optional Boolean value specifying whether the value schould be written as a string containing the original JSON text rather than decoding the value, as described in the chapter Writing the Individual JSON Values. If you do not specify this option, then the JSON value will be decoded before writing it to the data point. This is the same as specifying false.