]> granicus.if.org Git - esp-idf/commitdiff
Docs : Provisioning docs and READMEs updated with links to GitHub repositories of...
authorAnurag Kar <anurag.kar@espressif.com>
Thu, 18 Oct 2018 08:19:04 +0000 (13:49 +0530)
committerAnurag Kar <anurag.kar@espressif.com>
Thu, 18 Oct 2018 12:53:03 +0000 (18:23 +0530)
docs/en/api-reference/provisioning/provisioning.rst
examples/provisioning/README.md
examples/provisioning/ble_prov/README.md
examples/provisioning/console_prov/README.md
examples/provisioning/custom_config/README.md
examples/provisioning/softap_prov/README.md

index 7990e31ae6badaf969d2353c8a66974c4e275d92..40b7d21d7becda3b87df8b5e96f5a5a033b8bfdc 100644 (file)
@@ -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 <https://github.com/espressif/esp-idf-provisioning-android>`_
+* Android : `esp-idf-provisioning-android <https://github.com/espressif/esp-idf-provisioning-android>`_
+* iOS : `esp-idf-provisioning-ios <https://github.com/espressif/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.
index d265300e3ac3a1adb81ebf65bbf2d711f6623721..96e0b93bb0f66ecb3cc3af88c0a3bf0e1095352b 100644 (file)
@@ -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.
index 8b61235a8faeb55efaac32e1c1fadcd1801fbb44..d6d5223a9c498c0fa4392b26b5291df0cfc0b311 100644 (file)
@@ -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
 
 ```
index 1584b32bda774eb2dd7427032985d5033db92572..cb7551c614646e6af4669452dd21cb97f9e2bebb 100644 (file)
@@ -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
 
index 55c7e8cc31203b09577f637fb9ea679bdf57b1ff..6a07e69f608762ed6634f9644405276b455eb9f9 100644 (file)
@@ -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
 
index 5df3e83b0f9e9fe398e2c01c948a3dd9c14556b0..e5445b80c8ab65a4057b922ea90e27df4da3d615 100644 (file)
@@ -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