Identify server APIs

Collaboration diagram for Identify server APIs:

Functions
tr_status_t	tr_identify_server_start_identifying (zb_uint8_t endpoint, zb_uint16_t timeout_sec)
	API used to start identify on the local device.
tr_status_t	tr_identify_server_stop_identifying (zb_uint8_t endpoint)
	API used to stop identify on the local device.
zb_uint16_t	tr_identify_server_is_identifying (zb_uint8_t endpoint)
	API used to check if local device is identifing.

Detailed Description

---

---

Function Documentation

tr_identify_server_is_identifying()

zb_uint16_t tr_identify_server_is_identifying

(

zb_uint8_t

endpoint

)

API used to check if local device is identifing.

Parameters

endpoint

device endpoint

Returns

0 if the endpoint specified is not identifying

identify_time_left seconds if the endpoint specified is identifying

tr_identify_server_start_identifying()

tr_status_t tr_identify_server_start_identifying	(	zb_uint8_t	endpoint,
		zb_uint16_t	timeout_sec )

API used to start identify on the local device.

Parameters

endpoint	device endpoint
timeout_sec	identify duration in seconds

Returns

ZCL status TR_ZCL_STATUS_SUCCESS if successful, error code if not

tr_identify_server_stop_identifying()

tr_status_t tr_identify_server_stop_identifying

(

zb_uint8_t

endpoint

)

API used to stop identify on the local device.

Parameters

endpoint

device endpoint

Returns

ZCL status TR_ZCL_STATUS_SUCCESS if successful, error code if not