Developing with ZBOSS for Zigbee
|
Data Structures | |
struct | zb_zcl_disc_cmd_req_s |
ZCL Discovery Commands Command frame. More... | |
struct | zb_zcl_disc_cmd_resp_s |
ZCL Discovery Commands Command frame. More... | |
Macros | |
#define | ZB_ZCL_BROADCAST_ENDPOINT 0xFFU |
ZCL broadcast endpoint. | |
#define | ZB_ZCL_BROADCAST_ENDPOINT_CMD_RESP_JITTER (ZB_MILLISECONDS_TO_BEACON_INTERVAL(500)) |
Minimum time delay between responses to ZCL command sent to broadcast endpoint. | |
#define | ZB_ZCL_GENERAL_DISC_COMMAND_GENERATED_REQ(_buffer, _direction, _def_resp, _addr, _dst_addr_mode, _dst_ep, _ep, _profile_id, _cluster_id, _cb, _is_manuf, _manuf_id, _start_cmd_id, _max_len) |
Discover commands Generated command. More... | |
#define | ZB_ZCL_GENERAL_DISC_COMMAND_RECEIVED_REQ(_buffer, _direction, _def_resp, _addr, _dst_addr_mode, _dst_ep, _ep, _profile_id, _cluster_id, _cb, _is_manuf, _manuf_id, _start_cmd_id, _max_len) |
Discover commands Received command. More... | |
#define | ZB_ZCL_GENERAL_GET_DISC_COMMAND(_data_ptr, _buffer, _status) |
Get parameter of Discovery command request. More... | |
#define | ZB_ZCL_GENERAL_INIT_DISC_COMMAND_RESP(_cmd_ptr, _buffer, _direction, _seq, _cmd, _is_manuf, _manuf_id, _complete) |
Init Discover commands response manufacture specific and not specific. More... | |
#define | ZB_ZCL_GENERAL_ADD_DISC_COMMAND_RESP(_cmd_ptr, _cmd_id) |
Add command Id to Discover commands response. More... | |
#define | ZB_ZCL_GENERAL_FINISH_DISC_COMMAND_RESP(_buffer, _cmd_ptr, _addr, _dst_addr_mode, _dst_ep, _ep, _profile_id, _cluster_id) |
Finish command Id to Discover commands response. More... | |
#define | ZB_ZCL_GENERAL_GET_DISC_COMMAND_RESP(_data_ptr, _buffer, _status) |
Get parameter of Discovery command response. More... | |
#define | ZB_ZCL_GENERAL_GET_NEXT_CMD_ID_DISC_COMMAND_RESP(_cmd_id, _buffer, _status) |
Get next command ID from Discovery command response. More... | |
Typedefs | |
typedef zb_uint8_t | zb_zcl_cmd_t |
Type for ZCL common command IDs. More... | |
typedef struct zb_zcl_disc_cmd_req_s | zb_zcl_disc_cmd_req_t |
ZCL Discovery Commands Command frame. More... | |
typedef enum zb_zcl_disc_cmd_complete_e | zb_zcl_disc_cmd_complete_t |
ZCL Discover command complete enum. More... | |
typedef struct zb_zcl_disc_cmd_resp_s | zb_zcl_disc_cmd_resp_t |
ZCL Discovery Commands Command frame. More... | |
Enumerations | |
enum | zb_zcl_disc_cmd_complete_e { ZB_ZCL_DISC_CMD_NOT_COMPLETE = 0x00, ZB_ZCL_DISC_CMD_COMPLETE = 0x01 } |
ZCL Discover command complete enum. More... | |
This section describes data structures representing command payloads shared by all clusters, and APIs for sending these commands and parsing their payloads.
#define ZB_ZCL_CMD_CONFIG_REPORT 0x06U |
Configure reporting command
#define ZB_ZCL_CMD_CONFIG_REPORT_RESP 0x07U |
Configure reporting response command
#define ZB_ZCL_CMD_DEFAULT_RESP 0x0bU |
Default response command
#define ZB_ZCL_CMD_DISC_ATTRIB 0x0cU |
Discover attributes command
#define ZB_ZCL_CMD_DISC_ATTRIB_RESP 0x0dU |
Discover attributes response command
#define ZB_ZCL_CMD_DISCOVER_ATTR_EXT 0x15U |
Discover attributes extended command
#define ZB_ZCL_CMD_DISCOVER_ATTR_EXT_RES 0x16U |
Discover attributes extended response command
#define ZB_ZCL_CMD_DISCOVER_COMMANDS_GENERATED 0x13U |
Discover Commands Generated command
#define ZB_ZCL_CMD_DISCOVER_COMMANDS_GENERATED_RES 0x14U |
Discover Commands Generated response command
#define ZB_ZCL_CMD_DISCOVER_COMMANDS_RECEIVED 0x11U |
Discover Commands Received command
#define ZB_ZCL_CMD_DISCOVER_COMMANDS_RECEIVED_RES 0x12U |
Discover Commands Received response command
#define ZB_ZCL_CMD_READ_ATTRIB 0x00U |
Read attributes command
#define ZB_ZCL_CMD_READ_ATTRIB_RESP 0x01U |
Read attributes response command
#define ZB_ZCL_CMD_READ_ATTRIB_STRUCT 0x0eU |
Read attributes structured
#define ZB_ZCL_CMD_READ_REPORT_CFG 0x08U |
Read reporting config command
#define ZB_ZCL_CMD_READ_REPORT_CFG_RESP 0x09U |
Read reporting config response command
#define ZB_ZCL_CMD_REPORT_ATTRIB 0x0aU |
Report attribute command
#define ZB_ZCL_CMD_WRITE_ATTRIB 0x02U |
Write attributes foundation command
#define ZB_ZCL_CMD_WRITE_ATTRIB_NO_RESP 0x05U |
Write attributes no response command
#define ZB_ZCL_CMD_WRITE_ATTRIB_RESP 0x04U |
Write attributes response command
#define ZB_ZCL_CMD_WRITE_ATTRIB_STRUCT 0x0fU |
Write attributes structured
#define ZB_ZCL_CMD_WRITE_ATTRIB_STRUCT_RESP 0x10U |
Write attributes structured response
#define ZB_ZCL_CMD_WRITE_ATTRIB_UNDIV 0x03U |
Write attributes undivided command
#define ZB_ZCL_GENERAL_ADD_DISC_COMMAND_RESP | ( | _cmd_ptr, | |
_cmd_id | |||
) |
Add command Id to Discover commands response.
_cmd_ptr | - pointer of current part command |
_cmd_id | - The discovery complete field is a boolean field |
#define ZB_ZCL_GENERAL_DISC_COMMAND_GENERATED_REQ | ( | _buffer, | |
_direction, | |||
_def_resp, | |||
_addr, | |||
_dst_addr_mode, | |||
_dst_ep, | |||
_ep, | |||
_profile_id, | |||
_cluster_id, | |||
_cb, | |||
_is_manuf, | |||
_manuf_id, | |||
_start_cmd_id, | |||
_max_len | |||
) |
Discover commands Generated command.
_buffer | to put packet to |
_direction | - direction client-to-server or server-to-client |
_def_resp | - enable/disable default response |
_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 |
_is_manuf | - is discovery manufacturer attributes |
_manuf_id | - manufacturer ID |
_start_cmd_id | - start command ID |
_max_len | - max count |
#define ZB_ZCL_GENERAL_DISC_COMMAND_RECEIVED_REQ | ( | _buffer, | |
_direction, | |||
_def_resp, | |||
_addr, | |||
_dst_addr_mode, | |||
_dst_ep, | |||
_ep, | |||
_profile_id, | |||
_cluster_id, | |||
_cb, | |||
_is_manuf, | |||
_manuf_id, | |||
_start_cmd_id, | |||
_max_len | |||
) |
Discover commands Received command.
_buffer | to put packet to |
_direction | - direction client-to-server or server-to-client |
_def_resp | - enable/disable default response |
_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 |
_is_manuf | - is discovery manufacturer attributes |
_manuf_id | - manufacturer ID |
_start_cmd_id | - start command ID |
_max_len | - max count |
#define ZB_ZCL_GENERAL_FINISH_DISC_COMMAND_RESP | ( | _buffer, | |
_cmd_ptr, | |||
_addr, | |||
_dst_addr_mode, | |||
_dst_ep, | |||
_ep, | |||
_profile_id, | |||
_cluster_id | |||
) |
Finish command Id to Discover commands response.
_buffer | to put packet to |
_cmd_ptr | - pointer of current part command |
_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 |
#define ZB_ZCL_GENERAL_GET_DISC_COMMAND | ( | _data_ptr, | |
_buffer, | |||
_status | |||
) |
Get parameter of Discovery command request.
_buffer | - buffer containing part of Discover command request data |
_data_ptr | - out pointer to zb_zcl_disc_cmd_req_t, containing Discover command data |
_status | - result parse, see zb_zcl_parse_status_t |
#define ZB_ZCL_GENERAL_GET_DISC_COMMAND_RESP | ( | _data_ptr, | |
_buffer, | |||
_status | |||
) |
Get parameter of Discovery command response.
_buffer | - ID zb_bufid_t of a buffer containing part of Discover command response data |
_data_ptr | - out pointer to zb_zcl_disc_cmd_res_t, containing Discover command response |
_status | - result parse, see zb_zcl_parse_status_t |
#define ZB_ZCL_GENERAL_GET_NEXT_CMD_ID_DISC_COMMAND_RESP | ( | _cmd_id, | |
_buffer, | |||
_status | |||
) |
Get next command ID from Discovery command response.
_buffer | - ID zb_bufid_t of a buffer containing part of Discover command response data |
_cmd_id | - out next command ID |
_status | - result parse, see zb_zcl_parse_status_t |
#define ZB_ZCL_GENERAL_INIT_DISC_COMMAND_RESP | ( | _cmd_ptr, | |
_buffer, | |||
_direction, | |||
_seq, | |||
_cmd, | |||
_is_manuf, | |||
_manuf_id, | |||
_complete | |||
) |
Init Discover commands response manufacture specific and not specific.
_cmd_ptr | - pointer of current part command |
_buffer | to put packet to |
_direction | - direction client-to-server or server-to-client |
_seq | - sequence of request |
_cmd | - command Id |
_is_manuf | - is manufacturer specific |
_manuf_id | - manufacturer ID |
_complete | - The discovery complete field is a boolean field |
typedef zb_uint8_t zb_zcl_cmd_t |
Type for ZCL common command IDs.
typedef enum zb_zcl_disc_cmd_complete_e zb_zcl_disc_cmd_complete_t |
ZCL Discover command complete enum.
typedef struct zb_zcl_disc_cmd_req_s zb_zcl_disc_cmd_req_t |
ZCL Discovery Commands Command frame.
typedef struct zb_zcl_disc_cmd_resp_s zb_zcl_disc_cmd_resp_t |
ZCL Discovery Commands Command frame.