Logo
Developing with ZBOSS for Zigbee
zb_zcl_en50523_appliance_events_and_alerts.h File Reference

Data Structures

struct  zb_zcl_en50523_appl_ev_and_alerts_alert_struct_s
 Alert structure. More...
 
struct  zb_zcl_en50523_appl_ev_and_alerts_get_alerts_resp_s
 Structure representation of Get Alerts Response command. More...
 
struct  zb_zcl_en50523_appl_ev_and_alerts_alerts_notif_s
 Structure representation of Alerts Notification command. More...
 
struct  zb_zcl_en50523_appl_ev_and_alerts_event_notif_s
 Structure representation of Event Notification command. More...
 

Macros

#define ZB_ZCL_CLUSTER_ID_APPLIANCE_EVENTS_AND_ALERTS_SERVER_ROLE_INIT   zb_zcl_en50523_appliance_events_and_alerts_init_server
 
#define ZB_ZCL_CLUSTER_ID_APPLIANCE_EVENTS_AND_ALERTS_CLIENT_ROLE_INIT   zb_zcl_en50523_appliance_events_and_alerts_init_client
 

Functions

void zb_zcl_en50523_appliance_events_and_alerts_init_server (void)
 
void zb_zcl_en50523_appliance_events_and_alerts_init_client (void)
 

EN50523 Appliance events and alerts cluster commands

#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_CLUSTER_REVISION_DEFAULT   ((zb_uint16_t)0x0001u)
 Default value for EN50523 Appliance events and alerts cluster revision global attribute. More...
 
#define ZB_ZCL_DECLARE_EN50523_APPL_EV_AND_ALERTS_ATTR_LIST(attr_list)
 Declare attribute list for EN50523 Appliance events and alerts cluster (only cluster revision attribute) More...
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_SEND_GET_ALERTS_REQ( buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb)
 Get Alerts command, ZCL spec 15.4.2.2.1. More...
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_MAX_ALERTS_NUM   15
 Maximum number of Alerts. More...
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_ALERTS_COUNT_GET_NUM(_alerts_count)   ((_alerts_count) & 0x0F)
 Get Number of Alerts. More...
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_ALERTS_COUNT_SET_NUM(_alerts_count, num)   ((_alerts_count) |= (num & 0x0F))
 Set Number of Alerts. More...
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_ALERTS_COUNT_GET_TYPE(_alerts_count)   (((_alerts_count) & 0xF0) >> 4)
 Get Type of alert. More...
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_ALERTS_COUNT_SET_TYPE(_alerts_count, type)   ((_alerts_count) |= ((type & 0x0F) << 4))
 Set Type of alert. More...
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_ALERT_STRUCT_GET_ID(_alert_struct)   ((_alert_struct).alert[2] & 0xFF)
 Get Alert ID. More...
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_ALERT_STRUCT_SET_ID(_alert_struct, id)   ((_alert_struct).alert[2] = (id & 0xFF))
 Set Alert ID. More...
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_ALERT_STRUCT_GET_CATEGORY(_alert_struct)   ((_alert_struct).alert[1] & 0x0F)
 Get Alert Category. More...
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_ALERT_STRUCT_SET_CATEGORY(_alert_struct, cat)   ((_alert_struct).alert[1] |= (cat & 0x0F))
 Set Alert Category. More...
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_ALERT_STRUCT_GET_PRESENCE(_alert_struct)   (((_alert_struct).alert[1] & 0xF0) >> 4)
 Get Alert Presence recovery. More...
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_ALERT_STRUCT_SET_PRESENCE(_alert_struct, pres)   ((_alert_struct).alert[1] |= (pres & 0x0F) << 4)
 Set Alert Presence recovery. More...
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_ALERT_STRUCT_GET_MANUF_SPEC(_alert_struct)   ((_alert_struct).alert[0] & 0xFF)
 Get Alert Manufacturer specific bits. More...
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_ALERT_STRUCT_SET_MANUF_SPEC(_alert_struct, val)   ((_alert_struct).alert[0] = (val & 0xFF))
 Set Alert Manufacturer specific bits. More...
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_GET_ALERTS_RESP_PAYLOAD_SIZE(ptr)
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_SEND_GET_ALERTS_RESP_START(buffer, seq, alerts_count, ptr)
 Start Get Alerts Response command, ZCL spec 15.4.2.3.1. More...
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_SEND_GET_ALERTS_RESP_ADD(ptr, alert_struct)
 Add Alert Structure to Get Alerts Response command, ZCL spec 15.4.2.3.1. More...
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_SEND_GET_ALERTS_RESP_END(ptr, buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id)
 End form Get Alerts Response command and send it, ZCL spec 15.4.2.3.1. More...
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_GET_GET_ALERTS_RESP(data_ptr, buffer, status)
 Macro for getting Get Alerts Response command, ZCL spec 15.4.2.3.1. More...
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_ALERTS_NOTIF_PAYLOAD_SIZE(ptr)
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_SEND_ALERTS_NOTIF_START( buffer, def_resp, alerts_count, ptr)
 Start Alerts Notification command, ZCL spec 15.4.2.3.2. More...
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_SEND_ALERTS_NOTIF_ADD(ptr, alert_struct)
 Add Alert Structure to Alerts Notification command, ZCL spec 15.4.2.3.2. More...
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_SEND_ALERTS_NOTIF_END( ptr, buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, cb)
 End form Alerts Notification command and send it, ZCL spec 15.4.2.3.2. More...
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_GET_ALERTS_NOTIF(data_ptr, buffer, status)
 Macro for getting Alerts Notification command, ZCL spec 15.4.2.3.2. More...
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_SEND_EVENT_NOTIF( buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb, event_identification)
 Event Notification command, ZCL spec 15.4.2.3.3. More...
 
