zb_zcl_identify.h File Reference

#include "zcl/zb_zcl_common.h"
#include "zcl/zb_zcl_commands.h"

Data Structures
struct	zb_zcl_identify_effect_req_s
	Structured representation of Trigger effect command payload. More...
struct	zb_zcl_identify_effect_value_param_s
	Declare change Identify attribute for User Application. More...
struct	zb_zcl_identify_effect_user_app_schedule_e
struct	zb_zcl_identify_req_s
	Structured representation of Identify command payload. More...
struct	zb_zcl_identify_query_res_s
	Structured representation of Identify Query Response command payload. More...
struct	zb_zcl_identify_attrs_s
	Identify cluster attributes. More...

Macros
#define	ZB_ZCL_IDENTIFY_SEND_IDENTIFY_REQ( buffer, time, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb)
	Send Identify command. More...
#define	ZB_ZCL_IDENTIFY_SEND_IDENTIFY_QUERY_REQ( buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb)
	Send Identify Query command. More...
#define	ZB_ZCL_IDENTIFY_SEND_IDENTIFY_QUERY_RES( buffer, time, addr, dst_addr_mode, dst_ep, ep, prfl_id, seq_num, aps_secured)
	Send Identify Query Response command. More...
#define	ZB_ZCL_IDENTIFY_GET_IDENTIFY_REQ(data_ptr, buffer, status)
	Identify cluster Identify command payload structured read. More...
#define	ZB_ZCL_IDENTIFY_GET_IDENTIFY_QUERY_RES(data_ptr, buffer, status)
	Identify cluster Identify Query Response command payload structured read. More...
#define	ZB_ZCL_DECLARE_IDENTIFY_ATTRIB_LIST(attr_list, identify_time)
	Declare attribute list for Identify cluster. More...
#define	ZB_ZCL_DECLARE_IDENTIFY_ATTR_LIST(attr_list, attrs)   ZB_ZCL_DECLARE_IDENTIFY_ATTRIB_LIST(attr_list, &attrs.identify_time)
	Declare attribute list for Identify cluster cluster. More...
#define	ZB_ZCL_CLUSTER_ID_IDENTIFY_SERVER_ROLE_INIT   zb_zcl_identify_init_server
#define	ZB_ZCL_CLUSTER_ID_IDENTIFY_CLIENT_ROLE_INIT   zb_zcl_identify_init_client

Typedefs
typedef struct zb_zcl_identify_req_s	zb_zcl_identify_req_t
	Structured representation of Identify command payload. More...
typedef struct zb_zcl_identify_query_res_s	zb_zcl_identify_query_res_t
	Structured representation of Identify Query Response command payload. More...
typedef struct zb_zcl_identify_attrs_s	zb_zcl_identify_attrs_t
	Identify cluster attributes. More...

Functions
zb_uint8_t	zb_zcl_start_identifying (zb_uint8_t endpoint, zb_uint16_t timeout)
	Start identify process on given endpoint. More...
void	zb_zcl_stop_identifying (zb_uint8_t endpoint)
	Stop identify process on given endpoint Complimentary function to zb_zcl_start_identifying. Used to force identify termination before timeout provided to zb_zcl_start_identifying is elapsed. More...
zb_uint8_t	zb_zcl_is_identifying (zb_uint8_t endpoint)
	Indicates that endpoint supports Identify cluster and is identifying. More...
void	zb_zcl_identify_init_server (void)
void	zb_zcl_identify_init_client (void)

Identify cluster attributes
#define	ZB_ZCL_IDENTIFY_CLUSTER_REVISION_DEFAULT   ((zb_uint16_t)0x0002u)
	Default value for Identify cluster revision global attribute. More...
#define	ZB_ZCL_IDENTIFY_IDENTIFY_TIME_DEFAULT_VALUE   0x0000
	Default value for Identify attribute. More...
enum	zb_zcl_identify_attr_e { ZB_ZCL_ATTR_IDENTIFY_IDENTIFY_TIME_ID = 0x0000 }
	Identify cluster attribute identifier. More...

Identify cluster command structures and definitions
#define	ZB_ZCL_IDENTIFY_SEND_TRIGGER_VARIANT_REQ( buffer, addr, dst_addr_mode, dst_ep, ep, prof_id, def_resp, cb, effect_id, effect_var)
	Send Trigger effect command. More...
