![]() |
nRF5 SDK for Thread and Zigbee v1.0.0
|
Data Structures | |
struct | zb_zcl_tunnel_transfer_data_req_s |
Tunnel Transfer Data Request command paylaod. More... | |
struct | zb_zcl_tunnel_transfer_data_req_internal_s |
struct | zb_zcl_tunnel_transfer_data_resp_s |
Tunnel Transfer Data Response command paylaod. More... | |
struct | zb_zcl_tunnel_op_status_s |
struct | zb_zcl_tunnel_io_param_s |
struct | zb_zcl_tunnel_io_slot_s |
struct | zb_zcl_tunnel_io_slot_continue_s |
struct | zb_zcl_tunnel_context_s |
Macros | |
#define | ZB_ZCL_TUNNEL_TIMEOUT (10*ZB_TIME_ONE_SECOND) |
#define | ZB_ZCL_TUNNEL_MAX_IO_SLOT_NUMBER 16 |
Maximum slots for send/receive data. | |
#define | ZB_ZCL_TUNNEL_IO_SLOT_UNKNOWN 0xff |
Not slots index. | |
Typedefs | |
typedef struct zb_zcl_tunnel_io_slot_s | zb_zcl_tunnel_io_slot_t |
typedef struct zb_zcl_tunnel_io_slot_continue_s | zb_zcl_tunnel_io_slot_continue_t |
typedef struct zb_zcl_tunnel_context_s | zb_zcl_tunnel_context_t |
Functions | |
zb_ret_t | zb_zcl_tunnel_transfer_data_req_handler (zb_uint8_t buf_param) |
zb_ret_t | zb_zcl_tunnel_transfer_data_resp_handler (zb_uint8_t buf_param) |
zb_void_t | zb_zcl_tunnel_transfer_data_resp_send (zb_uint8_t param, zb_uint16_t endpoint16) |
zb_void_t | zb_zcl_tunnel_send_fist_block (zb_uint8_t param, zb_uint16_t index16) |
zb_void_t | zb_zcl_tunnel_timeout (zb_uint8_t index) |
zb_void_t | zb_zcl_tunnel_invoke_user_app (zb_uint8_t param) |
zb_ret_t | zb_zcl_process_tunnel_default_response_commands (zb_uint8_t param) |
zb_uint8_t | zb_zcl_process_tunnel_specific_commands (zb_uint8_t param) |
Manufacture specific cluster for transmit custom data between peers Model: One (client) to More (servers) Usually a device has MIXED role
#define ZB_ZCL_TUNNEL_GET_TRANSFER_REQ | ( | _data_ptr, | |
_buffer, | |||
_status | |||
) |
Macro for getting Send Transfer Data command.
_data_ptr | - pointer to a variable of type zb_zcl_tunnel_transfer_data_internal_t. |
_buffer | containing the packet (by pointer). |
_status | - variable to put parse status to (see zb_zcl_parse_status_t). |
NOTE file data place`s in buffer, payload saves pointer to data only!
#define ZB_ZCL_TUNNEL_GET_TRANSFER_RESP | ( | _data_ptr, | |
_buffer, | |||
_status | |||
) |
Macro for getting Send Transfer Data response command.
_data_ptr | - pointer to a variable of type zb_zcl_tunnel_transfer_data_resp_t. |
_buffer | containing the packet (by pointer). |
_status | - variable to put parse status to (see zb_zcl_parse_status_t). |
#define ZB_ZCL_TUNNEL_SEND_TRANSFER_REQ | ( | _buffer, | |
_addr, | |||
_dst_addr_mode, | |||
_dst_ep, | |||
_ep, | |||
_prfl_id, | |||
_def_resp, | |||
_cb, | |||
_manufacturer_id, | |||
_flag, | |||
_byte_num, | |||
_data_size, | |||
_image_data | |||
) |
Send Transfer Data 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 |
_cb | - callback for getting command send status |
_manufacturer_id | - Manufacturer code |
_flag | - command flag, see zb_zcl_tunnel_tx_flags_e |
_byte_num | - all transfer length or current offset, see zb_zcl_tunnel_transfer_data_header_t |
_data_size | - data size |
_image_data | - image data |
#define ZB_ZCL_TUNNEL_SEND_TRANSFER_RESP | ( | _buffer, | |
_addr, | |||
_dst_addr_mode, | |||
_dst_ep, | |||
_ep, | |||
_prfl_id, | |||
_seq, | |||
_cb, | |||
_manufacturer_id, | |||
_tun_status | |||
) |
Send Transfer Data response 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 |
_seq | - request sequence |
_cb | - callback for getting command send status |
_manufacturer_id | - Manufacturer code |
_tun_status | - command status, see zb_zcl_tunnel_status_e |
typedef void( * zb_zcl_tunnel_cb_t)(zb_uint8_t param) |
Callback to inform user about tx operation status or rx data;
- | param is reference to a buffer; zb_zcl_tunnel_io_param_t is stored as buffer parameter |
typedef struct zb_zcl_tunnel_io_param_s zb_zcl_tunnel_io_param_t |
structure to pass parameters for data i/o Save in first of each buffer
typedef struct zb_zcl_tunnel_io_slot_continue_s zb_zcl_tunnel_io_slot_continue_t |
struct for next buffer in multi-buffer chain
typedef struct zb_zcl_tunnel_op_status_s zb_zcl_tunnel_op_status_t |
Tunnel operation status
typedef enum zb_zcl_tunnel_status_e zb_zcl_tunnel_status_t |
Tunnel status; range: 0x00 - 0x3F (6 bit value)
enum zb_zcl_tunnel_cmd_e |
Tunnel status; range: 0x00 - 0x3F (6 bit value)
zb_void_t zb_zcl_tunnel_default_user_app | ( | zb_uint8_t | param | ) |
Default user application Contain default handle (usually free buffer) for different Tunnel Status command
zb_void_t zb_zcl_tunnel_init | ( | zb_uint16_t | manuf_id | ) |
Init CTX data table
manuf_id | - manufacturer ID |
zb_void_t zb_zcl_tunnel_register_cb | ( | zb_zcl_tunnel_cb_t | tunnel_cb | ) |
Register user callback
zb_ret_t zb_zcl_tunnel_transmit_data | ( | zb_uint8_t | buf_param | ) |
Start user data transmit. buf_param is a reference to a buffer; zb_zcl_tunnel_io_param_t is stored as a buffer parameter; data to be transmitted is stored as buffer data