You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(wifi_prov_mgr): Updated the README.md for reprovisioning usage
Updated the README.md for the reprovisoning usage in wifi_prov_mgr example
and udpated the commnet for wifi_prov_mgr_reset_sm_state_for_reprovision api.
Copy file name to clipboardExpand all lines: examples/provisioning/wifi_prov_mgr/README.md
+52Lines changed: 52 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,6 +25,58 @@ This example can be used, as it is, for adding a provisioning service to any app
25
25
26
26
> Note: If you use this example code in your own project, in BLE mode, then remember to enable the BT stack and BTDM BLE control settings in your SDK configuration (e.g. by using the `sdkconfig.defaults` file from this project).
27
27
28
+
## Transports
29
+
30
+
### SoftAP Transport
31
+
- After successful provisioning, the SoftAP connection is not disconnected by default
32
+
- Users can directly reconnect to the device for reprovisioning
33
+
- It's the user's responsibility to manage connection memory and handle it according to application requirements
- This API is can be called internally by the device firmware to reset WiFi credentials and restart provisioning mode.
56
+
- For demonstration purposes, this API has been called directly in firmware code, In real-world scenarios following command based reprovisioning is preferred.
57
+
58
+
**External Command**:
59
+
-**Endpoint**: `prov-ctrl`
60
+
-**Command**: `TypeCmdCtrlReprov` (protobuf)
61
+
-**Transport**: HTTP/BLE as configured
62
+
- External clients (like Phone apps) can send this command via the transport layer to trigger the reprovisioning.
63
+
64
+
**Usage from esp_prov.py**:
65
+
```bash
66
+
python esp_prov.py --transport ble --service_name "PROV_DEVICE" --reprov
67
+
```
68
+
69
+
### Use Cases for Reprovisioning
70
+
71
+
This flexibility is particularly useful when:
72
+
- Network credentials need to be updated (password changes, SSID changes)
73
+
- Device needs to connect to a different network environment
- Moving devices between different locations with different network setups
76
+
77
+
For more details on the provisioning process and APIs, refer to the [Wi-Fi Provisioning Manager component documentation](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/provisioning/wifi_provisioning.html).
0 commit comments