nRF5 SDK for Thread and Zigbee v3.2.0
Macros | Functions

Macros

#define ZB_INIT(trace_comment)
 

Functions

zb_ret_t zboss_start (void)
 ZBOSS start function. More...
 
zb_ret_t zboss_start_no_autostart (void)
 
zb_ret_t zboss_start_in_sniffer_mode (void)
 
void zboss_sniffer_start (zb_uint8_t channel, zb_callback_t data_ind_cb)
 
void zboss_sniffer_stop (void)
 

Detailed Description

Macro Definition Documentation

#define ZB_INIT (   trace_comment)
Value:
{ \
ZB_CHECK_LIBRARY(); \
zb_init((zb_char_t *)trace_comment); \
}
char zb_char_t
Project-local char type.
Definition: zb_types.h:112

Global stack initialization.

To be called from MAIN() at start.

Usual initialization sequence: ZB_INIT(), then assign some IB values, then zboss_start().

Parameters
trace_comment- trace file name component (valid for Unix, ignored at MCU)

Example:

ZB_INIT("zdo_zc");

See any sample

Function Documentation

void zboss_sniffer_start ( zb_uint8_t  channel,
zb_callback_t  data_ind_cb 
)

Start sniffing

ZBOSS must be started in the sniffer mode.

Parameters
channel- channel to work on
data_ind_cb- callback to be called to pass data to the sniffer application
void zboss_sniffer_stop ( void  )

Stop sniffing or do nothing if not sniffing now.

ZBOSS must be started in the sniffer mode.

zb_ret_t zboss_start ( void  )

ZBOSS start function.

Typical device start: init, load some parameters from nvram and proceed with startup.

Startup means either Formation (for ZC), rejoin or discovery/association join. After startup complete zboss_signal_handler callback is called, so application will know when to do some useful things.

Precondition: stack must be inited by ZB_INIT() call. ZB_INIT() sets default IB parameters, so caller has a chance to change some of them. Note that NVRAM will be loaded after zboss_start() call.

Note
: ZB is not looped in this routine. Instead, it schedules callback and returns. Caller must run zboss_main_loop() after this routine.
Returns
RET_OK on success.
zb_ret_t zboss_start_in_sniffer_mode ( void  )

Start ZBOSS in the sniffer mode

Initialize ZBOSS MAC layer to work as a sniffer. Once ZBOSS is intialized in the sniffer mode, it can't be commissined in the normal mode until reboot.

zb_ret_t zboss_start_no_autostart ( void  )

Start ZBOSS with only minimal initialization, without starting commissioning.

This function initializes scheduler and buffers pool, but not MAC and upper layers. Typically zboss_start_no_autostart() is used when application is doing some additional initialization (HW init etc) and requires ZBOSS scheduler to be working. Application should later call ZBOSS commissioning initiation - for instance, bdb_start_top_level_commissioning(). To finish node initialization without triggering commissioning call bdb_start_top_level_commissioning() with commissioning mask 0 (no steering, no formation, initialization only).

Returns
RET_OK on success.

Documentation feedback | Developer Zone | Subscribe | Updated