![]() |
nRF5 SDK for Thread and Zigbee v1.0.0
|
Data Structures | |
struct | zb_zcl_identify_effect_req_s |
Structured representsation 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) |
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. | |
typedef struct zb_zcl_identify_query_res_s | zb_zcl_identify_query_res_t |
Structured representation of Identify Query Response command payload. | |
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_IDENTIFY_TIME_DEFAULT_VALUE 0x0000 |
Default value for Identify attribute. | |
Inform User App about ZLL Identify cluster command and change attributes. | |
Internal structures and define-procedure for inform User App about ZLL 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. | |
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) |
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.
For more information see 5.5.3_groups, 5.4.2_identify samples
#define ZB_ZCL_IDENTIFY_EFFECT_SCHEDULE_USER_APP | ( | buffer, | |
pcmd_info, | |||
effectId, | |||
effectVar | |||
) |
#define ZB_ZCL_IDENTIFY_GET_IDENTIFY_QUERY_RES | ( | data_ptr, | |
buffer, | |||
status | |||
) |
Identify cluster Identify Query Response command payload structured read.
data_ptr | - pointer to a variable of type zb_zcl_identify_query_res_t |
buffer | containing the packet (by pointer). |
status | - variable to put parse status to (see zb_zcl_parse_status_t). |
#define ZB_ZCL_IDENTIFY_GET_IDENTIFY_REQ | ( | data_ptr, | |
buffer, | |||
status | |||
) |
Identify cluster Identify command payload structured read.
data_ptr | - pointer to a variable of type zb_zcl_identify_req_t |
buffer | containing the packet (by pointer). |
status | - variable to put parse status to (see zb_zcl_parse_status_t). |
#define ZB_ZCL_IDENTIFY_GET_TRIGGER_VARIANT_REQ | ( | data_ptr, | |
buffer, | |||
status | |||
) |
Parses Trigger effect command.
data_ptr | - pointer to a variable of type zb_zcl_identify_effect_req_s. |
buffer | containing the packet (by pointer). |
status | - variable to put parse status to (see zb_zcl_parse_status_t). |
#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.
buffer | to 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 |
#define ZB_ZCL_IDENTIFY_SEND_IDENTIFY_QUERY_RES | ( | buffer, | |
time, | |||
addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
prfl_id, | |||
seq_num | |||
) |
Send Identify Query Response command.
buffer | to put packet to |
time | the 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 |
#define ZB_ZCL_IDENTIFY_SEND_IDENTIFY_REQ | ( | buffer, | |
time, | |||
addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
prfl_id, | |||
def_resp, | |||
cb | |||
) |
Send Identify command.
buffer | to put packet to |
time | the 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 |
#define ZB_ZCL_IDENTIFY_SEND_TRIGGER_VARIANT_REQ | ( | buffer, | |
addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
prof_id, | |||
dis_default_resp, | |||
cb, | |||
effect_id, | |||
effect_var | |||
) |
Send Trigger effect command.
buffer | to 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 |
dis_default_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 struct zb_zcl_identify_effect_user_app_schedule_e zb_zcl_identify_effect_user_app_schedule_t |
Struct for invoke User App & continue after
Command identifiers for "Identify" cluster.
Effect identifier enum
zb_uint8_t zb_zcl_is_identifying | ( | zb_uint8_t | endpoint | ) |
Indicates that endpoint supports Identify cluster and is identifying.
endpoint | number to analyze |
zb_uint8_t zb_zcl_start_identifying | ( | zb_uint8_t | endpoint, |
zb_uint16_t | timeout | ||
) |
Start identify process on given endpoint.
endpoint | - endpoint to start identifying on |
timeout | - time (in seconds) after which identifying will stop |
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.
endpoint | Endpoint |