Application support module for common mesh behavior. More...
Modules | |
| Types | |
| Node configuration type defintions. | |
Functions | |
| uint32_t | nrf_mesh_node_config (const nrf_mesh_node_config_params_t *p_params) |
| Configures the mesh node. More... | |
| void | nrf_mesh_node_config_clear (void) |
| Clears the saved configuration and network state of the mesh node. More... | |
Application support module for common mesh behavior.
The node config module is a helper module designed to make it easy to get started developing applications with the mesh, by providing an abstraction of the common configuration APIs. Contrary to the base API, the node config module aims to satisfy only the most common usage scenarios, which makes it suitable for simple applications.
It is recommended to start out using the node config module as a scaffolding, then phase it out if fine-grained control is needed.
| uint32_t nrf_mesh_node_config | ( | const nrf_mesh_node_config_params_t * | p_params | ) |
Configures the mesh node.
This function wraps all the functionality required to go from the boot-up state to a fully functional mesh node.
| NRF_ERROR_NULL | The p_params parameter was NULL. |
| NRF_ERROR_INVALID_STATE | The node has already been configured. |
| NRF_ERROR_INVALID_PARAM | One or more of the parameters in the p_params structure were invalid. |
| NRF_SUCCESS | Node initialization was successfully started. However, the node initialization should not be considered finished until the configuration complete callback has been called. |
| void nrf_mesh_node_config_clear | ( | void | ) |
Clears the saved configuration and network state of the mesh node.