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

provisioning: Update README.md to explain QR code format

Browse Source 
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
This commit is contained in:
mjcross 2021-02-28 10:03:55 +00:00 committed by bot
parent eedcb8c97f
commit 66c533b3d5
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
examples/provisioning/README.md
View File

@ -17,6 +17,18 @@ Provisioning applications are available for various platforms:
- 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"
The Andriod and iOS provisioning applications allow the user to select the device manually or by scanning a QR code. Suitable QR codes can be generated by encoding a text string containing the device name, prooof-of-posession key (if used) and transport type (BLE or softAP), for example:
```
{"ver":"v1","name":"PROV_000318","pop":"a1000318","transport":"softap"}
```
or
```
{"ver":"v1","name":"PROV_EB15D5","pop":"abcd1234","transport":"ble"}
```
## Legacy Examples
The legacy examples require own implementation of provisioning functions and handlers. The Wi-Fi provisioning component abstracts out most of this complexity and provides a simpler interface and so, that is recommended for use. However, if you want to use lower level provisioning and protocomm APIs, you can check the these examples under legacy/ folder: