nRF5 SDK for Thread and Zigbee v1.0.0
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
ZLL Commissioning cluster

Data Structures

struct  zb_zll_commissioning_scan_req_s
 Parsed Scan request payload representation. More...
 
struct  zb_zll_commissioning_ep_info_s
 Endpoint information for parsed ZLL.Commissioning.ScanResponse representation. More...
 
struct  zb_zll_commissioning_scan_res_s
 Parsed ZLL.Commissioning.ScanResponse structure. More...
 
struct  zb_zll_commissioning_device_information_req_s
 Parsed ZLL.Commissioning.DeviceInformationRequest payload. More...
 
struct  zb_zll_commissioning_device_information_common_res_s
 Parsed permanent part of the ZLL.Commissioning.DeviceInformationResponse payload. More...
 
struct  zb_zll_commissioning_device_information_ep_info_res_s
 Parsed device information record from the ZLL.Commissioning.DeviceInformationResponse payload. More...
 
struct  zb_zll_commissioning_identify_req_s
 Parsed ZLL.Commissioning.IdentifyRequest payload. More...
 
struct  zb_zll_commissioning_identify_req_param_s
 Identify request parameters. More...
 
struct  zb_zll_commissioning_reset_to_fn_s
 Parsed ZLL.Commissioning.ResetToFactoryNewRequest payload. More...
 
struct  zb_zll_commissioning_network_start_req_s
 Parsed ZLL.Commissioning.NetworkStartRequest payload. More...
 
struct  zb_zll_commissioning_network_start_res_s
 Parsed ZLL.Commissioning.NetworkStartResponse payload. More...
 
struct  zb_zll_start_new_nwk_param_s
 Start new network function parameters representation. More...
 
struct  zb_zll_commissioning_network_join_router_req_s
 Parsed ZLL.Commissioning.NetworkJoinRouterRequest payload. More...
 
struct  zb_zll_commissioning_network_join_router_res_s
 Parsed ZLL.Commissioning.NetworkJoinRouterResponse payload. More...
 
struct  zb_zll_commissioning_network_join_end_device_req_s
 Parsed ZLL.Commissioning.NetworkJoinEndDeviceRequest payload. More...
 
struct  zb_zll_commissioning_network_join_end_device_res_s
 Parsed ZLL.Commissioning.NetworkJoinEndDeviceResponse payload. More...
 
struct  zb_zll_commissioning_network_update_req_s
 Parsed ZLL.Commissioning.NetworkUpdateRequest payload. More...
 
struct  zb_zll_commissioning_get_group_ids_req_s
 Parsed ZLL.Commissioning.GetGroupIdentifiersRequest payload. More...
 
struct  zb_zll_commissioning_get_group_ids_res_permanent_s
 Parsed ZLL.Commissioning.GetGroupIdentifiersResponse payload. More...
 
struct  zb_zll_commissioning_group_info_record_s
 Group information record for ZLL.Commissioning.GetGroupIdentifiersResponse command. More...
 
struct  zb_zll_commissioning_get_endpoint_list_req_s
 Parsed ZLL.Commissioning.GetEndpointListRequest payload. More...
 
struct  zb_zll_commissioning_get_endpoint_list_res_s
 Parsed ZLL.Commissioning.GetEndpointListResponse payload. More...
 
struct  zb_zll_commissioning_endpoint_info_record_s
 Endpoint information record for ZLL.Commissioning.GetEndpointListResponse command. More...
 
struct  zb_zll_commissioning_endpoint_information_s
 Parsed ZLL.Commissioning.EndpointInformation payload. More...
 
struct  zb_zll_transaction_task_status_s
 Transaction task status report structure. More...
 
struct  zb_zll_device_discovery_req_s
 Device discovery request parameters. More...
 
struct  zb_zll_join_router_param_s
 Join router request parameters. More...
 
struct  zb_zll_join_end_device_param_s
 Join end device parameters representation. More...
 

Functions

zb_int8_t zll_find_device_info_by_max_rssi (zb_bool_t route_only)
 Find device index with max rssi from device_infos table. More...
 
zb_uint8_t zll_find_device_ep_by_short_addr (zb_uint16_t addr)
 
zb_int_t zll_get_ep_info (zb_int_t i, zb_uint16_t *addr, zb_uint8_t *ep)
 
zb_void_t zll_network_start_continue (zb_uint8_t param)
 
zb_void_t zll_save_nwk_prefs (zb_ext_pan_id_t ext_pan_id, zb_uint16_t pan_id, zb_uint16_t short_addr, zb_uint8_t channel)
 

Commissioning cluster internals

Internal structures for Commissioning cluster

enum  zb_zll_general_status_e { ZB_ZLL_GENERAL_STATUS_SUCCESS, ZB_ZLL_GENERAL_STATUS_FAILURE }
 ZLL general status is used in different commissioning response command frames. More...
 
typedef enum
zb_zll_general_status_e 
zb_zll_general_status_t
 ZLL general status is used in different commissioning response command frames.
 
zb_ret_t zb_zll_send_packet (zb_buf_t *buffer, zb_uint8_t *data_ptr, zb_ieee_addr_t dsr_addr_long, zb_callback_t callback)
 Finish packet and send it to the designated IEEE address. More...
 
#define ZB_ZLL_PRIMARY_CHANNEL_MASK   ((1l << 11) | (1l << 15) | (1l << 20) | (1l << 25))
 First primary ZLL channels mask.
 
#define ZB_ZLL_MIN_ADDR_RANGE   100
 Configurable parameters: minimum address range that maybe assigned during commissioning.
 
#define ZB_ZLL_DEFAULT_ADDR_RANGE   1000
 Configurable parameters: default address range that is assigned during commissioning.
 
#define ZB_ZLL_MIN_GROUP_ID_RANGE   100
 Configurable parameters: minimum group id range that maybe assigned during commissioning.
 
#define ZB_ZLL_DEFAULT_GROUP_ID_RANGE   1000
 Configurable parameters: default group id range that is assigned during commissioning.
 
#define ZB_ZLL_SEND_PACKET(buffer, data_ptr, dst_addr_long, callback)   zb_zll_send_packet(buffer, data_ptr, dst_addr_long, callback)
 

Commissioning cluster commands

enum  zb_zll_commissioning_touchlink_cmd_e {
  ZB_ZLL_CMD_COMMISSIONING_SCAN_REQ = 0x00, ZB_ZLL_CMD_COMMISSIONING_DEVICE_INFORMATION_REQ = 0x02, ZB_ZLL_CMD_COMMISSIONING_IDENTIFY_REQ = 0x06, ZB_ZLL_CMD_COMMISSIONING_RESET_TO_FACTORY_NEW_REQ = 0x07,
  ZB_ZLL_CMD_COMMISSIONING_NETWORK_START_REQ = 0x10, ZB_ZLL_CMD_COMMISSIONING_NETWORK_JOIN_ROUTER_REQ = 0x12, ZB_ZLL_CMD_COMMISSIONING_NETWORK_JOIN_END_DEVICE_REQ = 0x14, ZB_ZLL_CMD_COMMISSIONING_NETWORK_UPDATE_REQ = 0x16
}
 Commissioning cluster touchlink command identifiers. More...
 
enum  zb_zll_commissioning_utility_cmd_e { ZB_ZLL_CMD_COMMISSIONING_GET_GROUP_IDENTIFIERS_REQUEST = 0x41, ZB_ZLL_CMD_COMMISSIONING_GET_ENDPOINT_LIST_REQUEST = 0x42 }
 Commissioning cluster utility command identifiers. More...
 
enum  zb_zll_commissioning_touchlink_cmd_resp_e {
  ZB_ZLL_CMD_COMMISSIONING_SCAN_RES = 0x01, ZB_ZLL_CMD_COMMISSIONING_DEVICE_INFORMATION_RES = 0x03, ZB_ZLL_CMD_COMMISSIONING_NETWORK_START_RES = 0x11, ZB_ZLL_CMD_COMMISSIONING_NETWORK_JOIN_ROUTER_RES = 0x13,
  ZB_ZLL_CMD_COMMISSIONING_NETWORK_JOIN_END_DEVICE_RES = 0x15
}
 Commissioning cluster touchlink response command identifiers. More...
 
enum  zb_zll_commissioning_utility_cmd_resp_e { ZB_ZLL_CMD_COMMISSIONING_ENDPOINT_INFORMATION = 0x40, ZB_ZLL_CMD_COMMISSIONING_GET_GROUP_IDENTIFIERS_RESPONSE = 0x41, ZB_ZLL_CMD_COMMISSIONING_GET_ENDPOINT_LIST_RESPONSE = 0x42 }
 Commissioning cluster utility response command identifiers. More...
 
enum  zb_zll_task_status_e {
  ZB_ZLL_TASK_STATUS_OK = 0, ZB_ZLL_TASK_STATUS_TIMED_OUT, ZB_ZLL_TASK_STATUS_SCHEDULE_FAILED, ZB_ZLL_TASK_STATUS_SCHEDULED,
  ZB_ZLL_TASK_STATUS_NO_CALLBACK, ZB_ZLL_TASK_STATUS_FINISHED, ZB_ZLL_TASK_STATUS_FAILED, ZB_ZLL_TASK_STATUS_WRONG_SIDE,
  ZB_ZLL_TASK_STATUS_NETWORK_UPDATED
}
 Possible values of transaction task status.
 
typedef struct
zb_zll_commissioning_scan_req_s 
zb_zll_commissioning_scan_req_t
 Parsed Scan request payload representation. More...
 
typedef struct
zb_zll_commissioning_ep_info_s 
zb_zll_commissioning_ep_info_t
 Endpoint information for parsed ZLL.Commissioning.ScanResponse representation.
 
typedef struct
zb_zll_commissioning_scan_res_s 
zb_zll_commissioning_scan_res_t
 Parsed ZLL.Commissioning.ScanResponse structure. More...
 
typedef struct
zb_zll_commissioning_device_information_req_s 
zb_zll_commissioning_device_information_req_t
 Parsed ZLL.Commissioning.DeviceInformationRequest payload. More...
 
typedef struct
zb_zll_commissioning_device_information_common_res_s 
zb_zll_commissioning_device_information_common_res_t
 Parsed permanent part of the ZLL.Commissioning.DeviceInformationResponse payload. More...
 
typedef struct
zb_zll_commissioning_device_information_ep_info_res_s 
zb_zll_commissioning_device_information_ep_info_res_t
 Parsed device information record from the ZLL.Commissioning.DeviceInformationResponse payload. More...
 
typedef struct
zb_zll_commissioning_identify_req_s 
zb_zll_commissioning_identify_req_t
 Parsed ZLL.Commissioning.IdentifyRequest payload. More...
 
typedef struct
zb_zll_commissioning_identify_req_param_s 
zb_zll_commissioning_identify_req_param_t
 Identify request parameters.
 
typedef struct
zb_zll_commissioning_reset_to_fn_s 
zb_zll_commissioning_reset_to_fn_t
 Parsed ZLL.Commissioning.ResetToFactoryNewRequest payload. More...
 
typedef struct
zb_zll_commissioning_network_start_req_s 
zb_zll_commissioning_network_start_req_t
 Parsed ZLL.Commissioning.NetworkStartRequest payload. More...
 
typedef struct
zb_zll_commissioning_network_start_res_s 
zb_zll_commissioning_network_start_res_t
 Parsed ZLL.Commissioning.NetworkStartResponse payload. More...
 
typedef struct
zb_zll_start_new_nwk_param_s 
zb_zll_start_new_nwk_param_t
 Start new network function parameters representation.
 
typedef struct
zb_zll_commissioning_network_join_router_req_s 
zb_zll_commissioning_network_join_router_req_t
 Parsed ZLL.Commissioning.NetworkJoinRouterRequest payload. More...
 
typedef struct
zb_zll_commissioning_network_join_router_res_s 
zb_zll_commissioning_network_join_router_res_t
 Parsed ZLL.Commissioning.NetworkJoinRouterResponse payload. More...
 
typedef struct
zb_zll_commissioning_network_join_end_device_req_s 
zb_zll_commissioning_network_join_end_device_req_t
 Parsed ZLL.Commissioning.NetworkJoinEndDeviceRequest payload. More...
 
typedef struct
zb_zll_commissioning_network_join_end_device_res_s 
zb_zll_commissioning_network_join_end_device_res_t
 Parsed ZLL.Commissioning.NetworkJoinEndDeviceResponse payload. More...
 
typedef struct
zb_zll_commissioning_network_update_req_s 
zb_zll_commissioning_network_update_req_t
 Parsed ZLL.Commissioning.NetworkUpdateRequest payload. More...
 
typedef struct
zb_zll_commissioning_get_group_ids_req_s 
zb_zll_commissioning_get_group_ids_req_t
 Parsed ZLL.Commissioning.GetGroupIdentifiersRequest payload. More...
 
typedef struct
zb_zll_commissioning_get_group_ids_res_permanent_s 
zb_zll_commissioning_get_group_ids_res_permanent_t
 Parsed ZLL.Commissioning.GetGroupIdentifiersResponse payload. More...
 
typedef struct
zb_zll_commissioning_group_info_record_s 
zb_zll_commissioning_group_info_record_t
 Group information record for ZLL.Commissioning.GetGroupIdentifiersResponse command. More...
 
typedef struct
zb_zll_commissioning_get_endpoint_list_req_s 
zb_zll_commissioning_get_endpoint_list_req_t
 Parsed ZLL.Commissioning.GetEndpointListRequest payload. More...
 
typedef struct
zb_zll_commissioning_get_endpoint_list_res_s 
zb_zll_commissioning_get_endpoint_list_res_t
 Parsed ZLL.Commissioning.GetEndpointListResponse payload. More...
 
typedef struct
zb_zll_commissioning_endpoint_info_record_s 
zb_zll_commissioning_endpoint_info_record_t
 Endpoint information record for ZLL.Commissioning.GetEndpointListResponse command. More...
 
typedef struct
zb_zll_commissioning_endpoint_information_s 
zb_zll_commissioning_endpoint_information_t
 Parsed ZLL.Commissioning.EndpointInformation payload. More...
 
typedef struct
zb_zll_transaction_task_status_s 
zb_zll_transaction_task_status_t
 Transaction task status report structure.
 
typedef struct
zb_zll_device_discovery_req_s 
zb_zll_device_discovery_req_t
 Device discovery request parameters.
 
typedef struct
zb_zll_join_router_param_s 
zb_zll_join_router_param_t
 Join router request parameters.
 
typedef struct
zb_zll_join_end_device_param_s 
zb_zll_join_end_device_param_t
 Join end device parameters representation.
 
zb_void_t zb_zll_commissioning_send_scan_req (zb_buf_t *buffer, zb_callback_t callback)
 Schedules ZLL.Commissioning.ScanRequest sending. More...
 
zb_ret_t zb_zll_identify (zb_uint8_t param)
 Sets up Identify request and schedules it for sending. Checks transaction state, identify period acceptability, fills in and schedules for sending command packet. More...
 
