5.2.6.3.6. ZCL Security and Safety Clusters

This section provides the security and safety clusters implementations in ZCL of ESP Zigbee Core.

5.2.6.3.6.1. IAS Zone

5.2.6.3.6.1.1. Header File

5.2.6.3.6.1.2. Functions

ezb_err_t ezb_zcl_ias_zone_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an ias_zone cluster descriptor.

Parameters:

  • cluster_desc -- [in] The ias_zone cluster descriptor.

  • attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

  • value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_ias_zone_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an ias_zone cluster descriptor.

Parameters:

  • cluster_cfg -- [in] The pointer to the ias_zone cluster configuration structure. Use ezb_zcl_ias_zone_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_ias_zone_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

  • role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_ias_zone_cluster_client_init(uint8_t ep_id)

Initialize the IasZone cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_ias_zone_cluster_server_init(uint8_t ep_id)

Initialize the IasZone cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.6.1.3. Structures

struct ezb_zcl_ias_zone_cluster_server_config_s

Configuration mandatory attributes for the IasZone server cluster.

Public Members

uint8_t zone_state

Configurable mandatory ZoneState attribute

uint16_t zone_type

Configurable mandatory ZoneType attribute

uint16_t zone_status

Configurable mandatory ZoneStatus attribute

uint64_t ias_cie_address

Configurable mandatory IasCieAddress attribute

uint8_t zone_id

Configurable mandatory ZoneId attribute

5.2.6.3.6.1.4. Macros

EZB_ZCL_IAS_ZONE_CLUSTER_REVISION

Cluster Revision of the ias_zone cluster implementation.

EZB_ZCL_IAS_ZONE_ZONE_STATE_DEFAULT_VALUE

Default value of ZoneState in IasZone cluster.

EZB_ZCL_IAS_ZONE_ZONE_STATUS_DEFAULT_VALUE

Default value of ZoneStatus in IasZone cluster.

EZB_ZCL_IAS_ZONE_ZONE_ID_DEFAULT_VALUE

Default value of ZoneId in IasZone cluster.

EZB_ZCL_IAS_ZONE_ZONE_ID_MIN_VALUE

Minimum value of ZoneId in IasZone cluster.

EZB_ZCL_IAS_ZONE_ZONE_ID_MAX_VALUE

Maximum value of ZoneId in IasZone cluster.

EZB_ZCL_IAS_ZONE_NUMBER_OF_ZONE_SENSITIVITY_LEVELS_SUPPORTED_DEFAULT_VALUE

Default value of NumberOfZoneSensitivityLevelsSupported in IasZone cluster.

EZB_ZCL_IAS_ZONE_NUMBER_OF_ZONE_SENSITIVITY_LEVELS_SUPPORTED_MIN_VALUE

Minimum value of NumberOfZoneSensitivityLevelsSupported in IasZone cluster.

EZB_ZCL_IAS_ZONE_NUMBER_OF_ZONE_SENSITIVITY_LEVELS_SUPPORTED_MAX_VALUE

Maximum value of NumberOfZoneSensitivityLevelsSupported in IasZone cluster.

EZB_ZCL_IAS_ZONE_CURRENT_ZONE_SENSITIVITY_LEVEL_DEFAULT_VALUE

Default value of CurrentZoneSensitivityLevel in IasZone cluster.

EZB_ZCL_IAS_ZONE_CURRENT_ZONE_SENSITIVITY_LEVEL_MIN_VALUE

Minimum value of CurrentZoneSensitivityLevel in IasZone cluster.

EZB_ZCL_IAS_ZONE_CURRENT_ZONE_SENSITIVITY_LEVEL_MAX_VALUE

Maximum value of CurrentZoneSensitivityLevel in IasZone cluster.

EZB_ZCL_CLUSTER_ID_IAS_ZONE_CLIENT_ROLE_INIT
EZB_ZCL_CLUSTER_ID_IAS_ZONE_SERVER_ROLE_INIT

5.2.6.3.6.1.5. Type Definitions

typedef struct ezb_zcl_ias_zone_cluster_server_config_s ezb_zcl_ias_zone_cluster_server_config_t

Configuration mandatory attributes for the IasZone server cluster.

typedef ezb_zcl_ias_zone_cluster_server_config_t ezb_zcl_ias_zone_cluster_config_t

5.2.6.3.6.1.6. Enumerations

enum ezb_zcl_ias_zone_server_attr_t

Attribute identifiers for the ias_zone server cluster.

Values:

enumerator EZB_ZCL_ATTR_IAS_ZONE_ZONE_STATE_ID

ZoneState attribute.

enumerator EZB_ZCL_ATTR_IAS_ZONE_ZONE_TYPE_ID

ZoneType attribute.

enumerator EZB_ZCL_ATTR_IAS_ZONE_ZONE_STATUS_ID

ZoneStatus attribute.

enumerator EZB_ZCL_ATTR_IAS_ZONE_IAS_CIE_ADDRESS_ID

IasCieAddress attribute.

enumerator EZB_ZCL_ATTR_IAS_ZONE_ZONE_ID_ID

ZoneId attribute.

enumerator EZB_ZCL_ATTR_IAS_ZONE_NUMBER_OF_ZONE_SENSITIVITY_LEVELS_SUPPORTED_ID

NumberOfZoneSensitivityLevelsSupported attribute.

enumerator EZB_ZCL_ATTR_IAS_ZONE_CURRENT_ZONE_SENSITIVITY_LEVEL_ID

CurrentZoneSensitivityLevel attribute.

enumerator EZB_ZCL_ATTR_IAS_ZONE_ZONE_CTX_ID

ZoneCtx attribute.

enum ezb_zcl_ias_zone_server_zone_state_t

Enumeration for ZCL ZoneState attribute of IasZone.

Values:

enumerator EZB_ZCL_IAS_ZONE_ZONE_STATE_NOT_ENROLLED

NotEnrolled

enumerator EZB_ZCL_IAS_ZONE_ZONE_STATE_ENROLLED

Enrolled

enum ezb_zcl_ias_zone_server_zone_type_t

Enumeration for ZCL ZoneType attribute of IasZone.

Values:

enumerator EZB_ZCL_IAS_ZONE_ZONE_TYPE_STANDARD_CIE

StandardCie

enumerator EZB_ZCL_IAS_ZONE_ZONE_TYPE_MOTION_SENSOR

MotionSensor

enumerator EZB_ZCL_IAS_ZONE_ZONE_TYPE_CONTACT_SWITCH

ContactSwitch

enumerator EZB_ZCL_IAS_ZONE_ZONE_TYPE_DOOR_WINDOW_HANDLE

DoorWindowHandle

enumerator EZB_ZCL_IAS_ZONE_ZONE_TYPE_FIRE_SENSOR

FireSensor

enumerator EZB_ZCL_IAS_ZONE_ZONE_TYPE_WATER_SENSOR

WaterSensor

enumerator EZB_ZCL_IAS_ZONE_ZONE_TYPE_CARBON_MONOXIDE_SENSOR

CarbonMonoxideSensor

enumerator EZB_ZCL_IAS_ZONE_ZONE_TYPE_PERSONAL_EMERGENCY_DEVICE

PersonalEmergencyDevice

enumerator EZB_ZCL_IAS_ZONE_ZONE_TYPE_VIBRATION_MOVEMENT_SENSOR

VibrationMovementSensor

enumerator EZB_ZCL_IAS_ZONE_ZONE_TYPE_REMOTE_CONTROL

RemoteControl

enumerator EZB_ZCL_IAS_ZONE_ZONE_TYPE_KEY_FOB

KeyFob

enumerator EZB_ZCL_IAS_ZONE_ZONE_TYPE_KEYPAD

Keypad

enumerator EZB_ZCL_IAS_ZONE_ZONE_TYPE_STANDARD_WARNING_DEVICE

StandardWarningDevice

enumerator EZB_ZCL_IAS_ZONE_ZONE_TYPE_GLASS_BREAK_SENSOR

GlassBreakSensor

enumerator EZB_ZCL_IAS_ZONE_ZONE_TYPE_SECURITY_REPEATER

SecurityRepeater

enumerator EZB_ZCL_IAS_ZONE_ZONE_TYPE_INVALID_ZONE_TYPE

InvalidZoneType

enum ezb_zcl_ias_zone_server_zone_status_t

Bitmap for ZCL ZoneStatus attribute of IasZone.

Values:

