ZWave Plugin Broadcasts
Broadcasts informs about events in ZWave Plugin scripts. ZWave plugin sends all broadcasts as hub.extensions.plugin.ui_broadcast with special parameters.
include_invoked
Sends if including process was invoked but not started yet
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | include_invoked |
string | + | Event name |
plugin | zwave |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "include_invoked",
"plugin": "zwave"
}
}
include_started
Sends if including process was started
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | include_started |
string | + | Event name |
plugin | zwave |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "include_started",
"plugin": "zwave"
}
}
s2_select_authentication_modes
Sends if including zwave device requests S2 keys for continie adding it to network
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | s2_select_authentication_modes |
string | + | Event name |
modes | strings array | + | an array of available authentication modes | |
plugin | zwave |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "s2_select_authentication_modes",
"modes": [ "accessControl", "authenticated", "unauthenticated" ],
"plugin": "zwave"
}
}
s2_request_device_specific_key
Sends if including zwave device requests S2 keys for continie adding it to network
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | s2_request_device_specific_key |
string | + | Event name |
key | strings array | + | an array of 7 items device specific key (public part) | |
plugin | zwave |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "s2_request_device_specific_key",
"key": [ "58975", "37056", "29754", "11588", "18902", "12511", "34338" ],
"plugin": "zwave"
}
}
s2_show_device_side_key
Sends if including zwave device requests S2 keys for continie adding it to network
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | s2_show_device_side_key |
string | + | Event name |
key | strings array | + | an array of 2 items controller specific key (public part) | |
plugin | zwave |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "s2_show_device_side_key",
"key": [ "58975", "37056" ],
"plugin": "zwave"
}
}
include_finished
Sends if new zwave device was added and all related devices and items were added
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | include_finished |
string | + | Event name |
plugin | zwave |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "include_finished",
"plugin": "zwave"
}
}
include_finished_error
Sends if zwave plugin recieve any error during including process
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | include_finished_error |
string | + | Event name |
plugin | zwave |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "include_finished_error",
"plugin": "zwave"
}
}
include_finished_timeout
Sends if including process was ended after timeout and nothing was added
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | include_finished_timeout |
string | + | Event name |
plugin | zwave |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "include_finished_timeout",
"plugin": "zwave"
}
}
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 | zwave |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "include_device_progress",
"value": 50,
"plugin": "zwave"
}
}
exclude_invoked
Sends if excluding process was invoked but not started yet
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | exclude_invoked |
string | + | Event name |
plugin | zwave |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "exclude_invoked",
"plugin": "zwave"
}
}
exclude_started
Sends if excluding process was started
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | exclude_started |
string | + | Event name |
plugin | zwave |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "exclude_started",
"plugin": "zwave"
}
}
unknown_node_removed
Sends if zwave device from another zwave network was removed successfully
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | unknown_node_removed |
string | + | Event name |
plugin | zwave |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "unknown_node_removed",
"plugin": "zwave"
}
}
exclude_finished
Sends if zwave device of controller network was removed successfully and excluding process was ended
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | exclude_finished |
string | + | Event name |
plugin | zwave |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "exclude_finished",
"plugin": "zwave"
}
}
exclude_finished_timeout
Sends if excluding process was ended after timeout and nothing was removed from ZWave network
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | exclude_finished_timeout |
string | + | Event name |
plugin | zwave |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "exclude_finished_timeout",
"plugin": "zwave"
}
}
exclude_finished_error
Sends if zwave plugin recieve any error during excluding process
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | exclude_finished_error |
string | + | Event name |
plugin | zwave |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "exclude_finished_error",
"plugin": "zwave"
}
}
learn_invoked
Sends if learning process was invoked but not started yet
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | learn_invoked |
string | + | Event name |
plugin | zwave |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "learn_invoked",
"plugin": "zwave"
}
}
learn_started
Sends if learning process was started
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | learn_started |
string | + | Event name |
plugin | zwave |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "learn_started",
"plugin": "zwave"
}
}
learn_show_key
Gets sent if a controller is included by another (remote) controller (learn mode) and the remote controller didn't choose an
unauthenticated
mode (authentication modes).
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | learn_show_key |
string | + | Event name |
key | ints array | + | An array of 8 items (2 bytes) - device (controller) specific key (dsk) | |
plugin | zwave |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "learn_show_key",
"key": [ 48975, 58975, 37056, 29754, 11588, 18902, 12511, 34338 ],
"plugin": "zwave"
}
}
learn_progress
Indicate progress of learn mode or, in other words, 'their' network devices interview progress
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | learn_progress |
string | + | Event name |
devices | int | + | Amount of devices in a network we're learning | |
current | int | + | Index of a current including device | |
status | string | + | Progress status | |
plugin | zwave |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "learn_progress",
"devices": 100500,
"current": 42,
"status": "in progress",
"plugin": "zwave"
}
}
learn_finished
Sends if controller was included in another ZWave network
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | learn_finished |
string | + | Event name |
plugin | zwave |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "learn_finished",
"plugin": "zwave"
}
}
learn_finished_error
Sends if zwave plugin recieve any error during learning process
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | learn_finished_error |
string | + | Event name |
plugin | zwave |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "learn_finished_error",
"plugin": "zwave"
}
}
learn_finished_timeout
Sends if including process was ended after timeout and controller was not added in any network
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | learn_finished_timeout |
string | + | Event name |
plugin | zwave |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "learn_finished_timeout",
"plugin": "zwave"
}
}
action_busy
Sends if user tries to run exclude/include/learn/reset operation during other not finished exclude/include/learn/reset operation
initiators:
- scripts/start_include
- scripts/stop_include
- scripts/start_exclude
- scripts/stop_exclude
- scripts/start_learn
- scripts/stop_learn
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | action_busy |
string | + | Event name |
action_type | string | + | Name of operation which is running now. Can contain any of ZWave Addon action types | |
plugin | zwave |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "action_busy",
"action_type": "include_starting",
"plugin": "zwave"
}
}
module_reset
Sends if user tries to run exclude/include/learn/reset operation during other not finished exclude/include/learn/reset operation
initiators:
result fields:
Field | Value | Type | Required | Description |
---|---|---|---|---|
event | module_reset |
string | + | Event name |
status | string | + | Name of current status, can be any of ZWave Addon event statuses | |
plugin | zwave |
string | + | Plugin name |
Examples
{
"id": "ui_broadcast",
"msg_subclass": "hub.extensions.plugin.ui_broadcast",
"result": {
"event": "module_reset",
"status": "started",
"plugin": "zwave"
}
}