Chapter 2. API Reference
wifi_prov_sta_conn_info_t conn_info
Connection information (valid only when wifi_state is WIFI_STATION_CONNECTED)
struct wifi_prov_config_set_data_t
WiFi config data received by slave during set_config request from master.
Public Members
char ssid[33]
SSID of the AP to which the slave is to be connected
char password[64]
Password of the AP
char bssid[6]
BSSID of the AP
uint8_t channel
Channel of the AP
struct wifi_prov_config_handlers
Internal handlers for receiving and responding to protocomm requests from master.
This is to be passed as priv_data for protocomm request handler (refer to
wifi_prov_config_data_handler()) when calling protocomm_add_endpoint().
Public Members
esp_err_t (*get_status_handler)(wifi_prov_config_get_data_t *resp_data, wifi_prov_ctx_t
**ctx)
Handler function called when connection status of the slave (in WiFi station mode) is requested
esp_err_t (*set_config_handler)(const wifi_prov_config_set_data_t *req_data,
wifi_prov_ctx_t **ctx)
Handler function called when WiFi connection configuration (eg. AP SSID, password, etc.) of the slave
(in WiFi station mode) is to be set to user provided values
esp_err_t (*apply_config_handler)(wifi_prov_ctx_t **ctx)
Handler function for applying the configuration that was set in set_config_handler. After apply-
ing the station may get connected to the AP or may fail to connect. The slave must be ready to convey the
updated connection status information when get_status_handler is invoked again by the master.
wifi_prov_ctx_t *ctx
Context pointer to be passed to above handler functions upon invocation
Type Definitions
typedef struct wifi_prov_ctx wifi_prov_ctx_t
Type of context data passed to each get/set/apply handler function set in wifi_prov_config_handlers
structure.
This is passed as an opaque pointer, thereby allowing it be defined later in application code as per requirements.
typedef struct wifi_prov_config_handlers wifi_prov_config_handlers_t
Internal handlers for receiving and responding to protocomm requests from master.
This is to be passed as priv_data for protocomm request handler (refer to
wifi_prov_config_data_handler()) when calling protocomm_add_endpoint().
Enumerations
enum wifi_prov_sta_state_t
WiFi STA status for conveying back to the provisioning master.
Values:
Espressif Systems 694
Submit Document Feedback
Release v4.4
To Next Page
Loading...