enumerator EZB_ZCL_IAS_ZONE_ZONE_STATUS_ALARM1

Alarm1

enumerator EZB_ZCL_IAS_ZONE_ZONE_STATUS_ALARM2

Alarm2

enumerator EZB_ZCL_IAS_ZONE_ZONE_STATUS_TAMPER

Tamper

enumerator EZB_ZCL_IAS_ZONE_ZONE_STATUS_BATTERY

Battery

enumerator EZB_ZCL_IAS_ZONE_ZONE_STATUS_SUPERVISION_NOTIFY

SupervisionNotify

enumerator EZB_ZCL_IAS_ZONE_ZONE_STATUS_RESTORE_NOTIFY

RestoreNotify

enumerator EZB_ZCL_IAS_ZONE_ZONE_STATUS_TROUBLE

Trouble

enumerator EZB_ZCL_IAS_ZONE_ZONE_STATUS_AC

AC

enumerator EZB_ZCL_IAS_ZONE_ZONE_STATUS_TEST

Test

enumerator EZB_ZCL_IAS_ZONE_ZONE_STATUS_BATTERY_DEFECT

BatteryDefect

enum ezb_zcl_ias_zone_server_cmd_id_t

Received Command identifiers for the IasZone cluster.

Values:

enumerator EZB_ZCL_CMD_IAS_ZONE_ZONE_ENROLL_RESPONSE_ID

ZoneEnrollResponse command.

enumerator EZB_ZCL_CMD_IAS_ZONE_INITIATE_NORMAL_OPERATION_MODE_ID

InitiateNormalOperationMode command.

enumerator EZB_ZCL_CMD_IAS_ZONE_INITIATE_TEST_MODE_ID

InitiateTestMode command.

enum ezb_zcl_ias_zone_client_cmd_id_t

Received Command identifiers for the IasZone cluster.

Values:

enumerator EZB_ZCL_CMD_IAS_ZONE_ZONE_STATUS_CHANGE_NOTIFICATION_ID

ZoneStatusChangeNotification command.

enumerator EZB_ZCL_CMD_IAS_ZONE_ZONE_ENROLL_REQUEST_ID

ZoneEnrollRequest command.

5.2.6.3.6.1.7. Header File

5.2.6.3.6.1.8. Functions

ezb_err_t ezb_zcl_ias_zone_enroll_cmd_req(const ezb_zcl_ias_zone_enroll_req_cmd_t *cmd_req)

Send ZCL IAS ZONE Enroll Request command.

Parameters:

cmd_req -- Pointer to the Enroll Request command structure.

Returns:

Error code.

ezb_err_t ezb_zcl_ias_zone_enroll_cmd_resp(const ezb_zcl_ias_zone_enroll_rsp_cmd_t *cmd_resp)

Send ZCL IAS ZONE Enroll Response command.

Parameters:

cmd_resp -- Pointer to the Enroll Response command structure.

Returns:

Error code.

ezb_err_t ezb_zcl_ias_zone_initiate_test_mode_cmd_req(const ezb_zcl_ias_zone_initiate_test_mode_cmd_t *cmd_req)

Send ZCL IAS ZONE Initiate Test Mode command.

Parameters:

cmd_req -- Pointer to the Initiate Test Mode command structure.

Returns:

Error code.

ezb_err_t ezb_zcl_ias_zone_initiate_normal_operation_mode_cmd_req(const ezb_zcl_ias_zone_initiate_normal_operation_mode_cmd_t *cmd_req)

Send ZCL IAS ZONE Initiate Normal Operation Mode command.

Parameters:

cmd_req -- Pointer to the Initiate Normal Operation Mode command structure.

Returns:

Error code.

5.2.6.3.6.1.9. Structures

struct ezb_zcl_ias_zone_enroll_req_s

Payload for IAS ZONE Enroll request command.

Public Members

uint16_t zone_type

Zone type.

uint16_t manuf_code

Manufacturer code.

struct ezb_zcl_ias_zone_enroll_rsp_payload_s

Payload for IAS ZONE Enroll response command.

Public Members

uint8_t enroll_rsp_code

The enroll response code.

uint8_t zone_id

The zone ID is the index of the table.

struct ezb_zcl_ias_zone_status_change_notif_payload_s

Payload for IAS ZONE Zone Status Change Notification command.

Note

The Zone Status Change Notification command can be triggered by changing the value of the zone status attribute.

Public Members

uint16_t zone_status

The zone status shall be the current value of the zone status attribute.

uint8_t extend_status

Extended status for additional info.

uint8_t zone_id

The zone ID is the index of the table.

uint16_t delay

Delay in quarter-seconds.

struct ezb_zcl_ias_zone_initiate_test_mode_payload_s

Payload for IAS ZONE Initiate Test Mode command.

Public Members

uint8_t duration

Duration of the test mode in seconds.

uint8_t current_zone_sensitivity_level

Level of sensitivity for the current zone.

struct ezb_zcl_ias_zone_enroll_req_cmd_s

Structure for IAS ZONE Enroll request command.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_ias_zone_enroll_req_payload_t payload

Payload for the Enroll request command.

struct ezb_zcl_ias_zone_initiate_normal_operation_mode_cmd_s

Structure for IAS ZONE Initiate Normal Operation Mode command.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

struct ezb_zcl_ias_zone_initiate_test_mode_cmd_s

Structure for IAS ZONE Initiate Test Mode command.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_ias_zone_initiate_test_mode_payload_t payload

Payload for the Initiate Test Mode command.

struct ezb_zcl_ias_zone_enroll_rsp_cmd_s

Structure for IAS ZONE Enroll Response command.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_ias_zone_enroll_rsp_payload_t payload

Payload for the Enroll Response command.

struct ezb_zcl_ias_zone_enroll_req_message_s

Message for IAS ZONE Enroll Request command message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

Header of command

ezb_zcl_ias_zone_enroll_req_payload_t payload

Payload for the Enroll Request command.

struct ezb_zcl_ias_zone_enroll_req_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_ias_zone_enroll_req_message_s out

Output: result to send back.

struct ezb_zcl_ias_zone_enroll_rsp_message_s

Message for IAS ZONE Enroll Response command message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

ezb_zcl_ias_zone_enroll_rsp_payload_t payload

Payload for the Enroll Response command.

struct ezb_zcl_ias_zone_enroll_rsp_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_ias_zone_enroll_rsp_message_s out

Output: result to send back.

struct ezb_zcl_ias_zone_status_change_notif_message_s

Message for IAS ZONE Zone Status Change Notification command message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

ezb_zcl_ias_zone_status_change_notif_payload_t payload

Payload for the Zone Status Change Notification command.

struct ezb_zcl_ias_zone_status_change_notif_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_ias_zone_status_change_notif_message_s out

Output: result to send back.

struct ezb_zcl_ias_zone_initiate_test_mode_message_s

Message for IAS ZONE Initiate Test Mode command message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

ezb_zcl_ias_zone_initiate_test_mode_payload_t payload

Payload for the Initiate Test Mode command.

struct ezb_zcl_ias_zone_initiate_test_mode_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_ias_zone_initiate_test_mode_message_s out

Output: result to send back.

struct ezb_zcl_ias_zone_initiate_normal_mode_message_s

Message for IAS ZONE Initiate Normal Mode command message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_ias_zone_initiate_normal_mode_message_s out

Output: result to send back.

5.2.6.3.6.1.10. Type Definitions

typedef struct ezb_zcl_ias_zone_enroll_req_s ezb_zcl_ias_zone_enroll_req_payload_t

Payload for IAS ZONE Enroll request command.

typedef struct ezb_zcl_ias_zone_enroll_rsp_payload_s ezb_zcl_ias_zone_enroll_rsp_payload_t

Payload for IAS ZONE Enroll response command.

typedef struct ezb_zcl_ias_zone_status_change_notif_payload_s ezb_zcl_ias_zone_status_change_notif_payload_t

Payload for IAS ZONE Zone Status Change Notification command.

Note

The Zone Status Change Notification command can be triggered by changing the value of the zone status attribute.

typedef struct ezb_zcl_ias_zone_initiate_test_mode_payload_s ezb_zcl_ias_zone_initiate_test_mode_payload_t

Payload for IAS ZONE Initiate Test Mode command.

typedef struct ezb_zcl_ias_zone_enroll_req_cmd_s ezb_zcl_ias_zone_enroll_req_cmd_t

Structure for IAS ZONE Enroll request command.

