BDB commissioning parameters

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)
	Sets primary channel set for the BDB energy scan. More...
zb_uint32_t	zb_get_bdb_primary_channel_set (void)
	Retrieves primary channel set for the BDB energy scan. More...
void	zb_set_bdb_secondary_channel_set (zb_uint32_t channel_mask)
	Sets secondary channel set for the BDB energy scan. More...
zb_uint32_t	zb_get_bdb_secondary_channel_set (void)
void	zb_bdb_set_legacy_device_support (zb_uint8_t state)
	Enables Zigbee PRO complaint commissioning support. More...

Detailed Description

Macro Definition Documentation

BDB_MAX_IDENTIFY_QUERY_RESP_NUMBER

#define BDB_MAX_IDENTIFY_QUERY_RESP_NUMBER   4

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zcl.h>

Identify query responses queue size

ZB_BDB_COMM_ACTIVE_ENDP_LIST_LEN

#define ZB_BDB_COMM_ACTIVE_ENDP_LIST_LEN   4

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zcl.h>

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

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zcl.h>

List of BDB commissioning states

Enumeration Type Documentation

zb_bdb_comm_state_e

enum zb_bdb_comm_state_e

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zcl.h>

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

)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zcl.h>

Enables Zigbee PRO complaint commissioning support.

This function turns off link key exchange thus supporting legacy devices (<ZB3.0).

Parameters

[in]

state

- controls requirement of trust center key exchange 1 - to disable trust center requirement for the key exchange 0 - to enable trust center requirement for the key exchange

zb_get_bdb_primary_channel_set()

zb_uint32_t zb_get_bdb_primary_channel_set

(

void

)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zcl.h>

Retrieves primary channel set for the BDB energy scan.

Returns

channel_mask - channel mask

Note

Channel set is reset to zero after changing the network role of the device.

See also

zb_set_bdb_primary_channel_set()

zb_get_bdb_secondary_channel_set()

zb_uint32_t zb_get_bdb_secondary_channel_set

(

void

)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zcl.h>

Retrieves 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

)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zcl.h>

Sets primary channel set for the BDB energy scan.

Network scan will be performed on these channels.

Parameters

[in]

channel_mask

- channel mask, can be formatted using ZB_CHANNEL_PAGE_SET_PAGE ZB_CHANNEL_PAGE_SET_MASK

Note

This function is used in:

• Network Steering for a node not on the network;
• Network Formation.

Channel set is reset to zero after changing the network role of the device.

See also

bdbPrimaryChannelSet 5.3.8 (BDB 3.0.1)

zb_get_bdb_primary_channel_set()

zb_set_bdb_secondary_channel_set()

void zb_set_bdb_secondary_channel_set

(

zb_uint32_t

channel_mask

)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_zcl.h>

Sets secondary channel set for the BDB energy scan.

Network scan will be performed on these channels if no network is found after the energy scan on the primary channels (zb_set_bdb_primary_channel_set()).

Parameters

[in]

channel_mask

- channel mask, can be formatted using ZB_CHANNEL_PAGE_SET_PAGE ZB_CHANNEL_PAGE_SET_MASK

Note

This function is used in:

• Network Steering for a node not on the network;
• Network Formation.

See also

bdbSecondaryChannelSet 5.3.10 (BDB 3.0.1)

zb_get_bdb_secondary_channel_set()