ADI
info.json
GET api/adi/status/info.json[?callback=<function>]
This object holds information about the ADI JSON interface. This data is static during runtime.
Name | Data Type | Note |
|---|---|---|
dataformat | Number | 0 = Little endian 1 = Big endian (Affects value, min and max representations) |
numadis | Number | Total number of ADIs |
webversion | Number | Web/JSON API version |
JSON response example:
{
"dataformat": 0,
"numadis": 123,
"webversion": 1
}data.json
GET api/adi/status/data.json?offset=<offset>&count=<count>
[&callback=<function>]
GET api/adi/status/data.json?inst=<instance>&count=<count>
[&callback=<function>]These function calls fetch a sorted list of up to <count> ADIs values, starting from <offset> or <instance>. The returned values may change at any time during runtime.
Request data:
Name | Data Type | Description |
|---|---|---|
offset | Number | Offset is the “order number” of the first requested ADI. The first implemented ADI will always get order number 0. <count> number of existing ADI values will be returned. I.e. non-existing ADIs are skipped. |
inst | Number | Instance number of first requested ADI. <count> number of ADI values is returned. A null value will be returned for non-existing ADIs |
count | String | Number of requested ADI values |
callback | Number | Optional. A callback function for JSONP output. |
Response data:
Name | Data Type | Description |
|---|---|---|
— | Array of Strings | Sorted list of string representations of the ADI value attributes |
JSON response example (using offset):
[ "FF", "A201", "01FAC105" ]
JSON response example (using inst):
[ "FF", "A201", null, null, "01FAC105" ]
metadata.json
GET api/adi/status/metadata.json?offset=<offset>&count=<count>
[&callback=<function>]
GET api/adi/status/metadata.json?inst=<instance>&count=<count>
[&callback=<function>]These function calls fetch a sorted list of metadata objects for up to <count> ADIs, starting from <offset> or <instance>.
The returned information provided is a transparent representation of the attributes available in the host Application Data object (FEh). See the Anybus CompactCom 40 Software Design Guide for more information about the content of each attribute.
The ADI metadata is static during runtime.
Request data:
Name | Data Type | Description |
|---|---|---|
offset | Number | Offset is the “order number” of the first requested ADI. The first implemented ADI will always get order number 0. Metadata objects for <count> number of existing ADI will be returned. I.e. non-existing ADIs are skipped. |
inst | Number | Instance number of first requested ADI. Metadata objects for <count> number of ADI values are returned. A null object will be returned for non-existing ADIs |
count | String | Number of requested ADI values |
callback | Number | Optional. A callback function for JSONP output. |
Response data:
Name | Data Type | Description |
|---|---|---|
instance | Number | - |
name | String | May be NULL if no name is present. |
numelements | Number | - |
datatype | Number | - |
min | String | Hex formatted string, see Hex Format Explained for more information. May be NULL if no minimum value is present. |
max | String | Hex formatted string, see Hex Format Explained for more information. May be NULL of no maximum value is present. |
access | Number | Bit 0: Read access Bit 1: Write access |
JSON response example (using offset):
[
{
"instance": 1,
"name": "Temperature threshold",
"numelements": 1,
"datatype": 0,
"min": "00",
"max": "FF",
"access": 0x03
},
{
...
}
]JSON response example (using inst):
[
{
"instance": 1,
"name": "Temperature threshold",
"numelements": 1,
"datatype": 0,
"min": "00",
"max": "FF",
"access": 0x03
},
null,
null
{
...
}
]metadata2.json
GET api/adi/status/metadata2.json?offset=<offset>&count=<count>
[&callback=<function>]
GET api/adi/status/metadata2.json?inst=<instance>&count=<count>
[&callback=<function>]This is an extended version of the metadata function that provides complete information about the ADIs. This extended version is needed to describe more complex data types such as Structures.
The information provided is a transparent representation of the attributes available in the host Application Data object (FEh). See the Anybus CompactCom 40 Software Design Guide for more information about the content of each attribute.
The ADI metadata is static during runtime.
Request data:
Name | Data Type | Description |
|---|---|---|
offset | Number | Offset is the “order number” of the first requested ADI. The first implemented ADI will always get order number 0. Metadata objects for <count> number of existing ADI will be returned. I.e. non-existing ADIs are skipped. |
inst | Number | Instance number of first requested ADI. Metadata objects for <count> number of ADI values are returned. A null object will be returned for non-existing ADIs |
count | String | Number of requested ADI values |
callback | Number | Optional. A callback function for JSONP output. |
Response data:
Name | Data Type | Description |
|---|---|---|
instance | Number | - |
numelements | Array of umbers | - |
datatype | Array of Numbers | Array of datatypes. For Structures and Variables, each array element defines the data type of the corresponding element of the instance value. For Arrays, one array element defines the data type for all elements of the instance value. |
descriptor | Array of descriptors. For Structures and Variables, each array element defines the descriptor of the corresponding element of the instance value. For Arrays, one array element defines the descriptor for all elements of the instance value. | |
name | May be NULL if no name is present. | |
min | String | Hex formatted string, see Hex Format Explained for more information. May be NULL if no minimum value is present. |
max | String | Hex formatted string, see Hex Format Explained for more information. May be NULL of no maximum value is present. |
default | String | Hex formatted string, see Hex Format Explained for more information. May be NULL of no default value is present. |
numsubelements | Array of Numbers | For Structures and Variables each array element defines the number of subelements of the corresponding element of the instance value. May be NULL if not present. |
elementname | Array of Strings | Array of names, one for each instance value element. May be NULL if not present. |
JSON response example (using offset):
[
{
"instance": 1,
"numelements": 1,
"datatype": [0 ],
"descriptor": [9 ],
"name": "Temperature threshold",
"max": "FF",
"min": "00",
"default": "00",
"numsubelements": null,
"elementname": null
},
{
...
}
]JSON response example (instance):
[
{
"instance": 1,
"numelements": 1,
"datatype": [0 ],
"descriptor": [9 ],
"name": "Temperature threshold",
"max": "FF",
"min": "00",
"default": "00",
"numsubelements": null,
"elementname": null
},
null,
null
{
...
}
]enum.json
GET api/adi/status/enum.json?inst=<instance>[&value=<element>]
[&callback=<function>]This function call fetches a list of enumeration strings for a specific instance.
The ADI enum strings are static during runtime.
Request data:
Name | Data Type | Description |
|---|---|---|
inst | Number | Instance number of the ADI to get enum string for. |
value | Number | Optional. If given, only the enumstring for the requested <value> is returned. |
callback | String | Optional. A callback function for JSONP output. |
Response data:
Name | Data Type | Description |
|---|---|---|
string | String | String representation for the corresponding value. |
value | Number | Value corresponding to the string representation. |
JSON response example:
[
{
"string": "String for value 1",
"value": 1
},
{
"string": "String for value 2",
"value": 2
},
{
...
}
]update.json
POST api/adi/config/update.json
Form data:
inst=<instance>&value=<data>[&elem=<element>][&callback=<function>]
This function updates the value attribute of an ADI.
Request data:
Name | Data Type | Description |
|---|---|---|
inst | Number | Instance number of the ADI |
value | String | Value to set. If the value attribute is a number it shall be hes formatted, see Hex Format Explained for more information. |
elem | Number | Optional. If specified only a single element of the ADI value is set. Then <data> shall only contain the value of the specified <element>. |
callback | String | Optional. A callback function for JSONP output. |
Response data:
Name | Data Type | Note |
|---|---|---|
result | Number | 0 = success The Anybus CompactCom error codes are used. Please see the Anybus CompactCom 40 Software Design Guide. |
{
"result" : 0
}