typedef struct ezb_zcl_ias_zone_initiate_normal_operation_mode_cmd_s ezb_zcl_ias_zone_initiate_normal_operation_mode_cmd_t

Structure for IAS ZONE Initiate Normal Operation Mode command.

typedef struct ezb_zcl_ias_zone_initiate_test_mode_cmd_s ezb_zcl_ias_zone_initiate_test_mode_cmd_t

Structure for IAS ZONE Initiate Test Mode command.

typedef struct ezb_zcl_ias_zone_enroll_rsp_cmd_s ezb_zcl_ias_zone_enroll_rsp_cmd_t

Structure for IAS ZONE Enroll Response command.

typedef struct ezb_zcl_ias_zone_enroll_req_message_s ezb_zcl_ias_zone_enroll_req_message_t

Message for IAS ZONE Enroll Request command message.

typedef struct ezb_zcl_ias_zone_enroll_rsp_message_s ezb_zcl_ias_zone_enroll_rsp_message_t

Message for IAS ZONE Enroll Response command message.

typedef struct ezb_zcl_ias_zone_status_change_notif_message_s ezb_zcl_ias_zone_status_change_notif_message_t

Message for IAS ZONE Zone Status Change Notification command message.

typedef struct ezb_zcl_ias_zone_initiate_test_mode_message_s ezb_zcl_ias_zone_initiate_test_mode_message_t

Message for IAS ZONE Initiate Test Mode command message.

typedef struct ezb_zcl_ias_zone_initiate_normal_mode_message_s ezb_zcl_ias_zone_initiate_normal_mode_message_t

Message for IAS ZONE Initiate Normal Mode command message.

5.2.6.3.6.1.11. Enumerations

enum ezb_zcl_ias_zone_enroll_rsp_code_t

Values of the Enroll Response Code definition.

Values:

enumerator EZB_ZCL_IAS_ZONE_ENROLL_RESPONSE_CODE_SUCCESS

Success.

enumerator EZB_ZCL_IAS_ZONE_ENROLL_RESPONSE_CODE_NOT_SUPPORTED

Not supported.

enumerator EZB_ZCL_IAS_ZONE_ENROLL_RESPONSE_CODE_NOT_PERMITTED

No enroll permit.

enumerator EZB_ZCL_IAS_ZONE_ENROLL_RESPONSE_CODE_TOO_MANY_ZONES

Too many zones.

5.2.6.3.6.2. IAS ACE

5.2.6.3.6.2.1. Header File

5.2.6.3.6.2.2. Functions

ezb_err_t ezb_zcl_ias_ace_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an ias_ace cluster descriptor.

Parameters:

  • cluster_desc -- [in] The ias_ace cluster descriptor.

  • attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

  • value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_ias_ace_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an ias_ace cluster descriptor.

Parameters:

  • cluster_cfg -- [in] The pointer to the ias_ace cluster configuration structure. Use ezb_zcl_ias_ace_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_ias_ace_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

  • role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_ias_ace_cluster_client_init(uint8_t ep_id)

Initialize the IasAce cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_ias_ace_cluster_server_init(uint8_t ep_id)

Initialize the IasAce cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.6.2.3. Structures

struct ezb_zcl_ias_ace_cluster_server_config_s

Configuration mandatory attributes for the IasAce server cluster.

Public Members

uint8_t zone_table_size

Configurable mandatory ZoneTableSize attribute

5.2.6.3.6.2.4. Macros

EZB_ZCL_IAS_ACE_CLUSTER_REVISION

Cluster Revision of the ias_ace cluster implementation.

EZB_ZCL_IAS_ACE_ZONE_TABLE_SIZE_DEFAULT_VALUE

Default value of ZoneTableSize in IasAce cluster.

EZB_ZCL_IAS_ACE_ZONE_TABLE_SIZE_MIN_VALUE

Minimum value of ZoneTableSize in IasAce cluster.

EZB_ZCL_IAS_ACE_ZONE_TABLE_SIZE_MAX_VALUE

Maximum value of ZoneTableSize in IasAce cluster.

EZB_ZCL_CLUSTER_ID_IAS_ACE_CLIENT_ROLE_INIT
EZB_ZCL_CLUSTER_ID_IAS_ACE_SERVER_ROLE_INIT

5.2.6.3.6.2.5. Type Definitions

typedef struct ezb_zcl_ias_ace_cluster_server_config_s ezb_zcl_ias_ace_cluster_server_config_t

Configuration mandatory attributes for the IasAce server cluster.

typedef ezb_zcl_ias_ace_cluster_server_config_t ezb_zcl_ias_ace_cluster_config_t

5.2.6.3.6.2.6. Enumerations

enum ezb_zcl_ias_ace_server_attr_t

Attribute identifiers for the ias_ace server cluster.

Values:

enumerator EZB_ZCL_ATTR_IAS_ACE_ZONE_TABLE_SIZE_ID

ZoneTableSize attribute.

enumerator EZB_ZCL_ATTR_IAS_ACE_ZONE_TABLE_HANDLE_ID

ZoneTableHandle attribute.

enum ezb_zcl_ias_ace_server_cmd_id_t

Received Command identifiers for the IasAce cluster.

Values:

enumerator EZB_ZCL_CMD_IAS_ACE_ARM_ID

Arm command.

enumerator EZB_ZCL_CMD_IAS_ACE_BYPASS_ID

Bypass command.

enumerator EZB_ZCL_CMD_IAS_ACE_EMERGENCY_ID

Emergency command.

enumerator EZB_ZCL_CMD_IAS_ACE_FIRE_ID

Fire command.

enumerator EZB_ZCL_CMD_IAS_ACE_PANIC_ID

Panic command.

enumerator EZB_ZCL_CMD_IAS_ACE_GET_ZONE_ID_MAP_ID

GetZoneIdMap command.

enumerator EZB_ZCL_CMD_IAS_ACE_GET_ZONE_INFO_ID

GetZoneInfo command.

enumerator EZB_ZCL_CMD_IAS_ACE_GET_PANEL_STATUS_ID

GetPanelStatus command.

enumerator EZB_ZCL_CMD_IAS_ACE_GET_BYPASSED_ZONE_LIST_ID

GetBypassedZoneList command.

enumerator EZB_ZCL_CMD_IAS_ACE_GET_ZONE_STATUS_ID

GetZoneStatus command.

enum ezb_zcl_ias_ace_client_cmd_id_t

Received Command identifiers for the IasAce cluster.

Values:

enumerator EZB_ZCL_CMD_IAS_ACE_ARM_RESPONSE_ID

ArmResponse command.

enumerator EZB_ZCL_CMD_IAS_ACE_GET_ZONE_ID_MAP_RESPONSE_ID

GetZoneIDMapResponse command.

enumerator EZB_ZCL_CMD_IAS_ACE_GET_ZONE_INFORMATION_RESPONSE_ID

GetZoneInformationResponse command.

enumerator EZB_ZCL_CMD_IAS_ACE_ZONE_STATUS_CHANGED_ID

ZoneStatusChanged command.

enumerator EZB_ZCL_CMD_IAS_ACE_PANEL_STATUS_CHANGED_ID

PanelStatusChanged command.

enumerator EZB_ZCL_CMD_IAS_ACE_GET_PANEL_STATUS_RESPONSE_ID

GetPanelStatusResponse command.

enumerator EZB_ZCL_CMD_IAS_ACE_SET_BYPASSED_ZONE_LIST_ID

SetBypassedZoneList command.

enumerator EZB_ZCL_CMD_IAS_ACE_BYPASS_RESPONSE_ID

BypassResponse command.

enumerator EZB_ZCL_CMD_IAS_ACE_GET_ZONE_STATUS_RESPONSE_ID

GetZoneStatusResponse command.

5.2.6.3.6.2.7. Header File

5.2.6.3.6.2.8. Functions

ezb_zcl_ias_ace_zone_table_t ezb_zcl_ias_ace_get_zone_table(uint8_t ep_id)

Get the zone table of the IAS ACE cluster.

Parameters:

ep_id -- A 8-bit endpoint ID which the IAS ACE cluster attach.

Returns:

The pointer to the zone table of IAS ACE cluster on the given endpoint. The pointer is valid until the IAS ACE cluster is unregistered or the device is reset.

ezb_err_t ezb_zcl_ias_ace_zone_table_get_zone(ezb_zcl_ias_ace_zone_table_t table, uint8_t zone_id, ezb_zcl_ias_ace_zone_table_ent_t *entry)

