Groups client Callbacks

Collaboration diagram for Groups client Callbacks:

Functions
void	tr_groups_client_init_cb (zb_uint8_t endpoint)
	Callback fires when the Groups client cluster plugin is initialized.
zb_bool_t	tr_groups_client_command_received_cb (zb_zcl_parsed_hdr_t *cmd_info)
	Callback that user can declare to handle any Groups client commands.
void	tr_groups_client_write_attr_cb (zb_uint8_t endpoint, zb_uint16_t attr_id, zb_uint8_t *new_value, zb_uint16_t manuf_code)
	Callback fires when an Groups client attribute is about to be written.
zb_bool_t	tr_groups_client_add_group_response_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t status, zb_uint16_t group_id)
	Callback that user can declare to handle groups cluster add group response command.
zb_bool_t	tr_groups_client_view_group_response_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t status, zb_uint16_t group_id, zb_uint8_t *group_name)
	Callback that user can declare to handle groups cluster view group response command.
zb_bool_t	tr_groups_client_get_group_membership_response_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t capacity, zb_uint8_t group_count, zb_uint8_t *group_list)
	Callback that user can declare to handle groups cluster get group membership response command.
zb_bool_t	tr_groups_client_remove_group_response_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t status, zb_uint16_t group_id)
	Callback that user can declare to handle groups cluster remove group response command.

Detailed Description

---

---

Function Documentation

tr_groups_client_add_group_response_cb()

zb_bool_t tr_groups_client_add_group_response_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	status,
		zb_uint16_t	group_id )

Callback that user can declare to handle groups cluster add group response command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
status	status of the received Add Group command
group_id	the Group ID field of the received Add Group command

Returns

ZB_FALSE to allow framework to continue processing the command

tr_groups_client_command_received_cb()

zb_bool_t tr_groups_client_command_received_cb

(

zb_zcl_parsed_hdr_t *

cmd_info

)

Callback that user can declare to handle any Groups client commands.

Parameters

cmd_info

struct that contains zcl header info

Returns

ZB_FALSE to allow framework to continue processing the command

tr_groups_client_get_group_membership_response_cb()

zb_bool_t tr_groups_client_get_group_membership_response_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	capacity,
		zb_uint8_t	group_count,
		zb_uint8_t *	group_list )

Callback that user can declare to handle groups cluster get group membership response command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
capacity	contains the remaining capacity of the group table of the device
group_count	contains the number of groups contained in the group list field
group_list	list of Group IDs that satisfy the Get Group Membership command

Returns

ZB_FALSE to allow framework to continue processing the command

tr_groups_client_init_cb()

void tr_groups_client_init_cb

(

zb_uint8_t

endpoint

)

Callback fires when the Groups client cluster plugin is initialized.

Parameters

endpoint

device endpoint being initialized

tr_groups_client_remove_group_response_cb()

zb_bool_t tr_groups_client_remove_group_response_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	status,
		zb_uint16_t	group_id )

Callback that user can declare to handle groups cluster remove group response command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
status	status of the received Remove Group command
group_id	set to the Group ID field of the received Remove Group command

Returns

ZB_FALSE to allow framework to continue processing the command

tr_groups_client_view_group_response_cb()

zb_bool_t tr_groups_client_view_group_response_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	status,
		zb_uint16_t	group_id,
		zb_uint8_t *	group_name )

Callback that user can declare to handle groups cluster view group response command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
status	status of the received View Group command
group_id	the Group ID field of the received View Group command.
group_name	If the status is SUCCESS, the Group Name field is set; otherwise it is set to the empty string

Returns

ZB_FALSE to allow framework to continue processing the command

tr_groups_client_write_attr_cb()

void tr_groups_client_write_attr_cb	(	zb_uint8_t	endpoint,
		zb_uint16_t	attr_id,
		zb_uint8_t *	new_value,
		zb_uint16_t	manuf_code )

Callback fires when an Groups client attribute is about to be written.

Parameters

endpoint	device endpoint
attr_id	ZCL attribute id
new_value	pointer to the new attribute value
manuf_code	manufacturer specific code