Scenes server Callbacks

Collaboration diagram for Scenes server Callbacks:

Functions
void	tr_scenes_server_init_cb (zb_uint8_t endpoint)
	Callback fires when the Scenes server cluster plugin is initialized.
zb_bool_t	tr_scenes_server_command_received_cb (zb_zcl_parsed_hdr_t *cmd_info)
	Callback that user can declare to handle any Scenes server commands.
void	tr_scenes_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 Scenes server attribute is about to be written.
zb_bool_t	tr_scenes_server_add_scene_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint16_t group_id, zb_uint8_t scene_id, zb_uint16_t transition_time, zb_uint8_t *scene_name, zb_uint8_t *extension_field_sets, zb_uint8_t extensions_len)
	Callback that user can declare to handle scenes cluster add scene command.
zb_bool_t	tr_scenes_server_view_scene_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint16_t group_id, zb_uint8_t scene_id)
	Callback that user can declare to handle scenes cluster view scene command.
zb_bool_t	tr_scenes_server_remove_scene_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint16_t group_id, zb_uint8_t scene_id)
	Callback that user can declare to handle scenes cluster remove scene command.
zb_bool_t	tr_scenes_server_remove_all_scenes_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint16_t group_id)
	Callback that user can declare to handle scenes cluster remove all scenes command.
zb_bool_t	tr_scenes_server_store_scene_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint16_t group_id, zb_uint8_t scene_id)
	Callback that user can declare to handle scenes cluster store scene command.
zb_bool_t	tr_scenes_server_recall_scene_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint16_t group_id, zb_uint8_t scene_id, zb_uint16_t transition_time)
	Callback that user can declare to handle scenes cluster recall scene command.
zb_bool_t	tr_scenes_server_get_scene_membership_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint16_t group_id)
	Callback that user can declare to handle scenes cluster get scene membership command.
zb_bool_t	tr_scenes_server_enhanced_add_scene_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint16_t group_id, zb_uint8_t scene_id, zb_uint16_t transition_time, zb_uint8_t *scene_name, zb_uint8_t *extension_field_sets, zb_uint8_t extensions_len)
	Callback that user can declare to handle scenes cluster enhanced add scene command.
zb_bool_t	tr_scenes_server_enhanced_view_scene_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint16_t group_id, zb_uint8_t scene_id)
	Callback that user can declare to handle scenes cluster enhanced view scene command.
zb_bool_t	tr_scenes_server_copy_scene_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t mode, zb_uint16_t group_id_from, zb_uint8_t scene_id_from, zb_uint16_t group_id_to, zb_uint8_t scene_id_to)
	Callback that user can declare to handle scenes cluster copy scene command.
zb_bool_t	tr_scenes_server_scene_is_activated_cb (zb_uint8_t endpoint, tr_scenes_table_entry_t *scene_entry)
	Callback that fires when a scene is activated.
void	tr_scenes_server_message_sent_cb (zb_bufid_t param)
	Callback fires when scenes plugin response has a message sent status. This status is based on the APS ack. The status can be pulled from the param buffer using: "zb_zcl_command_send_status_t *cmd_send_status = ZB_BUF_GET_PARAM(param, zb_zcl_command_send_status_t);", and then checking: "cmd_send_status->status", if this equals 0 then the APS ack was received, if non-zero then the APS Ack was not received.

Detailed Description

---

---

Function Documentation

tr_scenes_server_add_scene_cb()

zb_bool_t tr_scenes_server_add_scene_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint16_t	group_id,
		zb_uint8_t	scene_id,
		zb_uint16_t	transition_time,
		zb_uint8_t *	scene_name,
		zb_uint8_t *	extension_field_sets,
		zb_uint8_t	extensions_len )

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

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
group_id	group that scene affects
scene_id	allows this command to modify an existing scene by specifying that ID
transition_time	time for this scene to move from the old values to the new values in tenths of a second
scene_name	scene name with first byte being the length
extension_field_sets	scene extensions
extensions_len	the length of the scene extensions

Returns

ZB_FALSE to allow framework to continue processing the command

tr_scenes_server_command_received_cb()

zb_bool_t tr_scenes_server_command_received_cb

(

zb_zcl_parsed_hdr_t *

cmd_info

)

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

Parameters

cmd_info

struct that contains zcl header info

Returns

ZB_FALSE to allow framework to continue processing the command

tr_scenes_server_copy_scene_cb()