Get the zone entry from the zone table.

Parameters:

  • table -- The pointer to the zone table of IAS ACE cluster.

  • zone_id -- The zone ID of the zone entry to be retrieved.

  • entry -- Pointer to the zone entry to be retrieved.

Returns:

Error code.

ezb_err_t ezb_zcl_ias_ace_zone_table_add_zone(ezb_zcl_ias_ace_zone_table_t table, const ezb_zcl_ias_ace_zone_table_ent_t *new_entry)

Add a zone entry to the zone table.

Parameters:

  • table -- The pointer to the zone table of IAS ACE cluster.

  • new_entry -- The pointer to the new zone entry to be added.

Returns:

Error code.

ezb_err_t ezb_zcl_ias_ace_zone_table_remove_zone(ezb_zcl_ias_ace_zone_table_t table, uint8_t zone_id)

Remove a zone entry from the zone table by zone ID.

Parameters:

  • table -- The pointer to the zone table of IAS ACE cluster.

  • zone_id -- The zone ID of the zone entry to be removed.

Returns:

Error code.

ezb_err_t ezb_zcl_ias_ace_zone_table_update_zone(ezb_zcl_ias_ace_zone_table_t table, const ezb_zcl_ias_ace_zone_table_ent_t *entry)

Update a zone entry in the zone table by zone entry.

Parameters:

  • table -- The pointer to the zone table of IAS ACE cluster.

  • entry -- The pointer to the zone entry to be updated. The zone ID in the entry is used to find the existing entry to be updated.

Returns:

Error code.

ezb_err_t ezb_zcl_ias_ace_arm_cmd_req(const ezb_zcl_ias_ace_arm_cmd_t *cmd_req)

Send ZCL IAS ACE Arm command request.

Parameters:

cmd_req -- Pointer to the Arm command structure.

Returns:

Error code.

ezb_err_t ezb_zcl_ias_ace_bypass_cmd_req(const ezb_zcl_ias_ace_bypass_cmd_t *cmd_req)

Send ZCL IAS ACE Bypass command request.

Note

The IAS ACE server shall to update the bypassed attributes in the zone table entry after bypassing a zone.

Parameters:

cmd_req -- Pointer to the Bypass command structure.

Returns:

Error code.

ezb_err_t ezb_zcl_ias_ace_emergency_cmd_req(const ezb_zcl_ias_ace_emergency_cmd_t *cmd_req)

Send ZCL IAS ACE Emergency command request.

Parameters:

cmd_req -- Pointer to the Emergency command structure.

Returns:

Error code.

ezb_err_t ezb_zcl_ias_ace_fire_cmd_req(const ezb_zcl_ias_ace_fire_cmd_t *cmd_req)

Send ZCL IAS ACE Fire command request.

Parameters:

cmd_req -- Pointer to the Fire command structure.

Returns:

Error code.

ezb_err_t ezb_zcl_ias_ace_panic_cmd_req(const ezb_zcl_ias_ace_panic_cmd_t *cmd_req)

Send ZCL IAS ACE Panic command request.

Parameters:

cmd_req -- Pointer to the Panic command structure.

Returns:

Error code.

ezb_err_t ezb_zcl_ias_ace_get_zone_id_map_cmd_req(const ezb_zcl_ias_ace_get_zone_id_map_cmd_t *cmd_req)

Send ZCL IAS ACE Get Zone ID Map command request.

Parameters:

cmd_req -- Pointer to the Get Zone ID Map command structure.

Returns:

Error code.

ezb_err_t ezb_zcl_ias_ace_get_zone_information_cmd_req(const ezb_zcl_ias_ace_get_zone_info_cmd_t *cmd_req)

Send ZCL IAS ACE Get Zone Information command request.

Parameters:

cmd_req -- Pointer to the Get Zone Information command structure.

Returns:

Error code.

ezb_err_t ezb_zcl_ias_ace_get_panel_status_cmd_req(const ezb_zcl_ias_ace_get_panel_status_cmd_t *cmd_req)

Send ZCL IAS ACE Zone Status Changed command request.

Parameters:

cmd_req -- Pointer to the Zone Status Changed command structure.

Returns:

Error code.

ezb_err_t ezb_zcl_ias_ace_get_bypassed_zone_list_cmd_req(const ezb_zcl_ias_ace_get_bypassed_zone_list_cmd_t *cmd_req)

Send ZCL IAS ACE Get Bypassed Zone List command request.

Parameters:

cmd_req -- Pointer to the Get Bypassed Zone List command structure.

Returns:

Error code.

ezb_err_t ezb_zcl_ias_ace_get_zone_status_cmd_req(const ezb_zcl_ias_ace_get_zone_status_cmd_t *cmd_req)

Send ZCL IAS ACE Get Zone Status command request.

Parameters:

cmd_req -- Pointer to the Get Zone Status command structure.

Returns:

Error code.

ezb_err_t ezb_zcl_ias_ace_zone_status_changed_cmd_req(const ezb_zcl_ias_ace_zone_status_changed_cmd_t *cmd_req)

Send ZCL IAS ACE Zone Status Changed command request.

Parameters:

cmd_req -- Pointer to the Zone Status Changed command structure.

Returns:

Error code.

ezb_err_t ezb_zcl_ias_ace_panel_status_changed_cmd_req(const ezb_zcl_ias_ace_panel_status_changed_cmd_t *cmd_req)

Send ZCL IAS ACE Panel Status Changed command request.

Parameters:

cmd_req -- Pointer to the Panel Status Changed command structure.

Returns:

Error code.

5.2.6.3.6.2.9. Structures

struct ezb_zcl_ias_ace_zone_table_ent_s

Structure for IAS ACE Zone Table Entry.

Public Members

uint8_t zone_id

Zone ID.

uint16_t zone_type

Zone Type, see ezb_zcl_ias_zone_server_zone_type_t.

ezb_extaddr_t zone_address

Zone Address.

uint8_t bypassed

Zone is bypassed.

uint8_t zone_label[EZB_ZCL_IAS_ACE_ZONE_LABEL_MAX_LENGTH]

zcl string of Zone Label.

struct ezb_zcl_ias_ace_cmd_with_no_payload_s

Structure for ZCL command with no payload.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

struct ezb_zcl_ias_ace_zone_status_s

Structure for IAS ACE Zone Status.

Public Members

uint8_t zone_id

Zone ID.

uint16_t zone_status

Zone Status, see ezb_zcl_ias_zone_server_zone_status_t.

struct ezb_zcl_ias_ace_arm_payload_s

Payload for the ZCL IAS ACE Arm command.

Public Members

uint8_t arm_mode

Arm Mode.

uint8_t arm_disarm_code[EZB_ZCL_IAS_ACE_ARM_DISARM_CODE_MAX_LENGTH]

Arm/Disarm Code.

uint8_t zone_id

Zone ID.

struct ezb_zcl_ias_ace_bypass_rsp_payload_s

Payload for the ZCL IAS ACE Bypass Response command.

Public Members

uint8_t num_of_zones

Number of Zones.

uint8_t *bypass_result

Bypass Result, see ezb_zcl_ias_ace_bypass_result_t.

struct ezb_zcl_ias_ace_bypass_payload_s

Payload for the ZCL IAS ACE Bypass command.

Public Members

uint8_t num_of_zones

Number of Zones.

uint8_t *zone_id

Zone ID list.

uint8_t arm_disarm_code[EZB_ZCL_IAS_ACE_ARM_DISARM_CODE_MAX_LENGTH]

Arm/Disarm Code.

struct ezb_zcl_ias_ace_get_panel_status_rsp_payload_s

Payload for the ZCL IAS ACE Get Panel Status command.

Public Members

uint8_t panel_status

Panel Status.

uint8_t seconds_remaining

Seconds Remaining Parameter.

uint8_t aud_notif

Audible Notification.

uint8_t alarm_status

Alarm Status.

struct ezb_zcl_ias_ace_get_zone_info_rsp_payload_s

Payload for the ZCL IAS ACE Get Zone Info command.

Public Members

uint8_t zone_id

Zone ID.

uint16_t zone_type

Zone Type.

ezb_extaddr_t address

Zone Address.

uint8_t zone_label[EZB_ZCL_IAS_ACE_ZONE_LABEL_MAX_LENGTH]

Zone Label.

struct ezb_zcl_ias_ace_get_zone_status_rsp_payload_s