#define	ZB_ZCL_IDENTIFY_GET_TRIGGER_VARIANT_REQ(data_ptr, buffer, status)
	Parses Trigger effect command. More...
enum	zb_zcl_identify_cmd_e { ZB_ZCL_CMD_IDENTIFY_IDENTIFY_ID = 0x00, ZB_ZCL_CMD_IDENTIFY_IDENTIFY_QUERY_ID = 0x01, ZB_ZCL_CMD_IDENTIFY_TRIGGER_EFFECT_ID = 0x40, ZB_ZCL_CMD_IDENTIFY_IDENTIFY_QUERY_RSP_ID = 0x00 }
	Command identifiers for "Identify" cluster. More...
enum	zb_zcl_identify_trigger_effect_e {   ZB_ZCL_IDENTIFY_EFFECT_ID_BLINK = 0x00, ZB_ZCL_IDENTIFY_EFFECT_ID_BREATHE = 0x01, ZB_ZCL_IDENTIFY_EFFECT_ID_OKAY = 0x02, ZB_ZCL_IDENTIFY_EFFECT_ID_CHANNEL_CHANGE = 0x0b,   ZB_ZCL_IDENTIFY_EFFECT_ID_FINISH_EFFECT = 0xfe, ZB_ZCL_IDENTIFY_EFFECT_ID_STOP = 0xff }
enum	zb_zcl_identify_trigger_variant_e { ZB_ZCL_IDENTIFY_EFFECT_ID_VARIANT_DEFAULT = 0x00 }
typedef struct zb_zcl_identify_effect_req_s	zb_zcl_identify_effect_req_t
	Structured representation of Trigger effect command payload. More...

Inform User App about ZCL Identify cluster command and change attributes.
Internal structures and define-procedure for inform User App about ZCL Identify cluster command and change attributes.
#define	ZB_ZCL_IDENTIFY_EFFECT_SCHEDULE_USER_APP(buffer, pcmd_info, effectId, effectVar)
typedef struct zb_zcl_identify_effect_value_param_s	zb_zcl_identify_effect_value_param_t
	Declare change Identify attribute for User Application. More...
typedef struct zb_zcl_identify_effect_user_app_schedule_e	zb_zcl_identify_effect_user_app_schedule_t

Macro Definition Documentation

ZB_ZCL_CLUSTER_ID_IDENTIFY_CLIENT_ROLE_INIT

#define ZB_ZCL_CLUSTER_ID_IDENTIFY_CLIENT_ROLE_INIT   zb_zcl_identify_init_client

ZB_ZCL_CLUSTER_ID_IDENTIFY_SERVER_ROLE_INIT

#define ZB_ZCL_CLUSTER_ID_IDENTIFY_SERVER_ROLE_INIT   zb_zcl_identify_init_server

ZB_ZCL_DECLARE_IDENTIFY_ATTR_LIST

#define ZB_ZCL_DECLARE_IDENTIFY_ATTR_LIST	(		attr_list,
			attrs
	)		ZB_ZCL_DECLARE_IDENTIFY_ATTRIB_LIST(attr_list, &attrs.identify_time)

Declare attribute list for Identify cluster cluster.

Parameters

[in]	attr_list	- attribute list variable name
[in]	attrs	- variable of zb_zcl_identify_attrs_t type (containing Identify cluster attributes)

ZB_ZCL_DECLARE_IDENTIFY_ATTRIB_LIST

#define ZB_ZCL_DECLARE_IDENTIFY_ATTRIB_LIST	(		attr_list,
			identify_time
	)

Value:

ZB_ZCL_START_DECLARE_ATTRIB_LIST_CLUSTER_REVISION(attr_list, ZB_ZCL_IDENTIFY) \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_IDENTIFY_IDENTIFY_TIME_ID, (identify_time)) \
  ZB_ZCL_FINISH_DECLARE_ATTRIB_LIST

Declare attribute list for Identify cluster.

Parameters

attr_list	- attribute list name
identify_time	- pointer to variable to store identify time attribute value

Typedef Documentation

zb_zcl_identify_attrs_t

typedef struct zb_zcl_identify_attrs_s zb_zcl_identify_attrs_t

Identify cluster attributes.

Function Documentation

zb_zcl_identify_init_client()

void zb_zcl_identify_init_client

(

void

)

zb_zcl_identify_init_server()

void zb_zcl_identify_init_server

(

void

)