zb_ret_t zb_zll_start_new_network (zb_uint8_t param)
 
zb_void_t zb_zll_start_device_discovery (zb_uint8_t param)
 Starts device discovery. More...
 
zb_void_t zb_zll_join_router (zb_uint8_t param)
 Perform Join router commissioning. More...
 
zb_void_t zb_zll_join_ed (zb_uint8_t param)
 Perform Join end device commissioning. More...
 
zb_ret_t zb_zll_start_commissioning (zb_uint8_t param)
 Perform Start commissioning. More...
 
zb_void_t zll_add_device_to_network (zb_uint8_t param)
 Perform Add device to netwiork. More...
 
#define ZB_ZLL_ZB_INFO_CURRENT_VALUE()
 
#define ZB_ZLL_DEVICE_INFO_GET_FACTORY_NEW(zll_info)   ((zll_info) & ZB_ZLL_INFO_FACTORY_NEW)
 Check is ZLL device factory new.
 
#define ZB_ZLL_IS_FACTORY_NEW()   (ZB_ZLL_DEVICE_INFO_GET_FACTORY_NEW(ZLL_DEVICE_INFO().zll_info))
 Check is current ZLL device factory new.
 
#define ZB_ZLL_SET_FACTORY_NEW()   (ZLL_DEVICE_INFO().zll_info |= ZB_ZLL_INFO_FACTORY_NEW)
 Set current ZLL device is factory new.
 
#define ZB_ZLL_CLEAR_FACTORY_NEW()   (ZLL_DEVICE_INFO().zll_info &= ~ZB_ZLL_INFO_FACTORY_NEW)
 Set current ZLL device is not factory new.
 
#define ZB_ZLL_DEVICE_INFO_GET_ADDR_ASSIGNMENT(zll_info)   ((zll_info) & ZB_ZLL_INFO_ADDR_ASSIGNMENT)
 Check is ZLL device capable of address assignment.
 
#define ZB_ZLL_IS_ADDR_ASSIGNMENT()   (ZB_ZLL_DEVICE_INFO_GET_ADDR_ASSIGNMENT(ZLL_DEVICE_INFO().zll_info))
 Check is current ZLL device capable of address assignment.
 
#define ZB_ZLL_DEVICE_INFO_GET_LINK_INITIATOR(zll_info)   ((zll_info) & ZB_ZLL_INFO_TOUCHLINK_INITIATOR)
 Check is ZLL device a link initiator.
 
#define ZB_ZLL_IS_LINK_INITIATOR()   (ZB_ZLL_DEVICE_INFO_GET_LINK_INITIATOR(ZLL_DEVICE_INFO().zll_info))
 Check is current ZLL device a link initiator.
 
#define ZB_ZLL_COMMISSIONING_SEND_SCAN_REQ(buffer, callback)   zb_zll_commissioning_send_scan_req(buffer, callback)
 
#define ZB_ZLL_COMMISSIONING_GET_SCAN_REQ(data_ptr, buffer, status)
 Parses ZLL.Commissioning.ScanRequest payload. More...
 
#define ZB_ZLL_COMMISSIONING_SEND_SCAN_RES(buffer,seq_num,callback,status)
 Schedules ZLL.Commissioning.ScanResponse sending. More...
 
#define ZB_ZLL_COMMISSIONING_GET_SCAN_RES(data_ptr, buffer, status)
 Parses ZLL.Commissioning.ScanResponse. More...
 
#define ZB_ZLL_COMMISSIONING_SEND_DEVICE_INFO_REQ(buffer,start_index,dst_addr,callback,status)
 Schedules sending ZLL.Commissioning.DeviceInformationRequest command. More...
 
#define ZB_ZLL_COMMISSIONING_GET_DEVICE_INFO_REQ(data_ptr, buffer, status)
 Parses ZLL.Commissioning.DeviceInformationRequest. More...
 
#define ZB_ZLL_COMMISSIONING_DEVICE_INFO_MAX_RECORDS   0x05
 Maximum number of device information records in the response.
 
#define ZB_ZLL_COMMISSIONING_INIT_DEVICE_INFO_RES(buffer,data_ptr,tsn,start_index,n_devs_reported)
 Starts filling in ZLL.Commissioning.DeviceInformationResponse command. More...
 
#define ZB_ZLL_COMMISSIONING_ADD_EP_INFO_DEVICE_INFO_RES(data_ptr,ep_id_,profile,device,version_,n_group_ids,sort_)
 Add next device information record into ZLL.Commissioning.DeviceInformationResponse. More...
 
#define ZB_ZLL_COMMISSIONING_SEND_DEVICE_INFO_RES(buffer, data_ptr, dst_addr, callback, status)   (status) = ZB_ZLL_SEND_PACKET(buffer, data_ptr, dst_addr, callback)
 Schedules ZLL.Commissioning.DeviceInformationResponse for sending. More...
 
#define ZB_ZLL_COMMISSIONING_GET_DEVICE_INFO_RES(data_ptr, buffer, status)
 Parses ZLL.Commissioning.DeviceInformationResponse permanent part. More...
 
#define ZB_ZLL_COMMISSIONING_GET_NEXT_EP_INFO_DEVICE_INFO_RES(data_ptr, buffer, status)
 
#define ZB_ZLL_COMMISSIONING_SEND_IDENTIFY_REQ(buffer,p_identify_duration,ieee_addr,callback,status)
 Schedules sending ZLL.Commissioning.IdentifyRequest command. More...
 
#define ZB_ZLL_COMMISSIONING_GET_IDENTIFY_REQ(data_ptr, buffer, status)
 Parses ZLL.Commissioning.IdentifyRequest. More...
 
#define ZB_ZLL_IDENTIFY_STOP   0
 "Exit identify mode" constant for Identify request.
 
#define ZB_ZLL_IDENTIFY_DEFAULT_TIME   0xffff
 "Identify for default period" constant for Identify request.
 
#define ZB_ZLL_COMMISSIONING_FILL_IDENTIFY_REQ(buffer, address, period, status)
 Fills in appropriate structures and starts identify request sending process. More...
 
#define ZB_ZLL_COMMISSIONING_GET_IDENTIFY_REQ_PARAM(data_ptr, buffer)
 Extract Identify request parameters from the buffer. More...
 
#define ZB_ZLL_COMMISSIONING_SEND_RESET_TO_FN_REQ(buffer,dst_addr,callback,status)
 Schedules sending ZLL.Commissioning.ResetToFactoryNewRequest command. More...
 
#define ZB_ZLL_COMMISSIONING_GET_RESET_TO_FN_REQ(data_ptr, buffer, status)
 Parses ZLL.Commissioning.ResetToFactoryNewRequest. More...
 
#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_START_REQ(buffer,ext_pan_id_,key_index,encrypted_nwk_key,logical_channel,pan_id_,nwk_addr,grp_ids_begin,grp_ids_end,free_nwk_addrs_begin_,free_nwk_addrs_end_,free_group_ids_begin_,free_group_ids_end_,dst_addr,callback,status)
 Schedules sending ZLL.Commissioning.NetworkStartRequest command. More...
 
#define ZB_ZLL_COMMISSIONING_GET_NETWORK_START_REQ(data_ptr, buffer, status)
 Parses ZLL.Commissioning.NetworkStartRequest. More...
 
#define ZB_ZLL_NETWORK_UPDATE_ID   ((zb_uint8_t)0)
 The only acceptable value for network update identifier field in the network start response. More...
 
#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_START_RES(buffer,seq_num,nwk_status,ext_pan_id_,pan_id_,channel_,dst_addr,callback,status_)
 Schedules ZLL.Commissioning.NetworkStartResponse sending. More...
 
#define ZB_ZLL_COMMISSIONING_GET_NETWORK_START_RES(data_ptr, buffer, op_status)
 Parses ZLL.Commissioning.NetworkStartResponse. More...
 
#define ZB_ZLL_START_NEW_NETWORK(buffer, panid, ext_panid, channel_index, dest_addr, status)
 Requests a target to start a new network. More...
 
#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ROUTER_REQ(buffer,key_index,encrypted_nwk_key,nwk_addr,grp_ids_begin,grp_ids_end,free_nwk_addrs_begin_,free_nwk_addrs_end_,free_group_ids_begin_,free_group_ids_end_,dst_addr,callback,status)
 Schedules sending ZLL.Commissioning.NetworkJoinRouterRequest command. More...
 
#define ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ROUTER_REQ(data_ptr, buffer, status)
 Parses ZLL.Commissioning.NetworkJoinRouterRequest. More...
 
#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ROUTER_RES(buffer,nwk_status,tsn,dst_addr,callback,status)
 Schedules sending ZLL.Commissioning.NetworkJoinRouterResponse command. More...
 
#define ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ROUTER_RES(data_ptr, buffer, op_status)
 Parses ZLL.Commissioning.NetworkJoinRouterResponse. More...
 
#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ED_REQ(buffer,key_index,encrypted_nwk_key,logical_channel,nwk_addr,grp_ids_begin,grp_ids_end,free_nwk_addrs_begin_,free_nwk_addrs_end_,free_group_ids_begin_,free_group_ids_end_,dst_addr,callback,status)
 Schedules sending ZLL.Commissioning.NetworkJoinEndDeviceRequest command. More...
 
#define ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ED_REQ(data_ptr, buffer, status)
 Parses ZLL.Commissioning.NetworkJoinEndDeviceRequest. More...
 
#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ED_RES(buffer,nwk_status,tsn,dst_addr,callback,status)
 Schedules sending ZLL.Commissioning.NetworkJoinEndDeviceResponse command. More...
 
#define ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ED_RES(data_ptr, buffer, op_status)
 Parses ZLL.Commissioning.NetworkJoinEndDeviceResponse. More...
 
#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_UPDATE_REQ_WITH_CHANNEL(buffer_,nwk_addr_,dst_addr_,channel_,callback_,status_)
 Schedules sending ZLL.Commissioning.NetworkUpdateRequest command. More...
 
#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_UPDATE_REQ(buffer_,nwk_addr_,dst_addr_,callback_,status_)
 Schedules sending ZLL.Commissioning.NetworkUpdateRequest command. (send command with current value of channel from pib cache) More...
 
#define ZB_ZLL_COMMISSIONING_GET_NETWORK_UPDATE_REQ(data_ptr, buffer, status)
 Parses ZLL.Commissioning.NetworkUpdateRequest. More...
 
#define ZB_ZLL_COMMISSIONING_SEND_GET_GROUP_ID_REQ(buffer,start_index,dst_addr,dst_ep,ep,callback)
 Schedules sending ZLL.Commissioning.GetGroupIdentifiersRequest command. More...
 
#define ZB_ZLL_COMMISSIONING_GET_GET_GROUP_ID_REQ(data_ptr, buffer, status)
 Parses ZLL.Commissioning.GetGroupIdentifiersRequest. More...
 
#define ZB_ZLL_COMMISSIONING_GROUP_INFO_GROUP_TYPE_VALUE   0x00
 Group type value for group_type field of zb_zll_commissioning_group_info_record_s. More...
 
#define ZB_ZLL_COMMISSIONING_INIT_GET_GROUP_ID_RES(buffer,data_ptr,total_,start_index,count_,tsn)
 Fills in mandatory part of ZLL.Commissioning.GetGroupIdentifiersResponse payload. More...
 
#define ZB_ZLL_COMMISSIONING_ADD_GROUP_INFO_GET_GROUP_ID_RES(data_ptr, grp_id, grp_type)
 
#define ZB_ZLL_COMMISSIONING_SEND_GET_GROUP_ID_RES(buffer,data_ptr,addr,dst_ep,ep,callback)
 
#define ZB_ZLL_COMMISSIONING_GET_GET_GROUP_ID_RES(data_ptr, buffer, status)
 Parses permanent part of ZLL.Commissioning.GetGroupIdentifiersResponse. More...
 
#define ZB_ZLL_COMMISSIONING_GET_NEXT_GROUP_INFO_GET_GROUP_ID_RES(data_ptr, buffer, status)
 Extracts next group information record from ZLL.Commissioning.GetGroupIdentifiersResponse. More...
 
#define ZB_ZLL_COMMISSIONING_SEND_GET_EP_LIST_REQ(buffer,start_index,addr,dst_ep,ep,callback)
 Schedules sending ZLL.Commissioning.GetEndpointListRequest command. More...
 
#define ZB_ZLL_COMMISSIONING_GET_GET_EP_LIST_REQ(data_ptr, buffer, status)
 Parses ZLL.Commissioning.GetEndpointListRequest. More...
 
#define ZB_ZLL_COMMISSIONING_INIT_GET_EP_LIST_RES(buffer,total_,start_index,count_,tsn,data_ptr)
 Fills in mandatory part of ZLL.Commissioning.GetGroupIdentifiersResponse payload. More...
 
#define ZB_ZLL_COMMISSIONING_ADD_EP_INFO_GET_EP_LIST_RES(data_ptr,addr,ep,profile,device,version_id)
 
#define ZB_ZLL_COMMISSIONING_SEND_GET_EP_LIST_RES(buffer,data_ptr,dst_addr,dst_ep,ep,callback)
 
#define ZB_ZLL_COMMISSIONING_GET_GET_EP_LIST_RES(data_ptr, buffer, status)
 Parses permanent part of ZLL.Commissioning.GetEndpointListResponse. More...
 
#define ZB_ZLL_COMMISSIONING_GET_NEXT_EP_INFO_GET_EP_LIST_RES(data_ptr, buffer, status)
 Extracts next endpoint information record from ZLL.Commissioning.GetEndpointListResponse. More...
 
#define ZB_ZLL_COMMISSIONING_SEND_EP_INFO(buffer,endpoint_id,profile,device,version_,dst_addr,dst_ep,ep,callback)
 Schedules sending ZLL.Commissioning.EndpointInformation command. More...
 
#define ZB_ZLL_COMMISSIONING_GET_EP_INFO(data_ptr, buffer, status)
 Parses ZLL.Commissioning.EndpointInformation. More...
 
#define ZB_ZLL_START_DEVICE_DISCOVERY(buffer, extended_scan, callback, status)
 Fills in device discovery request and schedules device discovery process for execution. More...
 
#define ZB_ZLL_JOIN_ROUTER(buffer, dev_index, callback, status)
 Fills in parameters for Join router and schedules it for execution. More...
 
#define ZB_ZLL_JOIN_ED(buffer, dev_index, callback, status)
 Fills in parameters for Join end device and schedules it for execution. More...
 

Detailed Description

ZLL Commissioning cluster definitions

Macro Definition Documentation