Payload for the ZCL IAS ACE Get Zone Status Response command.

Public Members

uint8_t zone_status_complete

Zone Status Complete.

uint8_t num_of_zones

Number of Zones.

ezb_zcl_ias_ace_zone_status_t *zone_id_status

Status of Zone IDs.

struct ezb_zcl_ias_ace_set_bypassed_zone_list_payload_s

Payload for the ZCL IAS ACE Set Bypassed Zone List command.

Public Members

uint8_t num_of_zones

Number of Zones.

uint8_t *zone_id

Zone ID array.

struct ezb_zcl_ias_ace_zone_status_changed_payload_s

Payload for the ZCL IAS ACE Zone Status Changed command.

Public Members

uint8_t zone_id

Zone ID.

uint16_t zone_status

Zone Status.

uint8_t aud_notif

Audible Notification.

uint8_t zone_label[EZB_ZCL_IAS_ACE_ZONE_LABEL_MAX_LENGTH]

Zone Label.

struct ezb_zcl_ias_ace_get_zone_status_payload_s

Payload for the ZCL IAS ACE Get Zone Status command.

Public Members

uint8_t starting_zone_id

Starting Zone ID.

uint8_t max_num_zone_ids

Max Number of Zone IDs Requested.

uint8_t zone_status_mask_flag

Zone Status Mask Flag.

uint16_t zone_status_mask

Zone Status Mask.

struct ezb_zcl_ias_ace_arm_cmd_s

Structure for the ZCL IAS ACE Arm command.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_ias_ace_arm_payload_t payload

Payload of the ZCL IAS ACE Arm command.

struct ezb_zcl_ias_ace_bypass_cmd_s

Structure for the ZCL IAS ACE Bypass command.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_ias_ace_bypass_payload_t payload

Payload of the ZCL IAS ACE Bypass command.

struct ezb_zcl_ias_ace_get_zone_info_cmd_s

Structure for the ZCL IAS ACE Get Zone Information command.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

uint8_t zone_id

Zone ID.

struct ezb_zcl_ias_ace_get_zone_info_cmd_s payload

Payload of the ZCL IAS ACE Get Zone Information command.

struct ezb_zcl_ias_ace_get_zone_status_cmd_s

Structure for the ZCL IAS ACE Get Zone Status command.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_ias_ace_get_zone_status_payload_t payload

Payload of the ZCL IAS ACE Get Zone Status command.

struct ezb_zcl_ias_ace_zone_status_changed_cmd_s

Structure for the ZCL IAS ACE Zone Status Changed command.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_ias_ace_zone_status_changed_payload_t payload

Payload of the ZCL IAS ACE Zone Status Changed command.

struct ezb_zcl_ias_ace_panel_status_changed_cmd_s

Structure for the ZCL IAS ACE Panel Status Changed command.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_ias_ace_panel_status_changed_payload_t payload

Payload of the ZCL IAS ACE Panel Status Changed command.

struct ezb_zcl_ias_ace_arm_message_s

Message for the ZCL IAS ACE Arm command message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

ezb_zcl_ias_ace_arm_payload_t payload

Payload of the ZCL IAS ACE Arm command.

struct ezb_zcl_ias_ace_arm_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

uint8_t arm_notif

Arm Notification.

struct ezb_zcl_ias_ace_arm_message_s out

Output: result to send back.

struct ezb_zcl_ias_ace_bypass_message_s

Message for the ZCL IAS ACE Bypass command message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

ezb_zcl_ias_ace_bypass_payload_t payload

Payload of the ZCL IAS ACE Bypass command.

struct ezb_zcl_ias_ace_bypass_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

ezb_zcl_ias_ace_bypass_rsp_payload_t *payload

Payload of the ZCL IAS ACE Bypass Response command.

ezb_zcl_cmd_cnf_ctx_t cnf_ctx

Command confirmation context, which will be triggered when response is confirmed.

struct ezb_zcl_ias_ace_bypass_message_s out

Output: result to send back.

struct ezb_zcl_ias_ace_emergency_message_s

Message for the ZCL IAS ACE Emergency command message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

struct ezb_zcl_ias_ace_emergency_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_ias_ace_emergency_message_s out

Output: result to send back.

struct ezb_zcl_ias_ace_get_panel_status_message_s

Message for the ZCL IAS ACE Get Panel Status command message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

struct ezb_zcl_ias_ace_get_panel_status_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

ezb_zcl_ias_ace_get_panel_status_rsp_payload_t payload

Payload of the ZCL IAS ACE Get Panel Status Response command.

struct ezb_zcl_ias_ace_get_panel_status_message_s out

Output: result to send back.

struct ezb_zcl_ias_ace_get_zone_status_message_s

Message for the ZCL IAS ACE Get Zone Status command message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

ezb_zcl_ias_ace_get_zone_status_payload_t payload

Payload of the ZCL IAS ACE Get Zone Status command.

struct ezb_zcl_ias_ace_get_zone_status_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

ezb_zcl_ias_ace_get_zone_status_rsp_payload_t *payload

Payload of the ZCL IAS ACE Get Zone Status Response command.

ezb_zcl_cmd_cnf_ctx_t cnf_ctx

Command confirmation context, which will be triggered when response is confirmed.

struct ezb_zcl_ias_ace_get_zone_status_message_s out

Output: result to send back.

struct ezb_zcl_ias_ace_arm_rsp_message_s

Message for the ZCL IAS ACE Arm Response message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

uint8_t arm_notif

Arm Notification, see ezb_zcl_ias_ace_arm_notif_t

struct ezb_zcl_ias_ace_arm_rsp_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_ias_ace_arm_rsp_message_s out

Output: result to send back.

struct ezb_zcl_ias_ace_get_zone_id_map_rsp_message_s

Message for the ZCL IAS ACE Get Zone ID map Response message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

uint16_t zone_id_map[EZB_ZCL_IAS_ACE_GET_ZONE_ID_MAP_LENGTH]

Zone ID Map

struct ezb_zcl_ias_ace_get_zone_id_map_rsp_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_ias_ace_get_zone_id_map_rsp_message_s out

Output: result to send back.

struct ezb_zcl_ias_ace_get_zone_info_rsp_message_s

Message for the ZCL IAS ACE Get Zone Information Response message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

ezb_zcl_ias_ace_get_zone_info_rsp_payload_t payload

Payload of the ZCL IAS ACE Get Zone Information Response command.

struct ezb_zcl_ias_ace_get_zone_info_rsp_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_ias_ace_get_zone_info_rsp_message_s out

Output: result to send back.

struct ezb_zcl_ias_ace_zone_status_changed_message_s

Message for the ZCL IAS ACE Zone Status Changed message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

ezb_zcl_ias_ace_zone_status_changed_payload_t payload

Payload of the ZCL IAS ACE Zone Status Changed command.

struct ezb_zcl_ias_ace_zone_status_changed_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_ias_ace_zone_status_changed_message_s out

Output: result to send back.

struct ezb_zcl_ias_ace_panel_status_changed_message_s

Message for the ZCL IAS ACE Panel Status Changed message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

ezb_zcl_ias_ace_panel_status_changed_payload_t payload

Payload of the ZCL IAS ACE Panel Status Changed command.

struct ezb_zcl_ias_ace_panel_status_changed_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_ias_ace_panel_status_changed_message_s out

Output: result to send back.

struct ezb_zcl_ias_ace_get_panel_status_rsp_message_s

Message for the ZCL IAS ACE Get Panel Status Response message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

ezb_zcl_ias_ace_get_panel_status_rsp_payload_t payload

Payload of the ZCL IAS ACE Get Panel Status Response command.

struct ezb_zcl_ias_ace_get_panel_status_rsp_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_ias_ace_get_panel_status_rsp_message_s out

Output: result to send back.

struct ezb_zcl_ias_ace_set_bypassed_zone_list_rsp_message_s

Message for the ZCL IAS ACE Set Bypassed Zone List Response message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

ezb_zcl_ias_ace_set_bypassed_zone_list_payload_t payload

Payload of the ZCL IAS ACE Set Bypassed Zone List command.

struct ezb_zcl_ias_ace_set_bypassed_zone_list_rsp_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_ias_ace_set_bypassed_zone_list_rsp_message_s out

Output: result to send back.

struct ezb_zcl_ias_ace_bypass_rsp_message_s

Message for the ZCL IAS ACE Bypass Response message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

