Poll Control server Callbacks

Collaboration diagram for Poll Control server Callbacks:

Functions
void	tr_poll_control_server_init_cb (zb_uint8_t endpoint)
	Callback fires when the Poll Control server cluster plugin is initialized.
zb_bool_t	tr_poll_control_server_command_received_cb (zb_zcl_parsed_hdr_t *cmd_info)
	Callback that user can declare to handle any Poll Control server commands.
void	tr_poll_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 a poll control server attribute is about to be written.
zb_bool_t	tr_poll_control_server_check_in_response_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t start_fast_polling, zb_uint16_t fast_poll_timeout)
	Callback that user can declare to handle poll control cluster check in response command.
zb_bool_t	tr_poll_control_server_fast_poll_stop_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint)
	Callback that user can declare to handle poll control cluster fast poll stop command.
zb_bool_t	tr_poll_control_server_set_long_poll_interval_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint32_t new_long_poll_interval)
	Callback that user can declare to handle poll control cluster set long poll interval command.
zb_bool_t	tr_poll_control_server_set_short_poll_interval_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint16_t new_short_poll_interval)
	Callback that user can declare to handle poll control cluster set short poll interval command.
void	tr_poll_control_server_started_cb (void)
	Callback fires when poll control server cluster is started.
zb_bool_t	tr_poll_control_server_send_check_in_cb (void)
	Callback fires when poll control server sends a check in command.

Detailed Description

---

---

Function Documentation

tr_poll_control_server_check_in_response_cb()

zb_bool_t tr_poll_control_server_check_in_response_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	start_fast_polling,
		zb_uint16_t	fast_poll_timeout )

Callback that user can declare to handle poll control cluster check in response command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
start_fast_polling	indicates whether or not the device should begin fast polling
fast_poll_timeout	the number of quarterseconds during which the device should continue fast polling

Returns

ZB_FALSE to allow framework to continue processing the command

tr_poll_control_server_command_received_cb()

zb_bool_t tr_poll_control_server_command_received_cb

(

zb_zcl_parsed_hdr_t *

cmd_info

)

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

Parameters

cmd_info

struct that contains zcl header info

Returns

ZB_FALSE to allow framework to continue processing the command

tr_poll_control_server_fast_poll_stop_cb()

zb_bool_t tr_poll_control_server_fast_poll_stop_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint )

Callback that user can declare to handle poll control cluster fast poll stop 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_poll_control_server_init_cb()

void tr_poll_control_server_init_cb

(

zb_uint8_t

endpoint

)

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

Parameters

endpoint

device endpoint being initialized

tr_poll_control_server_send_check_in_cb()

zb_bool_t tr_poll_control_server_send_check_in_cb

(

void

)

Callback fires when poll control server sends a check in command.

Returns

ZB_FALSE to prevent sending the check in command

tr_poll_control_server_set_long_poll_interval_cb()

zb_bool_t tr_poll_control_server_set_long_poll_interval_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint32_t	new_long_poll_interval )

Callback that user can declare to handle poll control cluster set long poll interval command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
new_long_poll_interval	new value for the LongPollInterval attribute (subject to being within range)

Returns

ZB_FALSE to allow framework to continue processing the command

tr_poll_control_server_set_short_poll_interval_cb()

zb_bool_t tr_poll_control_server_set_short_poll_interval_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint16_t	new_short_poll_interval )

Callback that user can declare to handle poll control cluster set short poll interval command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
new_short_poll_interval	new value for the ShortPollInterval attribute (subject to being within range)

Returns

ZB_FALSE to allow framework to continue processing the command

tr_poll_control_server_started_cb()

void tr_poll_control_server_started_cb

(

void

)

Callback fires when poll control server cluster is started.

tr_poll_control_server_write_attr_cb()

void tr_poll_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 a poll 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