nRF5 SDK for Mesh v4.0.0
Data Fields
mesh_provisionee_start_params_t Struct Reference

Mesh stack configuration parameters. More...

#include <mesh_provisionee.h>

Data Fields

mesh_provisionee_prov_complete_cb_t prov_complete_cb
 Pointer to a function used to signal the completion of the device provisioning procedure. More...
 
mesh_provisionee_prov_device_identification_start prov_device_identification_start_cb
 Pointer to a function used to signal the device to start identifying itself. More...
 
mesh_provisionee_prov_device_identification_stop prov_device_identification_stop_cb
 Pointer to a function used to signal the device to stop identifying itself. More...
 
mesh_provisionee_prov_abort prov_abort_cb
 Pointer to a function used to signal the abort of the device provisioning procedure. More...
 
const char * p_device_uri
 NULL-terminated device URI string. More...
 
const uint8_t * p_static_data
 Data used for static OOB authentication. More...
 

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 99 of file mesh_provisionee.h.

Field Documentation

◆ prov_complete_cb

mesh_provisionee_prov_complete_cb_t mesh_provisionee_start_params_t::prov_complete_cb

Pointer to a function used to signal the completion of the device provisioning procedure.

Can be set to NULL if not used.

Note
Getting this callback means that a device is at minimum provisioned, however, it does not imply anthing about model configuration, added keys, etc. That may be altered by a Configuration Client at any point in time. See Configuration Server application events.

Definition at line 110 of file mesh_provisionee.h.

◆ prov_device_identification_start_cb

mesh_provisionee_prov_device_identification_start mesh_provisionee_start_params_t::prov_device_identification_start_cb

Pointer to a function used to signal the device to start identifying itself.

Can be set to NULL if not used.

Definition at line 116 of file mesh_provisionee.h.

◆ prov_device_identification_stop_cb

mesh_provisionee_prov_device_identification_stop mesh_provisionee_start_params_t::prov_device_identification_stop_cb

Pointer to a function used to signal the device to stop identifying itself.

Can be set to NULL if not used.

Definition at line 122 of file mesh_provisionee.h.

◆ prov_abort_cb

mesh_provisionee_prov_abort mesh_provisionee_start_params_t::prov_abort_cb

Pointer to a function used to signal the abort of the device provisioning procedure.

Can be set to NULL if not used.

Definition at line 128 of file mesh_provisionee.h.

◆ p_device_uri

const char* mesh_provisionee_start_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 135 of file mesh_provisionee.h.

◆ p_static_data

const uint8_t* mesh_provisionee_start_params_t::p_static_data

Data used for static OOB authentication.

This should be a pointer to a 16 byte long data array.

Definition at line 141 of file mesh_provisionee.h.


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

Documentation feedback | Developer Zone | Subscribe | Updated