ZCL IAS ACE

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

Header File

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

Structures

struct esp_zb_zcl_ias_ace_zone_table_s

Structure representation of IAS ACE Zone Table.

Public Members

uint8_t zone_id: Zone ID

uint16_t zone_type: Zone Type, see esp_zb_zcl_ias_zone_zonetype_t

esp_zb_ieee_addr_t zone_address: Zone Address

uint8_t *zone_label: The pointer to a string with Zone Label. NULL pointer means the Zone Label is not programmed

struct esp_zb_zcl_ias_ace_arm_s

Structure representation of Arm command.

Public Members

uint8_t arm_mode: Arm Mode, see esp_zb_zcl_ias_ace_arm_mode_t

uint8_t arm_disarm_code[ESP_ZB_ZCL_MAX_STRING_SIZE]: Arm/Disarm Code

uint8_t zone_id: Zone ID

struct esp_zb_zcl_ias_ace_bypass_s

Structure representation of Bypass command.

Public Members

uint8_t length: Number of Zones

uint8_t zone_id[ESP_ZB_ZCL_IAS_ACE_ZONE_TABLE_LENGTH]: Zone ID array, see esp_zb_zcl_ias_ace_zone_table_s

uint8_t arm_disarm_code[ESP_ZB_ZCL_MAX_STRING_SIZE]: Arm/Disarm Code

struct esp_zb_zcl_ias_ace_get_zone_info_s

Structure representation of Get Zone Information command.

Public Members

uint8_t zone_id: Zone ID, see esp_zb_zcl_ias_ace_zone_table_s

struct esp_zb_zcl_ias_ace_get_zone_status_s

Structure representation of Get Zone Status command.

Public Members

uint8_t starting_zone_id: Starting Zone ID, see esp_zb_zcl_ias_ace_zone_table_s

uint8_t max_num_zone_ids: Max Number of Zone IDs Requested Field

uint8_t zone_status_mask_flag: Zone Status Mask Flag Field

uint16_t zone_status_mask: Zone Status Mask Field, see esp_zb_zcl_ias_zone_zonestatus_t

struct esp_zb_zcl_ias_ace_arm_resp_s

Structure representation of Arm Response command.

Public Members

uint8_t arm_notification: Arm Notification, see esp_zb_zcl_ias_ace_arm_notif_t

struct esp_zb_zcl_ias_ace_get_zone_id_map_resp_s

Structure representation of Get Zone ID Map Response command.

Public Members

uint16_t zone_id_map[ESP_ZB_ZCL_IAS_ACE_GET_ZONE_ID_MAP_LENGTH]: Zone ID Map

struct esp_zb_zcl_ias_ace_get_zone_info_resp_s

Structure representation of Get Zone Information Response command, see esp_zb_zcl_ias_ace_zone_table_s.

Public Members

uint8_t zone_id: Zone ID

uint16_t zone_type: Zone Type, see esp_zb_zcl_ias_zone_zonetype_t

esp_zb_ieee_addr_t address: Zone Address

uint8_t zone_label[ESP_ZB_ZCL_MAX_STRING_SIZE]: Zone Label Field

struct esp_zb_zcl_ias_ace_zone_status_changed_s

Structure representation of Zone Status Changed command.

Public Members

uint8_t zone_id: Zone ID

uint16_t zone_status: Zone Status, see esp_zb_zcl_ias_zone_zonestatus_t

uint8_t aud_notification: Audible Notification, see esp_zb_zcl_ias_ace_aud_notification_t

uint8_t zone_label[ESP_ZB_ZCL_MAX_STRING_SIZE]: Zone Label Field

struct esp_zb_zcl_ias_ace_panel_status_changed_s

Structure representation of Panel Status Changed command.

Public Members

uint8_t panel_status: Panel Status, see esp_zb_zcl_ias_ace_panel_status_t

uint8_t seconds_remaining: Seconds Remaining Parameter

uint8_t aud_notification: Audible Notification, see esp_zb_zcl_ias_ace_aud_notification_t

uint8_t alarm_status: Alarm Status Field, see esp_zb_zcl_ias_ace_alarm_status_t

struct esp_zb_zcl_ias_ace_get_panel_status_resp_s

Structure representation of Get Panel Status Response command.

Public Members

uint8_t panel_status: Panel Status, see esp_zb_zcl_ias_ace_panel_status_t

uint8_t seconds_remaining: Seconds Remaining Parameter

uint8_t aud_notification: Audible Notification, see esp_zb_zcl_ias_ace_aud_notification_t

uint8_t alarm_status: Alarm Status Field, see esp_zb_zcl_ias_ace_alarm_status_t

struct esp_zb_zcl_ias_ace_set_bypassed_zone_list_s

Structure representation of Set Bypassed Zone List command.

Public Members

uint8_t length: Number of Zones

uint8_t zone_id[ESP_ZB_ZCL_IAS_ACE_ZONE_TABLE_LENGTH]: Zone ID array, see esp_zb_zcl_ias_ace_zone_table_s

