Groups server Callbacks

Collaboration diagram for Groups server Callbacks:

Functions
void	tr_groups_server_init_cb (zb_uint8_t endpoint)
	Callback fires when the Groups server cluster plugin is initialized.
zb_bool_t	tr_groups_server_command_received_cb (zb_zcl_parsed_hdr_t *cmd_info)
	Callback that user can declare to handle any Groups server commands.
void	tr_groups_server_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 server attribute is about to be written.
zb_bool_t	tr_groups_server_add_group_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint16_t group_id, zb_uint8_t *group_name)
	Callback that user can declare to handle groups cluster add group command.
zb_bool_t	tr_groups_server_view_group_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint16_t group_id, zb_uint8_t *group_name)
	Callback that user can declare to handle groups cluster view group command.
zb_bool_t	tr_groups_server_get_group_membership_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t group_count, zb_uint16_t *group_list)
	Callback that user can declare to handle groups cluster get group membership command.
zb_bool_t	tr_groups_server_remove_group_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint16_t group_id)
	Callback that user can declare to handle groups cluster remove group command.
zb_bool_t	tr_groups_server_remove_all_groups_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint)
	Callback that user can declare to handle groups cluster remove all groups command.
zb_bool_t	tr_groups_server_add_group_if_identifying_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint16_t group_id, zb_uint8_t *group_name)
	Callback that user can declare to handle groups cluster add group if identifying command.
void	tr_groups_server_resp_sent_cb (zb_bufid_t param)
	Callback fires when groups server response completes.

Detailed Description

---

---

Function Documentation

tr_groups_server_add_group_cb()

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

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

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
group_id	group id being added
group_name	optional group name being added

Returns

ZB_FALSE to allow framework to continue processing the command

tr_groups_server_add_group_if_identifying_cb()

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

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

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
group_id	group id being added
group_name	optional group name being added

Returns

ZB_FALSE to allow framework to continue processing the command

tr_groups_server_command_received_cb()

zb_bool_t tr_groups_server_command_received_cb

(

zb_zcl_parsed_hdr_t *

cmd_info

)

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

Parameters

cmd_info

struct that contains zcl header info

Returns

ZB_FALSE to allow framework to continue processing the command

tr_groups_server_get_group_membership_cb()

zb_bool_t tr_groups_server_get_group_membership_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	group_count,
		zb_uint16_t *	group_list )

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

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
group_count	number of groups being checked
group_list	list of group ids being checked

Returns

ZB_FALSE to allow framework to continue processing the command

tr_groups_server_init_cb()

void tr_groups_server_init_cb

(

zb_uint8_t

endpoint

)

Callback fires when the Groups server cluster plugin is initialized.

Parameters

endpoint

device endpoint being initialized

tr_groups_server_remove_all_groups_cb()

zb_bool_t tr_groups_server_remove_all_groups_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint )

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

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint

Returns

ZB_FALSE to allow framework to continue processing the command

tr_groups_server_remove_group_cb()

zb_bool_t tr_groups_server_remove_group_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint16_t	group_id )

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

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
group_id	group id to be removed

Returns

ZB_FALSE to allow framework to continue processing the command

tr_groups_server_resp_sent_cb()

void tr_groups_server_resp_sent_cb

(

zb_bufid_t

param

)

Callback fires when groups server response completes.

This callback is triggered when the groups server response either receives an APS Ack or times out. To check the status:

zb_zcl_command_send_status_t *cmd_send_status = ZB_BUF_GET_PARAM(param, zb_zcl_command_send_status_t);
if (cmd_send_status->status == 0)
{
    // APS ACK received
}
else
{
    // APS ACK not received
}

Parameters

param

buffer with information on the response sent. This buffer must be freed using zb_buf_free().

tr_groups_server_view_group_cb()

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

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

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
group_id	group id being viewed
group_name	optional group name a user can fill in

Returns

ZB_FALSE to allow framework to continue processing the command

tr_groups_server_write_attr_cb()

void tr_groups_server_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 server 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