Logo
Developing with ZBOSS for Zigbee
zb_zcl_alarms.h File Reference

Data Structures

struct  zb_zcl_alarms_reset_alarm_req_s
 Structured representation of Reset alarm command payload. More...
 
struct  zb_zcl_alarm_get_alarm_hdr_res_s
 
struct  zb_zcl_alarm_get_alarm_res_s
 Get alarm response command structure. More...
 

Macros

#define ZB_ZCL_ALARMS_CLUSTER_REVISION_DEFAULT   ((zb_uint16_t)0x0001u)
 Default value for Alarms cluster revision global attribute. More...
 
#define ZB_ZCL_DECLARE_ALARMS_ATTR_LIST(attr_list)
 Declare attribute list for Alarms cluster (only cluster revision attribute) More...
 
#define ZB_ZCL_ALARMS_REPORT_ATTR_COUNT   0
 
#define ZB_ZCL_CLUSTER_ID_ALARMS_SERVER_ROLE_INIT   zb_zcl_alarms_init_server
 
#define ZB_ZCL_CLUSTER_ID_ALARMS_CLIENT_ROLE_INIT   zb_zcl_alarms_init_client
 

Enumerations

Alarms cluster attributes
enum  zb_zcl_alarms_attr_e { ZB_ZCL_ATTR_ALARMS_ALARM_COUNT_ID = 0x0000 }
 Alarms cluster attribute identifiers. More...
 

Functions

void zb_zcl_alarms_init_server (void)
 
void zb_zcl_alarms_init_client (void)
 

Alarms cluster commands

#define ZB_ZCL_ALARMS_RESET_ALARM_REQ_PAYLOAD_LEN   sizeof(zb_zcl_alarms_reset_alarm_req_t)
 Reset alarm payload length macro. More...
 
#define ZB_ZCL_ALARMS_SEND_RESET_ALARM_REQ( buffer, addr, dst_addr_mode, dst_ep, ep, prof_id, dis_default_resp, cb, alarm_code, cluster_id)
 Send Reset alarm command. More...
 
#define ZB_ZCL_ALARMS_GET_RESET_ALARM_REQ(data_buf, reset_alarm_req, status)
 Parses Reset alarm command and fills in data request structure. If request contains invalid data, status will set to ZB_FALSE. More...
 
#define ZB_ZCL_ALARMS_SEND_RESET_ALL_ALARMS_REQ( buffer, addr, dst_addr_mode, dst_ep, ep, prof_id, dis_default_resp, cb)
 Send Reset all alarms command. More...
 
#define ZB_ZCL_ALARMS_SEND_GET_ALARM_REQ( buffer, addr, dst_addr_mode, dst_ep, ep, prof_id, dis_default_resp, cb)
 Send Get alarm command. More...
 
#define ZB_ZCL_ALARMS_SEND_RESET_ALARM_LOG_REQ( buffer, addr, dst_addr_mode, dst_ep, ep, prof_id, dis_default_resp, cb)
 Send Reset alarm log command. More...
 
#define ZB_ZCL_ALARM_GET_ALARM_RES_SIZE   sizeof(zb_zcl_alarm_get_alarm_res_t)
 
#define ZB_ZCL_ALARM_GET_ALARM_HDR_RES_SIZE   sizeof(zb_zcl_alarm_get_alarm_hdr_res_t)
 
#define ZB_ZCL_ALARMS_SEND_ALARM_RES( buffer, addr, dst_addr_mode, dst_ep, ep, prof_id, cb, alarm_code, cluster_id)
 Send Alarm command (to client) More...
 
#define ZB_ZCL_ALARMS_GET_ALARM_RES(data_ptr, buffer, status)
 Parses Reset alarm command and fills in data request structure. If request contains invalid data, status will set to ZB_FALSE. More...
 
#define ZB_ZCL_ALARMS_GET_GET_ALARM_RES(data_buf, get_alarm_res, status)
 Parses Get alarm response command and returns response data structure or status = ZB_FALSE if request contains invalid data. More...
 
enum  zb_zcl_alarms_cmd_e { ZB_ZCL_CMD_ALARMS_RESET_ALARM_ID = 0x00, ZB_ZCL_CMD_ALARMS_RESET_ALL_ALARMS_ID = 0x01, ZB_ZCL_CMD_ALARMS_GET_ALARM_ID = 0x02, ZB_ZCL_CMD_ALARMS_RESET_ALARM_LOG_ID = 0x03 }
 Alarms cluster command identifiers. More...
 
enum  zb_zcl_alarms_cmd_resp_e { ZB_ZCL_CMD_ALARMS_ALARM_ID = 0x00, ZB_ZCL_CMD_ALARMS_GET_ALARM_RES_ID = 0x01 }
 Alarms cluster response command identifiers. More...
 
typedef struct zb_zcl_alarms_reset_alarm_req_s zb_zcl_alarms_reset_alarm_req_t
 Structured representation of Reset alarm command payload. More...
 
typedef zb_zcl_alarms_reset_alarm_req_t zb_zcl_alarms_alarm_res_t
 Structured representation of Alarm command payload. More...
 
typedef struct zb_zcl_alarm_get_alarm_hdr_res_s zb_zcl_alarm_get_alarm_hdr_res_t
 
typedef struct zb_zcl_alarm_get_alarm_res_s zb_zcl_alarm_get_alarm_res_t
 Get alarm response command structure. More...
 

Macro Definition Documentation

§ ZB_ZCL_CLUSTER_ID_ALARMS_CLIENT_ROLE_INIT

#define ZB_ZCL_CLUSTER_ID_ALARMS_CLIENT_ROLE_INIT   zb_zcl_alarms_init_client

§ ZB_ZCL_CLUSTER_ID_ALARMS_SERVER_ROLE_INIT

#define ZB_ZCL_CLUSTER_ID_ALARMS_SERVER_ROLE_INIT   zb_zcl_alarms_init_server

Function Documentation

§ zb_zcl_alarms_init_client()

void zb_zcl_alarms_init_client ( void  )

§ zb_zcl_alarms_init_server()

void zb_zcl_alarms_init_server ( void  )