nRF5 SDK for Mesh v3.2.0  08c60f6
Mesh options

Data Structures

struct  nrf_mesh_opt_t
 Options structure. More...
 

Macros

#define NRF_MESH_OPT_PROV_START   200
 Start of provisioning parameters.
 
#define NRF_MESH_OPT_TRS_START   300
 Start of transport layer parameters.
 
#define NRF_MESH_OPT_NET_START   400
 Start of network layer parameters.
 

Enumerations

enum  nrf_mesh_opt_id_t {
  NRF_MESH_OPT_PROV_ECDH_OFFLOADING = NRF_MESH_OPT_PROV_START, NRF_MESH_OPT_TRS_SAR_RX_TIMEOUT = NRF_MESH_OPT_TRS_START, NRF_MESH_OPT_TRS_SAR_RX_ACK_TIMEOUT_BASE, NRF_MESH_OPT_TRS_SAR_RX_ACK_TIMEOUT_PER_HOP_ADDITION,
  NRF_MESH_OPT_TRS_SAR_TX_RETRY_TIMEOUT_BASE, NRF_MESH_OPT_TRS_SAR_TX_RETRY_TIMEOUT_PER_HOP_ADDITION, NRF_MESH_OPT_TRS_SAR_TX_RETRIES, NRF_MESH_OPT_TRS_SAR_SEGACK_TTL,
  NRF_MESH_OPT_TRS_SZMIC, NRF_MESH_OPT_NET_RELAY_ENABLE = NRF_MESH_OPT_NET_START, NRF_MESH_OPT_NET_RELAY_RETRANSMIT_COUNT, NRF_MESH_OPT_NET_RELAY_RETRANSMIT_INTERVAL_MS,
  NRF_MESH_OPT_NET_RELAY_TX_POWER, NRF_MESH_OPT_NET_NETWORK_TRANSMIT_COUNT, NRF_MESH_OPT_NET_NETWORK_TRANSMIT_INTERVAL_MS, NRF_MESH_OPT_NET_NETWORK_TX_POWER
}
 Option ID type. More...
 

Functions

_DEPRECATED uint32_t nrf_mesh_opt_set (nrf_mesh_opt_id_t id, const nrf_mesh_opt_t *const p_opt)
 Function for setting various nRF Mesh options. More...
 
_DEPRECATED uint32_t nrf_mesh_opt_get (nrf_mesh_opt_id_t id, nrf_mesh_opt_t *const p_opt)
 Function for getting various nRF Mesh options. More...
 

Detailed Description

Configuration options for the core mesh.

Enumeration Type Documentation

◆ nrf_mesh_opt_id_t

Option ID type.

Note
All corresponding option values are assumed unsigned 32-bit integers unless stated otherwise.
Enumerator
NRF_MESH_OPT_PROV_ECDH_OFFLOADING 

Enable (1) / disable (0) ECDH offloading in provisioning.

NRF_MESH_OPT_TRS_SAR_RX_TIMEOUT 

Transport SAR RX timeout.

NRF_MESH_OPT_TRS_SAR_RX_ACK_TIMEOUT_BASE 

Base transport SAR RX ack timeout.

NRF_MESH_OPT_TRS_SAR_RX_ACK_TIMEOUT_PER_HOP_ADDITION 

SAR RX ack timeout addition per hop.

NRF_MESH_OPT_TRS_SAR_TX_RETRY_TIMEOUT_BASE 

Base TX SAR retry timeout.

NRF_MESH_OPT_TRS_SAR_TX_RETRY_TIMEOUT_PER_HOP_ADDITION 

TX retry timeout addition per hop.

NRF_MESH_OPT_TRS_SAR_TX_RETRIES 

Number of retries before cancelling a SAR session.

NRF_MESH_OPT_TRS_SAR_SEGACK_TTL 

Default TTL value for segment acknowledgement messages.

NRF_MESH_OPT_TRS_SZMIC 

32-bit (NRF_MESH_TRANSMIC_SIZE_SMALL) or 64-bit (NRF_MESH_TRANSMIC_SIZE_LARGE) MIC size for transport layer.

NRF_MESH_OPT_NET_RELAY_ENABLE 

Packet relaying enabled (1) or disabled (0).

NRF_MESH_OPT_NET_RELAY_RETRANSMIT_COUNT 

Number of retransmits per relayed packet.

NRF_MESH_OPT_NET_RELAY_RETRANSMIT_INTERVAL_MS 

Relay retransmit interval in milliseconds.

NRF_MESH_OPT_NET_RELAY_TX_POWER 

Relay TX power.

NRF_MESH_OPT_NET_NETWORK_TRANSMIT_COUNT 

Number of retransmits per network packet originating from this device.

NRF_MESH_OPT_NET_NETWORK_TRANSMIT_INTERVAL_MS 

Interval between retransmitted packets originating from this device in milliseconds.

NRF_MESH_OPT_NET_NETWORK_TX_POWER 

TX power for packets originating from this device.

Definition at line 63 of file nrf_mesh_opt.h.

Function Documentation

◆ nrf_mesh_opt_set()

_DEPRECATED uint32_t nrf_mesh_opt_set ( nrf_mesh_opt_id_t  id,
const nrf_mesh_opt_t *const  p_opt 
)

Function for setting various nRF Mesh options.

Parameters
[in]idIdentifier for option to set. See nrf_mesh_opt_id_t.
[in]p_optPointer to option struct.
Return values
NRF_SUCCESSSuccessfully set option.

◆ nrf_mesh_opt_get()

_DEPRECATED uint32_t nrf_mesh_opt_get ( nrf_mesh_opt_id_t  id,
nrf_mesh_opt_t *const  p_opt 
)

Function for getting various nRF Mesh options.

Parameters
[in]idIdentifier for option to get. See nrf_mesh_opt_id_t.
[out]p_optPointer to option struct.
Return values
NRF_SUCCESSSuccessfully retrieved option.