Logo
Developing with ZBOSS for Zigbee
Data Structures | Macros | Typedefs | Functions
zboss_api_zdo.h File Reference

Data Structures

struct  zb_zdo_signal_leave_params_s
 Leave parameters. More...
 
struct  zb_zdo_signal_nlme_status_indication_params_s
 NLME status indication parameters. More...
 
struct  zb_zdo_signal_leave_indication_params_s
 Leave Indication parameters. More...
 
struct  zb_se_signal_service_discovery_bind_params_s
 Service Discovery Bind signal parameters. More...
 
struct  zb_zgp_signal_commissioning_params_s
 ZGP commissioning parameters. More...
 
struct  zb_zgp_signal_approve_comm_params_s
 ZGP approve commissioning parameters. More...
 
struct  zb_zgp_signal_mode_change_params_s
 ZGP mode changed parameters. More...
 
struct  zb_zdo_device_unavailable_params_s
 Device unavailable signal parameters. More...
 
struct  zb_nwk_signal_device_associated_params_s
 Association parameters. More...
 
struct  zb_zdo_signal_device_annce_params_s
 Association parameters. More...
 
struct  zb_bdb_signal_touchlink_nwk_started_params_s
 
struct  zb_bdb_signal_touchlink_nwk_joined_router_s
 
struct  zb_zdo_signal_can_sleep_params_s
 Sleep signal parameters. More...
 
struct  zb_zdo_signal_macsplit_dev_boot_params_s
 MAC-Split device boot parameters. More...
 
struct  zb_zdo_signal_fb_initiator_finished_params_s
 F&B Initiator Finished signal parameters. More...
 
struct  zb_zdo_signal_device_update_params_s
 Device Updated signal parameters. More...
 
struct  zb_zdo_signal_device_ready_for_interview_params_s
 Device Ready For Interview signal parameters. More...
 
struct  zb_zdo_signal_device_authorized_params_s
 Device Authorized signal parameters. More...
 
struct  zb_debug_signal_tclk_ready_params_s
 TCLK Read debug signal parameters. More...
 
struct  zb_zdo_app_signal_hdr_s
 
struct  zb_zdo_callback_info_s
 
struct  zb_zdo_default_resp_s
 
struct  zb_zdo_get_diag_data_req_params_s
 
struct  zb_zdo_get_diag_data_resp_params_s
 
struct  zb_zdo_nwk_addr_req_s
 NWK_addr_req command primitive. More...
 
struct  zb_zdo_nwk_addr_req_param_s
 Parameters for nwk_addr_req command. More...
 
struct  zb_zdo_nwk_addr_resp_head_s
 NWK_addr_req response frame. More...
 
struct  zb_zdo_nwk_addr_resp_ext_s
 NWK_addr_req response frame tail. More...
 
struct  zb_zdo_nwk_addr_resp_ext2_s
 NWK_addr_req response frame tail. More...
 
struct  zb_zdo_ieee_addr_req_s
 Parameters of IEEE_addr_req primitive. More...
 
struct  zb_zdo_ieee_addr_req_param_s
 Parameters for ieee_addr_req command. More...
 
struct  zb_zdo_ieee_addr_resp_s
 
struct  zb_zdo_ieee_addr_resp_ext_s
 ZDO IEEE address response frame tail. More...
 
struct  zb_zdo_ieee_addr_resp_ext2_s
 ZDO IEEE address response frame tail. More...
 
struct  zb_zdo_node_desc_req_s
 Parameters of Node_desc_req primitive. More...
 
struct  zb_zdo_desc_resp_hdr_s
 Header of Node_desc_resp primitive. More...
 
struct  zb_zdo_node_desc_resp_s
 Parameters of Node_desc_resp primitive. More...
 
struct  zb_zdo_simple_desc_resp_hdr_s
 Header of simple_desc_resp primitive. More...
 
struct  zb_zdo_simple_desc_resp_s
 Parameters of simple_desc_resp primitive. More...
 
struct  zb_zdo_child_info_s
 
struct  zb_zdo_parent_annce_s
 Header of parent_annce primitive. More...
 
struct  zb_zdo_parent_annce_rsp_hdr_s
 Header of parent_annce_rsp primitive. More...
 
struct  zb_zdo_parent_annce_rsp_s
 Parameters of parent_annce_rsp primitive. More...
 
struct  zb_zdo_power_desc_resp_s
 Parameters of Power_desc_resp primitive. More...
 
struct  zb_zdo_power_desc_req_s
 Parameters of Power_desc_req primitive. More...
 
struct  zb_zdo_simple_desc_req_s
 Parameters of Simple_desc_req primitive. More...
 
struct  zb_zdo_active_ep_req_s
 Parameters of Active_desc_req primitive. More...
 
struct  zb_zdo_ep_resp_s
 Active EP response. More...
 
struct  zb_zdo_match_desc_param_s
 Parameters of match_desc_req primitive. More...
 
struct  zb_zdo_match_desc_req_head_s
 Match_desc_req head. More...
 
struct  zb_zdo_match_desc_req_tail_s
 Match_desc_req tail. More...
 
struct  zb_zdo_match_desc_resp_s
 Match_Desc_rsp response structure. More...
 
struct  zb_zdo_system_server_discovery_req_s
 Request parameters for System_Server_Discovery_req. More...
 
struct  zb_zdo_system_server_discovery_resp_s
 Response parameters for System_Server_Discovery_rsp. More...
 
struct  zb_zdo_mgmt_nwk_update_req_hdr_s
 Header of parameters for Mgmt_NWK_Update_req. More...
 
struct  zb_zdo_mgmt_nwk_update_req_s
 Parameters for Mgmt_NWK_Update_req. More...
 
struct  zb_zdo_mgmt_nwk_enhanced_update_req_param_s
 Parameters for Mgmt_NWK_Update_req internal call. More...
 
struct  zb_zdo_mgmt_nwk_enhanced_update_req_hdr_s
 Header of parameters for Mgmt_NWK_Update_req. More...
 
struct  zb_zdo_mgmt_nwk_update_notify_hdr_s
 Header parameters for mgmt_nwk_update_notify. More...
 
struct  zb_zdo_mgmt_nwk_update_notify_param_s
 Parameters for mgmt_nwk_update_notify. More...
 
struct  zb_zdo_mgmt_nwk_unsol_enh_update_notify_s
 Notification for Mgmt_NWK_Unsolicited_Enhanced_Update_Notify. More...
 
struct  zb_zdo_mgmt_nwk_unsol_enh_update_notify_param_s
 Parameters for Mgmt_NWK_Unsolicited_Enhanced_Update_Notify. More...
 
struct  zb_zdo_mgmt_lqi_param_s
 Parameters for Mgmt_Lqi_req. More...
 
struct  zb_zdo_mgmt_lqi_req_s
 Request for Mgmt_Lqi_req. More...
 
struct  zb_zdo_mgmt_lqi_resp_s
 Response for Mgmt_Lqi_rsp. More...
 
struct  zb_zdo_neighbor_table_record_s
 NeighborTableList Record Format for Mgmt_Lqi_resp. More...
 
struct  zb_zdo_mgmt_rtg_param_s
 Parameters for Mgmt_rtg_req. More...
 
struct  zb_zdo_mgmt_rtg_req_s
 Request for Mgmt_rtg_req. More...
 
struct  zb_zdo_mgmt_rtg_resp_s
 Response for Mgmt_Rtg_rsp. More...
 
struct  zb_zdo_routing_table_record_s
 RoutingTableList Record Format for mgmt_rtg_resp. More...
 
struct  zb_energy_detect_channel_info_s
 
struct  zb_energy_detect_list_s
 
struct  zb_nlme_ed_scan_request_s
 
struct  zb_zdo_ed_scan_param_s
 
