Data Structures
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_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...

Typedefs
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...

Detailed Description

Remove Group request and response commands have simple payload. Actual request handling takes place in ZCL internals.

Examples: Remove Group request sending:

Macro Definition Documentation

§ ZB_ZCL_GROUPS_GET_REMOVE_GROUP_REQ

#define ZB_ZCL_GROUPS_GET_REMOVE_GROUP_REQ	(	data_buf,
		rem_group_req
	)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_groups.h>

Value:

{                                                                              \
  zb_zcl_groups_remove_group_req_t *rem_group_req_ptr;                         \
  (rem_group_req_ptr) = zb_buf_len(data_buf) >= ZB_ZCL_REMOVE_GROUP_REQ_SIZE ? \
    (zb_zcl_groups_remove_group_req_t*)zb_buf_begin(data_buf) : NULL;          \
                                                                               \
  if (rem_group_req_ptr)                                                       \
  {                                                                            \
    ZB_HTOLE16(&(rem_group_req).group_id, &rem_group_req_ptr->group_id);       \
  }                                                                            \
  else                                                                         \
  {                                                                            \
    rem_group_req.group_id = ZB_ZCL_NULL_ID;                                   \
  }                                                                            \
}

Parses Remove group command and fills in data request structure. If request contains invalid data, ZB_ZCL_NULL_ID is stored as group_id.

Parameters

data_buf	- pointer to zb_buf_t buffer containing command request data
rem_group_req	- variable to save command request

Note: data_buf buffer should contain command request payload without ZCL header.

§ ZB_ZCL_GROUPS_GET_REMOVE_GROUP_RES

#define ZB_ZCL_GROUPS_GET_REMOVE_GROUP_RES	(	data_buf,
		rem_group_res
	)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_groups.h>

Value:

{                                                                           \
  (rem_group_res) = zb_buf_len(data_buf) >= ZB_ZCL_REMOVE_GROUP_RES_SIZE ?  \
    (zb_zcl_groups_remove_group_res_t*)zb_buf_begin(data_buf) : NULL;       \
                                                                            \
  if (rem_group_res)                                                        \
  {                                                                         \
    ZB_ZCL_HTOLE16_INPLACE(&(rem_group_res)->group_id);                     \
  }                                                                         \
}

Parses Remove group response command and returns response data structure or NULL if request contains invalid data.

Parameters

data_buf	- pointer to zb_buf_t buffer containing command response data
rem_group_res	- out pointer to zb_zcl_groups_remove_group_res_t, containing command response record

Note: data_buf buffer should contain response command payload without ZCL header

§ ZB_ZCL_GROUPS_SEND_REMOVE_GROUP_REQ

#define ZB_ZCL_GROUPS_SEND_REMOVE_GROUP_REQ	(	buffer,
		addr,
		dst_addr_mode,
		dst_ep,
		ep,
		prfl_id,
		def_resp,
		cb,
		group_id
	)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_groups.h>

Value:

{                                                                                             \
  zb_uint8_t* ptr = ZB_ZCL_START_PACKET_REQ(buffer)                                              \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL(ptr, def_resp)                         \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER_REQ(ptr, ZB_ZCL_GET_SEQ_NUM(), ZB_ZCL_CMD_GROUPS_REMOVE_GROUP); \
  ZB_ZCL_PACKET_PUT_DATA16_VAL(ptr, (group_id));                                              \
  ZB_ZCL_FINISH_PACKET(buffer, ptr)                                                          \
  ZB_ZCL_SEND_COMMAND_SHORT(                                                                  \
      buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, ZB_ZCL_CLUSTER_ID_GROUPS, cb);        \
}

Send Remove group command.

Parameters

buffer	to put packet to
addr	- address to send packet to
dst_addr_mode	- addressing mode
dst_ep	- destination endpoint
ep	- sending endpoint
prfl_id	- profile identifier
def_resp	- enable/disable default response
cb	- callback for getting command send status
group_id	- group ID to remove