ezb_zcl_ias_ace_bypass_rsp_payload_t payload

Payload of the ZCL IAS ACE Bypass Response command.

struct ezb_zcl_ias_ace_bypass_rsp_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_ias_ace_bypass_rsp_message_s out

Output: result to send back.

struct ezb_zcl_ias_ace_get_zone_status_rsp_message_s

Message for the ZCL IAS ACE Get Zone Status Response message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

ezb_zcl_ias_ace_get_zone_status_rsp_payload_t payload

Payload of the ZCL IAS ACE Get Zone Status Response command.

struct ezb_zcl_ias_ace_get_zone_status_rsp_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_ias_ace_get_zone_status_rsp_message_s out

Output: result to send back.

5.2.6.3.6.2.10. Macros

EZB_ZCL_IAS_ACE_GET_ZONE_ID_MAP_LENGTH

Length of array of Bitmap of Zone ID Map.

EZB_ZCL_IAS_ACE_ZONE_ID_MAX_VALUE

Zone ID max value.

EZB_ZCL_IAS_ACE_ZONE_LABEL_MAX_LENGTH

Maximum length of zone label (zcl string).

EZB_ZCL_IAS_ACE_ARM_DISARM_CODE_MAX_LENGTH

Maximum length of arm disarm code (zcl string)

5.2.6.3.6.2.11. Type Definitions

typedef void *ezb_zcl_ias_ace_zone_table_t

Pointer to IAS ACE Zone Table.

typedef struct ezb_zcl_ias_ace_zone_table_ent_s ezb_zcl_ias_ace_zone_table_ent_t

Structure for IAS ACE Zone Table Entry.

typedef struct ezb_zcl_ias_ace_cmd_with_no_payload_s ezb_zcl_ias_ace_cmd_with_no_payload_t

Structure for ZCL command with no payload.

typedef struct ezb_zcl_ias_ace_zone_status_s ezb_zcl_ias_ace_zone_status_t

Structure for IAS ACE Zone Status.

typedef struct ezb_zcl_ias_ace_arm_payload_s ezb_zcl_ias_ace_arm_payload_t

Payload for the ZCL IAS ACE Arm command.

typedef struct ezb_zcl_ias_ace_bypass_rsp_payload_s ezb_zcl_ias_ace_bypass_rsp_payload_t

Payload for the ZCL IAS ACE Bypass Response command.

typedef struct ezb_zcl_ias_ace_bypass_payload_s ezb_zcl_ias_ace_bypass_payload_t

Payload for the ZCL IAS ACE Bypass command.

typedef struct ezb_zcl_ias_ace_get_panel_status_rsp_payload_s ezb_zcl_ias_ace_get_panel_status_rsp_payload_t

Payload for the ZCL IAS ACE Get Panel Status command.

typedef ezb_zcl_ias_ace_get_panel_status_rsp_payload_t ezb_zcl_ias_ace_panel_status_changed_payload_t

Payload for the ZCL IAS ACE Panel Status Changed command.

typedef struct ezb_zcl_ias_ace_get_zone_info_rsp_payload_s ezb_zcl_ias_ace_get_zone_info_rsp_payload_t

Payload for the ZCL IAS ACE Get Zone Info command.

typedef struct ezb_zcl_ias_ace_get_zone_status_rsp_payload_s ezb_zcl_ias_ace_get_zone_status_rsp_payload_t

Payload for the ZCL IAS ACE Get Zone Status Response command.

typedef struct ezb_zcl_ias_ace_set_bypassed_zone_list_payload_s ezb_zcl_ias_ace_set_bypassed_zone_list_payload_t

Payload for the ZCL IAS ACE Set Bypassed Zone List command.

typedef struct ezb_zcl_ias_ace_zone_status_changed_payload_s ezb_zcl_ias_ace_zone_status_changed_payload_t

Payload for the ZCL IAS ACE Zone Status Changed command.

typedef struct ezb_zcl_ias_ace_get_zone_status_payload_s ezb_zcl_ias_ace_get_zone_status_payload_t

Payload for the ZCL IAS ACE Get Zone Status command.

typedef struct ezb_zcl_ias_ace_arm_cmd_s ezb_zcl_ias_ace_arm_cmd_t

Structure for the ZCL IAS ACE Arm command.

typedef struct ezb_zcl_ias_ace_bypass_cmd_s ezb_zcl_ias_ace_bypass_cmd_t

Structure for the ZCL IAS ACE Bypass command.

typedef ezb_zcl_ias_ace_cmd_with_no_payload_t ezb_zcl_ias_ace_emergency_cmd_t

Structure for the ZCL IAS ACE Emergency command.

typedef ezb_zcl_ias_ace_cmd_with_no_payload_t ezb_zcl_ias_ace_fire_cmd_t

Structure for the ZCL IAS ACE Fire command.

typedef ezb_zcl_ias_ace_cmd_with_no_payload_t ezb_zcl_ias_ace_panic_cmd_t

Structure for the ZCL IAS ACE Panic command.

typedef ezb_zcl_ias_ace_cmd_with_no_payload_t ezb_zcl_ias_ace_get_zone_id_map_cmd_t

Structure for the ZCL IAS ACE Get Zone ID Map command.

typedef struct ezb_zcl_ias_ace_get_zone_info_cmd_s ezb_zcl_ias_ace_get_zone_info_cmd_t

Structure for the ZCL IAS ACE Get Zone Information command.

typedef ezb_zcl_ias_ace_cmd_with_no_payload_t ezb_zcl_ias_ace_get_panel_status_cmd_t

Structure for the ZCL IAS ACE Get Panel Status command.

typedef ezb_zcl_ias_ace_cmd_with_no_payload_t ezb_zcl_ias_ace_get_bypassed_zone_list_cmd_t

Structure for the ZCL IAS ACE Get Bypassed Zone List command.

typedef struct ezb_zcl_ias_ace_get_zone_status_cmd_s ezb_zcl_ias_ace_get_zone_status_cmd_t

Structure for the ZCL IAS ACE Get Zone Status command.

typedef struct ezb_zcl_ias_ace_zone_status_changed_cmd_s ezb_zcl_ias_ace_zone_status_changed_cmd_t

Structure for the ZCL IAS ACE Zone Status Changed command.

typedef struct ezb_zcl_ias_ace_panel_status_changed_cmd_s ezb_zcl_ias_ace_panel_status_changed_cmd_t

Structure for the ZCL IAS ACE Panel Status Changed command.

typedef struct ezb_zcl_ias_ace_arm_message_s ezb_zcl_ias_ace_arm_message_t

Message for the ZCL IAS ACE Arm command message.

typedef struct ezb_zcl_ias_ace_bypass_message_s ezb_zcl_ias_ace_bypass_message_t

Message for the ZCL IAS ACE Bypass command message.

typedef struct ezb_zcl_ias_ace_emergency_message_s ezb_zcl_ias_ace_emergency_message_t

Message for the ZCL IAS ACE Emergency command message.

typedef struct ezb_zcl_ias_ace_emergency_message_s ezb_zcl_ias_ace_fire_message_t

Message for the ZCL IAS ACE Fire command message.

typedef struct ezb_zcl_ias_ace_emergency_message_s ezb_zcl_ias_ace_panic_message_t

Message for the ZCL IAS ACE Panic command message.

typedef struct ezb_zcl_ias_ace_get_panel_status_message_s ezb_zcl_ias_ace_get_panel_status_message_t

Message for the ZCL IAS ACE Get Panel Status command message.

typedef struct ezb_zcl_ias_ace_emergency_message_s ezb_zcl_ias_ace_get_bypassed_zone_list_message_t

Message for the ZCL IAS ACE Get Bypassed Zone List command message.

typedef struct ezb_zcl_ias_ace_get_zone_status_message_s ezb_zcl_ias_ace_get_zone_status_message_t

Message for the ZCL IAS ACE Get Zone Status command message.

typedef struct ezb_zcl_ias_ace_arm_rsp_message_s ezb_zcl_ias_ace_arm_rsp_message_t

Message for the ZCL IAS ACE Arm Response message.

typedef struct ezb_zcl_ias_ace_get_zone_id_map_rsp_message_s ezb_zcl_ias_ace_get_zone_id_map_rsp_message_t

Message for the ZCL IAS ACE Get Zone ID map Response message.

typedef struct ezb_zcl_ias_ace_get_zone_info_rsp_message_s ezb_zcl_ias_ace_get_zone_info_rsp_message_t