struct  zb_zdo_active_scan_request_s
 Parameters for active_scan_req. More...
 
struct  zb_nlme_network_descriptor_s
 Network descriptor. This is a part of network discovery confirm result. More...
 
struct  zb_zdo_active_scan_resp_s
 Parameters for active_scan_resp. More...
 
struct  zb_zdo_mgmt_bind_param_s
 Parameters for Mgmt_Bind_req. More...
 
struct  zb_zdo_mgmt_bind_req_s
 Request for Mgmt_Bind_req. More...
 
struct  zb_zdo_mgmt_bind_resp_s
 Response for Mgmt_Bind_rsp. More...
 
struct  zb_zdo_binding_table_record_s
 BindingTableList Record Format for mgmt_bind_resp. See ZB spec, Table 2.131. More...
 
struct  zb_zdo_raw_req_param_s
 Parameters for zb_zdo_raw_req call. More...
 
struct  zb_zdo_raw_resp_param_s
 Parameters of zb_zdo_raw_resp call. More...
 
struct  zb_zdo_raw_resp_s
 Response by Raw_req. More...
 
struct  zb_zdo_bind_req_param_s
 Parameters for Bind_req API call. More...
 
struct  zb_zdo_bind_req_head_s
 Bind_req request head send to the remote. More...
 
struct  zb_zdo_bind_req_tail_1_s
 Bind_req request tail 1st variant send to the remote. More...
 
struct  zb_zdo_bind_req_tail_2_s
 Bind_req request tail 2nd variant send to the remote. More...
 
struct  zb_zdo_status_resp_s
 
struct  zb_zdo_bind_resp_s
 Response by Bind_req. More...
 
struct  zb_zdo_set_configuration_resp_s
 Response by ZDO Set Configuration req. More...
 
struct  zb_zdo_mgmt_leave_param_s
 Request for Mgmt_Leave_req. More...
 
struct  zb_zdo_mgmt_leave_req_s
 
struct  zb_zdo_mgmt_leave_res_s
 Response for Mgmt_Leave_rsp. More...
 
struct  zb_zdo_end_device_bind_req_head_s
 End_Device_Bind_req command head. More...
 
struct  zb_zdo_end_device_bind_req_tail_s
 End_Device_Bind_req command head. More...
 
struct  zb_end_device_bind_req_param_s
 Parameters for End_Device_Bind_req. More...
 
struct  zb_zdo_end_device_bind_resp_s
 Response from End_Device_Bind_req. More...
 
struct  zb_zdo_secur_get_auth_level_req_s
 Parameters for get authentication level request. More...
 
struct  zb_zdo_secur_get_auth_level_rsp_s
 
struct  zb_zdo_mgmt_permit_joining_req_s
 Parameters for Mgmt_Permit_Joining_req. More...
 
struct  zb_zdo_mgmt_permit_joining_req_param_s
 Parameters for zb_zdo_mgmt_permit_joining_req. More...
 
struct  zb_zdo_mgmt_permit_joining_resp_s
 Response from zb_zdo_mgmt_permit_joining_req. More...
 
struct  zb_zdo_not_supported_resp_s
 Not Supported Response. More...
 
struct  zb_zdo_mgmt_nwk_ieee_joining_list_param_s
 Parameters for Mgmt_NWK_IEEE_Joining_List_req. More...
 
struct  zb_zdo_mgmt_nwk_ieee_joining_list_req_s
 Request for Mgmt_NWK_IEEE_Joining_List_req. More...
 
struct  zb_zdo_mgmt_nwk_ieee_joining_list_rsp_s
 Response for Mgmt_NWK_IEEE_Joining_List_rsp. More...
 
struct  zb_zdo_device_annce_s
 
struct  zb_nlme_leave_indication_s
 
struct  zb_zdo_pim_get_long_poll_interval_resp_s
 
struct  zb_zdo_common_req_param_s
 
struct  zb_zdo_get_configuration_req_param_s
 ZDO Get Configuration Request parameters. More...
 
struct  zb_zdo_get_configuration_resp_param_s
 ZDO Get Configuration Response parameters. More...
 
struct  zb_zdo_configuration_parameters_s
 Configuration parameters Stack sends set_configuration_req to the device with set values. More...
 
struct  zb_zdo_next_panid_change_parameters_s
 Next PAN ID change parameters Stack sends set_configuration_req to the device with set values. More...
 
struct  zb_zdo_next_channel_change_parameters_s
 Next channel change parameters Stack sends set_configuration_req to the device with set values. More...
 
struct  zb_zdo_clear_all_bind_req_param_s
 Parameters for zdo_clear_all_bind_req. More...
 
struct  zb_zdo_mgmt_beacon_survey_param_s
 Parameters for beacon_survey_req command. More...
 
struct  zb_zcl_wwah_beacon_survey_s
 
struct  zb_zdo_beacon_survey_results_t
 R23, I.3.3 Beacon Survey Configuration TLV. More...
 
struct  zb_zdo_beacon_survey_potential_parents_t
 R23, I.3.5 Potential Parents TLV. More...
 
struct  zb_zdo_beacon_survey_resp_params_s
 Structure to store information when 'Beacon Survey' procedure is executing. More...
 

Macros

#define ZB_TCLK_UPDATED_SIGNAL   55U
 
#define ZB_SIGNAL_JOIN_DONE   56U
 
#define ZB_BUFFER_TEST_REQ_SIGNAL   57U
 
#define ZB_BDB_SIGNAL_TC_REJOIN_DONE   58U
 
#define ZB_NWK_SIGNAL_PERMIT_JOIN_STATUS   59U
 
#define ZB_ZDO_SIGNAL_DEVICE_INTERVIEW_FINISHED   60U
 
#define ZB_BDB_SIGNAL_STEERING_CANCELLED   61U
 
#define ZB_BDB_SIGNAL_FORMATION_CANCELLED   62U
 
#define ZB_SIGNAL_READY_TO_SHUT   63U
 
#define ZB_SIGNAL_INTERPAN_PREINIT   64U
 
#define ZB_ZGP_SIGNAL_MODE_CHANGE   65U
 
#define ZB_ZDO_DEVICE_UNAVAILABLE   66U
 
#define ZB_ZGP_SIGNAL_APPROVE_COMMISSIONING   67U
 
#define ZB_DEBUG_SIGNAL_TCLK_READY   68U
 
#define ZB_ZDO_SIGNAL_GET_PARAMS(sg_p, type)   ((type *)(void *)((((zb_uint8_t *)sg_p) + sizeof(zb_zdo_app_signal_hdr_t))))
 
#define ZB_ZDO_SIGNAL_CUT_HEADER(buf)   zb_buf_cut_left(buf, sizeof(zb_zdo_app_signal_hdr_t))
 Cuts ZBOSS signal headers while keeping the signal parameter (if it was in the buffer). More...
 
#define ZB_HIGH_SEQ_SECURED_REJOIN   4U
 
#define ZB_HIGH_SEQ_UNSECURED_JOIN   5U
 
#define ZB_HIGH_SEQ_UNSECURED_REJOIN   7U
 
#define ZB_ZDO_INVALID_TSN   0xFFU
 
#define ZB_GET_APP_SIGNAL_STATUS(param)   zb_buf_get_status(param)
 Get status from the application signal. More...
 
#define ZB_ZDO_SINGLE_DEVICE_RESP   0U
 
#define ZB_ZDO_EXTENDED_DEVICE_RESP   1U
 
#define ZB_PARENT_ANNCE_JITTER()   (ZB_APS_PARENT_ANNOUNCE_BASE_TIMER + ZB_RANDOM_JTR(ZB_APS_PARENT_ANNOUNCE_JITTER_MAX))
 Jitter used for sending Parent Annce. More...
 
