AF common constants

nRF5 SDK for Thread and Zigbee v4.2.0
Typedefs

Typedefs

typedef zb_uint8_t zb_current_power_mode_t
 Type for power descriptor types. More...
 
typedef zb_uint8_t zb_power_src_t
 Type for power source types. More...
 
typedef zb_uint8_t zb_power_source_level_t
 Type for power source level values. More...
 

Node descriptor - frequency value

Note: These values were members of enum zb_freq_band_e type but were converted to a set of macros due to MISRA violations.

#define ZB_FREQ_BAND_868   1U
 
#define ZB_FREQ_BAND_SUB_GHZ_NA_FSK   (1U << 2)
 
#define ZB_FREQ_BAND_2400   (1U << 3)
 
#define ZB_FREQ_BAND_SUB_GHZ_EU_FSK   (1U << 4)
 

Node descriptor - server mask

Note: These values were members of enum zb_server_mask_bit_e type but were converted to a set of macros due to MISRA violations.

#define ZB_PRIMARY_TRUST_CENTER   1U
 
#define ZB_BACKUP_TRUST_CENTER   (1U << 1)
 
#define ZB_PRIMARY_BINDING_TABLE_CENTER   (1U << 2)
 
#define ZB_BACKUP_BINDING_TABLE_CENTER   (1U << 3)
 
#define ZB_PRIMARY_DISCOVERY_CACHE   (1U << 4)
 
#define ZB_BACKUP_DISCOVERY_CACHE   (1U << 5)
 
#define ZB_NETWORK_MANAGER   (1U << 6)
 

Node descriptor - capability mask

Note: These values were members of enum zb_desc_capability_e type but were converted to a set of macros due to MISRA violations.

#define ZB_EXT_ACTIVE_EP_LIST   1U
 
#define ZB_EXT_SIMPLE_DESC_LIST   (1U << 1)
 

Power descriptor types

#define ZB_POWER_MODE_SYNC_ON_WHEN_IDLE   0U
 
#define ZB_POWER_MODE_COME_ON_PERIODICALLY   1U
 
#define ZB_POWER_MODE_COME_ON_WHEN_STIMULATED   2U
 

Power source types

#define ZB_POWER_SRC_CONSTANT   1U
 
#define ZB_POWER_SRC_RECHARGEABLE_BATTERY   (1U << 1)
 
#define ZB_POWER_SRC_DISPOSABLE_BATTERY   (1U << 2)
 

Power source level values

#define ZB_POWER_LEVEL_CRITICAL   0U
 
#define ZB_POWER_LEVEL_33   4U
 
#define ZB_POWER_LEVEL_66   8U
 
#define ZB_POWER_LEVEL_100   12U
 

Profile identifiers

Note: These values were members of enum zb_af_profile_id_e type but were converted to a set of macros due to MISRA violations.

#define ZB_AF_ZDO_PROFILE_ID   0x0000U
 
#define ZB_AF_LEGACY_PROFILE1_ID   0x0101U
 
#define ZB_AF_LEGACY_PROFILE2_ID   0x0102U
 
#define ZB_AF_LEGACY_PROFILE3_ID   0x0103U
 
#define ZB_AF_HA_PROFILE_ID   0x0104U
 
#define ZB_AF_LEGACY_PROFILE4_ID   0x0105U
 
#define ZB_AF_LEGACY_PROFILE5_ID   0x0106U
 
#define ZB_AF_LEGACY_PROFILE6_ID   0x0107U
 
#define ZB_AF_LEGACY_PROFILE7_ID   0x0108U
 
#define ZB_AF_SE_PROFILE_ID   0x0109U
 
#define ZB_AF_ZLL_PROFILE_ID   0xC05EU
 
#define ZB_AF_WILDCARD_PROFILE_ID   0xFFFFU
 
#define ZB_AF_GP_PROFILE_ID   0xA1E0U
 

Detailed Description

Macro Definition Documentation

◆ ZB_AF_GP_PROFILE_ID

#define ZB_AF_GP_PROFILE_ID   0xA1E0U

GreenPower profile ID

◆ ZB_AF_HA_PROFILE_ID

#define ZB_AF_HA_PROFILE_ID   0x0104U

HA profile ID

◆ ZB_AF_LEGACY_PROFILE1_ID

#define ZB_AF_LEGACY_PROFILE1_ID   0x0101U

Legacy profile

◆ ZB_AF_LEGACY_PROFILE2_ID

#define ZB_AF_LEGACY_PROFILE2_ID   0x0102U

Legacy profile

◆ ZB_AF_LEGACY_PROFILE3_ID

#define ZB_AF_LEGACY_PROFILE3_ID   0x0103U

Legacy profile

◆ ZB_AF_LEGACY_PROFILE4_ID

#define ZB_AF_LEGACY_PROFILE4_ID   0x0105U

Legacy profile

◆ ZB_AF_LEGACY_PROFILE5_ID

#define ZB_AF_LEGACY_PROFILE5_ID   0x0106U

Legacy profile

◆ ZB_AF_LEGACY_PROFILE6_ID

#define ZB_AF_LEGACY_PROFILE6_ID   0x0107U

Legacy profile

◆ ZB_AF_LEGACY_PROFILE7_ID

#define ZB_AF_LEGACY_PROFILE7_ID   0x0108U

Legacy profile

◆ ZB_AF_SE_PROFILE_ID

#define ZB_AF_SE_PROFILE_ID   0x0109U

SE profile ID

◆ ZB_AF_WILDCARD_PROFILE_ID

#define ZB_AF_WILDCARD_PROFILE_ID   0xFFFFU

Wildcard profile identifier.

◆ ZB_AF_ZDO_PROFILE_ID

#define ZB_AF_ZDO_PROFILE_ID   0x0000U

ZDO profile ID

◆ ZB_AF_ZLL_PROFILE_ID

#define ZB_AF_ZLL_PROFILE_ID   0xC05EU

ZLL profile identifier.

◆ ZB_BACKUP_BINDING_TABLE_CENTER

#define ZB_BACKUP_BINDING_TABLE_CENTER   (1U << 3)

Backup Binding Table Center

◆ ZB_BACKUP_DISCOVERY_CACHE

#define ZB_BACKUP_DISCOVERY_CACHE   (1U << 5)

Backup Discovery Cache

◆ ZB_BACKUP_TRUST_CENTER

#define ZB_BACKUP_TRUST_CENTER   (1U << 1)

Backup Trust Center

◆ ZB_EXT_ACTIVE_EP_LIST

#define ZB_EXT_ACTIVE_EP_LIST   1U

Extended Active Endpoint List Available

◆ ZB_EXT_SIMPLE_DESC_LIST

#define ZB_EXT_SIMPLE_DESC_LIST   (1U << 1)

Extended Simple Descriptor List Available

◆ ZB_FREQ_BAND_2400

#define ZB_FREQ_BAND_2400   (1U << 3)

2400-2483.5 MHz

◆ ZB_FREQ_BAND_868

#define ZB_FREQ_BAND_868   1U

868-868.6 MHz BPSK

◆ ZB_FREQ_BAND_SUB_GHZ_EU_FSK

#define ZB_FREQ_BAND_SUB_GHZ_EU_FSK   (1U << 4)

Zigbee R22: European FSK sub-GHz bands (863-876MHz, 915-921MHz)

◆ ZB_FREQ_BAND_SUB_GHZ_NA_FSK

#define ZB_FREQ_BAND_SUB_GHZ_NA_FSK   (1U << 2)

902-928 MHz BPSK

◆ ZB_NETWORK_MANAGER

#define ZB_NETWORK_MANAGER   (1U << 6)

Network Manager

◆ ZB_POWER_LEVEL_100

#define ZB_POWER_LEVEL_100   12U

100%

◆ ZB_POWER_LEVEL_33

#define ZB_POWER_LEVEL_33   4U

33%

◆ ZB_POWER_LEVEL_66

#define ZB_POWER_LEVEL_66   8U

66%

◆ ZB_POWER_LEVEL_CRITICAL

#define ZB_POWER_LEVEL_CRITICAL   0U

Critical

◆ ZB_POWER_MODE_COME_ON_PERIODICALLY

#define ZB_POWER_MODE_COME_ON_PERIODICALLY   1U

Receiver comes on when stimulated, for example, by a user pressing a button.

◆ ZB_POWER_MODE_SYNC_ON_WHEN_IDLE

#define ZB_POWER_MODE_SYNC_ON_WHEN_IDLE   0U

< Receiver synchronized with the receiver on when idle subfield of the node descriptor. Receiver comes on periodically as defined by the node power descriptor.

◆ ZB_POWER_SRC_CONSTANT

#define ZB_POWER_SRC_CONSTANT   1U

Constant (mains) power

◆ ZB_POWER_SRC_DISPOSABLE_BATTERY

#define ZB_POWER_SRC_DISPOSABLE_BATTERY   (1U << 2)

Disposable battery

◆ ZB_POWER_SRC_RECHARGEABLE_BATTERY

#define ZB_POWER_SRC_RECHARGEABLE_BATTERY   (1U << 1)

Rechargeable battery

◆ ZB_PRIMARY_BINDING_TABLE_CENTER

#define ZB_PRIMARY_BINDING_TABLE_CENTER   (1U << 2)

Primary Binding Table Center

◆ ZB_PRIMARY_DISCOVERY_CACHE

#define ZB_PRIMARY_DISCOVERY_CACHE   (1U << 4)

Primary Discovery Cache

◆ ZB_PRIMARY_TRUST_CENTER

#define ZB_PRIMARY_TRUST_CENTER   1U

Primary Trust Center

Typedef Documentation

◆ zb_current_power_mode_t

typedef zb_uint8_t zb_current_power_mode_t

Type for power descriptor types.

Holds one of current_power_mode. Kept only for backward compatibility as current_power_mode were declared previously as enum. Can be removed in future releases.

◆ zb_power_source_level_t

typedef zb_uint8_t zb_power_source_level_t

Type for power source level values.

Holds one of power_source_level. Kept only for backward compatibility as power_source_level were declared previously as enum. Can be removed in future releases.

◆ zb_power_src_t

typedef zb_uint8_t zb_power_src_t

Type for power source types.