...
| Code Block |
|---|
|
[
{
"gatewayApiVersion":"2.0.13",
"protocolName":"zigbee",
"protocolVersion":3,
"messageType":"zcl_response",
"message":{
"sourceNode":"0xCD22",
"sourceEndpoint":"0x01",
"localEndpoint":"0x01",
"clusterId":"0x0000",
"encryption":"0x00",
"frameControl":"0x18",
"manufacturerCode":"0x0000",
"transactionNum":"0x13",
"commandId":"0x01",
"payload":"0x0000002003"
}
}
] |
Write Attribute
| Code Block |
|---|
| language | java |
|---|
| title | Write Attribute Example |
|---|
|
ZigBeeDevice device = ...
int clusterID = 0x0000 // Basic Cluster
int attributeID = 0x0075 // random attribute with read/write access control
short dataType = 0x21 // UInt16
byte[] value = new byte[]{(btye)0x34, (byte)0x12}; // writing the value 0x1234, Little-Endian
CompletableFuture<Property> results = device.writeAttribute(clusterID, attributeID, dataType, value)
results.whenComplete((propertyResult, error) -> {
if (error != null) {
// handle error of computation
} else {
String jsonResults = propertyResult.getValue()
...
// parse results
...
}
}); |
Response
| Code Block |
|---|
|
[
{
"gatewayApiVersion":"2.0.14-SNAPSHOT",
"protocolName":"zigbee",
"protocolVersion":3,
"messageType":"zcl_response",
"message":{
"sourceNode":"0x4544",
"sourceEndpoint":"0x01",
"localEndpoint":"0x01",
"clusterId":"0x0000",
"encryption":"0x00",
"frameControl":"0x18",
"manufacturerCode":"0x0000",
"transactionNum":"0x11",
"commandId":"0x04",
"payload":"0x00" //success
}
}
] |
Unicast
| Code Block |
|---|
| language | js |
|---|
| title | Unicast Example |
|---|
|
|
Broadcast
Multicast
| Code Block |
|---|
| language | java |
|---|
| title | Multicast Example |
|---|
|
|
Failed
...
Requests
Default Response
If there is an error with the request, you will get a default response with a status code.
e.g Default Response, Status Code 0x01 (Failure).
Note: Status Code of 0x00 mean success
| Code Block |
|---|
| language | js |
|---|
| title | Failed Request |
|---|
|
[
{
"gatewayApiVersion":"2.0.14-SNAPSHOT13",
"protocolName":"zigbee",
"protocolVersion":3,
"messageType":"default_response",
"message":{
"status":"0x01"
}
}
] |
ZCL Response
For certain situations, you could receive a ZCL Response with a failure status
| Code Block |
|---|
[
{
"gatewayApiVersion":"2.0.14",
"protocolName":"zigbee",
"protocolVersion":3,
"messageType":"zcl_response",
"message":{
"sourceNode":"0x4544",
"sourceEndpoint":"0x01",
"localEndpoint":"0x01",
"clusterId":"0x0000",
"encryption":"0x00",
"frameControl":"0x18",
"manufacturerCode":"0x0000",
"transactionNum":"0x12",
"commandId":"0x04",
"payload":"0x869900"
}
}
] |
Status Codes
<todo list status codes here>
Data Types
<todo list data types here>
References