#define ZB_ZLL_COMMISSIONING_ADD_EP_INFO_DEVICE_INFO_RES (   data_ptr,
  ep_id_,
  profile,
  device,
  version_,
  n_group_ids,
  sort_ 
)
Value:
{ \
ZB_IEEE_ADDR_COPY(req_data->ieee_addr, ZB_PIBCACHE_EXTENDED_ADDRESS()); \
req_data->ep_id = (ep_id_); \
ZB_HTOLE16_VAL(&(req_data->profile_id), (profile)); \
ZB_HTOLE16_VAL(&(req_data->device_id), (device)); \
req_data->version = (version_); \
req_data->group_id_count = (n_group_ids); \
req_data->sort = (sort_); \
}
struct zb_zll_commissioning_device_information_ep_info_res_s zb_zll_commissioning_device_information_ep_info_res_t
Parsed device information record from the ZLL.Commissioning.DeviceInformationResponse payload...
#define ZB_PIBCACHE_EXTENDED_ADDRESS()
Definition: zboss_api_nwk.h:175
Parsed device information record from the ZLL.Commissioning.DeviceInformationResponse payload...
Definition: zb_zll_commissioning.h:512

Add next device information record into ZLL.Commissioning.DeviceInformationResponse.

Parameters
data_ptr[IN] - pointer to contain address right after the added record's tail.
ep_id_[IN] - endpoint identifier of the sub-device.
profile[IN] - profile identifier of the sub-device.
device[IN] - device identifier.
version_[IN] of the device.
n_group_ids[IN] - group identifier count.
sort_[IN] - endpoint info sort flag.
Attention
According to ZLL spec, Device Information Response frame can contain not more than 5 device information records. Caller should check this condition.
#define ZB_ZLL_COMMISSIONING_ADD_EP_INFO_GET_EP_LIST_RES (   data_ptr,
  addr,
  ep,
  profile,
  device,
  version_id 
)
Value:
{ \
ZB_HTOLE16_VAL(&(res_data->addr_shart), (addr)); \
res_data->endpoint = (ep); \
ZB_HTOLE16_VAL(&(res_data->profile_id), (profile)); \
ZB_HTOLE16_VAL(&(res_data->device_id), (device)); \
res_data->version = (version_id); \
}
Endpoint information record for ZLL.Commissioning.GetEndpointListResponse command.
Definition: zb_zll_commissioning.h:1832
Parsed ZLL.Commissioning.GetEndpointListResponse payload.
Definition: zb_zll_commissioning.h:1822
struct zb_zll_commissioning_endpoint_info_record_s zb_zll_commissioning_endpoint_info_record_t
Endpoint information record for ZLL.Commissioning.GetEndpointListResponse command.
#define ZB_ZLL_COMMISSIONING_ADD_GROUP_INFO_GET_GROUP_ID_RES (   data_ptr,
  grp_id,
  grp_type 
)
Value:
{ \
ZB_ZCL_PACKET_PUT_DATA16((data_ptr), (grp_id)); \
ZB_ZCL_PACKET_PUT_DATA8((data_ptr), (grp_type)); \
}
#define ZB_ZCL_PACKET_PUT_DATA8(ptr, val)
Put 8 bit value to packet.
Definition: zb_zcl_common.h:1273
#define ZB_ZCL_PACKET_PUT_DATA16(ptr, val)
Definition: zb_zcl_common.h:1280
#define ZB_ZLL_COMMISSIONING_FILL_IDENTIFY_REQ (   buffer,
  address,
  period,
  status 
)
Value:
{ \
ZB_IEEE_ADDR_COPY(request->dst_addr, (address)); \
request->identify_time = (period); \
(status) = zb_zll_identify(ZB_REF_FROM_BUF((buffer))); \
}
zb_ret_t zb_zll_identify(zb_uint8_t param)
Sets up Identify request and schedules it for sending. Checks transaction state, identify period acce...
Identify request parameters.
Definition: zb_zll_commissioning.h:720
#define ZB_GET_BUF_PARAM(zbbuf, type)
Definition: zboss_api_core.h:920
#define ZB_REF_FROM_BUF(buf)
get buffer reference which can be passed to scheduler callback
Definition: zboss_api_core.h:709
struct zb_zll_commissioning_identify_req_param_s zb_zll_commissioning_identify_req_param_t
Identify request parameters.

Fills in appropriate structures and starts identify request sending process.

Parameters
buffer[IN] - pointer to the buffer to put packet to.
address[IN] - IEEE address of the target device.
period[IN] - time to identify.
status[OUT] - status of the operation.
#define ZB_ZLL_COMMISSIONING_GET_DEVICE_INFO_REQ (   data_ptr,
  buffer,
  status 
)
Value:
{ \
{ \
} \
else \
{ \
ZB_LETOH32(&((data_ptr)->trans_id), &(req_data->trans_id)); \
(data_ptr)->start_idx = req_data->start_idx; \
} \
}
Parsed ZLL.Commissioning.DeviceInformationRequest payload.
Definition: zb_zll_commissioning.h:430
Definition: zb_zcl_common.h:252
#define ZB_BUF_BEGIN(zbbuf)
Definition: zboss_api_core.h:722
#define ZB_BUF_LEN(zbbuf)
Definition: zboss_api_core.h:731
Definition: zb_zcl_common.h:251
struct zb_zll_commissioning_device_information_req_s zb_zll_commissioning_device_information_req_t
Parsed ZLL.Commissioning.DeviceInformationRequest payload.

Parses ZLL.Commissioning.DeviceInformationRequest.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zll_commissioning_device_information_req_s.
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZLL_COMMISSIONING_GET_DEVICE_INFO_RES (   data_ptr,
  buffer,
  status 
)
Value:
{ \
{ \
} \
else \
{ \
ZB_LETOH32(&((data_ptr)->trans_id), &(src_ptr->trans_id)); \
(data_ptr)->n_subdevs = src_ptr->n_subdevs; \
(data_ptr)->start_idx = src_ptr->start_idx; \
(data_ptr)->n_records = src_ptr->n_records; \
ZB_BUF_CUT_LEFT2((buffer), sizeof(zb_zll_commissioning_device_information_common_res_t)); \
} \
}
Definition: zb_zcl_common.h:252
#define ZB_BUF_BEGIN(zbbuf)
Definition: zboss_api_core.h:722
#define ZB_BUF_LEN(zbbuf)
Definition: zboss_api_core.h:731
Definition: zb_zcl_common.h:251
struct zb_zll_commissioning_device_information_common_res_s zb_zll_commissioning_device_information_common_res_t
Parsed permanent part of the ZLL.Commissioning.DeviceInformationResponse payload. ...
Parsed permanent part of the ZLL.Commissioning.DeviceInformationResponse payload. ...
Definition: zb_zll_commissioning.h:494

Parses ZLL.Commissioning.DeviceInformationResponse permanent part.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zll_commissioning_device_information_common_res_s.
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZLL_COMMISSIONING_GET_EP_INFO (   data_ptr,
  buffer,
  status 
)
Value:
{ \
{ \
} \
else \
{ \
ZB_IEEE_ADDR_COPY((data_ptr)->addr_long, src_ptr->addr_long); \
ZB_LETOH16(&((data_ptr)->addr_short), &(src_ptr->addr_short)); \
(data_ptr)->endpoint = src_ptr->endpoint; \
ZB_LETOH16(&((data_ptr)->profile_id), &(src_ptr->profile_id)); \
ZB_LETOH16(&((data_ptr)->device_id), &(src_ptr->device_id)); \
(data_ptr)->version = src_ptr->version; \
} \
}
Definition: zb_zcl_common.h:252
#define ZB_BUF_BEGIN(zbbuf)
Definition: zboss_api_core.h:722
#define ZB_BUF_LEN(zbbuf)
Definition: zboss_api_core.h:731
Definition: zb_zcl_common.h:251
Parsed ZLL.Commissioning.EndpointInformation payload.
Definition: zb_zll_commissioning.h:1966
#define ZB_LETOH16
Definition: zb_types.h:666
struct zb_zll_commissioning_endpoint_information_s zb_zll_commissioning_endpoint_information_t
Parsed ZLL.Commissioning.EndpointInformation payload.

Parses ZLL.Commissioning.EndpointInformation.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zll_commissioning_endpoint_information_s.
buffercontaining the packet (by pointer).
status- status read parameters - see zb_zcl_parse_status_e
#define ZB_ZLL_COMMISSIONING_GET_GET_EP_LIST_REQ (   data_ptr,
  buffer,
  status 
)
Value:
{ \
{ \
} \
else \
{ \
zb_uint8_t* src_ptr = ZB_BUF_BEGIN((buffer)); \
ZB_ZCL_PACKET_GET_DATA8(&((data_ptr)->start_idx), (src_ptr)); \
} \
}
Definition: zb_zcl_common.h:252
#define ZB_BUF_BEGIN(zbbuf)
Definition: zboss_api_core.h:722
#define ZB_ZCL_PACKET_GET_DATA8(dst_ptr, src_ptr)
Get 8-bit value from packet.
Definition: zb_zcl_common.h:1364
#define ZB_BUF_LEN(zbbuf)
Definition: zboss_api_core.h:731
Definition: zb_zcl_common.h:251
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
Parsed ZLL.Commissioning.GetEndpointListRequest payload.
Definition: zb_zll_commissioning.h:1758

Parses ZLL.Commissioning.GetEndpointListRequest.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zll_commissioning_get_endpoint_list_req_s.
status- status read parameters - see zb_zcl_parse_status_e
buffercontaining the packet (by pointer).
#define ZB_ZLL_COMMISSIONING_GET_GET_EP_LIST_RES (   data_ptr,
  buffer,
  status 
)
Value:
{ \
{ \
} \
else \
{ \
ZB_MEMCPY((data_ptr)), src_ptr, sizeof(zb_zll_commissioning_get_endpoint_list_res_t)); \
ZB_BUF_CUT_LEFT2((buffer), sizeof(zb_zll_commissioning_get_endpoint_list_res_t)); \
} \
}
Definition: zb_zcl_common.h:252
#define ZB_BUF_BEGIN(zbbuf)
Definition: zboss_api_core.h:722
#define ZB_BUF_LEN(zbbuf)
Definition: zboss_api_core.h:731
Definition: zb_zcl_common.h:251
struct zb_zll_commissioning_get_endpoint_list_res_s zb_zll_commissioning_get_endpoint_list_res_t
Parsed ZLL.Commissioning.GetEndpointListResponse payload.
Parsed ZLL.Commissioning.GetEndpointListResponse payload.
Definition: zb_zll_commissioning.h:1822

Parses permanent part of ZLL.Commissioning.GetEndpointListResponse.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zll_commissioning_get_endpoint_list_res_s.
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZLL_COMMISSIONING_GET_GET_GROUP_ID_REQ (   data_ptr,
  buffer,
  status 
)
Value:
{ \
{ \
} \
else \
{ \
zb_uint8_t* src_ptr = ZB_BUF_BEGIN((buffer)); \
ZB_ZCL_PACKET_GET_DATA8(&((data_ptr)->start_idx), (src_ptr)); \
} \
}
Definition: zb_zcl_common.h:252
#define ZB_BUF_BEGIN(zbbuf)
Definition: zboss_api_core.h:722
#define ZB_ZCL_PACKET_GET_DATA8(dst_ptr, src_ptr)
Get 8-bit value from packet.
Definition: zb_zcl_common.h:1364
#define ZB_BUF_LEN(zbbuf)
Definition: zboss_api_core.h:731
Definition: zb_zcl_common.h:251
Parsed ZLL.Commissioning.GetGroupIdentifiersRequest payload.
Definition: zb_zll_commissioning.h:1567
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115

Parses ZLL.Commissioning.GetGroupIdentifiersRequest.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zll_commissioning_get_group_ids_req_s.
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZLL_COMMISSIONING_GET_GET_GROUP_ID_RES (   data_ptr,
  buffer,
  status 
)
Value:
{ \
{ \
} \
else \
{ \
ZB_MEMCPY((data_ptr), src_ptr,sizeof(zb_zll_commissioning_get_group_ids_res_permanent_t)); \
ZB_BUF_CUT_LEFT2((buffer), sizeof(zb_zll_commissioning_get_group_ids_res_permanent_t)); \
} \
}
Definition: zb_zcl_common.h:252
#define ZB_BUF_BEGIN(zbbuf)
Definition: zboss_api_core.h:722
#define ZB_BUF_LEN(zbbuf)
Definition: zboss_api_core.h:731
Definition: zb_zcl_common.h:251
struct zb_zll_commissioning_get_group_ids_res_permanent_s zb_zll_commissioning_get_group_ids_res_permanent_t
Parsed ZLL.Commissioning.GetGroupIdentifiersResponse payload.
Parsed ZLL.Commissioning.GetGroupIdentifiersResponse payload.
Definition: zb_zll_commissioning.h:1630

Parses permanent part of ZLL.Commissioning.GetGroupIdentifiersResponse.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zll_commissioning_get_group_ids_res_permanent_s.
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZLL_COMMISSIONING_GET_IDENTIFY_REQ (   data_ptr,
  buffer,
  status 
)
Value:
{ \
/* FIXED */ \
if (ZB_BUF_LEN((buffer)) != sizeof(zb_zll_commissioning_identify_req_t)) \
{ \
} \
else \
{ \
ZB_LETOH32(&((data_ptr)->trans_id), &(src_ptr->trans_id)); \
ZB_LETOH16(&((data_ptr)->duration), &(src_ptr->duration)); \
} \
}
Definition: zb_zcl_common.h:252
#define ZB_BUF_BEGIN(zbbuf)
Definition: zboss_api_core.h:722
#define ZB_BUF_LEN(zbbuf)
Definition: zboss_api_core.h:731
Definition: zb_zcl_common.h:251
#define ZB_LETOH16
Definition: zb_types.h:666
struct zb_zll_commissioning_identify_req_s zb_zll_commissioning_identify_req_t
Parsed ZLL.Commissioning.IdentifyRequest payload.
Parsed ZLL.Commissioning.IdentifyRequest payload.
Definition: zb_zll_commissioning.h:656

Parses ZLL.Commissioning.IdentifyRequest.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zll_commissioning_identify_req_s.
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZLL_COMMISSIONING_GET_IDENTIFY_REQ_PARAM (   data_ptr,
  buffer 
)
Value:
{ \
ZB_MEMCPY((data_ptr), tmp_ptr, sizeof(zb_zll_commissioning_identify_req_param_t)); \
}
Identify request parameters.
Definition: zb_zll_commissioning.h:720
#define ZB_GET_BUF_PARAM(zbbuf, type)
Definition: zboss_api_core.h:920
struct zb_zll_commissioning_identify_req_param_s zb_zll_commissioning_identify_req_param_t
Identify request parameters.

Extract Identify request parameters from the buffer.