Message for the ZCL IAS ACE Get Zone Information Response message.

typedef struct ezb_zcl_ias_ace_zone_status_changed_message_s ezb_zcl_ias_ace_zone_status_changed_message_t

Message for the ZCL IAS ACE Zone Status Changed message.

typedef struct ezb_zcl_ias_ace_panel_status_changed_message_s ezb_zcl_ias_ace_panel_status_changed_message_t

Message for the ZCL IAS ACE Panel Status Changed message.

typedef struct ezb_zcl_ias_ace_get_panel_status_rsp_message_s ezb_zcl_ias_ace_get_panel_status_rsp_message_t

Message for the ZCL IAS ACE Get Panel Status Response message.

typedef struct ezb_zcl_ias_ace_set_bypassed_zone_list_rsp_message_s ezb_zcl_ias_ace_set_bypassed_zone_list_rsp_message_t

Message for the ZCL IAS ACE Set Bypassed Zone List Response message.

typedef struct ezb_zcl_ias_ace_bypass_rsp_message_s ezb_zcl_ias_ace_bypass_rsp_message_t

Message for the ZCL IAS ACE Bypass Response message.

typedef struct ezb_zcl_ias_ace_get_zone_status_rsp_message_s ezb_zcl_ias_ace_get_zone_status_rsp_message_t

Message for the ZCL IAS ACE Get Zone Status Response message.

5.2.6.3.6.2.12. Enumerations

enum ezb_zcl_ias_ace_arm_mode_t

Values of the Arm Mode.

Values:

enumerator EZB_ZCL_IAS_ACE_ARM_MODE_DISARM

Disarm.

enumerator EZB_ZCL_IAS_ACE_ARM_MODE_DAY

Arm Day/Home Zones Only.

enumerator EZB_ZCL_IAS_ACE_ARM_MODE_NIGHT

Arm Night/Sleep Zones Only.

enumerator EZB_ZCL_IAS_ACE_ARM_MODE_ALL

Arm All Zones.

enum ezb_zcl_ias_ace_arm_notif_t

Values of the Arm Notification.

Values:

enumerator EZB_ZCL_IAS_ACE_ARM_NOTIF_ALL_ZONES_DISARMED

All Zones Disarmed.

enumerator EZB_ZCL_IAS_ACE_ARM_NOTIF_ONLY_DAY_HOME_ZONES_ARMED

Only Day/Home Zones Armed.

enumerator EZB_ZCL_IAS_ACE_ARM_NOTIF_ONLY_NIGHT_SLEEP_ZONES_ARMED

Only Night/Sleep Zones Armed.

enumerator EZB_ZCL_IAS_ACE_ARM_NOTIF_ALL_ZONES_ARMED

All Zones Armed.

enumerator EZB_ZCL_IAS_ACE_ARM_NOTIF_INVALID_ARM_DISARM_CODE

Invalid Arm/Disarm Code.

enumerator EZB_ZCL_IAS_ACE_ARM_NOTIF_NOT_READY_TO_ARM

Not ready to arm.

enumerator EZB_ZCL_IAS_ACE_ARM_NOTIF_ALREADY_DISARMED

Already disarmed.

enum ezb_zcl_ias_ace_aud_notif_t

IAS ACE Audible Notification Field.

Values:

enumerator EZB_ZCL_IAS_ACE_AUD_NOTIF_MUTE

Mute (i.e., no audible notification).

enumerator EZB_ZCL_IAS_ACE_AUD_NOTIF_DEF_SOUND

Default sound.

enumerator EZB_ZCL_IAS_ACE_AUD_NOTIF_MANUF_SPECIFIC

Manufacturer specific.

enum ezb_zcl_ias_ace_panel_status_t

IAS ACE PanelStatus Parameter.

Values:

enumerator EZB_ZCL_IAS_ACE_PANEL_STATUS_DISARMED

Panel disarmed (all zones disarmed) and ready to arm.

enumerator EZB_ZCL_IAS_ACE_PANEL_STATUS_ARMED_STAY

Armed stay.

enumerator EZB_ZCL_IAS_ACE_PANEL_STATUS_ARMED_NIGHT

Armed night.

enumerator EZB_ZCL_IAS_ACE_PANEL_STATUS_ARMED_AWAY

Armed away.

enumerator EZB_ZCL_IAS_ACE_PANEL_STATUS_EXIT_DELAY

Exit delay.

enumerator EZB_ZCL_IAS_ACE_PANEL_STATUS_ENTRY_DELAY

Entry delay.

enumerator EZB_ZCL_IAS_ACE_PANEL_STATUS_NOT_READY

Not ready to arm.

enumerator EZB_ZCL_IAS_ACE_PANEL_STATUS_IN_ALARM

In alarm.

enumerator EZB_ZCL_IAS_ACE_PANEL_STATUS_ARMING_STAY

Arming Stay.

enumerator EZB_ZCL_IAS_ACE_PANEL_STATUS_ARMING_NIGHT

Arming Night.

enumerator EZB_ZCL_IAS_ACE_PANEL_STATUS_ARMING_AWAY

Arming Away.

enum ezb_zcl_ias_ace_alarm_status_t

IAS ACE Alarm Status Field.

Values:

enumerator EZB_ZCL_IAS_ACE_ALARM_STATUS_NO_ALARM

No alarm.

enumerator EZB_ZCL_IAS_ACE_ALARM_STATUS_BURGLAR

Burglar.

enumerator EZB_ZCL_IAS_ACE_ALARM_STATUS_FIRE

Fire.

enumerator EZB_ZCL_IAS_ACE_ALARM_STATUS_EMERGENCY

Emergency.

enumerator EZB_ZCL_IAS_ACE_ALARM_STATUS_POLICE_PANIC

Police Panic.

enumerator EZB_ZCL_IAS_ACE_ALARM_STATUS_FIRE_PANIC

Fire Panic.

enumerator EZB_ZCL_IAS_ACE_ALARM_STATUS_EMERGENCY_PANIC

Emergency Panic.

enum ezb_zcl_ias_ace_bypass_result_t

IAS ACE Bypass Result.

Values:

enumerator EZB_ZCL_IAS_ACE_BYPASS_RESULT_BYPASSED

Bypass request is successful. Zone is bypassed.

enumerator EZB_ZCL_IAS_ACE_BYPASS_RESULT_NOT_BYPASSED

Bypass request is unsuccessful. Zone is not bypassed.

enumerator EZB_ZCL_IAS_ACE_BYPASS_RESULT_NOT_ALLOWED

Bypass request is not allowed. Zone is not bypassed.

enumerator EZB_ZCL_IAS_ACE_BYPASS_RESULT_INVALID_ZONE_ID

Invalid Zone ID in the request.

enumerator EZB_ZCL_IAS_ACE_BYPASS_RESULT_UNKNOWN_ZONE_ID

Valid range of Zone ID, but unknown to server.

enumerator EZB_ZCL_IAS_ACE_BYPASS_RESULT_INVALID_ARM_CODE

Arm/Disarm Code was entered incorrectly.

5.2.6.3.6.3. IAS WD

5.2.6.3.6.3.1. Header File

5.2.6.3.6.3.2. Functions

ezb_err_t ezb_zcl_ias_wd_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an ias_wd cluster descriptor.

Parameters:

  • cluster_desc -- [in] The ias_wd cluster descriptor.

  • attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

  • value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_ias_wd_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an ias_wd cluster descriptor.

Parameters:

  • cluster_cfg -- [in] The pointer to the ias_wd cluster configuration structure. Use ezb_zcl_ias_wd_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_ias_wd_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

  • role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_ias_wd_cluster_client_init(uint8_t ep_id)

Initialize the IasWd cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_ias_wd_cluster_server_init(uint8_t ep_id)

Initialize the IasWd cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.6.3.3. Structures

struct ezb_zcl_ias_wd_cluster_server_config_s

Configuration mandatory attributes for the IasWd server cluster.

Public Members

uint16_t max_duration

Configurable mandatory MaxDuration attribute

5.2.6.3.6.3.4. Macros

EZB_ZCL_IAS_WD_CLUSTER_REVISION

Cluster Revision of the ias_wd cluster implementation.

EZB_ZCL_IAS_WD_MAX_DURATION_DEFAULT_VALUE

Default value of MaxDuration in IasWd cluster.

EZB_ZCL_IAS_WD_MAX_DURATION_MIN_VALUE

