Logo
Developing with ZBOSS for Zigbee
Data Structures | Macros | Typedefs | Functions
ZCL Identify cluster
Zigbee stack API » ZCL API » ZCL clusters

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...
 

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...
 

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...
 

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...
 

Identify cluster attributes

enum  zb_zcl_identify_attr_e { ZB_ZCL_ATTR_IDENTIFY_IDENTIFY_TIME_ID = 0x0000 }
 Identify cluster attribute identifier. More...
 
#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...
 

Identify cluster command structures and definitions

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...
 
#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...
 

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.

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
 
#define ZB_ZCL_IDENTIFY_EFFECT_SCHEDULE_USER_APP(buffer, pcmd_info, effectId, effectVar)
 

Detailed Description

Identify cluster implementation supports Identify command and Identify Query request-response command pair. All these commands have simple payload. Both Identify and Identify Query request are being processed, and Identify Query response is being generated in ZCL internals.

Example
Identify sending:
Identify Query request sending:

Macro Definition Documentation

§ ZB_ZCL_IDENTIFY_CLUSTER_REVISION_DEFAULT

#define ZB_ZCL_IDENTIFY_CLUSTER_REVISION_DEFAULT   ((zb_uint16_t)0x0002u)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_identify.h>

Default value for Identify cluster revision global attribute.

§ ZB_ZCL_IDENTIFY_EFFECT_SCHEDULE_USER_APP

#define ZB_ZCL_IDENTIFY_EFFECT_SCHEDULE_USER_APP (   buffer,
  pcmd_info,
  effectId,
  effectVar 
)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_identify.h>

Value:
{ \
zb_zcl_identify_effect_user_app_schedule_t* data = \
ZB_BUF_GET_PARAM((buffer), zb_zcl_identify_effect_user_app_schedule_t); \
ZB_MEMMOVE(&(data->cmd_info), (pcmd_info), sizeof(zb_zcl_parsed_hdr_t)); \
data->param.effect_id = (effectId); \
data->param.effect_variant = (effectVar); \
ZB_SCHEDULE_CALLBACK(zb_zcl_identify_effect_invoke_user_app, (buffer)); \
}
zb_zcl_parsed_hdr_s
Definition: zb_zcl_common.h:1158
zb_zcl_identify_effect_user_app_schedule_e
Definition: zb_zcl_identify.h:209

§ ZB_ZCL_IDENTIFY_GET_IDENTIFY_QUERY_RES

#define ZB_ZCL_IDENTIFY_GET_IDENTIFY_QUERY_RES (   data_ptr,
  buffer,
  status 
)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_identify.h>

Value:
{ \
if (zb_buf_len((buffer)) < sizeof(zb_zcl_identify_query_res_t)) \
{ \
(status) = ZB_ZCL_PARSE_STATUS_FAILURE; \
} \
else \
{ \
zb_zcl_identify_query_res_t *src_ptr = \
(zb_zcl_identify_query_res_t*)zb_buf_begin((buffer)); \
(status) = ZB_ZCL_PARSE_STATUS_SUCCESS; \
ZB_HTOLE16(&((data_ptr)->timeout), &(src_ptr->timeout)); \
} \
}
ZB_ZCL_PARSE_STATUS_FAILURE
Definition: zb_zcl_common.h:339
zb_zcl_identify_query_res_s
Structured representation of Identify Query Response command payload.
Definition: zb_zcl_identify.h:330
ZB_ZCL_PARSE_STATUS_SUCCESS
Definition: zb_zcl_common.h:338
zb_buf_begin
#define zb_buf_begin(buf)
Definition: zboss_api_buf.h:354
zb_buf_len
#define zb_buf_len(buf)
Definition: zboss_api_buf.h:372

Identify cluster Identify Query Response command payload structured read.

Parameters
data_ptr- pointer to a variable of type zb_zcl_identify_query_res_t
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).

§ ZB_ZCL_IDENTIFY_GET_IDENTIFY_REQ

#define ZB_ZCL_IDENTIFY_GET_IDENTIFY_REQ (   data_ptr,
  buffer,
  status 
)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_identify.h>

Value:
{ \
if (zb_buf_len((buffer)) < sizeof(zb_zcl_identify_req_t)) \
{ \
(status) = ZB_ZCL_PARSE_STATUS_FAILURE; \
} \
else \
{ \
zb_zcl_identify_req_t *src_ptr = \
(zb_zcl_identify_req_t*)zb_buf_begin((buffer)); \
(status) = ZB_ZCL_PARSE_STATUS_SUCCESS; \
ZB_HTOLE16(&((data_ptr)->timeout), &(src_ptr->timeout)); \
} \
}
ZB_ZCL_PARSE_STATUS_FAILURE
Definition: zb_zcl_common.h:339
ZB_ZCL_PARSE_STATUS_SUCCESS
Definition: zb_zcl_common.h:338
zb_buf_begin
#define zb_buf_begin(buf)
Definition: zboss_api_buf.h:354
zb_zcl_identify_req_s
Structured representation of Identify command payload.
Definition: zb_zcl_identify.h:324
zb_buf_len
#define zb_buf_len(buf)
Definition: zboss_api_buf.h:372