#define ZB_ZDO_RECORD_SET_DEVICE_TYPE(var, type)   ( ( var ) &= ~3U, ( var ) |= ( type ) )
 
#define ZB_ZDO_RECORD_GET_DEVICE_TYPE(var)   ( var & 3U )
 
#define ZB_ZDO_RECORD_SET_RX_ON_WHEN_IDLE(var, type)   ( ( var ) &= ~0xCU, ( var ) |= (( type ) << 2U) )
 
#define ZB_ZDO_RECORD_GET_RX_ON_WHEN_IDLE(var)   ( (var & 0xCU) >> 2U )
 
#define ZB_ZDO_RECORD_SET_RELATIONSHIP(var, type)   ( ( var ) &= ~0x70U, ( var ) |= (( type ) << 4U) )
 
#define ZB_ZDO_RECORD_GET_RELATIONSHIP(var)   ( (var & 0x70) >> 4 )
 
#define ZB_ZDO_MGMT_RTG_RESP_RECORD_FLAGS_STATUS   0U
 
#define ZB_ZDO_MGMT_RTG_RESP_RECORD_FLAGS_MEM_CONST   3U
 
#define ZB_ZDO_MGMT_RTG_RESP_RECORD_FLAGS_MANY_TO_ONE   4U
 
#define ZB_ZDO_MGMT_RTG_RESP_RECORD_FLAGS_ROUTE_REC_REQUIRED   5U
 
#define ZB_ED_SCAN_MAX_CHANNELS_COUNT   ((ZB_IO_BUF_SIZE - sizeof(zb_uint8_t)) / sizeof(zb_energy_detect_channel_info_t))
 
#define ZB_POST_JOIN_KEY_UPD_METH_NOT_UPDATED   0x00U
 
#define ZB_POST_JOIN_KEY_UPD_METH_KEY_REQ   0x01U
 
#define ZB_POST_JOIN_KEY_UPD_METH_UNAUTH_KEY_NEGOTIATION   0x02U
 
#define ZB_POST_JOIN_KEY_UPD_METH_AUTH_KEY_NEGOTIATION   0x03U
 
#define ZB_POST_JOIN_KEY_UPD_METH_APP_DEFINED_CERT_BASED_MUTUAL   0x04U /* CBKE indeed */
 
#define ZB_POST_JOIN_KEY_UPD_METH_RESERVED1   0x05U
 
#define ZB_POST_JOIN_KEY_UPD_METH_RESERVED2   0x06U
 
#define ZB_POST_JOIN_KEY_UPD_METH_HASHED_TCLK   0x07U /* Hashed TCLK is restored from backup at TC after TC swap */
 
#define ZB_NWK_LPD_NOTIFICATION   0x01U
 
#define ZB_NWK_LPD_REQUEST   0x02U
 
#define ZB_ZDO_CLEAR_ALL_BIND_EUI64_LIST_SIZE   (5u)
 
#define ZB_SURVEY_BEACON_MAX_CHANNEL_PAGE_CNT   10U
 
#define ZDO_WWAH_MAX_BEACON_SURVEY   5U
 
#define ZDO_WWAH_MAX_BEACON_SURVEY_BYTES
 
ZDP status values

See also
2.4.5 - ZDP Enumeration Description
#define ZB_ZDP_STATUS_SUCCESS   0x00U
 
#define ZB_ZDP_STATUS_INV_REQUESTTYPE   0x80U
 
#define ZB_ZDP_STATUS_DEVICE_NOT_FOUND   0x81U
 
#define ZB_ZDP_STATUS_INVALID_EP   0x82U
 
#define ZB_ZDP_STATUS_NOT_ACTIVE   0x83U
 
#define ZB_ZDP_STATUS_NOT_SUPPORTED   0x84U
 
#define ZB_ZDP_STATUS_TIMEOUT   0x85U
 
#define ZB_ZDP_STATUS_NO_MATCH   0x86U
 
#define ZB_ZDP_STATUS_NO_ENTRY   0x88U
 
#define ZB_ZDP_STATUS_NO_DESCRIPTOR   0x89U
 
#define ZB_ZDP_STATUS_INSUFFICIENT_SPACE   0x8aU
 
#define ZB_ZDP_STATUS_NOT_PERMITTED   0x8bU
 
#define ZB_ZDP_STATUS_TABLE_FULL   0x8cU
 
#define ZB_ZDP_STATUS_NOT_AUTHORIZED   0x8dU
 
#define ZB_ZDP_STATUS_INVALID_INDEX   0x8fU
 
#define ZB_ZDP_STATUS_FRAME_TOO_LARGE   0x90U
 
#define ZB_ZDP_STATUS_BAD_KEY_NEG_METHOD   0x91U
 
#define ZB_ZDP_STATUS_TEMPORARY_FAILURE   0x92U
 
#define ZB_ZDP_STATUS_DEV_ANNCE_SENDING_FAILED   0x0feU
 
#define ZB_ZDP_STATUS_TIMEOUT_BY_STACK   0xffU
 
Signals passed to application signal handler

Note
If an application requires the parameters to be passed to the zboss_signal_handler, it is recommended to introduce the structure according to the pattern below:
typedef struct zb_zdo_app_my_custom_signal_s
{
zb_zdo_app_signal_type_t super;
zb_my_custom_data_type_t my_custom_data;
}
#define ZB_ZDO_SIGNAL_DEFAULT_START   0U
 
#define ZB_ZDO_SIGNAL_SKIP_STARTUP   1U
 
#define ZB_ZDO_SIGNAL_DEVICE_ANNCE   2U
 
#define ZB_ZDO_SIGNAL_LEAVE   3U
 
#define ZB_ZDO_SIGNAL_ERROR   4U
 
#define ZB_BDB_SIGNAL_DEVICE_FIRST_START   5U
 
#define ZB_BDB_SIGNAL_DEVICE_REBOOT   6U
 
#define ZB_SIGNAL_DEVICE_FIRST_START   ZB_BDB_SIGNAL_DEVICE_FIRST_START
 
#define ZB_SIGNAL_DEVICE_REBOOT   ZB_BDB_SIGNAL_DEVICE_REBOOT
 
#define ZB_BDB_SIGNAL_STEERING   10U
 
#define ZB_BDB_SIGNAL_FORMATION   11U
 
#define ZB_BDB_SIGNAL_FINDING_AND_BINDING_TARGET_FINISHED   12U
 
#define ZB_BDB_SIGNAL_FINDING_AND_BINDING_INITIATOR_FINISHED   13U
 
#define ZB_NWK_SIGNAL_DEVICE_ASSOCIATED   18U
 
#define ZB_ZDO_SIGNAL_LEAVE_INDICATION   19U
 
#define ZB_BDB_SIGNAL_WWAH_REJOIN_STARTED   20U
 
#define ZB_ZGP_SIGNAL_COMMISSIONING   21U
 
#define ZB_COMMON_SIGNAL_CAN_SLEEP   22U
 
#define ZB_ZDO_SIGNAL_PRODUCTION_CONFIG_READY   23U
 
#define ZB_NWK_SIGNAL_NO_ACTIVE_LINKS_LEFT   24U
 
#define ZB_SE_SIGNAL_SKIP_JOIN   25U
 
#define ZB_SE_SIGNAL_REJOIN_STARTED   ZB_BDB_SIGNAL_WWAH_REJOIN_STARTED
 
#define ZB_SE_SIGNAL_REJOIN   26U
 
#define ZB_SE_SIGNAL_CHILD_REJOIN   27U
 
#define ZB_SE_TC_SIGNAL_CHILD_JOIN_CBKE   28U
 
#define ZB_SE_TC_SIGNAL_CHILD_JOIN_NON_CBKE   29U
 
#define ZB_SE_SIGNAL_CBKE_FAILED   30U
 
#define ZB_SE_SIGNAL_CBKE_OK   31U
 
