Identify Cluster

Files
file	zcl_identify.c
file	zcl_identify.h

Functions
uint_fast8_t	_zcl_identify_time_get (const zcl_attribute_full_t FAR *attribute)
int	_zcl_identify_time_set (const zcl_attribute_full_t FAR *attribute, zcl_attribute_write_rec_t *rec)
	Function registered to #ZCL_IDENTIFY_ATTR_IDENTIFY_TIME attribute of Identify Cluster. More...
int	zcl_identify_command (const wpan_envelope_t FAR *envelope, void FAR *context)
	Handler for ZCL Identify Server Commands (Identify, IdentifyQuery). More...
uint16_t	zcl_identify_isactive (void)
	Used by main program to see if a device is in "Identification mode". More...

Variables
uint16_t   end_of_list
zcl_attribute_full_t   identify_time
struct {
uint16_t   end_of_list
zcl_attribute_full_t   identify_time
}	zcl_identify_attr
	Standard attribute list for the Identify Server Cluster. More...
XBEE_BEGIN_DECLS const zcl_attribute_tree_t	zcl_identify_attribute_tree []
const zcl_attribute_tree_t	zcl_identify_attribute_tree []
uint32_t	zcl_identify_end = 0
uint16_t	zcl_identify_time = 0
	Private variable for tracking amount of "Identification mode" time left. More...

Detailed Description

Function Documentation

uint_fast8_t _zcl_identify_time_get

(

const zcl_attribute_full_t FAR *

attribute

)

int _zcl_identify_time_set	(	const zcl_attribute_full_t FAR *	attribute,
		zcl_attribute_write_rec_t *	rec
	)

Function registered to #ZCL_IDENTIFY_ATTR_IDENTIFY_TIME attribute of Identify Cluster.

Responsible for updating the IdentifyTime attribute, and also for determining when identify mode should end.

Parameters

[in]	attribute	ignored; assumed to point to zcl_identify_time
[in,out]	rec	value from write request or NULL to update the time when identify mode should end (used by the Identify cluster command).

See zcl_attribute_write_fn() for calling convention.

int zcl_identify_command	(	const wpan_envelope_t FAR *	envelope,
		void FAR *	context
	)

Handler for ZCL Identify Server Commands (Identify, IdentifyQuery).

Used in the #ZCL_CLUST_IDENTIFY cluster entry for an endpoint.

Parameters

[in]	envelope	envelope from received message
[in]	context	pointer to attribute list for cluster (typically passed in via endpoint dispatcher)

Return values

0	command was processed, including sending a possible Identify Query Response
!0	error sending response or processing command

uint16_t zcl_identify_isactive

(

void

)

Used by main program to see if a device is in "Identification mode".

Return values

>0	Number of seconds of "Identification mode" left.
0	Device is not in "Identification mode".

Variable Documentation

uint16_t end_of_list

uint16_t end_of_list

zcl_attribute_full_t identify_time

zcl_attribute_full_t identify_time

const { ... } zcl_identify_attr

Initial value:

=
{

        { { ZCL_IDENTIFY_ATTR_IDENTIFY_TIME,
                ZCL_ATTRIB_FLAG_FULL,
                ZCL_TYPE_UNSIGNED_16BIT,
                &zcl_identify_time },
                { 0 }, { 0 },
                &_zcl_identify_time_get, &_zcl_identify_time_set },
        ZCL_ATTRIBUTE_END_OF_LIST
}

Standard attribute list for the Identify Server Cluster.

XBEE_BEGIN_DECLS const zcl_attribute_tree_t zcl_identify_attribute_tree[]

const zcl_attribute_tree_t zcl_identify_attribute_tree[]

Initial value:

=
                { { ZCL_MFG_NONE, &zcl_identify_attr.identify_time.base, NULL } }

uint32_t zcl_identify_end = 0

Private variable for tracking value of xbee_seconds_timer() that "Idenfication mode" should end.

uint16_t zcl_identify_time = 0

Private variable for tracking amount of "Identification mode" time left.