Identify cluster Identify command payload structured read.

Parameters
data_ptr- pointer to a variable of type zb_zcl_identify_req_t
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).

§ ZB_ZCL_IDENTIFY_GET_TRIGGER_VARIANT_REQ

#define ZB_ZCL_IDENTIFY_GET_TRIGGER_VARIANT_REQ (   data_ptr,
  buffer,
  status 
)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_identify.h>

Value:
{ \
if (zb_buf_len((buffer)) < sizeof(zb_zcl_identify_effect_req_t)) \
{ \
(status) = ZB_ZCL_PARSE_STATUS_FAILURE; \
} \
else \
{ \
zb_zcl_identify_effect_req_t *src_ptr = \
(zb_zcl_identify_effect_req_t*)zb_buf_begin((buffer)); \
(status) = ZB_ZCL_PARSE_STATUS_SUCCESS; \
ZB_MEMCPY((data_ptr), src_ptr, sizeof(zb_zcl_identify_effect_req_t)); \
} \
}
zb_zcl_identify_effect_req_s
Structured representation of Trigger effect command payload.
Definition: zb_zcl_identify.h:136
ZB_ZCL_PARSE_STATUS_FAILURE
Definition: zb_zcl_common.h:339
ZB_ZCL_PARSE_STATUS_SUCCESS
Definition: zb_zcl_common.h:338
zb_buf_begin
#define zb_buf_begin(buf)
Definition: zboss_api_buf.h:354
zb_buf_len
#define zb_buf_len(buf)
Definition: zboss_api_buf.h:372

Parses Trigger effect command.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zcl_identify_effect_req_s.
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).

§ ZB_ZCL_IDENTIFY_IDENTIFY_TIME_DEFAULT_VALUE

#define ZB_ZCL_IDENTIFY_IDENTIFY_TIME_DEFAULT_VALUE   0x0000

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_identify.h>

Default value for Identify attribute.

§ ZB_ZCL_IDENTIFY_SEND_IDENTIFY_QUERY_REQ

#define ZB_ZCL_IDENTIFY_SEND_IDENTIFY_QUERY_REQ (   buffer,
  addr,
  dst_addr_mode,
  dst_ep,
  ep,
  prfl_id,
  def_resp,
  cb 
)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_identify.h>

Value:
{ \
zb_uint8_t* ptr = ZB_ZCL_START_PACKET_REQ(buffer) \
ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL(ptr, def_resp) \
ZB_ZCL_CONSTRUCT_COMMAND_HEADER_REQ( \
ptr, ZB_ZCL_GET_SEQ_NUM(), ZB_ZCL_CMD_IDENTIFY_IDENTIFY_QUERY_ID); \
ZB_ZCL_FINISH_PACKET(buffer, ptr) \
ZB_ZCL_SEND_COMMAND_SHORT( \
buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, ZB_ZCL_CLUSTER_ID_IDENTIFY, cb); \
}
ZB_ZCL_GET_SEQ_NUM
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame.
Definition: zb_zcl_common.h:1470
ZB_ZCL_CMD_IDENTIFY_IDENTIFY_QUERY_ID
Definition: zb_zcl_identify.h:81
ZB_ZCL_CLUSTER_ID_IDENTIFY
#define ZB_ZCL_CLUSTER_ID_IDENTIFY
Definition: zb_zcl_common.h:210

Send Identify Query command.

Parameters
bufferto put packet to
addr- address to send packet to
dst_addr_mode- addressing mode
dst_ep- destination endpoint
ep- sending endpoint
prfl_id- profile identifier
def_resp- flag "Default response required"
cb- callback for getting command send status

§ ZB_ZCL_IDENTIFY_SEND_IDENTIFY_QUERY_RES

#define ZB_ZCL_IDENTIFY_SEND_IDENTIFY_QUERY_RES (   buffer,
  time,
  addr,
  dst_addr_mode,
  dst_ep,
  ep,
  prfl_id,
  seq_num,
  aps_secured 
)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_identify.h>