struct esp_zb_zcl_ias_ace_bypass_resp_s

Structure representation of Bypass Response command.

Public Members

uint8_t length: Number of Zones

uint8_t bypass_result[ESP_ZB_ZCL_IAS_ACE_ZONE_TABLE_LENGTH]: Bypass Result for Zone IDs, see esp_zb_zcl_ias_ace_bypass_result_t

struct esp_zb_zcl_ias_ace_zone_status_s

IAS ACE Zone Status structure.

Public Members

uint8_t zone_id: Zone ID, see esp_zb_zcl_ias_ace_zone_table_s

uint16_t zone_status: Zone Status, see esp_zb_zcl_ias_zone_zonestatus_t

struct esp_zb_zcl_ias_ace_get_zone_status_resp_s

Structure representation of Get Zone Status Response command.

Public Members

uint8_t zone_status_complete: Zone Status Complete Field

uint8_t length: Number of Zones

esp_zb_zcl_ias_ace_zone_status_t zone_id_status[ESP_ZB_ZCL_IAS_ACE_ZONE_TABLE_LENGTH]: Status of Zone IDs

Macros

ESP_ZB_ZCL_IAS_ACE_CLUSTER_REVISION_DEFAULT: Default value for IAS ACE cluster revision global attribute.

ESP_ZB_ZCL_IAS_ACE_ZONE_TABLE_LENGTH: IAS ACE Zone Table maximum length.

ESP_ZB_ZCL_IAS_ACE_ZONE_TYPE_MAX_VALUE: IAS ACE ZoneType attribute maximum value.

ESP_ZB_ZCL_IAS_ACE_ZONE_ID_MAX_VALUE: IAS ACE ZoneID attribute maximum value.

ESP_ZB_ZCL_IAS_ACE_ZONE_ID_DEFAULT_VALUE: IAS ACE ZoneID attribute default value.

ESP_ZB_ZCL_IAS_ACE_SET_ZONE_ADDRESS_DEFAULT_VALUE(ptr): IAS ACE Set Zone Address default value.

ESP_ZB_ZCL_IAS_ACE_GET_ZONE_ID_MAP_LENGTH: Length of array of Bitmap of Zone ID Map.

ESP_ZB_ZCL_IAS_ACE_GET_ZONE_INFO_TYPE_NONE: Zone Type is empty.

Type Definitions

typedef struct esp_zb_zcl_ias_ace_zone_table_s esp_zb_zcl_ias_ace_zone_table_t: Structure representation of IAS ACE Zone Table.

typedef struct esp_zb_zcl_ias_ace_arm_s esp_zb_zcl_ias_ace_arm_t: Structure representation of Arm command.

typedef struct esp_zb_zcl_ias_ace_bypass_s esp_zb_zcl_ias_ace_bypass_t: Structure representation of Bypass command.

typedef struct esp_zb_zcl_ias_ace_get_zone_info_s esp_zb_zcl_ias_ace_get_zone_info_t: Structure representation of Get Zone Information command.

typedef struct esp_zb_zcl_ias_ace_get_zone_status_s esp_zb_zcl_ias_ace_get_zone_status_t: Structure representation of Get Zone Status command.

typedef struct esp_zb_zcl_ias_ace_arm_resp_s esp_zb_zcl_ias_ace_arm_resp_t: Structure representation of Arm Response command.

typedef struct esp_zb_zcl_ias_ace_get_zone_id_map_resp_s esp_zb_zcl_ias_ace_get_zone_id_map_resp_t: Structure representation of Get Zone ID Map Response command.

typedef struct esp_zb_zcl_ias_ace_get_zone_info_resp_s esp_zb_zcl_ias_ace_get_zone_info_resp_t: Structure representation of Get Zone Information Response command, see esp_zb_zcl_ias_ace_zone_table_s.

typedef struct esp_zb_zcl_ias_ace_zone_status_changed_s esp_zb_zcl_ias_ace_zone_status_changed_t: Structure representation of Zone Status Changed command.

typedef struct esp_zb_zcl_ias_ace_panel_status_changed_s esp_zb_zcl_ias_ace_panel_status_changed_t: Structure representation of Panel Status Changed command.

typedef struct esp_zb_zcl_ias_ace_get_panel_status_resp_s esp_zb_zcl_ias_ace_get_panel_status_resp_t: Structure representation of Get Panel Status Response command.

typedef struct esp_zb_zcl_ias_ace_set_bypassed_zone_list_s esp_zb_zcl_ias_ace_set_bypassed_zone_list_t: Structure representation of Set Bypassed Zone List command.

typedef struct esp_zb_zcl_ias_ace_bypass_resp_s esp_zb_zcl_ias_ace_bypass_resp_t: Structure representation of Bypass Response command.

typedef struct esp_zb_zcl_ias_ace_zone_status_s esp_zb_zcl_ias_ace_zone_status_t: IAS ACE Zone Status structure.

