Alarms client Callbacks

Collaboration diagram for Alarms client Callbacks:

Functions
void	tr_alarms_client_init_cb (zb_uint8_t endpoint)
	Callback fires when the Alarms client cluster plugin is initialized.
zb_bool_t	tr_alarms_client_command_received_cb (zb_zcl_parsed_hdr_t *cmd_info)
	Callback that user can declare to handle any Alarms client commands.
void	tr_alarms_client_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 Alarms client attribute is about to be written.
zb_bool_t	tr_alarms_client_alarm_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t alarm_code, zb_uint16_t cluster_id)
	Callback that user can declare to handle alarms cluster alarm command.
zb_bool_t	tr_alarms_client_get_alarm_response_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t status, zb_uint8_t alarm_code, zb_uint16_t cluster_id, zb_uint32_t time_stamp)
	Callback that user can declare to handle alarms cluster get alarm response command.

Detailed Description

---

---

Function Documentation

tr_alarms_client_alarm_cb()

zb_bool_t tr_alarms_client_alarm_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	alarm_code,
		zb_uint16_t	cluster_id )

Callback that user can declare to handle alarms cluster alarm command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
alarm_code	Identifying code for the cause of the alarm, as given in the specification of the cluster whose attribute generated this alarm
cluster_id	The identifier of the cluster whose attribute generated this alarm

Returns

ZB_FALSE to allow framework to continue processing the command

tr_alarms_client_command_received_cb()

zb_bool_t tr_alarms_client_command_received_cb

(

zb_zcl_parsed_hdr_t *

cmd_info

)

Callback that user can declare to handle any Alarms client commands.

Parameters

cmd_info

struct that contains zcl header info

Returns

ZB_FALSE to allow framework to continue processing the command

tr_alarms_client_get_alarm_response_cb()

zb_bool_t tr_alarms_client_get_alarm_response_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t	endpoint,
		zb_uint8_t	status,
		zb_uint8_t	alarm_code,
		zb_uint16_t	cluster_id,
		zb_uint32_t	time_stamp )

Callback that user can declare to handle alarms cluster get alarm response command.

Parameters

cmd_info	struct that contains zcl header info
endpoint	device endpoint
status	if status is SUCCESS then an alarm is returned, if the table is empty, status will be NOT_FOUND
alarm_code	Identifying code for the cause of the alarm, as given in the specification of the cluster whose attribute generated this alarm
cluster_id	The identifier of the cluster whose attribute generated this alarm
time_stamp	The time at which the alarm occurred or 0xFFFFFFFF if no time information is available

Returns

ZB_FALSE to allow framework to continue processing the command

tr_alarms_client_init_cb()

void tr_alarms_client_init_cb

(

zb_uint8_t

endpoint

)

Callback fires when the Alarms client cluster plugin is initialized.

Parameters

endpoint

device endpoint being initialized

tr_alarms_client_write_attr_cb()

void tr_alarms_client_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 Alarms client 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