Minimum value of MaxDuration in IasWd cluster.

EZB_ZCL_IAS_WD_MAX_DURATION_MAX_VALUE

Maximum value of MaxDuration in IasWd cluster.

EZB_ZCL_CLUSTER_ID_IAS_WD_CLIENT_ROLE_INIT
EZB_ZCL_CLUSTER_ID_IAS_WD_SERVER_ROLE_INIT

5.2.6.3.6.3.5. Type Definitions

typedef struct ezb_zcl_ias_wd_cluster_server_config_s ezb_zcl_ias_wd_cluster_server_config_t

Configuration mandatory attributes for the IasWd server cluster.

typedef ezb_zcl_ias_wd_cluster_server_config_t ezb_zcl_ias_wd_cluster_config_t

5.2.6.3.6.3.6. Enumerations

enum ezb_zcl_ias_wd_server_attr_t

Attribute identifiers for the ias_wd server cluster.

Values:

enumerator EZB_ZCL_ATTR_IAS_WD_MAX_DURATION_ID

MaxDuration attribute.

enum ezb_zcl_ias_wd_server_cmd_id_t

Received Command identifiers for the IasWd cluster.

Values:

enumerator EZB_ZCL_CMD_IAS_WD_START_WARNING_ID

StartWarning command.

enumerator EZB_ZCL_CMD_IAS_WD_SQUAWK_ID

Squawk command.

5.2.6.3.6.3.7. Header File

5.2.6.3.6.3.8. Functions

ezb_err_t ezb_zcl_ias_wd_start_warning_cmd_req(const ezb_zcl_ias_wd_start_warning_cmd_t *cmd_req)

Request to send an IAS WD Start Warning command request.

Parameters:

cmd_req -- Pointer to the Start Warning command structure.

Returns:

Error code.

ezb_err_t ezb_zcl_ias_wd_squawk_cmd_req(const ezb_zcl_ias_wd_squawk_cmd_t *cmd_req)

Request to send an IAS WD Squawk command request.

Parameters:

cmd_req -- Pointer to the Squawk command structure.

Returns:

Error code.

5.2.6.3.6.3.9. Structures

struct ezb_zcl_ias_wd_start_warning_payload_s

Payload for IAS WD Start Warning command request.

Public Members

uint8_t warning_mode

Warning Mode.

uint8_t strobe

Strobe.

uint8_t siren_level

Siren level.

uint16_t duration

Duration.

uint8_t strobe_duty_cycle

Strobe duty cycle.

uint8_t strobe_level

Strobe level.

struct ezb_zcl_ias_wd_squawk_payload_s

Payload for IAS WD Squawk command request.

Public Members

uint8_t squawk_level

Squawk level.

uint8_t strobe

Strobe.

uint8_t squawk_mode

Squawk Mode.

struct ezb_zcl_ias_wd_start_warning_cmd_s

structure for IAS WD Start Warning command.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_ias_wd_start_warning_payload_t payload

Payload for the Start Warning command.

struct ezb_zcl_ias_wd_squawk_cmd_s

Structure for IAS WD Squawk command.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_ias_wd_squawk_payload_t payload

Payload for the Squawk command.

struct ezb_zcl_ias_wd_start_warning_message_s

Message for IAS WD Start Warning command message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

ezb_zcl_ias_wd_start_warning_payload_t payload

Payload for the Start Warning command.

struct ezb_zcl_ias_wd_start_warning_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_ias_wd_start_warning_message_s out

Output: result to send back.

struct ezb_zcl_ias_wd_squawk_message_s

Message for IAS WD Squawk command message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

ezb_zcl_ias_wd_squawk_payload_t payload

Payload for the Squawk command.

struct ezb_zcl_ias_wd_squawk_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_ias_wd_squawk_message_s out

Output: result to send back.

5.2.6.3.6.3.10. Type Definitions

typedef struct ezb_zcl_ias_wd_start_warning_payload_s ezb_zcl_ias_wd_start_warning_payload_t

Payload for IAS WD Start Warning command request.

typedef struct ezb_zcl_ias_wd_squawk_payload_s ezb_zcl_ias_wd_squawk_payload_t

Payload for IAS WD Squawk command request.

typedef struct ezb_zcl_ias_wd_start_warning_cmd_s ezb_zcl_ias_wd_start_warning_cmd_t

structure for IAS WD Start Warning command.

typedef struct ezb_zcl_ias_wd_squawk_cmd_s ezb_zcl_ias_wd_squawk_cmd_t

Structure for IAS WD Squawk command.

typedef struct ezb_zcl_ias_wd_start_warning_message_s ezb_zcl_ias_wd_start_warning_message_t

Message for IAS WD Start Warning command message.

typedef struct ezb_zcl_ias_wd_squawk_message_s ezb_zcl_ias_wd_squawk_message_t

Message for IAS WD Squawk command message.

5.2.6.3.6.3.11. Enumerations

enum ezb_zcl_ias_wd_warning_mode_t

Values of Warning Mode Field.

Values:

enumerator EZB_ZCL_IAS_WD_WARNING_MODE_STOP

Stop.

enumerator EZB_ZCL_IAS_WD_WARNING_MODE_BURGLAR

Burglar.

enumerator EZB_ZCL_IAS_WD_WARNING_MODE_FIRE

Fire.

enumerator EZB_ZCL_IAS_WD_WARNING_MODE_EMERGENCY

Emergency.

enumerator EZB_ZCL_IAS_WD_WARNING_MODE_POLICE_PANIC

Police panic.

enumerator EZB_ZCL_IAS_WD_WARNING_MODE_FIRE_PANIC

Fire panic.

enumerator EZB_ZCL_IAS_WD_WARNING_MODE_EMERGENCY_PANIC

Emergency panic (i.e., medical issue).

enum ezb_zcl_ias_wd_strobe_t

Values of Strobe Field.

Values:

enumerator EZB_ZCL_IAS_WD_STROBE_NO_STROBE

No strobe.

enumerator EZB_ZCL_IAS_WD_STROBE_USE_STROBE

Use strobe in parallel to warning.

enum ezb_zcl_ias_wd_siren_level_t

Values of Siren Level Field.

Values:

enumerator EZB_ZCL_IAS_WD_SIREN_LEVEL_LOW

Low level sound.

enumerator EZB_ZCL_IAS_WD_SIREN_LEVEL_MEDIUM

Medium level sound.

enumerator EZB_ZCL_IAS_WD_SIREN_LEVEL_HIGH

High level sound.

enumerator EZB_ZCL_IAS_WD_SIREN_LEVEL_VERY_HIGH

Very high level sound.

enum ezb_zcl_ias_wd_strobe_level_t

Values of Strobe Level Field.

Values:

enumerator EZB_ZCL_IAS_WD_STROBE_LEVEL_LOW

Low level strobe.

enumerator EZB_ZCL_IAS_WD_STROBE_LEVEL_MEDIUM

Medium level strobe.

enumerator EZB_ZCL_IAS_WD_STROBE_LEVEL_HIGH

High level strobe.

enumerator EZB_ZCL_IAS_WD_STROBE_LEVEL_VERY_HIGH

Very high level strobe.

enum ezb_zcl_ias_wd_squawk_mode_t

Values of Squawk Mode Field.

Values:

enumerator EZB_ZCL_IAS_WD_SQUAWK_MODE_ARMED

Notification sound for "System is armed".

enumerator EZB_ZCL_IAS_WD_SQUAWK_MODE_DISARMED

Notification sound for "System is disarmed".

enum ezb_zcl_ias_wd_squawk_strobe_t

Values of Squawk Strobe Field.

Values:

enumerator EZB_ZCL_IAS_WD_SQUAWK_STROBE_NO_STROBE

No strobe.

enumerator EZB_ZCL_IAS_WD_SQUAWK_STROBE_USE_STROBE

Use strobe blink in parallel to squawk.

enum ezb_zcl_ias_wd_squawk_level_t

Values of Squawk Level Field.

Values:

enumerator EZB_ZCL_IAS_WD_SQUAWK_LEVEL_LOW

Low level sound.

enumerator EZB_ZCL_IAS_WD_SQUAWK_LEVEL_MEDIUM

Medium level sound.

enumerator EZB_ZCL_IAS_WD_SQUAWK_LEVEL_HIGH

High level sound.

enumerator EZB_ZCL_IAS_WD_SQUAWK_LEVEL_VERY_HIGH

Very high level sound.