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] enabled Set to trueto enable the Friend state. To disable the Friend state, set tofalse.
- Return values
-
NRF_SUCCESS Friend state successfully changed. NRF_ERROR_NOT_FOUND Friend state is not available.
◆ mesh_opt_friend_get()
| uint32_t mesh_opt_friend_get | ( | bool * | p_enabled | ) |
Gets the Friend state.
- Parameters
-
[out] p_enabled Pointer to write the current Friend state.
- Return values
-
NRF_SUCCESS Successfully provided the current Friend state. NRF_ERROR_NULL NULL pointer supplied to function.