Parameters
data_ptr[OUT] - pointer to a memory region to put request aprameters to. Must be capable of storing value of type zb_zll_commissioning_identify_req_param_s.
buffer[IN] - pointer to a buffer containing request parameters (as a tail parameter).
#define ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ED_REQ (   data_ptr,
  buffer,
  status 
)
Value:
{ \
{ \
} \
else \
{ \
ZB_LETOH32(&((data_ptr)->trans_id), &(src_ptr->trans_id)); \
ZB_IEEE_ADDR_COPY((data_ptr)->ext_pan_id, src_ptr->ext_pan_id); \
(data_ptr)->key_idx = src_ptr->key_idx; \
ZB_MEMCPY((data_ptr)->encr_nwk_key, src_ptr->encr_nwk_key, 16); \
(data_ptr)->nwk_upd_id = src_ptr->nwk_upd_id; \
(data_ptr)->channel = src_ptr->channel; \
ZB_LETOH16(&((data_ptr)->pan_id), &(src_ptr->pan_id)); \
ZB_LETOH16(&((data_ptr)->short_addr), &(src_ptr->short_addr)); \
ZB_LETOH16(&((data_ptr)->group_ids_begin), &(src_ptr->group_ids_begin)); \
ZB_LETOH16(&((data_ptr)->group_ids_end), &(src_ptr->group_ids_end)); \
ZB_LETOH16(&((data_ptr)->free_nwk_addrs_begin), &(src_ptr->free_nwk_addrs_begin)); \
ZB_LETOH16(&((data_ptr)->free_nwk_addrs_end), &(src_ptr->free_nwk_addrs_end)); \
ZB_LETOH16(&((data_ptr)->free_group_ids_begin), &(src_ptr->free_group_ids_begin)); \
ZB_LETOH16(&((data_ptr)->free_group_ids_end), &(src_ptr->free_group_ids_end)); \
} \
}
struct zb_zll_commissioning_network_join_end_device_req_s zb_zll_commissioning_network_join_end_device_req_t
Parsed ZLL.Commissioning.NetworkJoinEndDeviceRequest payload.
Definition: zb_zcl_common.h:252
#define ZB_BUF_BEGIN(zbbuf)
Definition: zboss_api_core.h:722
#define ZB_BUF_LEN(zbbuf)
Definition: zboss_api_core.h:731
Parsed ZLL.Commissioning.NetworkJoinEndDeviceRequest payload.
Definition: zb_zll_commissioning.h:1288
Definition: zb_zcl_common.h:251
#define ZB_LETOH16
Definition: zb_types.h:666

Parses ZLL.Commissioning.NetworkJoinEndDeviceRequest.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zll_commissioning_network_join_end_device_req_s.
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ED_RES (   data_ptr,
  buffer,
  op_status 
)
Value:
{ \
{ \
(op_status) = ZB_ZCL_PARSE_STATUS_FAILURE; \
} \
else \
{ \
zb_uint8_t* src_ptr = ZB_BUF_BEGIN((buffer)); \
ZB_ZCL_PACKET_GET_DATA32(&((data_ptr)->trans_id), (src_ptr)); \
ZB_ZCL_PACKET_GET_DATA8(&((data_ptr)->status), (src_ptr)); \
} \
}
Definition: zb_zcl_common.h:252
#define ZB_ZCL_PACKET_GET_DATA32(dst_ptr, src_ptr)
Get 32-bit value from packet.
Definition: zb_zcl_common.h:1418
#define ZB_BUF_BEGIN(zbbuf)
Definition: zboss_api_core.h:722
#define ZB_ZCL_PACKET_GET_DATA8(dst_ptr, src_ptr)
Get 8-bit value from packet.
Definition: zb_zcl_common.h:1364
#define ZB_BUF_LEN(zbbuf)
Definition: zboss_api_core.h:731
Parsed ZLL.Commissioning.NetworkJoinEndDeviceResponse payload.
Definition: zb_zll_commissioning.h:1404
Definition: zb_zcl_common.h:251
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115

Parses ZLL.Commissioning.NetworkJoinEndDeviceResponse.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zll_commissioning_network_join_end_device_res_s.
buffercontaining the packet (by pointer).
op_status- variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ROUTER_REQ (   data_ptr,
  buffer,
  status 
)
Value:
{ \
{ \
} \
else \
{ \
ZB_LETOH32(&((data_ptr)->trans_id), &(src_ptr->trans_id)); \
ZB_IEEE_ADDR_COPY((data_ptr)->ext_pan_id, src_ptr->ext_pan_id); \
(data_ptr)->key_idx = src_ptr->key_idx; \
ZB_MEMCPY((data_ptr)->encr_nwk_key, src_ptr->encr_nwk_key, 16); \
(data_ptr)->nwk_upd_id = src_ptr->nwk_upd_id; \
(data_ptr)->channel = src_ptr->channel; \
ZB_LETOH16(&((data_ptr)->pan_id), &(src_ptr->pan_id)); \
ZB_LETOH16(&((data_ptr)->short_addr), &(src_ptr->short_addr)); \
ZB_LETOH16(&((data_ptr)->group_ids_begin), &(src_ptr->group_ids_begin)); \
ZB_LETOH16(&((data_ptr)->group_ids_end), &(src_ptr->group_ids_end)); \
ZB_LETOH16(&((data_ptr)->free_nwk_addrs_begin), &(src_ptr->free_nwk_addrs_begin)); \
ZB_LETOH16(&((data_ptr)->free_nwk_addrs_end), &(src_ptr->free_nwk_addrs_end)); \
ZB_LETOH16(&((data_ptr)->free_group_ids_begin), &(src_ptr->free_group_ids_begin)); \
ZB_LETOH16(&((data_ptr)->free_group_ids_end), &(src_ptr->free_group_ids_end)); \
} \
}
Definition: zb_zcl_common.h:252
Parsed ZLL.Commissioning.NetworkJoinRouterRequest payload.
Definition: zb_zll_commissioning.h:1112
#define ZB_BUF_BEGIN(zbbuf)
Definition: zboss_api_core.h:722
#define ZB_BUF_LEN(zbbuf)
Definition: zboss_api_core.h:731
Definition: zb_zcl_common.h:251
#define ZB_LETOH16
Definition: zb_types.h:666
struct zb_zll_commissioning_network_join_router_req_s zb_zll_commissioning_network_join_router_req_t
Parsed ZLL.Commissioning.NetworkJoinRouterRequest payload.

Parses ZLL.Commissioning.NetworkJoinRouterRequest.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zll_commissioning_network_join_router_req_s.
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ROUTER_RES (   data_ptr,
  buffer,
  op_status 
)
Value:
{ \
{ \
(op_status) = ZB_ZCL_PARSE_STATUS_FAILURE; \
} \
else \
{ \
zb_uint8_t* src_ptr = ZB_BUF_BEGIN((buffer)); \
ZB_ZCL_PACKET_GET_DATA32(&((data_ptr)->trans_id), (src_ptr)); \
ZB_ZCL_PACKET_GET_DATA8(&((data_ptr)->status), (src_ptr)); \
} \
}
Parsed ZLL.Commissioning.NetworkJoinRouterResponse payload.
Definition: zb_zll_commissioning.h:1227
Definition: zb_zcl_common.h:252
#define ZB_ZCL_PACKET_GET_DATA32(dst_ptr, src_ptr)
Get 32-bit value from packet.
Definition: zb_zcl_common.h:1418
#define ZB_BUF_BEGIN(zbbuf)
Definition: zboss_api_core.h:722
#define ZB_ZCL_PACKET_GET_DATA8(dst_ptr, src_ptr)
Get 8-bit value from packet.
Definition: zb_zcl_common.h:1364
#define ZB_BUF_LEN(zbbuf)
Definition: zboss_api_core.h:731
Definition: zb_zcl_common.h:251
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115

Parses ZLL.Commissioning.NetworkJoinRouterResponse.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zll_commissioning_network_join_router_res_s.
buffercontaining the packet (by pointer).
op_status- variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZLL_COMMISSIONING_GET_NETWORK_START_REQ (   data_ptr,
  buffer,
  status 
)
Value:
{ \
{ \
} \
else \
{ \
/* CR:MAJOR:FIXED modify macro - do not use PACKET_GET..., use memcpy + HTOLE for each struct->field */ \
ZB_LETOH32(&((data_ptr)->trans_id), &(src_ptr->trans_id)); \
ZB_IEEE_ADDR_COPY((data_ptr)->ext_pan_id, src_ptr->ext_pan_id); \
(data_ptr)->key_idx = src_ptr->key_idx; \
ZB_MEMCPY((data_ptr)->encr_nwk_key, src_ptr->encr_nwk_key, 16); \
(data_ptr)->channel = src_ptr->channel; \
ZB_LETOH16(&((data_ptr)->pan_id), &(src_ptr->pan_id)); \
ZB_LETOH16(&((data_ptr)->short_addr), &(src_ptr->short_addr)); \
ZB_LETOH16(&((data_ptr)->group_ids_begin), &(src_ptr->group_ids_begin)); \
ZB_LETOH16(&((data_ptr)->group_ids_end), &(src_ptr->group_ids_end)); \
ZB_LETOH16(&((data_ptr)->free_nwk_addrs_begin), &(src_ptr->free_nwk_addrs_begin)); \
ZB_LETOH16(&((data_ptr)->free_nwk_addrs_end), &(src_ptr->free_nwk_addrs_end)); \
ZB_LETOH16(&((data_ptr)->free_group_ids_begin), &(src_ptr->free_group_ids_begin)); \
ZB_LETOH16(&((data_ptr)->free_group_ids_end), &(src_ptr->free_group_ids_end)); \
ZB_IEEE_ADDR_COPY((data_ptr)->initiator_ieee, (src_ptr->initiator_ieee)); \
ZB_LETOH16(&((data_ptr)->initiator_short), &(src_ptr->initiator_short)); \
} \
}
Parsed ZLL.Commissioning.NetworkStartRequest payload.
Definition: zb_zll_commissioning.h:852
Definition: zb_zcl_common.h:252
#define ZB_BUF_BEGIN(zbbuf)
Definition: zboss_api_core.h:722
#define ZB_BUF_LEN(zbbuf)
Definition: zboss_api_core.h:731
struct zb_zll_commissioning_network_start_req_s zb_zll_commissioning_network_start_req_t
Parsed ZLL.Commissioning.NetworkStartRequest payload.
Definition: zb_zcl_common.h:251
#define ZB_LETOH16
Definition: zb_types.h:666

Parses ZLL.Commissioning.NetworkStartRequest.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr[OUT] - pointer to a variable of type zb_zll_commissioning_network_start_req_s.
buffer[IN] - pointer to the buffer containing the packet.
status[OUT] - variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZLL_COMMISSIONING_GET_NETWORK_START_RES (   data_ptr,
  buffer,
  op_status 
)
Value:
{ \
{ \
(op_status) = ZB_ZCL_PARSE_STATUS_FAILURE; \
} \
else \
{ \
(op_status) = ZB_ZCL_PARSE_STATUS_SUCCESS; \
/* CR:MAJOR:FIXED modify macro - do not use PACKET_GET..., use memcpy + HTOLE for each struct->field */ \
ZB_LETOH32(&((data_ptr)->trans_id), &(src_ptr->trans_id)); \
(data_ptr)->status = src_ptr->status; \
ZB_IEEE_ADDR_COPY((data_ptr)->ext_pan_id, src_ptr->ext_pan_id); \
(data_ptr)->nwk_upd_id = src_ptr->nwk_upd_id; \
(data_ptr)->channel = src_ptr->channel; \
ZB_LETOH16(&((data_ptr)->pan_id), &(src_ptr->pan_id)); \
} \
}
Definition: zb_zcl_common.h:252
Parsed ZLL.Commissioning.NetworkStartResponse payload.
Definition: zb_zll_commissioning.h:984
#define ZB_BUF_BEGIN(zbbuf)
Definition: zboss_api_core.h:722
#define ZB_BUF_LEN(zbbuf)
Definition: zboss_api_core.h:731
Definition: zb_zcl_common.h:251
struct zb_zll_commissioning_network_start_res_s zb_zll_commissioning_network_start_res_t
Parsed ZLL.Commissioning.NetworkStartResponse payload.
#define ZB_LETOH16
Definition: zb_types.h:666

Parses ZLL.Commissioning.NetworkStartResponse.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr[OUT] - pointer to a variable of type zb_zll_commissioning_network_start_res_s that will contain parsed information.
buffer[IN] - pointer to the buffer containing the packet.
op_status[OUT] - variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZLL_COMMISSIONING_GET_NETWORK_UPDATE_REQ (   data_ptr,
  buffer,
  status 
)
Value:
{ \
{ \
} \
else \
{ \
ZB_LETOH32(&((data_ptr)->trans_id), &(src_ptr->trans_id)); \
ZB_IEEE_ADDR_COPY((data_ptr)->ext_pan_id, src_ptr->ext_pan_id); \
(data_ptr)->nwk_upd_id = src_ptr->nwk_upd_id; \
(data_ptr)->channel = src_ptr->channel; \
ZB_LETOH16(&((data_ptr)->pan_id), &(src_ptr->pan_id)); \
ZB_LETOH16(&((data_ptr)->short_addr), &(src_ptr->short_addr)); \
} \
}
Definition: zb_zcl_common.h:252
#define ZB_BUF_BEGIN(zbbuf)
Definition: zboss_api_core.h:722
#define ZB_BUF_LEN(zbbuf)
Definition: zboss_api_core.h:731
Parsed ZLL.Commissioning.NetworkUpdateRequest payload.
Definition: zb_zll_commissioning.h:1466
Definition: zb_zcl_common.h:251
struct zb_zll_commissioning_network_update_req_s zb_zll_commissioning_network_update_req_t
Parsed ZLL.Commissioning.NetworkUpdateRequest payload.
#define ZB_LETOH16
Definition: zb_types.h:666

Parses ZLL.Commissioning.NetworkUpdateRequest.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zll_commissioning_network_update_req_s.
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZLL_COMMISSIONING_GET_NEXT_EP_INFO_DEVICE_INFO_RES (   data_ptr,
  buffer,
  status 
)
Value:
{ \
{ \
} \
else \
{ \
ZB_ZCL_PACKET_GET_DATA_IEEE((data_ptr)->ieee_addr, (src_ptr)); \
(data_ptr)->ep_id = src_ptr->ep_id; \
ZB_LETOH16(&((data_ptr)->profile_id), &(src_ptr->profile_id)); \
ZB_LETOH16(&((data_ptr)->device_id), &(src_ptr->device_id)); \
(data_ptr)->version = src_ptr->version; \
(data_ptr)->group_id_count = src_ptr->group_id_count; \
(data_ptr)->sort = src_ptr->sort; \
ZB_BUF_CUT_LEFT2((buffer), sizeof(zb_zll_commissioning_device_information_ep_info_res_t)); \
} \
}
struct zb_zll_commissioning_device_information_ep_info_res_s zb_zll_commissioning_device_information_ep_info_res_t
Parsed device information record from the ZLL.Commissioning.DeviceInformationResponse payload...
Definition: zb_zcl_common.h:252
#define ZB_BUF_BEGIN(zbbuf)
Definition: zboss_api_core.h:722
#define ZB_BUF_LEN(zbbuf)
Definition: zboss_api_core.h:731
#define ZB_ZCL_PACKET_GET_DATA_IEEE(dst_ptr, src_ptr)
Get IEEE address from packet.
Definition: zb_zcl_common.h:1438
Definition: zb_zcl_common.h:251
Parsed device information record from the ZLL.Commissioning.DeviceInformationResponse payload...
Definition: zb_zll_commissioning.h:512
#define ZB_LETOH16
Definition: zb_types.h:666

