Zigbee events
The Zigbee addon notifies a script subscribed by zigbee.subscribe( "script_name" )
about state of the Zigbee world.
Structure of an event is table.
Type of events:
include_device - gets sent if a Zigbee device inclusion status changed
{
event = "include_device"
status = "started"
}
fields | type | description |
---|---|---|
event | string | type of an event |
status | string | actual event status |
include_device_progress - gets sent if a Zigbee device inclusion progress changed
{
event = "include_device_progress"
value = 50
}
fields | type | description |
---|---|---|
event | string | type of an event |
value | int | progress in percents (0-100) |
node_added - gets sent if a new Zigbee device has been included
{
event = "node_added",
node_id = 2
}
fields | type | description |
---|---|---|
event | string | type of an event |
node_id | int | a unique id of a Zigbee device within a Zigbee network |
node_removed - gets sent if a Zigbee device has been excluded from hub network
{
event = "node_removed",
node_id = 2,
manufactured_id = "Ezlo",
model_id = "Ezlo plug"
}
fields | type | description |
---|---|---|
event | string | type of an event |
node_id | int | |
manufactured_id | string | |
model_id | string |
attribute_value_updated - gets sent if a pcp value has been changed
{
event = "attribute_value_updated",
node_id = 2,
endpoint_id = 1,
cluster_name = "ias_zone",
attribute = {...}
}
fields | type | description |
---|---|---|
event | string | type of an event |
node_id | int | node ID |
endpoint_id | int | endpoint ID |
cluster_name | string | name of attribute cluster |
attribute | table | attribute with new value |
mfg_specific_attribute_value_updated - gets sent if a manufacturer specific pcp value has been changed
{
event = "mfg_specific_attribute_value_updated",
node_id = 2,
endpoint_id = 1,
cluster_id = 35,
attribute = {...}
}
fields | type | description |
---|---|---|
event | string | type of an event |
node_id | int | node ID |
endpoint_id | int | endpoint ID |
cluster_id | int | attribute cluster ID |
attribute | table | attribute with new value |
unknown_attribute_value_updated - gets sent if an unknown attribute(that wasn't reported during inclusion process) value has been changed
{
event = "unknown_attribute_value_updated",
node_id = 2,
endpoint_id = 1,
cluster_id = 15,
cluster_name = "ias_zone",
attribute_id = 0,
attribute_name = "ZoneStatus",
value = "1"
}
fields | type | description |
---|---|---|
event | string | type of an event |
node_id | int | node ID |
endpoint_id | int | endpoint ID |
cluster_id | int | ID of attribute cluster |
cluster_name | string | name of attribute cluster |
attribute_id | int | attribute ID |
attribute_name | int | attribute name |
value | string | new attribute value |
simple_command_received - gets sent if command without parameters received
{
event = "simple_command_received",
node_id = 2,
endpoint_id = 1,
cluster_name = "ias_zone",
command_id = 0,
command_name = "Panic"
}
fields | type | description |
---|---|---|
event | string | type of an event |
node_id | int | node ID |
endpoint_id | int | endpoint ID |
cluster_name | string | name of attribute cluster |
command_id | int | command ID |
command_name | string | name of command |
arm_command_received - gets sent if IAS Ace Arm command received
{
event = "arm_command_received",
node_id = 2,
endpoint_id = 1,
cluster_name = "ias_ace",
command_id = 0,
command_name = "Arm",
arm_mode = "disarm"
pin_code = "1234"
}
fields | type | description |
---|---|---|
event | string | type of an event |
node_id | int | node ID |
endpoint_id | int | endpoint ID |
cluster_name | string | name of attribute cluster |
command_id | int | command ID |
command_name | string | name of command |
arm_mode | string | action to be applied on zone |
pin_code | string | pin code |
Possible arm modes |
---|
disarm |
arm_day_home_zones_only |
arm_night_home_zones_only |
arm_all_zones |
module_reset - gets sent if a pcp value has been changed
{
"event": "module_reset",
"status": "invoked"
}
fields | type | description |
---|---|---|
event | string | type of an event |
status | string | actual event status |
reachable_state_updated - gets sent if a Zigbee device reachable state has been changed
{
event = "reachable_state_updated",
node_id = 2,
value = true
}
fields | type | description |
---|---|---|
event | string | type of an event |
node_id | int | a unique id of a Zigbee device within a Zigbee network |
value | bool | true if Zigbee device is reachable, false otherwise |