Alarms

class st.zigbee.zcl.clusters.Alarms
ID: number

0x0009 the ID of this cluster

NAME: str

“Alarms” the name of this cluster

attributes: st.zigbee.zcl.clusters.AlarmsServerAttributes or st.zigbee.zcl.clusters.AlarmsClientAttributes
commands: st.zigbee.zcl.clusters.AlarmsServerCommands or st.zigbee.zcl.clusters.AlarmsClientCommands
types: st.zigbee.zcl.clusters.AlarmsTypes

Alarms Attributes

class st.zigbee.zcl.clusters.Alarms.AlarmCount
ID: number

0x0000 the ID of this attribute

NAME: str

“AlarmCount” the name of this attribute

data_type: st.zigbee.data_types.Uint16

the data type of this attribute

augment_type(base_type_obj)
Parameters:

base_type_obj (any)

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters:
Returns:

containing an AttributeReport body

Return type:

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

Create a Uint16 object of this attribute with any additional features provided for the attribute

This is also usable with the AlarmCount(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Uint16

Return type:

st.zigbee.data_types.Uint16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters:

  • device (st.zigbee.Device)

  • min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute

  • max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

  • rep_change (st.zigbee.data_types.Uint16) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

Alarms Commands

class st.zigbee.zcl.clusters.Alarms.Alarm
ID: number

0x00 the ID of this command

NAME: str

“Alarm” the name of this command

alarm_code: st.zigbee.data_types.Enum8
cluster_identifier: st.zigbee.data_types.ClusterId
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

Alarm

set_field_names()
static build_test_rx(device, alarm_code, cluster_identifier)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, alarm_code, cluster_identifier)

Initialize the Alarm command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.Alarms.GetAlarmResponse
ID: number

0x01 the ID of this command

NAME: str

“GetAlarmResponse” the name of this command

status: st.zigbee.data_types.ZclStatus
alarm_code: st.zigbee.data_types.Enum8
cluster_identifier: st.zigbee.data_types.ClusterId
time_stamp: st.zigbee.data_types.Uint32
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

GetAlarmResponse

set_field_names()
static build_test_rx(device, status, alarm_code, cluster_identifier, time_stamp)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, status, alarm_code, cluster_identifier, time_stamp)

Initialize the GetAlarmResponse command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.Alarms.ResetAlarm
ID: number

0x00 the ID of this command

NAME: str

“ResetAlarm” the name of this command

alarm_code: st.zigbee.data_types.Enum8
cluster_identifier: st.zigbee.data_types.ClusterId
get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

ResetAlarm

set_field_names()
static build_test_rx(device, alarm_code, cluster_identifier)

Build a version of this message as if it came from the device

Parameters:
Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device, alarm_code, cluster_identifier)

Initialize the ResetAlarm command

Parameters:
Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.Alarms.ResetAllAlarms
ID: number

0x01 the ID of this command

NAME: str

“ResetAllAlarms” the name of this command

get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

ResetAllAlarms

set_field_names()
static build_test_rx(device)

Build a version of this message as if it came from the device

Parameters:

device (st.zigbee.Device) – the device to build the message from

Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device)

Initialize the ResetAllAlarms command

Parameters:

  • self (ResetAllAlarms) – the template class for this command

  • device (st.zigbee.Device) – the device to build this message to

Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.Alarms.GetAlarm
ID: number

0x02 the ID of this command

NAME: str

“GetAlarm” the name of this command

get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

GetAlarm

set_field_names()
static build_test_rx(device)

Build a version of this message as if it came from the device

Parameters:

device (st.zigbee.Device) – the device to build the message from

Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device)

Initialize the GetAlarm command

Parameters:

  • self (GetAlarm) – the template class for this command

  • device (st.zigbee.Device) – the device to build this message to

Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.Alarms.ResetAlarmLog
ID: number

0x03 the ID of this command

NAME: str

“ResetAlarmLog” the name of this command

get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

ResetAlarmLog

set_field_names()
static build_test_rx(device)

Build a version of this message as if it came from the device

Parameters:

device (st.zigbee.Device) – the device to build the message from

Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device)

Initialize the ResetAlarmLog command

Parameters:

  • self (ResetAlarmLog) – the template class for this command

  • device (st.zigbee.Device) – the device to build this message to

Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx