nRF5 SDK for Mesh v2.2.0
Data Structures | Typedefs | Functions
Mesh examples provisionee support module

Mesh examples support module for starting the provisioning process for a device in the provisionee role using PB-ADV and static OOB authentication. More...

Data Structures

struct  mesh_provisionee_start_params_t
 Mesh stack configuration parameters. More...
 

Typedefs

typedef void(* mesh_provisionee_prov_complete_cb_t) (void)
 Provisioning complete callback. More...
 

Functions

uint32_t mesh_provisionee_prov_start (const mesh_provisionee_start_params_t *p_start_params)
 Start the provisioning process for a device in the provisionee role using static OOB authentication. More...
 
uint32_t mesh_provisionee_prov_listen_stop (void)
 Stops listening for incoming provisioning links. More...
 

Detailed Description

Mesh examples support module for starting the provisioning process for a device in the provisionee role using PB-ADV and static OOB authentication.

Typedef Documentation

◆ mesh_provisionee_prov_complete_cb_t

typedef void(* mesh_provisionee_prov_complete_cb_t) (void)

Provisioning complete callback.

This function is called to indicate that the device has been successfully provisioned.

Definition at line 57 of file mesh_provisionee.h.

Function Documentation

◆ mesh_provisionee_prov_start()

uint32_t mesh_provisionee_prov_start ( const mesh_provisionee_start_params_t p_start_params)

Start the provisioning process for a device in the provisionee role using static OOB authentication.

Parameters
[in]p_start_paramsPointer to structure containing parameters related to the provisioning procedure.
Return values
NRF_ERROR_INVALID_STATEThe provisioning module is not in idle state.
NRF_ERROR_INVALID_PARAMThe p_static_data parameter is NULL.
NRF_SUCCESSThe provisioning was started successfully.

◆ mesh_provisionee_prov_listen_stop()

uint32_t mesh_provisionee_prov_listen_stop ( void  )

Stops listening for incoming provisioning links.

Return values
NRF_ERROR_INVALID_STATEThe provisionee is not currently listening.
NRF_SUCCESSSuccessfully stopped listening.

Documentation feedback | Developer Zone | Subscribe | Updated