Logo
Developing with ZBOSS for Zigbee
zboss_api_nwk.h File Reference

Data Structures

struct  zb_channel_panid_change_preparation_s
 Callback parameters for zb_prepare_network_for_channel_change() and zb_prepare_network_for_panid_change() Stack sends set_configuration_req to the all devices and count responses with incorrect status. More...
 
struct  zb_channel_change_parameters_s
 Parameters for zb_prepare_network_for_channel_change() and zb_start_channel_change() More...
 
struct  zb_panid_change_parameters_s
 Parameters for zb_prepare_network_for_panid_change() and zb_start_panid_change() More...
 
struct  zb_route_record_s
 Route record for public API usage. More...
 
struct  zb_nwk_nbr_iterator_cb_params_s
 
struct  zb_nwk_nbr_iterator_entry_s
 

Macros

#define ZB_NWK_MULTIMAC_ALL_INTERFACES   0xFFU
 Flag that is used to perform some action on all interfaces together. More...
 
#define ZB_NWK_IS_ADDRESS_BROADCAST(addr)   ( (addr) >= ZB_NWK_BROADCAST_RESERVED )
 Check that address is broadcast. More...
 
#define ZB_MAC_LQI_UNDEFINED   0U
 
#define ZB_MAC_RSSI_UNDEFINED   0x7fU
 
#define ZB_MAC_MAX_CHANNEL_NUMBER   26U
 
#define ZB_MAC_SUPPORTED_CHANNELS   (ZB_MAC_MAX_CHANNEL_NUMBER + 1U)
 
#define ZB_PAGE23_SUB_GHZ_START_LOGICAL_CHANNEL   0U
 
#define ZB_PAGE23_SUB_GHZ_START_CHANNEL_NUMBER   0U
 
#define ZB_PAGE23_SUB_GHZ_MAX_LOGICAL_CHANNEL   24U
 
#define ZB_PAGE23_SUB_GHZ_MAX_CHANNEL_NUMBER
 
#define ZB_PAGE24_SUB_GHZ_START_LOGICAL_CHANNEL   56U
 
#define ZB_PAGE24_SUB_GHZ_START_CHANNEL_NUMBER   0U
 
#define ZB_PAGE24_SUB_GHZ_MAX_LOGICAL_CHANNEL   76U
 
#define ZB_PAGE24_SUB_GHZ_MAX_CHANNEL_NUMBER
 
#define ZB_PAGE25_SUB_GHZ_START_LOGICAL_CHANNEL   0U
 
#define ZB_PAGE25_SUB_GHZ_START_CHANNEL_NUMBER   0U
 
#define ZB_PAGE25_SUB_GHZ_MAX_LOGICAL_CHANNEL   26U
 
#define ZB_PAGE25_SUB_GHZ_MAX_CHANNEL_NUMBER
 
#define ZB_PAGE26_SUB_GHZ_START_LOGICAL_CHANNEL   27U
 
#define ZB_PAGE26_SUB_GHZ_START_CHANNEL_NUMBER   0U
 
#define ZB_PAGE26_SUB_GHZ_MAX_LOGICAL_CHANNEL   34U
 
#define ZB_PAGE26_SUB_GHZ_MAX_CHANNEL_NUMBER
 
#define ZB_PAGE27_SUB_GHZ_START_LOGICAL_CHANNEL   35U
 
#define ZB_PAGE27_SUB_GHZ_START_CHANNEL_NUMBER   0U
 
#define ZB_PAGE27_SUB_GHZ_MAX_LOGICAL_CHANNEL   55U
 
#define ZB_PAGE27_SUB_GHZ_MAX_CHANNEL_NUMBER
 
#define ZB_PAGE28_SUB_GHZ_START_LOGICAL_CHANNEL   0U
 
#define ZB_PAGE28_SUB_GHZ_START_CHANNEL_NUMBER   0U
 
#define ZB_PAGE28_SUB_GHZ_MAX_LOGICAL_CHANNEL   26U
 
#define ZB_PAGE28_SUB_GHZ_MAX_CHANNEL_NUMBER
 
#define ZB_PAGE29_SUB_GHZ_START_LOGICAL_CHANNEL   27U
 
#define ZB_PAGE29_SUB_GHZ_START_CHANNEL_NUMBER   0U
 
#define ZB_PAGE29_SUB_GHZ_PRE_MAX_LOGICAL_CHANNEL   34U
 
#define ZB_PAGE29_SUB_GHZ_MAX_LOGICAL_CHANNEL   62U
 
#define ZB_PAGE29_SUB_GHZ_MAX_CHANNEL_NUMBER
 
#define ZB_PAGE30_SUB_GHZ_START_LOGICAL_CHANNEL   35U
 
#define ZB_PAGE30_SUB_GHZ_START_CHANNEL_NUMBER   0U
 
#define ZB_PAGE30_SUB_GHZ_MAX_LOGICAL_CHANNEL   61U
 
#define ZB_PAGE30_SUB_GHZ_MAX_CHANNEL_NUMBER
 
#define ZB_PAGE31_SUB_GHZ_START_LOGICAL_CHANNEL   0U
 
#define ZB_PAGE31_SUB_GHZ_START_CHANNEL_NUMBER   0U
 
#define ZB_PAGE31_SUB_GHZ_MAX_LOGICAL_CHANNEL   26U
 
#define ZB_PAGE31_SUB_GHZ_MAX_CHANNEL_NUMBER
 
#define ZB_PAGE0_2_4_GHZ_START_LOGICAL_CHANNEL   11U
 