Value:
{ \
zb_uint8_t* ptr = ZB_ZCL_START_PACKET(buffer); \
ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(ptr); \
ZB_ZCL_CONSTRUCT_COMMAND_HEADER(ptr, seq_num, ZB_ZCL_CMD_IDENTIFY_IDENTIFY_QUERY_RSP_ID); \
ZB_ZCL_PACKET_PUT_DATA16_VAL(ptr, time); \
ZB_ZCL_FINISH_N_SEND_PACKET_NEW(buffer, ptr, \
addr, dst_addr_mode, dst_ep, ep, prfl_id, ZB_ZCL_CLUSTER_ID_IDENTIFY, NULL, aps_secured, \
ZB_FALSE, 0); \
}
ZB_ZCL_START_PACKET
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array.
Definition: zb_zcl_common.h:1550
ZB_FALSE
#define ZB_FALSE
Definition: zb_types.h:349
ZB_ZCL_CMD_IDENTIFY_IDENTIFY_QUERY_RSP_ID
Definition: zb_zcl_identify.h:83
ZB_ZCL_CLUSTER_ID_IDENTIFY
#define ZB_ZCL_CLUSTER_ID_IDENTIFY
Definition: zb_zcl_common.h:210

Send Identify Query Response command.

Parameters
bufferto put packet to
timethe device will be identifying
addr- address to send packet to
dst_addr_mode- addressing mode
dst_ep- destination endpoint
ep- sending endpoint
prfl_id- profile identifier
seq_num- sequence number
aps_secured- APS security mode

§ ZB_ZCL_IDENTIFY_SEND_IDENTIFY_REQ

#define ZB_ZCL_IDENTIFY_SEND_IDENTIFY_REQ (   buffer,
  time,
  addr,
  dst_addr_mode,
  dst_ep,
  ep,
  prfl_id,
  def_resp,
  cb 
)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_identify.h>

Value:
{ \
zb_uint8_t* ptr = ZB_ZCL_START_PACKET_REQ(buffer) \
ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL(ptr, def_resp) \
ZB_ZCL_CONSTRUCT_COMMAND_HEADER_REQ(ptr, ZB_ZCL_GET_SEQ_NUM(), ZB_ZCL_CMD_IDENTIFY_IDENTIFY_ID); \
ZB_ZCL_PACKET_PUT_DATA16_VAL(ptr, time); \
ZB_ZCL_FINISH_PACKET(buffer, ptr) \
ZB_ZCL_SEND_COMMAND_SHORT( \
buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, ZB_ZCL_CLUSTER_ID_IDENTIFY, cb); \
}
ZB_ZCL_GET_SEQ_NUM
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame.
Definition: zb_zcl_common.h:1470
ZB_ZCL_CMD_IDENTIFY_IDENTIFY_ID
Definition: zb_zcl_identify.h:80
ZB_ZCL_CLUSTER_ID_IDENTIFY
#define ZB_ZCL_CLUSTER_ID_IDENTIFY
Definition: zb_zcl_common.h:210

Send Identify command.

Parameters
bufferto put packet to
timethe device will be identifying
addr- address to send packet to
dst_addr_mode- addressing mode
dst_ep- destination endpoint
ep- sending endpoint
prfl_id- profile identifier
def_resp- flag "Default response required"
cb- callback for getting command send status

§ ZB_ZCL_IDENTIFY_SEND_TRIGGER_VARIANT_REQ

#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 
)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_identify.h>

Value:
{ \
zb_uint8_t* ptr = ZB_ZCL_START_PACKET_REQ(buffer) \
ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL(ptr, def_resp) \
ZB_ZCL_CONSTRUCT_COMMAND_HEADER_REQ(ptr, ZB_ZCL_GET_SEQ_NUM(), ZB_ZCL_CMD_IDENTIFY_TRIGGER_EFFECT_ID); \
ZB_ZCL_PACKET_PUT_DATA8(ptr, (effect_id)); \
ZB_ZCL_PACKET_PUT_DATA8(ptr, (effect_var)); \
ZB_ZCL_FINISH_PACKET(buffer, ptr) \
ZB_ZCL_SEND_COMMAND_SHORT( \
buffer, addr, dst_addr_mode, dst_ep, ep, prof_id, ZB_ZCL_CLUSTER_ID_IDENTIFY, cb); \
}
ZB_ZCL_GET_SEQ_NUM
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame.
Definition: zb_zcl_common.h:1470
ZB_ZCL_CLUSTER_ID_IDENTIFY
#define ZB_ZCL_CLUSTER_ID_IDENTIFY
Definition: zb_zcl_common.h:210
ZB_ZCL_CMD_IDENTIFY_TRIGGER_EFFECT_ID
Definition: zb_zcl_identify.h:82

Send Trigger effect command.

Parameters
bufferto put packet to
addr- address to send packet to
dst_addr_mode- addressing mode
dst_ep- destination endpoint
ep- sending endpoint
prof_id- profile identifier
def_resp- flag "Default response required"
cb- callback for getting command send status
effect_id- effect identify, see zb_zcl_identify_trigger_effect_e
effect_var- effect variant, see zb_zcl_identify_trigger_variant_e

Typedef Documentation

§ zb_zcl_identify_effect_req_t

