Constants
The ZigBee Base Device constants are divided into two categories:
Constants used on all nodes - see General constants.
Constants used on nodes that support Touchlink - see Touchlink constants.
General constants
The table below lists the ZigBee Base Device constants that can be used on all nodes and also shows the corresponding macros used to define the constant values in the bdb_options.h file.
Table: ZBD General Constants and Macros
Constant |
Macro |
|---|---|
bdbcMaxSameNetworkRetryAttempts |
BDBC_MAX_SAME_NETWORK_RETRY_ATTEMPTS |
bdbcMinCommissioningTime |
BDBC_MIN_COMMISSIONING_TIME |
bdbcRecSameNetworkRetryAttempts |
BDBC_REC_SAME_NETWORK_RETRY_ATTEMPTS |
bdbcTCLinkKeyExchangeTimeout |
BDBC_TC_LINK_KEY_EXCHANGE_TIMEOUT |
bdbcMaxSameNetworkRetryAttempts
This constant specifies the maximum number of join or key exchange attempts that the node can make on the same network. The value of this constant is defined using the macro BDBC_MAX_SAME_NETWORK_RETRY_ATTEMPTS and should be set to 10 (as recommended in the ZigBee BDB Specification).
bdbcMinCommissioningTime
This constant specifies the minimum time-interval (in seconds) for which a network is open to allow new nodes to join or for a device to identify itself. The value of this constant is defined using the macro BDBC_MIN_COMMISSIONING_TIME and should be set to 180 (as recommended in the ZigBee BDB Specification).
bdbcRecSameNetworkRetryAttempts
This constant specifies the recommended number of join or key exchange attempts that the node can make on the same network. The value of this constant is defined using the macro BDBC_REC_SAME_NETWORK_RETRY_ATTEMPTS and should be set to 3 (as recommended in the ZigBee BDB Specification).
bdbcTCLinkKeyExchangeTimeout
This constant specifies the maximum time (in seconds) for which a joining node will wait for a response after an APS key request has been sent to the Trust Centre. The value of this constant is defined using the macro BDBC_TC_LINK_KEY_EXCHANGE_TIMEOUT and should be set to 5 (as recommended in the ZigBee BDB Specification).
Parent topic:Constants
Touchlink constants
The table below lists the ZigBee Base Device constants that can be used on nodes that support Touchlink commissioning and also shows the corresponding macros used to define the constant values in the bdb_options.h file.
ZBD Touchlink Constants and |
Macros |
|---|---|
Constant |
Macro |
bdbcTLInterPANTransIdLifetime |
BDBC_TL_INTERPAN_TRANS_ID_LIFETIME |
bdbcTLMinStartupDelayTime |
BDBC_TL_MIN_STARTUP_DELAY_TIME |
bdbcTLPrimaryChannelSet |
BDBC_TL_PRIMARY_CHANNEL_SET |
bdbcTLRxWindowDuration |
BDBC_TL_RX_WINDOW_DURATION |
bdbcTLScanTimeBaseDuration |
BDBC_TL_SCAN_TIME_BASE_DURATION_MS |
bdbcTLSecondaryChannelSet |
BDBC_TL_SECONDARY_CHANNEL_SET |
bdbcTLInterPANTransIdLifetime
This constant specifies the maximum length of time (in seconds) that an inter-PAN transaction ID remains valid. The value of this constant is defined using the macro BDBC_TL_INTERPAN_TRANS_ID_LIFETIME and should be set to 8 (as recommended in the ZigBee BDB Specification).
bdbcTLMinStartupDelayTime
This constant specifies the length of time (in seconds) that a Touchlink initiator waits for the target to complete its network start-up procedure. The value of this constant is defined using the macro BDBC_TL_MIN_STARTUP_DELAY_TIME and should be set to 2 (as recommended in the ZigBee BDB Specification).
bdbcTLPrimaryChannelSet
This constant specifies the bitmap for the primary (first-choice) set of 2.4 GHz radio channels that is used for a non-extended Touchlink scan. The value of this constant is defined using the macro BDBC_TL_PRIMARY_CHANNEL_SET and should be set to 0x02108800, corresponding to channels 11, 15, 20 and 25 (as recommended in the ZigBee BDB Specification).
bdbcTLRxWindowDuration
This constant specifies the maximum duration (in seconds) for which the radio receiver of node remains enabled during Touchlink commissioning, in order to receive responses. The value of this constant is defined using the macro BDBC_TL_RX_WINDOW_DURATION and should be set to 5 (as recommended in the ZigBee BDB Specification).
bdbcTLScanTimeBaseDuration
This constant specifies the base duration (in milliseconds) for which the radio receiver of node remains enabled after transmitting a scan request during a Touchlink scan operation, in order to receive responses. The value of this constant is defined using the macro BDBC_TL_SCAN_TIME_BASE_DURATION_MS and should be set to 250 (as recommended in the ZigBee BDB Specification).
bdbcTLSecondaryChannelSet
This constant specifies the bitmap for the secondary (second-choice) set of 2.4 GHz radio channels that is used for an extended Touchlink scan. It should contain the channels that remain from those specified in bdbcTLPrimaryChannelSet. The value of this constant is defined using the macro BDBC_TL_SECONDARY_CHANNEL_SET and should be set to 0x07FFF800 XOR BDBC_TL_PRIMARY_CHANNEL_SET.
Parent topic:Constants
Parent topic:Attributes and Constants