#define ZB_SE_SIGNAL_SERVICE_DISCOVERY_START   32U
 
#define ZB_SE_SIGNAL_SERVICE_DISCOVERY_DO_BIND   33U
 
#define ZB_SE_SIGNAL_SERVICE_DISCOVERY_BIND_OK   34U
 
#define ZB_SE_SIGNAL_SERVICE_DISCOVERY_BIND_FAILED   35U
 
#define ZB_SE_SIGNAL_SERVICE_DISCOVERY_BIND_INDICATION   36U
 
#define ZB_SE_SIGNAL_SERVICE_DISCOVERY_OK   37U
 
#define ZB_SE_SIGNAL_SERVICE_DISCOVERY_FAILED   38U
 
#define ZB_SE_SIGNAL_APS_KEY_READY   39U
 
#define ZB_SE_SIGNAL_APS_KEY_FAIL   40U
 
#define ZB_SIGNAL_SUBGHZ_SUSPEND   41U
 
#define ZB_SIGNAL_SUBGHZ_RESUME   42U
 
#define ZB_ZDO_SIGNAL_DEVICE_AUTHORIZED   47U
 
#define ZB_ZDO_SIGNAL_DEVICE_UPDATE   48U
 
#define ZB_ZDO_SIGNAL_DEVICE_READY_FOR_INTERVIEW   49U
 
#define ZB_ZDO_SIGNAL_DEVICE_INTERVIEW_STARTED   50U
 
#define ZB_NWK_SIGNAL_PANID_CONFLICT_DETECTED   51U
 
#define ZB_NLME_STATUS_INDICATION   52U
 
#define ZB_TCSWAP_DB_BACKUP_REQUIRED_SIGNAL   53U
 
#define ZB_TC_SWAPPED_SIGNAL   54U
 
Status codes for F&B Initiator Finished signal

#define ZB_ZDO_FB_INITIATOR_STATUS_SUCCESS   0U
 
#define ZB_ZDO_FB_INITIATOR_STATUS_CANCEL   1U
 
#define ZB_ZDO_FB_INITIATOR_STATUS_ALARM   2U
 
#define ZB_ZDO_FB_INITIATOR_STATUS_ERROR   3U
 
Security/rejoin states of the 'status' field of APSME-Update-Device
See also
Table 4.40
#define ZB_STD_SEQ_SECURED_REJOIN   0U
 
#define ZB_STD_SEQ_UNSECURED_JOIN   1U
 
#define ZB_DEVICE_LEFT   2U
 
#define ZB_STD_SEQ_UNSECURED_REJOIN   3U
 
#define ZB_JOIN_WITH_DLK   6U
 
TC action on incoming Update Device

#define ZB_TC_ACTION_AUTHORIZE   0u
 
#define ZB_TC_ACTION_DENY   1u
 
#define ZB_TC_ACTION_IGNORE   2u
 
Authorization types for @ref ZB_ZDO_SIGNAL_DEVICE_AUTHORIZED

#define ZB_ZDO_AUTHORIZATION_TYPE_LEGACY   0U
 
#define ZB_ZDO_AUTHORIZATION_TYPE_R21_TCLK   1U
 
#define ZB_ZDO_AUTHORIZATION_TYPE_SE_CBKE   2U
 
#define ZB_ZDO_AUTHORIZATION_TYPE_DLK   3U
 
Authorization statuses for ZB_ZDO_AUTHORIZATION_TYPE_LEGACY value of @ref

zdo_authorization_type type.

#define ZB_ZDO_LEGACY_DEVICE_AUTHORIZATION_SUCCESS   0U
 
#define ZB_ZDO_LEGACY_DEVICE_AUTHORIZATION_FAILED   1U
 
Authorization statuses for ZB_ZDO_AUTHORIZATION_TYPE_R21_TCLK and ZB_ZDO_AUTHORIZATION_TYPE_DLK

values zdo_authorization_type

#define ZB_ZDO_TCLK_AUTHORIZATION_SUCCESS   0U
 
#define ZB_ZDO_TCLK_AUTHORIZATION_TIMEOUT   1U
 
#define ZB_ZDO_TCLK_AUTHORIZATION_FAILED   2U
 
Authorization statuses for ZB_ZDO_AUTHORIZATION_TYPE_SE_CBKE value @ref zdo_authorization_type

For non-success statuses

See also
zb_kec_term_status_t
#define ZB_ZDO_CBKE_AUTHORIZATION_SUCCESS   0U
 
Bind destination address mode

The addressing mode for the destination address used in zb_zdo_binding_table_record_s, zb_zdo_bind_req_param_s, zb_zdo_bind_req_head_s command. This field can take one of the non-reserved values from the list of defines below (bind_dst_addr_mode). Values 0x00, 0x02, 0x04-0xff are reserved.

See also
ZB Spec, subclause 2.4.3.2.2.
#define ZB_BIND_DST_ADDR_MODE_16_BIT_GROUP   0x01U
 
#define ZB_BIND_DST_ADDR_MODE_64_BIT_EXTENDED   0x03U
 

Typedefs

typedef zb_uint8_t zb_zdp_status_t
 Type for ZDP status values. More...
 
typedef zb_uint8_t zb_zdo_app_signal_type_t
 Type for signals passed to an application signal handler. More...
 
typedef zb_zdo_app_signal_type_t zb_zdo_app_signal_t
 
typedef struct zb_zdo_signal_leave_params_s zb_zdo_signal_leave_params_t
 Leave parameters. More...
 
typedef struct zb_zdo_signal_nlme_status_indication_params_s zb_zdo_signal_nlme_status_indication_params_t
 NLME status indication parameters. More...
 
typedef struct zb_zdo_signal_leave_indication_params_s zb_zdo_signal_leave_indication_params_t
 Leave Indication parameters. More...
 
typedef struct zb_se_signal_service_discovery_bind_params_s zb_se_signal_service_discovery_bind_params_t
 Service Discovery Bind signal parameters. More...
 
typedef struct zb_zgp_signal_commissioning_params_s zb_zgp_signal_commissioning_params_t
 ZGP commissioning parameters. More...
 
typedef struct zb_zgp_signal_approve_comm_params_s zb_zgp_signal_approve_comm_params_t
 ZGP approve commissioning parameters. More...
 
typedef struct zb_zgp_signal_mode_change_params_s zb_zgp_signal_mode_change_params_t
 ZGP mode changed parameters. More...
 
typedef struct zb_zdo_device_unavailable_params_s zb_zdo_device_unavailable_params_t
 Device unavailable signal parameters. More...
 
typedef struct zb_nwk_signal_device_associated_params_s zb_nwk_signal_device_associated_params_t
 Association parameters. More...
 
typedef struct zb_zdo_signal_device_annce_params_s zb_zdo_signal_device_annce_params_t
 Association parameters. More...
 
typedef struct zb_bdb_signal_touchlink_nwk_started_params_s zb_bdb_signal_touchlink_nwk_started_params_t
 
typedef struct zb_bdb_signal_touchlink_nwk_joined_router_s zb_bdb_signal_touchlink_nwk_joined_router_t
 
typedef struct zb_zdo_signal_can_sleep_params_s zb_zdo_signal_can_sleep_params_t
 Sleep signal parameters. More...
 
typedef struct zb_zdo_signal_macsplit_dev_boot_params_s zb_zdo_signal_macsplit_dev_boot_params_t
 MAC-Split device boot parameters. More...
 
typedef zb_uint8_t zb_zdo_fb_initiator_finished_status_t
 Type for Status codes for F&B Initiator Finished signal. More...
 
typedef struct zb_zdo_signal_fb_initiator_finished_params_s zb_zdo_signal_fb_initiator_finished_params_t
 F&B Initiator Finished signal parameters. More...
 
typedef struct zb_zdo_signal_device_update_params_s zb_zdo_signal_device_update_params_t
 Device Updated signal parameters. More...
 
typedef struct zb_zdo_signal_device_ready_for_interview_params_s zb_zdo_signal_device_ready_for_interview_params_t
 Device Ready For Interview signal parameters. More...
 
typedef zb_uint8_t zb_zdo_authorization_type_t
 Type for Authorization types for ZB_ZDO_SIGNAL_DEVICE_AUTHORIZED. More...
 
typedef zb_uint8_t zb_zdo_legacy_device_authorization_status_t
 Type for Authorization statuses for ZB_ZDO_AUTHORIZATION_TYPE_LEGACY value of zdo_authorization_type type. More...
 
typedef zb_uint8_t zb_zdo_tclk_authorization_status_t
 Type for Authorization types for ZB_ZDO_SIGNAL_DEVICE_AUTHORIZED. More...
 
typedef struct zb_zdo_signal_device_authorized_params_s zb_zdo_signal_device_authorized_params_t
 Device Authorized signal parameters. More...
 
typedef struct zb_debug_signal_tclk_ready_params_s zb_debug_signal_tclk_ready_params_t
 TCLK Read debug signal parameters. More...
 
typedef struct zb_zdo_app_signal_hdr_s zb_zdo_app_signal_hdr_t
 
typedef zb_zdo_app_signal_hdr_t zb_zdo_app_event_t
 
typedef struct zb_zdo_callback_info_s zb_zdo_callback_info_t
 
typedef struct zb_zdo_default_resp_s zb_zdo_default_resp_t
 
typedef struct zb_zdo_get_diag_data_req_params_s zb_zdo_get_diag_data_req_params_t
 
typedef struct zb_zdo_get_diag_data_resp_params_s zb_zdo_get_diag_data_resp_params_t
 
typedef struct zb_zdo_nwk_addr_req_s zb_zdo_nwk_addr_req_t
 NWK_addr_req command primitive. More...
 
typedef struct zb_zdo_nwk_addr_req_param_s zb_zdo_nwk_addr_req_param_t
 Parameters for nwk_addr_req command. More...
 
typedef struct zb_zdo_nwk_addr_resp_head_s zb_zdo_nwk_addr_resp_head_t
 NWK_addr_req response frame. More...
 
typedef struct zb_zdo_nwk_addr_resp_ext_s zb_zdo_nwk_addr_resp_ext_t
 NWK_addr_req response frame tail. More...
 
typedef struct zb_zdo_nwk_addr_resp_ext2_s zb_zdo_nwk_addr_resp_ext2_t
 NWK_addr_req response frame tail. More...
 
typedef struct zb_zdo_ieee_addr_req_s zb_zdo_ieee_addr_req_t
 Parameters of IEEE_addr_req primitive. More...
 
typedef struct zb_zdo_ieee_addr_req_param_s zb_zdo_ieee_addr_req_param_t
 Parameters for ieee_addr_req command. More...
 
typedef struct zb_zdo_ieee_addr_resp_s zb_zdo_ieee_addr_resp_t
 
typedef struct zb_zdo_ieee_addr_resp_ext_s zb_zdo_ieee_addr_resp_ext_t
 ZDO IEEE address response frame tail. More...
 
typedef struct zb_zdo_ieee_addr_resp_ext2_s zb_zdo_ieee_addr_resp_ext2_t
 ZDO IEEE address response frame tail. More...
 
typedef struct zb_zdo_node_desc_req_s zb_zdo_node_desc_req_t
 Parameters of Node_desc_req primitive. More...
 
typedef struct zb_zdo_desc_resp_hdr_s zb_zdo_desc_resp_hdr_t
 Header of Node_desc_resp primitive. More...
 
typedef struct zb_zdo_node_desc_resp_s zb_zdo_node_desc_resp_t
 Parameters of Node_desc_resp primitive. More...
 
typedef struct zb_zdo_simple_desc_resp_hdr_s zb_zdo_simple_desc_resp_hdr_t
 Header of simple_desc_resp primitive. More...
 
typedef struct zb_zdo_simple_desc_resp_s zb_zdo_simple_desc_resp_t
 Parameters of simple_desc_resp primitive. More...
 
typedef struct zb_zdo_child_info_s zb_zdo_child_info_t
 
typedef struct zb_zdo_parent_annce_s zb_zdo_parent_annce_t
 Header of parent_annce primitive. More...
 
typedef struct zb_zdo_parent_annce_rsp_hdr_s zb_zdo_parent_annce_rsp_hdr_t
 Header of parent_annce_rsp primitive. More...
 
typedef struct zb_zdo_parent_annce_rsp_s zb_zdo_parent_annce_rsp_t
 Parameters of parent_annce_rsp primitive. More...
 
typedef struct zb_zdo_power_desc_resp_s zb_zdo_power_desc_resp_t
 Parameters of Power_desc_resp primitive. More...
 
typedef struct zb_zdo_power_desc_req_s zb_zdo_power_desc_req_t
 Parameters of Power_desc_req primitive. More...
 
typedef struct zb_zdo_simple_desc_req_s zb_zdo_simple_desc_req_t
 Parameters of Simple_desc_req primitive. More...
 
typedef struct zb_zdo_active_ep_req_s zb_zdo_active_ep_req_t
 Parameters of Active_desc_req primitive. More...
 
typedef struct zb_zdo_ep_resp_s zb_zdo_ep_resp_t
 Active EP response. More...
 
typedef struct zb_zdo_match_desc_param_s zb_zdo_match_desc_param_t
 Parameters of match_desc_req primitive. More...
 
typedef struct zb_zdo_match_desc_req_head_s zb_zdo_match_desc_req_head_t
 Match_desc_req head. More...
 
typedef struct zb_zdo_match_desc_req_tail_s zb_zdo_match_desc_req_tail_t
 Match_desc_req tail. More...
 
typedef struct zb_zdo_match_desc_resp_s zb_zdo_match_desc_resp_t
 Match_Desc_rsp response structure. More...
 
typedef struct zb_zdo_system_server_discovery_req_s zb_zdo_system_server_discovery_req_t
 Request parameters for System_Server_Discovery_req. More...
 
typedef zb_zdo_system_server_discovery_req_t zb_zdo_system_server_discovery_param_t
 Parameters for System_Server_Discovery_req call. More...
 
typedef struct zb_zdo_system_server_discovery_resp_s zb_zdo_system_server_discovery_resp_t
 Response parameters for System_Server_Discovery_rsp. More...
 
typedef struct zb_zdo_mgmt_nwk_update_req_hdr_s zb_zdo_mgmt_nwk_update_req_hdr_t
 Header of parameters for Mgmt_NWK_Update_req. More...
 
typedef struct zb_zdo_mgmt_nwk_update_req_s zb_zdo_mgmt_nwk_update_req_t
 Parameters for Mgmt_NWK_Update_req. More...
 
typedef struct zb_zdo_mgmt_nwk_enhanced_update_req_param_s zb_zdo_mgmt_nwk_enhanced_update_req_param_t
 Parameters for Mgmt_NWK_Update_req internal call. More...
 
typedef struct zb_zdo_mgmt_nwk_enhanced_update_req_hdr_s zb_zdo_mgmt_nwk_enhanced_update_req_hdr_t
 Header of parameters for Mgmt_NWK_Update_req. More...
 
typedef struct zb_zdo_mgmt_nwk_update_notify_hdr_s zb_zdo_mgmt_nwk_update_notify_hdr_t
 Header parameters for mgmt_nwk_update_notify. More...
 
typedef struct zb_zdo_mgmt_nwk_update_notify_param_s zb_zdo_mgmt_nwk_update_notify_param_t
 Parameters for mgmt_nwk_update_notify. More...
 
