nRF5 SDK for Mesh v5.0.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_sd_ble_opt_set_cb_t) (void)
 Set BLE stack option callback type. More...
 
typedef void(* mesh_provisionee_prov_complete_cb_t) (void)
 Provisioning complete callback type. More...
 
typedef void(* mesh_provisionee_prov_device_identification_start) (uint8_t attention_duration_s)
 Start device identification callback type. More...
 
typedef void(* mesh_provisionee_prov_device_identification_stop) (void)
 Stop device identification callback type. More...
 
typedef void(* mesh_provisionee_prov_abort) (void)
 Provisioning abort callback type. 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_sd_ble_opt_set_cb_t

typedef void(* mesh_provisionee_prov_sd_ble_opt_set_cb_t) (void)

Set BLE stack option callback type.

This callback is called to indicate that BLE stack was restarted and any BLE option can be set at this point through sd_ble_opt_set function.

Definition at line 58 of file mesh_provisionee.h.

◆ mesh_provisionee_prov_complete_cb_t

typedef void(* mesh_provisionee_prov_complete_cb_t) (void)

Provisioning complete callback type.

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

Definition at line 65 of file mesh_provisionee.h.

◆ mesh_provisionee_prov_device_identification_start

typedef void(* mesh_provisionee_prov_device_identification_start) (uint8_t attention_duration_s)

Start device identification callback type.

This callback is called to indicate that the device can start identifying itself using any means it can to attract attention.

Note
This callback is called every time when the device is asked to start identifying itself.
Parameters
[in]attention_duration_sTime in seconds during which the device identifies itself using any means it can.

Definition at line 79 of file mesh_provisionee.h.

◆ mesh_provisionee_prov_device_identification_stop

typedef void(* mesh_provisionee_prov_device_identification_stop) (void)

Stop device identification callback type.

This callback is called to indicate that the device should stop identifying itself.

Note
This callback is called only once per provisioning process.

Definition at line 88 of file mesh_provisionee.h.

◆ mesh_provisionee_prov_abort

typedef void(* mesh_provisionee_prov_abort) (void)

Provisioning abort callback type.

This callback is called if the provisioning process is aborted.

Note
This callback can be used to stop the device from identifying itself if the provisioning process is aborted before mesh_provisionee_prov_device_identification_stop is called.

Definition at line 98 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