BDB commissioning parameters

nRF5 SDK for Thread and Zigbee v4.2.0
Macros | Typedefs | Enumerations | Functions

Macros

#define ZB_BDB_COMM_ACTIVE_ENDP_LIST_LEN   4
 
#define BDB_MAX_IDENTIFY_QUERY_RESP_NUMBER   4
 

Typedefs

typedef enum zb_bdb_comm_state_e zb_bdb_comm_state_t
 

Enumerations

enum  zb_bdb_comm_state_e { ZB_BDB_COMM_IDLE = 0, ZB_BDB_COMM_FINDING_AND_BINDING = 4, ZB_BDB_COMM_FINDING_AND_BINDING_TARGET = 5 }
 

Functions

void zb_set_bdb_primary_channel_set (zb_uint32_t channel_mask)
 
zb_uint32_t zb_get_bdb_primary_channel_set (void)
 
void zb_set_bdb_secondary_channel_set (zb_uint32_t channel_mask)
 
zb_uint32_t zb_get_bdb_secondary_channel_set (void)
 
void zb_bdb_set_legacy_device_support (zb_uint8_t state)
 

Detailed Description

Macro Definition Documentation

◆ BDB_MAX_IDENTIFY_QUERY_RESP_NUMBER

#define BDB_MAX_IDENTIFY_QUERY_RESP_NUMBER   4

Identify query responses queue size

◆ ZB_BDB_COMM_ACTIVE_ENDP_LIST_LEN

#define ZB_BDB_COMM_ACTIVE_ENDP_LIST_LEN   4

Maximum endpoints of the "respondent" that can be served

Typedef Documentation

◆ zb_bdb_comm_state_t

typedef enum zb_bdb_comm_state_e zb_bdb_comm_state_t

List of BDB commissioning states

Enumeration Type Documentation

◆ zb_bdb_comm_state_e

enum zb_bdb_comm_state_e

List of BDB commissioning states

Enumerator
ZB_BDB_COMM_IDLE 

EZ-Mode isn't invoked

ZB_BDB_COMM_FINDING_AND_BINDING 

EZ-Mode finding and binding in progress (on initiator)

ZB_BDB_COMM_FINDING_AND_BINDING_TARGET 

EZ-Mode finding and binding in progress (on target)

Function Documentation

◆ zb_bdb_set_legacy_device_support()

void zb_bdb_set_legacy_device_support ( zb_uint8_t  state)

Enable Zigbee PRO complaint commissioning support

Parameters
state- 1 to disable trust center require key exchange; 0 - to enable.

◆ zb_get_bdb_primary_channel_set()

zb_uint32_t zb_get_bdb_primary_channel_set ( void  )

Get the primary channel set for the BDB energy scan.

Returns
channel_mask - Channel mask.
Note
Channel set is reset to zero after changing network role of the device

◆ zb_get_bdb_secondary_channel_set()

zb_uint32_t zb_get_bdb_secondary_channel_set ( void  )

Get the secondary channel set for the BDB energy scan.

Returns
channel_mask - Channel mask.

◆ zb_set_bdb_primary_channel_set()

void zb_set_bdb_primary_channel_set ( zb_uint32_t  channel_mask)

Set the primary channel set for the BDB energy scan. Beacon request will be send on these channels

Parameters
channel_mask- Channel mask.
Note
Channel set is reset to zero after changing network role of the device

◆ zb_set_bdb_secondary_channel_set()

void zb_set_bdb_secondary_channel_set ( zb_uint32_t  channel_mask)

Set the secondary channel set for the BDB energy scan. Beacon request will be send on these channels if no network found after energy scan on the primary channels.

Parameters
channel_mask- Channel mask.