nRF5 SDK for Mesh v5.0.0
Macros | Functions
Friend runtime configuration options

Runtime configuration for Mesh Friend feature functionality. More...

Macros

#define MESH_OPT_FRIEND_EID   MESH_OPT_CORE_ID(MESH_OPT_FRND_ID_START + 0)
 Friend entry ID.
 

Functions

uint32_t mesh_opt_friend_set (bool enabled)
 Sets the Friend state. More...
 
uint32_t mesh_opt_friend_get (bool *p_enabled)
 Gets the Friend state. More...
 

Detailed Description

Runtime configuration for Mesh Friend feature functionality.

Function Documentation

◆ mesh_opt_friend_set()

uint32_t mesh_opt_friend_set ( bool  enabled)

Sets the Friend state.

Parameters
[in]enabledSet to true to enable the Friend state. To disable the Friend state, set to false.
Return values
NRF_SUCCESSFriend state successfully changed.
NRF_ERROR_NOT_FOUNDFriend state is not available.

◆ mesh_opt_friend_get()

uint32_t mesh_opt_friend_get ( bool *  p_enabled)

Gets the Friend state.

Parameters
[out]p_enabledPointer to write the current Friend state.
Return values
NRF_SUCCESSSuccessfully provided the current Friend state.
NRF_ERROR_NULLNULL pointer supplied to function.

Documentation feedback | Developer Zone | Subscribe | Updated