typedef zb_zdo_mgmt_nwk_update_notify_param_t zb_zdo_mgmt_nwk_enhanced_update_notify_param_t
 
typedef struct zb_zdo_mgmt_nwk_unsol_enh_update_notify_s zb_zdo_mgmt_nwk_unsol_enh_update_notify_t
 Notification for Mgmt_NWK_Unsolicited_Enhanced_Update_Notify. More...
 
typedef struct zb_zdo_mgmt_nwk_unsol_enh_update_notify_param_s zb_zdo_mgmt_nwk_unsol_enh_update_notify_param_t
 Parameters for Mgmt_NWK_Unsolicited_Enhanced_Update_Notify. More...
 
typedef struct zb_zdo_mgmt_lqi_param_s zb_zdo_mgmt_lqi_param_t
 Parameters for Mgmt_Lqi_req. More...
 
typedef struct zb_zdo_mgmt_lqi_req_s zb_zdo_mgmt_lqi_req_t
 Request for Mgmt_Lqi_req. More...
 
typedef struct zb_zdo_mgmt_lqi_resp_s zb_zdo_mgmt_lqi_resp_t
 Response for Mgmt_Lqi_rsp. More...
 
typedef struct zb_zdo_neighbor_table_record_s zb_zdo_neighbor_table_record_t
 NeighborTableList Record Format for Mgmt_Lqi_resp. More...
 
typedef struct zb_zdo_mgmt_rtg_param_s zb_zdo_mgmt_rtg_param_t
 Parameters for Mgmt_rtg_req. More...
 
typedef struct zb_zdo_mgmt_rtg_req_s zb_zdo_mgmt_rtg_req_t
 Request for Mgmt_rtg_req. More...
 
typedef struct zb_zdo_mgmt_rtg_resp_s zb_zdo_mgmt_rtg_resp_t
 Response for Mgmt_Rtg_rsp. More...
 
typedef struct zb_zdo_routing_table_record_s zb_zdo_routing_table_record_t
 RoutingTableList Record Format for mgmt_rtg_resp. More...
 
typedef struct zb_energy_detect_channel_info_s zb_energy_detect_channel_info_t
 
typedef struct zb_energy_detect_list_s zb_energy_detect_list_t
 
typedef struct zb_nlme_ed_scan_request_s zb_nlme_ed_scan_request_t
 
typedef struct zb_zdo_ed_scan_param_s zb_zdo_ed_scan_param_t
 
typedef struct zb_zdo_active_scan_request_s zb_zdo_active_scan_request_t
 Parameters for active_scan_req. More...
 
typedef struct zb_nlme_network_descriptor_s zb_nlme_network_descriptor_t
 Network descriptor. This is a part of network discovery confirm result. More...
 
typedef struct zb_zdo_active_scan_resp_s zb_zdo_active_scan_resp_t
 Parameters for active_scan_resp. More...
 
typedef zb_uint8_t zb_bind_dst_addr_mode_t
 Type for bind destination address mode. More...
 
typedef struct zb_zdo_mgmt_bind_param_s zb_zdo_mgmt_bind_param_t
 Parameters for Mgmt_Bind_req. More...
 
typedef struct zb_zdo_mgmt_bind_req_s zb_zdo_mgmt_bind_req_t
 Request for Mgmt_Bind_req. More...
 
typedef struct zb_zdo_mgmt_bind_resp_s zb_zdo_mgmt_bind_resp_t
 Response for Mgmt_Bind_rsp. More...
 
typedef struct zb_zdo_binding_table_record_s zb_zdo_binding_table_record_t
 BindingTableList Record Format for mgmt_bind_resp. See ZB spec, Table 2.131. More...
 
typedef struct zb_zdo_raw_req_param_s zb_zdo_raw_req_param_t
 Parameters for zb_zdo_raw_req call. More...
 
typedef struct zb_zdo_raw_resp_param_s zb_zdo_raw_resp_param_t
 Parameters of zb_zdo_raw_resp call. More...
 
typedef struct zb_zdo_raw_resp_s zb_zdo_raw_resp_t
 Response by Raw_req. More...
 
typedef struct zb_zdo_bind_req_param_s zb_zdo_bind_req_param_t
 Parameters for Bind_req API call. More...
 
typedef struct zb_zdo_bind_req_head_s zb_zdo_bind_req_head_t
 Bind_req request head send to the remote. More...
 
typedef struct zb_zdo_bind_req_tail_1_s zb_zdo_bind_req_tail_1_t
 Bind_req request tail 1st variant send to the remote. More...
 
typedef struct zb_zdo_bind_req_tail_2_s zb_zdo_bind_req_tail_2_t
 Bind_req request tail 2nd variant send to the remote. More...
 
typedef struct zb_zdo_status_resp_s zb_zdo_status_resp_t
 
typedef struct zb_zdo_bind_resp_s zb_zdo_bind_resp_t
 Response by Bind_req. More...
 
typedef struct zb_zdo_set_configuration_resp_s zb_zdo_set_configuration_resp_t
 Response by ZDO Set Configuration req. More...
 
typedef struct zb_zdo_mgmt_leave_param_s zb_zdo_mgmt_leave_param_t
 Request for Mgmt_Leave_req. More...
 
typedef struct zb_zdo_mgmt_leave_req_s zb_zdo_mgmt_leave_req_t
 
typedef struct zb_zdo_mgmt_leave_res_s zb_zdo_mgmt_leave_res_t
 Response for Mgmt_Leave_rsp. More...
 
typedef struct zb_zdo_end_device_bind_req_head_s zb_zdo_end_device_bind_req_head_t
 End_Device_Bind_req command head. More...
 
typedef struct zb_zdo_end_device_bind_req_tail_s zb_zdo_end_device_bind_req_tail_t
 End_Device_Bind_req command head. More...
 
typedef struct zb_end_device_bind_req_param_s zb_end_device_bind_req_param_t
 Parameters for End_Device_Bind_req. More...
 
typedef struct zb_zdo_end_device_bind_resp_s zb_zdo_end_device_bind_resp_t
 Response from End_Device_Bind_req. More...
 
typedef zb_uint8_t zb_post_join_key_upd_method_t
 
typedef struct zb_zdo_secur_get_auth_level_req_s zb_zdo_secur_get_auth_level_req_t
 Parameters for get authentication level request. More...
 
typedef struct zb_zdo_secur_get_auth_level_rsp_s zb_zdo_secur_get_auth_level_rsp_t
 
typedef struct zb_zdo_mgmt_permit_joining_req_s zb_zdo_mgmt_permit_joining_req_t
 Parameters for Mgmt_Permit_Joining_req. More...
 
typedef struct zb_zdo_mgmt_permit_joining_req_param_s zb_zdo_mgmt_permit_joining_req_param_t
 Parameters for zb_zdo_mgmt_permit_joining_req. More...
 
typedef struct zb_zdo_mgmt_permit_joining_resp_s zb_zdo_mgmt_permit_joining_resp_t
 Response from zb_zdo_mgmt_permit_joining_req. More...
 
typedef struct zb_zdo_not_supported_resp_s zb_zdo_not_supported_resp_t
 Not Supported Response. More...
 
typedef struct zb_zdo_mgmt_nwk_ieee_joining_list_param_s zb_zdo_mgmt_nwk_ieee_joining_list_param_t
 Parameters for Mgmt_NWK_IEEE_Joining_List_req. More...
 
typedef struct zb_zdo_mgmt_nwk_ieee_joining_list_req_s zb_zdo_mgmt_nwk_ieee_joining_list_req_t
 Request for Mgmt_NWK_IEEE_Joining_List_req. More...
 
typedef struct zb_zdo_mgmt_nwk_ieee_joining_list_rsp_s zb_zdo_mgmt_nwk_ieee_joining_list_rsp_t
 Response for Mgmt_NWK_IEEE_Joining_List_rsp. More...
 
