ApplianceEventsAlerts
- class st.zigbee.zcl.clusters.ApplianceEventsAlerts
- ID: number
0x0B02 the ID of this cluster
- NAME: str
“ApplianceEventsAlerts” the name of this cluster
- attributes: st.zigbee.zcl.clusters.ApplianceEventsAlertsServerAttributes or st.zigbee.zcl.clusters.ApplianceEventsAlertsClientAttributes
- commands: st.zigbee.zcl.clusters.ApplianceEventsAlertsServerCommands or st.zigbee.zcl.clusters.ApplianceEventsAlertsClientCommands
- types: st.zigbee.zcl.clusters.ApplianceEventsAlertsTypes
ApplianceEventsAlerts Attributes
ApplianceEventsAlerts Commands
- class st.zigbee.zcl.clusters.ApplianceEventsAlerts.GetAlertsResponse
- ID: number
0x00 the ID of this command
- NAME: str
“GetAlertsResponse” the name of this command
- alerts_count: st.zigbee.zcl.clusters.ApplianceEventsAlerts.types.AlertsCount
- alert_structure_list: list[st.zigbee.zcl.clusters.ApplianceEventsAlerts.types.AlertStructure]
- get_fields()
- static deserialize(buf)
Deserialize this command
- Parameters
buf (
buf
) – the bytes of the command body- Return type
GetAlertsResponse
- set_field_names()
- static build_test_rx(device, alerts_count, alert_structure)
Build a version of this message as if it came from the device
- Parameters
device (
st.zigbee.Device
) – the device to build the message fromalerts_count (
st.zigbee.zcl.clusters.ApplianceEventsAlerts.types.AlertsCount
) –alert_structure (
list[st.zigbee.zcl.clusters.ApplianceEventsAlerts.types.AlertStructure]
) –
- Returns
The full Zigbee message containing this command body
- Return type
- init(self, device, alerts_count, alert_structure)
Initialize the GetAlertsResponse command
- Parameters
self (
GetAlertsResponse
) – the template class for this commanddevice (
st.zigbee.Device
) – the device to build this message toalerts_count (
st.zigbee.zcl.clusters.ApplianceEventsAlerts.types.AlertsCount
) –alert_structure (
list[st.zigbee.zcl.clusters.ApplianceEventsAlerts.types.AlertStructure]
) –
- Returns
the full command addressed to the device
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.ApplianceEventsAlerts.AlertsNotification
- ID: number
0x01 the ID of this command
- NAME: str
“AlertsNotification” the name of this command
- alerts_count: st.zigbee.zcl.clusters.ApplianceEventsAlerts.types.AlertsCount
- alert_structure_list: list[st.zigbee.zcl.clusters.ApplianceEventsAlerts.types.AlertStructure]
- get_fields()
- static deserialize(buf)
Deserialize this command
- Parameters
buf (
buf
) – the bytes of the command body- Return type
AlertsNotification
- set_field_names()
- static build_test_rx(device, alerts_count, alert_structure)
Build a version of this message as if it came from the device
- Parameters
device (
st.zigbee.Device
) – the device to build the message fromalerts_count (
st.zigbee.zcl.clusters.ApplianceEventsAlerts.types.AlertsCount
) –alert_structure (
list[st.zigbee.zcl.clusters.ApplianceEventsAlerts.types.AlertStructure]
) –
- Returns
The full Zigbee message containing this command body
- Return type
- init(self, device, alerts_count, alert_structure)
Initialize the AlertsNotification command
- Parameters
self (
AlertsNotification
) – the template class for this commanddevice (
st.zigbee.Device
) – the device to build this message toalerts_count (
st.zigbee.zcl.clusters.ApplianceEventsAlerts.types.AlertsCount
) –alert_structure (
list[st.zigbee.zcl.clusters.ApplianceEventsAlerts.types.AlertStructure]
) –
- Returns
the full command addressed to the device
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- class st.zigbee.zcl.clusters.ApplianceEventsAlerts.EventNotification
- ID: number
0x02 the ID of this command
- NAME: str
“EventNotification” the name of this command
- event_header: st.zigbee.data_types.Uint8
- event_id: st.zigbee.zcl.clusters.ApplianceEventsAlerts.types.EventId
- get_fields()
- static deserialize(buf)
Deserialize this command
- Parameters
buf (
buf
) – the bytes of the command body- Return type
EventNotification
- set_field_names()
- static build_test_rx(device, event_header, event_id)
Build a version of this message as if it came from the device
- Parameters
device (
st.zigbee.Device
) – the device to build the message fromevent_header (
st.zigbee.data_types.Uint8
) –event_id (
st.zigbee.zcl.clusters.ApplianceEventsAlerts.types.EventId
) –
- Returns
The full Zigbee message containing this command body
- Return type
- init(self, device, event_header, event_id)
Initialize the EventNotification command
- Parameters
self (
EventNotification
) – the template class for this commanddevice (
st.zigbee.Device
) – the device to build this message toevent_header (
st.zigbee.data_types.Uint8
) –event_id (
st.zigbee.zcl.clusters.ApplianceEventsAlerts.types.EventId
) –
- Returns
the full command addressed to the device
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
ApplianceEventsAlerts Types
- class st.zigbee.zcl.clusters.ApplianceEventsAlerts.types.AlertsCount: st.zigbee.data_types.Uint8
- byte_length: number
1
- NUM_ALERTS: number
15
- ALERT_TYPE: number
240
- is_num_alerts_set()
- Returns
True if the value of NUM_ALERTS is non-zero
- Return type
boolean
- set_num_alerts(fieldVal)
Set the value of the bits in the NUM_ALERTS field
- Parameters
fieldVal (
number
) – the value to set the bitfield to
- get_num_alerts()
Get the value of the bits in the NUM_ALERTS field
- unset_num_alerts()
Set the value of the bits in the NUM_ALERTS field to 0
- is_alert_type_set()
- Returns
True if the value of ALERT_TYPE is non-zero
- Return type
boolean
- set_alert_type(fieldVal)
Set the value of the bits in the ALERT_TYPE field
- Parameters
fieldVal (
number
) – the value to set the bitfield to
- get_alert_type()
Get the value of the bits in the ALERT_TYPE field
- unset_alert_type()
Set the value of the bits in the ALERT_TYPE field to 0
- class st.zigbee.zcl.clusters.ApplianceEventsAlerts.types.AlertStructure: st.zigbee.data_types.Uint24
- byte_length: number
3
- ALERT_ID: number
255
- CATEGORY: number
3840
- PRESENCE_RECOVERY: number
12288
- UNUSED: number
49152
- MANUFACTURER_SPECIFIC: number
16711680
- is_alert_id_set()
- Returns
True if the value of ALERT_ID is non-zero
- Return type
boolean
- set_alert_id(fieldVal)
Set the value of the bits in the ALERT_ID field
- Parameters
fieldVal (
number
) – the value to set the bitfield to
- get_alert_id()
Get the value of the bits in the ALERT_ID field
- unset_alert_id()
Set the value of the bits in the ALERT_ID field to 0
- is_category_set()
- Returns
True if the value of CATEGORY is non-zero
- Return type
boolean
- set_category(fieldVal)
Set the value of the bits in the CATEGORY field
- Parameters
fieldVal (
number
) – the value to set the bitfield to
- get_category()
Get the value of the bits in the CATEGORY field
- unset_category()
Set the value of the bits in the CATEGORY field to 0
- is_presence_recovery_set()
- Returns
True if the value of PRESENCE_RECOVERY is non-zero
- Return type
boolean
- set_presence_recovery(fieldVal)
Set the value of the bits in the PRESENCE_RECOVERY field
- Parameters
fieldVal (
number
) – the value to set the bitfield to
- get_presence_recovery()
Get the value of the bits in the PRESENCE_RECOVERY field
- unset_presence_recovery()
Set the value of the bits in the PRESENCE_RECOVERY field to 0
- is_unused_set()
- Returns
True if the value of UNUSED is non-zero
- Return type
boolean
- set_unused(fieldVal)
Set the value of the bits in the UNUSED field
- Parameters
fieldVal (
number
) – the value to set the bitfield to
- get_unused()
Get the value of the bits in the UNUSED field
- unset_unused()
Set the value of the bits in the UNUSED field to 0
- is_manufacturer_specific_set()
- Returns
True if the value of MANUFACTURER_SPECIFIC is non-zero
- Return type
boolean
- set_manufacturer_specific(fieldVal)
Set the value of the bits in the MANUFACTURER_SPECIFIC field
- Parameters
fieldVal (
number
) – the value to set the bitfield to
- get_manufacturer_specific()
Get the value of the bits in the MANUFACTURER_SPECIFIC field
- unset_manufacturer_specific()
Set the value of the bits in the MANUFACTURER_SPECIFIC field to 0