Node configuration parameters. More...
#include <nrf_mesh_node_config.h>
Data Fields | |
nrf_mesh_node_config_complete_cb_t | complete_callback |
Pointer to a function used to signal the completion of the node configuration procedure. More... | |
nrf_mesh_node_config_setup_cb_t | setup_callback |
Pointer to a function used to allow initialization of application-specific models. More... | |
config_server_evt_cb_t | config_server_callback |
Pointer to a function used to inform about events from the configuration server. More... | |
void * | p_data |
Data pointer to pass to the callback functions. | |
nrf_clock_lf_cfg_t | lf_clk_cfg |
Low frequency clock configuration. More... | |
nrf_fault_handler_t | sd_assertion_handler |
Handler for SoftDevice assertions. More... | |
nrf_mesh_assertion_handler_t | mesh_assertion_handler |
Handler for mesh assertions. More... | |
health_server_attention_cb_t | attention_cb |
Attention callback function. More... | |
const health_server_selftest_t * | p_selftest_array |
Self-test function array. More... | |
uint8_t | num_selftests |
Number of self-tests provided by p_selftest_array . | |
nrf_mesh_prov_oob_caps_t | prov_caps |
Device capabilities for OOB authentication. More... | |
const char * | p_device_uri |
NULL-terminated device URI string. More... | |
uint16_t | oob_info_sources |
Device OOB information sources. More... | |
const uint8_t * | p_static_data |
Data used for OOB authentication when the static authentication method is used. More... | |
uint8_t | irq_priority |
Application IRQ priority. More... | |
Node 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 106 of file nrf_mesh_node_config.h.
nrf_mesh_node_config_complete_cb_t nrf_mesh_node_config_params_t::complete_callback |
Pointer to a function used to signal the completion of the node configuration procedure.
Can be set to NULL
if not used.
Definition at line 117 of file nrf_mesh_node_config.h.
nrf_mesh_node_config_setup_cb_t nrf_mesh_node_config_params_t::setup_callback |
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 node has been provisioned. Can be set to NULL
if not used.
Definition at line 125 of file nrf_mesh_node_config.h.
config_server_evt_cb_t nrf_mesh_node_config_params_t::config_server_callback |
Pointer to a function used to inform about events from the configuration server.
Can be set to NULL
if not used.
Definition at line 136 of file nrf_mesh_node_config.h.
nrf_clock_lf_cfg_t nrf_mesh_node_config_params_t::lf_clk_cfg |
Low frequency clock configuration.
Used for SoftDevice initialization. See nrf_sdm.h or the SoftDevice documentation for more information about this parameter.
Definition at line 148 of file nrf_mesh_node_config.h.
nrf_fault_handler_t nrf_mesh_node_config_params_t::sd_assertion_handler |
Handler for SoftDevice assertions.
This is an optional field for specifying a handler for critical errors from the SoftDevice. If set to NULL
, a default handler will be used instead.
Definition at line 155 of file nrf_mesh_node_config.h.
nrf_mesh_assertion_handler_t nrf_mesh_node_config_params_t::mesh_assertion_handler |
Handler for mesh assertions.
This is an optional field for specifying a handler that is called on critical error conditions in the mesh stack, that usually indicates a bug in either the application or internally in the mesh stack. If set to NULL
, a default handler will be used instead.
Definition at line 164 of file nrf_mesh_node_config.h.
health_server_attention_cb_t nrf_mesh_node_config_params_t::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 173 of file nrf_mesh_node_config.h.
const health_server_selftest_t* nrf_mesh_node_config_params_t::p_selftest_array |
Self-test function array.
Nodes 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.
Definition at line 185 of file nrf_mesh_node_config.h.
nrf_mesh_prov_oob_caps_t nrf_mesh_node_config_params_t::prov_caps |
Device capabilities for OOB authentication.
It is recommended to support at least the static authentication method. If no authentication methods are supported, the device will fall back to using non-secure provisioning, making the device vulnerable to certain attacks during provisioning.
Definition at line 198 of file nrf_mesh_node_config.h.
const char* nrf_mesh_node_config_params_t::p_device_uri |
NULL-terminated device URI string.
This is an optional field that can be used to add additional data to the unprovisioned node broadcast beacon.
Definition at line 205 of file nrf_mesh_node_config.h.
uint16_t nrf_mesh_node_config_params_t::oob_info_sources |
Device OOB information sources.
This adds information to the unprovisioned node broadcast beacon about where the user of a device can find information about the available OOB authentication methods supported by the device.
Definition at line 213 of file nrf_mesh_node_config.h.
const uint8_t* nrf_mesh_node_config_params_t::p_static_data |
Data used for OOB authentication when the static authentication method is used.
This should be a pointer to a 16 byte long data array. This field is optional, not used unless static authentication is one of the supported authentication methods.
Definition at line 221 of file nrf_mesh_node_config.h.
uint8_t nrf_mesh_node_config_params_t::irq_priority |
Application IRQ priority.
Specifies in which IRQ level the application code will be running. Set to NRF_MESH_IRQ_PRIORITY_THREAD if running in thread mode.
Definition at line 228 of file nrf_mesh_node_config.h.