Parses next device description record in ZLL.Commissioning.DeviceInformationResponse payload.

Parameters
data_ptr- pointer to a variable of type zb_zll_commissioning_device_information_ep_info_res_s.
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZLL_COMMISSIONING_GET_NEXT_EP_INFO_GET_EP_LIST_RES (   data_ptr,
  buffer,
  status 
)
Value:
{ \
{ \
} \
else \
{ \
ZB_LETOH16(&((data_ptr)->addr_short), &(src_ptr->addr_short)); \
(data_ptr)->endpoint = src_ptr->endpoint; \
ZB_LETOH16(&((data_ptr)->profile_id), &(src_ptr->profile_id)); \
ZB_LETOH16(&((data_ptr)->device_id), &(src_ptr_device_id)); \
(data_ptr)->version = src_ptr->version; \
ZB_BUF_CUT_LEFT2((buffer), sizeof(zb_zll_commissioning_endpoint_info_record_t)); \
} \
}
Definition: zb_zcl_common.h:252
#define ZB_BUF_BEGIN(zbbuf)
Definition: zboss_api_core.h:722
#define ZB_BUF_LEN(zbbuf)
Definition: zboss_api_core.h:731
Endpoint information record for ZLL.Commissioning.GetEndpointListResponse command.
Definition: zb_zll_commissioning.h:1832
Definition: zb_zcl_common.h:251
#define ZB_LETOH16
Definition: zb_types.h:666
struct zb_zll_commissioning_endpoint_info_record_s zb_zll_commissioning_endpoint_info_record_t
Endpoint information record for ZLL.Commissioning.GetEndpointListResponse command.

Extracts next endpoint information record from ZLL.Commissioning.GetEndpointListResponse.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zll_commissioning_endpoint_info_record_s.
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZLL_COMMISSIONING_GET_NEXT_GROUP_INFO_GET_GROUP_ID_RES (   data_ptr,
  buffer,
  status 
)
Value:
{ \
{ \
} \
else \
{ \
zb_uint8_t* src_ptr = ZB_BUF_BEGIN((buffer)); \
ZB_ZCL_PACKET_GET_DATA16(&((data_ptr)->group_id), (src_ptr)); \
ZB_ZCL_PACKET_GET_DATA8(&((data_ptr)->group_type), (src_ptr)); \
ZB_BUF_CUT_LEFT2((buffer), sizeof(zb_zll_commissioning_group_info_record_t)); \
} \
}
Definition: zb_zcl_common.h:252
#define ZB_BUF_BEGIN(zbbuf)
Definition: zboss_api_core.h:722
#define ZB_ZCL_PACKET_GET_DATA8(dst_ptr, src_ptr)
Get 8-bit value from packet.
Definition: zb_zcl_common.h:1364
#define ZB_BUF_LEN(zbbuf)
Definition: zboss_api_core.h:731
Definition: zb_zcl_common.h:251
#define ZB_ZCL_PACKET_GET_DATA16(dst_ptr, src_ptr)
Get 16-bit value from packet.
Definition: zb_zcl_common.h:1386
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
Group information record for ZLL.Commissioning.GetGroupIdentifiersResponse command.
Definition: zb_zll_commissioning.h:1640

Extracts next group information record from ZLL.Commissioning.GetGroupIdentifiersResponse.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zll_commissioning_group_info_record_s.
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZLL_COMMISSIONING_GET_RESET_TO_FN_REQ (   data_ptr,
  buffer,
  status 
)
Value:
{ \
if (ZB_BUF_LEN((buffer)) != sizeof(zb_zll_commissioning_reset_to_fn_t)) \
{ \
} \
else \
{ \
zb_uint8_t* src_ptr = ZB_BUF_BEGIN((buffer)); \
ZB_ZCL_PACKET_GET_DATA32(&((data_ptr)->trans_id), (src_ptr)); \
} \
}
Definition: zb_zcl_common.h:252
#define ZB_ZCL_PACKET_GET_DATA32(dst_ptr, src_ptr)
Get 32-bit value from packet.
Definition: zb_zcl_common.h:1418
#define ZB_BUF_BEGIN(zbbuf)
Definition: zboss_api_core.h:722
#define ZB_BUF_LEN(zbbuf)
Definition: zboss_api_core.h:731
Definition: zb_zcl_common.h:251
Parsed ZLL.Commissioning.ResetToFactoryNewRequest payload.
Definition: zb_zll_commissioning.h:797
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115

Parses ZLL.Commissioning.ResetToFactoryNewRequest.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zll_commissioning_reset_to_fn_s.
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZLL_COMMISSIONING_GET_SCAN_REQ (   data_ptr,
  buffer,
  status 
)
Value:
{ \
zb_uint8_t* src_ptr = ZB_BUF_BEGIN((buffer)); \
if (ZB_BUF_LEN((buffer)) != sizeof(zb_zll_commissioning_scan_req_t)) \
{ \
} \
else \
{ \
ZB_LETOH32(&((data_ptr)->trans_id), src_ptr); \
src_ptr += sizeof(zb_uint32_t); \
(data_ptr)->zb_info = *(src_ptr++); \
(data_ptr)->zll_info = *(src_ptr); \
} \
}
Definition: zb_zcl_common.h:252
#define ZB_BUF_BEGIN(zbbuf)
Definition: zboss_api_core.h:722
#define ZB_BUF_LEN(zbbuf)
Definition: zboss_api_core.h:731
Definition: zb_zcl_common.h:251
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
unsigned int zb_uint32_t
Project-local 4-byte unsigned int type.
Definition: zb_types.h:143
Parsed Scan request payload representation.
Definition: zb_zll_commissioning.h:155

Parses ZLL.Commissioning.ScanRequest payload.

Attention
Assumes that ZCL header was already cut.
Parameters
data_ptr- pointer to a variable of type zb_zll_commissioning_scan_req_s.
bufferwith the ZLL.Commissioning.ScanRequest payload.
status- variable to put parse status to (see zb_zcl_parse_status_t).
#define ZB_ZLL_COMMISSIONING_GET_SCAN_RES (   data_ptr,
  buffer,
  status 
)

Parses ZLL.Commissioning.ScanResponse.

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

Group type value for group_type field of zb_zll_commissioning_group_info_record_s.

See also
ZLL spec, subclause 7.1.2.3.7.4.
#define ZB_ZLL_COMMISSIONING_INIT_DEVICE_INFO_RES (   buffer,
  data_ptr,
  tsn,
  start_index,
  n_devs_reported 
)
Value:
{ \
data_ptr = ZB_ZCL_START_PACKET((buffer)); \
(data_ptr), \
(tsn), \
ZB_ZLL_CMD_COMMISSIONING_DEVICE_INFORMATION_RES); \
ZB_HTOLE32(&(req_data->trans_id), &(ZLL_TRAN_CTX().transaction_id)); \
req_data->n_subdevs = ZCL_CTX().device_ctx->ep_count; \
req_data->start_idx = (start_index); \
req_data->n_records = (n_devs_reported); \
}
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array.
Definition: zb_zcl_common.h:1252
#define ZB_ZCL_CONSTRUCT_COMMAND_HEADER(data_ptr, tsn, cmd_id)
Construct ZCL header.
Definition: zb_zcl_common.h:1127
struct zb_zll_commissioning_device_information_common_res_s zb_zll_commissioning_device_information_common_res_t
Parsed permanent part of the ZLL.Commissioning.DeviceInformationResponse payload. ...
#define ZCL_CTX()
Definition: zboss_api_zcl.h:1142
Parsed permanent part of the ZLL.Commissioning.DeviceInformationResponse payload. ...
Definition: zb_zll_commissioning.h:494
#define ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(buf_ptr)
Construct ZCL header frame control value for cluster-specific command response.
Definition: zb_zcl_common.h:1114

Starts filling in ZLL.Commissioning.DeviceInformationResponse command.

Parameters
bufferto put packet to (by pointer).
data_ptr- pointer to contain address right after the response's permanent part's tail.
tsn- ZCL transaction sequence number.
start_index- index of the first reported device.
n_devs_reported- number of reported devices.
#define ZB_ZLL_COMMISSIONING_INIT_GET_EP_LIST_RES (   buffer,
  total_,
  start_index,
  count_,
  tsn,
  data_ptr 
)
Value:
{ \
(data_ptr) = ZB_ZCL_START_PACKET((buffer)); \
(data_ptr), \
(tsn), \
ZB_ZLL_CMD_COMMISSIONING_GET_ENDPOINT_LIST_RESPONSE); \
res_data->total = (total_); \
res_data->start_idx = (start_index); \
res_data->count = (count_); \
}
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array.
Definition: zb_zcl_common.h:1252
#define ZB_ZCL_CONSTRUCT_COMMAND_HEADER(data_ptr, tsn, cmd_id)
Construct ZCL header.
Definition: zb_zcl_common.h:1127
struct zb_zll_commissioning_get_endpoint_list_res_s zb_zll_commissioning_get_endpoint_list_res_t
Parsed ZLL.Commissioning.GetEndpointListResponse payload.
Parsed ZLL.Commissioning.GetEndpointListResponse payload.
Definition: zb_zll_commissioning.h:1822
#define ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(buf_ptr)
Construct ZCL header frame control value for cluster-specific command response.
Definition: zb_zcl_common.h:1114

Fills in mandatory part of ZLL.Commissioning.GetGroupIdentifiersResponse payload.

Parameters
bufferto put packet to (by pointer).
total_- all count endpoint list
start_index- Index at which to start returning endpoint list.
count_- count of endpoints in this payload.
tsn[IN] - ZCL transaction sequence number.
data_ptr- pointer to contain address right after the response's permanent part's tail.
#define ZB_ZLL_COMMISSIONING_INIT_GET_GROUP_ID_RES (   buffer,
  data_ptr,
  total_,
  start_index,
  count_,
  tsn 
)
Value:
{ \
(data_ptr) = ZB_ZCL_START_PACKET((buffer)); \
data_ptr, \
(tsn), \
ZB_ZLL_CMD_COMMISSIONING_GET_GROUP_IDENTIFIERS_RESPONSE); \
req_data->total = (total_); \
req_data->start_idx = (start_index); \
req_data->count = (count_); \
}
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array.
Definition: zb_zcl_common.h:1252
#define ZB_ZCL_CONSTRUCT_COMMAND_HEADER(data_ptr, tsn, cmd_id)
Construct ZCL header.
Definition: zb_zcl_common.h:1127
struct zb_zll_commissioning_get_group_ids_res_permanent_s zb_zll_commissioning_get_group_ids_res_permanent_t
Parsed ZLL.Commissioning.GetGroupIdentifiersResponse payload.
#define ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(buf_ptr)
Construct ZCL header frame control value for cluster-specific command response.
Definition: zb_zcl_common.h:1114
Parsed ZLL.Commissioning.GetGroupIdentifiersResponse payload.
Definition: zb_zll_commissioning.h:1630

Fills in mandatory part of ZLL.Commissioning.GetGroupIdentifiersResponse payload.

Parameters
bufferto put packet to (by pointer).
data_ptr- pointer to contain address right after the response's permanent part's tail.
total_- all count group identifiers
start_index- Index at which to start returning group identifiers.
count_- count of identifiers in this payload.
tsn[IN] - ZCL transaction sequence number.
#define ZB_ZLL_COMMISSIONING_SEND_DEVICE_INFO_REQ (   buffer,
  start_index,
  dst_addr,
  callback,
  status 
)
Value:
{ \
zb_uint8_t* data_ptr = ZB_ZCL_START_PACKET((buffer)); \
ZB_ZCL_CONSTRUCT_GENERAL_COMMAND_RESP_FRAME_CONTROL_A(data_ptr, \
data_ptr, \
ZB_ZLL_CMD_COMMISSIONING_DEVICE_INFORMATION_REQ); \
ZB_HTOLE32(&(req->trans_id), &(ZLL_TRAN_CTX().transaction_id)); \
req->start_idx= (start_index); \
status = ZB_ZLL_SEND_PACKET((buffer), data_ptr, (dst_addr), (callback)); \
}
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame.
Definition: zb_zcl_common.h:1170
Parsed ZLL.Commissioning.DeviceInformationRequest payload.
Definition: zb_zll_commissioning.h:430
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array.
Definition: zb_zcl_common.h:1252
Standard profile command.
Definition: zb_zcl_common.h:756
Definition: zb_zcl_common.h:784
#define ZB_ZCL_CONSTRUCT_COMMAND_HEADER(data_ptr, tsn, cmd_id)
Construct ZCL header.
Definition: zb_zcl_common.h:1127
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
struct zb_zll_commissioning_device_information_req_s zb_zll_commissioning_device_information_req_t
Parsed ZLL.Commissioning.DeviceInformationRequest payload.

Schedules sending ZLL.Commissioning.DeviceInformationRequest command.

Parameters
buffer[IN] - pointer to the buffer to put packet to.
start_index[IN] - device index to start reporting with.
dst_addr[IN] - IEEE device address to send packet to.
callback[IN] - callback to schedule on packet send confirmation.
status[OUT] - packet schedule status (xsee zb_ret_t).
#define ZB_ZLL_COMMISSIONING_SEND_DEVICE_INFO_RES (   buffer,
  data_ptr,
  dst_addr,
  callback,
  status 
)    (status) = ZB_ZLL_SEND_PACKET(buffer, data_ptr, dst_addr, callback)

Schedules ZLL.Commissioning.DeviceInformationResponse for sending.

