Chapter 2. API Reference
Type Definitions
typedef void (*wifi_prov_cb_func_t)(void *user_data, wifi_prov_cb_event_t event, void
*event_data)
typedef struct wifi_prov_scheme wifi_prov_scheme_t
Structure for specifying the provisioning scheme to be followed by the manager.
Note Ready to use schemes are available:
• wifi_prov_scheme_ble : for provisioning over BLE transport + GATT server
• wifi_prov_scheme_softap : for provisioning over SoftAP transport + HTTP server
• wifi_prov_scheme_console : for provisioning over Serial UART transport + Console (for debugging)
typedef enum wifi_prov_security wifi_prov_security_t
Security modes supported by the Provisioning Manager.
These are same as the security modes provided by protocomm
Enumerations
enum wifi_prov_cb_event_t
Events generated by manager.
These events are generated in order of declaration and, for the stretch of time between initialization and de-
initialization of the manager, each event is signaled only once
Values:
WIFI_PROV_INIT
Emitted when the manager is initialized
WIFI_PROV_START
Indicates that provisioning has started
WIFI_PROV_CRED_RECV
Emitted when Wi-Fi AP credentials are received via protocomm endpoint wifi_config. The event
data in this case is a pointer to the corresponding wifi_sta_config_t structure
WIFI_PROV_CRED_FAIL
Emitted when device fails to connect to the AP of which the credentials were received earlier on event
WIFI_PROV_CRED_RECV. The event data in this case is a pointer to the disconnection reason code
with type wifi_prov_sta_fail_reason_t
WIFI_PROV_CRED_SUCCESS
Emitted when device successfully connects to the AP of which the credentials were received earlier on
event WIFI_PROV_CRED_RECV
WIFI_PROV_END
Signals that provisioning service has stopped
WIFI_PROV_DEINIT
Signals that manager has been de-initialized
enum wifi_prov_security
Security modes supported by the Provisioning Manager.
These are same as the security modes provided by protocomm
Values:
WIFI_PROV_SECURITY_0 = 0
No security (plain-text communication)
WIFI_PROV_SECURITY_1
This secure communication mode consists of X25519 key exchange
• proof of possession (pop) based authentication
• AES-CTR encryption
Espressif Systems 691
Submit Document Feedback
Release v4.4