alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

provisioning: Remove legacy examples section from README

Browse Source
This commit is contained in:
Laukik Hase 2022-01-28 09:39:31 +05:30
parent d587a1ce6d
commit 07f1e49566
2 changed files with 2 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
examples/provisioning/README.md
View File

@ -24,21 +24,3 @@ The Android and iOS provisioning applications allow the user to configure the de
``` ```
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). 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:
* 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.
* ble_prov
Provisioning involves Wi-Fi station configuration via BLE service endpoints running on the device initially. After provisioning, BLE is turned off and device runs in Wi-Fi station mode, connecting to the AP whose credentials were provided during provisioning.
* console_prov
Provisioning involves Wi-Fi station configuration via UART console. This is intended for debugging protocomm and provisioning related features.
* 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.
Refer to the README.md files in each example directory for more information.

9
tools/esp_prov/README.md
View File

@ -91,11 +91,6 @@ Run `pip install -r $IDF_PATH/tools/esp_prov/requirements_linux_extra.txt`
# EXAMPLE USAGE # EXAMPLE USAGE
Please refer to the README.md files with the examples present under `$IDF_PATH/examples/provisioning/`, namely: Please refer to the README.md file with the `wifi_prov_mgr` example present under `$IDF_PATH/examples/provisioning/`.
* `ble_prov` This example uses specific options of the `esp_prov` tool and gives an overview of simple as well as advanced usage scenarios.
* `softap_prov`
* `custom_config`
* `console_prov`
Each of these examples use specific options of the `esp_prov` tool and give an overview to simple as well as advanced usage scenarios.