Scenes client Callbacks

Collaboration diagram for Scenes client Callbacks:

Functions
void	tr_scenes_client_init_cb (zb_uint8_t endpoint)
	Callback fires when the Scenes client cluster plugin is initialized.
zb_bool_t	tr_scenes_client_command_received_cb (zb_zcl_parsed_hdr_t *cmd_info)
	Callback that user can declare to handle any Scenes client commands.
void	tr_scenes_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 Scenes client attribute is about to be written.
zb_bool_t	tr_scenes_client_add_scene_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 scene_id)
	Callback that user can declare to handle scenes cluster add scene response command.
zb_bool_t	tr_scenes_client_view_scene_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 scene_id, zb_uint16_t transition_time, zb_uint8_t *scene_name, zb_uint8_t extensions_length, zb_uint8_t *extensions_ptr)
	Callback that user can declare to handle scenes cluster view scene response command.
zb_bool_t	tr_scenes_client_remove_scene_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 scene_id)
	Callback that user can declare to handle scenes cluster remove scene response command.
zb_bool_t	tr_scenes_client_remove_all_scenes_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 scenes cluster remove all scenes response command.
zb_bool_t	tr_scenes_client_store_scene_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 scene_id)
	Callback that user can declare to handle scenes cluster store scene response command.
zb_bool_t	tr_scenes_client_get_scene_membership_response_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t status, zb_uint8_t capacity, zb_uint16_t group_id, zb_uint8_t scene_count, zb_uint8_t *scene_list)
	Callback that user can declare to handle scenes cluster get scene membership response command.
zb_bool_t	tr_scenes_client_enhanced_add_scene_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 scene_id)
	Callback that user can declare to handle scenes cluster enhanced add scene response command.
zb_bool_t	tr_scenes_client_enhanced_view_scene_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 scene_id, zb_uint16_t transition_time, zb_uint8_t *scene_name, zb_uint8_t extensions_length, zb_uint8_t *extensions_ptr)
	Callback that user can declare to handle scenes cluster enhanced view scene response command.
zb_bool_t	tr_scenes_client_copy_scene_response_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t status, zb_uint16_t group_id_from, zb_uint8_t scene_id_from)
	Callback that user can declare to handle scenes cluster copy scene response command.

Detailed Description

---

---

Function Documentation

tr_scenes_client_add_scene_response_cb()

zb_bool_t tr_scenes_client_add_scene_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	scene_id )

Callback that user can declare to handle scenes cluster add scene response command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
status	did the add scene work or an error code
group_id	group ID for new scene
scene_id	scene ID for new scene

Returns

ZB_FALSE to allow framework to continue processing the command

tr_scenes_client_command_received_cb()

zb_bool_t tr_scenes_client_command_received_cb

(

zb_zcl_parsed_hdr_t *

cmd_info

)

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

Parameters

cmd_info

struct that contains zcl header info

Returns

ZB_FALSE to allow framework to continue processing the command

tr_scenes_client_copy_scene_response_cb()

zb_bool_t tr_scenes_client_copy_scene_response_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	status,
		zb_uint16_t	group_id_from,
		zb_uint8_t	scene_id_from )

Callback that user can declare to handle scenes cluster copy scene response command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
status	did the command work or an error code
group_id_from	specifies the identifier of the group from which the scene is to be copied
scene_id_from	specifies the identifier of the scene from which the scene is to be copied

Returns

ZB_FALSE to allow framework to continue processing the command

tr_scenes_client_enhanced_add_scene_response_cb()

zb_bool_t tr_scenes_client_enhanced_add_scene_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	scene_id )

Callback that user can declare to handle scenes cluster enhanced add scene response command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
status	did the add scene work or an error code
group_id	group ID for new scene
scene_id	scene ID for new scene

Returns

ZB_FALSE to allow framework to continue processing the command

tr_scenes_client_enhanced_view_scene_response_cb()

zb_bool_t tr_scenes_client_enhanced_view_scene_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	scene_id,
		zb_uint16_t	transition_time,
		zb_uint8_t *	scene_name,
		zb_uint8_t	extensions_length,
		zb_uint8_t *	extensions_ptr )

Callback that user can declare to handle scenes cluster enhanced view scene response command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
status	did the command work or an error code
group_id	group ID for the viewed scene
scene_id	scene ID for the viewed scene
transition_time	transition time for viewed scene
scene_name	scene name as a zigbee string with length in the first byte
extensions_length	length of the extensions that specify the scene
extensions_ptr	ptr to the values of the scene extensions, each extension is 2 byte cluster, 1 byte length, and N byte data

Returns

ZB_FALSE to allow framework to continue processing the command

tr_scenes_client_get_scene_membership_response_cb()

zb_bool_t tr_scenes_client_get_scene_membership_response_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	status,
		zb_uint8_t	capacity,
		zb_uint16_t	group_id,
		zb_uint8_t	scene_count,
		zb_uint8_t *	scene_list )

Callback that user can declare to handle scenes cluster get scene membership response command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
status	did the command work or an error code
capacity	the remaining capacity of the scene table
group_id	group ID for scene membership
scene_count	number of scene IDs returned as a member of
scene_list	list of 1 byte scene IDs that the target device is a member of

Returns

ZB_FALSE to allow framework to continue processing the command

tr_scenes_client_init_cb()

void tr_scenes_client_init_cb

(

zb_uint8_t

endpoint

)

Callback fires when the Scenes client cluster plugin is initialized.

Parameters

endpoint

device endpoint being initialized

tr_scenes_client_remove_all_scenes_response_cb()

zb_bool_t tr_scenes_client_remove_all_scenes_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 scenes cluster remove all scenes response command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
status	did the remove all scenes work or an error code
group_id	group ID for removed scenes

Returns

ZB_FALSE to allow framework to continue processing the command

tr_scenes_client_remove_scene_response_cb()

zb_bool_t tr_scenes_client_remove_scene_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	scene_id )

Callback that user can declare to handle scenes cluster remove scene response command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
status	did the remove scene work or an error code
group_id	group ID for removed scene
scene_id	scene ID for removed scene

Returns

ZB_FALSE to allow framework to continue processing the command

tr_scenes_client_store_scene_response_cb()

zb_bool_t tr_scenes_client_store_scene_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	scene_id )

Callback that user can declare to handle scenes cluster store scene response command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
status	did the store scene work or an error code
group_id	group ID for stored scene
scene_id	scene ID for stored scene

Returns

ZB_FALSE to allow framework to continue processing the command

tr_scenes_client_view_scene_response_cb()

zb_bool_t tr_scenes_client_view_scene_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	scene_id,
		zb_uint16_t	transition_time,
		zb_uint8_t *	scene_name,
		zb_uint8_t	extensions_length,
		zb_uint8_t *	extensions_ptr )

Callback that user can declare to handle scenes cluster view scene response command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
status	did the command work or an error code
group_id	group ID for the viewed scene
scene_id	scene ID for the viewed scene
transition_time	transition time for viewed scene
scene_name	scene name as a zigbee string with length in the first byte
extensions_length	length of the extensions that specify the scene
extensions_ptr	ptr to the values of the scene extensions, each extension is 2 byte cluster, 1 byte length, and N byte data

Returns

ZB_FALSE to allow framework to continue processing the command

tr_scenes_client_write_attr_cb()

void tr_scenes_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 Scenes 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