JSON Format for Devices

A JSON object describing a Device has the following syntax:

{
  "@Skill.ADS.Device": {
    "name": "Device",
    "UUID": "2d56a464-132d-4f0c-8492-89479dda7f9c",
    "ACL": { ... },
    "targetAddress": "10.20.30.40",
    "targetNetId": "1.2.3.4.5.6",
    "targetAmsPort": 851,
    "keepAlive": "5s",
    "disableSumCommands": false,
    "children": [
      ...
    ]
  }
}

Object Members

name	A string value containing the name of the Device. The name is used to construct the Device’s primary key.
UUID	A string value containing the unique UUID of the Device.
ACL	An optional JSON object containing the element ACL of the Device. The format of the object is described under JSON Format for ACLs in the Xentara user manual.
targetAddress	A string value containing the network address (IP address or domain name) of the target ADS device.
targetNetId	A string value containing the AMS NetID of the target ADS device.
targetAmsPort	A string value containing the port number of the target ADS device. If omitted, the default value of 851 will be used.
keepAlive	A time interval which the device should check the connection health based on.
disableSumCommands	A flag that disables the read and write operations to be performed in batches using ADS SumCommands. In this case ADS read/write operations will be handled individually using normal ADS commands. If omitted the default value of “false” will be used. Warning Setting this flag has a significant negative impact on performance. Only use it if your ADS device does not support ADS SumCommands.
children	An array of Variable and Poll elements this device defines. The individual child elements are each represented by a double nested JSON object, as described in Element Blocks under Structure of the Model File in the Xentara user manual. The outer object has a single member whose name is the type of element, and whose value is another JSON object that contains the actual properties of the element.