From 156ae68275eb984d991302beb5624aec15818c7b Mon Sep 17 00:00:00 2001 From: Piyush Shah Date: Fri, 3 Jan 2020 20:57:49 +0530 Subject: [PATCH] provisioning_examples: Move older examples to legacy/ folder Change the manager example folder name to wifi_prov_mgr to sound more meaningful. Signed-off-by: Piyush Shah --- .flake8 | 2 +- .../api-reference/provisioning/protocomm.rst | 4 +-- .../provisioning/provisioning.rst | 12 ++++++--- .../provisioning/wifi_provisioning.rst | 20 +++++++++++++- examples/provisioning/README.md | 27 ++++++++++++++----- .../{ => legacy}/ble_prov/CMakeLists.txt | 0 .../{ => legacy}/ble_prov/Makefile | 0 .../{ => legacy}/ble_prov/README.md | 4 ++- .../{ => legacy}/ble_prov/ble_prov_test.py | 2 +- .../{ => legacy}/ble_prov/main/CMakeLists.txt | 0 .../ble_prov/main/Kconfig.projbuild | 0 .../{ => legacy}/ble_prov/main/app_main.c | 0 .../{ => legacy}/ble_prov/main/app_prov.c | 0 .../{ => legacy}/ble_prov/main/app_prov.h | 0 .../ble_prov/main/app_prov_handlers.c | 0 .../{ => legacy}/ble_prov/main/component.mk | 0 .../{ => legacy}/ble_prov/partitions.csv | 0 .../{ => legacy}/ble_prov/sdkconfig.defaults | 0 .../{ => legacy}/console_prov/CMakeLists.txt | 0 .../{ => legacy}/console_prov/Makefile | 0 .../{ => legacy}/console_prov/README.md | 4 ++- .../console_prov/main/CMakeLists.txt | 0 .../console_prov/main/Kconfig.projbuild | 0 .../{ => legacy}/console_prov/main/app_main.c | 0 .../{ => legacy}/console_prov/main/app_prov.c | 0 .../{ => legacy}/console_prov/main/app_prov.h | 0 .../console_prov/main/app_prov_handlers.c | 0 .../console_prov/main/component.mk | 0 .../{ => legacy}/custom_config/CMakeLists.txt | 0 .../{ => legacy}/custom_config/Makefile | 0 .../{ => legacy}/custom_config/README.md | 4 ++- .../custom_provisioning/CMakeLists.txt | 0 .../custom_provisioning/component.mk | 0 .../custom_provisioning/custom_config.h | 0 .../proto-c/custom_config.pb-c.c | 0 .../proto-c/custom_config.pb-c.h | 0 .../custom_provisioning/proto/CMakeLists.txt | 0 .../custom_provisioning/proto/README.md | 0 .../proto/custom_config.proto | 0 .../custom_provisioning/proto/makefile | 0 .../python/custom_config_pb2.py | 0 .../custom_provisioning/src/custom_config.c | 0 .../custom_config/main/CMakeLists.txt | 0 .../custom_config/main/Kconfig.projbuild | 0 .../custom_config/main/app_main.c | 0 .../custom_config/main/app_prov.c | 0 .../custom_config/main/app_prov.h | 0 .../custom_config/main/app_prov_handlers.c | 0 .../custom_config/main/component.mk | 0 .../{ => legacy}/softap_prov/CMakeLists.txt | 0 .../{ => legacy}/softap_prov/Makefile | 0 .../{ => legacy}/softap_prov/README.md | 4 ++- .../softap_prov/main/CMakeLists.txt | 0 .../softap_prov/main/Kconfig.projbuild | 0 .../{ => legacy}/softap_prov/main/app_main.c | 0 .../{ => legacy}/softap_prov/main/app_prov.c | 0 .../{ => legacy}/softap_prov/main/app_prov.h | 0 .../softap_prov/main/app_prov_handlers.c | 0 .../softap_prov}/main/component.mk | 0 .../softap_prov/softap_prov_test.py | 2 +- .../{manager => wifi_prov_mgr}/CMakeLists.txt | 0 .../{manager => wifi_prov_mgr}/Makefile | 0 .../{manager => wifi_prov_mgr}/README.md | 0 .../main/CMakeLists.txt | 0 .../main/app_main.c | 0 .../main/component.mk | 0 .../{manager => wifi_prov_mgr}/partitions.csv | 0 .../sdkconfig.defaults | 0 .../wifi_prov_mgr_test.py | 0 tools/esp_prov/proto/__init__.py | 2 +- 70 files changed, 66 insertions(+), 21 deletions(-) rename examples/provisioning/{ => legacy}/ble_prov/CMakeLists.txt (100%) rename examples/provisioning/{ => legacy}/ble_prov/Makefile (100%) rename examples/provisioning/{ => legacy}/ble_prov/README.md (96%) rename examples/provisioning/{ => legacy}/ble_prov/ble_prov_test.py (96%) rename examples/provisioning/{ => legacy}/ble_prov/main/CMakeLists.txt (100%) rename examples/provisioning/{ => legacy}/ble_prov/main/Kconfig.projbuild (100%) rename examples/provisioning/{ => legacy}/ble_prov/main/app_main.c (100%) rename examples/provisioning/{ => legacy}/ble_prov/main/app_prov.c (100%) rename examples/provisioning/{ => legacy}/ble_prov/main/app_prov.h (100%) rename examples/provisioning/{ => legacy}/ble_prov/main/app_prov_handlers.c (100%) rename examples/provisioning/{ => legacy}/ble_prov/main/component.mk (100%) rename examples/provisioning/{ => legacy}/ble_prov/partitions.csv (100%) rename examples/provisioning/{ => legacy}/ble_prov/sdkconfig.defaults (100%) rename examples/provisioning/{ => legacy}/console_prov/CMakeLists.txt (100%) rename examples/provisioning/{ => legacy}/console_prov/Makefile (100%) rename examples/provisioning/{ => legacy}/console_prov/README.md (96%) rename examples/provisioning/{ => legacy}/console_prov/main/CMakeLists.txt (100%) rename examples/provisioning/{ => legacy}/console_prov/main/Kconfig.projbuild (100%) rename examples/provisioning/{ => legacy}/console_prov/main/app_main.c (100%) rename examples/provisioning/{ => legacy}/console_prov/main/app_prov.c (100%) rename examples/provisioning/{ => legacy}/console_prov/main/app_prov.h (100%) rename examples/provisioning/{ => legacy}/console_prov/main/app_prov_handlers.c (100%) rename examples/provisioning/{ => legacy}/console_prov/main/component.mk (100%) rename examples/provisioning/{ => legacy}/custom_config/CMakeLists.txt (100%) rename examples/provisioning/{ => legacy}/custom_config/Makefile (100%) rename examples/provisioning/{ => legacy}/custom_config/README.md (95%) rename examples/provisioning/{ => legacy}/custom_config/components/custom_provisioning/CMakeLists.txt (100%) rename examples/provisioning/{ => legacy}/custom_config/components/custom_provisioning/component.mk (100%) rename examples/provisioning/{ => legacy}/custom_config/components/custom_provisioning/include/custom_provisioning/custom_config.h (100%) rename examples/provisioning/{ => legacy}/custom_config/components/custom_provisioning/proto-c/custom_config.pb-c.c (100%) rename examples/provisioning/{ => legacy}/custom_config/components/custom_provisioning/proto-c/custom_config.pb-c.h (100%) rename examples/provisioning/{ => legacy}/custom_config/components/custom_provisioning/proto/CMakeLists.txt (100%) rename examples/provisioning/{ => legacy}/custom_config/components/custom_provisioning/proto/README.md (100%) rename examples/provisioning/{ => legacy}/custom_config/components/custom_provisioning/proto/custom_config.proto (100%) rename examples/provisioning/{ => legacy}/custom_config/components/custom_provisioning/proto/makefile (100%) rename examples/provisioning/{ => legacy}/custom_config/components/custom_provisioning/python/custom_config_pb2.py (100%) rename examples/provisioning/{ => legacy}/custom_config/components/custom_provisioning/src/custom_config.c (100%) rename examples/provisioning/{ => legacy}/custom_config/main/CMakeLists.txt (100%) rename examples/provisioning/{ => legacy}/custom_config/main/Kconfig.projbuild (100%) rename examples/provisioning/{ => legacy}/custom_config/main/app_main.c (100%) rename examples/provisioning/{ => legacy}/custom_config/main/app_prov.c (100%) rename examples/provisioning/{ => legacy}/custom_config/main/app_prov.h (100%) rename examples/provisioning/{ => legacy}/custom_config/main/app_prov_handlers.c (100%) rename examples/provisioning/{ => legacy}/custom_config/main/component.mk (100%) rename examples/provisioning/{ => legacy}/softap_prov/CMakeLists.txt (100%) rename examples/provisioning/{ => legacy}/softap_prov/Makefile (100%) rename examples/provisioning/{ => legacy}/softap_prov/README.md (95%) rename examples/provisioning/{ => legacy}/softap_prov/main/CMakeLists.txt (100%) rename examples/provisioning/{ => legacy}/softap_prov/main/Kconfig.projbuild (100%) rename examples/provisioning/{ => legacy}/softap_prov/main/app_main.c (100%) rename examples/provisioning/{ => legacy}/softap_prov/main/app_prov.c (100%) rename examples/provisioning/{ => legacy}/softap_prov/main/app_prov.h (100%) rename examples/provisioning/{ => legacy}/softap_prov/main/app_prov_handlers.c (100%) rename examples/provisioning/{manager => legacy/softap_prov}/main/component.mk (100%) rename examples/provisioning/{ => legacy}/softap_prov/softap_prov_test.py (97%) rename examples/provisioning/{manager => wifi_prov_mgr}/CMakeLists.txt (100%) rename examples/provisioning/{manager => wifi_prov_mgr}/Makefile (100%) rename examples/provisioning/{manager => wifi_prov_mgr}/README.md (100%) rename examples/provisioning/{manager => wifi_prov_mgr}/main/CMakeLists.txt (100%) rename examples/provisioning/{manager => wifi_prov_mgr}/main/app_main.c (100%) rename examples/provisioning/{softap_prov => wifi_prov_mgr}/main/component.mk (100%) rename examples/provisioning/{manager => wifi_prov_mgr}/partitions.csv (100%) rename examples/provisioning/{manager => wifi_prov_mgr}/sdkconfig.defaults (100%) rename examples/provisioning/{manager => wifi_prov_mgr}/wifi_prov_mgr_test.py (100%) diff --git a/.flake8 b/.flake8 index d3591e051..e98aa15f2 100644 --- a/.flake8 +++ b/.flake8 @@ -162,4 +162,4 @@ exclude = components/wifi_provisioning/python/wifi_config_pb2.py, components/wifi_provisioning/python/wifi_constants_pb2.py, components/esp_local_ctrl/python/esp_local_ctrl_pb2.py, - examples/provisioning/custom_config/components/custom_provisioning/python/custom_config_pb2.py, + examples/provisioning/legacy/custom_config/components/custom_provisioning/python/custom_config_pb2.py, diff --git a/docs/en/api-reference/provisioning/protocomm.rst b/docs/en/api-reference/provisioning/protocomm.rst index a8139d36a..02e20b86a 100644 --- a/docs/en/api-reference/provisioning/protocomm.rst +++ b/docs/en/api-reference/provisioning/protocomm.rst @@ -19,7 +19,7 @@ Note that the client still needs to establish session (only for protocomm_securi Transport Example (SoftAP + HTTP) with Security 1 ------------------------------------------------- -For complete example see :example:`provisioning/softap_prov` +For complete example see :example:`provisioning/legacy/softap_prov` .. highlight:: c @@ -113,7 +113,7 @@ For complete example see :example:`provisioning/softap_prov` Transport Example (BLE) with Security 0 --------------------------------------- -For complete example see :example:`provisioning/ble_prov` +For complete example see :example:`provisioning/legacy/ble_prov` .. highlight:: c diff --git a/docs/en/api-reference/provisioning/provisioning.rst b/docs/en/api-reference/provisioning/provisioning.rst index 40b7d21d7..97e1d3ea6 100644 --- a/docs/en/api-reference/provisioning/provisioning.rst +++ b/docs/en/api-reference/provisioning/provisioning.rst @@ -144,15 +144,21 @@ Sample Code >>>>>>>>>>> Please refer to :doc:`protocomm` and :doc:`wifi_provisioning` for API guides and code snippets on example usage. -Various use case implementations can be found as examples under :example:`provisioning`. +Application implementation can be found as an example under :example:`provisioning`. Provisioning Tools >>>>>>>>>>>>>>>>>> Provisioning applications are available for various platforms, along with source code: -* Android : `esp-idf-provisioning-android `_ -* iOS : `esp-idf-provisioning-ios `_ +* Android: + * `BLE Provisioning app on Play Store `_. + * `SoftAP Provisioning app on Play Store `_. + * Source code on GitHub: `esp-idf-provisioning-android `_. +* iOS: + * `BLE Provisioning app on app store `_. + * `SoftAP Provisioning app on app Store `_. + * Source code on GitHub: `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/docs/en/api-reference/provisioning/wifi_provisioning.rst b/docs/en/api-reference/provisioning/wifi_provisioning.rst index 06c33ef1d..7e89516d1 100644 --- a/docs/en/api-reference/provisioning/wifi_provisioning.rst +++ b/docs/en/api-reference/provisioning/wifi_provisioning.rst @@ -274,7 +274,25 @@ The customized behavior is useful for applications which want the provisioning s Application Examples -------------------- -For complete example implementation see :example:`provisioning/manager` +For complete example implementation see :example:`provisioning/wifi_prov_mgr` + +Provisioning Tools +-------------------- + +Provisioning applications are available for various platforms, along with source code: + +* Android: + * `BLE Provisioning app on Play Store `_. + * `SoftAP Provisioning app on Play Store `_. + * Source code on GitHub: `esp-idf-provisioning-android `_. +* iOS: + * `BLE Provisioning app on app store `_. + * `SoftAP Provisioning app on app Store `_. + * Source code on GitHub: `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. + API Reference ------------- diff --git a/examples/provisioning/README.md b/examples/provisioning/README.md index 96e0b93bb..98134d411 100644 --- a/examples/provisioning/README.md +++ b/examples/provisioning/README.md @@ -1,6 +1,25 @@ # Provisioning Application Examples -These consist of the following examples : +This primarily consists of a single unified example wifi_prov_mgr + +* wifi_prov_mgr + Abstracts out most of the complexity of Wi-Fi provisioning and allows easy switching between the SoftAP (using HTTP) and BLE transports. + +Provisioning applications are available for various platforms: + +* Android: + - [BLE Provisioning app on Play Store](https://play.google.com/store/apps/details?id=com.espressif.provble). + - [SoftAP Provisioning app on Play Store](https://play.google.com/store/apps/details?id=com.espressif.provsoftap). + - Source code on GitHub: [esp-idf-provisioning-android](https://github.com/espressif/esp-idf-provisioning-android). +* iOS: + - [BLE Provisioning app on app store](https://apps.apple.com/in/app/esp-ble-provisioning/id1473590141) + - [SoftAP Provisioning app on app Store](https://apps.apple.com/in/app/esp-softap-provisioning/id1474040630) + - 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" + +## 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: * softap_prov Provisioning involves Wi-Fi station configuration via an HTTP server running on the device, which is initially configured to be in SoftAP mode. After provisioning, device runs in Wi-Fi station mode only and connects to the AP whose credentials were provided during provisioning. @@ -14,10 +33,4 @@ 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. -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/CMakeLists.txt b/examples/provisioning/legacy/ble_prov/CMakeLists.txt similarity index 100% rename from examples/provisioning/ble_prov/CMakeLists.txt rename to examples/provisioning/legacy/ble_prov/CMakeLists.txt diff --git a/examples/provisioning/ble_prov/Makefile b/examples/provisioning/legacy/ble_prov/Makefile similarity index 100% rename from examples/provisioning/ble_prov/Makefile rename to examples/provisioning/legacy/ble_prov/Makefile diff --git a/examples/provisioning/ble_prov/README.md b/examples/provisioning/legacy/ble_prov/README.md similarity index 96% rename from examples/provisioning/ble_prov/README.md rename to examples/provisioning/legacy/ble_prov/README.md index 1c871e657..949035aaf 100644 --- a/examples/provisioning/ble_prov/README.md +++ b/examples/provisioning/legacy/ble_prov/README.md @@ -1,4 +1,6 @@ -# BLE based Provisioning Example +# BLE based Provisioning Example (Legacy) + +> Note: It is recommended to use the new `wifi_prov_mgr` example which is based on the simpler `wifi_provisioning` APIs. Check this example only if you wish to use lower level provisioning and protocomm APIs and want more control over the handlers. (See the README.md file in the upper level 'examples' directory for more information about examples.) diff --git a/examples/provisioning/ble_prov/ble_prov_test.py b/examples/provisioning/legacy/ble_prov/ble_prov_test.py similarity index 96% rename from examples/provisioning/ble_prov/ble_prov_test.py rename to examples/provisioning/legacy/ble_prov/ble_prov_test.py index c4f57780c..eef5e51fe 100644 --- a/examples/provisioning/ble_prov/ble_prov_test.py +++ b/examples/provisioning/legacy/ble_prov/ble_prov_test.py @@ -29,7 +29,7 @@ esp_prov.config_throw_except = True @ttfw_idf.idf_example_test(env_tag="Example_WIFI_BT") def test_examples_provisioning_ble(env, extra_data): # Acquire DUT - dut1 = env.get_dut("ble_prov", "examples/provisioning/ble_prov", dut_class=ttfw_idf.ESP32DUT) + dut1 = env.get_dut("ble_prov", "examples/provisioning/legacy/ble_prov", dut_class=ttfw_idf.ESP32DUT) # Get binary file binary_file = os.path.join(dut1.app.binary_path, "ble_prov.bin") diff --git a/examples/provisioning/ble_prov/main/CMakeLists.txt b/examples/provisioning/legacy/ble_prov/main/CMakeLists.txt similarity index 100% rename from examples/provisioning/ble_prov/main/CMakeLists.txt rename to examples/provisioning/legacy/ble_prov/main/CMakeLists.txt diff --git a/examples/provisioning/ble_prov/main/Kconfig.projbuild b/examples/provisioning/legacy/ble_prov/main/Kconfig.projbuild similarity index 100% rename from examples/provisioning/ble_prov/main/Kconfig.projbuild rename to examples/provisioning/legacy/ble_prov/main/Kconfig.projbuild diff --git a/examples/provisioning/ble_prov/main/app_main.c b/examples/provisioning/legacy/ble_prov/main/app_main.c similarity index 100% rename from examples/provisioning/ble_prov/main/app_main.c rename to examples/provisioning/legacy/ble_prov/main/app_main.c diff --git a/examples/provisioning/ble_prov/main/app_prov.c b/examples/provisioning/legacy/ble_prov/main/app_prov.c similarity index 100% rename from examples/provisioning/ble_prov/main/app_prov.c rename to examples/provisioning/legacy/ble_prov/main/app_prov.c diff --git a/examples/provisioning/ble_prov/main/app_prov.h b/examples/provisioning/legacy/ble_prov/main/app_prov.h similarity index 100% rename from examples/provisioning/ble_prov/main/app_prov.h rename to examples/provisioning/legacy/ble_prov/main/app_prov.h diff --git a/examples/provisioning/ble_prov/main/app_prov_handlers.c b/examples/provisioning/legacy/ble_prov/main/app_prov_handlers.c similarity index 100% rename from examples/provisioning/ble_prov/main/app_prov_handlers.c rename to examples/provisioning/legacy/ble_prov/main/app_prov_handlers.c diff --git a/examples/provisioning/ble_prov/main/component.mk b/examples/provisioning/legacy/ble_prov/main/component.mk similarity index 100% rename from examples/provisioning/ble_prov/main/component.mk rename to examples/provisioning/legacy/ble_prov/main/component.mk diff --git a/examples/provisioning/ble_prov/partitions.csv b/examples/provisioning/legacy/ble_prov/partitions.csv similarity index 100% rename from examples/provisioning/ble_prov/partitions.csv rename to examples/provisioning/legacy/ble_prov/partitions.csv diff --git a/examples/provisioning/ble_prov/sdkconfig.defaults b/examples/provisioning/legacy/ble_prov/sdkconfig.defaults similarity index 100% rename from examples/provisioning/ble_prov/sdkconfig.defaults rename to examples/provisioning/legacy/ble_prov/sdkconfig.defaults diff --git a/examples/provisioning/console_prov/CMakeLists.txt b/examples/provisioning/legacy/console_prov/CMakeLists.txt similarity index 100% rename from examples/provisioning/console_prov/CMakeLists.txt rename to examples/provisioning/legacy/console_prov/CMakeLists.txt diff --git a/examples/provisioning/console_prov/Makefile b/examples/provisioning/legacy/console_prov/Makefile similarity index 100% rename from examples/provisioning/console_prov/Makefile rename to examples/provisioning/legacy/console_prov/Makefile diff --git a/examples/provisioning/console_prov/README.md b/examples/provisioning/legacy/console_prov/README.md similarity index 96% rename from examples/provisioning/console_prov/README.md rename to examples/provisioning/legacy/console_prov/README.md index 685fdf66c..9965bb25b 100644 --- a/examples/provisioning/console_prov/README.md +++ b/examples/provisioning/legacy/console_prov/README.md @@ -1,4 +1,6 @@ -# Console based Provisioning Example +# Console based Provisioning Example (Legacy) + +> Check this example only if you wish to use console based provisioning. For any real applications, it is recommended to use the new `wifi_prov_mgr` example which is based on the simpler `wifi_provisioning` APIs. (See the README.md file in the upper level 'examples' directory for more information about examples.) diff --git a/examples/provisioning/console_prov/main/CMakeLists.txt b/examples/provisioning/legacy/console_prov/main/CMakeLists.txt similarity index 100% rename from examples/provisioning/console_prov/main/CMakeLists.txt rename to examples/provisioning/legacy/console_prov/main/CMakeLists.txt diff --git a/examples/provisioning/console_prov/main/Kconfig.projbuild b/examples/provisioning/legacy/console_prov/main/Kconfig.projbuild similarity index 100% rename from examples/provisioning/console_prov/main/Kconfig.projbuild rename to examples/provisioning/legacy/console_prov/main/Kconfig.projbuild diff --git a/examples/provisioning/console_prov/main/app_main.c b/examples/provisioning/legacy/console_prov/main/app_main.c similarity index 100% rename from examples/provisioning/console_prov/main/app_main.c rename to examples/provisioning/legacy/console_prov/main/app_main.c diff --git a/examples/provisioning/console_prov/main/app_prov.c b/examples/provisioning/legacy/console_prov/main/app_prov.c similarity index 100% rename from examples/provisioning/console_prov/main/app_prov.c rename to examples/provisioning/legacy/console_prov/main/app_prov.c diff --git a/examples/provisioning/console_prov/main/app_prov.h b/examples/provisioning/legacy/console_prov/main/app_prov.h similarity index 100% rename from examples/provisioning/console_prov/main/app_prov.h rename to examples/provisioning/legacy/console_prov/main/app_prov.h diff --git a/examples/provisioning/console_prov/main/app_prov_handlers.c b/examples/provisioning/legacy/console_prov/main/app_prov_handlers.c similarity index 100% rename from examples/provisioning/console_prov/main/app_prov_handlers.c rename to examples/provisioning/legacy/console_prov/main/app_prov_handlers.c diff --git a/examples/provisioning/console_prov/main/component.mk b/examples/provisioning/legacy/console_prov/main/component.mk similarity index 100% rename from examples/provisioning/console_prov/main/component.mk rename to examples/provisioning/legacy/console_prov/main/component.mk diff --git a/examples/provisioning/custom_config/CMakeLists.txt b/examples/provisioning/legacy/custom_config/CMakeLists.txt similarity index 100% rename from examples/provisioning/custom_config/CMakeLists.txt rename to examples/provisioning/legacy/custom_config/CMakeLists.txt diff --git a/examples/provisioning/custom_config/Makefile b/examples/provisioning/legacy/custom_config/Makefile similarity index 100% rename from examples/provisioning/custom_config/Makefile rename to examples/provisioning/legacy/custom_config/Makefile diff --git a/examples/provisioning/custom_config/README.md b/examples/provisioning/legacy/custom_config/README.md similarity index 95% rename from examples/provisioning/custom_config/README.md rename to examples/provisioning/legacy/custom_config/README.md index dba1854a6..8cf9eea9e 100644 --- a/examples/provisioning/custom_config/README.md +++ b/examples/provisioning/legacy/custom_config/README.md @@ -1,4 +1,6 @@ -# SoftAP + HTTPD based Provisioning Example featuring Custom configuration +# SoftAP + HTTPD based Provisioning Example featuring Custom configuration (Legacy) + +> Note: It is recommended to use the new `wifi_prov_mgr` example which is based on the simpler `wifi_provisioning` APIs. Check this example only if you wish to use lower level provisioning and protocomm APIs and want more control over the handlers. (See the README.md file in the upper level 'examples' directory for more information about examples.) diff --git a/examples/provisioning/custom_config/components/custom_provisioning/CMakeLists.txt b/examples/provisioning/legacy/custom_config/components/custom_provisioning/CMakeLists.txt similarity index 100% rename from examples/provisioning/custom_config/components/custom_provisioning/CMakeLists.txt rename to examples/provisioning/legacy/custom_config/components/custom_provisioning/CMakeLists.txt diff --git a/examples/provisioning/custom_config/components/custom_provisioning/component.mk b/examples/provisioning/legacy/custom_config/components/custom_provisioning/component.mk similarity index 100% rename from examples/provisioning/custom_config/components/custom_provisioning/component.mk rename to examples/provisioning/legacy/custom_config/components/custom_provisioning/component.mk diff --git a/examples/provisioning/custom_config/components/custom_provisioning/include/custom_provisioning/custom_config.h b/examples/provisioning/legacy/custom_config/components/custom_provisioning/include/custom_provisioning/custom_config.h similarity index 100% rename from examples/provisioning/custom_config/components/custom_provisioning/include/custom_provisioning/custom_config.h rename to examples/provisioning/legacy/custom_config/components/custom_provisioning/include/custom_provisioning/custom_config.h diff --git a/examples/provisioning/custom_config/components/custom_provisioning/proto-c/custom_config.pb-c.c b/examples/provisioning/legacy/custom_config/components/custom_provisioning/proto-c/custom_config.pb-c.c similarity index 100% rename from examples/provisioning/custom_config/components/custom_provisioning/proto-c/custom_config.pb-c.c rename to examples/provisioning/legacy/custom_config/components/custom_provisioning/proto-c/custom_config.pb-c.c diff --git a/examples/provisioning/custom_config/components/custom_provisioning/proto-c/custom_config.pb-c.h b/examples/provisioning/legacy/custom_config/components/custom_provisioning/proto-c/custom_config.pb-c.h similarity index 100% rename from examples/provisioning/custom_config/components/custom_provisioning/proto-c/custom_config.pb-c.h rename to examples/provisioning/legacy/custom_config/components/custom_provisioning/proto-c/custom_config.pb-c.h diff --git a/examples/provisioning/custom_config/components/custom_provisioning/proto/CMakeLists.txt b/examples/provisioning/legacy/custom_config/components/custom_provisioning/proto/CMakeLists.txt similarity index 100% rename from examples/provisioning/custom_config/components/custom_provisioning/proto/CMakeLists.txt rename to examples/provisioning/legacy/custom_config/components/custom_provisioning/proto/CMakeLists.txt diff --git a/examples/provisioning/custom_config/components/custom_provisioning/proto/README.md b/examples/provisioning/legacy/custom_config/components/custom_provisioning/proto/README.md similarity index 100% rename from examples/provisioning/custom_config/components/custom_provisioning/proto/README.md rename to examples/provisioning/legacy/custom_config/components/custom_provisioning/proto/README.md diff --git a/examples/provisioning/custom_config/components/custom_provisioning/proto/custom_config.proto b/examples/provisioning/legacy/custom_config/components/custom_provisioning/proto/custom_config.proto similarity index 100% rename from examples/provisioning/custom_config/components/custom_provisioning/proto/custom_config.proto rename to examples/provisioning/legacy/custom_config/components/custom_provisioning/proto/custom_config.proto diff --git a/examples/provisioning/custom_config/components/custom_provisioning/proto/makefile b/examples/provisioning/legacy/custom_config/components/custom_provisioning/proto/makefile similarity index 100% rename from examples/provisioning/custom_config/components/custom_provisioning/proto/makefile rename to examples/provisioning/legacy/custom_config/components/custom_provisioning/proto/makefile diff --git a/examples/provisioning/custom_config/components/custom_provisioning/python/custom_config_pb2.py b/examples/provisioning/legacy/custom_config/components/custom_provisioning/python/custom_config_pb2.py similarity index 100% rename from examples/provisioning/custom_config/components/custom_provisioning/python/custom_config_pb2.py rename to examples/provisioning/legacy/custom_config/components/custom_provisioning/python/custom_config_pb2.py diff --git a/examples/provisioning/custom_config/components/custom_provisioning/src/custom_config.c b/examples/provisioning/legacy/custom_config/components/custom_provisioning/src/custom_config.c similarity index 100% rename from examples/provisioning/custom_config/components/custom_provisioning/src/custom_config.c rename to examples/provisioning/legacy/custom_config/components/custom_provisioning/src/custom_config.c diff --git a/examples/provisioning/custom_config/main/CMakeLists.txt b/examples/provisioning/legacy/custom_config/main/CMakeLists.txt similarity index 100% rename from examples/provisioning/custom_config/main/CMakeLists.txt rename to examples/provisioning/legacy/custom_config/main/CMakeLists.txt diff --git a/examples/provisioning/custom_config/main/Kconfig.projbuild b/examples/provisioning/legacy/custom_config/main/Kconfig.projbuild similarity index 100% rename from examples/provisioning/custom_config/main/Kconfig.projbuild rename to examples/provisioning/legacy/custom_config/main/Kconfig.projbuild diff --git a/examples/provisioning/custom_config/main/app_main.c b/examples/provisioning/legacy/custom_config/main/app_main.c similarity index 100% rename from examples/provisioning/custom_config/main/app_main.c rename to examples/provisioning/legacy/custom_config/main/app_main.c diff --git a/examples/provisioning/custom_config/main/app_prov.c b/examples/provisioning/legacy/custom_config/main/app_prov.c similarity index 100% rename from examples/provisioning/custom_config/main/app_prov.c rename to examples/provisioning/legacy/custom_config/main/app_prov.c diff --git a/examples/provisioning/custom_config/main/app_prov.h b/examples/provisioning/legacy/custom_config/main/app_prov.h similarity index 100% rename from examples/provisioning/custom_config/main/app_prov.h rename to examples/provisioning/legacy/custom_config/main/app_prov.h diff --git a/examples/provisioning/custom_config/main/app_prov_handlers.c b/examples/provisioning/legacy/custom_config/main/app_prov_handlers.c similarity index 100% rename from examples/provisioning/custom_config/main/app_prov_handlers.c rename to examples/provisioning/legacy/custom_config/main/app_prov_handlers.c diff --git a/examples/provisioning/custom_config/main/component.mk b/examples/provisioning/legacy/custom_config/main/component.mk similarity index 100% rename from examples/provisioning/custom_config/main/component.mk rename to examples/provisioning/legacy/custom_config/main/component.mk diff --git a/examples/provisioning/softap_prov/CMakeLists.txt b/examples/provisioning/legacy/softap_prov/CMakeLists.txt similarity index 100% rename from examples/provisioning/softap_prov/CMakeLists.txt rename to examples/provisioning/legacy/softap_prov/CMakeLists.txt diff --git a/examples/provisioning/softap_prov/Makefile b/examples/provisioning/legacy/softap_prov/Makefile similarity index 100% rename from examples/provisioning/softap_prov/Makefile rename to examples/provisioning/legacy/softap_prov/Makefile diff --git a/examples/provisioning/softap_prov/README.md b/examples/provisioning/legacy/softap_prov/README.md similarity index 95% rename from examples/provisioning/softap_prov/README.md rename to examples/provisioning/legacy/softap_prov/README.md index 086a18e63..750024904 100644 --- a/examples/provisioning/softap_prov/README.md +++ b/examples/provisioning/legacy/softap_prov/README.md @@ -1,4 +1,6 @@ -# SoftAP + HTTPD based Provisioning Example +# SoftAP + HTTPD based Provisioning Example (Legacy) + +> Note: It is recommended to use the new `wifi_prov_mgr` example which is based on the simpler `wifi_provisioning` APIs. Check this example only if you wish to use lower level provisioning and protocomm APIs and want more control over the handlers. (See the README.md file in the upper level 'examples' directory for more information about examples.) diff --git a/examples/provisioning/softap_prov/main/CMakeLists.txt b/examples/provisioning/legacy/softap_prov/main/CMakeLists.txt similarity index 100% rename from examples/provisioning/softap_prov/main/CMakeLists.txt rename to examples/provisioning/legacy/softap_prov/main/CMakeLists.txt diff --git a/examples/provisioning/softap_prov/main/Kconfig.projbuild b/examples/provisioning/legacy/softap_prov/main/Kconfig.projbuild similarity index 100% rename from examples/provisioning/softap_prov/main/Kconfig.projbuild rename to examples/provisioning/legacy/softap_prov/main/Kconfig.projbuild diff --git a/examples/provisioning/softap_prov/main/app_main.c b/examples/provisioning/legacy/softap_prov/main/app_main.c similarity index 100% rename from examples/provisioning/softap_prov/main/app_main.c rename to examples/provisioning/legacy/softap_prov/main/app_main.c diff --git a/examples/provisioning/softap_prov/main/app_prov.c b/examples/provisioning/legacy/softap_prov/main/app_prov.c similarity index 100% rename from examples/provisioning/softap_prov/main/app_prov.c rename to examples/provisioning/legacy/softap_prov/main/app_prov.c diff --git a/examples/provisioning/softap_prov/main/app_prov.h b/examples/provisioning/legacy/softap_prov/main/app_prov.h similarity index 100% rename from examples/provisioning/softap_prov/main/app_prov.h rename to examples/provisioning/legacy/softap_prov/main/app_prov.h diff --git a/examples/provisioning/softap_prov/main/app_prov_handlers.c b/examples/provisioning/legacy/softap_prov/main/app_prov_handlers.c similarity index 100% rename from examples/provisioning/softap_prov/main/app_prov_handlers.c rename to examples/provisioning/legacy/softap_prov/main/app_prov_handlers.c diff --git a/examples/provisioning/manager/main/component.mk b/examples/provisioning/legacy/softap_prov/main/component.mk similarity index 100% rename from examples/provisioning/manager/main/component.mk rename to examples/provisioning/legacy/softap_prov/main/component.mk diff --git a/examples/provisioning/softap_prov/softap_prov_test.py b/examples/provisioning/legacy/softap_prov/softap_prov_test.py similarity index 97% rename from examples/provisioning/softap_prov/softap_prov_test.py rename to examples/provisioning/legacy/softap_prov/softap_prov_test.py index 09381b362..238234c15 100644 --- a/examples/provisioning/softap_prov/softap_prov_test.py +++ b/examples/provisioning/legacy/softap_prov/softap_prov_test.py @@ -30,7 +30,7 @@ esp_prov.config_throw_except = True @ttfw_idf.idf_example_test(env_tag="Example_WIFI_BT") def test_examples_provisioning_softap(env, extra_data): # Acquire DUT - dut1 = env.get_dut("softap_prov", "examples/provisioning/softap_prov", dut_class=ttfw_idf.ESP32DUT) + dut1 = env.get_dut("softap_prov", "examples/provisioning/legacy/softap_prov", dut_class=ttfw_idf.ESP32DUT) # Get binary file binary_file = os.path.join(dut1.app.binary_path, "softap_prov.bin") diff --git a/examples/provisioning/manager/CMakeLists.txt b/examples/provisioning/wifi_prov_mgr/CMakeLists.txt similarity index 100% rename from examples/provisioning/manager/CMakeLists.txt rename to examples/provisioning/wifi_prov_mgr/CMakeLists.txt diff --git a/examples/provisioning/manager/Makefile b/examples/provisioning/wifi_prov_mgr/Makefile similarity index 100% rename from examples/provisioning/manager/Makefile rename to examples/provisioning/wifi_prov_mgr/Makefile diff --git a/examples/provisioning/manager/README.md b/examples/provisioning/wifi_prov_mgr/README.md similarity index 100% rename from examples/provisioning/manager/README.md rename to examples/provisioning/wifi_prov_mgr/README.md diff --git a/examples/provisioning/manager/main/CMakeLists.txt b/examples/provisioning/wifi_prov_mgr/main/CMakeLists.txt similarity index 100% rename from examples/provisioning/manager/main/CMakeLists.txt rename to examples/provisioning/wifi_prov_mgr/main/CMakeLists.txt diff --git a/examples/provisioning/manager/main/app_main.c b/examples/provisioning/wifi_prov_mgr/main/app_main.c similarity index 100% rename from examples/provisioning/manager/main/app_main.c rename to examples/provisioning/wifi_prov_mgr/main/app_main.c diff --git a/examples/provisioning/softap_prov/main/component.mk b/examples/provisioning/wifi_prov_mgr/main/component.mk similarity index 100% rename from examples/provisioning/softap_prov/main/component.mk rename to examples/provisioning/wifi_prov_mgr/main/component.mk diff --git a/examples/provisioning/manager/partitions.csv b/examples/provisioning/wifi_prov_mgr/partitions.csv similarity index 100% rename from examples/provisioning/manager/partitions.csv rename to examples/provisioning/wifi_prov_mgr/partitions.csv diff --git a/examples/provisioning/manager/sdkconfig.defaults b/examples/provisioning/wifi_prov_mgr/sdkconfig.defaults similarity index 100% rename from examples/provisioning/manager/sdkconfig.defaults rename to examples/provisioning/wifi_prov_mgr/sdkconfig.defaults diff --git a/examples/provisioning/manager/wifi_prov_mgr_test.py b/examples/provisioning/wifi_prov_mgr/wifi_prov_mgr_test.py similarity index 100% rename from examples/provisioning/manager/wifi_prov_mgr_test.py rename to examples/provisioning/wifi_prov_mgr/wifi_prov_mgr_test.py diff --git a/tools/esp_prov/proto/__init__.py b/tools/esp_prov/proto/__init__.py index 82726cd95..54186629d 100644 --- a/tools/esp_prov/proto/__init__.py +++ b/tools/esp_prov/proto/__init__.py @@ -41,4 +41,4 @@ wifi_scan_pb2 = _load_source("wifi_scan_pb2", idf_path + "/components/ # custom_provisioning component related python files generated from .proto files custom_config_pb2 = _load_source("custom_config_pb2", idf_path + - "/examples/provisioning/custom_config/components/custom_provisioning/python/custom_config_pb2.py") + "/examples/provisioning/legacy/custom_config/components/custom_provisioning/python/custom_config_pb2.py")