typedef struct zb_zdo_device_annce_s zb_zdo_device_annce_t
 
typedef struct zb_nlme_leave_indication_s zb_nlme_leave_indication_t
 
typedef struct zb_zdo_pim_get_long_poll_interval_resp_s zb_zdo_pim_get_long_poll_interval_resp_t
 
typedef struct zb_zdo_common_req_param_s zb_zdo_common_req_param_t
 
typedef struct zb_zdo_get_configuration_req_param_s zb_zdo_get_configuration_req_param_t
 ZDO Get Configuration Request parameters. More...
 
typedef struct zb_zdo_get_configuration_resp_param_s zb_zdo_get_configuration_resp_param_t
 ZDO Get Configuration Response parameters. More...
 
typedef struct zb_zdo_configuration_parameters_s zb_zdo_configuration_parameters_t
 Configuration parameters Stack sends set_configuration_req to the device with set values. More...
 
typedef struct zb_zdo_next_panid_change_parameters_s zb_zdo_next_panid_change_parameters_t
 Next PAN ID change parameters Stack sends set_configuration_req to the device with set values. More...
 
typedef struct zb_zdo_next_channel_change_parameters_s zb_zdo_next_channel_change_parameters_t
 Next channel change parameters Stack sends set_configuration_req to the device with set values. More...
 
typedef struct zb_zdo_clear_all_bind_req_param_s zb_zdo_clear_all_bind_req_param_t
 Parameters for zdo_clear_all_bind_req. More...
 
typedef zb_zdo_clear_all_bind_req_param_t zb_zdo_decommission_req_param_t
 
typedef struct zb_zdo_mgmt_beacon_survey_param_s zb_zdo_mgmt_beacon_survey_param_t
 Parameters for beacon_survey_req command. More...
 
typedef struct zb_zcl_wwah_beacon_survey_s zb_zcl_wwah_beacon_survey_t
 
typedef zb_zcl_wwah_beacon_survey_t zb_zdo_beacon_survey_parent_info_t
 
typedef struct zb_zdo_beacon_survey_results_t zb_zdo_beacon_survey_results_t
 R23, I.3.3 Beacon Survey Configuration TLV. More...
 
typedef struct zb_zdo_beacon_survey_potential_parents_t zb_zdo_beacon_survey_potential_parents_t
 R23, I.3.5 Potential Parents TLV. More...
 
typedef struct zb_zdo_beacon_survey_resp_params_s zb_zdo_beacon_survey_resp_params_t
 Structure to store information when 'Beacon Survey' procedure is executing. More...
 

Functions

zb_zdo_app_signal_type_t zb_get_app_signal (zb_uint8_t param, zb_zdo_app_signal_hdr_t **sg_p)
 Unpack application signal buffer in zboss_signal_handler() More...
 
void zb_zdo_get_diag_data (zb_uint16_t short_address, zb_uint8_t *lqa, zb_int8_t *rssi)
 Obtains last known LQA and RSSI values from device with specified short address. More...
 
zb_ret_t zb_zdo_get_diag_data_async (zb_bufid_t buf, zb_callback_t cb)
 Obtains last known LQI and RSSI values from the device with the specified short address. More...
 
zb_uint8_t zb_zdo_nwk_addr_req (zb_uint8_t param, zb_callback_t cb)
 Sends NWK_addr_req primitive. More...
 
zb_uint8_t zb_zdo_ieee_addr_req (zb_uint8_t param, zb_callback_t cb)
 IEEE_addr_req primitive. More...
 
zb_uint8_t zb_zdo_node_desc_req (zb_uint8_t param, zb_callback_t cb)
 Node_desc_req primitive. More...
 
zb_uint8_t zb_zdo_power_desc_req (zb_uint8_t param, zb_callback_t cb)
 Power_desc_req primitive. More...
 
zb_uint8_t zb_zdo_simple_desc_req (zb_uint8_t param, zb_callback_t cb)
 Simple_desc_req primitive. More...
 
zb_uint8_t zb_zdo_active_ep_req (zb_uint8_t param, zb_callback_t cb)
 Active_desc_req primitive. More...
 
zb_uint8_t zb_zdo_match_desc_req (zb_uint8_t param, zb_callback_t cb)
 Match_desc_req primitive. More...
 
zb_uint8_t zb_zdo_system_server_discovery_req (zb_uint8_t param, zb_callback_t cb)
 Performs System_Server_Discovery_req. More...
 
zb_uint8_t zb_zdo_mgmt_nwk_update_req (zb_uint8_t param, zb_callback_t cb)
 Performs Mgmt_NWK_Update_req request. More...
 
zb_uint8_t zb_zdo_mgmt_nwk_enh_update_req (zb_uint8_t param, zb_callback_t cb)
 Performs Mgmt_NWK_Enhanced_Update_req request. More...
 
void zb_zdo_mgmt_nwk_unsol_enh_update_notify (zb_uint8_t param, zb_callback_t cb)
 Performs Mgmt_NWK_Enhanced_Update_req request. More...
 
zb_uint8_t zb_zdo_mgmt_lqi_req (zb_uint8_t param, zb_callback_t cb)
 Sends Mgmt_Lqi_req (see Zigbee spec 2.4.3.3.2) More...
 
zb_uint8_t zb_zdo_mgmt_rtg_req (zb_uint8_t param, zb_callback_t cb)
 
void zdo_mgmt_rtg_resp (zb_uint8_t param)
 
void zb_zdo_ed_scan_request (zb_uint8_t param)
 Performs energy scan. More...
 
void zb_zdo_active_scan_request (zb_uint8_t param)
 Performs active scan. More...
 
zb_uint8_t zb_zdo_mgmt_bind_req (zb_uint8_t param, zb_callback_t cb)
 Sends Mgmt_Bind_req request. More...
 
void zdo_mgmt_bind_resp (zb_uint8_t param)
 Sends 2.4.4.3.4 Mgmt_Bind_rsp. More...
 
zb_uint8_t zb_zdo_bind_req (zb_uint8_t param, zb_callback_t cb)
 Bind_req request. More...
 
zb_uint8_t zb_zdo_unbind_req (zb_uint8_t param, zb_callback_t cb)
 Unbind_req request. More...
 
zb_uint8_t zb_zdo_clear_all_bind_req (zb_uint8_t param, zb_callback_t cb)
 
void zb_zdo_unbind_all_local (zb_uint8_t param)
 Perform unbind all entries locally. This custom function and it is not described in Zigbee specification. More...
 
void zb_zdo_check_binding_request (zb_bufid_t param)
 Checks if the binding with specified parameters exists. More...
 
zb_uint8_t zdo_mgmt_leave_req (zb_uint8_t param, zb_callback_t cb)
 Sends Mgmt_Leave_req. More...
 
zb_uint8_t zb_end_device_bind_req (zb_uint8_t param, zb_callback_t cb)
 
zb_uint8_t zb_zdo_get_auth_level_req (zb_uint8_t param, zb_callback_t cb)
 Get authentication level for target device. More...
 
void zb_set_tc_connectivity (zb_bool_t val)
 
zb_bool_t zb_get_tc_connectivity (void)
 
void zb_set_nwk_preferred_parent (zb_bool_t val)
 
zb_uint8_t zb_zdo_mgmt_permit_joining_req (zb_uint8_t param, zb_callback_t cb)
 sends Mgmt_Permit_Joining_req (See Zigbee spec 2.4.3.3.7) More...
 
void zb_zdo_add_group_req (zb_uint8_t param)
 ZDO interface for ADD-GROUP.request. More...
 
void zb_zdo_remove_group_req (zb_uint8_t param)
 ZDO interface for REMOVE-GROUP.request. More...
 
