ZCL Alarms

Zigbee Cluster Library (ZCL) alarms cluster usage definition for ESP Zigbee SDK.

Header File

components/esp-zigbee-lib/include/zcl/esp_zigbee_zcl_alarms.h

Functions

void esp_zb_zcl_alarms_init_server(void): Alarm cluster server initialization.

void esp_zb_zcl_alarms_init_client(void): Alarm cluster client initialization.

Macros

ESP_ZB_ZCL_ALARMS_ALARM_COUNT_MIN_VALUE: Minimum value for AlarmCount attribute.

ESP_ZB_ZCL_ALARMS_ALARM_COUNT_MAX_VALUE: Maximum value for AlarmCount attribute.

ESP_ZB_ZCL_ALARMS_ALARM_COUNT_DEFAULT_VALUE: Default value for AlarmCount attribute.

ESP_ZB_ZCL_ALARMS_ALARM_TABLE_SIZE_DEFAULT_VALUE: Default value for AlarmTableSize attribute.

ESP_ZB_ZCL_CLUSTER_ID_ALARMS_SERVER_ROLE_INIT

ESP_ZB_ZCL_CLUSTER_ID_ALARMS_CLIENT_ROLE_INIT

Type Definitions

typedef enum esp_zb_zcl_alarms_attr_e esp_zb_zcl_alarms_attr_t: Alarms cluster attribute identifiers.

typedef enum esp_zb_zcl_alarms_cmd_req_e esp_zb_zcl_alarms_cmd_req_t: Alarms cluster command identifiers.

typedef enum esp_zb_zcl_alarms_cmd_resp_e esp_zb_zcl_alarms_cmd_resp_t: Alarms cluster command identifiers.

Enumerations

enum esp_zb_zcl_alarms_attr_e

Alarms cluster attribute identifiers.

Values:

enumerator ESP_ZB_ZCL_ATTR_ALARMS_ALARM_COUNT_ID: AlarmCount attribute

enumerator ESP_ZB_ZCL_ATTR_ALARMS_ALARM_TABLE_SIZE_ID: Internal AlarmTable size attribute

enumerator ESP_ZB_ZCL_ATTR_ALARMS_ALARM_TABLE_ID: Internal AlarmTable attribute

enum esp_zb_zcl_alarms_cmd_req_e

Alarms cluster command identifiers.

Values:

enumerator ESP_ZB_ZCL_CMD_ALARMS_RESET_ALARM_ID: Reset alarm command.

enumerator ESP_ZB_ZCL_CMD_ALARMS_RESET_ALL_ALARMS_ID: Reset all alarms command.

enumerator ESP_ZB_ZCL_CMD_ALARMS_GET_ALARM_ID: Get alarms command.

enumerator ESP_ZB_ZCL_CMD_ALARMS_RESET_ALARM_LOG_ID: Reset alarm log command.

enum esp_zb_zcl_alarms_cmd_resp_e

Alarms cluster command identifiers.

Values:

enumerator ESP_ZB_ZCL_CMD_ALARMS_ALARM_ID: Alarm command.

enumerator ESP_ZB_ZCL_CMD_ALARMS_GET_ALARM_RESP_ID: Get alarm response command.