Parameters
buffer[IN] - pointer to a buffer containing payload.
data_ptr[IN] - pointer to the payload's tail.
dst_addr[IN] - IEEE device address to send packet to.
callback[IN] - callback to call upon packet confirm.
status[OUT] - packet send schedule status (see zb_ret_t).
#define ZB_ZLL_COMMISSIONING_SEND_EP_INFO (   buffer,
  endpoint_id,
  profile,
  device,
  version_,
  dst_addr,
  dst_ep,
  ep,
  callback 
)
Value:
{ \
zb_uint8_t* data_ptr = ZB_ZCL_START_PACKET((buffer)); \
data_ptr, \
ZB_ZLL_CMD_COMMISSIONING_NETWORK_UPDATE_REQ); \
ZB_IEEE_ADDR_COPY(req_data->addr_long, ZB_PIBCACHE_EXTENDED_ADDRESS());\
ZB_HTOLE16_VAL(&(req_data->addr_shart), ZB_PIBCACHE_NETWORK_ADDRESS());\
req_data->endpoint = (endpoint_id); \
ZB_HTOLE16_VAL(&(req_data->profile_id), (profile)); \
ZB_HTOLE16_VAL(&(req_data->device_id), (device)); \
req_data->version = (version_); \
ZB_ZCL_FINISH_PACKET((buffer), (data_ptr)); \
ZB_ZCL_SEND_COMMAND_SHORT( \
(buffer), \
dst_addr, \
dst_ep, \
ep, \
callback); \
}
#define ZB_PIBCACHE_NETWORK_ADDRESS()
Definition: zboss_api_nwk.h:171
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame.
Definition: zb_zcl_common.h:1170
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array.
Definition: zb_zcl_common.h:1252
#define ZB_ZCL_CONSTRUCT_COMMAND_HEADER(data_ptr, tsn, cmd_id)
Construct ZCL header.
Definition: zb_zcl_common.h:1127
#define ZB_ZCL_FINISH_PACKET(zbbuf, ptr)
Definition: zb_zcl_common.h:1538
Parsed ZLL.Commissioning.EndpointInformation payload.
Definition: zb_zll_commissioning.h:1966
Definition: zboss_api_af.h:456
#define ZB_PIBCACHE_EXTENDED_ADDRESS()
Definition: zboss_api_nwk.h:175
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
Definition: zboss_api_aps.h:114
Definition: zb_zll_common.h:100
#define ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(buf_ptr)
Construct ZCL header frame control value for cluster-specific command response.
Definition: zb_zcl_common.h:1114
struct zb_zll_commissioning_endpoint_information_s zb_zll_commissioning_endpoint_information_t
Parsed ZLL.Commissioning.EndpointInformation payload.

Schedules sending ZLL.Commissioning.EndpointInformation command.

Parameters
bufferto put packet to (by pointer).
endpoint_id- endpoint identificator.
profile- profile identificator.
device- device identificator.
version_- device version.
dst_addr- IEEE device address to send packet to.
dst_ep- endpoint of device to send packet to.
ep- endpoint of target device.
callbackto schedule on packet send confirmation.
#define ZB_ZLL_COMMISSIONING_SEND_GET_EP_LIST_REQ (   buffer,
  start_index,
  addr,
  dst_ep,
  ep,
  callback 
)
Value:
{ \
zb_uint8_t* data_ptr = ZB_ZCL_START_PACKET((buffer)); \
data_ptr, \
ZB_ZLL_CMD_COMMISSIONING_GET_ENDPOINT_LIST_REQUEST); \
ZB_ZCL_PACKET_PUT_DATA8(data_ptr, (start_index)); \
ZB_ZCL_FINISH_PACKET((buffer), data_ptr); \
ZB_ZCL_SEND_COMMAND_SHORT( \
(buffer), \
addr, \
dst_ep, \
ep, \
callback); \
}
#define ZB_ZCL_PACKET_PUT_DATA8(ptr, val)
Put 8 bit value to packet.
Definition: zb_zcl_common.h:1273
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame.
Definition: zb_zcl_common.h:1170
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array.
Definition: zb_zcl_common.h:1252
#define ZB_ZCL_CONSTRUCT_COMMAND_HEADER(data_ptr, tsn, cmd_id)
Construct ZCL header.
Definition: zb_zcl_common.h:1127
#define ZB_ZCL_FINISH_PACKET(zbbuf, ptr)
Definition: zb_zcl_common.h:1538
Definition: zboss_api_af.h:456
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
Definition: zboss_api_aps.h:114
Definition: zb_zll_common.h:100
#define ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(buf_ptr)
Construct ZCL header frame control value for cluster-specific command response.
Definition: zb_zcl_common.h:1114

Schedules sending ZLL.Commissioning.GetEndpointListRequest command.

Parameters
bufferto put packet to (by pointer).
start_index- Index at which to start returning group identifiers.
addr- IEEE device address to send packet to.
dst_ep- endpoint of device to send packet to.
ep- endpoint of target device.
callbackto schedule on packet send confirmation.
#define ZB_ZLL_COMMISSIONING_SEND_GET_EP_LIST_RES (   buffer,
  data_ptr,
  dst_addr,
  dst_ep,
  ep,
  callback 
)
Value:
{ \
ZB_ZCL_FINISH_PACKET((buffer), (data_ptr)); \
ZB_ZCL_SEND_COMMAND_SHORT( \
(buffer), \
dst_addr, \
dst_ep, \
ep, \
callback); \
}
#define ZB_ZCL_FINISH_PACKET(zbbuf, ptr)
Definition: zb_zcl_common.h:1538
Definition: zboss_api_af.h:456
Definition: zboss_api_aps.h:114
Definition: zb_zll_common.h:100
#define ZB_ZLL_COMMISSIONING_SEND_GET_GROUP_ID_REQ (   buffer,
  start_index,
  dst_addr,
  dst_ep,
  ep,
  callback 
)
Value:
{ \
zb_uint8_t* data_ptr = ZB_ZCL_START_PACKET((buffer)); \
data_ptr, \
ZB_ZLL_CMD_COMMISSIONING_NETWORK_UPDATE_REQ); \
ZB_ZCL_PACKET_PUT_DATA8(data_ptr, (start_index)); \
ZB_ZCL_FINISH_PACKET((buffer), data_ptr); \
ZB_ZCL_SEND_COMMAND_SHORT( \
(buffer), \
dst_addr, \
dst_ep, \
ep, \
callback); \
}
#define ZB_ZCL_PACKET_PUT_DATA8(ptr, val)
Put 8 bit value to packet.
Definition: zb_zcl_common.h:1273
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame.
Definition: zb_zcl_common.h:1170
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array.
Definition: zb_zcl_common.h:1252
#define ZB_ZCL_CONSTRUCT_COMMAND_HEADER(data_ptr, tsn, cmd_id)
Construct ZCL header.
Definition: zb_zcl_common.h:1127
#define ZB_ZCL_FINISH_PACKET(zbbuf, ptr)
Definition: zb_zcl_common.h:1538
Definition: zboss_api_af.h:456
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
Definition: zboss_api_aps.h:114
Definition: zb_zll_common.h:100
#define ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(buf_ptr)
Construct ZCL header frame control value for cluster-specific command response.
Definition: zb_zcl_common.h:1114

Schedules sending ZLL.Commissioning.GetGroupIdentifiersRequest command.

Parameters
bufferto put packet to (by pointer).
start_index- Rindex at which to start returning group identifiers.
dst_addr- IEEE device address to send packet to.
dst_ep- endpoint of device to send packet to.
ep- endpoint of target device.
callbackto schedule on packet send confirmation.
#define ZB_ZLL_COMMISSIONING_SEND_GET_GROUP_ID_RES (   buffer,
  data_ptr,
  addr,
  dst_ep,
  ep,
  callback 
)
Value:
{ \
ZB_ZCL_FINISH_PACKET((buffer), (data_ptr)); \
ZB_ZCL_SEND_COMMAND_SHORT( \
(buffer), \
addr, \
dst_ep, \
ep, \
callback); \
}
#define ZB_ZCL_FINISH_PACKET(zbbuf, ptr)
Definition: zb_zcl_common.h:1538
Definition: zboss_api_af.h:456
Definition: zboss_api_aps.h:114
Definition: zb_zll_common.h:100
#define ZB_ZLL_COMMISSIONING_SEND_IDENTIFY_REQ (   buffer,
  p_identify_duration,
  ieee_addr,
  callback,
  status 
)
Value:
{ \
zb_uint8_t* data_ptr = ZB_ZCL_START_PACKET((buffer)); \
ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL_O(data_ptr, ZB_ZCL_DISABLE_DEFAULT_RESPONSE); \
data_ptr, \
ZB_ZLL_CMD_COMMISSIONING_IDENTIFY_REQ); \
req_data = (zb_zll_commissioning_identify_req_t*)data_ptr; \
ZB_HTOLE32(&(req_data->trans_id), &(ZLL_TRAN_CTX().transaction_id)); \
ZB_HTOLE16(&(req_data->duration), (p_identify_duration)); \
data_ptr += sizeof(zb_zll_commissioning_identify_req_t); \
(status) = ZB_ZLL_SEND_PACKET((buffer), data_ptr, (ieee_addr), (callback)); \
}
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame.
Definition: zb_zcl_common.h:1170
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array.
Definition: zb_zcl_common.h:1252
#define ZB_ZCL_CONSTRUCT_COMMAND_HEADER(data_ptr, tsn, cmd_id)
Construct ZCL header.
Definition: zb_zcl_common.h:1127
Disble default response.
Definition: zb_zcl_common.h:774
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
struct zb_zll_commissioning_identify_req_s zb_zll_commissioning_identify_req_t
Parsed ZLL.Commissioning.IdentifyRequest payload.
Parsed ZLL.Commissioning.IdentifyRequest payload.
Definition: zb_zll_commissioning.h:656

Schedules sending ZLL.Commissioning.IdentifyRequest command.

Parameters
buffer[IN] - pointer to the buffer to put packet to.
p_identify_duration[IN] - period to identify.
ieee_addr[IN] - IEEE device address to send packet to.
callback[IN] - callback to schedule on packet send confirmation.
status[OUT] - packet send schedule status (see zb_ret_t).
#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ED_REQ (   buffer,
  key_index,
  encrypted_nwk_key,
  logical_channel,
  nwk_addr,
  grp_ids_begin,
  grp_ids_end,
  free_nwk_addrs_begin_,
  free_nwk_addrs_end_,
  free_group_ids_begin_,
  free_group_ids_end_,
  dst_addr,
  callback,
  status 
)
Value:
{ \
zb_uint8_t* data_ptr = ZB_ZCL_START_PACKET(buffer); \
data_ptr, \
ZB_ZLL_CMD_COMMISSIONING_NETWORK_JOIN_END_DEVICE_REQ); \
ZB_HTOLE32(&(req_data->trans_id), &(ZLL_TRAN_CTX().transaction_id)); \
ZB_IEEE_ADDR_COPY(req_data->ext_pan_id, ZB_NIB_EXT_PAN_ID()); \
req_data->key_idx = (key_index); \
ZB_MEMCPY(req_data->encr_nwk_key, (encrypted_nwk_key), 16); \
req_data->nwk_upd_id = ZB_NIB_UPDATE_ID(); \
req_data->channel = (logical_channel); \
ZB_HTOLE16_VAL(&(req_data->pan_id), ZB_PIBCACHE_PAN_ID()); \
ZB_HTOLE16_VAL(&(req_data->short_addr), (nwk_addr)); \
ZB_HTOLE16_VAL(&(req_data->group_ids_begin), (grp_ids_begin)); \
ZB_HTOLE16_VAL(&(req_data->group_ids_end), (grp_ids_end)); \
ZB_HTOLE16_VAL(&(req_data->free_nwk_addrs_begin), (free_nwk_addrs_begin_)); \
ZB_HTOLE16_VAL(&(req_data->free_nwk_addrs_end), (free_nwk_addrs_end_)); \
ZB_HTOLE16_VAL(&(req_data->free_group_ids_begin), (free_group_ids_begin_)); \
ZB_HTOLE16_VAL(&(req_data->free_group_ids_end), (free_group_ids_end_)); \
(status) = ZB_ZLL_SEND_PACKET((buffer), data_ptr, (dst_addr), (callback)); \
}
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame.
Definition: zb_zcl_common.h:1170
#define ZB_NIB_UPDATE_ID()
The value of ZB_NIB_ATTRIBUTE_UPDATE_ID attribute.
Definition: zb_nwk_nib.h:365
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array.
Definition: zb_zcl_common.h:1252
struct zb_zll_commissioning_network_join_end_device_req_s zb_zll_commissioning_network_join_end_device_req_t
Parsed ZLL.Commissioning.NetworkJoinEndDeviceRequest payload.
#define ZB_ZCL_CONSTRUCT_COMMAND_HEADER(data_ptr, tsn, cmd_id)
Construct ZCL header.
Definition: zb_zcl_common.h:1127
#define ZB_NIB_EXT_PAN_ID()
Device extended PAN ID.
Definition: zb_nwk_nib.h:363
Parsed ZLL.Commissioning.NetworkJoinEndDeviceRequest payload.
Definition: zb_zll_commissioning.h:1288
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
#define ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(buf_ptr)
Construct ZCL header frame control value for cluster-specific command response.
Definition: zb_zcl_common.h:1114
#define ZB_PIBCACHE_PAN_ID()
Definition: zboss_api_nwk.h:173

Schedules sending ZLL.Commissioning.NetworkJoinEndDeviceRequest command.

Parameters
buffer[IN] - pointer to the buffer to put packet to.
key_index[IN] - index of the field to be used in the encrypted network key field.
encrypted_nwk_key[IN] - encrypted network key.
logical_channel[IN] - ZLL channel to be used for the new network.
nwk_addr[IN] - short network address for the recepient.
grp_ids_begin[IN] - group identifiers begin field.
grp_ids_end[IN] - group identifiers end field.
free_nwk_addrs_begin_[IN] - free network addresses begin field.
free_nwk_addrs_end_[IN] - free network addresses end field.
free_group_ids_begin_[IN] - free group identifiers begin field.
free_group_ids_end_[IN] - free group identifiers end field.
dst_addr[IN] - IEEE device address to send packet to.
callback[IN] - callback to schedule on packet send confirmation.
status[OUT] - packet send schedule status (see zb_ret_t).
#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ED_RES (   buffer,
  nwk_status,
  tsn,
  dst_addr,
  callback,
  status 
)
Value:
{ \
zb_uint8_t* data_ptr = ZB_ZCL_START_PACKET((buffer)); \
data_ptr, \
(tsn), \
ZB_ZLL_CMD_COMMISSIONING_NETWORK_JOIN_END_DEVICE_RES); \
ZB_ZCL_PACKET_PUT_DATA32_VAL(data_ptr, ZLL_TRAN_CTX().transaction_id); \
ZB_ZCL_PACKET_PUT_DATA8(data_ptr, (nwk_status)); \
(status) = ZB_ZLL_SEND_PACKET((buffer), data_ptr, (dst_addr), (callback)); \
}
#define ZB_ZCL_PACKET_PUT_DATA8(ptr, val)
Put 8 bit value to packet.
Definition: zb_zcl_common.h:1273
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array.
Definition: zb_zcl_common.h:1252
#define ZB_ZCL_CONSTRUCT_COMMAND_HEADER(data_ptr, tsn, cmd_id)
Construct ZCL header.
Definition: zb_zcl_common.h:1127
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
#define ZB_ZCL_PACKET_PUT_DATA32_VAL(ptr, val)
Put 32 bit value to packet.
Definition: zb_zcl_common.h:1303
#define ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(buf_ptr)
Construct ZCL header frame control value for cluster-specific command response.
Definition: zb_zcl_common.h:1114

Schedules sending ZLL.Commissioning.NetworkJoinEndDeviceResponse command.