zb_bool_t tr_scenes_server_copy_scene_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	mode,
		zb_uint16_t	group_id_from,
		zb_uint8_t	scene_id_from,
		zb_uint16_t	group_id_to,
		zb_uint8_t	scene_id_to )

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

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
mode	a value of 1 means all scenes from group_id_from are copied to group_id_to
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
group_id_to	specifies the identifier of the group to which the scene is to be copied
scene_id_to	specifies the identifier of the scene to which the scene is to be copied

Returns

ZB_FALSE to allow framework to continue processing the command

tr_scenes_server_enhanced_add_scene_cb()

zb_bool_t tr_scenes_server_enhanced_add_scene_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint16_t	group_id,
		zb_uint8_t	scene_id,
		zb_uint16_t	transition_time,
		zb_uint8_t *	scene_name,
		zb_uint8_t *	extension_field_sets,
		zb_uint8_t	extensions_len )

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

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
group_id	group that scene affects
scene_id	allows this command to modify an existing scene by specifying that ID
transition_time	time for this scene to move from the old values to the new values in tenths of a second
scene_name	scene name with first byte being the length
extension_field_sets	scene extensions
extensions_len	the length of the scene extensions

Returns

ZB_FALSE to allow framework to continue processing the command

tr_scenes_server_enhanced_view_scene_cb()

zb_bool_t tr_scenes_server_enhanced_view_scene_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint16_t	group_id,
		zb_uint8_t	scene_id )

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

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
group_id	group for which scene to view
scene_id	which scene to view by specifying that ID

Returns

ZB_FALSE to allow framework to continue processing the command

tr_scenes_server_get_scene_membership_cb()

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

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

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
group_id	group to use for finding scene membership

Returns

ZB_FALSE to allow framework to continue processing the command

tr_scenes_server_init_cb()

void tr_scenes_server_init_cb

(

zb_uint8_t

endpoint

)

Callback fires when the Scenes server cluster plugin is initialized.

Parameters

endpoint

device endpoint being initialized

tr_scenes_server_message_sent_cb()

void tr_scenes_server_message_sent_cb

(

zb_bufid_t

param

)

Callback fires when scenes plugin response has a message sent status. This status is based on the APS ack. The status can be pulled from the param buffer using: "zb_zcl_command_send_status_t *cmd_send_status = ZB_BUF_GET_PARAM(param, zb_zcl_command_send_status_t);", and then checking: "cmd_send_status->status", if this equals 0 then the APS ack was received, if non-zero then the APS Ack was not received.

Parameters

param

buffer with information on the message sent. This buffer needs to be freed using "zb_buf_free(param);"

tr_scenes_server_recall_scene_cb()

zb_bool_t tr_scenes_server_recall_scene_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint16_t	group_id,
		zb_uint8_t	scene_id,
		zb_uint16_t	transition_time )

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

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
group_id	group for which scene to recall
scene_id	ID of scene to recall
transition_time	time for this scene to move from the old values to the new values in tenths of a second

Returns

ZB_FALSE to allow framework to continue processing the command

tr_scenes_server_remove_all_scenes_cb()

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

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

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
group_id	group for which to remove all scenes

Returns

ZB_FALSE to allow framework to continue processing the command

tr_scenes_server_remove_scene_cb()

zb_bool_t tr_scenes_server_remove_scene_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint16_t	group_id,
		zb_uint8_t	scene_id )

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

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
group_id	group for which scene to remove
scene_id	ID of scene to remove

Returns

ZB_FALSE to allow framework to continue processing the command

tr_scenes_server_scene_is_activated_cb()

zb_bool_t tr_scenes_server_scene_is_activated_cb	(	zb_uint8_t	endpoint,
		tr_scenes_table_entry_t *	scene_entry )

Callback that fires when a scene is activated.

Parameters

endpoint	endpoint for scene that is activated
scene_entry	contains the information about the active scene

Returns

ZB_FALSE to allow framework to continue processing the command

tr_scenes_server_store_scene_cb()

zb_bool_t tr_scenes_server_store_scene_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint16_t	group_id,
		zb_uint8_t	scene_id )

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

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
group_id	group for which scene to store
scene_id	ID of scene to store

Returns

ZB_FALSE to allow framework to continue processing the command

tr_scenes_server_view_scene_cb()

zb_bool_t tr_scenes_server_view_scene_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint16_t	group_id,
		zb_uint8_t	scene_id )

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

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
group_id	group for which scene to view
scene_id	which scene to view by specifying that ID

Returns

ZB_FALSE to allow framework to continue processing the command

tr_scenes_server_write_attr_cb()

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