typedef struct esp_zb_zcl_ias_ace_get_zone_status_resp_s esp_zb_zcl_ias_ace_get_zone_status_resp_t: Structure representation of Get Zone Status Response command.

Enumerations

enum esp_zb_zcl_ias_ace_cmd_t

IAS Ace cluster command identifiers.

Values:

enumerator ESP_ZB_ZCL_CMD_IAS_ACE_ARM_ID: Arm command

enumerator ESP_ZB_ZCL_CMD_IAS_ACE_BYPASS_ID: Bypass command

enumerator ESP_ZB_ZCL_CMD_IAS_ACE_EMERGENCY_ID: Emergency command

enumerator ESP_ZB_ZCL_CMD_IAS_ACE_FIRE_ID: Fire command

enumerator ESP_ZB_ZCL_CMD_IAS_ACE_PANIC_ID: Panic command

enumerator ESP_ZB_ZCL_CMD_IAS_ACE_GET_ZONE_ID_MAP_ID: Get Zone ID Map command

enumerator ESP_ZB_ZCL_CMD_IAS_ACE_GET_ZONE_INFO_ID: Get Zone Information command

enumerator ESP_ZB_ZCL_CMD_IAS_ACE_GET_PANEL_STATUS_ID: Get Panel Status command

enumerator ESP_ZB_ZCL_CMD_IAS_ACE_GET_BYPASSED_ZONE_LIST_ID: Get Bypassed Zone List command

enumerator ESP_ZB_ZCL_CMD_IAS_ACE_GET_ZONE_STATUS_ID: Get Zone Status command

enum esp_zb_zcl_ias_ace_resp_cmd_t

IAS Ace cluster response command identifiers.

Values:

enumerator ESP_ZB_ZCL_CMD_IAS_ACE_ARM_RESP_ID: Arm Response command

enumerator ESP_ZB_ZCL_CMD_IAS_ACE_GET_ZONE_ID_MAP_RESP_ID: Get Zone ID Map Response command

enumerator ESP_ZB_ZCL_CMD_IAS_ACE_GET_ZONE_INFO_RESP_ID: Get Zone Information Response command

enumerator ESP_ZB_ZCL_CMD_IAS_ACE_ZONE_STATUS_CHANGED_ID: Updates ACE clients of changes to zone status recorded by the server.

enumerator ESP_ZB_ZCL_CMD_IAS_ACE_PANEL_STATUS_CHANGED_ID: Updates ACE clients of changes to zone status recorded by the server.

enumerator ESP_ZB_ZCL_CMD_IAS_ACE_GET_PANEL_STATUS_RESPONSE_ID: Updates ACE clients of changes to panel status recorded by the server.

enumerator ESP_ZB_ZCL_CMD_IAS_ACE_SET_BYPASSED_ZONE_LIST_ID: Sets the list of bypassed zones on the IAS ACE client.

enumerator ESP_ZB_ZCL_CMD_IAS_ACE_BYPASS_RESPONSE_ID: Bypass Response command.

enumerator ESP_ZB_ZCL_CMD_IAS_ACE_GET_ZONE_STATUS_RESPONSE_ID: Get Zone Status Response Command.

enum esp_zb_zcl_ias_ace_arm_mode_t

Values of the Arm Mode.

Values:

enumerator ESP_ZB_ZCL_IAS_ACE_ARM_MODE_DISARM: Disarm

enumerator ESP_ZB_ZCL_IAS_ACE_ARM_MODE_DAY: Arm Day/Home Zones Only

enumerator ESP_ZB_ZCL_IAS_ACE_ARM_MODE_NIGHT: Arm Night/Sleep Zones Only

enumerator ESP_ZB_ZCL_IAS_ACE_ARM_MODE_ALL: Arm All Zones

enum esp_zb_zcl_ias_ace_arm_notif_t

Values of the Arm Notification.

Values:

enumerator ESP_ZB_ZCL_IAS_ACE_ARM_NOTIF_ALL_ZONES_DISARMED: All Zones Disarmed

enumerator ESP_ZB_ZCL_IAS_ACE_ARM_NOTIF_ONLY_DAY_HOME_ZONES_ARMED: Only Day/Home Zones Armed

enumerator ESP_ZB_ZCL_IAS_ACE_ARM_NOTIF_ONLY_NIGHT_SLEEP_ZONES_ARMED: Only Night/Sleep Zones Armed

enumerator ESP_ZB_ZCL_IAS_ACE_ARM_NOTIF_ALL_ZONES_ARMED: All Zones Armed

enumerator ESP_ZB_ZCL_IAS_ACE_ARM_NOTIF_INVALID_ARM_DISARM_CODE: Invalid Arm/Disarm Code

enumerator ESP_ZB_ZCL_IAS_ACE_ARM_NOTIF_NOT_READY_TO_ARM: Not ready to arm

enumerator ESP_ZB_ZCL_IAS_ACE_ARM_NOTIF_ALREADY_DISARMED: Already disarmed

enum esp_zb_zcl_ias_ace_aud_notification_t

IAS ACE Audible Notification Field.