#define ZB_PAGE0_2_4_GHZ_START_CHANNEL_NUMBER   ZB_PAGE0_2_4_GHZ_START_LOGICAL_CHANNEL
 
#define ZB_PAGE0_2_4_GHZ_MAX_LOGICAL_CHANNEL   ZB_MAC_MAX_CHANNEL_NUMBER
 
#define ZB_PAGE0_2_4_GHZ_MAX_CHANNEL_NUMBER   ZB_MAC_MAX_CHANNEL_NUMBER
 
#define ZB_PAGE23_SUB_GHZ_MAX_CHANNELS_COUNT
 
#define ZB_PAGE24_SUB_GHZ_MAX_CHANNELS_COUNT
 
#define ZB_PAGE25_SUB_GHZ_MAX_CHANNELS_COUNT
 
#define ZB_PAGE26_SUB_GHZ_MAX_CHANNELS_COUNT
 
#define ZB_PAGE27_SUB_GHZ_MAX_CHANNELS_COUNT
 
#define ZB_PAGE28_SUB_GHZ_MAX_CHANNELS_COUNT
 
#define ZB_PAGE29_SUB_GHZ_MAX_CHANNELS_COUNT
 
#define ZB_PAGE30_SUB_GHZ_MAX_CHANNELS_COUNT
 
#define ZB_PAGE31_SUB_GHZ_MAX_CHANNELS_COUNT
 
#define ZB_PAGE0_2_4_GHZ_MAX_CHANNELS_COUNT
 
#define ZB_ACTIVE_SCAN_MAX_NETWORK_COUNT   ((ZB_IO_BUF_SIZE - sizeof(zb_nlme_network_discovery_confirm_t)) / sizeof(zb_nlme_network_descriptor_t))
 
#define ZB_CHANNEL_PAGE_MAX_CHANNELS_COUNT   ZB_PAGE28_SUB_GHZ_MAX_CHANNELS_COUNT
 
#define ZB_NWK_NBR_ITERATOR_INDEX_EOT   0xFFFFU /*! Index, indicating that the iterator reached boundaries of the neighbour table. */
 
Network coordinator address
#define ZB_NWK_COORDINATOR_ADDR   0x0000U
 
Network broadcast addresses types

#define ZB_NWK_BROADCAST_ALL_DEVICES   0xFFFFu
 
#define ZB_NWK_BROADCAST_RX_ON_WHEN_IDLE   0xFFFDu
 
#define ZB_NWK_BROADCAST_ROUTER_COORDINATOR   0xFFFCu
 
#define ZB_NWK_BROADCAST_LOW_POWER_ROUTER   0xFFFBu
 
#define ZB_NWK_BROADCAST_RESERVED   0xFFF8u
 
Network device type

#define ZB_NWK_DEVICE_TYPE_COORDINATOR   0U
 
#define ZB_NWK_DEVICE_TYPE_ROUTER   1U
 
#define ZB_NWK_DEVICE_TYPE_ED   2U
 
#define ZB_NWK_DEVICE_TYPE_NONE   3U
 
Leave types

#define ZB_NWK_LEAVE_TYPE_RESET   0x00U
 
#define ZB_NWK_LEAVE_TYPE_REJOIN   0x01U
 

Typedefs

typedef zb_uint8_t zb_nwk_device_type_t
 Type for network device type. More...
 
typedef zb_uint8_t zb_nwk_leave_type_t
 Type for leave types. More...
 
typedef struct zb_channel_panid_change_preparation_s zb_channel_panid_change_preparation_t
 Callback parameters for zb_prepare_network_for_channel_change() and zb_prepare_network_for_panid_change() Stack sends set_configuration_req to the all devices and count responses with incorrect status. More...
 
typedef struct zb_channel_change_parameters_s zb_channel_change_parameters_t
 Parameters for zb_prepare_network_for_channel_change() and zb_start_channel_change() More...
 
typedef struct zb_panid_change_parameters_s zb_panid_change_parameters_t
 Parameters for zb_prepare_network_for_panid_change() and zb_start_panid_change() More...
 
typedef struct zb_route_record_s zb_route_record_t
 Route record for public API usage. More...
 
typedef struct zb_nwk_nbr_iterator_cb_params_s zb_nwk_nbr_iterator_params_t
 
typedef struct zb_nwk_nbr_iterator_entry_s zb_nwk_nbr_iterator_entry_t
 

Functions

zb_ret_t zb_prepare_network_for_channel_change (zb_uint8_t param, zb_callback_t cb)
 
zb_ret_t zb_prepare_network_for_panid_change (zb_uint8_t param, zb_callback_t cb)
 
zb_ret_t zb_start_channel_change (zb_uint8_t param)
 
zb_ret_t zb_start_panid_change (zb_uint8_t param)
 
void zb_enable_panid_conflict_resolution (zb_bool_t status)
 
void zb_enable_auto_pan_id_conflict_resolution (zb_bool_t status)
 
zb_ret_t zb_get_source_route (zb_route_record_t *p_route_record, zb_uint16_t short_dst_addr)
 
void zb_start_concentrator_mode (zb_uint8_t radius, zb_uint32_t disc_time)
 
void zb_stop_concentrator_mode (void)
 
zb_nwk_device_type_t zb_get_device_type (void)
 
zb_uint16_t zb_nwk_get_parent (void)
 
zb_ret_t zb_nwk_nbr_iterator_next (zb_uint8_t bufid, zb_callback_t cb)
 
zb_ret_t zb_nwk_set_max_ed_capacity (zb_uint8_t value)
 
zb_uint8_t zb_nwk_get_max_ed_capacity (void)
 
zb_uint8_t zb_nwk_get_total_capacity (void)