alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-09 12:35:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: added documentation for wifi_ctrl endpoint and updated esp_prov readme

Browse Source
This commit is contained in:
harshal.patil
2022-10-21 16:29:23 +05:30
parent b7de443aaa
commit e7a4062a30
2 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/en/api-reference/provisioning/wifi_provisioning.rst
View File

@@ -204,6 +204,9 @@ Once connected to the device, the provisioning related protocomm endpoints can b
* - prov-scan
- http://wifi-prov.local/prov-scan
- Endpoint used for starting Wi-Fi scan and receiving scan results
* - prov-ctrl
- http://wifi-prov.local/prov-ctrl
- Endpoint used for controlling Wi-Fi provisioning state
* - prov-config
- http://<mdns-hostname>.local/prov-config
- Endpoint used for configuring Wi-Fi credentials on device
@@ -241,6 +244,12 @@ After session establishment, client can also request Wi-Fi scan results from the
* `count` (input) - Number of entries to fetch from the starting index
* `entries` (output) - List of entries returned. Each entry consists of `ssid`, `channel` and `rssi` information
The client can also control the provisioning state of the device using `wifi_ctrl` endpoint. The `wifi_ctrl` endpoint supports the following protobuf commands:
* `ctrl_reset` - Resets internal state machine of the device and clears provisioned credentials only in case of provisioning failures.
* `ctrl_reprov` - Resets internal state machine of the device and clears provisioned credentials only in case the device is to be provisioned again for new credentials after a previous successful provisioning
Additional Endpoints
^^^^^^^^^^^^^^^^^^^^