Parameters
buffer[IN] - pointer to the buffer to put packet to.
nwk_status[IN] - network join end device result.
tsn[IN] - ZCL transaction sequence number.
dst_addr[IN] - IEEE device address to send packet to.
callback[IN] - callback to schedule on packet send confirmation.
status[OUT] - packet send schedule status (see zb_ret_t).
#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ROUTER_REQ (   buffer,
  key_index,
  encrypted_nwk_key,
  nwk_addr,
  grp_ids_begin,
  grp_ids_end,
  free_nwk_addrs_begin_,
  free_nwk_addrs_end_,
  free_group_ids_begin_,
  free_group_ids_end_,
  dst_addr,
  callback,
  status 
)
Value:
{ \
zb_uint8_t* data_ptr = ZB_ZCL_START_PACKET(buffer); \
ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RESP_FRAME_CONTROL_A(data_ptr, \
data_ptr, \
ZB_ZLL_CMD_COMMISSIONING_NETWORK_JOIN_ROUTER_REQ); \
ZB_HTOLE32(&(req_data->trans_id), &(ZLL_TRAN_CTX().transaction_id)); \
ZB_IEEE_ADDR_COPY(req_data->ext_pan_id, ZB_NIB_EXT_PAN_ID()); \
req_data->key_idx = (key_index); \
ZB_MEMCPY(req_data->encr_nwk_key, (encrypted_nwk_key), 16); \
req_data->nwk_upd_id = ZB_NIB_UPDATE_ID(); \
req_data->channel = (ZLL_DEVICE_INFO().nwk_channel) ? ZLL_DEVICE_INFO().nwk_channel : ZB_PIBCACHE_CURRENT_CHANNEL(); \
ZB_HTOLE16_VAL(&(req_data->pan_id), ZB_PIBCACHE_PAN_ID()); \
ZB_HTOLE16_VAL(&(req_data->short_addr), (nwk_addr)); \
ZB_HTOLE16_VAL(&(req_data->group_ids_begin), (grp_ids_begin)); \
ZB_HTOLE16_VAL(&(req_data->group_ids_end), (grp_ids_end)); \
ZB_HTOLE16_VAL(&(req_data->free_nwk_addrs_begin), (free_nwk_addrs_begin_)); \
ZB_HTOLE16_VAL(&(req_data->free_nwk_addrs_end), (free_nwk_addrs_end_)); \
ZB_HTOLE16_VAL(&(req_data->free_group_ids_begin), (free_group_ids_begin_)); \
ZB_HTOLE16_VAL(&(req_data->free_group_ids_end), (free_group_ids_end_)); \
(status) = ZB_ZLL_SEND_PACKET((buffer), data_ptr, (dst_addr), (callback)); \
}
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame.
Definition: zb_zcl_common.h:1170
#define ZB_NIB_UPDATE_ID()
The value of ZB_NIB_ATTRIBUTE_UPDATE_ID attribute.
Definition: zb_nwk_nib.h:365
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array.
Definition: zb_zcl_common.h:1252
Standard profile command.
Definition: zb_zcl_common.h:756
Definition: zb_zcl_common.h:784
#define ZB_ZCL_CONSTRUCT_COMMAND_HEADER(data_ptr, tsn, cmd_id)
Construct ZCL header.
Definition: zb_zcl_common.h:1127
Parsed ZLL.Commissioning.NetworkJoinRouterRequest payload.
Definition: zb_zll_commissioning.h:1112
#define ZB_NIB_EXT_PAN_ID()
Device extended PAN ID.
Definition: zb_nwk_nib.h:363
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
#define ZB_PIBCACHE_CURRENT_CHANNEL()
Definition: zboss_api_nwk.h:181
struct zb_zll_commissioning_network_join_router_req_s zb_zll_commissioning_network_join_router_req_t
Parsed ZLL.Commissioning.NetworkJoinRouterRequest payload.
#define ZB_PIBCACHE_PAN_ID()
Definition: zboss_api_nwk.h:173

Schedules sending ZLL.Commissioning.NetworkJoinRouterRequest command.

Parameters
bufferto put packet to (by pointer).
key_index[IN] - index of the field to be used in the encrypted network key field.
encrypted_nwk_key[IN] - encrypted network key.
nwk_addr[IN] - short network address for the recepient.
grp_ids_begin[IN] - group identifiers begin field.
grp_ids_end[IN] - group identifiers end field.
free_nwk_addrs_begin_[IN] - free network addresses begin field.
free_nwk_addrs_end_[IN] - free network addresses end field.
free_group_ids_begin_[IN] - free group identifiers begin field.
free_group_ids_end_[IN] - free group identifiers end field.
dst_addr[IN] - IEEE device address to send packet to.
callback[IN] - callback to schedule on packet send confirmation.
status[OUT] - packet send schedule status (see zb_ret_t).
#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ROUTER_RES (   buffer,
  nwk_status,
  tsn,
  dst_addr,
  callback,
  status 
)
Value:
{ \
zb_uint8_t* data_ptr = ZB_ZCL_START_PACKET(buffer); \
data_ptr, \
(tsn), \
ZB_ZLL_CMD_COMMISSIONING_NETWORK_JOIN_ROUTER_RES); \
ZB_ZCL_PACKET_PUT_DATA32_VAL(data_ptr, ZLL_TRAN_CTX().transaction_id); \
ZB_ZCL_PACKET_PUT_DATA8(data_ptr, (nwk_status)); \
(status) = ZB_ZLL_SEND_PACKET((buffer), data_ptr, (dst_addr), (callback)); \
}
#define ZB_ZCL_PACKET_PUT_DATA8(ptr, val)
Put 8 bit value to packet.
Definition: zb_zcl_common.h:1273
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array.
Definition: zb_zcl_common.h:1252
#define ZB_ZCL_CONSTRUCT_COMMAND_HEADER(data_ptr, tsn, cmd_id)
Construct ZCL header.
Definition: zb_zcl_common.h:1127
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
#define ZB_ZCL_PACKET_PUT_DATA32_VAL(ptr, val)
Put 32 bit value to packet.
Definition: zb_zcl_common.h:1303
#define ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(buf_ptr)
Construct ZCL header frame control value for cluster-specific command response.
Definition: zb_zcl_common.h:1114

Schedules sending ZLL.Commissioning.NetworkJoinRouterResponse command.

Parameters
buffer[IN] - pointer to the buffer to put packet to.
nwk_status[IN] - network join router operation status.
tsn[IN] - ZCL transaction sequence number.
dst_addr[IN] - IEEE device address to send packet to.
callback[IN] - callback to schedule on packet send confirmation.
status[OUT] - packet send schedule status (see zb_ret_t).
#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_START_REQ (   buffer,
  ext_pan_id_,
  key_index,
  encrypted_nwk_key,
  logical_channel,
  pan_id_,
  nwk_addr,
  grp_ids_begin,
  grp_ids_end,
  free_nwk_addrs_begin_,
  free_nwk_addrs_end_,
  free_group_ids_begin_,
  free_group_ids_end_,
  dst_addr,
  callback,
  status 
)

Schedules sending ZLL.Commissioning.NetworkStartRequest command.

Parameters
buffer[IN] - pointer to the buffer to put packet to.
ext_pan_id_[IN] - extended PAN identifier of the new network.
key_index[IN] - index of the field to be used in the encrypted network key field.
encrypted_nwk_key[IN] - encrypted network key.
logical_channel[IN] - ZLL channel to be used for the new network.
pan_id_[IN] - identifier of the new PAN.
nwk_addr[IN] - short network address for the recepient.
grp_ids_begin[IN] - group identifiers begin field.
grp_ids_end[IN] - group identifiers end field.
free_nwk_addrs_begin_[IN] - free network addresses begin field.
free_nwk_addrs_end_[IN] - free network addresses end field.
free_group_ids_begin_[IN] - free group identifiers begin field.
free_group_ids_end_[IN] - free group identifiers end field.
dst_addr[IN] - IEEE device address to send packet to.
callback[IN] - callback to schedule on packet send confirmation.
status[OUT] - packet send schedule status (see zb_ret_t).
#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_START_RES (   buffer,
  seq_num,
  nwk_status,
  ext_pan_id_,
  pan_id_,
  channel_,
  dst_addr,
  callback,
  status_ 
)
Value:
{ \
zb_uint8_t* data_ptr = ZB_ZCL_START_PACKET((buffer)); \
ZB_ZCL_CONSTRUCT_COMMAND_HEADER(data_ptr, (seq_num), \
ZB_ZLL_CMD_COMMISSIONING_NETWORK_START_RES); \
ZB_HTOLE32(&(req_data->trans_id), &(ZLL_TRAN_CTX().transaction_id)); \
req_data->status = (nwk_status); \
ZB_IEEE_ADDR_COPY(req_data->ext_pan_id, (ext_pan_id_)); \
req_data->nwk_upd_id = ZB_ZLL_NETWORK_UPDATE_ID; \
req_data->channel = (channel_); \
ZB_HTOLE16_VAL(&(req_data->pan_id), (pan_id_)); \
(status_) = ZB_ZLL_SEND_PACKET((buffer), data_ptr, (dst_addr), (callback)); \
}
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array.
Definition: zb_zcl_common.h:1252
#define ZB_ZCL_CONSTRUCT_COMMAND_HEADER(data_ptr, tsn, cmd_id)
Construct ZCL header.
Definition: zb_zcl_common.h:1127
Parsed ZLL.Commissioning.NetworkStartResponse payload.
Definition: zb_zll_commissioning.h:984
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
struct zb_zll_commissioning_network_start_res_s zb_zll_commissioning_network_start_res_t
Parsed ZLL.Commissioning.NetworkStartResponse payload.
#define ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(buf_ptr)
Construct ZCL header frame control value for cluster-specific command response.
Definition: zb_zcl_common.h:1114
#define ZB_ZLL_NETWORK_UPDATE_ID
The only acceptable value for network update identifier field in the network start response...
Definition: zb_zll_commissioning.h:999

Schedules ZLL.Commissioning.NetworkStartResponse sending.

Parameters
buffer[IN] - pointer to the buffer containing payload.
seq_num[IN] - ZCL transaction sequence number.
nwk_status[IN] - network start request result.
ext_pan_id_[IN] - extended PAN Id of the network to be started.
pan_id_[IN] - PAN Id of the network to be started.
channel_[IN] - channel number network will be started on.
dst_addr[IN] - IEEE device address to send packet to.
callback[IN] - callback to schedule on packet send confirmation.
status_[OUT] - packet send schedule status.
#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_UPDATE_REQ (   buffer_,
  nwk_addr_,
  dst_addr_,
  callback_,
  status_ 
)
Value:
{ \
buffer_, \
nwk_addr_, \
dst_addr_, \
callback_, \
status_); \
}
#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_UPDATE_REQ_WITH_CHANNEL(buffer_,nwk_addr_,dst_addr_,channel_,callback_,status_)
Schedules sending ZLL.Commissioning.NetworkUpdateRequest command.
Definition: zb_zll_commissioning.h:1485
#define ZB_PIBCACHE_CURRENT_CHANNEL()
Definition: zboss_api_nwk.h:181

Schedules sending ZLL.Commissioning.NetworkUpdateRequest command. (send command with current value of channel from pib cache)

Parameters
buffer[IN] - pointer to the buffer to put packet to.
nwk_addr[IN] - network address assigned to the target.
dst_addr[IN] - IEEE device address to send packet to.
callback[IN] - callback to schedule on packet send confirmation.
status[OUT] - packet send schedule status (see zb_ret_t).
#define ZB_ZLL_COMMISSIONING_SEND_NETWORK_UPDATE_REQ_WITH_CHANNEL (   buffer_,
  nwk_addr_,
  dst_addr_,
  channel_,
  callback_,
  status_ 
)
Value:
{ \
zb_uint8_t* data_ptr = ZB_ZCL_START_PACKET((buffer_)); \
ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL_O(data_ptr, ZB_ZCL_DISABLE_DEFAULT_RESPONSE); \
data_ptr, \
ZB_ZLL_CMD_COMMISSIONING_NETWORK_UPDATE_REQ); \
ZB_HTOLE32(&(req_data->trans_id), &(ZLL_TRAN_CTX().transaction_id)); \
ZB_IEEE_ADDR_COPY(req_data->ext_pan_id, ZB_NIB_EXT_PAN_ID()); \
req_data->nwk_upd_id = ZB_NIB_UPDATE_ID(); \
req_data->channel = channel_; \
ZB_HTOLE16_VAL(&(req_data->pan_id), ZB_PIBCACHE_PAN_ID()); \
ZB_HTOLE16_VAL(&(req_data->short_addr), (nwk_addr_)); \
(status_) = ZB_ZLL_SEND_PACKET((buffer_), data_ptr, (dst_addr_), (callback_)); \
}
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame.
Definition: zb_zcl_common.h:1170
#define ZB_NIB_UPDATE_ID()
The value of ZB_NIB_ATTRIBUTE_UPDATE_ID attribute.
Definition: zb_nwk_nib.h:365
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array.
Definition: zb_zcl_common.h:1252
#define ZB_ZCL_CONSTRUCT_COMMAND_HEADER(data_ptr, tsn, cmd_id)
Construct ZCL header.
Definition: zb_zcl_common.h:1127
#define ZB_NIB_EXT_PAN_ID()
Device extended PAN ID.
Definition: zb_nwk_nib.h:363
Disble default response.
Definition: zb_zcl_common.h:774
Parsed ZLL.Commissioning.NetworkUpdateRequest payload.
Definition: zb_zll_commissioning.h:1466
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
struct zb_zll_commissioning_network_update_req_s zb_zll_commissioning_network_update_req_t
Parsed ZLL.Commissioning.NetworkUpdateRequest payload.
#define ZB_PIBCACHE_PAN_ID()
Definition: zboss_api_nwk.h:173

Schedules sending ZLL.Commissioning.NetworkUpdateRequest command.

Parameters
buffer[IN] - pointer to the buffer to put packet to.
nwk_addr[IN] - network address assigned to the target.
dst_addr[IN] - IEEE device address to send packet to.
channel[IN] - channel number.
callback[IN] - callback to schedule on packet send confirmation.
status[OUT] - packet send schedule status (see zb_ret_t).
#define ZB_ZLL_COMMISSIONING_SEND_RESET_TO_FN_REQ (   buffer,
  dst_addr,
  callback,
  status 
)
Value:
{ \
zb_uint8_t* data_ptr = ZB_ZCL_START_PACKET((buffer)); \
ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL_O(data_ptr, ZB_ZCL_ENABLE_DEFAULT_RESPONSE); \
data_ptr, \
ZB_ZLL_CMD_COMMISSIONING_RESET_TO_FACTORY_NEW_REQ); \
ZB_ZCL_PACKET_PUT_DATA32_VAL(data_ptr, ZLL_TRAN_CTX().transaction_id); \
(status) = ZB_ZLL_SEND_PACKET((buffer), data_ptr, (dst_addr), (callback)); \
}
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame.
Definition: zb_zcl_common.h:1170
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array.
Definition: zb_zcl_common.h:1252
#define ZB_ZCL_CONSTRUCT_COMMAND_HEADER(data_ptr, tsn, cmd_id)
Construct ZCL header.
Definition: zb_zcl_common.h:1127
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
Enable default response.
Definition: zb_zcl_common.h:772
#define ZB_ZCL_PACKET_PUT_DATA32_VAL(ptr, val)
Put 32 bit value to packet.
Definition: zb_zcl_common.h:1303

