mirror of https://github.com/espressif/esp-idf.git synced 2024-09-19 14:26:01 -04:00

History

Aditya Patwardhan f2cce5fa0d wifi_provisioning: Update the APIs with reference to the new APIs from protocomm esp_local_ctrl: Update the code with reference to new changes in protocomm component		2022-06-17 13:16:20 +00:00
..
wifi_prov_mgr	wifi_provisioning: Update the APIs with reference to the new APIs from protocomm	2022-06-17 13:16:20 +00:00
README.md	provisioning: Remove legacy examples section from README	2022-01-28 09:58:43 +05:30

README.md

Provisioning Application Examples

This primarily consists of a single unified example wifi_prov_mgr

wifi_prov_mgr Abstracts out most of the complexity of Wi-Fi provisioning and allows easy switching between the SoftAP (using HTTP) and BLE transports. It also demonstrates how applications can register and use additional custom data endpoints.

Provisioning applications are available for various platforms:

Android:
- BLE Provisioning app on Play Store.
- SoftAP Provisioning app on Play Store.
- Source code on GitHub: esp-idf-provisioning-android.
iOS:
- BLE Provisioning app on app store
- SoftAP Provisioning app on app Store
- Source code on GitHub: esp-idf-provisioning-ios
For all other platforms a python based command line tool is provided under "$IDF_PATH/tools/esp_prov"

The Android and iOS provisioning applications allow the user to configure the device manually or by scanning a QR code. QR codes can be generated by any online QR code generator. QR code payload is encoded with a JSON string containing the device name, proof-of-possession key (if used) and transport type (BLE or softAP), for example:

{"ver":"v1","name":"PROV_000318","pop":"a1000318","transport":"softap"}

The more details about QR code format, you can refer to QR Code Scan.