View group command definitions

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

Macros
#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...

Typedefs
typedef struct zb_zcl_groups_view_group_req_s	zb_zcl_groups_view_group_req_t
	View group command structure.
typedef struct zb_zcl_groups_view_group_res_s	zb_zcl_groups_view_group_res_t
	View group command response structure.

Detailed Description

View Group command and response have simple payload. View group command is being processed, and View Group response command originates from ZCL internals.

Examples

View Group request command can be formed as:

 ZB_ZCL_GROUPS_SEND_VIEW_GROUP_REQ(buffer, DST_ADDR, DST_ADDR_MODE, ENDPOINT_C, ENDPOINT_ED, ZB_AF_HA_PROFILE_ID, ZB_ZCL_ENABLE_DEFAULT_RESPONSE, NULL, TEST_GROUP_ID_1);

View Group response command can be parsed as:

 ZB_ZCL_GROUPS_GET_VIEW_GROUP_RES(buf, view_group_res);

Macro Definition Documentation

ZB_ZCL_GROUPS_GET_VIEW_GROUP_REQ

#define ZB_ZCL_GROUPS_GET_VIEW_GROUP_REQ	(		data_buf,
			view_group_req
	)

Value:

{ \
 zb_zcl_groups_view_group_req_t *view_group_req_ptr; \
 (view_group_req_ptr) = zb_buf_len(data_buf) >= ZB_ZCL_VIEW_GROUP_REQ_SIZE ? \
 (zb_zcl_groups_view_group_req_t*)zb_buf_begin(data_buf) : NULL; \
 \
 if (view_group_req_ptr) \
 { \
 ZB_HTOLE16(&(view_group_req).group_id, &view_group_req_ptr->group_id); \
 } \
 else \
 { \
 view_group_req.group_id = ZB_ZCL_NULL_ID; \
 } \
}

Parses View 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
view_group_req	- variable to save command request

Note

data_buf buffer should contain command request payload without ZCL header.

ZB_ZCL_GROUPS_GET_VIEW_GROUP_RES

#define ZB_ZCL_GROUPS_GET_VIEW_GROUP_RES	(		data_buf,
			view_group_res
	)

Value:

{ \
 (view_group_res) = zb_buf_len(data_buf) >= ZB_ZCL_VIEW_GROUP_RES_SIZE ? \
 (zb_zcl_groups_view_group_res_t*)zb_buf_begin(data_buf) : NULL; \
 \
 if (view_group_res) \
 { \
 ZB_ZCL_HTOLE16_INPLACE(&(view_group_res)->group_id); \
 /* group name currently is not supported - empty string is returned */ \
 } \
}

Parses View 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
view_group_res	- out pointer to zb_zcl_groups_add_group_res_t, containing command response record

Note

data_buf buffer should contain response command payload without ZCL header

ZB_ZCL_GROUPS_SEND_VIEW_GROUP_REQ

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

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_VIEW_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 view 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 add