hub.device.checked
- The broadcast is a reply to a device check sent by the hub.
Initiators: Send device checked broadcast as a response to a hub.device.check
Edit
Field | Type | Required | Description |
---|---|---|---|
deviceId | string | + | The identity of the device which was checked. |
status | string | + | Current progress on the check. Possible values are ‘Started’, ‘Finished’ and ‘Failed’. |
completed | int | – | Indicates whether or not the check has finished. |
error | object | – | Description and error code if the check failed. |
error.code | int | + | The type of error that occurred. See General error codes . and Z-Wave error codes. |
error.data | string | + | String token of the error. |
error.message | string | – | More detailed description of the error. |
Edit
Example -1
{
"id": "ui_broadcast",
"msg_subclass": "hub.device.checked",
"result": {
"completed": 0,
"device_id": "asd89ujn234kjndfdsfkjn3",
"status": "started"
}
}
Example-2
{
"id": "ui_broadcast",
"msg_subclass": "hub.device.checked",
"result": {
"device_id": "asd89ujn234kjndfdsfkjn3",
"error": {
"code": -42,
"data": "error.data",
"message": "error message"
},
"status": "failed"
}
}