From 2bb669cfbdb68ca40b98672e51ada8b977e34bc0 Mon Sep 17 00:00:00 2001 From: Anurag Kar Date: Thu, 18 Oct 2018 13:49:04 +0530 Subject: [PATCH] Docs : Provisioning docs and READMEs updated with links to GitHub repositories of Android and iOS apps --- .../en/api-reference/provisioning/provisioning.rst | 8 ++++++-- examples/provisioning/README.md | 6 +++++- examples/provisioning/ble_prov/README.md | 14 ++++++++++++-- examples/provisioning/console_prov/README.md | 2 +- examples/provisioning/custom_config/README.md | 2 +- examples/provisioning/softap_prov/README.md | 14 ++++++++++++-- 6 files changed, 37 insertions(+), 9 deletions(-) diff --git a/docs/en/api-reference/provisioning/provisioning.rst b/docs/en/api-reference/provisioning/provisioning.rst index 7990e31ae6..40b7d21d7b 100644 --- a/docs/en/api-reference/provisioning/provisioning.rst +++ b/docs/en/api-reference/provisioning/provisioning.rst @@ -149,6 +149,10 @@ Various use case implementations can be found as examples under :example:`provis Provisioning Tools >>>>>>>>>>>>>>>>>> -A python based provisioning tool is provided under `$IDF_PATH/tools/esp_prov`, intended for use along with the examples under :example:`provisioning`. +Provisioning applications are available for various platforms, along with source code: -For android, a provisioning tool along with source code is available on Github as `esp-idf-provisioning-android `_ +* Android : `esp-idf-provisioning-android `_ +* iOS : `esp-idf-provisioning-ios `_ +* Linux/MacOS/Windows : :idf:`tools/esp_prov` (a python based command line tool for provisioning) + +The phone applications offer simple UI and thus more user centric, while the command line application is useful as a debugging tool for developers. diff --git a/examples/provisioning/README.md b/examples/provisioning/README.md index d265300e3a..96e0b93bb0 100644 --- a/examples/provisioning/README.md +++ b/examples/provisioning/README.md @@ -14,6 +14,10 @@ These consist of the following examples : * custom_config Similar to softap_prov examples, but allows for configuration of custom (device-local) information during provisioning. This is intended as an example for implementing custom provisioning schemes. -A python based utility is provided under "$IDF_PATH/tools/esp_prov" for testing the examples over a host. +Provisioning applications are available for various platforms: + +* For Android, a provisioning application along with source code is available on GitHub : [esp-idf-provisioning-android](https://github.com/espressif/esp-idf-provisioning-android) +* For iOS, a provisioning application along with source code is available 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" Refer to the README.md files in each example directory for more information. diff --git a/examples/provisioning/ble_prov/README.md b/examples/provisioning/ble_prov/README.md index 8b61235a8f..d6d5223a9c 100644 --- a/examples/provisioning/ble_prov/README.md +++ b/examples/provisioning/ble_prov/README.md @@ -26,14 +26,24 @@ Example should be able to run on any commonly available ESP32 development board. ### Application Required +Provisioning applications are available for various platforms. See below + +#### Platform : Android + +For Android, a provisioning application along with source code is available on GitHub : [esp-idf-provisioning-android](https://github.com/espressif/esp-idf-provisioning-android) + +#### Platform : iOS + +For iOS, a provisioning application along with source code is available on GitHub : [esp-idf-provisioning-ios](https://github.com/espressif/esp-idf-provisioning-ios) + +#### Platform : Linux / Windows / macOS + To provision the device running this example, the `esp_prov.py` script needs to be run (found under `$IDF_PATH/tools/esp_prov`). Make sure to satisfy all the dependencies prior to running the script. Presently, `esp_prov` supports BLE transport only for Linux platform. For Windows/macOS it falls back to console mode and requires another application (for BLE) through which the communication can take place. There are various applications, specific to Windows and macOS platform which can be used. The `esp_prov` console will guide you through the provisioning process of locating the correct BLE GATT services and characteristics, the values to write, and input read values. -For android, a provisioning tool along with source code is available [here](https://github.com/espressif/esp-idf-provisioning-android). This offers a simpler and more close to actual user experience. - ### Configure the project ``` diff --git a/examples/provisioning/console_prov/README.md b/examples/provisioning/console_prov/README.md index 1584b32bda..cb7551c614 100644 --- a/examples/provisioning/console_prov/README.md +++ b/examples/provisioning/console_prov/README.md @@ -25,7 +25,7 @@ Example should be able to run on any commonly available ESP32 development board. ### Application Required -To provision the device running this example, the `esp_prov.py` script needs to be run (found under `$IDF_PATH/tools/esp_prov`). This feature of `esp_prov` should work on all platforms as long long as all Python dependencies are satisfied. +To provision the device running this example, the `esp_prov.py` script needs to be run (found under `$IDF_PATH/tools/esp_prov`). This feature of `esp_prov` should work on all platforms, given the dependencies are satisfied. ### Configure the project diff --git a/examples/provisioning/custom_config/README.md b/examples/provisioning/custom_config/README.md index 55c7e8cc31..6a07e69f60 100644 --- a/examples/provisioning/custom_config/README.md +++ b/examples/provisioning/custom_config/README.md @@ -24,7 +24,7 @@ Example should be able to run on any commonly available ESP32 development board. ### Application Required -To provision the device running this example, the `esp_prov.py` script needs to be run (found under `$IDF_PATH/tools/esp_prov`). This feature of `esp_prov` should work on all platforms as long long as all Python dependencies are satisfied. +To provision the device running this example, the `esp_prov.py` script needs to be run (found under `$IDF_PATH/tools/esp_prov`). This feature of `esp_prov` should work on all platforms, given the dependencies are satisfied. ### Configure the project diff --git a/examples/provisioning/softap_prov/README.md b/examples/provisioning/softap_prov/README.md index 5df3e83b0f..e5445b80c8 100644 --- a/examples/provisioning/softap_prov/README.md +++ b/examples/provisioning/softap_prov/README.md @@ -25,9 +25,19 @@ Example should be able to run on any commonly available ESP32 development board. ### Application Required -To provision the device running this example, the `esp_prov.py` script needs to be run (found under `$IDF_PATH/tools/esp_prov`). This feature of `esp_prov` should work on all platforms as long long as all Python dependencies are satisfied. +Provisioning applications are available for various platforms. See below -For android, a provisioning tool along with source code is available [here](https://github.com/espressif/esp-idf-provisioning-android). This offers a simpler and more close to actual user experience. +#### Platform : Android + +For Android, a provisioning application along with source code is available on GitHub : [esp-idf-provisioning-android](https://github.com/espressif/esp-idf-provisioning-android) + +#### Platform : iOS + +For iOS, a provisioning application along with source code is available on GitHub : [esp-idf-provisioning-ios](https://github.com/espressif/esp-idf-provisioning-ios) + +#### Platform : Linux / Windows / macOS + +To provision the device running this example, the `esp_prov.py` script needs to be run (found under `$IDF_PATH/tools/esp_prov`). This feature of `esp_prov` should work on all platforms, given the dependencies are satisfied. ### Configure the project