Level Control server Callbacks

Collaboration diagram for Level Control server Callbacks:

Functions
void	tr_level_control_server_init_cb (zb_uint8_t endpoint)
	Callback fires when the Level Control server cluster plugin is initialized.
zb_bool_t	tr_level_control_server_command_received_cb (zb_zcl_parsed_hdr_t *cmd_info)
	Callback that user can declare to handle any Level Control server commands.
void	tr_level_control_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 Level Control server attribute is about to be written.
zb_bool_t	tr_level_control_server_move_to_level_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t level, zb_uint16_t transition_time, zb_uint8_t option_mask, zb_uint8_t option_override)
	Callback that user can declare to handle level control cluster move to level command.
zb_bool_t	tr_level_control_server_move_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t move_mode, zb_uint8_t rate, zb_uint8_t option_mask, zb_uint8_t option_override)
	Callback that user can declare to handle level control cluster move command.
zb_bool_t	tr_level_control_server_step_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t step_mode, zb_uint8_t step_size, zb_uint16_t transition_time, zb_uint8_t option_mask, zb_uint8_t option_override)
	Callback that user can declare to handle level control cluster step command.
zb_bool_t	tr_level_control_server_stop_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t option_mask, zb_uint8_t option_override)
	Callback that user can declare to handle level control cluster stop command.
zb_bool_t	tr_level_control_server_move_to_level_with_on_off_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t level, zb_uint16_t transition_time, zb_uint8_t option_mask, zb_uint8_t option_override)
	Callback that user can declare to handle level control cluster move to level with on off command.
zb_bool_t	tr_level_control_server_move_with_on_off_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t move_mode, zb_uint8_t rate, zb_uint8_t option_mask, zb_uint8_t option_override)
	Callback that user can declare to handle level control cluster move with on off command.
zb_bool_t	tr_level_control_server_step_with_on_off_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t step_mode, zb_uint8_t step_size, zb_uint16_t transition_time, zb_uint8_t option_mask, zb_uint8_t option_override)
	Callback that user can declare to handle level control cluster step with on off command.
zb_bool_t	tr_level_control_server_stop_with_on_off_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t option_mask, zb_uint8_t option_override)
	Callback that user can declare to handle level control cluster stop with on off command.
void	tr_level_control_server_level_changed_cb (zb_uint8_t endpoint, zb_uint8_t new_level)
	Callback fires when current level changes.

Detailed Description

---

---

Function Documentation

tr_level_control_server_command_received_cb()

zb_bool_t tr_level_control_server_command_received_cb

(

zb_zcl_parsed_hdr_t *

cmd_info

)

Callback that user can declare to handle any Level Control server commands.

Parameters

cmd_info

struct that contains zcl header info

Returns

ZB_FALSE to allow framework to continue processing the command

tr_level_control_server_init_cb()

void tr_level_control_server_init_cb

(

zb_uint8_t

endpoint

)

Callback fires when the Level Control server cluster plugin is initialized.

Parameters

endpoint

device endpoint being initialized

tr_level_control_server_level_changed_cb()

void tr_level_control_server_level_changed_cb	(	zb_uint8_t	endpoint,
		zb_uint8_t	new_level )

Callback fires when current level changes.

tr_level_control_server_move_cb()

zb_bool_t tr_level_control_server_move_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	move_mode,
		zb_uint8_t	rate,
		zb_uint8_t	option_mask,
		zb_uint8_t	option_override )

Callback that user can declare to handle level control cluster move command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
move_mode	specifies to move up or down
rate	specifies rate in units per second
option_mask	determines which bits in options_override (next arg) are used
option_override	this can override the options attribute behavior

Returns

ZB_FALSE to allow framework to continue processing the command

tr_level_control_server_move_to_level_cb()

zb_bool_t tr_level_control_server_move_to_level_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	level,
		zb_uint16_t	transition_time,
		zb_uint8_t	option_mask,
		zb_uint8_t	option_override )

Callback that user can declare to handle level control cluster move to level command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
level	new level that should be moved to
transition_time	time to move to the new level in tenths of a second
option_mask	determines which bits in options_override (next arg) are used
option_override	this can override the options attribute behavior

Returns

ZB_FALSE to allow framework to continue processing the command

tr_level_control_server_move_to_level_with_on_off_cb()

zb_bool_t tr_level_control_server_move_to_level_with_on_off_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	level,
		zb_uint16_t	transition_time,
		zb_uint8_t	option_mask,
		zb_uint8_t	option_override )

Callback that user can declare to handle level control cluster move to level with on off command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
level	new level that should be moved to
transition_time	time to move to the new level in tenths of a second
option_mask	determines which bits in options_override (next arg) are used
option_override	this can override the options attribute behavior

Returns

ZB_FALSE to allow framework to continue processing the command

tr_level_control_server_move_with_on_off_cb()

zb_bool_t tr_level_control_server_move_with_on_off_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	move_mode,
		zb_uint8_t	rate,
		zb_uint8_t	option_mask,
		zb_uint8_t	option_override )

Callback that user can declare to handle level control cluster move with on off command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
move_mode	specifies to move up or down
rate	specifies rate in units per second
option_mask	determines which bits in options_override (next arg) are used
option_override	this can override the options attribute behavior

Returns

ZB_FALSE to allow framework to continue processing the command

tr_level_control_server_step_cb()

zb_bool_t tr_level_control_server_step_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	step_mode,
		zb_uint8_t	step_size,
		zb_uint16_t	transition_time,
		zb_uint8_t	option_mask,
		zb_uint8_t	option_override )

Callback that user can declare to handle level control cluster step command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
step_mode	specifies to move up or down
step_size	specifies amount to change up or down in units
transition_time	time to move to the new level in tenths of a second
option_mask	determines which bits in options_override (next arg) are used
option_override	this can override the options attribute behavior

Returns

ZB_FALSE to allow framework to continue processing the command

tr_level_control_server_step_with_on_off_cb()

zb_bool_t tr_level_control_server_step_with_on_off_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	step_mode,
		zb_uint8_t	step_size,
		zb_uint16_t	transition_time,
		zb_uint8_t	option_mask,
		zb_uint8_t	option_override )

Callback that user can declare to handle level control cluster step with on off command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
step_mode	specifies to move up or down
step_size	specifies amount to change up or down in units
transition_time	time to move to the new level in tenths of a second
option_mask	determines which bits in options_override (next arg) are used
option_override	this can override the options attribute behavior

Returns

ZB_FALSE to allow framework to continue processing the command

tr_level_control_server_stop_cb()

zb_bool_t tr_level_control_server_stop_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	option_mask,
		zb_uint8_t	option_override )

Callback that user can declare to handle level control cluster stop command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
option_mask	determines which bits in options_override (next arg) are used
option_override	this can override the options attribute behavior

Returns

ZB_FALSE to allow framework to continue processing the command

tr_level_control_server_stop_with_on_off_cb()

zb_bool_t tr_level_control_server_stop_with_on_off_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	option_mask,
		zb_uint8_t	option_override )

Callback that user can declare to handle level control cluster stop with on off command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	endpoint that received the command
option_mask	determines which bits in options_override (next arg) are used
option_override	this can override the options attribute behavior

Returns

ZB_FALSE to allow framework to continue processing the command

tr_level_control_server_write_attr_cb()

void tr_level_control_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 Level Control 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