Logo
Developing with ZBOSS for Zigbee
zb_zcl_groups.h File Reference

Data Structures

struct  zb_zcl_groups_add_group_req_s
 Add group command structure. More...
 
struct  zb_zcl_groups_add_group_res_s
 Add group response command structure. More...
 
struct  zb_zcl_groups_view_group_req_s
 View group command structure. More...
 
struct  zb_zcl_groups_view_group_res_s
 View group command response structure. More...
 
struct  zb_zcl_groups_get_group_membership_req_s
 Get Group Membership command structure. More...
 
struct  zb_zcl_groups_get_group_membership_res_s
 Get Group Membership command response structure. More...
 
struct  zb_zcl_groups_remove_group_req_s
 Remove Group command structure. More...
 
struct  zb_zcl_groups_remove_group_res_s
 Remove group response command structure. More...
 

Macros

#define ZB_ZCL_GROUPS_GET_ADD_GROUP_REQ(data_buf, add_group_req)
 Parses Add group command and fills in data request structure. If request contains invalid data, ZB_ZCL_NULL_ID is stored as group_id. More...
 
#define ZB_ZCL_GROUPS_GET_ADD_GROUP_RES(data_buf, add_group_res)
 Parses Add group response command and returns response data structure or NULL if request contains invalid data. More...
 
#define ZB_ZCL_GROUPS_SEND_ADD_GROUP_REQ( buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb, group_id)
 Send Add group command. More...
 
#define ZB_ZCL_GROUPS_GET_VIEW_GROUP_REQ(data_buf, view_group_req)
 Parses View group command and fills in data request structure. If request contains invalid data, ZB_ZCL_NULL_ID is stored as group_id. More...
 
#define ZB_ZCL_GROUPS_GET_VIEW_GROUP_RES(data_buf, view_group_res)
 Parses View group response command and returns response data structure or NULL if request contains invalid data. More...
 
#define ZB_ZCL_GROUPS_SEND_VIEW_GROUP_REQ( buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb, group_id)
 Send view group command. More...
 
#define ZB_ZCL_GROUPS_GET_GROUP_MEMBERSHIP_REQ(data_buf, group_member_req)
 Parses Get Group Membership command and returns pointer to data request structure. If request contains invalid data, NULL is returned. More...
 
#define ZB_ZCL_GROUPS_GET_GROUP_MEMBERSHIP_RES(data_buf, group_member_res)
 Parses Get Group Membership command response and returns pointer to data response structure. If response contains invalid data, NULL is returned. More...
 
#define ZB_ZCL_GROUPS_INIT_GET_GROUP_MEMBERSHIP_REQ(buffer, ptr, def_resp, group_cnt)
 Initialize Get group membership command. More...
 
#define ZB_ZCL_GROUPS_ADD_ID_GET_GROUP_MEMBERSHIP_REQ(ptr, group_id)
 Add group id to command payload. More...
 
#define ZB_ZCL_GROUPS_SEND_GET_GROUP_MEMBERSHIP_REQ( buffer, ptr, addr, dst_addr_mode, dst_ep, ep, prfl_id, cb)
 Sends Get group membership command. More...
 
#define ZB_ZCL_GROUPS_GET_REMOVE_GROUP_REQ(data_buf, rem_group_req)
 Parses Remove group command and fills in data request structure. If request contains invalid data, ZB_ZCL_NULL_ID is stored as group_id. More...
 
#define ZB_ZCL_GROUPS_GET_REMOVE_GROUP_RES(data_buf, rem_group_res)
 Parses Remove group response command and returns response data structure or NULL if request contains invalid data. More...
 
#define ZB_ZCL_GROUPS_SEND_REMOVE_GROUP_REQ( buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb, group_id)
 Send Remove group command. More...
 
#define ZB_ZCL_GROUPS_SEND_REMOVE_ALL_GROUPS_REQ( buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb)
 Send Remove all groups command. More...
 
#define ZB_ZCL_GROUPS_SEND_ADD_GROUP_IF_IDENT_REQ( buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb, group_id)
 Send Add group if identifying command. More...
 
#define ZB_ZCL_CLUSTER_ID_GROUPS_SERVER_ROLE_INIT   zb_zcl_groups_init_server
 
#define ZB_ZCL_CLUSTER_ID_GROUPS_CLIENT_ROLE_INIT   zb_zcl_groups_init_client
 

