nRF5 SDK for Mesh v3.2.0  08c60f6
mesh_stack_init_params_t Struct Reference

Mesh stack configuration parameters. More...

#include <mesh_stack.h>

Data Fields

nrf_mesh_init_params_t core
 Core initialization parameters structure.
 
struct {
   config_server_evt_cb_t   config_server_cb
 Pointer to a function used to inform about events from the configuration server. More...
 
   health_server_attention_cb_t   health_server_attention_cb
 Attention callback function. More...
 
   const health_server_selftest_t *   p_health_server_selftest_array
 Self-test function array. More...
 
   uint8_t   health_server_num_selftests
 Number of self-tests provided by p_health_server_selftest_array.
 
   mesh_stack_models_init_cb_t   models_init_cb
 Pointer to a function used to allow initialization of application-specific models. More...
 
models
 

Detailed Description

Mesh stack configuration parameters.

Some fields are optional; the description of the specific fields notes if the value of a field can be omitted. In this case, the value of the field should be set to 0 (NULL for pointer values).

Definition at line 70 of file mesh_stack.h.

Field Documentation

◆ config_server_cb

config_server_evt_cb_t mesh_stack_init_params_t::config_server_cb

Pointer to a function used to inform about events from the configuration server.

Can be set to NULL if not used.

Warning
If the device receives a CONFIG_SERVER_EVT_NODE_RESET event, it will erase all mesh data from the persistent storage and reset the device after forwarding the event to the application. The application developer should take care to be in a defined state after reset. This is considered a "factory reset" of the mesh device.

Definition at line 88 of file mesh_stack.h.

◆ health_server_attention_cb

health_server_attention_cb_t mesh_stack_init_params_t::health_server_attention_cb

Attention callback function.

This callback is called when the device should enable or disable the attention state. When the attention state is enabled, the device should make itself noticeable, by, for example, blinking an LED, vibrating or making sounds. If set to NULL, the attention state will be considered to be unsupported by the device.

Definition at line 97 of file mesh_stack.h.

◆ p_health_server_selftest_array

const health_server_selftest_t* mesh_stack_init_params_t::p_health_server_selftest_array

Self-test function array.

Devices can provide a list of self-test functions that can be run by applications providing a health client. This is useful if the device has functionality that provides support for testing and status reporting. If set to NULL, the self-test functionality will be considered to be unsupported by the device.

Note
If provided, the self-test array must be statically allocated and available for the entire life-time of the application.

Definition at line 109 of file mesh_stack.h.

◆ models_init_cb

mesh_stack_models_init_cb_t mesh_stack_init_params_t::models_init_cb

Pointer to a function used to allow initialization of application-specific models.

Any models used by the application should be initialized in this callback function, which ensure that these models are available immediately after the device has been provisioned. Can be set to NULL if not used.

Definition at line 122 of file mesh_stack.h.


The documentation for this struct was generated from the following file: