File espos_prov.h¶

FileList > espos_prov > include > espos_prov.h

#include <stdbool.h>
#include "esp_err.h"

Classes¶

Type	Name
struct	espos_prov_cfg_t

Public Functions¶

Type	Name
bool	espos_prov_got_credentials (void) True once credentials have been received and written to config.
bool	espos_prov_is_active (void) True between a successful start() and stop().
esp_err_t	espos_prov_register_api (void) Register GET /api/v1/prov (state, service name, PoP, QR payload).
esp_err_t	espos_prov_start (const espos_prov_cfg_t * cfg) Start BLE provisioning.
esp_err_t	espos_prov_stop (void) Stop provisioning, tear down the GATT server and resume scanning.

Public Functions Documentation¶

function espos_prov_got_credentials¶

True once credentials have been received and written to config.

bool espos_prov_got_credentials (
    void
)

The WiFi state machine decides what happens next; this only says the handover happened.

function espos_prov_is_active¶

True between a successful start() and stop().

bool espos_prov_is_active (
    void
)

function espos_prov_register_api¶

Register GET /api/v1/prov (state, service name, PoP, QR payload).

esp_err_t espos_prov_register_api (
    void
)

Called by espos_prov_start(); exposed for tests.

function espos_prov_start¶

Start BLE provisioning.

esp_err_t espos_prov_start (
    const espos_prov_cfg_t * cfg
)

NULL takes every default.

Suspends BLE scanning if espos_ble is running (see the note above), starts the GATT server, and returns as soon as it is advertising credentials arrive later, on the provisioning task.

ESP_ERR_INVALID_STATE if already running.

function espos_prov_stop¶

Stop provisioning, tear down the GATT server and resume scanning.

esp_err_t espos_prov_stop (
    void
)

The documentation for this class was generated from the following file espos_prov/include/espos_prov.h