Typedefs

typedef struct zb_zcl_groups_add_group_req_s zb_zcl_groups_add_group_req_t
 Add group command structure. More...
 
typedef struct zb_zcl_groups_add_group_res_s zb_zcl_groups_add_group_res_t
 Add group response command structure. More...
 
typedef struct zb_zcl_groups_view_group_req_s zb_zcl_groups_view_group_req_t
 View group command structure. More...
 
typedef struct zb_zcl_groups_view_group_res_s zb_zcl_groups_view_group_res_t
 View group command response structure. More...
 
typedef struct zb_zcl_groups_get_group_membership_req_s zb_zcl_groups_get_group_membership_req_t
 Get Group Membership command structure. More...
 
typedef struct zb_zcl_groups_get_group_membership_res_s zb_zcl_groups_get_group_membership_res_t
 Get Group Membership command response structure. More...
 
typedef struct zb_zcl_groups_remove_group_req_s zb_zcl_groups_remove_group_req_t
 Remove Group command structure. More...
 
typedef struct zb_zcl_groups_remove_group_res_s zb_zcl_groups_remove_group_res_t
 Remove group response command structure. More...
 

Enumerations

Groups cluster command identifiers
enum  zb_zcl_groups_cmd_e {
  ZB_ZCL_CMD_GROUPS_ADD_GROUP = 0x00, ZB_ZCL_CMD_GROUPS_VIEW_GROUP = 0x01, ZB_ZCL_CMD_GROUPS_GET_GROUP_MEMBERSHIP = 0x02, ZB_ZCL_CMD_GROUPS_REMOVE_GROUP = 0x03,
  ZB_ZCL_CMD_GROUPS_REMOVE_ALL_GROUPS = 0x04, ZB_ZCL_CMD_GROUPS_ADD_GROUP_IF_IDENTIFYING = 0x05
}
 Groups cluster command identifiers. More...
 
enum  zb_zcl_groups_cmd_resp_e { ZB_ZCL_CMD_GROUPS_ADD_GROUP_RES = 0x00, ZB_ZCL_CMD_GROUPS_VIEW_GROUP_RES = 0x01, ZB_ZCL_CMD_GROUPS_GET_GROUP_MEMBERSHIP_RES = 0x02, ZB_ZCL_CMD_GROUPS_REMOVE_GROUP_RES = 0x03 }
 Groups cluster response command identifiers. More...
 

Functions

zb_bool_t zb_zcl_process_groups_commands_srv (zb_uint8_t param)
 
zb_bool_t zb_zcl_process_groups_commands_cli (zb_uint8_t param)
 
void zb_zcl_groups_init_server (void)
 
void zb_zcl_groups_init_client (void)
 

Groups cluster attributes

#define ZB_ZCL_GROUPS_CLUSTER_REVISION_DEFAULT   ((zb_uint16_t)0x0003u)
 Default value for Groups cluster revision global attribute. More...
 
#define ZB_ZCL_DECLARE_GROUPS_ATTRIB_LIST(attr_list, name_support)
 Declare attribute list for Groups cluster. More...
 
enum  zb_zcl_groups_attr_e { ZB_ZCL_ATTR_GROUPS_NAME_SUPPORT_ID = 0 }
 Groups cluster attribute identifiers. More...
 
enum  zb_zcl_groups_name_support_e { ZB_ZCL_ATTR_GROUPS_NAME_NOT_SUPPORTED = 0, ZB_ZCL_ATTR_GROUPS_NAME_SUPPORTED = 1 << 7 }
 Values for NameSupport attribute. More...
 

Macro Definition Documentation

§ ZB_ZCL_CLUSTER_ID_GROUPS_CLIENT_ROLE_INIT

#define ZB_ZCL_CLUSTER_ID_GROUPS_CLIENT_ROLE_INIT   zb_zcl_groups_init_client

§ ZB_ZCL_CLUSTER_ID_GROUPS_SERVER_ROLE_INIT

#define ZB_ZCL_CLUSTER_ID_GROUPS_SERVER_ROLE_INIT   zb_zcl_groups_init_server

Function Documentation

§ zb_zcl_groups_init_client()

void zb_zcl_groups_init_client ( void  )

§ zb_zcl_groups_init_server()

void zb_zcl_groups_init_server ( void  )