typedef struct zb_zcl_identify_effect_req_s zb_zcl_identify_effect_req_t

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_identify.h>

Structured representation of Trigger effect command payload.

§ zb_zcl_identify_effect_user_app_schedule_t

typedef struct zb_zcl_identify_effect_user_app_schedule_e zb_zcl_identify_effect_user_app_schedule_t

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_identify.h>

Struct for invoke User App & continue after

§ zb_zcl_identify_effect_value_param_t

typedef struct zb_zcl_identify_effect_value_param_s zb_zcl_identify_effect_value_param_t

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_identify.h>

Declare change Identify attribute for User Application.

§ zb_zcl_identify_query_res_t

typedef struct zb_zcl_identify_query_res_s zb_zcl_identify_query_res_t

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_identify.h>

Structured representation of Identify Query Response command payload.

§ zb_zcl_identify_req_t

typedef struct zb_zcl_identify_req_s zb_zcl_identify_req_t

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_identify.h>

Structured representation of Identify command payload.

Enumeration Type Documentation

§ zb_zcl_identify_attr_e

enum zb_zcl_identify_attr_e

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_identify.h>

Identify cluster attribute identifier.

See also
ZCL8 spec, subclause 3.5.2.2
Enumerator
ZB_ZCL_ATTR_IDENTIFY_IDENTIFY_TIME_ID 

Identify time attribute

§ zb_zcl_identify_cmd_e

enum zb_zcl_identify_cmd_e

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_identify.h>

Command identifiers for "Identify" cluster.

See also
ZCL8 spec, subclauses 3.5.2.3, 3.5.2.4
Enumerator
ZB_ZCL_CMD_IDENTIFY_IDENTIFY_ID 

Identify command

ZB_ZCL_CMD_IDENTIFY_IDENTIFY_QUERY_ID 

Identify query command

ZB_ZCL_CMD_IDENTIFY_TRIGGER_EFFECT_ID 

"Trigger effect" command identifier.

ZB_ZCL_CMD_IDENTIFY_IDENTIFY_QUERY_RSP_ID 

Identify query response

§ zb_zcl_identify_trigger_effect_e

enum zb_zcl_identify_trigger_effect_e

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_identify.h>

Effect identifier enum

See also
ZCL8 spec 3.5.2.3.3.1
Enumerator
ZB_ZCL_IDENTIFY_EFFECT_ID_BLINK 

Effect identifier field value: Light is turned on/off once Effect identifier field value: Light turned on/off over 1 second and repeated 15 times

ZB_ZCL_IDENTIFY_EFFECT_ID_BREATHE 

Effect identifier field value: Colored light turns green for 1 second; non-colored light flashes twice

ZB_ZCL_IDENTIFY_EFFECT_ID_OKAY 

Effect identifier field value: Colored light turns orange for 8 seconds; non-colored light switches to maximum brightness for 0.5s and then minimum brightness for 7.5s

ZB_ZCL_IDENTIFY_EFFECT_ID_CHANNEL_CHANGE 

Effect identifier field value: Complete the current effect sequence before terminating. E.g., if in the middle of a breathe effect (as above), first complete the current 1s breathe effect and then terminate the effect

ZB_ZCL_IDENTIFY_EFFECT_ID_FINISH_EFFECT 

Effect identifier field value: Terminate the effect as soon as possible

ZB_ZCL_IDENTIFY_EFFECT_ID_STOP 

§ zb_zcl_identify_trigger_variant_e

enum zb_zcl_identify_trigger_variant_e

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_identify.h>

Effect variant enum

See also
ZCL8 spec 3.5.2.3.3.2
Enumerator
ZB_ZCL_IDENTIFY_EFFECT_ID_VARIANT_DEFAULT 

Effect variant field value: Default

Function Documentation

§ zb_zcl_is_identifying()

zb_uint8_t zb_zcl_is_identifying ( zb_uint8_t  endpoint)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_identify.h>

Indicates that endpoint supports Identify cluster and is identifying.

Parameters
endpointnumber to analyze
Returns
ZB_TRUE if endpoint is in the "identifying" state, ZB_FALSE otherwise.

§ zb_zcl_start_identifying()

zb_uint8_t zb_zcl_start_identifying ( zb_uint8_t  endpoint,
zb_uint16_t  timeout 
)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_identify.h>

Start identify process on given endpoint.

Parameters
endpoint- endpoint to start identifying on
timeout- time (in seconds) after which identifying will stop

§ zb_zcl_stop_identifying()

void zb_zcl_stop_identifying ( zb_uint8_t  endpoint)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_identify.h>

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.

Parameters
endpointEndpoint
Copyright (c) 2012-2022 DSR Corporation, Golden CO, USA. http://www.dsr-zboss.com http://www.dsr-corporation.com
ZBOSS documentation. Wed Oct 29 2025.