On/off server Callbacks

Collaboration diagram for On/off server Callbacks:

Functions
void	tr_on_off_server_init_cb (zb_uint8_t endpoint)
	Callback fires when the On/off server cluster plugin is initialized.
zb_bool_t	tr_on_off_server_command_received_cb (zb_zcl_parsed_hdr_t *cmd_info)
	Callback that user can declare to handle any On/off server commands.
void	tr_on_off_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 On/off server attribute is about to be written.
zb_bool_t	tr_on_off_server_off_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint)
	Callback that user can declare to handle on/off cluster off command.
zb_bool_t	tr_on_off_server_on_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint)
	Callback that user can declare to handle on/off cluster on command.
zb_bool_t	tr_on_off_server_toggle_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t current_on_off_state)
	Callback that user can declare to handle on/off cluster toggle command.
zb_bool_t	tr_on_off_server_off_with_effect_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t effect_id, zb_uint8_t effect_variant)
	Callback that user can declare to handle on/off cluster off with effect command.
zb_bool_t	tr_on_off_server_on_with_recall_global_scene_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint)
	Callback that user can declare to handle on/off cluster on with recall global scene command.
zb_bool_t	tr_on_off_server_on_with_timed_off_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t on_off_control, zb_uint16_t on_time, zb_uint16_t off_wait_time)
	Callback that user can declare to handle on/off cluster on with timed off command.

Detailed Description

---

---

Function Documentation

tr_on_off_server_command_received_cb()

zb_bool_t tr_on_off_server_command_received_cb

(

zb_zcl_parsed_hdr_t *

cmd_info

)

Callback that user can declare to handle any On/off server commands.

Parameters

cmd_info

struct that contains zcl header info

Returns

ZB_FALSE to allow framework to continue processing the command

tr_on_off_server_init_cb()

void tr_on_off_server_init_cb

(

zb_uint8_t

endpoint

)

Callback fires when the On/off server cluster plugin is initialized.

Parameters

endpoint

device endpoint being initialized

tr_on_off_server_off_cb()

zb_bool_t tr_on_off_server_off_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint )

Callback that user can declare to handle on/off cluster off 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_on_off_server_off_with_effect_cb()

zb_bool_t tr_on_off_server_off_with_effect_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	effect_id,
		zb_uint8_t	effect_variant )

Callback that user can declare to handle on/off cluster off with effect command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
effect_id	effect for the command
effect_variant	effect variant for the command

Returns

ZB_FALSE to allow framework to continue processing the command

tr_on_off_server_on_cb()

zb_bool_t tr_on_off_server_on_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint )

Callback that user can declare to handle on/off cluster on 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_on_off_server_on_with_recall_global_scene_cb()

zb_bool_t tr_on_off_server_on_with_recall_global_scene_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint )

Callback that user can declare to handle on/off cluster on with recall global scene command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint

tr_on_off_server_on_with_timed_off_cb()

zb_bool_t tr_on_off_server_on_with_timed_off_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	on_off_control,
		zb_uint16_t	on_time,
		zb_uint16_t	off_wait_time )

Callback that user can declare to handle on/off cluster on with timed off command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
on_off_control	on off control bitmask ("accept only when on" if bit 0 is set)
on_time	on time for the command
off_wait_time	off wait time for the command

Returns

ZB_FALSE to allow framework to continue processing the command

tr_on_off_server_toggle_cb()

zb_bool_t tr_on_off_server_toggle_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	current_on_off_state )

Callback that user can declare to handle on/off cluster toggle command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
current_on_off_state	current value, before the toggle, of the on_off attribute

Returns

ZB_FALSE to allow framework to continue processing the command

tr_on_off_server_write_attr_cb()

void tr_on_off_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 On/off 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