Schedules sending ZLL.Commissioning.ResetToFactoryNewRequest command.

Parameters
buffer[IN] - pointer to the buffer to put packet to.
dst_addr[IN] - IEEE device address to send packet to.
callback[IN] - callback to schedule on packet send confirmation.
status[OUT] - packet send schedule status (see zb_ret_t).
#define ZB_ZLL_COMMISSIONING_SEND_SCAN_RES (   buffer,
  seq_num,
  callback,
  status 
)

Schedules ZLL.Commissioning.ScanResponse sending.

Parameters
buffer[IN] - pointer to the buffer to put packet to.
seq_num[IN] - ZCL sequence number.
callback[IN] - callback to call upon packet confirm.
status[OUT] - packet send schedule status (see zb_ret_t).
#define ZB_ZLL_JOIN_ED (   buffer,
  dev_index,
  callback,
  status 
)
Value:
{ \
ZB_BUF_REUSE((buffer)); \
param->device_index = (dev_index); \
\
}
#define ZB_SCHEDULE_CALLBACK(func, param)
Definition: zboss_api_core.h:350
#define ZB_BUF_REUSE(zbbuf)
Reuse previously used buffer.
Definition: zboss_api_core.h:977
struct zb_zll_join_end_device_param_s zb_zll_join_end_device_param_t
Join end device parameters representation.
Join end device parameters representation.
Definition: zb_zll_commissioning.h:2156
#define ZB_GET_BUF_PARAM(zbbuf, type)
Definition: zboss_api_core.h:920
zb_void_t zb_zll_join_ed(zb_uint8_t param)
Perform Join end device commissioning.
#define ZB_REF_FROM_BUF(buf)
get buffer reference which can be passed to scheduler callback
Definition: zboss_api_core.h:709
Device discovery request parameters.
Definition: zb_zll_commissioning.h:2084

Fills in parameters for Join end device and schedules it for execution.

Parameters
buffer- buffer to put transaction packets to.
dev_index- Device index in device discovery results, it points remote target device
callback- callback function (zb_callback_t type) that should be called upon transaction state changed.
status- return code, RET_OK on success, other value on error
#define ZB_ZLL_JOIN_ROUTER (   buffer,
  dev_index,
  callback,
  status 
)
Value:
{ \
ZB_BUF_REUSE((buffer)); \
param->device_index = (dev_index); \
\
}
#define ZB_SCHEDULE_CALLBACK(func, param)
Definition: zboss_api_core.h:350
#define ZB_BUF_REUSE(zbbuf)
Reuse previously used buffer.
Definition: zboss_api_core.h:977
zb_void_t zb_zll_join_router(zb_uint8_t param)
Perform Join router commissioning.
Join router request parameters.
Definition: zb_zll_commissioning.h:2120
#define ZB_GET_BUF_PARAM(zbbuf, type)
Definition: zboss_api_core.h:920
#define ZB_REF_FROM_BUF(buf)
get buffer reference which can be passed to scheduler callback
Definition: zboss_api_core.h:709
Device discovery request parameters.
Definition: zb_zll_commissioning.h:2084
struct zb_zll_join_router_param_s zb_zll_join_router_param_t
Join router request parameters.

Fills in parameters for Join router and schedules it for execution.

Parameters
buffer- buffer to put transaction packets to.
dev_index- Device index in device discovery results, it points remote target device
callback- callback function (zb_callback_t type) that should be called upon transaction state changed.
status- return code, RET_OK on success, other value on error
#define ZB_ZLL_NETWORK_UPDATE_ID   ((zb_uint8_t)0)

The only acceptable value for network update identifier field in the network start response.

See also
ZLL spec, subclause 7.1.2.3.3.5.
#define ZB_ZLL_START_DEVICE_DISCOVERY (   buffer,
  extended_scan,
  callback,
  status 
)
Value:
{ \
ZB_BUF_REUSE((buffer)); \
buffer, \
zb_zll_device_discovery_req_t))->ext_scan = ((extended_scan) != ZB_FALSE);\
\
}
#define ZB_SCHEDULE_CALLBACK(func, param)
Definition: zboss_api_core.h:350
#define ZB_BUF_REUSE(zbbuf)
Reuse previously used buffer.
Definition: zboss_api_core.h:977
zb_void_t zb_zll_start_device_discovery(zb_uint8_t param)
Starts device discovery.
#define ZB_GET_BUF_PARAM(zbbuf, type)
Definition: zboss_api_core.h:920
#define ZB_REF_FROM_BUF(buf)
get buffer reference which can be passed to scheduler callback
Definition: zboss_api_core.h:709
Device discovery request parameters.
Definition: zb_zll_commissioning.h:2084
Definition: zb_types.h:99

Fills in device discovery request and schedules device discovery process for execution.

Parameters
buffer- buffer to put transaction packets to.
extended_scan- extended device scan procedure flag. 0 means standard scan procedure (on primary channels only, and any non-zero value selects extended scan procedure (both primary and secondary channel sets explored).
callback- callback function (zb_callback_t type) that should be called upon transaction state changed.
status- return code, RET_OK on success, other value on error
#define ZB_ZLL_START_NEW_NETWORK (   buffer,
  panid,
  ext_panid,
  channel_index,
  dest_addr,
  status 
)
Value:
{ \
ZB_BUF_REUSE((buffer)); \
param->pan_id = (panid); \
ZB_IEEE_ADDR_COPY(&(param->ext_pan_id), (ext_panid)); \
param->channel = (channel_index); \
ZB_IEEE_ADDR_COPY(&(param->dst_addr), (dest_addr)); \
(status) = zb_zll_start_new_network( ZB_REF_FROM_BUF((buffer)) ); \
}
Start new network function parameters representation.
Definition: zb_zll_commissioning.h:1070
#define ZB_BUF_REUSE(zbbuf)
Reuse previously used buffer.
Definition: zboss_api_core.h:977
struct zb_zll_start_new_nwk_param_s zb_zll_start_new_nwk_param_t
Start new network function parameters representation.
#define ZB_GET_BUF_PARAM(zbbuf, type)
Definition: zboss_api_core.h:920
#define ZB_REF_FROM_BUF(buf)
get buffer reference which can be passed to scheduler callback
Definition: zboss_api_core.h:709

Requests a target to start a new network.

Parameters
buffer[IN] - buffer containing request parameters (see
panid- short PAN identifier to use for new network
ext_panid- extended PAN identifier to use for new network
channel_index- logical channel to start network on
dest_addr- target device's ieee address
status- return code, RET_OK on success, other value on error List of return codes - see zb_ret_t
  • RET_OK on success;
  • RET_INVALID_STATE if no active transaction focund;
  • RET_INVALID_PARAMETER if could not extract parameters from the buffer;
  • RET_ERROR if could not schedule network start request for sending.
#define ZB_ZLL_ZB_INFO_CURRENT_VALUE ( )
Value:
( ZB_ZLL_ZB_INFO_ED_DEVICE_TYPE \
| (ZB_PIBCACHE_RX_ON_WHEN_IDLE() ? ZB_ZLL_ZB_INFO_RX_ON_WHEN_IDLE_MASK : 0))
#define ZB_PIBCACHE_RX_ON_WHEN_IDLE()
Definition: zboss_api_nwk.h:177

Typedef Documentation

Parsed permanent part of the ZLL.Commissioning.DeviceInformationResponse payload.

See also
ZLL spec, subclause 7.1.2.3.2.

Parsed device information record from the ZLL.Commissioning.DeviceInformationResponse payload.

See also
ZLL spec, subclause 7.1.2.3.2.

Parsed ZLL.Commissioning.DeviceInformationRequest payload.

See also
ZLL spec, subclause 7.1.2.2.2.

Endpoint information record for ZLL.Commissioning.GetEndpointListResponse command.

See also
ZLL spec, subclause 7.1.2.3.8.

Parsed ZLL.Commissioning.EndpointInformation payload.

See also
ZLL spec, subclause 7.1.2.3.6.

Parsed ZLL.Commissioning.GetEndpointListRequest payload.

See also
ZLL spec, subclause 7.1.2.2.10.

Parsed ZLL.Commissioning.GetEndpointListResponse payload.

See also
ZLL spec, subclause 7.1.2.3.8.

Parsed ZLL.Commissioning.GetGroupIdentifiersRequest payload.

See also
ZLL spec, subclause 7.1.2.2.9.

Parsed ZLL.Commissioning.GetGroupIdentifiersResponse payload.

See also
ZLL spec, subclause 7.1.2.3.7.

Group information record for ZLL.Commissioning.GetGroupIdentifiersResponse command.

See also
ZLL spec, subclause 7.1.2.3.7.4.

Parsed ZLL.Commissioning.IdentifyRequest payload.

See also
ZLL spec, subclause 7.1.2.2.3.

Parsed ZLL.Commissioning.NetworkJoinEndDeviceRequest payload.

See also
ZLL spec, subclause 7.1.2.2.7.

Parsed ZLL.Commissioning.NetworkJoinEndDeviceResponse payload.

See also
ZLL spec, subclause 7.1.2.3.5.

Parsed ZLL.Commissioning.NetworkJoinRouterRequest payload.

See also
ZLL spec, subclause 7.1.2.2.6.

Parsed ZLL.Commissioning.NetworkJoinRouterResponse payload.

See also
ZLL spec, subclause 7.1.2.3.4.

Parsed ZLL.Commissioning.NetworkStartRequest payload.

See also
ZLL spec, subclause 7.1.2.2.5.

Parsed ZLL.Commissioning.NetworkStartResponse payload.

See also
ZLL spec, subclause 7.1.2.3.3.

Parsed ZLL.Commissioning.NetworkUpdateRequest payload.

See also
ZLL spec, subclause 7.1.2.2.8.

Parsed ZLL.Commissioning.ResetToFactoryNewRequest payload.

See also
ZLL spec, subclause 7.1.2.2.4.

Parsed Scan request payload representation.

See also
ZLL spec, subclause 7.1.2.2.1.

Parsed ZLL.Commissioning.ScanResponse structure.

See also
ZLL spec, subclause 7.1.2.3.1.

Enumeration Type Documentation

Commissioning cluster touchlink command identifiers.

See also
LL spec, subclauses 7.1.2.2 and 7.1.3.2

Commissioning cluster touchlink response command identifiers.

See also
LL spec, subclause 7.1.3.2

Commissioning cluster utility command identifiers.

See also
LL spec, subclauses 7.1.2.2

Commissioning cluster utility response command identifiers.

See also
LL spec, subclause 7.1.3.2

ZLL general status is used in different commissioning response command frames.

Enumerator
ZB_ZLL_GENERAL_STATUS_SUCCESS 

Status: OK.

ZB_ZLL_GENERAL_STATUS_FAILURE 

Status: Error.

Function Documentation

zb_void_t zb_zll_commissioning_send_scan_req ( zb_buf_t buffer,
zb_callback_t  callback 
)

Schedules ZLL.Commissioning.ScanRequest sending.

Parameters
bufferto use for packet creation.
callbackto call upon packet confirmation.
zb_ret_t zb_zll_identify ( zb_uint8_t  param)

Sets up Identify request and schedules it for sending. Checks transaction state, identify period acceptability, fills in and schedules for sending command packet.

Parameters
param[IN] - reference to the packet buffer containing zb_zll_commissioning_identify_req_param_s structure as parameter.
Returns
  • RET_OK in case of success. In this case application will be notified on further status (packet received, timed out, etc.) via zb_zll_commissioning_cb() with first argument set to ZB_ZLL_IDENTIFY_TASK, and second argument containing task status.
  • RET_INVALID_STATE if identify time period doesn't correspond to the transaction state. I.e. either identify request was already sent, and identify period is non-zero, or request was not sent, and identify period is zero zus instructing the target to exit identify state.
  • packet schedule error otherwise.
zb_void_t zb_zll_join_ed ( zb_uint8_t  param)

Perform Join end device commissioning.

Parameters
param- reference to the buffer with parameters.
Note
It's not recommended to call the function directly. Use ZB_ZLL_JOIN_ED() macro instead.
zb_void_t zb_zll_join_router ( zb_uint8_t  param)

Perform Join router commissioning.

Parameters
param- reference to the buffer with parameters.
Note
It's not recommended to call the function directly. Use ZB_ZLL_JOIN_ROUTER() macro instead.
zb_ret_t zb_zll_send_packet ( zb_buf_t buffer,
zb_uint8_t data_ptr,
zb_ieee_addr_t  dsr_addr_long,
zb_callback_t  callback 
)

Finish packet and send it to the designated IEEE address.

Parameters
buffer[IN] - pointer to the buffer containing packet.
data_ptr[IN] - pointer to the packet tail.
dst_addr_long[IN] - destination device's IEEE address.
callback[IN] - callback to call upon send packet confirmation.
status[OUT] - packet send schedule status (see zb_ret_t).
zb_ret_t zb_zll_start_commissioning ( zb_uint8_t  param)

Perform Start commissioning.

Parameters
param- reference to the buffer without parameters.
Returns
command status
zb_void_t zb_zll_start_device_discovery ( zb_uint8_t  param)

Starts device discovery.

Parameters
param- reference to the buffer to put packets to.
Note
It's not recommended to call the function directly. Use ZB_ZLL_START_DEVICE_DISCOVERY() macro instead.
zb_void_t zll_add_device_to_network ( zb_uint8_t  param)

Perform Add device to netwiork.

Parameters
param- reference to the buffer without parameters.
Note
It recommended to call the function after finish call Device discovery.
zb_uint8_t zll_find_device_ep_by_short_addr ( zb_uint16_t  addr)

Find endpoint of known ZLL device by its nwk address

Parameters
addr- nwk address
Returns
endpoint if success, 0xff if error
zb_int8_t zll_find_device_info_by_max_rssi ( zb_bool_t  route_only)

Find device index with max rssi from device_infos table.

Parameters
route_only- find from all device or router olny
Returns
Device index by device_infos table
Note
It recommended to call the function after finish call Device discovery.
zb_int_t zll_get_ep_info ( zb_int_t  i,
zb_uint16_t addr,
zb_uint8_t ep 
)

Find info (address & endpoint) about known ZLL device by its index

Parameters
i- index in the endpoints array
addr- (out) found nwk address of remote device
ep- (out) endpoint
Returns
0 if success, -1 if no ep number i - to be able to use zll_get_ep_info as an iterator