NWK functions visible to applications

Macros
#define	ZB_NWK_IS_ADDRESS_BROADCAST(addr)   ( (addr) >= ZB_NWK_BROADCAST_RESERVED )
	Check that address is broadcast. More...
#define	ZB_MAC_LQI_UNDEFINED   0
#define	ZB_MAC_RSSI_UNDEFINED   0x7f
#define	ZB_MAC_MAX_CHANNEL_NUMBER   26
#define	ZB_MAC_SUPPORTED_CHANNELS   (ZB_MAC_MAX_CHANNEL_NUMBER + 1)
#define	ZB_PAGE0_2_4_GHZ_START_LOGICAL_CHANNEL   11
#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_PAGE0_2_4_GHZ_MAX_CHANNELS_COUNT

Typedefs
typedef enum zb_nwk_broadcast_address_e	zb_nwk_broadcast_address_t
	Network broadcast addresses types.
typedef enum zb_nwk_device_type_e	zb_nwk_device_type_t
typedef enum zb_nwk_leave_type_e	zb_nwk_leave_type_t
	Leave types.

Enumerations
enum	zb_nwk_broadcast_address_e {   ZB_NWK_BROADCAST_ALL_DEVICES = 0xFFFF, ZB_NWK_BROADCAST_RX_ON_WHEN_IDLE = 0xFFFD, ZB_NWK_BROADCAST_ROUTER_COORDINATOR = 0xFFFC, ZB_NWK_BROADCAST_LOW_POWER_ROUTER = 0xFFFB,   ZB_NWK_BROADCAST_RESERVED = 0xFFF8 }
	Network broadcast addresses types. More...
enum	zb_nwk_device_type_e { ZB_NWK_DEVICE_TYPE_COORDINATOR, ZB_NWK_DEVICE_TYPE_ROUTER, ZB_NWK_DEVICE_TYPE_ED, ZB_NWK_DEVICE_TYPE_NONE }
enum	zb_nwk_leave_type_e { ZB_NWK_LEAVE_TYPE_RESET = 0x00, ZB_NWK_LEAVE_TYPE_REJOIN = 0x01 }
	Leave types. More...

Functions
void	zb_start_concentrator_mode (zb_uint8_t radius, zb_uint32_t disc_time)
void	zb_stop_concentrator_mode (void)
zb_uint16_t	zb_nwk_get_parent (void)

Detailed Description

Macro Definition Documentation

#define ZB_MAC_LQI_UNDEFINED   0

LQI undefined value

#define ZB_MAC_MAX_CHANNEL_NUMBER   26

Number of the first channel Maximal number of the channels

#define ZB_MAC_RSSI_UNDEFINED   0x7f

RSSI undefined value

#define ZB_MAC_SUPPORTED_CHANNELS   (ZB_MAC_MAX_CHANNEL_NUMBER + 1)

Total number of supported channels

#define ZB_NWK_IS_ADDRESS_BROADCAST

(

addr

)

( (addr) >= ZB_NWK_BROADCAST_RESERVED )

Check that address is broadcast.

Parameters

addr	- 16-bit address

Returns

TRUE if address is broadcast, FALSE otherwise

#define ZB_PAGE0_2_4_GHZ_MAX_CHANNEL_NUMBER   ZB_MAC_MAX_CHANNEL_NUMBER

Number of the last channel in channel mask for Page 0 2.4GHz

#define ZB_PAGE0_2_4_GHZ_MAX_CHANNELS_COUNT

Value:

(ZB_PAGE0_2_4_GHZ_MAX_CHANNEL_NUMBER - \
 ZB_PAGE0_2_4_GHZ_START_CHANNEL_NUMBER + 1)

Maximal number of channels for Page 0 2.4GHz

#define ZB_PAGE0_2_4_GHZ_MAX_LOGICAL_CHANNEL   ZB_MAC_MAX_CHANNEL_NUMBER

The last logical channel in channel mask for Page 0 2.4GHz

#define ZB_PAGE0_2_4_GHZ_START_CHANNEL_NUMBER   ZB_PAGE0_2_4_GHZ_START_LOGICAL_CHANNEL

Number of the first channel in channel mask for Page 0 2.4GHz

#define ZB_PAGE0_2_4_GHZ_START_LOGICAL_CHANNEL   11

The first logical channel for Page 0 2.4GHz

Typedef Documentation

typedef enum zb_nwk_device_type_e zb_nwk_device_type_t

Network device type

Enumeration Type Documentation

enum zb_nwk_broadcast_address_e

Network broadcast addresses types.

Enumerator
ZB_NWK_BROADCAST_ALL_DEVICES	All devices in PAN
ZB_NWK_BROADCAST_RX_ON_WHEN_IDLE	macRxOnWhenIdle = TRUE
ZB_NWK_BROADCAST_ROUTER_COORDINATOR	All routers and coordinator
ZB_NWK_BROADCAST_LOW_POWER_ROUTER	Low power routers only
ZB_NWK_BROADCAST_RESERVED	Reserved value

enum zb_nwk_device_type_e

Network device type

Enumerator
ZB_NWK_DEVICE_TYPE_COORDINATOR	Device - Coordinator
ZB_NWK_DEVICE_TYPE_ROUTER	Device - Router
ZB_NWK_DEVICE_TYPE_ED	Device - End device
ZB_NWK_DEVICE_TYPE_NONE	Unknown Device

enum zb_nwk_leave_type_e

Leave types.

Enumerator
ZB_NWK_LEAVE_TYPE_RESET	Leave without rejoin
ZB_NWK_LEAVE_TYPE_REJOIN	Leave with rejoin

Function Documentation

zb_uint16_t zb_nwk_get_parent

(

void

)

Get short address of the parent node.

Returns

Short address of the parent node or ZB_UNKNOWN_SHORT_ADDR if the device isn't joined to a network.

void zb_start_concentrator_mode	(	zb_uint8_t	radius,
		zb_uint32_t	disc_time
	)

Enable Concentrator mode for the device (disabled by default). It's possible to call this function to send MTORR immediately, e.g. after a new device joined the network. It does affect only for Coordinator role.

Parameters

radius	- the hop count radius for concentrator route discoveries. If the value is set zero then the default radius will be used.
disc_time	- the time in seconds between concentrator route discoveries. If the value is set to zero, the route discoveries are done by the application layer only.

void zb_stop_concentrator_mode

(

void

)

Disable Concentrator mode for the device. It does affect only for Coordinator role.