Zigbee Plugin Broadcasts
Broadcasts informs about events in Zigbee Plugin scripts. Zigbee plugin sends all broadcasts as hub.extensions.plugin.ui_broadcast with special parameters.
include_device
Sends if device inclusion status changed
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | include_device |
string | + | Event name |
status | string | + | Name of current status, can be any of Zigbee Addon event statuses | |
plugin | zigbee |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "include_device",
"status": "started",
"plugin": "zigbee"
}
}
include_device_progress
Sends if device inclusion progress changed
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | include_device_progress |
string | + | Event name |
value | int | + | progress in percents (0-100) | |
plugin | zigbee |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "include_device_progress",
"value": 50,
"plugin": "zigbee"
}
}
module_reset
It sends if module reset status changed. Now reporting status implemented for 'invoked', 'started' and 'finished'
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | module_reset |
string | + | Event name |
status | string | + | Name of current status, can be any of Zigbee Addon event statuses | |
plugin | zigbee |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "module_reset",
"plugin": "zigbee",
"status": "invoked"
}
}