Espressif ESP32-S2 User Manual

Chapter 2. API Reference
Please refer to Wi-Fi Alliance’s official page on Easy Connect for more information.
ESP32-S2 supports Enrollee mode of Easy Connect with QR Code as the provisioning method. A display is required
to display this QR Code. Users can scan this QR Code using their capable device and provision the ESP32-S2 to
their Wi-Fi network. The provisioning device needs to be connected to the AP which need not support Wi-Fi Easy
Connect™. Easy Connect is still an evolving protocol. Of known platforms that support the QR Code method are
some Android smartphones with Android 10 or higher. To use Easy Connect no additional App needs to be installed
on the supported smartphone.
Application Example Example on how to provision ESP32-S2 using a supported smartphone:
wifi/wifi_easy_connect/dpp-enrollee.
API Reference
Header File
• components/wpa_supplicant/esp_supplicant/include/esp_dpp.h
Functions
esp_err_t esp_supp_dpp_init(esp_supp_dpp_event_cb_t evt_cb)
Initialize DPP Supplicant.
Starts DPP Supplicant and initializes related Data Structures.
return
• ESP_OK: Success
• ESP_FAIL: Failure
Parameters
• evt_cb: Callback function to receive DPP related events
void esp_supp_dpp_deinit(void)
De-initalize DPP Supplicant.
Frees memory from DPP Supplicant Data Structures.
esp_err_t esp_supp_dpp_bootstrap_gen(const char *chan_list, esp_supp_dpp_bootstrap_t type,
const char *key, const char *info)
Generates Bootstrap Information as an Enrollee.
Generates Out Of Band Bootstrap information as an Enrollee which can be used by a DPP Configurator to
provision the Enrollee.
Return
• ESP_OK: Success
• ESP_FAIL: Failure
Parameters
• chan_list: List of channels device will be available on for listening
• type: Bootstrap method type, only QR Code method is supported for now.
• key: (Optional) Private Key used to generate a Bootstrapping Public Key
• info: (Optional) Ancilliary Device Information like Serial Number
esp_err_t esp_supp_dpp_start_listen(void)
Start listening on Channels provided during esp_supp_dpp_bootstrap_gen.
Listens on every Channel from Channel List for a pre-defined wait time.
Return
• ESP_OK: Success
• ESP_FAIL: Generic Failure
• ESP_ERR_INVALID_STATE: ROC attempted before WiFi is started
• ESP_ERR_NO_MEM: Memory allocation failed while posting ROC request
Espressif Systems 168
Submit Document Feedback
Release v4.4

Espressif ESP32-S2 Specifications

General

Brand	Espressif
Model	ESP32-S2
Category	Single board computers
Language	English