void zb_zdo_remove_all_groups_req (zb_uint8_t param)
 ZDO interface for REMOVE-ALL-GROUPS.request. More...
 
void zb_zdo_get_group_membership_req (zb_uint8_t param)
 ZDO interface for ZCL Get Group Membership Command. More...
 
void zb_zdo_pim_permit_turbo_poll (zb_bool_t permit)
 Toggle Turbo Poll feature. More...
 
void zb_zdo_pim_toggle_turbo_poll_retry_feature (zb_bool_t enable)
 Toggle Turbo Poll retry feature. This feature enables device to retry polling attempt some times in case if device haven't got any data after receiving ack with pending bit set. This feature can be toggled after joining/rejoining any network. It restores its default value upon leave. Default value: disabled. More...
 
void zb_zdo_pim_start_turbo_poll_packets (zb_uint8_t n_packets)
 Start Turbo Poll adaptive algorithm for the number of packets. Turbo Poll will be disabled after receiving the specified number of packets or after the poll timeout will rise up to the Long Poll interval. More...
 
void zb_zdo_pim_set_long_poll_interval (zb_time_t ms)
 Change the Long Poll interval. More...
 
void zb_zdo_pim_start_turbo_poll_continuous (zb_time_t turbo_poll_timeout_ms)
 Start the Turbo Poll adaptive algorithm for the specified timeout. More...
 
void zb_zdo_pim_turbo_poll_continuous_leave (zb_uint8_t param)
 Stop the Turbo Poll adaptive algorithm initiated by zb_zdo_pim_start_turbo_poll_continuous before the timeout expires. Restores the Long Poll interval. More...
 
void zb_zdo_pim_get_long_poll_interval_req (zb_uint8_t param, zb_callback_t cb)
 Get the Long Poll Interval. More...
 
zb_ret_t zb_zdo_set_lpd_cmd_mode (zb_uint8_t mode)
 
void zb_zdo_set_lpd_cmd_timeout (zb_uint16_t timeout)
 
void zb_zdo_disable_network_mgmt_channel_update (zb_bool_t disable)
 Disable channel update (affected for coordinator role only) More...
 
void zb_zdo_set_aps_unsecure_join (zb_bool_t insecure_join)
 Setups insecure join flag. More...
 
void zb_zdo_set_tc_standard_distributed_key (zb_uint8_t *key_ptr)
 Set custom distributed key. More...
 
void zb_zdo_setup_network_as_distributed (void)
 Allow to setup network as distributed when started. More...
 
void zb_enable_distributed (void)
 
void zb_disable_distributed (void)
 Disable distributed security network formation at runtime. More...
 
void zb_bdb_enable_distributed_network_formation (void)
 Enable distributed security network formation at runtime. More...
 
void zb_bdb_disable_distributed_network_formation (void)
 Disable distributed security network formation at runtime. More...
 
void zb_bdb_enable_distributed_formation (zb_bool_t enable)
 Enable/disable distributed security network formation at runtime. More...
 
zb_bool_t zb_is_network_distributed (void)
 Check if the current network is a distributed security network. More...
 
void zb_af_set_data_indication (zb_device_handler_t cb)
 Set up application callback to be called for APS data packets. More...
 
void zb_bdb_reset_via_local_action (zb_uint8_t param)
 Perform "Reset with a Local Action" procedure (as described in BDB spec, chapter 9.5). The device will perform the NLME leave and clean all Zigbee persistent data except the outgoing NWK frame counter and application datasets (if any). The reset can be performed at any time once the device is started (see zboss_start). After the reset, the application will receive the ZB_ZDO_SIGNAL_LEAVE signal. More...
 
void zb_bdb_initiate_tc_rejoin (zb_uint8_t param)
 Starts TC rejoin procedure. More...
 
zb_uint8_t zb_zdo_send_configuration_parameters (zb_uint8_t param, zb_callback_t cb)
 Sends secur_set_configuration_req command with configuration parameters. More...
 
zb_uint8_t zb_zdo_send_next_panid_change (zb_uint8_t param, zb_callback_t cb)
 Sends secur_set_configuration_req command with next pan id change information. More...
 
zb_uint8_t zb_zdo_send_next_channel_change (zb_uint8_t param, zb_callback_t cb)
 Sends secur_set_configuration_req command with next channel change information. More...
 
zb_uint8_t zb_zdo_get_configuration_req (zb_uint8_t param, zb_callback_t cb)
 Sends Secur_Get_Configuration_req command. More...
 
zb_uint8_t * zdo_fill_get_configuration_req (zb_uint8_t param, zb_uint16_t dst, zb_uint8_t tlv_count, zb_uint8_t first_tlv_id)
 Start filling of body of ZDO Secur Get Configuration Req. More...
 
zb_uint8_t zb_zdo_decommission_req (zb_uint8_t param, zb_callback_t cb)
 Sends Secur_Decommission_req command. More...
 
zb_ret_t zb_zdo_secur_update_device_tclk (zb_uint8_t param, zb_ieee_addr_t dev_ieee_addr)
 Send Security_Key_Update_req for update EXISTING verified tclk. More...
 
zb_uint8_t zdo_mgmt_beacon_survey_req (zb_uint8_t param, zb_callback_t cb)
 Sends Mgmt beacon survey request. More...
 
void zboss_use_r22_behavior (void)
 
void zboss_use_r23_behavior (void)
 
void zb_nwk_use_r22_joining (zb_bool_t value)
 
zb_bool_t zb_tc_is_device_interview_enabled (void)
 
void zb_tc_enable_device_interview (zb_bool_t enable)
 
zb_ret_t zb_tc_auth_device_after_interview (const zb_ieee_addr_t device_addr)
 
void zb_tc_reject_device_after_interview (const zb_ieee_addr_t device_addr)
 
zb_bool_t zb_tc_is_interview_active_for_device (zb_uint16_t device_addr)
 

InitialJoinAuthentication enum (see Table 4-33)

Note: These values were members of enum zb_initial_join_auth_e type but were converted to a set of macros due to MISRA violations.

#define ZB_JOIN_NO_AUTHENTICATION   0x00U
 
#define ZB_JOIN_INSTALLCODE_KEY   0x01U
 
#define ZB_JOIN_ANON_KEY_NEG   0x02U
 
#define ZB_JOIN_AUTH_KEY_NEG   0x03U
 
typedef zb_uint8_t zb_initial_join_auth_t
 

Macro Definition Documentation

§ ZB_NWK_LPD_NOTIFICATION

#define ZB_NWK_LPD_NOTIFICATION   0x01U

§ ZB_NWK_LPD_REQUEST

#define ZB_NWK_LPD_REQUEST   0x02U

Function Documentation

§ zb_zdo_disable_network_mgmt_channel_update()

void zb_zdo_disable_network_mgmt_channel_update ( zb_bool_t  disable)

Disable channel update (affected for coordinator role only)

The current ZB channel can be changed inside the stack for internal reasons or as a result of processing Mgmt NWK Update Notify commands. Call this function to prevent such channel changes if it is not allowable for the application.

Parameters
disable- specify if channel update is disabled (enabled by default)

§ zb_zdo_set_aps_unsecure_join()

void zb_zdo_set_aps_unsecure_join ( zb_bool_t  insecure_join)

Setups insecure join flag.

§ zb_zdo_set_lpd_cmd_mode()

zb_ret_t zb_zdo_set_lpd_cmd_mode ( zb_uint8_t  mode)

§ zb_zdo_set_lpd_cmd_timeout()

void zb_zdo_set_lpd_cmd_timeout ( zb_uint16_t  timeout)
Copyright (c) 2012-2022 DSR Corporation, Golden CO, USA. http://www.dsr-zboss.com http://www.dsr-corporation.com
ZBOSS documentation. Wed Oct 29 2025.