Identify server Callbacks

Collaboration diagram for Identify server Callbacks:

Functions
void	tr_identify_server_init_cb (zb_uint8_t endpoint)
	Callback fires when the Identify server cluster plugin is initialized.
zb_bool_t	tr_identify_server_command_received_cb (zb_zcl_parsed_hdr_t *cmd_info)
	Callback that user can declare to handle any Identify server commands.
void	tr_identify_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 Identify server attribute is about to be written.
zb_bool_t	tr_identify_server_identify_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint16_t identify_time)
	Callback that user can declare to handle identify cluster identify command.
zb_bool_t	tr_identify_server_identify_query_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint)
	Callback that user can declare to handle identify cluster identify query command.
zb_bool_t	tr_identify_server_ez_mode_invoke_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t action)
	Callback that user can declare to handle identify clusterez mode invoke command.
zb_bool_t	tr_identify_server_update_commission_state_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t action, zb_uint8_t commission_state_mask)
	Callback that user can declare to handle identify cluster update commission state command.
zb_bool_t	tr_identify_server_trigger_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 identify cluster trigger effect command.
void	tr_identify_server_identify_start_cb (zb_uint8_t endpoint, zb_uint16_t timeout_sec)
	Callback fires when identify behavior is started.
void	tr_identify_server_identify_stop_cb (zb_uint8_t endpoint)
	Callback fires when identify behavior stops.
void	tr_identify_server_message_sent_cb (zb_bufid_t param)
	Callback fires when identify 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_identify_server_command_received_cb()

zb_bool_t tr_identify_server_command_received_cb

(

zb_zcl_parsed_hdr_t *

cmd_info

)

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

Parameters

cmd_info

struct that contains zcl header info

Returns

ZB_FALSE to allow framework to continue processing the command

tr_identify_server_ez_mode_invoke_cb()

zb_bool_t tr_identify_server_ez_mode_invoke_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	action )

Callback that user can declare to handle identify clusterez mode invoke command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
action	the action to take

Returns

ZB_FALSE to allow framework to continue processing the command

tr_identify_server_identify_cb()

zb_bool_t tr_identify_server_identify_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint16_t	identify_time )

Callback that user can declare to handle identify cluster identify command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
identify_time	the amount of time to identify for, or 0 to stop identify

Returns

ZB_FALSE to allow framework to continue processing the command

tr_identify_server_identify_query_cb()

zb_bool_t tr_identify_server_identify_query_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint )

Callback that user can declare to handle identify cluster identify query 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_identify_server_identify_start_cb()

void tr_identify_server_identify_start_cb	(	zb_uint8_t	endpoint,
		zb_uint16_t	timeout_sec )

Callback fires when identify behavior is started.

Parameters

endpoint	device endpoint
timeout_sec	identify duration in seconds

tr_identify_server_identify_stop_cb()

void tr_identify_server_identify_stop_cb

(

zb_uint8_t

endpoint

)

Callback fires when identify behavior stops.

Parameters

endpoint

device endpoint

tr_identify_server_init_cb()

void tr_identify_server_init_cb

(

zb_uint8_t

endpoint

)

Callback fires when the Identify server cluster plugin is initialized.

Parameters

endpoint

device endpoint being initialized

tr_identify_server_message_sent_cb()

void tr_identify_server_message_sent_cb

(

zb_bufid_t

param

)

Callback fires when identify 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_identify_server_trigger_effect_cb()

zb_bool_t tr_identify_server_trigger_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 identify cluster trigger effect command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
effect_id	specifies the identify effect to use
effect_variant	used to indicate which variant of the effect to use

Returns

ZB_FALSE to allow framework to continue processing the command

tr_identify_server_update_commission_state_cb()

zb_bool_t tr_identify_server_update_commission_state_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	action,
		zb_uint8_t	commission_state_mask )

Callback that user can declare to handle identify cluster update commission state command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
action	the action to take
commission_state_mask	bitmask for commission state

Returns

ZB_FALSE to allow framework to continue processing the command

tr_identify_server_write_attr_cb()

void tr_identify_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 Identify 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