diff --git a/examples/provisioning/README.md b/examples/provisioning/README.md index 4a755e3f53..7cdadadfcd 100644 --- a/examples/provisioning/README.md +++ b/examples/provisioning/README.md @@ -17,6 +17,14 @@ 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 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](https://github.com/espressif/esp-idf-provisioning-android#qr-code-scan). + ## 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: