nRF5 SDK for Mesh v5.0.0
Macros
API level definitions

Macros

#define NRF_MESH_SEG_PAYLOAD_SIZE_MAX   (380)
 Maximum possible segmented payload size (octets). More...
 
#define NRF_MESH_UPPER_TRANSPORT_PDU_SIZE_MAX   (384)
 Maximum possible upper transport PDU (payload + MIC) size (octets). More...
 
#define NRF_MESH_UNSEG_PAYLOAD_SIZE_MAX   (11)
 Maximum useful access unsegmented payload size (octets). More...
 
#define NRF_MESH_ADV_CHAN_ALL   {37, 38, 39}
 All advertisement channels.
 
#define NRF_MESH_ADV_CHAN_DEFAULT   NRF_MESH_ADV_CHAN_ALL
 Default advertisement channel map (37, 38 and 39). More...
 
#define NRF_MESH_KEY_SIZE   (16)
 Size (in octets) of an encryption key. More...
 
#define NRF_MESH_NETID_SIZE   (8)
 Size (in octets) of the network ID. More...
 
#define NRF_MESH_UUID_SIZE   (16)
 Size (in octets) of a UUID. More...
 
#define NRF_MESH_TTL_BIT_COUNT   (7)
 Number of bits available for the TTL field. More...
 
#define NRF_MESH_TTL_MAX   ((1 << NRF_MESH_TTL_BIT_COUNT) - 1)
 Maximum TTL value. More...
 
#define NRF_MESH_GLOBAL_KEY_INDEX_MAX   (0xFFF)
 Maximum global key index allowed, according to Bluetooth Mesh Profile Specification (MshPRFv1.0.1) section 3.8.6.4. More...
 
#define NRF_MESH_BEACON_SECURE_NET_BCAST_INTERVAL_SECONDS   10
 Interval for secure network broadcast beacons, in seconds. More...
 
#define NRF_MESH_BEACON_OBSERVATION_PERIODS   2
 Number of periods to keep beacon observations of. More...
 
#define NRF_MESH_BEACON_UNPROV_URI_HASH_SIZE   (4)
 Size (in octets) of the unprovisioned beacon URI hash. More...
 
#define NRF_MESH_ECDH_PUBLIC_KEY_SIZE   (64)
 Size of an ECDH public key. More...
 
#define NRF_MESH_ECDH_PRIVATE_KEY_SIZE   (32)
 Size of an ECDH private key. More...
 
#define NRF_MESH_ECDH_SHARED_SECRET_SIZE   (32)
 Size of an ECDH shared secret. More...
 
#define NRF_MESH_ADDR_UNASSIGNED   (0x0000)
 Unassigned address. More...
 
#define NRF_MESH_ALL_PROXIES_ADDR   (0xFFFC)
 All-proxies fixed group address. More...
 
#define NRF_MESH_ALL_FRIENDS_ADDR   (0xFFFD)
 All-friends fixed group address. More...
 
#define NRF_MESH_ALL_RELAYS_ADDR   (0xFFFE)
 All-relays fixed group address. More...
 
#define NRF_MESH_ALL_NODES_ADDR   (0xFFFF)
 All-nodes fixed group address. More...
 
#define NRF_MESH_ADDR_TYPE_BITS_OFFSET   (14)
 Offset of bits determining the address type. More...
 
#define NRF_MESH_ADDR_TYPE_BITS_MASK   (0xC000)
 Mask of bits determining the address type. More...
 
#define NRF_MESH_IRQ_PRIORITY_THREAD   (4)
 IRQ priority value if running in thread mode. More...
 
#define NRF_MESH_IRQ_PRIORITY_LOWEST   (3)
 Lowest available IRQ priority on current architecture. More...
 

Detailed Description

Macro Definition Documentation

◆ NRF_MESH_SEG_PAYLOAD_SIZE_MAX

#define NRF_MESH_SEG_PAYLOAD_SIZE_MAX   (380)

Maximum possible segmented payload size (octets).

Definition at line 65 of file nrf_mesh_defines.h.

◆ NRF_MESH_UPPER_TRANSPORT_PDU_SIZE_MAX

#define NRF_MESH_UPPER_TRANSPORT_PDU_SIZE_MAX   (384)

Maximum possible upper transport PDU (payload + MIC) size (octets).

Definition at line 68 of file nrf_mesh_defines.h.

◆ NRF_MESH_UNSEG_PAYLOAD_SIZE_MAX

#define NRF_MESH_UNSEG_PAYLOAD_SIZE_MAX   (11)

Maximum useful access unsegmented payload size (octets).

Definition at line 71 of file nrf_mesh_defines.h.

◆ NRF_MESH_ADV_CHAN_DEFAULT

#define NRF_MESH_ADV_CHAN_DEFAULT   NRF_MESH_ADV_CHAN_ALL

Default advertisement channel map (37, 38 and 39).

Definition at line 77 of file nrf_mesh_defines.h.

◆ NRF_MESH_KEY_SIZE

#define NRF_MESH_KEY_SIZE   (16)

Size (in octets) of an encryption key.

Definition at line 80 of file nrf_mesh_defines.h.

◆ NRF_MESH_NETID_SIZE

#define NRF_MESH_NETID_SIZE   (8)

Size (in octets) of the network ID.

Definition at line 83 of file nrf_mesh_defines.h.

◆ NRF_MESH_UUID_SIZE

#define NRF_MESH_UUID_SIZE   (16)

Size (in octets) of a UUID.

Definition at line 86 of file nrf_mesh_defines.h.

◆ NRF_MESH_TTL_BIT_COUNT

#define NRF_MESH_TTL_BIT_COUNT   (7)

Number of bits available for the TTL field.

Definition at line 89 of file nrf_mesh_defines.h.

◆ NRF_MESH_TTL_MAX

#define NRF_MESH_TTL_MAX   ((1 << NRF_MESH_TTL_BIT_COUNT) - 1)

Maximum TTL value.

Definition at line 92 of file nrf_mesh_defines.h.

◆ NRF_MESH_GLOBAL_KEY_INDEX_MAX

#define NRF_MESH_GLOBAL_KEY_INDEX_MAX   (0xFFF)

Maximum global key index allowed, according to Bluetooth Mesh Profile Specification (MshPRFv1.0.1) section 3.8.6.4.

Definition at line 95 of file nrf_mesh_defines.h.

◆ NRF_MESH_BEACON_SECURE_NET_BCAST_INTERVAL_SECONDS

#define NRF_MESH_BEACON_SECURE_NET_BCAST_INTERVAL_SECONDS   10

Interval for secure network broadcast beacons, in seconds.

Definition at line 98 of file nrf_mesh_defines.h.

◆ NRF_MESH_BEACON_OBSERVATION_PERIODS

#define NRF_MESH_BEACON_OBSERVATION_PERIODS   2

Number of periods to keep beacon observations of.

Definition at line 101 of file nrf_mesh_defines.h.

◆ NRF_MESH_BEACON_UNPROV_URI_HASH_SIZE

#define NRF_MESH_BEACON_UNPROV_URI_HASH_SIZE   (4)

Size (in octets) of the unprovisioned beacon URI hash.

Definition at line 104 of file nrf_mesh_defines.h.

◆ NRF_MESH_ECDH_PUBLIC_KEY_SIZE

#define NRF_MESH_ECDH_PUBLIC_KEY_SIZE   (64)

Size of an ECDH public key.

Definition at line 107 of file nrf_mesh_defines.h.

◆ NRF_MESH_ECDH_PRIVATE_KEY_SIZE

#define NRF_MESH_ECDH_PRIVATE_KEY_SIZE   (32)

Size of an ECDH private key.

Definition at line 110 of file nrf_mesh_defines.h.

◆ NRF_MESH_ECDH_SHARED_SECRET_SIZE

#define NRF_MESH_ECDH_SHARED_SECRET_SIZE   (32)

Size of an ECDH shared secret.

Definition at line 113 of file nrf_mesh_defines.h.

◆ NRF_MESH_ADDR_UNASSIGNED

#define NRF_MESH_ADDR_UNASSIGNED   (0x0000)

Unassigned address.

Definition at line 116 of file nrf_mesh_defines.h.

◆ NRF_MESH_ALL_PROXIES_ADDR

#define NRF_MESH_ALL_PROXIES_ADDR   (0xFFFC)

All-proxies fixed group address.

Definition at line 119 of file nrf_mesh_defines.h.

◆ NRF_MESH_ALL_FRIENDS_ADDR

#define NRF_MESH_ALL_FRIENDS_ADDR   (0xFFFD)

All-friends fixed group address.

Definition at line 122 of file nrf_mesh_defines.h.

◆ NRF_MESH_ALL_RELAYS_ADDR

#define NRF_MESH_ALL_RELAYS_ADDR   (0xFFFE)

All-relays fixed group address.

Definition at line 125 of file nrf_mesh_defines.h.

◆ NRF_MESH_ALL_NODES_ADDR

#define NRF_MESH_ALL_NODES_ADDR   (0xFFFF)

All-nodes fixed group address.

Definition at line 128 of file nrf_mesh_defines.h.

◆ NRF_MESH_ADDR_TYPE_BITS_OFFSET

#define NRF_MESH_ADDR_TYPE_BITS_OFFSET   (14)

Offset of bits determining the address type.

Definition at line 131 of file nrf_mesh_defines.h.

◆ NRF_MESH_ADDR_TYPE_BITS_MASK

#define NRF_MESH_ADDR_TYPE_BITS_MASK   (0xC000)

Mask of bits determining the address type.

Definition at line 134 of file nrf_mesh_defines.h.

◆ NRF_MESH_IRQ_PRIORITY_THREAD

#define NRF_MESH_IRQ_PRIORITY_THREAD   (4)

IRQ priority value if running in thread mode.

Definition at line 138 of file nrf_mesh_defines.h.

◆ NRF_MESH_IRQ_PRIORITY_LOWEST

#define NRF_MESH_IRQ_PRIORITY_LOWEST   (3)

Lowest available IRQ priority on current architecture.

Definition at line 145 of file nrf_mesh_defines.h.


Documentation feedback | Developer Zone | Subscribe | Updated