ElixirForge/WiFiManager
1
0
Fork 0
mirror of https://github.com/alexhopeoconnor/WiFiManager.git synced 2026-10-04 02:48:13 +10:00
Code Releases Activity

Expand API and deployment documentation

Browse Source
This commit is contained in:
alex
2026-09-06 14:35:32 +10:00
parent 28c095c2d1
commit 242f60fa99
24 changed files with 1042 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files
examples/BasicPortal/README.md
+1 -1
View File
@@ -9,4 +9,4 @@ This is the smallest useful WiFiManager application. It first tries the credenti
The access-point password is only an example. Choose a unique, Wi-Fi-valid password for a real product.
See the shared [example guide](../README.md) and [getting started](../../docs/GETTING_STARTED.md).
See the shared [example guide](../README.md), [getting started](../../docs/GETTING_STARTED.md), and [provisioning lifecycle](../../docs/PROVISIONING_LIFECYCLE.md).
examples/BrandedPortal/README.md
+1 -1
View File
@@ -6,4 +6,4 @@ Flash the `esp8266` or `esp32` environment, join **Temperature Monitor**, and op
Use only trusted compiled SVG data. Keep the backing strings static for the lifetime of the firmware, then call `setPortalConfig()` before opening a portal.
See [Portal UI](../../docs/PORTAL_UI.md) and the shared [example guide](../README.md).
See [Portal UI and configuration](../../docs/PORTAL_UI.md), [architecture boundaries](../../docs/ARCHITECTURE.md), and the shared [example guide](../README.md).
examples/CustomPortalContent/CustomPortalContent.ino
+1
View File
@@ -28,6 +28,7 @@ void setup() {
portal.portalAddHomeCard(hint);
portal.setSaveParamsCallback([](WiFiManager::WiFiManagerRequestArgs) {
// A product validates and persists this value here; this demo only prints it.
Serial.print("MQTT broker selected: ");
Serial.println(brokerHost.getValue());
});
examples/CustomPortalContent/README.md
+1 -1
View File
@@ -10,4 +10,4 @@ It opens **WiFiManager Content** with password **example-pass** until it has wor
The parameter object is global because WiFiManager reads it for the lifetime of the portal. In a real application, copy the value into that application’s own validated persistent configuration inside the save callback.
See [structured portal content](../../docs/PORTAL_UI.md#structured-portal-content) and the shared [example guide](../README.md).
See [Portal content](../../docs/PORTAL_CONTENT.md), [product settings and Wi-Fi](../../docs/recipes/PRODUCT_SETTINGS_AND_WIFI.md), and the shared [example guide](../README.md).
examples/StationProfiles/README.md
+1 -1
View File
@@ -6,4 +6,4 @@ On a blank board, connect to **WiFiManager Profiles** with password **example-pa
`StoredProfiles` is intentionally simple so the ownership boundary is visible. A production application should add its own record versioning and integrity protection around the application’s complete configuration; WiFiManager only owns network-selection policy.
See [Station profiles](../../docs/STATION_PROFILES.md) and the shared [example guide](../README.md).
See [Station profiles](../../docs/STATION_PROFILES.md), [primary and fallback Wi-Fi](../../docs/recipes/PRIMARY_AND_FALLBACK_WIFI.md), and the shared [example guide](../README.md).