nRF5 SDK for Thread and Zigbee v3.0.0
Typedefs | Enumerations | Functions
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_INITIALIZATION = 0, ZB_BDB_TOUCHLINK_COMMISSIONING = 1, ZB_BDB_NETWORK_STEERING = 2, ZB_BDB_NETWORK_FORMATION = 4,
  ZB_BDB_FINDING_N_BINDING = 8, ZB_BDB_LAST_COMMISSIONING_STEP = 0x10, ZB_BDB_COMMISSIONING_STOP = 0x20, ZB_BDB_TOUCHLINK_TARGET = 0x40
}
 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)
 
zb_void_t zb_set_bdb_commissioning_mode (zb_uint8_t commissioning_mode)
 

Detailed Description

Enumeration Type Documentation

BDB commissioning mode mask bits.

Enumerator
ZB_BDB_TOUCHLINK_COMMISSIONING 

Touchlink: 0 = Do not attempt Touchlink commissioning; 1 = Attempt Touchlink commissioning

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

ZB_BDB_FINDING_N_BINDING 

Finding & binding: 0 = Do not attempt finding & binding; 1 = Attempt finding & binding

Note
actually this mode does not call Finding & Binding procedure. Use zb_bdb_finding_binding_target or zb_bdb_finding_binding_initiator.

Function Documentation

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

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, "Successfull steering", (FMT__0));
break;
}
zb_bool_t zb_bdb_is_factory_new ( void  )

Check if device is factory new.

Returns
ZB_TRUE if factory new. Example:
zb_void_t 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: Bit number Description 0 Enables/disables Touchlink commissioning 1 Attempt network steering 2 Attempt to form a network 3 Attempt finding and binding
See also
zb_bdb_commissioning_mode_mask_t

Documentation feedback | Developer Zone | Subscribe | Updated