From b3e384272a224f3d4e6122f9628ae8c9e6d54bfb Mon Sep 17 00:00:00 2001 From: mjcross Date: Sun, 28 Feb 2021 10:03:55 +0000 Subject: [PATCH 1/2] 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 Merges https://github.com/espressif/esp-idf/pull/6629 --- examples/provisioning/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/examples/provisioning/README.md b/examples/provisioning/README.md index 4a755e3f53..f617fd211f 100644 --- a/examples/provisioning/README.md +++ b/examples/provisioning/README.md @@ -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: From 444f81983e93d5ce1aa7c765ee5008ebbd2fc868 Mon Sep 17 00:00:00 2001 From: yuanjm Date: Tue, 2 Mar 2021 14:57:02 +0800 Subject: [PATCH 2/2] provisioning: update README.md --- examples/provisioning/README.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/examples/provisioning/README.md b/examples/provisioning/README.md index f617fd211f..7cdadadfcd 100644 --- a/examples/provisioning/README.md +++ b/examples/provisioning/README.md @@ -17,17 +17,13 @@ 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: +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"} ``` -or - -``` - {"ver":"v1","name":"PROV_EB15D5","pop":"abcd1234","transport":"ble"} - ``` +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). ## Legacy Examples