alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
3cd5ba44d1
esp-idf/examples/provisioning/README.md

27 lines
1.7 KiB
Markdown
Raw Normal View History

Examples : Added provisioning examples, tests and client tool. * BLE and softAP provisioning examples added along with tests. * An application specific example added for demonstrating custom provisioning scheme. * tools/esp_prov/esp_prov.py can be used as a provisioning client for SoftAP, BLE and CLI based transports. Co-Authored-By: Amey Inamdar <amey@espressif.com> Co-Authored-By: Anurag Kar <anurag.kar@espressif.com>
2018-07-30 12:10:10 -04:00
# Provisioning Application Examples
provisioning_examples: Move older examples to legacy/ folder Change the manager example folder name to wifi_prov_mgr to sound more meaningful. Signed-off-by: Piyush Shah <piyush@espressif.com>
2020-01-03 10:27:49 -05:00
This primarily consists of a single unified example wifi_prov_mgr
* wifi_prov_mgr
wifi_prov_mgr: Add config options to switch transport and support for custom data Config options have been set such that BLE transport will be the default for ESP32 and SoftAP will be the default for ESP-S2. CMakeLists.txt for all provisioning examples applicable for ESP32-S2 have also been updated as these now work fine on ESP32-S2 Signed-off-by: Piyush Shah <piyush@espressif.com>
2020-01-03 10:36:10 -05:00
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_examples: Move older examples to legacy/ folder Change the manager example folder name to wifi_prov_mgr to sound more meaningful. Signed-off-by: Piyush Shah <piyush@espressif.com>
2020-01-03 10:27:49 -05:00
Provisioning applications are available for various platforms:
* Android:
- [BLE Provisioning app on Play Store](https://play.google.com/store/apps/details?id=com.espressif.provble).
- [SoftAP Provisioning app on Play Store](https://play.google.com/store/apps/details?id=com.espressif.provsoftap).
- Source code on GitHub: [esp-idf-provisioning-android](https://github.com/espressif/esp-idf-provisioning-android).
* iOS:
- [BLE Provisioning app on app store](https://apps.apple.com/in/app/esp-ble-provisioning/id1473590141)
- [SoftAP Provisioning app on app Store](https://apps.apple.com/in/app/esp-softap-provisioning/id1474040630)
- Source code on GitHub: [esp-idf-provisioning-ios](https://github.com/espressif/esp-idf-provisioning-ios)
* For all other platforms a python based command line tool is provided under "$IDF_PATH/tools/esp_prov"
provisioning: update README.md
2021-03-02 01:57:02 -05:00
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:
provisioning: Update README.md to explain QR code format Add examples of how to create a QR code that will be recognised by the iOS or Android app Signed-off-by: yuanjm <yuanjianmin@espressif.com> Merges https://github.com/espressif/esp-idf/pull/6629
2021-02-28 05:03:55 -05:00
```
{"ver":"v1","name":"PROV_000318","pop":"a1000318","transport":"softap"}
```
provisioning: update README.md
2021-03-02 01:57:02 -05:00
The more details about QR code format, you can refer to [QR Code Scan](https://github.com/espressif/esp-idf-provisioning-android#qr-code-scan).
Reference in New Issue Copy Permalink