Color Control server Callbacks

Collaboration diagram for Color Control server Callbacks:

Functions
void	tr_color_control_server_init_cb (zb_uint8_t endpoint)
	Callback fires when the Color Control server cluster plugin is initialized.
zb_bool_t	tr_color_control_server_command_received_cb (zb_zcl_parsed_hdr_t *cmd_info)
	Callback that user can declare to handle any Color Control server commands.
void	tr_color_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 Color Control server attribute is about to be written.
zb_bool_t	tr_color_control_server_move_to_color_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint16_t color_x, zb_uint16_t color_y, zb_uint16_t transition_time, zb_uint8_t options_mask, zb_uint8_t options_override)
	Callback that user can declare to handle color control cluster move to color command.
zb_bool_t	tr_color_control_server_move_color_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_int16_t rate_x, zb_int16_t rate_y, zb_uint8_t options_mask, zb_uint8_t options_override)
	Callback that user can declare to handle color control cluster move color command.
zb_bool_t	tr_color_control_server_step_color_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_int16_t step_x, zb_int16_t step_y, zb_uint16_t transition_time, zb_uint8_t options_mask, zb_uint8_t options_override)
	Callback that user can declare to handle color control cluster step color command.
zb_bool_t	tr_color_control_server_move_to_color_temperature_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint16_t color_temperature, zb_uint16_t transition_time, zb_uint8_t options_mask, zb_uint8_t options_override)
	Callback that user can declare to handle color control cluster move to color temperature command.
zb_bool_t	tr_color_control_server_stop_move_step_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t options_mask, zb_uint8_t options_override)
	Callback that user can declare to handle color control cluster stop move step command.
zb_bool_t	tr_color_control_server_move_color_temperature_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t move_mode, zb_uint16_t rate, zb_uint16_t color_temperature_minimum, zb_uint16_t color_temperature_maximum, zb_uint8_t options_mask, zb_uint8_t options_override)
	Callback that user can declare to handle color control cluster move color temperature command.
zb_bool_t	tr_color_control_server_step_color_temperature_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t step_mode, zb_uint16_t step_size, zb_uint16_t transition_time, zb_uint16_t color_temperature_minimum, zb_uint16_t color_temperature_maximum, zb_uint8_t options_mask, zb_uint8_t options_override)
	Callback that user can declare to handle color control cluster step color temperature command.

Detailed Description

---

---

Function Documentation

tr_color_control_server_command_received_cb()

zb_bool_t tr_color_control_server_command_received_cb

(

zb_zcl_parsed_hdr_t *

cmd_info

)

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

Parameters

cmd_info

struct that contains zcl header info

Returns

ZB_FALSE to allow framework to continue processing the command

tr_color_control_server_init_cb()

void tr_color_control_server_init_cb

(

zb_uint8_t

endpoint

)

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

Parameters

endpoint

device endpoint being initialized

tr_color_control_server_move_color_cb()

zb_bool_t tr_color_control_server_move_color_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_int16_t	rate_x,
		zb_int16_t	rate_y,
		zb_uint8_t	options_mask,
		zb_uint8_t	options_override )

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

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
rate_x	specifies the rate of movement in steps per second. A step is a change in the device’s CurrentX attribute of one unit
rate_y	specifies the rate of movement in steps per second. A step is a change in the device’s CurrentY attribute of one unit
options_mask	determines which bits in options_override (next arg) are used
options_override	this can override the options attribute behavior

Returns

ZB_FALSE to allow framework to continue processing the command

tr_color_control_server_move_color_temperature_cb()

zb_bool_t tr_color_control_server_move_color_temperature_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	move_mode,
		zb_uint16_t	rate,
		zb_uint16_t	color_temperature_minimum,
		zb_uint16_t	color_temperature_maximum,
		zb_uint8_t	options_mask,
		zb_uint8_t	options_override )

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

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
move_mode	specifies to move up or down
rate	specifies rate in units per second
color_temperature_minimum	specifies a lower bound on the ColorTemperatureMireds attribute
color_temperature_maximum	specifies an upper bound on the ColorTemperatureMireds attribute
options_mask	determines which bits in options_override (next arg) are used
options_override	this can override the options attribute behavior

Returns

ZB_FALSE to allow framework to continue processing the command

tr_color_control_server_move_to_color_cb()

zb_bool_t tr_color_control_server_move_to_color_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint16_t	color_x,
		zb_uint16_t	color_y,
		zb_uint16_t	transition_time,
		zb_uint8_t	options_mask,
		zb_uint8_t	options_override )

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

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
color_x	new color to move to
color_y	new color to move to
transition_time	time to move to the new color in tenths of a second
options_mask	determines which bits in options_override (next arg) are used
options_override	this can override the options attribute behavior

Returns

ZB_FALSE to allow framework to continue processing the command

tr_color_control_server_move_to_color_temperature_cb()

zb_bool_t tr_color_control_server_move_to_color_temperature_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint16_t	color_temperature,
		zb_uint16_t	transition_time,
		zb_uint8_t	options_mask,
		zb_uint8_t	options_override )

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

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
color_temperature	new color temperature to move to, in mirads
transition_time	time to move to the new color in tenths of a second
options_mask	determines which bits in options_override (next arg) are used
options_override	this can override the options attribute behavior

Returns

ZB_FALSE to allow framework to continue processing the command

tr_color_control_server_step_color_cb()

zb_bool_t tr_color_control_server_step_color_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_int16_t	step_x,
		zb_int16_t	step_y,
		zb_uint16_t	transition_time,
		zb_uint8_t	options_mask,
		zb_uint8_t	options_override )

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

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
step_x	specifies the change to be added to the device's CurrentX attribute
step_y	specifies the change to be added to the device's CurrentY attribute
transition_time	time to move to the new color in tenths of a second
options_mask	determines which bits in options_override (next arg) are used
options_override	this can override the options attribute behavior

Returns

ZB_FALSE to allow framework to continue processing the command

tr_color_control_server_step_color_temperature_cb()

zb_bool_t tr_color_control_server_step_color_temperature_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	step_mode,
		zb_uint16_t	step_size,
		zb_uint16_t	transition_time,
		zb_uint16_t	color_temperature_minimum,
		zb_uint16_t	color_temperature_maximum,
		zb_uint8_t	options_mask,
		zb_uint8_t	options_override )

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

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
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 color temperature in tenths of a second
color_temperature_minimum	specifies a lower bound on the ColorTemperatureMireds attribute
color_temperature_maximum	specifies an upper bound on the ColorTemperatureMireds attribute
options_mask	determines which bits in options_override (next arg) are used
options_override	this can override the options attribute behavior

Returns

ZB_FALSE to allow framework to continue processing the command

tr_color_control_server_stop_move_step_cb()

zb_bool_t tr_color_control_server_stop_move_step_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	options_mask,
		zb_uint8_t	options_override )

Callback that user can declare to handle color control cluster stop move step command.

Parameters

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

Returns

ZB_FALSE to allow framework to continue processing the command

tr_color_control_server_write_attr_cb()

void tr_color_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 Color 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