From 6500eee528112fa8529c38604ab7ae20bb57daaf Mon Sep 17 00:00:00 2001 From: Alex Hope-O'Connor Date: Wed, 9 Sep 2026 13:10:11 +1000 Subject: [PATCH] docs: annotate basic portal flow --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bb12b10..4021a16 100644 --- a/README.md +++ b/README.md @@ -21,11 +21,16 @@ WiFiManager wifi; void setup() { Serial.begin(115200); + + // Leave the temporary setup portal available for three minutes. wifi.setConfigPortalTimeout(180); + + // Reconnect to saved Wi-Fi, or open the setup portal when none works. wifi.autoConnect("Device Setup", "change-me"); } void loop() { + // Service portal requests and connection state without blocking firmware work. wifi.process(); } ``` @@ -38,9 +43,7 @@ WiFiManager remains a standalone provisioning library. If a device also needs persistent configuration, MQTT, Home Assistant discovery, OTA, mDNS, and an optional local web UI, see [DeviceFramework](https://github.com/alexhopeoconnor/DeviceFramework), which -integrates this portal as part of that larger device lifecycle. A -DeviceFramework sketch includes DeviceFramework and calls its `setup()` and -`loop()` APIs; do not create a second `WiFiManager` instance alongside it. +integrates this portal as part of that larger device lifecycle. ## Make it yours