Developing with ZBOSS SDK for Zigbee
|
Data Structures | |
struct | zb_zcl_disc_attr_req_s |
ZCL Discover Attribute Command frame. More... | |
struct | zb_zcl_disc_attr_info_s |
ZCL Description for Discover Attribute Response frame. More... | |
struct | zb_zcl_disc_attr_res_s |
ZCL Discover Attribute Response frame. More... | |
Macros | |
#define | ZB_ZCL_GENERAL_GET_COMPLETE_DISC_RES(data_buf, complete) |
Parses Discovery attribute response and returns next Read attribute status record or NULL if there is no more data. More... | |
#define | ZB_ZCL_GENERAL_GET_NEXT_DISC_ATTR_RES(data_buf, disc_attr_info) |
Discovery attribute response and returns next Discovery attribute status record or NULL if there is no more data. More... | |
#define | ZB_ZCL_GENERAL_DISC_READ_ATTR_REQ(buffer, def_resp, start_attr_id, max_len, addr, dst_addr_mode, dst_ep, ep, profile_id, cluster_id, cb) |
Discover attribute command. More... | |
#define | ZB_ZCL_GENERAL_DISC_ATTR_REQ_A(buffer, cmd_ptr, direction, def_resp, start_attr_id, max_len, addr, dst_addr_mode, dst_ep, ep, profile_id, cluster_id, cb) |
Discover Attribute Request. More... | |
Typedefs | |
typedef struct zb_zcl_disc_attr_req_s | zb_zcl_disc_attr_req_t |
ZCL Discover Attribute Command frame. More... | |
typedef struct zb_zcl_disc_attr_info_s | zb_zcl_disc_attr_info_t |
ZCL Description for Discover Attribute Response frame. More... | |
typedef struct zb_zcl_disc_attr_res_s | zb_zcl_disc_attr_res_t |
ZCL Discover Attribute Response frame. More... | |
typedef enum zb_zcl_disc_complete_e | zb_zcl_disc_complete_t |
ZCL Discover Attribute Response - complete field. More... | |
Enumerations | |
enum | zb_zcl_disc_complete_e { ZB_ZCL_DISC_NON_COMPLETE = 0x00, ZB_ZCL_DISC_COMPLETE = 0x01 } |
ZCL Discover Attribute Response - complete field. More... | |
Discover attributes command described in ZCL spec, subclauses 2.4.13 and 2.4.14.
Read attributes request command can be formed and sent as in following snippet:
Discover attributes response can be parsed as:
until allocated buffer space exceeds.
Discover attributes request parsing and response filling and sending is implemented in ZCL library internal functions.
For more information see any HA sample
#define ZB_ZCL_GENERAL_DISC_ATTR_REQ_A | ( | buffer, | |
cmd_ptr, | |||
direction, | |||
def_resp, | |||
start_attr_id, | |||
max_len, | |||
addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
profile_id, | |||
cluster_id, | |||
cb | |||
) |
Discover Attribute Request.
buffer | - reference to buffer to put packet into |
cmd_ptr | - pointer to command (not used) |
direction | - direction of command (see zb_zcl_frame_direction_t) |
def_resp | - enable/disable default response |
start_attr_id | - start attribute ID |
max_len | - max count |
addr | - address to send packet to |
dst_addr_mode | - addressing mode |
dst_ep | - destination endpoint |
ep | - sending endpoint |
profile_id | - profile identifier |
cluster_id | - cluster identifier |
cb | - callback for getting command send status |
#define ZB_ZCL_GENERAL_DISC_READ_ATTR_REQ | ( | buffer, | |
def_resp, | |||
start_attr_id, | |||
max_len, | |||
addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
profile_id, | |||
cluster_id, | |||
cb | |||
) |
Discover attribute command.
buffer | - reference to buffer to put packet into |
def_resp | - enable/disable default response |
start_attr_id | - start attribute ID |
max_len | - max count |
addr | - address to send packet to |
dst_addr_mode | - addressing mode |
dst_ep | - destination endpoint |
ep | - sending endpoint |
profile_id | - profile identifier |
cluster_id | - cluster identifier |
cb | - callback for getting command send status |
#define ZB_ZCL_GENERAL_GET_COMPLETE_DISC_RES | ( | data_buf, | |
complete | |||
) |
Parses Discovery attribute response and returns next Read attribute status record or NULL if there is no more data.
If response contains invalid data, 0 is returned.
data_buf | - ID zb_bufid_t of a buffer containing discover attribute response data |
complete | - variable to store Complete field |
#define ZB_ZCL_GENERAL_GET_NEXT_DISC_ATTR_RES | ( | data_buf, | |
disc_attr_info | |||
) |
Discovery attribute response and returns next Discovery attribute status record or NULL if there is no more data.
If response contains invalid data, NULL is returned.
data_buf | - ID zb_bufid_t of a buffer containing part of Discover attribute response data |
disc_attr_info | - out pointer to zb_zcl_disc_attr_info_t, containing Discover attribute status record |
typedef struct zb_zcl_disc_attr_info_s zb_zcl_disc_attr_info_t |
ZCL Description for Discover Attribute Response frame.
typedef struct zb_zcl_disc_attr_req_s zb_zcl_disc_attr_req_t |
ZCL Discover Attribute Command frame.
typedef struct zb_zcl_disc_attr_res_s zb_zcl_disc_attr_res_t |
ZCL Discover Attribute Response frame.
typedef enum zb_zcl_disc_complete_e zb_zcl_disc_complete_t |
ZCL Discover Attribute Response - complete field.