Developing with ZBOSS for Zigbee
BDB commissioning start & status

Typedefs

typedef enum zb_bdb_commissioning_mode_mask_e zb_bdb_commissioning_mode_mask_t
 BDB commissioning mode mask bits.
 

Enumerations

enum  zb_bdb_commissioning_mode_mask_e { ZB_BDB_NETWORK_STEERING = 2, ZB_BDB_NETWORK_FORMATION = 4, ZB_BDB_REJOIN = 0x80 }
 BDB commissioning mode mask bits. More...
 

Functions

zb_bool_t bdb_start_top_level_commissioning (zb_uint8_t mode_mask)
 Start top level commissioning procedure with specified mode mask. When the selected commissioning procedure finishes one of the following ZBOSS signals is generated: More...
 
zb_bool_t zb_bdb_is_factory_new (void)
 
void zb_set_bdb_commissioning_mode (zb_uint8_t commissioning_mode)
 Set commissioning mode. More...
 

Detailed Description

Enumeration Type Documentation

◆ zb_bdb_commissioning_mode_mask_e

BDB commissioning mode mask bits.

Enumerator
ZB_BDB_NETWORK_STEERING 

Network steering: 0 = Do not attempt network steering; 1 = Attempt network steering

ZB_BDB_NETWORK_FORMATION 

Network formation: 0 = Do not attempt to form a network; 1 = Attempt to form a network, according to device type2

Function Documentation

◆ bdb_start_top_level_commissioning()

zb_bool_t bdb_start_top_level_commissioning ( zb_uint8_t  mode_mask)

Start top level commissioning procedure with specified mode mask. When the selected commissioning procedure finishes one of the following ZBOSS signals is generated:

Parameters
mode_mask- commissioning modes, see zb_bdb_commissioning_mode_mask_e
Returns
ZB_TRUE - in case the device starts successfully
ZB_FALSE - ZB_FALSE – in case an error occurred (for example: the device has already been running)

Example:

zb_zdo_app_signal_type_type_t sig = zb_get_app_signal(param, &sg_p);
switch(sig)
{
TRACE_MSG(TRACE_APP1, "Device STARTED OK", (FMT__0));
break;
TRACE_MSG(TRACE_APP1, "Successful steering", (FMT__0));
break;
}

◆ zb_bdb_is_factory_new()

zb_bool_t zb_bdb_is_factory_new ( void  )

Check if device is factory new.

Returns
ZB_TRUE if factory new. Example:
{
zb_zdo_rejoin_backoff_start(ZB_FALSE);
}

◆ zb_set_bdb_commissioning_mode()

void zb_set_bdb_commissioning_mode ( zb_uint8_t  commissioning_mode)

Set commissioning mode.

Parameters
commissioning_mode- bitfield with the bdbCommissioningMode attribute. Set 1 to the corresponding bit to enable, 0 to disable. All the possible mask bits are stored in zb_bdb_commissioning_mode_mask_t
zb_get_app_signal
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()
ZB_BDB_SIGNAL_DEVICE_FIRST_START
#define ZB_BDB_SIGNAL_DEVICE_FIRST_START
Definition: zboss_api_zdo.h:213
bdb_start_top_level_commissioning
zb_bool_t bdb_start_top_level_commissioning(zb_uint8_t mode_mask)
Start top level commissioning procedure with specified mode mask. When the selected commissioning pro...
ZB_BDB_SIGNAL_STEERING
#define ZB_BDB_SIGNAL_STEERING
Definition: zboss_api_zdo.h:311
zb_bdb_is_factory_new
zb_bool_t zb_bdb_is_factory_new(void)
zb_zdo_app_signal_hdr_s
Definition: zboss_api_zdo.h:1057
ZB_BDB_NETWORK_STEERING
@ ZB_BDB_NETWORK_STEERING
Definition: zboss_api_zcl.h:1966
ZB_FALSE
#define ZB_FALSE
Definition: zb_types.h:366
zb_bdb_set_legacy_device_support
void zb_bdb_set_legacy_device_support(zb_uint8_t state)