#define ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_GET_EVENT_NOTIF(data_ptr, buffer, status)
 Macro for getting Event Notification command, see ZCL spec 15.4.2.3.3. More...
 
enum  zb_zcl_en50523_appl_ev_and_alerts_recv_cmd_e { ZB_ZCL_CMD_EN50523_APPL_EV_AND_ALERTS_GET_ALERTS_ID = 0x00 }
 EN50523 Appliance events and alerts cluster command received identifiers. More...
 
enum  zb_zcl_en50523_appl_ev_and_alerts_send_cmd_e { ZB_ZCL_CMD_EN50523_APPL_EV_AND_ALERTS_GET_ALERTS_RESP_ID = 0x00, ZB_ZCL_CMD_EN50523_APPL_EV_AND_ALERTS_ALERTS_NOTIFICATION_ID = 0x01, ZB_ZCL_CMD_EN50523_APPL_EV_AND_ALERTS_EVENT_NOTIFICATION_ID = 0x02 }
 EN50523 Appliance events and alerts cluster commands generated identifiers. More...
 
enum  zb_zcl_en50523_appl_ev_and_alerts_alerts_type_e { ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_ALERTS_TYPE_UNSTRUCTURED = 0x00 }
 Type of alert. More...
 
enum  zb_zcl_en50523_appl_ev_and_alerts_alert_category_e { ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_ALERT_CATEGORY_WARNING = 0x01, ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_ALERT_CATEGORY_DANGER = 0x02, ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_ALERT_CATEGORY_FAILURE = 0x03 }
 Alert category. More...
 
enum  zb_zcl_en50523_appl_ev_and_alerts_alert_presence_e { ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_ALERT_RECOVERY = 0x00, ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_ALERT_PRESENCE = 0x01 }
 Alert presence recovery. More...
 
enum  zb_zcl_en50523_appl_ev_and_alerts_event_identification_e {
  ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_EVENT_ID_END_OF_CYCLE = 0x01, ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_EVENT_ID_TEMP_REACHED = 0x04, ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_EVENT_ID_END_OF_COOKING = 0x05, ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_EVENT_ID_SWITCHING_OFF = 0x06,
  ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_EVENT_ID_WRONG_DATA = 0xf7
}
 Event Identification. More...
 
typedef struct zb_zcl_en50523_appl_ev_and_alerts_alert_struct_s zb_zcl_en50523_appl_ev_and_alerts_alert_struct_t
 Alert structure. More...
 
typedef struct zb_zcl_en50523_appl_ev_and_alerts_get_alerts_resp_s zb_zcl_en50523_appl_ev_and_alerts_get_alerts_resp_t
 Structure representation of Get Alerts Response command. More...
 
typedef struct zb_zcl_en50523_appl_ev_and_alerts_alerts_notif_s zb_zcl_en50523_appl_ev_and_alerts_alerts_notif_t
 Structure representation of Alerts Notification command. More...
 
typedef struct zb_zcl_en50523_appl_ev_and_alerts_event_notif_s zb_zcl_en50523_appl_ev_and_alerts_event_notif_t
 Structure representation of Event Notification command. More...
 

Macro Definition Documentation

§ ZB_ZCL_CLUSTER_ID_APPLIANCE_EVENTS_AND_ALERTS_CLIENT_ROLE_INIT

#define ZB_ZCL_CLUSTER_ID_APPLIANCE_EVENTS_AND_ALERTS_CLIENT_ROLE_INIT   zb_zcl_en50523_appliance_events_and_alerts_init_client

§ ZB_ZCL_CLUSTER_ID_APPLIANCE_EVENTS_AND_ALERTS_SERVER_ROLE_INIT

#define ZB_ZCL_CLUSTER_ID_APPLIANCE_EVENTS_AND_ALERTS_SERVER_ROLE_INIT   zb_zcl_en50523_appliance_events_and_alerts_init_server

Function Documentation

§ zb_zcl_en50523_appliance_events_and_alerts_init_client()

void zb_zcl_en50523_appliance_events_and_alerts_init_client ( void  )

§ zb_zcl_en50523_appliance_events_and_alerts_init_server()

void zb_zcl_en50523_appliance_events_and_alerts_init_server ( void  )