ci: remove ripgrep dependency from OTA identity test

Use the DFTE async integration helper so portal HTML chunk callbacks handle
zero-length buffers and no-progress retries without terminating transfers
early on constrained hosts.

.dockerignore

@@ -0,0 +1,14 @@
+# Keep local credentials, build output, and test artifacts out of the Docker
+# build context. OTA firmware is mounted read-only by compose.ota.yaml instead
+# of copied into an image.
+.git
+.github
+.pio
+**/.pio
+node_modules
+**/node_modules
+artifacts
+test/portal-station.env
+test/.env
+platformio.local.ini*
+**/platformio.local.ini*

.github/CONTRIBUTING.md

@@ -1,12 +0,0 @@
-## Contributing PRs and ISSUES
-
-The development branch is the active branch, no features or bugs will be fixed against master ( hotfixes may be considered ).
-
-Please test against development branch before submitting issues, issues against master will be closed, 
-
-PRs against master may be kept open if provides something useful to other members.
-
-Please open issues before sumbitting PRs against development, as commits might be occuring very frequently.
-
-### Documentation is in progress
-https://github.com/tzapu/WiFiManager/issues/500

.github/ISSUE_TEMPLATE.md

@@ -1,57 +0,0 @@
-## PLEASE TRY Latest Master BRANCH before submitting bugs, in case they were already fixed. ##
-
-Issues without basic info will be ignored or closed!
-
-Please fill the info fields, it helps to get you faster support ;)
-
-if you have a stack dump decode it:
-https://github.com/esp8266/Arduino/blob/master/doc/Troubleshooting/stack_dump.rst
-
-for better debug messages:
-https://github.com/esp8266/Arduino/blob/master/doc/Troubleshooting/debugging.rst
-
------------------------------ Remove above -----------------------------
-
-### Basic Infos
-
-#### Hardware
-WiFimanager Branch/Release:  Master
-
-Esp8266/Esp32: 
-
-Hardware:			ESP-12e, esp01, esp25
-
-Core Version:      	2.4.0, staging
-
-### Description
-
-Problem description
-
-### Settings in IDE
-
-Module:  			NodeMcu, Wemos D1
-
-Additional libraries: 
-
-### Sketch
-
-```cpp
-#BEGIN
-#include <Arduino.h>
-
-void setup() {
-
-}
-
-void loop() {
-
-}
-#END
-```
-
-### Debug Messages
-
-```
-messages here
-```
-

.github/workflows/ci.yml

@@ -0,0 +1,60 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - device-framework
+    tags:
+      - "v*"
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  documentation:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: bash -n scripts/*.sh tools/check-ota-partitions.sh tools/portal-hardware tools/lib/*.sh tools/tests/*.sh
+      - run: python3 -m py_compile test/portal-harness/tools/ota_fixture_input.py
+      - run: |
+          for spec in tests/portal-harness/tests/*.js; do
+            node --check "$spec"
+          done
+      - run: timeout 15s python3 tools/tests/test-capture-serial.py
+      - run: timeout 15s bash tools/tests/test-ota-fixture-identity.sh
+      - run: ./tools/check-ota-partitions.sh
+      - run: ./scripts/check-docs.sh
+
+  compile-tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - platform: esp8266
+            examples: true
+            ota_fixtures: true
+            unity: true
+          - platform: esp32
+            examples: true
+            ota_fixtures: true
+            unity: true
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - run: python -m pip install --upgrade platformio==6.1.19
+      - run: ./scripts/test.sh compile --platform ${{ matrix.platform }}
+      - if: matrix.unity
+        run: ./scripts/test.sh unity --platform ${{ matrix.platform }}
+      - if: matrix.examples
+        run: ./scripts/test.sh examples --platform ${{ matrix.platform }}
+      - if: matrix.ota_fixtures
+        run: ./scripts/test.sh ota-fixtures --platform ${{ matrix.platform }}

.github/workflows/compile_examples.yaml

@@ -1,131 +0,0 @@
-name: Compile examples
-
-on:
-  push:
-    paths-ignore:
-      - '.github/workflows/cpp_lint.yml'
-      - '.github/workflows/compile_library.yml'
-  pull_request:
-    paths-ignore:
-      - '.github/workflows/cpp_lint.yml'
-      - '.github/workflows/compile_library.yml'
-
-jobs:
-  esp8266:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        example: 
-        - "examples/Parameters/SPIFFS/AutoConnectWithFSParametersAndCustomIP/AutoConnectWithFSParametersAndCustomIP.ino"
-        - "examples/Parameters/SPIFFS/AutoConnectWithFSParameters/AutoConnectWithFSParameters.ino"
-        - "examples/NonBlocking/OnDemandNonBlocking/OnDemandNonBlocking.ino"
-        - "examples/NonBlocking/AutoConnectNonBlockingwParams/AutoConnectNonBlockingwParams.ino"
-        - "examples/NonBlocking/AutoConnectNonBlocking/AutoConnectNonBlocking.ino"
-        - "examples/Basic/Basic.ino"
-        - "examples/Super/OnDemandConfigPortal/OnDemandConfigPortal.ino"
-        - "examples/Advanced/Advanced.ino"
-        - "examples/Old_examples/AutoConnectWithStaticIP/AutoConnectWithStaticIP.ino"
-        - "examples/Old_examples/AutoConnectWithFeedback/AutoConnectWithFeedback.ino"
-        - "examples/Old_examples/AutoConnectWithReset/AutoConnectWithReset.ino"
-        - "examples/Old_examples/AutoConnectWithTimeout/AutoConnectWithTimeout.ino"
-        - "examples/ParamsChildClass/ParamsChildClass.ino"
-        - "examples/OnDemand/OnDemandConfigPortal/OnDemandConfigPortal.ino"
-        - "examples/OnDemand/OnDemandWebPortal/OnDemandWebPortal.ino"
-     
-    steps:
-    - uses: actions/checkout@v2
-    - name: Cache pip
-      uses: actions/cache@v2
-      with:
-        path: ~/.cache/pip
-        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}-${{ github.ref }}
-        restore-keys: |
-          ${{ runner.os }}-pip-${{ github.ref }}-
-          ${{ runner.os }}-pip-
-        
-    - name: Cache PlatformIO
-      uses: actions/cache@v2
-      with:
-        path: ~/.platformio
-        key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}-${{ github.ref }}
-        restore-keys: |
-          ${{ runner.os }}-${{ github.ref }}-
-          ${{ runner.os }}-
-        
-    - name: Set up Python
-      uses: actions/setup-python@v2
-    - name: Install PlatformIO
-      run: |
-        python -m pip install --upgrade pip
-        pip install --upgrade platformio
-    - name: Install 3rd party dependencies
-      run: | 
-        pio lib -g install \
-        file://. \
-        https://github.com/bblanchon/ArduinoJson \
-        https://github.com/knolleary/pubsubclient
-        
-    - name: Run PlatformIO Examples
-      run: pio ci --board=nodemcuv2
-      env:
-        PLATFORMIO_CI_SRC: ${{ matrix.example }}
-
-  esp32:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        example:
-          - "examples/Parameters/SPIFFS/AutoConnectWithFSParametersAndCustomIP/AutoConnectWithFSParametersAndCustomIP.ino"
-          - "examples/Parameters/SPIFFS/AutoConnectWithFSParameters/AutoConnectWithFSParameters.ino"
-          - "examples/NonBlocking/OnDemandNonBlocking/OnDemandNonBlocking.ino"
-          - "examples/NonBlocking/AutoConnectNonBlockingwParams/AutoConnectNonBlockingwParams.ino"
-          - "examples/NonBlocking/AutoConnectNonBlocking/AutoConnectNonBlocking.ino"
-          - "examples/Basic/Basic.ino"
-          - "examples/Super/OnDemandConfigPortal/OnDemandConfigPortal.ino"
-          - "examples/Advanced/Advanced.ino"
-          - "examples/Old_examples/AutoConnectWithStaticIP/AutoConnectWithStaticIP.ino"
-          - "examples/Old_examples/AutoConnectWithFeedback/AutoConnectWithFeedback.ino"
-          - "examples/Old_examples/AutoConnectWithReset/AutoConnectWithReset.ino"
-          - "examples/Old_examples/AutoConnectWithTimeout/AutoConnectWithTimeout.ino"
-          - "examples/ParamsChildClass/ParamsChildClass.ino"
-          - "examples/OnDemand/OnDemandConfigPortal/OnDemandConfigPortal.ino"
-          - "examples/OnDemand/OnDemandWebPortal/OnDemandWebPortal.ino"
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Cache pip
-        uses: actions/cache@v2
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}-${{ github.ref }}
-          restore-keys: |
-            ${{ runner.os }}-pip-${{ github.ref }}-
-            ${{ runner.os }}-pip-
-      - name: Cache PlatformIO
-        uses: actions/cache@v2
-        with:
-          path: ~/.platformio
-          key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}-${{ github.ref }}
-          restore-keys: |
-            ${{ runner.os }}-${{ github.ref }}-
-            ${{ runner.os }}-
-      - name: Set up Python
-        uses: actions/setup-python@v2
-      - name: Install PlatformIO
-        run: |
-          python -m pip install --upgrade pip
-          pip install --upgrade platformio
-      - name: Install 3rd party dependencies
-        run: |
-          pio lib -g install \
-          file://. \
-          https://github.com/bblanchon/ArduinoJson \
-          https://github.com/knolleary/pubsubclient
-
-      - name: Run PlatformIO Examples
-        run: pio ci --board=esp32dev
-        env:
-          PLATFORMIO_CI_SRC: ${{ matrix.example }}
-          

.github/workflows/compile_library.yml

@@ -1,58 +0,0 @@
-name: Compile Library
-
-on:
-  push:
-    paths-ignore:
-      - '.github/workflows/cpp_lint.yml'
-      - '.github/workflows/compile_examples.yml'
-      - 'examples/**'
-  pull_request:
-    paths-ignore:
-      - '.github/workflows/cpp_lint.yml'
-      - '.github/workflows/compile_examples.yml'
-      - 'examples/**'
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        board: 
-          - "nodemcuv2"
-          - "lolin32"
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Cache pip
-      uses: actions/cache@v2
-      with:
-        path: ~/.cache/pip
-        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}-${{ matrix.board }}
-        restore-keys: |
-          ${{ runner.os }}-pip-${{ matrix.board }}-
-          ${{ runner.os }}-pip-
-    - name: Cache PlatformIO
-      uses: actions/cache@v2
-      with:
-        path: ~/.platformio
-        key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}-${{ matrix.board }}
-        restore-keys: |
-          ${{ runner.os }}-${{ matrix.board }}-
-          ${{ runner.os }}-
-    - name: Set up Python
-      uses: actions/setup-python@v2
-    - name: Install PlatformIO
-      run: |
-        python -m pip install --upgrade pip
-        pip install --upgrade platformio
-
-    - name: Create main file
-      run: |
-        echo "#include <Arduino.h>" >> main.ino
-        echo "void setup() {}" >> main.ino
-        echo "void loop() {}" >> main.ino
-
-    - name: Run PlatformIO
-      run: pio ci --board=${{ matrix.board }} .

.github/workflows/cpp_lint.yml

@@ -1,31 +0,0 @@
-name: cpplint
-
-on:
-   push:
-      paths-ignore:
-       - '.github/workflows/compile_*.yml'
-   pull_request:
-      paths-ignore:
-       - '.github/workflows/compile_*.yml'
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: cpplint
-        uses: reviewdog/action-cpplint@master
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          reporter: github-pr-check
-          flags: --linelength=100
-          target: .
-          filter: "-whitespace/tab\
-           ,-readability/braces\
-           ,-whitespace/braces\
-           ,-whitespace/comments\
-           ,-whitespace/indent\
-           ,-whitespace/newline\
-           ,-whitespace/operators\
-           ,-whitespace/parens\
-           ,-whitespace/line_length\
-           "

.github/workflows/release.yml

@@ -0,0 +1,73 @@
+name: Publish release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: read
+
+jobs:
+  documentation:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: bash -n scripts/*.sh tools/check-ota-partitions.sh tools/portal-hardware tools/lib/*.sh tools/tests/*.sh
+      - run: |
+          for spec in tests/portal-harness/tests/*.js; do
+            node --check "$spec"
+          done
+      - run: timeout 15s python3 tools/tests/test-capture-serial.py
+      - run: ./tools/check-ota-partitions.sh
+      - run: ./scripts/check-docs.sh
+
+  compile-tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - platform: esp8266
+            examples: true
+            ota_fixtures: true
+            unity: true
+          - platform: esp32
+            examples: true
+            ota_fixtures: true
+            unity: true
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - run: python -m pip install --upgrade platformio==6.1.19
+      - run: ./scripts/test.sh compile --platform ${{ matrix.platform }}
+      - if: matrix.unity
+        run: ./scripts/test.sh unity --platform ${{ matrix.platform }}
+      - if: matrix.examples
+        run: ./scripts/test.sh examples --platform ${{ matrix.platform }}
+      - if: matrix.ota_fixtures
+        run: ./scripts/test.sh ota-fixtures --platform ${{ matrix.platform }}
+
+  publish:
+    needs:
+      - documentation
+      - compile-tests
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - run: python -m pip install --upgrade platformio==6.1.19
+      - run: ./scripts/prepare-release.sh "$GITHUB_REF_NAME"
+      - run: ./scripts/release-notes.sh "$GITHUB_REF_NAME" > "$RUNNER_TEMP/release-notes.md"
+      - run: >-
+          gh release create "$GITHUB_REF_NAME"
+          --title "WiFiManager $GITHUB_REF_NAME"
+          --notes-file "$RUNNER_TEMP/release-notes.md"
+        env:
+          GH_TOKEN: ${{ github.token }}

.gitignore

@@ -1,13 +1,40 @@
-.pio
-.cache
-.pioenvs
-.piolibdeps
-.idea
-.vscode
+# PlatformIO
+.pio/
+.pioenvs/
+.piolibdeps/
+.vscode/
+.cache/
+*.pyc
+*.pyo
+*.pyd
+__pycache__/
+
+# IDE
+.idea/
+*.sublime-project
+*.sublime-workspace
+.vscode/
 !.vscode/extensions.json
+
+# PlatformIO project overrides
 /platformio_override.ini
-/build_output
+/build_output/
+
+# OS
 .DS_Store
-.gitignore
-.clang-format
-node_modules
+Thumbs.db
+
+# Build artifacts
+*.o
+*.elf
+*.hex
+*.bin
+*.log
+
+# Misc
+node_modules/
+
+# Local portal station handoff credentials and optional direct test artifacts
+/test/portal-station.env
+/tests/portal-harness/artifacts/
+/artifacts/

.travis.yml

@@ -1,42 +0,0 @@
-language: c
-sudo: false
-
-before_install:
-  - "/sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_1.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :1 -ac -screen 0 1280x1024x16"
-  - sleep 3
-  - export DISPLAY=:1.0
-  - wget http://downloads.arduino.cc/arduino-1.8.10-linux64.tar.xz
-  - tar xf arduino-1.8.10-linux64.tar.xz
-  - sudo mv arduino-1.8.10 /usr/local/share/arduino
-  - sudo ln -s /usr/local/share/arduino/arduino /usr/local/bin/arduino
-
-install:
-  - ln -s $PWD /usr/local/share/arduino/libraries/WiFiManager
-  - arduino --pref "boardsmanager.additional.urls=http://arduino.esp8266.com/stable/package_esp8266com_index.json,http://dl.espressif.com/dl/package_esp32_index.json" --save-prefs
-  - arduino --install-library "ArduinoJson:6.18.0"
-  - arduino --install-boards esp8266:esp8266
-  - arduino --pref "compiler.warning_level=all" --save-prefs
-# install esp32
-  - arduino --install-boards esp32:esp32
-
-script:
-  - "echo $PWD"
-  - "echo $HOME"
-  - "ls $PWD"
-  - source $TRAVIS_BUILD_DIR/travis/common.sh
-  - arduino --board esp8266:esp8266:generic:xtal=80,eesz=4M1M,FlashMode=qio,FlashFreq=80,dbg=Serial,lvl=CORE --save-prefs
-  - build_examples
-  - arduino --board esp32:esp32:esp32:FlashFreq=80,FlashSize=4M,DebugLevel=info --save-prefs
-# some examples fail (SPIFFS defines differ esp32 vs esp8266) so we exclude them
-  - build_examples
-#  - arduino -v --verbose-build --verify $PWD/examples/AutoConnect/AutoConnect.ino
-
-# no coverage generated, no need to run
-#
-#after_success:
-#  - bash <(curl -s https://codecov.io/bash)
-
-notifications:
-  email:
-    on_success: change
-    on_failure: change

CHANGELOG.md

@@ -0,0 +1,80 @@
+# Changelog
+
+## 3.2.5
+
+- Prevent ESP8266 portal firmware uploads from yielding in ESPAsyncWebServer's
+  SYS callback. The updater now enters asynchronous mode before its first
+  erase or write, so the real browser upload can complete and restart into
+  the new firmware image.
+- Send the successful portal OTA response before scheduling the restart, so
+  browsers can observe a completed HTTP exchange on both ESP8266 and ESP32.
+- Give ESP32's Wi-Fi radio a five-second hand-off interval before a user scan
+  retry, avoiding transient scan failures immediately after completion.
+
+## 3.2.4
+
+- Correct profile-backed Wi-Fi hand-off from the embedded web portal: the
+  station controller now owns attempts started through either portal surface,
+  preventing the legacy empty-SSID path from reporting success before a
+  station address is available.
+
+## 3.2.3
+
+- Clarify the public integration boundary, built-in browser protocol, and
+  portal presentation documentation without coupling the standalone library to
+  DeviceFramework.
+- Refresh the standalone test guidance and pin the packaged DFTE dependency to
+  the validated 1.2.1 release.
+
+## 3.2.2
+
+- Align the direct ESP8266 and ESP32 test environments with the packaged DFTE 1.2.0 dependency.
+
+## 3.2.1
+
+- Ensure externally supplied station profiles remain authoritative on ESP32 by clearing stale SDK-owned credentials before opening the portal for an empty or invalid external profile set.
+- Pin DFTE 1.2.0, the tested template-engine release used by the maintained portal.
+
+## 3.2.0
+
+- Refine the device-hosted portal with a startup Wi-Fi scan, stable loading overlays, clearer connection progress, and a resettable configuration timeout.
+- Keep a successful portal-to-station hand-off reachable until the browser acknowledges its redirect, with a bounded fallback for captive or headless clients.
+- Rename the presentation field `homeIntro` to `tagline` so portal identity and wording are clearer; update portal bootstrap contract to v3.
+- Add focused Basic Portal, Branded Portal, Custom Portal Content, and Station Profiles examples for ESP8266 and ESP32, with real-hardware README captures.
+- Strengthen release CI with documentation and clean-consumer/example compilation checks for both supported targets.
+
+## 3.1.0
+
+- Add an opt-in primary/fallback station-profile controller with bounded failover, reconnection, a durable consumer-supplied store, and profile-aware portal APIs. DeviceFramework uses this to persist verified WiFi profiles transactionally.
+- Add portable portal branding and presentation hooks, including theme-aware shell and template rendering, without requiring DeviceFramework.
+- Pin ESP32 tests to the Arduino 3-compatible pioarduino platform release and resolve DFTE 1.1.0.
+
+## 3.0.6
+
+- Correct async PlatformIO dependency owners to the registry's canonical lowercase identity, so a clean consumer builds WiFiManager and its ESP8266/ESP32 transport dependencies without duplicating them in `lib_deps`. Remove the superseded include-path bridge.
+
+## 3.0.5
+
+- Add a library-owned PlatformIO bridge for the asynchronous web/TCP include paths required when WiFiManager is nested beneath DeviceFramework.
+
+## 3.0.4
+
+- Set the package's deep PlatformIO dependency-discovery mode so WiFiManager's asynchronous web/TCP children remain available when it is consumed through DeviceFramework.
+
+## 3.0.3
+
+- Declare the ESP8266 and ESP32 async TCP libraries explicitly in the PlatformIO package manifest so clean consumers resolve the headers required by the asynchronous portal.
+
+## 3.0.2
+
+- Update the pinned DFTE dependency to the iterator-lifecycle and configuration-safe 1.0.2 release.
+
+## 3.0.1
+
+- Redact WiFi, AP, portal-form, and custom-parameter values from diagnostic logs.
+
+## 3.0.0
+
+- Establish `device-framework` as the independently maintained canonical branch.
+- Add safe default parameter construction and allocation-failure handling.
+- Pin the DFTE dependency used by PlatformIO builds.

CMakeLists.txt

@@ -1,9 +0,0 @@
-cmake_minimum_required(VERSION 3.5)
-
-idf_component_register(
-                       SRCS "WiFiManager.cpp"
-                       INCLUDE_DIRS "."
-                       PRIV_REQUIRES arduino
-)
-
-project(WiFiManager)

LICENSE

@@ -20,3 +20,12 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
+---
+
+This is a fork of tzapu/WiFiManager (https://github.com/tzapu/WiFiManager)
+Original work Copyright (c) 2015 tzapu
+
+This software has been modified and includes contributions Copyright (c) 2024
+Alex Hope-O'Connor (https://github.com/alexhopeoconnor). The original
+license and copyright notice above must be preserved in all copies as required
+by the MIT License.

README.md

@@ -1,576 +1,114 @@
-
 # WiFiManager
 
-Espressif ESPx WiFi Connection manager with fallback web configuration portal
+WiFiManager gives ESP8266 and ESP32 firmware a polished, self-hosted Wi-Fi setup experience. It reconnects to saved networks and opens a temporary captive portal when it cannot, so users can configure the device from any phone or browser without a cloud service or companion app.
 
-:warning: This Documentation is out of date, see notes below
+## See it on real hardware
 
-<a name="release"></a>
-[![Release](https://img.shields.io/github/v/release/tzapu/WiFiManager?include_prereleases)](#release)
+![A short WiFiManager portal tour showing product branding, nearby networks,
+application settings, and scan feedback.](docs/assets/readme/portal-tour.gif)
 
-[![Build CI Status](https://github.com/tzapu/WiFiManager/actions/workflows/compile_library.yml/badge.svg)](https://github.com/tzapu/WiFiManager/actions/workflows/compile_library.yml)
+WiFiManager provides a self-hosted setup portal for Wi-Fi and application
+settings without copying portal HTML into each firmware. See the detailed
+[portal UI guide](docs/PORTAL_UI.md) for supported branding and content APIs.
 
-[![Build CI Status Examples](https://github.com/tzapu/WiFiManager/actions/workflows/compile_examples.yaml/badge.svg)](https://github.com/tzapu/WiFiManager/actions/workflows/compile_examples.yaml)
+## Start with a working portal
 
-[![arduino-library-badge](https://www.ardu-badge.com/badge/WiFiManager.svg?)](https://www.ardu-badge.com/WiFiManager)
-
-[![Build with PlatformIO](https://img.shields.io/badge/PlatformIO-Library-orange?)](https://platformio.org/lib/show/567/WiFiManager/installation)
-
-[![ESP8266](https://img.shields.io/badge/ESP-8266-000000.svg?longCache=true&style=flat&colorA=CC101F)](https://www.espressif.com/en/products/socs/esp8266)
-
-[![ESP32](https://img.shields.io/badge/ESP-32-000000.svg?longCache=true&style=flat&colorA=CC101F)](https://www.espressif.com/en/products/socs/esp32)
-[![ESP32](https://img.shields.io/badge/ESP-32S2-000000.svg?longCache=true&style=flat&colorA=CC101F)](https://www.espressif.com/en/products/socs/esp32-s2)
-[![ESP32](https://img.shields.io/badge/ESP-32C3-000000.svg?longCache=true&style=flat&colorA=CC101F)](https://www.espressif.com/en/products/socs/esp32-c3)
-[![ESP32](https://img.shields.io/badge/ESP-32S3-000000.svg?longCache=true&style=flat&colorA=CC101F)](https://www.espressif.com/en/products/socs/esp32-S3)
-
-Member to Member Support / Chat
-
- [![Join the chat at https://gitter.im/tablatronix/WiFiManager](https://badges.gitter.im/tablatronix/WiFiManager.svg)](https://gitter.im/tablatronix/WiFiManager?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
- 
-[![Discord](https://img.shields.io/badge/Discord-WiFiManager-%237289da.svg?logo=discord)](https://discord.gg/nS5WGkaQH5)
-The configuration portal is of the captive variety, so on various devices it will present the configuration dialogue as soon as you connect to the created access point.
-
-Works with the [ESP8266 Arduino](https://github.com/esp8266/Arduino) and [ESP32 Arduino](https://github.com/espressif/arduino-esp32) platforms.
-
-### Known Issues
-
-* Documentation needs to be updated, see [https://github.com/tzapu/WiFiManager/issues/500](https://github.com/tzapu/WiFiManager/issues/500)
--------
-
-## Contents
- - [How it works](#how-it-works)
- - [Wishlist](#wishlist)
- - [Quick start](#quick-start)
-   - Installing
-     - [Arduino - Through Library Manager](#install-through-library-manager)
-     - [Arduino - From Github](#checkout-from-github)
-     - [PlatformIO](#install-using-platformio)
-   - [Using](#using)
- - [Documentation](#documentation)
-   - [Access Point Password](#password-protect-the-configuration-access-point)
-   - [Callbacks](#callbacks)
-   - [Configuration Portal Timeout](#configuration-portal-timeout)
-   - [On Demand Configuration](#on-demand-configuration-portal)
-   - [Custom Parameters](#custom-parameters)
-   - [Custom IP Configuration](#custom-ip-configuration)
-   - [Filter Low Quality Networks](#filter-networks)
-   - [Debug Output](#debug)
- - [Troubleshooting](#troubleshooting)
- - [Releases](#releases)
- - [Contributors](#contributions-and-thanks)
-
-
-## How It Works
-- When your ESP starts up, it sets it up in Station mode and tries to connect to a previously saved Access Point
-- if this is unsuccessful (or no previous network saved) it moves the ESP into Access Point mode and spins up a DNS and WebServer (default ip 192.168.4.1)
-- using any wifi enabled device with a browser (computer, phone, tablet) connect to the newly created Access Point
-- because of the Captive Portal and the DNS server you will either get a 'Join to network' type of popup or get any domain you try to access redirected to the configuration portal
-- choose one of the access points scanned, enter password, click save
-- ESP will try to connect. If successful, it relinquishes control back to your app. If not, reconnect to AP and reconfigure.
-- There are options to change this behavior or manually start the configportal and webportal independantly as well as run them in non blocking mode.
-
-## How It Looks
-![ESP8266 WiFi Captive Portal Homepage](http://i.imgur.com/YPvW9eql.png) ![ESP8266 WiFi Captive Portal Configuration](http://i.imgur.com/oicWJ4gl.png)
-
-## Wishlist
-- [x] remove dependency on EEPROM library
-- [x] move HTML Strings to PROGMEM
-- [x] cleanup and streamline code (although this is ongoing)
-- [x] if timeout is set, extend it when a page is fetched in AP mode
-- [x] add ability to configure more parameters than ssid/password
-- [x] maybe allow setting ip of ESP after reboot
-- [x] add to Arduino Library Manager
-- [x] add to PlatformIO
-- [ ] add multiple sets of network credentials
-- [x] allow users to customize CSS
-- [ ] rewrite documentation for simplicity, based on scenarios/goals
-
-### Development
-- [x] ESP32 support
-- [x] rely on the SDK's built in auto connect more than forcing a connect
-- [x] add non blocking mode
-- [x] easy customization of strings
-- [x] hostname support
-- [x] fix various bugs and workarounds for esp SDK issues
-- [x] additional info page items
-- [x] last status display / faiilure reason
-- [x] customizeable menu
-- [x] seperate custom params page
-- [x] ondemand webportal
-- [x] complete refactor of code to segment functions
-- [x] wiif scan icons or percentage display
-- [x] invert class for dark mode
-- [x] more template tokens
-- [x] progmem for all strings
-- [ ] new callbacks
-- [ ] new callouts / filters
-- [ ] shared web server instance
-- [x] latest esp idf/sdk support
-- [x] wm is now non persistent, will not erase or change stored esp config on esp8266
-- [x] tons of debugging output / levels
-- [ ] disable captiveportal
-- [ ] preload wiifscans, faster page loads
-- [ ] softap stability fixes when sta is not connected
-
-
-## Quick Start
-
-### Installing
-You can either install through the Arduino Library Manager or checkout the latest changes or a release from github
-
-#### Install through Library Manager
-__Currently version 0.8+ works with release 2.4.0 or newer of the [ESP8266 core for Arduino](https://github.com/esp8266/Arduino)__
- - in Arduino IDE got to Sketch/Include Library/Manage Libraries
-  ![Manage Libraries](http://i.imgur.com/9BkEBkR.png)
-
- - search for WiFiManager
-  ![WiFiManager package](http://i.imgur.com/18yIai8.png)
-
- - click Install and start [using it](#using)
-
-####  Checkout from github
-__Github version works with release 2.4.0 or newer of the [ESP8266 core for Arduino](https://github.com/esp8266/Arduino)__
-- Checkout library to your Arduino libraries folder
-
-### Using
-- Include in your sketch
 ```cpp
-#include <WiFiManager.h>          //https://github.com/tzapu/WiFiManager WiFi Configuration Magic
-```
+#include <Arduino.h>
+#include <WiFiManager.h>
 
-- Initialize library, in your setup function add, NOTEif you are using non blocking you will make sure you create this in global scope or handle appropriatly , it will not work if in setup and using non blocking mode.
-```cpp
-WiFiManager wifiManager;
-```
+WiFiManager wifi;
 
-- Also in the setup function add
-```cpp
-//first parameter is name of access point, second is the password
-wifiManager.autoConnect("AP-NAME", "AP-PASSWORD");
-```
-if you just want an unsecured access point
-```cpp
-wifiManager.autoConnect("AP-NAME");
-```
-or if you want to use and auto generated name from 'ESP' and the esp's Chip ID use
-```cpp
-wifiManager.autoConnect();
-```
+void setup() {
+    Serial.begin(115200);
 
-After you write your sketch and start the ESP, it will try to connect to WiFi. If it fails it starts in Access Point mode.
-While in AP mode, connect to it then open a browser to the gateway IP, default 192.168.4.1, configure wifi, save and it should reboot and connect.
+    // Leave the temporary setup portal available for three minutes.
+    wifi.setConfigPortalTimeout(180);
 
-Also see [examples](https://github.com/tzapu/WiFiManager/tree/master/examples).
-
-#### Install Using PlatformIO
-
-[PlatformIO](https://platformio.org/) is an emerging ecosystem for IoT development, and 
-is an alternative to using the Arduino IDE. Install `WiFiManager`
-using the platformio [library manager](https://docs.platformio.org/en/latest/librarymanager/index.html#librarymanager) in your editor, 
-or using the [PlatformIO Core CLI](https://docs.platformio.org/en/latest/core/index.html),
-or by adding it to your `platformio.ini` as shown below (recommended approach).
-
-The simplest way is to open the `platformio.ini` file at the root of your project, and `WifiManager` to the common top-level env
-`lib_deps` key like so:
-
-```
-[env]
-lib_deps =
-	WiFiManager
-```
-
-
-```
-[env]
-lib_deps =
-	https://github.com/tzapu/WiFiManager.git
-```
-
-## Documentation
-
-#### Password protect the configuration Access Point
-You can and should password protect the configuration access point.  Simply add the password as a second parameter to `autoConnect`.
-A short password seems to have unpredictable results so use one that's around 8 characters or more in length.
-The guidelines are that a wifi password must consist of 8 to 63 ASCII-encoded characters in the range of 32 to 126 (decimal)
-```cpp
-wifiManager.autoConnect("AutoConnectAP", "password")
-```
-
-#### Callbacks
-##### Enter Config mode
-Use this if you need to do something when your device enters configuration mode on failed WiFi connection attempt.
-Before `autoConnect()`
-```cpp
-wifiManager.setAPCallback(configModeCallback);
-```
-`configModeCallback` declaration and example
-```cpp
-void configModeCallback (WiFiManager *myWiFiManager) {
-  Serial.println("Entered config mode");
-  Serial.println(WiFi.softAPIP());
-
-  Serial.println(myWiFiManager->getConfigPortalSSID());
+    // Reconnect to saved Wi-Fi, or open the setup portal when none works.
+    wifi.autoConnect("Device Setup", "change-me");
 }
-```
 
-##### Save settings
-This gets called when custom parameters have been set **AND** a connection has been established. Use it to set a flag, so when all the configuration finishes, you can save the extra parameters somewhere.
-
-
-IF YOU NEED TO SAVE PARAMETERS EVEN ON WIFI FAIL OR EMPTY, you must set `setBreakAfterConfig` to true, or else saveConfigCallback will not be called.
-
-```C++
-//if this is set, it will exit after config, even if connection is unsuccessful.
-    void          setBreakAfterConfig(boolean shouldBreak);
-```
-
-See [AutoConnectWithFSParameters Example](https://github.com/tzapu/WiFiManager/tree/master/examples/Parameters/SPIFFS/AutoConnectWithFSParameters).
-```cpp
-wifiManager.setSaveConfigCallback(saveConfigCallback);
-```
-`saveConfigCallback` declaration and example
-```cpp
-//flag for saving data
-bool shouldSaveConfig = false;
-
-//callback notifying us of the need to save config
-void saveConfigCallback () {
-  Serial.println("Should save config");
-  shouldSaveConfig = true;
-}
-```
-
-#### Configuration Portal Timeout
-If you need to set a timeout so the ESP doesn't hang waiting to be configured, for instance after a power failure, you can add
-```cpp
-wifiManager.setConfigPortalTimeout(180);
-```
-which will wait 3 minutes (180 seconds). When the time passes, the autoConnect function will return, no matter the outcome.
-Check for connection and if it's still not established do whatever is needed (on some modules I restart them to retry, on others I enter deep sleep)
-
-#### On Demand Configuration Portal
-If you would rather start the configuration portal on demand rather than automatically on a failed connection attempt, then this is for you.
-
-Instead of calling `autoConnect()` which does all the connecting and failover configuration portal setup for you, you need to use `startConfigPortal()`. __Do not use BOTH.__
-
-Example usage
-```cpp
 void loop() {
-  // is configuration portal requested?
-  if ( digitalRead(TRIGGER_PIN) == LOW ) {
-    WiFiManager wifiManager;
-    wifiManager.startConfigPortal("OnDemandAP");
-    Serial.println("connected...yeey :)");
-  }
+    // Service portal requests and connection state without blocking firmware work.
+    wifi.process();
 }
 ```
-See example for a more complex version. [OnDemandConfigPortal](https://github.com/tzapu/WiFiManager/tree/master/examples/OnDemand/OnDemandConfigPortal)
 
-#### Exiting from the Configuration Portal
-Normally, once entered, the configuration portal will continue to loop until WiFi credentials have been successfully entered or a timeout is reached.
-If you'd prefer to exit without joining a WiFi network, say becuase you're going to put the ESP into AP mode, then press the "Exit" button
-on the main webpage.
-If started via `autoConnect` or `startConfigPortal` then it will return `false (portalAbortResult)`
+When saved Wi-Fi is unavailable, `autoConnect()` starts the portal asynchronously. Call `process()` from every `loop()` iteration while it may be open. Flash [Basic Portal](examples/BasicPortal/) to try this exact flow; its README gives the network name, password, portal address, and expected result after saving Wi-Fi.
+
+## Building a Home Assistant device?
+
+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.
+
+## Make it yours
 
-#### Custom Parameters
-You can use WiFiManager to collect more parameters than just SSID and password.
-This could be helpful for configuring stuff like MQTT host and port, [blynk](http://www.blynk.cc) or [emoncms](http://emoncms.org) tokens, just to name a few.
-**You are responsible for saving and loading these custom values.** The library just collects and displays the data for you as a convenience.
-Usage scenario would be:
-- load values from somewhere (EEPROM/FS) or generate some defaults
-- add the custom parameters to WiFiManager using
 ```cpp
- // id/name, placeholder/prompt, default, length
- WiFiManagerParameter custom_mqtt_server("server", "mqtt server", mqtt_server, 40);
- wifiManager.addParameter(&custom_mqtt_server);
+const char kTitle[] PROGMEM = "Set up Temperature Monitor";
+const char kBrand[] PROGMEM = "Example Devices";
+const char kAccent[] PROGMEM = "#347a45";
 
-```
-- if connection to AP fails, configuration portal starts and you can set /change the values (or use on demand configuration portal)
-- once configuration is done and connection is established save config callback() is called
-- once WiFiManager returns control to your application, read and save the new values using the `WiFiManagerParameter` object.
-```cpp
- mqtt_server = custom_mqtt_server.getValue();
-```  
-This feature is a lot more involved than all the others, so here are some examples to fully show how it is done.
-You should also take a look at adding custom HTML to your form.
+void setup() {
+    WiFiManagerPortalConfig portalUI;
 
-- Save and load custom parameters to file system in json form [AutoConnectWithFSParameters](https://github.com/tzapu/WiFiManager/tree/master/examples/Parameters/SPIFFS/AutoConnectWithFSParameters)
-- *Save and load custom parameters to EEPROM* (not done yet)
+    // Leave fields unset to keep WiFiManager's built-in portal values.
+    portalUI.title = WiFiManagerPortalText::progmem(kTitle);
+    portalUI.identityText = WiFiManagerPortalText::progmem(kBrand);
 
-#### Custom IP Configuration
-You can set a custom IP for both AP (access point, config mode) and STA (station mode, client mode, normal project state)
+    // Theme values customise the built-in styles; they do not replace the portal.
+    portalUI.theme.accent = WiFiManagerPortalText::progmem(kAccent);
+    portalUI.theme.cornerRadiusPx = 10;
 
-##### Custom Access Point IP Configuration
-This will set your captive portal to a specific IP should you need/want such a feature. Add the following snippet before `autoConnect()`
-```cpp
-//set custom ip for portal
-wifiManager.setAPStaticIPConfig(IPAddress(10,0,1,1), IPAddress(10,0,1,1), IPAddress(255,255,255,0));
+    wifi.setPortalConfig(portalUI);  // Apply before the portal starts.
+    wifi.autoConnect("Device Setup");
+}
+
+void loop() {
+    wifi.process();
+}
 ```
 
-##### Custom Station (client) Static IP Configuration
-This will make use the specified IP configuration instead of using DHCP in station mode.
-```cpp
-wifiManager.setSTAStaticIPConfig(IPAddress(192,168,0,99), IPAddress(192,168,0,1), IPAddress(255,255,255,0)); // optional DNS 4th argument
-```
-There are a couple of examples in the examples folder that show you how to set a static IP and even how to configure it through the web configuration portal.
+The [Branded Portal](examples/BrandedPortal/) example includes a static SVG, accessible identity text, and a small semantic theme. [Custom Portal Content](examples/CustomPortalContent/) shows the supported parameters, information sections, and home cards without replacing the portal shell.
 
-NOTE: You should fill DNS server if you have HTTP requests with hostnames or syncronize time (NTP). It's the same as gateway ip or a popular (Google DNS: 8.8.8.8).
+## What it provides
 
-#### Custom HTML, CSS, Javascript
-There are various ways in which you can inject custom HTML, CSS or Javascript into the configuration portal.
-The options are:
-- inject custom head element
-You can use this to any html bit to the head of the configuration portal. If you add a `<style>` element, bare in mind it overwrites the included css, not replaces.
-```cpp
-wifiManager.setCustomHeadElement("<style>html{filter: invert(100%); -webkit-filter: invert(100%);}</style>");
-```
-- inject a custom bit of html in the configuration/param form
-```cpp
-WiFiManagerParameter custom_text("<p>This is just a text paragraph</p>");
-wifiManager.addParameter(&custom_text);
-```
-- inject a custom bit of html in a configuration form element
-Just add the bit you want added as the last parameter to the custom parameter constructor.
-```cpp
-WiFiManagerParameter custom_mqtt_server("server", "mqtt server", "iot.eclipse", 40, " readonly");
-wifiManager.addParameter(&custom_mqtt_server);
+- **Captive Wi-Fi setup:** starts an access point only when saved network credentials cannot connect.
+- **Responsive portal:** one small portal for Wi-Fi, application fields, information, actions, and firmware update flow.
+- **Structured APIs:** C++ configuration and a local JSON protocol for the built-in portal.
+- **Product presentation:** title, logo, tagline, and semantic colour tokens without copying the portal HTML.
+- **Primary and fallback networks:** an opt-in two-network controller backed by an application-provided store.
+- **ESP8266 and ESP32 support:** the package resolves its asynchronous web dependencies for the selected target.
+
+## Choose a guide
+
+| Goal | Guide |
+| --- | --- |
+| Understand library/application ownership and supported boundaries | [Architecture](docs/ARCHITECTURE.md) |
+| Get a device online or recover from missing Wi-Fi | [Provisioning lifecycle](docs/PROVISIONING_LIFECYCLE.md) |
+| Brand or constrain the built-in portal | [Portal UI and configuration](docs/PORTAL_UI.md) |
+| Add and persist application settings, status, or home cards | [Portal content](docs/PORTAL_CONTENT.md) |
+| Configure primary/fallback station profiles | [Station profiles](docs/STATION_PROFILES.md) |
+| Surface setup, offline, and connection state in firmware | [Observability](docs/OBSERVABILITY.md) |
+| Configure AP, station, scan, or reconnect behaviour | [Network configuration](docs/NETWORK_CONFIGURATION.md) |
+| Look up a supported C++ method and its timing | [API reference](docs/API_REFERENCE.md) |
+| Understand the built-in portal's local JSON protocol | [Portal API](docs/PORTAL_API.md) |
+| Follow deployment-oriented integration patterns | [Recipes](docs/recipes/README.md) |
+| Build or flash a complete example | [Examples](examples/README.md) |
+| Run documentation and board-free compile checks | [Testing](docs/TESTING.md) |
+| Contribute to this fork or prepare a release | [Development](docs/DEVELOPMENT.md) |
+
+## Install
+
+```ini
+[common]
+lib_deps =
+    WiFiManager=https://github.com/alexhopeoconnor/WiFiManager.git#v3.2.5
 ```
 
-#### Theming
-You can customize certain elements of the default template with some builtin classes
-```CPP
-wifiManager.setClass("invert"); // dark theme
-wifiManager.setScanDispPerc(true); // display percentages instead of graphs for RSSI
-```
-There are additional classes in the css you can use in your custom html , see the example template.
-
-#### Filter Networks
-You can filter networks based on signal quality and show/hide duplicate networks.
-
-- If you would like to filter low signal quality networks you can tell WiFiManager to not show networks below an arbitrary quality %;
-```cpp
-wifiManager.setMinimumSignalQuality(10);
-```
-will not show networks under 10% signal quality. If you omit the parameter it defaults to 8%;
-
-- You can also remove or show duplicate networks (default is remove).
-Use this function to show (or hide) all networks.
-```cpp
-wifiManager.setRemoveDuplicateAPs(false);
-```
-
-#### Debug
-Debug is enabled by default on `Serial` in non-stable releases. To disable add before autoConnect/startConfigPortal
-```cpp
-wifiManager.setDebugOutput(false);
-```
-
-You can pass in a custom stream via constructor 
-```CPP
-WiFiManager wifiManager(Serial1);
-```
-
-You can customize the debug level by changing `_debugLevel` in source
-options are:
-* DEBUG_ERROR
-* DEBUG_NOTIFY
-* DEBUG_VERBOSE
-* DEBUG_DEV
-* DEBUG_MAX
-
-## Troubleshooting
-If you get compilation errors, more often than not, you may need to install a newer version of the ESP8266 core for Arduino.
-
-Changes added on 0.8 should make the latest trunk work without compilation errors. Tested down to ESP8266 core 2.0.0. **Please update to version 0.8**
-
-I am trying to keep releases working with release versions of the core, so they can be installed through boards manager, but if you checkout the latest version directly from github, sometimes, the library will only work if you update the ESP8266 core to the latest version because I am using some newly added function.
-
-If you connect to the created configuration Access Point but the configuration portal does not show up, just open a browser and type in the IP of the web portal, by default `192.168.4.1`.
-
-If trying to connect ends up in an endless loop, try to add `setConnectTimeout(60)` before `autoConnect();`. The parameter is timeout to try connecting in seconds.
-
-I get stuck in ap mode when the power goes out or modem resets, try a setConfigPortalTimeout(seconds). This will cause the configportal to close after no activity, and you can reboot or attempt reconnection in your code.
-
-## Releases
-### 1.0.1
-
-### Development Overview
-
-#### Added Public Methods
-`setConfigPortalBlocking`
-
-`setShowStaticFields`
-
-`setCaptivePortalEnable`
-
-`setRestorePersistent`
-
-`setCaptivePortalClientCheck`
-
-`setWebPortalClientCheck`
-
-`startWebPortal`
-
-`stopWebPortal`
-
-`process`
-
-`disconnect`
-
-`erase`
-
-` debugSoftAPConfig`
-
-` debugPlatformInfo`
-
-`setScanDispPerc`
-
-`setHostname`
-
-`setMenu(menu_page_t[])`
-
-`setWiFiAutoReconnect`
-
-` setSTAStaticIPConfig(..,dns)`
-
-`setShowDnsFields`
-
-`getLastConxResult`
-
-`getWLStatusString`
-
-`getModeString`
-
-`getWiFiIsSaved`
-
-`setShowInfoErase`
-
-`setEnableConfigPortal`
-
-`setCountry`
-
-`setClass`
-
-`htmleEtities`
-
-
-#### WiFiManagerParameter
-`WiFiManagerParameter(id,label)`
-
-`WiFiManagerParameter.setValue(value,length)`
-
-`getParameters`
-
-`getParametersCount`
-
-
-#### Constructors
-`WiFiManager(Stream& consolePort)`
-
-#### define flags
-❗️  **Defines cannot be set in user sketches**
-`#define WM_MDNS       // use MDNS`
-
-`#define WM_FIXERASECONFIG // use erase flash fix, esp8266 2.4.0`
-
-`#define WM_ERASE_NVS // esp32 erase(true) will erase NVS`
-
-`#include <rom/rtc.h> // esp32 info page will show last reset reasons if this file is included`
-
-#### Changes Overview
-- ESP32 support ( fairly stable )
-- complete refactor of strings `strings_en.h`
-- adds new tokens for wifiscan, and some classes (left , invert icons, MSG color)
-- adds status callout panel default, primary, special colors
--  adds tons of info on info page, and erase capability
-- adds signal icons, replaces percentage ( has hover titles )
-- adds labels to all inputs (replaces placeholders)
-- all html ( and eventually all strings except debug) moved to `strings_en.h`
-- added additional debugging, compressed debug lines, debuglevels
-- persistent disabled, and restored via de/con-stuctor (uses `setRestorePersistent`)
-- should retain all user modes including AP, should not overwrite or persist user modes or configs,even STA (`storeSTAmode`) (BUGGY)
-- ⚠️ return values may have changed depending on portal abort, or timeout ( `portalTimeoutResult`,`portalAbortResult`)
-- params memory is auto allocated by increment of `WIFI_MANAGER_MAX_PARAMS(5)` when exceeded, user no longer needs to specify this at all.
-- addparameter now returns bool, and it returns false if param ID is not alphanum [0-9,A-Z,a-z,_]
-- param field ids allow {I} token to use param_n instead of string in case someones wants to change this due to i18n or character issues
-- provides `#DEFINE FIXERASECONFIG` to help deal with https://github.com/esp8266/Arduino/pull/3635
-- failure reason reporting on portal
-- set esp8266 sta hostname, esp32 sta+ap hostname ( DHCP client id)
-- pass in debug stream in constructor WiFiManager(Stream& consolePort)
-- you can force ip fields off with showxfields(false) if you set _disableIpFields=true
-- param menu/page (setup) added to separate params from wifi page, handled automatically by setMenu
-- set custom root menu
-- disable configportal on autoconnect
-- wm parameters init is now protected, allowing child classes, example included
-- wifiscans are precached and async for faster page loads, refresh forces rescan
-- adds esp32 gettemperature ( currently commented out, useful for relative measurement only )
-
-#### 0.12
-- removed 204 header response
-- fixed incompatibility with other libs using isnan and other std:: functions without namespace
-
-##### 0.11
-- a lot more reliable reconnecting to networks
-- custom html in custom parameters (for read only params)
-- custom html in custom parameter form (like labels)
-- custom head element (like custom css)
-- sort networks based on signal quality
-- remove duplicate networks
-
-##### 0.10
-- some css changes
-- bug fixes and speed improvements
-- added an alternative to waitForConnectResult() for debugging
-- changed `setTimeout(seconds)` to `setConfigPortalTimeout(seconds)`
-
-### Contributions and thanks
-The support and help I got from the community has been nothing short of phenomenal. I can't thank you guys enough. This is my first real attept in developing open source stuff and I must say, now I understand why people are so dedicated to it, it is because of all the wonderful people involved.
-
-__THANK YOU__
-
-The esp8266 and esp32 arduino and idf maintainers!
-
-[Shawn A aka tablatronix](https://github.com/tablatronix)
-
-[liebman](https://github.com/liebman)
-
-[Evgeny Dontsov](https://github.com/dontsovcmc)
-
-[Chris Marrin](https://github.com/cmarrin)
-
-[bbx10](https://github.com/bbx10)
-
-[kentaylor](https://github.com/kentaylor)
-
-[Maximiliano Duarte](https://github.com/domonetic)
-
-[alltheblinkythings](https://github.com/alltheblinkythings)
-
-[Niklas Wall](https://github.com/niklaswall)
-
-[Jakub Piasecki](https://github.com/zaporylie)
-
-[Peter Allan](https://github.com/alwynallan)
-
-[John Little](https://github.com/j0hnlittle)
-
-[markaswift](https://github.com/markaswift)
-
-[franklinvv](https://github.com/franklinvv)
-
-[Alberto Ricci Bitti](https://github.com/riccibitti)
-
-[SebiPanther](https://github.com/SebiPanther)
-
-[jonathanendersby](https://github.com/jonathanendersby)
-
-[walthercarsten](https://github.com/walthercarsten)
-
-And countless others
-
-#### Inspiration
- * http://www.esp8266.com/viewtopic.php?f=29&t=2520
- * https://github.com/chriscook8/esp-arduino-apboot
- * https://github.com/esp8266/Arduino/tree/master/libraries/DNSServer/examples/CaptivePortalAdvanced
- * Built by AlexT https://github.com/tzapu
+The suffix after `#` is a Git ref. PlatformIO clones the repository and checks out that release tag; GitHub Release assets are unrelated. Arduino IDE users can install this repository as a library checkout.
 
+See the [documentation index](docs/README.md), [examples](examples/README.md), [release history](CHANGELOG.md), and [licence](LICENSE).

WiFiManager.h

@@ -1,862 +0,0 @@
-/**
- * WiFiManager.h
- * 
- * WiFiManager, a library for the ESP8266/Arduino platform
- * for configuration of WiFi credentials using a Captive Portal
- * 
- * @author Creator tzapu
- * @author tablatronix
- * @version 0.0.0
- * @license MIT
- */
-
-
-#ifndef WiFiManager_h
-#define WiFiManager_h
-
-#if defined(ESP8266) || defined(ESP32)
-
-#ifdef ESP8266
-#include <core_version.h>
-#endif
-
-#include <vector>
-
-// #define WM_MDNS            // includes MDNS, also set MDNS with sethostname
-// #define WM_FIXERASECONFIG  // use erase flash fix
-// #define WM_ERASE_NVS       // esp32 erase(true) will erase NVS 
-// #define WM_RTC             // esp32 info page will include reset reasons
-
-// #define WM_JSTEST                      // build flag for enabling js xhr tests
-// #define WIFI_MANAGER_OVERRIDE_STRINGS // build flag for using own strings include
-
-#ifdef ARDUINO_ESP8266_RELEASE_2_3_0
-#warning "ARDUINO_ESP8266_RELEASE_2_3_0, some WM features disabled" 
-// @todo check failing on platform = espressif8266@1.7.3
-#define WM_NOASYNC         // esp8266 no async scan wifi
-#define WM_NOCOUNTRY       // esp8266 no country
-#define WM_NOAUTH          // no httpauth
-#define WM_NOSOFTAPSSID    // no softapssid() @todo shim
-#endif
-
-// #ifdef CONFIG_IDF_TARGET_ESP32S2
-// #warning ESP32S2
-// #endif
-
-// #ifdef CONFIG_IDF_TARGET_ESP32C3
-// #warning ESP32C3
-// #endif
-
-// #ifdef CONFIG_IDF_TARGET_ESP32S3
-// #warning ESP32S3
-// #endif
-
-// #if defined(ARDUINO_ESP32S3_DEV) || defined(CONFIG_IDF_TARGET_ESP32S3)
-// #warning "WM_NOTEMP"
-// #define WM_NOTEMP // disabled temp sensor, have to determine which chip we are on
-// #endif
-
-// #include "soc/efuse_reg.h" // include to add efuse chip rev to info, getChipRevision() is almost always the same though, so not sure why it matters.
-
-// #define esp32autoreconnect    // implement esp32 autoreconnect event listener kludge, @DEPRECATED
-// autoreconnect is WORKING https://github.com/espressif/arduino-esp32/issues/653#issuecomment-405604766
-
-#define WM_WEBSERVERSHIM      // use webserver shim lib
-
-#define WM_G(string_literal)  (String(FPSTR(string_literal)).c_str())
-
-#ifdef ESP8266
-
-    extern "C" {
-      #include "user_interface.h"
-    }
-    #include <ESP8266WiFi.h>
-    #include <ESP8266WebServer.h>
-
-    #ifdef WM_MDNS
-        #include <ESP8266mDNS.h>
-    #endif
-
-    #define WIFI_getChipId() ESP.getChipId() 
-    #define WM_WIFIOPEN   ENC_TYPE_NONE
-
-#elif defined(ESP32)
-
-    #include <WiFi.h>
-    #include <esp_wifi.h>  
-    #include <Update.h>
-    
-    #define WIFI_getChipId() (uint32_t)ESP.getEfuseMac()
-    #define WM_WIFIOPEN   WIFI_AUTH_OPEN
-
-    #ifndef WEBSERVER_H
-        #ifdef WM_WEBSERVERSHIM
-            #include <WebServer.h>
-        #else
-            #include <ESP8266WebServer.h>
-            // Forthcoming official ? probably never happening
-            // https://github.com/esp8266/ESPWebServer
-        #endif
-    #endif
-
-    #ifdef WM_ERASE_NVS
-       #include <nvs.h>
-       #include <nvs_flash.h>
-    #endif
-
-    #ifdef WM_MDNS
-        #include <ESPmDNS.h>
-    #endif
-
-    #ifdef WM_RTC
-        #ifdef ESP_IDF_VERSION_MAJOR // IDF 4+
-        #if CONFIG_IDF_TARGET_ESP32 // ESP32/PICO-D4
-        #include "esp32/rom/rtc.h"
-        #elif CONFIG_IDF_TARGET_ESP32S2
-        #include "esp32s2/rom/rtc.h"
-        #elif CONFIG_IDF_TARGET_ESP32C3
-        #include "esp32c3/rom/rtc.h"
-        #elif CONFIG_IDF_TARGET_ESP32S3
-        #include "esp32s3/rom/rtc.h"
-        #else
-        #error Target CONFIG_IDF_TARGET is not supported
-        #endif
-        #else // ESP32 Before IDF 4.0
-        #include "rom/rtc.h"
-        #endif
-    #endif
-
-#else
-#endif
-
-#include <DNSServer.h>
-#include <memory>
-
-
-// Include wm strings vars
-// Pass in strings env override via WM_STRINGS_FILE
-#ifndef WM_STRINGS_FILE
-#define WM_STRINGS_FILE "wm_strings_en.h" // this includes constants as dependency
-#endif
-#include WM_STRINGS_FILE
-
-// prep string concat vars
-#define WM_STRING2(x) #x
-#define WM_STRING(x) WM_STRING2(x)    
-
-// #include <esp_idf_version.h>
-#ifdef ESP_IDF_VERSION
-    // #pragma message "ESP_IDF_VERSION_MAJOR = " WM_STRING(ESP_IDF_VERSION_MAJOR)
-    // #pragma message "ESP_IDF_VERSION_MINOR = " WM_STRING(ESP_IDF_VERSION_MINOR)
-    // #pragma message "ESP_IDF_VERSION_PATCH = " WM_STRING(ESP_IDF_VERSION_PATCH)
-    #define VER_IDF_STR WM_STRING(ESP_IDF_VERSION_MAJOR)  "."  WM_STRING(ESP_IDF_VERSION_MINOR)  "."  WM_STRING(ESP_IDF_VERSION_PATCH)
-#else 
-    #define VER_IDF_STR "Unknown"
-#endif
-
-#ifdef Arduino_h
-    #ifdef ESP32
-    // #include "esp_arduino_version.h" // esp32 arduino > 2.x
-    #endif
-    // esp_get_idf_version
-    #ifdef ESP_ARDUINO_VERSION
-        // #pragma message "ESP_ARDUINO_VERSION_MAJOR = " WM_STRING(ESP_ARDUINO_VERSION_MAJOR)
-        // #pragma message "ESP_ARDUINO_VERSION_MINOR = " WM_STRING(ESP_ARDUINO_VERSION_MINOR)
-        // #pragma message "ESP_ARDUINO_VERSION_PATCH = " WM_STRING(ESP_ARDUINO_VERSION_PATCH)
-        #ifdef ESP_ARDUINO_VERSION_MAJOR
-        #define VER_ARDUINO_STR WM_STRING(ESP_ARDUINO_VERSION_MAJOR)  "."  WM_STRING(ESP_ARDUINO_VERSION_MINOR)  "."  WM_STRING(ESP_ARDUINO_VERSION_PATCH)
-        #else
-        #define VER_ARDUINO_STR "Unknown"
-        #endif
-    #else
-        #include <core_version.h>
-        // #pragma message "ESP_ARDUINO_VERSION_GIT  = " WM_STRING(ARDUINO_ESP32_GIT_VER)//  0x46d5afb1
-        // #pragma message "ESP_ARDUINO_VERSION_DESC = " WM_STRING(ARDUINO_ESP32_GIT_DESC) //  1.0.6
-        // #pragma message "ESP_ARDUINO_VERSION_REL  = " WM_STRING(ARDUINO_ESP32_RELEASE) //"1_0_6"
-        #ifdef ESP_ARDUINO_VERSION_MAJOR
-        #define VER_ARDUINO_STR WM_STRING(ESP_ARDUINO_VERSION_MAJOR)  "."  WM_STRING(ESP_ARDUINO_VERSION_MINOR)  "."  WM_STRING(ESP_ARDUINO_VERSION_PATCH)
-        #else
-        #define VER_ARDUINO_STR "Unknown"
-        #endif
-    #endif
-#else 
-#define VER_ARDUINO_STR "Unknown"
-#endif
-
-// #pragma message "VER_IDF_STR = " WM_STRING(VER_IDF_STR)
-// #pragma message "VER_ARDUINO_STR = " WM_STRING(VER_ARDUINO_STR)
-
-#ifndef WIFI_MANAGER_MAX_PARAMS
-    #define WIFI_MANAGER_MAX_PARAMS 5 // params will autoincrement and realloc by this amount when max is reached
-#endif
-
-#define WFM_LABEL_BEFORE 1
-#define WFM_LABEL_AFTER 2
-#define WFM_NO_LABEL 0
-#define WFM_LABEL_DEFAULT 1
-
-class WiFiManagerParameter {
-  public:
-    /** 
-        Create custom parameters that can be added to the WiFiManager setup web page
-        @id is used for HTTP queries and must not contain spaces nor other special characters
-    */
-    WiFiManagerParameter();
-    WiFiManagerParameter(const char *custom);
-    WiFiManagerParameter(const char *id, const char *label);
-    WiFiManagerParameter(const char *id, const char *label, const char *defaultValue, int length);
-    WiFiManagerParameter(const char *id, const char *label, const char *defaultValue, int length, const char *custom);
-    WiFiManagerParameter(const char *id, const char *label, const char *defaultValue, int length, const char *custom, int labelPlacement);
-    ~WiFiManagerParameter();
-    // WiFiManagerParameter& operator=(const WiFiManagerParameter& rhs);
-
-    const char *getID() const;
-    const char *getValue() const;
-    const char *getLabel() const;
-    const char *getPlaceholder() const; // @deprecated, use getLabel
-    int         getValueLength() const;
-    int         getLabelPlacement() const;
-    virtual const char *getCustomHTML() const;
-    void        setValue(const char *defaultValue, int length);
-
-  protected:
-    void init(const char *id, const char *label, const char *defaultValue, int length, const char *custom, int labelPlacement);
-
-    WiFiManagerParameter& operator=(const WiFiManagerParameter&);
-    const char *_id;
-    const char *_label;
-    char       *_value;
-    int         _length;
-    int         _labelPlacement;
-  
-    const char *_customHTML;
-    friend class WiFiManager;
-};
-
-
-    // debugging
-    typedef enum {
-        WM_DEBUG_SILENT    = 0, // debug OFF but still compiled for runtime
-        WM_DEBUG_ERROR     = 1, // error only
-        WM_DEBUG_NOTIFY    = 2, // default stable,INFO
-        WM_DEBUG_VERBOSE   = 3, // move verbose info
-        WM_DEBUG_DEV       = 4, // development useful debugging info
-        WM_DEBUG_MAX       = 5  // MAX extra dev auditing, var dumps etc (MAX+1 will print timing,mem and frag info)
-    } wm_debuglevel_t;
-
-class WiFiManager
-{
-  public:
-    WiFiManager(Print& consolePort);
-    WiFiManager();
-    ~WiFiManager();
-    void WiFiManagerInit();
-
-    // auto connect to saved wifi, or custom, and start config portal on failures
-    boolean       autoConnect();
-    boolean       autoConnect(char const *apName, char const *apPassword = NULL);
-
-    //manually start the config portal, autoconnect does this automatically on connect failure
-    boolean       startConfigPortal(); // auto generates apname
-    boolean       startConfigPortal(char const *apName, char const *apPassword = NULL);
-
-    //manually stop the config portal if started manually, stop immediatly if non blocking, flag abort if blocking
-    bool          stopConfigPortal();
-    
-    //manually start the web portal, autoconnect does this automatically on connect failure    
-    void          startWebPortal();
-
-    //manually stop the web portal if started manually
-    void          stopWebPortal();
-
-    // Run webserver processing, if setConfigPortalBlocking(false)
-    boolean       process();
-
-    // get the AP name of the config portal, so it can be used in the callback
-    String        getConfigPortalSSID();
-    int           getRSSIasQuality(int RSSI);
-
-    // erase wifi credentials
-    void          resetSettings();
-
-    // reboot esp
-    void          reboot();
-
-    // disconnect wifi, without persistent saving or erasing
-    bool          disconnect();
-
-    // erase esp
-    bool          erase();
-    bool          erase(bool opt);
-
-    //adds a custom parameter, returns false on failure
-    bool          addParameter(WiFiManagerParameter *p);
-
-    //returns the list of Parameters
-    WiFiManagerParameter** getParameters();
-
-    // returns the Parameters Count
-    int           getParametersCount();
-
-    // SET CALLBACKS
-
-    //called after AP mode and config portal has started
-    void          setAPCallback( std::function<void(WiFiManager*)> func );
-
-    //called after webserver has started
-    void          setWebServerCallback( std::function<void()> func );
-
-    //called when settings reset have been triggered
-    void          setConfigResetCallback( std::function<void()> func );
-
-    //called when wifi settings have been changed and connection was successful ( or setBreakAfterConfig(true) )
-    void          setSaveConfigCallback( std::function<void()> func );
-
-    //called when saving params-in-wifi or params before anything else happens (eg wifi)
-    void          setPreSaveConfigCallback( std::function<void()> func );
-
-    //called when saving params before anything else happens
-    void          setPreSaveParamsCallback( std::function<void()> func );
-
-    //called when saving either params-in-wifi or params page
-    void          setSaveParamsCallback( std::function<void()> func );
-
-    //called just before doing OTA update
-    void          setPreOtaUpdateCallback( std::function<void()> func );
-
-    //called when config portal is timeout
-    void          setConfigPortalTimeoutCallback( std::function<void()> func );
-
-    //sets timeout before AP,webserver loop ends and exits even if there has been no setup.
-    //useful for devices that failed to connect at some point and got stuck in a webserver loop
-    //in seconds setConfigPortalTimeout is a new name for setTimeout, ! not used if setConfigPortalBlocking
-    void          setConfigPortalTimeout(unsigned long seconds);
-    void          setTimeout(unsigned long seconds); // @deprecated, alias
-
-    //sets timeout for which to attempt connecting, useful if you get a lot of failed connects
-    void          setConnectTimeout(unsigned long seconds);
-
-    // sets number of retries for autoconnect, force retry after wait failure exit
-    void          setConnectRetries(uint8_t numRetries); // default 1
-    
-    //sets timeout for which to attempt connecting on saves, useful if there are bugs in esp waitforconnectloop
-    void          setSaveConnectTimeout(unsigned long seconds);
-    
-    // lets you disable automatically connecting after save from webportal
-    void          setSaveConnect(bool connect = true);
-    
-    // toggle debug output
-    void          setDebugOutput(boolean debug);
-    void          setDebugOutput(boolean debug, String prefix); // log line prefix, default "*wm:"
-    void          setDebugOutput(boolean debug, wm_debuglevel_t level ); // log line prefix, default "*wm:"
-
-    //set min quality percentage to include in scan, defaults to 8% if not specified
-    void          setMinimumSignalQuality(int quality = 8);
-    
-    //sets a custom ip /gateway /subnet configuration
-    void          setAPStaticIPConfig(IPAddress ip, IPAddress gw, IPAddress sn);
-    
-    //sets config for a static IP
-    void          setSTAStaticIPConfig(IPAddress ip, IPAddress gw, IPAddress sn);
-    
-    //sets config for a static IP with DNS
-    void          setSTAStaticIPConfig(IPAddress ip, IPAddress gw, IPAddress sn, IPAddress dns);
-    
-    //if this is set, it will exit after config, even if connection is unsuccessful.
-    void          setBreakAfterConfig(boolean shouldBreak);
-    
-    // if this is set, portal will be blocking and wait until save or exit, 
-    // is false user must manually `process()` to handle config portal,
-    // setConfigPortalTimeout is ignored in this mode, user is responsible for closing configportal
-    void          setConfigPortalBlocking(boolean shouldBlock);
-    
-    //add custom html at inside <head> for all pages
-    void          setCustomHeadElement(const char* html);
-
-    //add custom html at start of <body> for all pages
-    void          setCustomBodyHeader(const char* html);
-
-    //add custom html at end of <body> for all pages
-    void          setCustomBodyFooter(const char* html);
-
-    //if this is set, customise style
-    void          setCustomMenuHTML(const char* html);
-
-    //if this is true, remove duplicated Access Points - defaut true
-    void          setRemoveDuplicateAPs(boolean removeDuplicates);
-    
-    //setter for ESP wifi.persistent so we can remember it and restore user preference, as WIFi._persistent is protected
-    void          setRestorePersistent(boolean persistent);
-    
-    //if true, always show static net inputs, IP, subnet, gateway, else only show if set via setSTAStaticIPConfig
-    void          setShowStaticFields(boolean alwaysShow);
-    
-    //if true, always show static dns, esle only show if set via setSTAStaticIPConfig
-    void          setShowDnsFields(boolean alwaysShow);
-    
-    // toggle showing the saved wifi password in wifi form, could be a security issue.
-    void          setShowPassword(boolean show);
-    
-    //if false, disable captive portal redirection
-    void          setCaptivePortalEnable(boolean enabled);
-    
-    //if false, timeout captive portal even if a STA client connected to softAP (false), suggest disabling if captiveportal is open
-    void          setAPClientCheck(boolean enabled);
-    
-    //if true, reset timeout when webclient connects (true), suggest disabling if captiveportal is open    
-    void          setWebPortalClientCheck(boolean enabled);
-    
-    // if true, enable autoreconnecting
-    void          setWiFiAutoReconnect(boolean enabled);
-    
-    // if true, wifiscan will show percentage instead of quality icons, until we have better templating
-    void          setScanDispPerc(boolean enabled);
-    
-    // if true (default) then start the config portal from autoConnect if connection failed
-    void          setEnableConfigPortal(boolean enable);
-
-    // if true (default) then stop the config portal from autoConnect when wifi is saved
-    void          setDisableConfigPortal(boolean enable);
-
-    // set a custom hostname, sets sta and ap dhcp client id for esp32, and sta for esp8266
-    bool          setHostname(const char * hostname);
-    bool          setHostname(String hostname);
-
-    // show erase wifi onfig button on info page, true
-    void          setShowInfoErase(boolean enabled);
-
-    // show OTA upload button on info page
-    void          setShowInfoUpdate(boolean enabled);
-
-    // set ap channel
-    void          setWiFiAPChannel(int32_t channel);
-    
-    // set ap hidden
-    void          setWiFiAPHidden(bool hidden); // default false
-    
-    // clean connect, always disconnect before connecting
-    void          setCleanConnect(bool enable); // default false
-
-    // set custom menu items and order, vector or arr
-    // see _menutokens for ids
-    void          setMenu(std::vector<const char*>& menu);
-    void          setMenu(const char* menu[], uint8_t size);
-    
-    // set the webapp title, default WiFiManager
-    void          setTitle(String title);
-
-    // add params to its own menu page and remove from wifi, NOT TO BE COMBINED WITH setMenu!
-    void          setParamsPage(bool enable);
-
-    // get last connection result, includes autoconnect and wifisave
-    uint8_t       getLastConxResult();
-    
-    // get a status as string
-    String        getWLStatusString(uint8_t status);    
-    String        getWLStatusString();    
-
-    // get wifi mode as string
-    String        getModeString(uint8_t mode);
-
-    // check if the module has a saved ap to connect to
-    bool          getWiFiIsSaved();
-
-    // helper to get saved password, if persistent get stored, else get current if connected    
-    String        getWiFiPass(bool persistent = true);
-
-    // helper to get saved ssid, if persistent get stored, else get current if connected
-    String        getWiFiSSID(bool persistent = true);
-
-    // debug output the softap config
-    void          debugSoftAPConfig();
-
-    // debug output platform info and versioning
-    void          debugPlatformInfo();
-
-    // helper for html
-    String        htmlEntities(String str, bool whitespace = false);
-    
-    // set the country code for wifi settings, CN
-    void          setCountry(String cc);
-
-    // set body class (invert), may be used for hacking in alt classes
-    void          setClass(String str);
-
-    // set dark mode via invert class
-    void          setDarkMode(bool enable);
-
-    // get default ap esp uses , esp_chipid etc
-    String        getDefaultAPName();
-    
-    // set port of webserver, 80
-    void          setHttpPort(uint16_t port);
-
-    // check if config portal is active (true)
-    bool          getConfigPortalActive();
-    
-    // check if web portal is active (true)
-    bool          getWebPortalActive();
-
-    // to preload autoconnect for test fixtures or other uses that skip esp sta config
-    bool          preloadWiFi(String ssid, String pass);
-
-    // get hostname helper
-    String        getWiFiHostname();
-
-
-    std::unique_ptr<DNSServer>        dnsServer;
-
-    #if defined(ESP32) && defined(WM_WEBSERVERSHIM)
-        using WM_WebServer = WebServer;
-    #else
-        using WM_WebServer = ESP8266WebServer;
-    #endif
-    
-    std::unique_ptr<WM_WebServer> server;
-
-  protected:
-    // vars
-    std::vector<uint8_t> _menuIds;
-    std::vector<const char *> _menuIdsParams  = {"wifi","param","info","exit"};
-    std::vector<const char *> _menuIdsUpdate  = {"wifi","param","info","update","exit"};
-    std::vector<const char *> _menuIdsDefault = {"wifi","info","exit","sep","update"};
-
-    // ip configs @todo struct ?
-    IPAddress     _ap_static_ip;
-    IPAddress     _ap_static_gw;
-    IPAddress     _ap_static_sn;
-    IPAddress     _sta_static_ip;
-    IPAddress     _sta_static_gw;
-    IPAddress     _sta_static_sn;
-    IPAddress     _sta_static_dns;
-
-    unsigned long _configPortalStart      = 0; // ms config portal start time (updated for timeouts)
-    unsigned long _webPortalAccessed      = 0; // ms last web access time
-    uint8_t       _lastconxresult         = WL_IDLE_STATUS; // store last result when doing connect operations
-    int           _numNetworks            = 0; // init index for numnetworks wifiscans
-    unsigned long _lastscan               = 0; // ms for timing wifi scans
-    unsigned long _startscan              = 0; // ms for timing wifi scans
-    unsigned long _startconn              = 0; // ms for timing wifi connects
-
-    // defaults
-    const uint8_t  DNS_PORT               = 53;
-    String        _apName                 = "no-net";
-    String        _apPassword             = "";
-    String        _ssid                   = ""; // var temp ssid
-    String        _pass                   = ""; // var temp psk
-    String        _defaultssid            = ""; // preload ssid
-    String        _defaultpass            = ""; // preload pass
-
-    // options flags
-    unsigned long _configPortalTimeout    = 0; // ms close config portal loop if set (depending on  _cp/webClientCheck options)
-    unsigned long _connectTimeout         = 0; // ms stop trying to connect to ap if set
-    unsigned long _saveTimeout            = 0; // ms stop trying to connect to ap on saves, in case bugs in esp waitforconnectresult
-    
-    WiFiMode_t    _usermode               = WIFI_STA; // Default user mode
-    String        _wifissidprefix         = FPSTR(S_ssidpre); // auto apname prefix prefix+chipid
-    int           _cpclosedelay           = 2000; // delay before wifisave, prevents captive portal from closing to fast.
-    bool          _cleanConnect           = false; // disconnect before connect in connectwifi, increases stability on connects
-    bool          _connectonsave          = true; // connect to wifi when saving creds
-    bool          _disableSTA             = false; // disable sta when starting ap, always
-    bool          _disableSTAConn         = true;  // disable sta when starting ap, if sta is not connected ( stability )
-    bool          _channelSync            = false; // use same wifi sta channel when starting ap
-    int32_t       _apChannel              = 0; // default channel to use for ap, 0 for auto
-    bool          _apHidden               = false; // store softap hidden value
-    uint16_t      _httpPort               = 80; // port for webserver
-    // uint8_t       _retryCount             = 0; // counter for retries, probably not needed if synchronous
-    uint8_t       _connectRetries         = 1; // number of sta connect retries, force reconnect, wait loop (connectimeout) does not always work and first disconnect bails
-    bool          _aggresiveReconn        = false; // use an agrressive reconnect strategy, WILL delay conxs
-                                                   // on some conn failure modes will add delays and many retries to work around esp and ap bugs, ie, anti de-auth protections
-                                                   // https://github.com/tzapu/WiFiManager/issues/1067
-    bool          _allowExit              = true; // allow exit in nonblocking, else user exit/abort calls will be ignored including cptimeout
-
-    #ifdef ESP32
-    wifi_event_id_t wm_event_id           = 0;
-    static uint8_t _lastconxresulttmp; // tmp var for esp32 callback
-    #endif
-
-    #ifndef WL_STATION_WRONG_PASSWORD
-    uint8_t WL_STATION_WRONG_PASSWORD     = 7; // @kludge define a WL status for wrong password
-    #endif
-
-    // parameter options
-    int           _minimumQuality         = -1;    // filter wifiscan ap by this rssi
-    int           _staShowStaticFields    = 0;     // ternary 1=always show static ip fields, 0=only if set, -1=never(cannot change ips via web!)
-    int           _staShowDns             = 0;     // ternary 1=always show dns, 0=only if set, -1=never(cannot change dns via web!)
-    boolean       _removeDuplicateAPs     = true;  // remove dup aps from wifiscan
-    boolean       _showPassword           = false; // show or hide saved password on wifi form, might be a security issue!
-    boolean       _shouldBreakAfterConfig = false; // stop configportal on save failure
-    boolean       _configPortalIsBlocking = true;  // configportal enters blocking loop 
-    boolean       _enableCaptivePortal    = true;  // enable captive portal redirection
-    boolean       _userpersistent         = true;  // users preffered persistence to restore
-    boolean       _wifiAutoReconnect      = true;  // there is no platform getter for this, we must assume its true and make it so
-    boolean       _apClientCheck          = false; // keep cp alive if ap have station
-    boolean       _webClientCheck         = true;  // keep cp alive if web have client
-    boolean       _scanDispOptions        = false; // show percentage in scans not icons
-    boolean       _paramsInWifi           = true;  // show custom parameters on wifi page
-    boolean       _showInfoErase          = true;  // info page erase button
-    boolean       _showInfoUpdate         = true;  // info page update button
-    boolean       _showBack               = false; // show back button
-    boolean       _enableConfigPortal     = true;  // FOR autoconnect - start config portal if autoconnect failed
-    boolean       _disableConfigPortal    = true;  // FOR autoconnect - stop config portal if cp wifi save
-    String        _hostname               = "";    // hostname for esp8266 for dhcp, and or MDNS
-
-    const char*   _customHeadElement      = ""; // store custom head element html from user inside <head>
-    const char*   _customBodyHeader       = ""; // store custom top body element html from user inside <body>
-    const char*   _customBodyFooter       = ""; // store custom bottom body element html from user inside <body>
-    const char*   _customMenuHTML         = ""; // store custom menu html from user
-    String        _bodyClass              = ""; // class to add to body
-    String        _title                  = FPSTR(S_brand); // app title -  default WiFiManager
-
-    // internal options
-    
-    // wifiscan notes
-    // currently disabled due to issues with caching, sometimes first scan is empty esp32 wifi not init yet race, or portals hit server nonstop flood
-    // The following are background wifi scanning optimizations
-    // experimental to make scans faster, preload scans after starting cp, and visiting home page, so when you click wifi its already has your list
-    // ideally we would add async and xhr here but I am holding off on js requirements atm
-    // might be slightly buggy since captive portals hammer the home page, @todo workaround this somehow.
-    // cache time helps throttle this
-    // async enables asyncronous scans, so they do not block anything
-    // the refresh button bypasses cache
-    // no aps found is problematic as scans are always going to want to run, leading to page load delays
-    // 
-    // These settings really only make sense with _preloadwifiscan true
-    // but not limited to, we could run continuous background scans on various page hits, or xhr hits
-    // which would be better coupled with asyncscan
-    // atm preload is only done on root hit and startcp
-    // 
-    // preload scanning causes AP to delay showing for users, but also caches and lets the cp load faster once its open
-    //  my scan takes 7-10 seconds
-public:
-    boolean       _preloadwifiscan        = false; // preload wifiscan if true
-    unsigned int  _scancachetime          = 30000; // ms cache time for preload scans
-    boolean       _asyncScan              = false; // perform wifi network scan async
-    
-protected:
-
-    boolean       _autoforcerescan        = false;  // automatically force rescan if scan networks is 0, ignoring cache
-    
-    boolean       _disableIpFields        = false; // modify function of setShow_X_Fields(false), forces ip fields off instead of default show if set, eg. _staShowStaticFields=-1
-
-    String        _wificountry            = "";  // country code, @todo define in strings lang
-
-    // wrapper functions for handling setting and unsetting persistent for now.
-    bool          esp32persistent         = false;
-    bool          _hasBegun               = false; // flag wm loaded,unloaded
-    void          _begin();
-    void          _end();
-
-    void          setupConfigPortal();
-    bool          shutdownConfigPortal();
-    bool          setupHostname(bool restart);
-    
-#ifdef NO_EXTRA_4K_HEAP
-    boolean       _tryWPS                 = false; // try WPS on save failure, unsupported
-    void          startWPS();
-#endif
-
-    bool          startAP();
-    void          setupDNSD();
-    void          setupHTTPServer();
-
-    uint8_t       connectWifi(String ssid, String pass, bool connect = true);
-    bool          setSTAConfig();
-    bool          wifiConnectDefault();
-    bool          wifiConnectNew(String ssid, String pass,bool connect = true);
-
-    uint8_t       waitForConnectResult();
-    uint8_t       waitForConnectResult(uint32_t timeout);
-    void          updateConxResult(uint8_t status);
-
-    // webserver handlers
-public:
-    void          handleNotFound();
-protected:
-    void          HTTPSend(const String &content);
-    void          handleRoot();
-    void          handleWifi(boolean scan);
-    void          handleWifiSave();
-    void          handleInfo();
-    void          handleReset();
-
-    void          handleExit();
-    void          handleClose();
-    // void          handleErase();
-    void          handleErase(boolean opt);
-    void          handleParam();
-    void          handleWiFiStatus();
-    void          handleRequest();
-    void          handleParamSave();
-    void          doParamSave();
-
-    boolean       captivePortal();
-    boolean       configPortalHasTimeout();
-    uint8_t       processConfigPortal();
-    void          stopCaptivePortal();
-	// OTA Update handler
-	void          handleUpdate();
-	void          handleUpdating();
-	void          handleUpdateDone();
-
-
-    // wifi platform abstractions
-    bool          WiFi_Mode(WiFiMode_t m);
-    bool          WiFi_Mode(WiFiMode_t m,bool persistent);
-    bool          WiFi_Disconnect();
-    bool          WiFi_enableSTA(bool enable);
-    bool          WiFi_enableSTA(bool enable,bool persistent);
-    bool          WiFi_eraseConfig();
-    uint8_t       WiFi_softap_num_stations();
-    bool          WiFi_hasAutoConnect();
-    void          WiFi_autoReconnect();
-    String        WiFi_SSID(bool persistent = true) const;
-    String        WiFi_psk(bool persistent = true) const;
-    bool          WiFi_scanNetworks();
-    bool          WiFi_scanNetworks(bool force,bool async);
-    bool          WiFi_scanNetworks(unsigned int cachetime,bool async);
-    bool          WiFi_scanNetworks(unsigned int cachetime);
-    void          WiFi_scanComplete(int networksFound);
-    bool          WiFiSetCountry();
-
-    #ifdef ESP32
-
-    // check for arduino or system event system, handle esp32 arduino v2 and IDF
-    #if defined(ESP_ARDUINO_VERSION) && defined(ESP_ARDUINO_VERSION_VAL)
-
-        #define WM_ARDUINOVERCHECK ESP_ARDUINO_VERSION >= ESP_ARDUINO_VERSION_VAL(2, 0, 0)
-        #define WM_ARDUINOVERCHECK_204 ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 5)
-
-        #ifdef WM_ARDUINOVERCHECK
-            #define WM_ARDUINOEVENTS
-        #else
-            #define WM_NOSOFTAPSSID
-            #define WM_NOCOUNTRY
-        #endif
-
-        #ifdef WM_ARDUINOVERCHECK_204
-            #define WM_DISCONWORKAROUND
-        #endif
-
-    #else 
-        #define WM_NOCOUNTRY
-    #endif
-
-    #ifdef WM_NOCOUNTRY
-        #warning "ESP32 set country unavailable" 
-    #endif
-
-
-    #ifdef WM_ARDUINOEVENTS
-        void   WiFiEvent(WiFiEvent_t event, arduino_event_info_t info);
-    #else
-        void   WiFiEvent(WiFiEvent_t event, system_event_info_t info);
-    #endif
-    #endif
-
-    // output helpers
-    String        getParamOut();
-    String        getIpForm(String id, String title, String value);
-    String        getScanItemOut();
-    String        getStaticOut();
-    String        getHTTPHead(String title, String classes = "");
-    String        getHTTPEnd();
-    String        getMenuOut();
-    //helpers
-    boolean       isIp(String str);
-    String        toStringIp(IPAddress ip);
-    boolean       validApPassword();
-    String        encryptionTypeStr(uint8_t authmode);
-    void          reportStatus(String &page);
-    String        getInfoData(String id);
-
-    // flags
-    boolean       connect             = false;
-    boolean       abort               = false;
-    boolean       reset               = false;
-    boolean       configPortalActive  = false;
-
-
-    // these are state flags for portal mode, we are either in webportal mode(STA) or configportal mode(AP)
-    // these are mutually exclusive as STA+AP mode is not supported due to channel restrictions and stability
-    // if we decide to support this, these checks will need to be replaced with something client aware to check if client origin is ap or web
-    // These state checks are critical and used for internal function checks
-    boolean       webPortalActive     = false;
-    boolean       portalTimeoutResult = false;
-
-    boolean       portalAbortResult   = false;
-    boolean       storeSTAmode        = true; // option store persistent STA mode in connectwifi 
-    int           timer               = 0;    // timer for debug throttle for numclients, and portal timeout messages
-    
-    // WiFiManagerParameter
-    int         _paramsCount          = 0;
-    int         _max_params;
-    WiFiManagerParameter** _params    = NULL;
-
-    boolean _debug  = true;
-    String _debugPrefix = FPSTR(S_debugPrefix);
-
-    wm_debuglevel_t debugLvlShow = WM_DEBUG_VERBOSE; // at which level start showing [n] level tags
-
-    // build debuglevel support
-    // @todo use DEBUG_ESP_x?
-    
-    // Set default debug level
-    #ifndef WM_DEBUG_LEVEL
-    #define WM_DEBUG_LEVEL WM_DEBUG_NOTIFY
-    #endif
-
-    // override debug level OFF
-    #ifdef WM_NODEBUG
-    #undef WM_DEBUG_LEVEL
-    #endif
-
-    #ifdef WM_DEBUG_LEVEL
-    uint8_t _debugLevel = (uint8_t)WM_DEBUG_LEVEL;
-    #else 
-    uint8_t _debugLevel = 0; // default debug level
-    #endif
-
-    // @todo use DEBUG_ESP_PORT ?
-    #ifdef WM_DEBUG_PORT
-    Print& _debugPort = WM_DEBUG_PORT;
-    #else
-    Print& _debugPort = Serial; // debug output stream ref
-    #endif
-
-    template <typename Generic>
-    void        DEBUG_WM(Generic text);
-
-    template <typename Generic>
-    void        DEBUG_WM(wm_debuglevel_t level,Generic text);
-    template <typename Generic, typename Genericb>
-    void        DEBUG_WM(Generic text,Genericb textb);
-    template <typename Generic, typename Genericb>
-    void        DEBUG_WM(wm_debuglevel_t level, Generic text,Genericb textb);
-
-    // callbacks
-    // @todo use cb list (vector) maybe event ids, allow no return value
-    std::function<void(WiFiManager*)> _apcallback;
-    std::function<void()> _webservercallback;
-    std::function<void()> _savewificallback;
-    std::function<void()> _presavewificallback;
-    std::function<void()> _presaveparamscallback;
-    std::function<void()> _saveparamscallback;
-    std::function<void()> _resetcallback;
-    std::function<void()> _preotaupdatecallback;
-    std::function<void()> _configportaltimeoutcallback;
-
-    template <class T>
-    auto optionalIPFromString(T *obj, const char *s) -> decltype(  obj->fromString(s)  ) {
-      return  obj->fromString(s);
-    }
-    auto optionalIPFromString(...) -> bool {
-      // DEBUG_WM("NO fromString METHOD ON IPAddress, you need ESP8266 core 2.1.0 or newer for Custom IP configuration to work.");
-      return false;
-    }
-
-};
-
-#endif
-
-#endif

docs/API_REFERENCE.md

@@ -0,0 +1,133 @@
+# API reference
+
+This is a task-oriented reference for the supported WiFiManager firmware API. Configure an instance during boot, keep it alive for the application's lifetime, and call process() regularly while WiFiManager may have active work.
+
+For complete end-to-end patterns, use [Provisioning lifecycle](PROVISIONING_LIFECYCLE.md), [Portal content](PORTAL_CONTENT.md), and [Station profiles](STATION_PROFILES.md).
+
+## Lifecycle
+
+| API | Timing and meaning |
+| --- | --- |
+| autoConnect([apName, apPassword]) | Tries legacy saved station credentials. Returns true if it connected during the call; otherwise starts the enabled portal fallback and returns false. |
+| startConfigPortal([apName, apPassword]) | Immediately starts a configuration AP and captive portal. |
+| stopConfigPortal() | Immediately stops the configuration portal. |
+| startWebPortal() / stopWebPortal() | Starts/stops the portal web server without the configuration-AP flow. |
+| process() | Cooperatively services active portal, scan, station-profile, and connection state. Call from loop(); do not treat it as a hard real-time operation or rely on a fixed maximum duration. |
+| getConfigPortalSSID() | Returns the current configuration AP name. |
+| getConfigPortalActive() / getWebPortalActive() | Reports active configuration or web portal state. |
+| setHttpPort(port) | Chooses the portal server port before starting it. |
+
+The application owns any existing HTTP service and must release a shared port before WiFiManager starts its portal.
+
+## Station profiles
+
+| API | Timing and meaning |
+| --- | --- |
+| setStationProfileStore(store) | Supplies an application-owned durable store; WiFiManager does not own it. |
+| startStationConnection([apName, apPassword]) | Loads and begins the stored primary/fallback profile flow. |
+| startStationCandidate(candidate[, apName, apPassword]) | Attempts an in-memory profile set; when a store is attached, saves it only after a successful usable connection. |
+| saveStationProfiles(profiles) | Deliberately stores a complete profile set without a connection verification attempt. |
+| clearStationProfiles() | Clears the store and disconnects the station. |
+| setStationRecoveryInterval(milliseconds) | Sets delay before profile recovery attempts after a connection loss. |
+| isStationProfileMode(), getStationProfiles(), getStationStatus() | Inspects profile-controller state. |
+
+Profile mode has exactly primary slot 0 and optional fallback slot 1. See [Station profiles](STATION_PROFILES.md) for storage rules and portal fields.
+
+## Application settings and callbacks
+
+| API | Timing and meaning |
+| --- | --- |
+| portalAddParameter(parameter) | Registers an application-owned WiFiManagerParameter; it must outlive the portal. Returns false if registration fails. |
+| portalClearParameters() | Removes registered parameter pointers; it does not delete them. |
+| getParameters() / getParametersCount() | Inspects registered parameters. |
+| setPreSaveParamsCallback(callback) | Invoked before a parameter-only save. |
+| setSaveParamsCallback(callback) | Invoked when parameters save; receives WiFiManagerRequestArgs. |
+| setPreSaveConfigCallback(callback) | Invoked before a combined Wi-Fi/config save. |
+| setSaveConfigCallback(callback) | Invoked after changed Wi-Fi settings connect successfully, or when break-after-config is enabled. |
+| setConfigResetCallback(callback) | Invoked when Wi-Fi settings reset. |
+| setAPCallback(callback) / setWebServerCallback(callback) | Invoked after the AP/config portal or web server begins. |
+| setConfigPortalTimeoutCallback(callback) | Invoked when a configuration portal times out. |
+| setPreOtaUpdateCallback(callback) | Invoked immediately before OTA update handling. |
+
+WiFiManagerRequestArgs provides hasArg(), getArg(), getArgAsInt(), getArgAsFloat(), getArgAsBool(), and count(). It is a callback argument, not durable application configuration.
+
+WiFiManagerParameter constructors accept an ID, label, default value, maximum length, optional custom HTML, and optional label placement. IDs are request field names; keep them stable and simple.
+
+## Portal presentation and policy
+
+| API | Timing and meaning |
+| --- | --- |
+| setPortalConfig(config) | Applies title, identity text, tagline, SVG logo, and semantic theme. Returns false when a portal is active or the theme is invalid. |
+| portalSetPageInfoVisible(), portalSetPageUpdateVisible(), portalSetPageSetupVisible() | Controls built-in page visibility. |
+| portalSetActionEraseVisible(), portalSetActionRestartVisible(), portalSetActionExitVisible(), portalSetActionCloseCaptiveVisible(), portalSetActionBackVisible() | Controls built-in action visibility. |
+| portalSetLayoutParamsLocation(location) | Selects WiFiPage or SetupPage for custom parameters. |
+| portalSetBehaviorCaptivePortalEnabled(), portalSetBehaviorConnectOnSave(), portalSetBehaviorExitAllowed() | Sets portal availability, post-save connection, and exit policy. |
+| portalSetBehaviorConnectTimeoutSeconds(), portalSetBehaviorPortalTimeoutSeconds() | Sets connection and portal timeout behavior. |
+| portalSetBehaviorAutoReconnect(), portalSetBehaviorApClientCheck(), portalSetBehaviorWebClientCheck() | Sets reconnection and activity/timeout behavior. |
+| portalSetFieldPasswordPlaceholderMode(mode) | Selects Hidden, Masked, or Actual password placeholder behavior. |
+| portalSetFieldStaticIpVisibility(visibility), portalSetFieldStaticDnsVisibility(visibility) | Selects Hidden, Auto, or Always static-network fields. |
+| portalAddInfoSection(), portalClearInfoSections() | Adds/clears copied read-only information sections. |
+| portalAddHomeCard(), portalClearHomeCards() | Adds/clears copied overview cards. |
+
+Use [Portal UI and configuration](PORTAL_UI.md) for configuration examples and [Portal content](PORTAL_CONTENT.md) for ownership/persistence rules.
+
+## Connection and network policy
+
+| API | Timing and meaning |
+| --- | --- |
+| setConfigPortalTimeout(seconds) | Limits configuration portal lifetime; setTimeout() is deprecated alias. |
+| setConnectTimeout(seconds), setConnectRetries(count) | Bounds legacy automatic connection attempts. |
+| setSaveConnectTimeout(seconds), setSaveConnect(enabled) | Controls and bounds portal save-and-connect behavior. |
+| setBreakAfterConfig(enabled) | Exits after a configuration submission even when it did not connect. |
+| setEnableConfigPortal(enabled), setDisableConfigPortal(enabled) | Controls autoConnect() fallback/start-stop behavior. |
+| setAPClientCheck(enabled), setWebPortalClientCheck(enabled) | Controls portal timeout interaction with AP/web clients. |
+| setWiFiAutoReconnect(enabled), setCleanConnect(enabled) | Controls station reconnect and pre-connect disconnect behavior. |
+| setHostname(), getWiFiHostname() | Sets/reads the supported target hostname. |
+| setWiFiSSIDPrefix(), setWiFiAPChannel(), setWiFiAPHidden() | Configures the temporary setup AP. |
+| setAPStaticIPConfig(), setSTAStaticIPConfig() | Configures AP or station static addressing. |
+| setCountry(), setMinimumSignalQuality(), setRemoveDuplicateAPs(), setScanDispPerc() | Configures country and scan presentation/filter behavior. |
+| setRestorePersistent(enabled) | Controls restoration of the platform Wi-Fi persistence setting. |
+
+See [Network configuration](NETWORK_CONFIGURATION.md) for deployment constraints.
+
+## Scan, state, and diagnostics
+
+| API | Timing and meaning |
+| --- | --- |
+| requestAsyncScan(forceRefresh) | Requests a non-blocking scan. |
+| getScanSnapshot(), getScanRuntimeState(), getScanState() | Returns scan lifecycle state. |
+| isScanRunning(), hasValidScanResults() | Reads scan progress and cached-result validity. |
+| getScanResults() | Returns WiFiManager-owned cached visible results; do not retain references after a new scan or portal shutdown. |
+| getRSSIasQuality(rssi) | Converts RSSI to WiFiManager quality. |
+| getLastConxResult(), getWLStatusString(), getModeString() | Formats connection and mode diagnostics. |
+| hasEnteredConfigPortal(), getConfigPortalConnectState() | Reads portal-session history and last submission state. |
+| isConfigPortalConnectPending(), didConfigPortalConnectSucceed(), didConfigPortalConnectFail() | Reads concise portal connection status. |
+| getConfigPortalConnectStatus(), getConfigPortalConnectMessage() | Returns platform status and message for the last portal attempt. |
+| setEventCallback(callback) | Receives lifecycle notifications; use getters for detailed state. |
+| setLogEnabled(), setLogPrefix(), setLogOutput(), setLogSink(), getLogSink() | Configures log output and optional application-owned sink. |
+
+See [Observability](OBSERVABILITY.md) for event meanings and product feedback.
+
+## Reset and low-level helpers
+
+| API | Meaning |
+| --- | --- |
+| disconnect() | Disconnects without erasing saved configuration. |
+| resetSettings() | Clears legacy Wi-Fi settings. |
+| erase([optional]) | Erases Wi-Fi configuration. |
+| reboot() | Reboots the target. |
+| getWiFiIsSaved(), getWiFiSSID(), getWiFiPass() | Reads legacy saved/current station values; handle credentials carefully. |
+| getDefaultAPName() | Returns the default generated AP name. |
+| debugSoftAPConfig(), debugPlatformInfo() | Writes diagnostic information. |
+| htmlEntities(text[, whitespace]) | Escapes text for WiFiManager HTML rendering. |
+| preloadWiFi(ssid, password) | Intended for fixtures or controlled integrations that deliberately skip normal station configuration. |
+
+getServer() and getDNSServer() are exposed for testing/host integration. They are not a supported way for product firmware to add private portal routes or mutate the built-in server.
+
+## Continue
+
+- [Architecture and boundaries](ARCHITECTURE.md)
+- [Portal API](PORTAL_API.md)
+- [Examples](../examples/README.md)
+
+Back to [documentation](README.md) · [project overview](../README.md).

docs/ARCHITECTURE.md

@@ -0,0 +1,93 @@
+# Integrating WiFiManager
+
+WiFiManager runs device-local Wi-Fi setup. It tries station Wi-Fi, temporarily
+hosts an access point and portal when the device cannot connect, and then lets
+the firmware continue its normal work. It is not a cloud service,
+remote-management system, or companion-app framework.
+
+## What WiFiManager handles
+
+| WiFiManager handles | Your firmware handles |
+| --- | --- |
+| Temporary AP, captive DNS, portal routes, Wi-Fi connection attempts, portal session state | Durable application settings, schema migration, product services, LEDs/display, reboot policy, telemetry, and access-control decisions |
+| Wi-Fi credentials in the legacy flow, or profile-selection policy in station-profile mode | The durable station-profile store when profile mode is enabled |
+| Structured portal presentation and built-in Wi-Fi/settings forms | Product-specific validation and the persistence of product settings |
+| The local portal JSON protocol | Any separate product HTTP API or local web server |
+
+This lets a firmware decide what configuration it needs without copying the
+portal, captive-network behavior, or Wi-Fi connection flow.
+
+## Typical boot sequence
+
+~~~text
+Firmware boot
+  │
+  ├─ Load and migrate application settings
+  ├─ Register portal branding, policy, and application parameters
+  ├─ Start a WiFiManager connection flow
+  │    ├─ Connected: start normal application services
+  │    └─ Not connected: temporary AP + local portal
+  ├─ Service wifi.process() while a portal or profile controller is active
+  └─ Persist application data and decide when to restart or resume services
+~~~
+
+Register portal configuration before calling autoConnect(), startConfigPortal(), startWebPortal(), or a station-profile start method. The active portal uses an immutable response model so that asynchronous requests cannot see a partially changed UI.
+
+## Customise the built-in portal
+
+WiFiManager can set product identity, named theme values, page/action
+visibility, parameters, information sections, and home cards. Use its public
+C++ configuration and content APIs for those tasks:
+
+~~~cpp
+WiFiManagerPortalConfig portal;
+portal.title = WiFiManagerPortalText::progmem(PSTR("Set up sensor"));
+wifi.setPortalConfig(portal);
+~~~
+
+The built-in portal still owns its HTML shell, routes, forms, navigation, and
+captive behavior. It does not provide:
+
+- arbitrary portal HTML-shell replacement;
+- raw CSS or JavaScript injection;
+- route replacement or navigation injection;
+- a cloud API or supported mobile-companion integration surface.
+
+The `/api/*` routes are the built-in portal's browser protocol. They are useful
+for portal maintenance and tests, but are not a product firmware or
+companion-app integration API. If a product needs a reusable portal capability,
+add one focused public WiFiManager C++ API and test it on ESP8266 and ESP32.
+
+## Application-service handoff
+
+WiFiManager's portal server uses its configured HTTP port, 80 by default. A product already using that port must explicitly release it before WiFiManager starts a portal. Conversely, the application decides when its normal web service is safe to start after a successful connection.
+
+Release an application-owned server before starting the portal:
+
+~~~cpp
+void beginRecovery() {
+    stopApplicationWebServer();       // Releases port 80 owned by the product.
+    wifi.startConfigPortal("Device Setup", "setup-password");
+}
+~~~
+
+The application may instead use a different WiFiManager HTTP port through setHttpPort(); document that address for installers because the captive-portal redirect and station handoff will include the selected port.
+
+## Data lifetime and persistence
+
+WiFiManagerPortalConfig text and SVG values are non-owning. Keep RAM or PROGMEM source data alive for the entire firmware lifetime. WiFiManagerParameter instances are application-owned and must outlive the portal. Portal information sections and home cards are copied when registered.
+
+A station-profile store is also application-owned. Its load(), save(), and clear() methods are responsible for durable storage and error handling. The profile controller chooses and verifies networks; it does not own the store or an application's migration format.
+
+## Security and operator expectations
+
+The configuration portal is intended for local setup. Use a Wi-Fi-valid AP password in deployed products, do not put secrets in information cards or logs, and do not expose password placeholders unless there is an explicit local-installation requirement. The portal's JSON endpoints are the built-in UI's device-local protocol; they are not an authenticated remote-management API.
+
+## Continue
+
+- [Provisioning lifecycle](PROVISIONING_LIFECYCLE.md)
+- [Portal UI and configuration](PORTAL_UI.md)
+- [Portal content](PORTAL_CONTENT.md)
+- [Integration recipes](recipes/README.md)
+
+Back to [documentation](README.md) · [project overview](../README.md).

docs/DEVELOPMENT.md

@@ -0,0 +1,120 @@
+# Development and releases
+
+Released consumers use the public Git tag. While changing WiFiManager and a sibling dependency together, point an ignored local PlatformIO override at a `symlink://` or `file://` checkout rather than changing tracked application dependencies.
+
+```ini
+lib_deps =
+    WiFiManager=symlink:///path/to/WiFiManager
+```
+
+## Target pins
+
+WiFiManager uses one maintained ESP32 test lane:
+
+| Lane | pioarduino platform | Purpose |
+| --- | --- | --- |
+| `esp32` | `55.03.311` / Arduino-ESP32 3.3.11 | maintained baseline |
+
+This is a test-target policy, not a library-manifest dependency: a consuming
+application chooses its own `platform` and must validate the complete
+framework/toolchain stack. Do not let a shared global PlatformIO cache choose
+framework metadata or a compiler implicitly, and do not override just the
+toolchain to repair a cache mismatch. Each pioarduino platform owns its
+matching framework, uploader, and compiler package set.
+
+Core 3 Wi-Fi builds need the C++14, `SOC_WIFI_SUPPORTED`, and `Network/src`
+settings in this repository's `platformio.ini`; keep those settings together
+when adding an ESP32 environment. The portal OTA fixture and every guided
+example use this 3.3.11 ESP32 baseline.
+
+ESP8266 test environments pin framework commit `521ae60` for the upstream
+Postmortem large-jump linker fix. The exact rationale and update rule are in
+the shared [ESP8266 linker-workaround note](https://github.com/alexhopeoconnor/arduino-home-assistant/blob/main/docs/ESP8266-LINKER-WORKAROUND.md).
+For the pioarduino release-to-Core mapping and cache-collision diagnosis, see
+[DeviceFramework's toolchain guide](https://github.com/alexhopeoconnor/DeviceFramework/blob/main/docs/TOOLCHAINS.md).
+
+`./scripts/test.sh` and `./tools/portal-hardware ota --platform esp32` use the
+PlatformIO Core/cache shared by the maintained framework repositories,
+defaulting to `${XDG_CACHE_HOME:-$HOME/.cache}/arduino-framework-platformio/core-3.3.11`.
+WiFiManager, DeviceFramework, DFTE, and ArduinoHA pin this same graph, so this
+avoids downloading the same Core 3.3.11 inputs for each repository while
+keeping pioarduino's package-form `esptool` and generated environment separate
+from stale global `tool-esptoolpy` metadata. Override the location with
+`WIFIMANAGER_PLATFORMIO_CORE_DIR`,
+`WIFIMANAGER_PLATFORMIO_PACKAGES_DIR`, and
+`WIFIMANAGER_PLATFORMIO_CACHE_DIR` when space belongs elsewhere or an isolated
+diagnosis is needed. The first shared install is several GiB; reserve at least
+4 GiB plus cache headroom. It is persistent and is never cleared by normal test
+commands.
+
+For a disposable cache investigation, point that variable at an exact temporary
+directory, run the affected command, inspect the resolved graph, then remove
+only that directory:
+
+```bash
+wm_pio_core="$(mktemp -d /tmp/wifimanager-pio-XXXXXX)"
+WIFIMANAGER_PLATFORMIO_CORE_DIR="$wm_pio_core" \
+  ./scripts/test.sh compile --platform esp32
+rm -rf -- "$wm_pio_core"
+```
+
+Start a release with `bump-version.sh`. It updates package metadata and canonical installation snippets, then creates the changelog section. Replace its generated TODO with the release summary and update any behavioural documentation before running:
+
+```bash
+./scripts/bump-version.sh vMAJOR.MINOR.PATCH
+# Replace the generated CHANGELOG TODO with the release summary.
+./scripts/check-docs.sh
+./scripts/test.sh compile --platform esp8266
+./scripts/test.sh compile --platform esp32
+./scripts/test.sh unity --platform esp8266
+./scripts/test.sh unity --platform esp32
+./scripts/test.sh examples --platform esp8266
+./scripts/test.sh examples --platform esp32
+./scripts/test.sh ota-fixtures --platform esp8266
+./scripts/test.sh ota-fixtures --platform esp32
+./scripts/prepare-release.sh vMAJOR.MINOR.PATCH --tag
+```
+
+When a physical ESP8266 and ESP32 are available, include their local lifecycle tests in the release gate. These tests remain opt-in because they flash the selected board and use its actual radio:
+
+~~~bash
+./scripts/test.sh hardware --platform esp8266 --port /dev/serial/by-id/usb-...
+./scripts/test.sh hardware --platform esp32 --port /dev/serial/by-id/usb-...
+~~~
+
+When a physical ESP8266 or ESP32 and a spare USB Wi-Fi adapter are available,
+run the Docker portal test harness as an additional release-gate check. It is
+opt-in because it flashes the selected board and temporarily joins its AP, but
+it refuses the host default-route adapter and leaves Docker responsible only
+for browser/API testing:
+
+```bash
+./tools/portal-hardware run --platform esp8266 --port /dev/serial/by-id/usb-... \
+  --client-interface wlx74da385d4165
+```
+
+From an SSH/headless shell, the portal command may ask once for scoped
+NetworkManager sudo authorization before the selected board is erased. This is
+host setup, not a test secret; never add a sudo value to an env file or run the
+whole runner as root. See [Testing](TESTING.md#networkmanager-authorization)
+for the direct/Polkit and scoped-sudo behavior.
+
+See [Testing](TESTING.md#docker-portal-test-harness) for cleanup, artifacts, and
+optional station handoff credentials.
+
+Run the portal HTTP OTA A/B test harness separately when a spare adapter and 4 MB
+test board are available. It erases the selected board's flash, serial-flashes
+A, and uses the real browser update form to upload B; do not replace its
+automatic-reboot assertion with a manual reset:
+
+```bash
+./tools/portal-hardware ota --platform esp8266 --port /dev/serial/by-id/usb-... \
+  --client-interface wlx74da385d4165
+```
+
+See [Portal HTTP OTA A/B test harness](TESTING.md#portal-http-ota-ab-test-harness) for
+the partition, artifact, final-board-state, and adapter rules.
+
+Push the branch and annotated tag. GitHub Actions repeats the board-free compile checks, validates the package, and creates a GitHub Release using that version’s changelog section. The workflow does not publish to the PlatformIO Registry.
+
+Back to [documentation](README.md) · [project overview](../README.md).

docs/GETTING_STARTED.md

@@ -0,0 +1,38 @@
+# Getting started
+
+WiFiManager owns station credential recovery and a temporary configuration portal. Keep one instance for the life of the application.
+
+```cpp
+#include <Arduino.h>
+#include <WiFiManager.h>
+
+WiFiManager wifi;
+
+void setup() {
+    Serial.begin(115200);
+    wifi.setConfigPortalTimeout(180);  // Stop the portal after three minutes.
+    wifi.autoConnect("Example Setup", "change-me");
+}
+
+void loop() {
+    wifi.process();  // Keeps the portal responsive when setup is needed.
+    // Normal work begins after autoConnect succeeds.
+}
+```
+
+`autoConnect()` first tries stored station credentials. If that cannot connect, it starts the AP and portal with the supplied name and password, then returns `false`; call `process()` from `loop()` so that portal can run. `setConfigPortalTimeout(180)` limits that portal to three minutes; pass `0` (the default) to leave it open. Use a Wi-Fi-valid AP password.
+
+## PlatformIO dependency
+
+```ini
+lib_deps =
+    WiFiManager=https://github.com/alexhopeoconnor/WiFiManager.git#v3.2.5
+```
+
+The package includes the asynchronous web and TCP dependencies required by the selected ESP8266 or ESP32 target. Add WiFiManager as the application’s direct dependency; do not copy its internal dependency list into your project.
+
+Next: build [Basic Portal](../examples/BasicPortal/), then read [Provisioning lifecycle](PROVISIONING_LIFECYCLE.md) for return-state, timeout, and recovery rules.
+
+For product presentation and settings, continue with [Portal UI and configuration](PORTAL_UI.md) and [Portal content](PORTAL_CONTENT.md).
+
+Back to [documentation](README.md) · [project overview](../README.md).

docs/NETWORK_CONFIGURATION.md

@@ -0,0 +1,107 @@
+# Network configuration
+
+These APIs configure WiFiManager's AP, station, scan, and reconnection behavior. Set them during boot, before starting a connection or portal flow, so an installer sees one consistent configuration.
+
+The current ESP8266 and ESP32 implementations apply AP static addressing through WiFi.softAPConfig() and station static addressing through WiFi.config(). Station static configuration is used by legacy connections, portal save-and-connect attempts, and the station-profile controller.
+
+This page is an advanced deployment reference. Use these settings only when the local network and the product's operating policy require them; WiFiManager's defaults are appropriate for many devices.
+
+## Access-point setup network
+
+| API | Purpose |
+| --- | --- |
+| setWiFiSSIDPrefix(prefix) | Changes the prefix used by an automatically generated AP name. |
+| setWiFiAPChannel(channel) | Selects the setup AP Wi-Fi channel. |
+| setWiFiAPHidden(hidden) | Hides or advertises the setup AP SSID. |
+| setAPStaticIPConfig(ip, gateway, subnet) | Sets the AP-side portal address configuration. |
+| setHttpPort(port) | Uses a non-default portal HTTP port. |
+| setHostname(name) | Sets the station/AP hostname as supported by the target. |
+| getConfigPortalSSID() / getDefaultAPName() | Reports the actual/current setup AP name. |
+
+A hidden AP can make field setup harder because an installer must enter the SSID manually. Treat it as a deployment decision, not a general security control. If setHttpPort() changes the default, publish the full portal address in the product's installation procedure.
+
+## A fixed setup-portal address
+
+Give the setup AP a fixed address when an installer procedure needs a stable local portal address:
+
+~~~cpp
+wifi.setAPStaticIPConfig(
+    IPAddress(192, 168, 8, 1),
+    IPAddress(192, 168, 8, 1),
+    IPAddress(255, 255, 255, 0));
+wifi.setWiFiAPChannel(6);
+wifi.setWiFiAPHidden(false);
+~~~
+
+This is applied before WiFiManager starts its SoftAP. The usual portal address becomes http://192.168.8.1/. If setHttpPort() selects a non-default port, include that port in the installer instructions and expect the station handoff URL to include it too.
+
+## Station address and credential behavior
+
+Use a station static address only when the network owner has reserved and documented it:
+
+~~~cpp
+wifi.setSTAStaticIPConfig(
+    IPAddress(192, 168, 20, 50),
+    IPAddress(192, 168, 20, 1),
+    IPAddress(255, 255, 255, 0),
+    IPAddress(192, 168, 20, 1));
+~~~
+
+| API | Purpose |
+| --- | --- |
+| setSTAStaticIPConfig(ip, gateway, subnet[, dns]) | Supplies a station static address and optional DNS server. |
+| setCleanConnect(enabled) | Disconnects before connecting; use when the product requires a fresh association. |
+| setRestorePersistent(enabled) | Controls restoration of the platform Wi-Fi persistence preference. |
+| setWiFiAutoReconnect(enabled) | Enables Wi-Fi auto-reconnect behavior. |
+| setCountry(countryCode) | Applies the supported Wi-Fi country setting. |
+| disconnect() | Disconnects without erasing persistent settings. |
+| resetSettings() | Clears legacy saved Wi-Fi settings. |
+| erase([optional]) | Erases Wi-Fi configuration and schedules the configured reset behavior. |
+
+Static-IP entry fields can be configured independently of the network setting:
+
+~~~cpp
+wifi.portalSetFieldStaticIpVisibility(PortalFieldVisibility::Auto);
+wifi.portalSetFieldStaticDnsVisibility(PortalFieldVisibility::Hidden);
+~~~
+
+Auto shows these fields when a static station configuration is already in use; Always makes them visible; Hidden suppresses them. Do not expose static network controls in a general user portal unless the installer is expected to manage those values.
+
+## Scan behavior
+
+WiFiManager's portal schedules asynchronous scans. Firmware that needs its own nearby-network status can request and inspect the same cached scan state:
+
+~~~cpp
+wifi.requestAsyncScan();
+
+if (wifi.hasValidScanResults()) {
+    for (const auto& network : wifi.getScanResults()) {
+        Serial.printf("%s: %ld dBm\n", network.ssid.c_str(), network.rssi);
+    }
+}
+~~~
+
+| API | Purpose |
+| --- | --- |
+| requestAsyncScan(forceRefresh) | Queues a scan without blocking the application loop. |
+| getScanSnapshot() / getScanRuntimeState() | Returns the complete scan lifecycle snapshot. |
+| getScanState() / isScanRunning() / hasValidScanResults() | Provides concise status checks. |
+| getScanResults() | Returns the cached visible network list. |
+| setMinimumSignalQuality(quality) | Filters low-quality scan results. |
+| setRemoveDuplicateAPs(enabled) | Controls duplicate SSID removal. |
+| setScanDispPerc(enabled) | Uses percentage rather than quality icons in the portal. |
+| getRSSIasQuality(rssi) | Converts RSSI for display. |
+
+WiFiManager owns the scan cache. It keeps the cache and its allocation while a portal is active so nearby networks can be rendered without repeated allocation churn; it clears and releases that storage when the portal fully closes. Treat getScanResults() as a snapshot and do not retain references, iterators, or pointers across a new scan or portal shutdown.
+
+## Connection and timeout policy
+
+See [Provisioning lifecycle](PROVISIONING_LIFECYCLE.md) for setConfigPortalTimeout(), setConnectTimeout(), setConnectRetries(), setSaveConnectTimeout(), setSaveConnect(), and the portal-prefixed behavior equivalents. These settings define recovery behavior; they should reflect how long an on-site installer can reasonably work and how long the product can remain offline.
+
+## Continue
+
+- [Portal UI and configuration](PORTAL_UI.md)
+- [Provisioning lifecycle](PROVISIONING_LIFECYCLE.md)
+- [API reference](API_REFERENCE.md)
+
+Back to [documentation](README.md) · [project overview](../README.md).

docs/OBSERVABILITY.md

@@ -0,0 +1,89 @@
+# Observability
+
+WiFiManager exposes connection and portal state so product firmware can provide useful local feedback. Use getters as the source of truth and treat callbacks as notifications.
+
+A device framework consuming WiFiManager uses this pattern to distinguish normal operation, offline recovery, active setup, and a successful portal connection before it changes LED state or starts product services.
+
+## Portal state
+
+| API | Meaning |
+| --- | --- |
+| getConfigPortalActive() | A configuration AP/portal is currently active. |
+| getWebPortalActive() | A manually started portal web service is active. |
+| hasEnteredConfigPortal() | Setup has been entered at least once since boot. |
+| getConfigPortalConnectState() | Idle, queued, waiting, success, or failed for the most recent portal connection attempt. |
+| isConfigPortalConnectPending() | A concise check for queued or waiting connection work. |
+| didConfigPortalConnectSucceed() / didConfigPortalConnectFail() | Result checks for the most recent portal submission. |
+| getConfigPortalConnectStatus() | Platform Wi-Fi status for that attempt. |
+| getConfigPortalConnectMessage() | Human-readable status; suitable for logs or local display. |
+| getLastConxResult() / getWLStatusString() | Legacy and general Wi-Fi connection result helpers. |
+
+Use these values to drive product feedback. Do not derive state by scraping portal HTML or assuming that an autoConnect() false return means the portal session failed.
+
+## Events
+
+setEventCallback() installs an optional notification hook:
+
+~~~cpp
+wifi.setEventCallback([](WiFiManager::wm_event_t event) {
+    switch (event) {
+        case WiFiManager::WM_EVENT_PORTAL_STARTED:
+            setIndicator(IndicatorState::Setup);
+            break;
+        case WiFiManager::WM_EVENT_PORTAL_CONNECT_SUCCESS:
+            setIndicator(IndicatorState::ConnectingComplete);
+            break;
+        case WiFiManager::WM_EVENT_STATION_LINK_LOST:
+            setIndicator(IndicatorState::Offline);
+            break;
+        default:
+            break;
+    }
+});
+~~~
+
+| Event | Product use |
+| --- | --- |
+| WM_EVENT_PORTAL_STARTED / WM_EVENT_PORTAL_STOPPED | Begin or end setup feedback. |
+| WM_EVENT_PORTAL_CONNECT_QUEUED / START / SUCCESS / FAILED | Show progress and result for a portal-submitted network. |
+| WM_EVENT_STATION_PROFILE_ATTEMPT / CONNECTED / FAILED | Track profile-controller progress. |
+| WM_EVENT_STATION_LINK_LOST / BACKOFF | Show recovery behavior after an established connection drops. |
+| WM_EVENT_STATION_PROFILES_CLEARED | Reconcile product state after profiles are cleared. |
+
+Events are intentionally small and do not carry credentials or mutable request state. Read the relevant getter inside the callback when more detail is needed.
+
+## Station-profile status
+
+When using profile mode, getStationStatus() reports:
+
+- state: idle, loading, attempting, switching, connected, backoff, or portal;
+- activeSlot and attemptedSlot;
+- configuredProfiles;
+- wifiStatus and a human-readable message;
+- whether the last connection was a candidate;
+- whether the profile store could not save a successful candidate.
+
+A store-save failure is operationally important: the device may be connected now but will not necessarily reconnect after a restart. Preserve that distinction in an LED, display, or operator log.
+
+## Logging
+
+WiFiManager logs to its configured Print output unless a WiFiManagerLogSink is supplied.
+
+~~~cpp
+wifi.setLogPrefix("[network] ");
+wifi.setLogOutput(true, WiFiManagerLogLevel::Info);
+~~~
+
+WiFiManagerLogLevel ranges from Silent through Error, Warn, Info, Debug, and Trace. A custom WiFiManagerLogSink receives a WiFiManagerLogMessage instead of the Print output. Redact SSIDs and never log passwords, portal form values, or product secrets into a remotely collected log.
+
+## Scan status
+
+For nearby-network progress, use getScanState(), isScanRunning(), hasValidScanResults(), and getScanResults(); see [Network configuration](NETWORK_CONFIGURATION.md#scan-behavior). The portal API exposes a matching local scan-status representation for the built-in UI.
+
+## Continue
+
+- [Provisioning lifecycle](PROVISIONING_LIFECYCLE.md)
+- [Station profiles](STATION_PROFILES.md)
+- [API reference](API_REFERENCE.md)
+
+Back to [documentation](README.md) · [project overview](../README.md).

docs/PORTAL_API.md

@@ -0,0 +1,118 @@
+# Built-in portal browser protocol
+
+This device-local protocol is used by WiFiManager's built-in portal shell. It
+is useful when maintaining that UI or writing portal-focused tests. It is not a
+cloud API, remote-management interface, or supported companion-app integration
+surface.
+
+The portal is unauthenticated local setup infrastructure. Do not expose it as a product's general application API, and do not infer a security boundary from hiding an action in the UI.
+
+## Contract version and format
+
+GET /api/bootstrap returns contractVersion 3. The built-in portal uses that versioned response; tests that assert its shape should feature-detect fields rather than assume undocumented portal HTML or JSON properties.
+
+All documented API responses are JSON with no-cache headers. The server also sends permissive CORS headers for the built-in portal implementation; that does not change the local-only security boundary or make these routes a remote integration contract.
+
+## Route inventory
+
+| Method | Route | Built-in portal purpose |
+| --- | --- | --- |
+| GET | / | Serves the one portal HTML shell. |
+| GET | /api/bootstrap | Reads product brand, portal context, page/action visibility, layout, scan summary, and overview cards. |
+| GET | /api/wifi/scan-status | Reads async scan state and visible nearby networks. |
+| POST | /api/wifi/scan | Queues a forced asynchronous scan; returns 202. |
+| GET | /api/wifi/meta | Reads Wi-Fi form fields, static-IP fields, parameters on the Wi-Fi page, and profile metadata when enabled. |
+| POST | /api/wifi/save | Submits Wi-Fi fields, applicable parameters, and optionally a station-profile set. |
+| GET | /api/wifi/connect-status | Reads the result of the most recent portal save-and-connect attempt. |
+| POST | /api/wifi/connect-complete | Acknowledges that the built-in portal has received the successful station handoff address. |
+| POST | /api/portal/timeout-reset | Restarts an active configured portal timeout. |
+| GET | /api/params | Reads parameters for the separate Setup page. |
+| POST | /api/params/save | Saves Setup-page parameters. |
+| GET | /api/info | Reads device/Wi-Fi info, copied information sections, and visible actions. |
+| GET | /api/status | Reads a short plain-text status summary in JSON. |
+| POST | /api/device/restart | Schedules a target restart. |
+| POST | /api/device/erase | Erases Wi-Fi configuration and schedules restart when successful. |
+| POST | /api/portal/close | Disables captive-portal detection for the active session. |
+| POST | /api/portal/exit | Requests portal exit when portal exit is allowed. |
+| POST | /u | Receives multipart firmware upload and returns JSON completion status. |
+
+Unknown routes are redirected only while captive-portal handling is active; otherwise they return the normal not-found result.
+
+## Bootstrap and read models
+
+Bootstrap includes a brand object (title, tagline, logo SVG, and logo alt text), a context object (portal activity, timeout remaining, identity text, status summary, scan state), visible pages/actions, parameter layout, and copied home cards.
+
+Wi-Fi form metadata is intentionally separate:
+
+- Legacy mode returns SSID/password fields, configured static fields, and parameters when the layout places them on the Wi-Fi page.
+- Profile mode returns primary/fallback profile metadata, the active slot, controller state, static fields, and applicable parameters.
+- Password values are never returned. Legacy password placeholder behavior is controlled by portalSetFieldPasswordPlaceholderMode().
+
+GET /api/params exposes all registered parameters for the separate Setup page, plus whether the back action is visible. GET /api/info exposes device/Wi-Fi facts, copied information sections, and action visibility. GET /api/status returns a short human-readable text field.
+
+## Wi-Fi submit and connection handoff
+
+POST /api/wifi/save accepts form fields. In legacy mode:
+
+| Field | Meaning |
+| --- | --- |
+| s | Station SSID. |
+| p | Station password. A password without an SSID is treated as a password change for the stored SSID. |
+| ip, gw, sn, dns | Optional station static IP, gateway, subnet, and DNS values when those fields are visible. |
+| Registered parameter ID or param_N | Application parameter values when parameters are placed on the Wi-Fi page. |
+
+A normal accepted save returns 202 and directs the portal to poll /api/wifi/connect-status. The status response is:
+
+~~~json
+{
+  "state": "success",
+  "message": "human readable status",
+  "wifiStatus": "WL_CONNECTED",
+  "stationIp": "192.168.1.42",
+  "redirectUrl": "http://192.168.1.42/"
+}
+~~~
+
+`state` is one of `idle`, `waiting`, `success`, or `failed`. The example shows
+a successful join; `stationIp` and `redirectUrl` are present only in that state.
+If the portal server is not on port 80, `redirectUrl` includes that port. When
+connect-on-save is disabled, a saved configuration has no station address and
+the built-in portal remains open.
+
+After observing success, the built-in portal POSTs /api/wifi/connect-complete. A 409 response means successful handoff is not ready; otherwise WiFiManager keeps the portal alive briefly, receives the acknowledgement, and then closes after a grace delay. Browser captive redirects can still fail, so the portal keeps the station address visible.
+
+When portalSetBehaviorConnectOnSave(false) or setSaveConnect(false) is selected, a Wi-Fi save does not start this station connection/handoff flow.
+
+## Profile-mode submit
+
+In profile mode, POST /api/wifi/save accepts s0/p0 for primary and s1/p1 for fallback. Primary must be non-empty. A blank p0 or p1 preserves an existing password; clear0 or clear1 explicitly clears a password for an open network.
+
+By default, WiFiManager attempts the submitted candidate and returns 202 for status polling. With stationAction=save, it writes the submitted profile set for a later connection attempt and returns 200. See [Station profiles](STATION_PROFILES.md) for candidate verification and storage behavior.
+
+## Parameter submit
+
+POST /api/params/save sends registered application parameter fields and returns a successful acknowledgement after the registered save callbacks run. A parameter can be addressed by its stable ID or by param_N index. WiFiManager does not define application validation or durable-storage semantics; the consuming application owns both.
+
+## Actions and error states
+
+| Route | Success | Important non-success response |
+| --- | --- | --- |
+| POST /api/wifi/scan | 202 with accepted/queued state | Scan result arrives through scan-status. |
+| POST /api/wifi/save | 202 for queued connection, or 200 for profile save-for-later | 400 for invalid Wi-Fi/profile input; 500 when an explicit profile store save fails. |
+| POST /api/wifi/connect-complete | 200 after successful station handoff | 409 when success/address is not ready. |
+| POST /api/portal/timeout-reset | 200 with timeout seconds remaining | 409 when no active finite portal timeout exists. |
+| POST /api/device/restart | 200, restart scheduled | The target restarts shortly after the response. |
+| POST /api/device/erase | 200, erase/restart scheduled | 500 when erase fails. |
+| POST /api/portal/close | 200, captive detection disabled | The portal server itself remains subject to its normal lifecycle. |
+| POST /api/portal/exit | 200, exit scheduled | 403 when exit is not allowed. |
+| POST /u | 200, firmware update/restart scheduled | 500 with update failure detail. |
+
+## Using this protocol safely
+
+Use this document to understand and test WiFiManager's own portal behavior.
+Applications that need a product web API should host and secure that API after
+WiFiManager has completed its provisioning role. Do not scrape the portal shell,
+depend on undocumented JSON fields, or add routes through WiFiManager's testing
+server accessor.
+
+Back to [documentation](README.md) · [project overview](../README.md).

docs/PORTAL_CONTENT.md

@@ -0,0 +1,107 @@
+# Portal content and application settings
+
+Use the built-in portal to collect small product settings alongside Wi-Fi credentials. WiFiManager owns the form and its temporary values; the application validates and persists its own settings.
+
+This matches the product-firmware pattern used by real consumers: load configuration first, expose its current values through WiFiManagerParameter objects, then persist valid submitted values through the application's configuration layer.
+
+## End-to-end pattern
+
+~~~cpp
+#include <WiFiManager.h>
+
+constexpr int kBrokerHostLength = 64;
+
+WiFiManager wifi;
+WiFiManagerParameter brokerHost(
+    "broker_host", "MQTT broker", "", kBrokerHostLength);
+
+void setupPortal() {
+    // The application has already loaded settings before this point.
+    brokerHost.setValue(settings.mqttHost.c_str(), kBrokerHostLength);
+    wifi.portalAddParameter(&brokerHost);
+
+    wifi.setSaveParamsCallback([](WiFiManager::WiFiManagerRequestArgs) {
+        const String candidate = brokerHost.getValue();
+
+        if (!isValidHostname(candidate)) {
+            logInvalidBroker(candidate);
+            return;  // Keep the application's known-good stored value.
+        }
+
+        settings.mqttHost = candidate;
+        saveApplicationSettings(settings);
+    });
+}
+~~~
+
+Call setupPortal() after loading application settings and before a WiFiManager connection or portal start method. The callback receives a copy of the submitted request arguments; use getArg(), getArgAsInt(), getArgAsFloat(), or getArgAsBool() when the application needs request-level values.
+
+The save-parameters callback is a notification hook, not a validation-response API. Its return type cannot turn the built-in UI's success response into a form error. Validate before using the candidate, preserve known-good data when persistence fails, and provide product-specific feedback through the application's own UI/logging policy.
+
+## Parameter rules
+
+| Rule | Why it matters |
+| --- | --- |
+| Keep each WiFiManagerParameter alive while the portal can use it. | WiFiManager stores the parameter pointer; it does not take ownership. |
+| Use a stable ID without spaces or special characters. | The ID is used in portal requests. |
+| Choose a bounded value length. | It defines the editable buffer length. |
+| Register parameters before opening the portal. | Active portal responses use their established form model. |
+| Treat submitted text as untrusted application input. | Portal input is not application validation or durable storage. |
+
+Use portalClearParameters() only before opening a portal when rebuilding a complete form. It removes registered parameter pointers; it does not destroy application-owned parameter objects.
+
+## Where settings appear
+
+By default, custom parameters appear on the Wi-Fi page. To put them on the separate Setup page:
+
+~~~cpp
+wifi.portalSetLayoutParamsLocation(PortalParamsLocation::SetupPage);
+~~~
+
+Use the Wi-Fi page for a small setting that is naturally provisioned with network credentials. Use the Setup page when product configuration needs its own step. Page visibility and layout are part of the structured portal policy; see [Portal UI and configuration](PORTAL_UI.md).
+
+## Read-only product context
+
+Use information sections for labelled facts and home cards for a short overview or callout:
+
+~~~cpp
+PortalInfoSection deviceInfo;
+deviceInfo.id = "device";
+deviceInfo.title = "Device";
+deviceInfo.items = {
+    {"firmware", "Firmware", firmwareVersion},
+    {"sensor", "Sensor", sensorReady ? "Ready" : "Checking"},
+};
+wifi.portalAddInfoSection(deviceInfo);
+
+PortalHomeCard installerHint;
+installerHint.id = "installer-hint";
+installerHint.title = "Before you begin";
+installerHint.kind = PortalHomeCardKind::Callout;
+installerHint.text = "Connect the device to its final local network.";
+wifi.portalAddHomeCard(installerHint);
+~~~
+
+Information sections and cards are copied at registration. Do not place secrets, passwords, API tokens, or personally identifying values in them.
+
+## Save callbacks
+
+| Callback | Use |
+| --- | --- |
+| setPreSaveParamsCallback() | Observe a parameter-only save before the normal parameter callback. |
+| setSaveParamsCallback(args) | Read, validate, and persist application settings after a parameter save. |
+| setPreSaveConfigCallback() | Observe a combined Wi-Fi/config save before Wi-Fi connection processing. |
+| setSaveConfigCallback() | React after Wi-Fi settings changed and the connection succeeded, or when break-after-config is enabled. |
+| setConfigResetCallback() | Clear or reconcile application configuration when the portal resets Wi-Fi settings. |
+
+Do not use a Wi-Fi-success callback to persist unrelated product settings: parameters can be saved separately, and an application needs its own durable-data policy.
+
+The buildable [Custom Portal Content](../examples/CustomPortalContent/) example demonstrates parameters, information sections, and home cards. This guide supplies the missing persistence and validation boundary.
+
+## Continue
+
+- [Portal UI and configuration](PORTAL_UI.md)
+- [Product settings and Wi-Fi recipe](recipes/PRODUCT_SETTINGS_AND_WIFI.md)
+- [API reference](API_REFERENCE.md)
+
+Back to [documentation](README.md) · [project overview](../README.md).

docs/PORTAL_UI.md

@@ -0,0 +1,134 @@
+# Portal UI and configuration
+
+WiFiManagerPortalConfig is the supported presentation API for the built-in provisioning portal. It changes product identity and semantic visual tokens; the portal-policy methods below control the visibility and behavior of existing built-in features. WiFiManager continues to own portal routes, forms, navigation, captive behavior, reset, and OTA views.
+
+Apply presentation before autoConnect(), startConfigPortal(), or startWebPortal(). Configure portal policy during boot as well so each portal session begins consistently. Portal text and SVG assets are non-owning, so their RAM or PROGMEM data must have static firmware lifetime. WiFiManager locks presentation while a portal is active so asynchronous responses cannot observe partial configuration; setPortalConfig() returns false if it cannot accept the configuration.
+
+## Portal views
+
+These ESP32 captures use the same real-board portal test harness described in
+[Testing](TESTING.md). The nearby networks shown are the networks visible to
+the capture device when the portal scans.
+
+| Overview | Wi-Fi and application settings |
+| --- | --- |
+| ![WiFiManager portal overview with branded identity, status, and portal actions.](assets/readme/portal-overview.png) | ![WiFiManager Wi-Fi page with nearby networks and an application setting.](assets/readme/portal-wifi-settings.png) |
+
+## Standalone branded portal
+
+~~~cpp
+#include <Arduino.h>
+#include <WiFiManager.h>
+
+WiFiManager wifi;
+
+namespace {
+const char kTitle[] PROGMEM = "Set up Temperature Monitor";
+const char kIdentity[] PROGMEM = "Example Devices";
+const char kTagline[] PROGMEM = "Reliable setup for connected devices.";
+const char kLogoAlt[] PROGMEM = "Example Devices";
+const char kLogo[] PROGMEM =
+    R"svg(<svg viewBox="0 0 64 64"><circle cx="32" cy="32" r="28"/></svg>)svg";
+const char kPage[] PROGMEM = "#f4f7f3";
+const char kSurface[] PROGMEM = "#ffffff";
+const char kAccent[] PROGMEM = "#347a45";
+const char kAccentText[] PROGMEM = "#ffffff";
+
+WiFiManagerPortalConfig kPortalUI;
+}
+
+void setup() {
+    // Set only the identity values this product needs.
+    kPortalUI.title = WiFiManagerPortalText::progmem(kTitle);
+    kPortalUI.identityText = WiFiManagerPortalText::progmem(kIdentity);
+    kPortalUI.tagline = WiFiManagerPortalText::progmem(kTagline);
+    kPortalUI.logo = WiFiManagerPortalAsset::svgFromProgmem(kLogo);
+    kPortalUI.logoAltText = WiFiManagerPortalText::progmem(kLogoAlt);
+
+    // Unset theme values retain the built-in style.
+    kPortalUI.theme.pageBackground = WiFiManagerPortalText::progmem(kPage);
+    kPortalUI.theme.surface = WiFiManagerPortalText::progmem(kSurface);
+    kPortalUI.theme.accent = WiFiManagerPortalText::progmem(kAccent);
+    kPortalUI.theme.accentText = WiFiManagerPortalText::progmem(kAccentText);
+    kPortalUI.theme.cornerRadiusPx = 10;
+
+    if (!wifi.setPortalConfig(kPortalUI)) {
+        Serial.println("Portal UI configuration was rejected");
+    }
+    wifi.autoConnect("Temperature Monitor");
+}
+
+void loop() { wifi.process(); }
+~~~
+
+The complete buildable example is [Branded Portal](../examples/BrandedPortal/BrandedPortal.ino). The compile fixture exercises this API on ESP8266 and the maintained ESP32 3.3.11 baseline.
+
+## Presentation reference
+
+Leave a text or colour value empty, or a radius at 0, to retain the built-in stylesheet value.
+
+| Field | Used by |
+| --- | --- |
+| title | Document title and concise setup-page heading |
+| identityText | Company or product name in the header above navigation |
+| tagline | Short product context in the header above navigation |
+| logo.svg, logoAltText | Optional trusted inline SVG and its accessible label |
+| pageBackground, surface, text, mutedText, border | Portal surfaces and text |
+| accent, accentHover, accentText | Primary links and actions |
+| success, danger, dangerHover | Status and destructive actions |
+| cornerRadiusPx, smallCornerRadiusPx | Card and compact-control corners, limited to 64 px |
+
+Theme values accept simple named CSS values and are emitted once into a small
+portal theme block. Raw CSS and JavaScript are not supported. An SVG is a
+trusted compiled firmware asset, never form, MQTT, or network input.
+
+## Portal policy
+
+Use the portal-prefixed methods to choose which built-in pages and actions a
+product presents. Configure them during boot, before the portal starts, so a
+session begins with the intended behavior.
+
+~~~cpp
+// An installer portal that does not expose destructive reset or OTA actions.
+wifi.portalSetPageUpdateVisible(false);
+wifi.portalSetActionEraseVisible(false);
+wifi.portalSetActionRestartVisible(false);
+
+// Keep application settings on their own Setup page.
+wifi.portalSetLayoutParamsLocation(PortalParamsLocation::SetupPage);
+
+// Do not show saved passwords or static-IP fields unless the product needs them.
+wifi.portalSetFieldPasswordPlaceholderMode(PortalPasswordPlaceholderMode::Hidden);
+wifi.portalSetFieldStaticIpVisibility(PortalFieldVisibility::Hidden);
+wifi.portalSetFieldStaticDnsVisibility(PortalFieldVisibility::Hidden);
+~~~
+
+| Group | Methods | Use |
+| --- | --- | --- |
+| Pages | portalSetPageInfoVisible(), portalSetPageUpdateVisible(), portalSetPageSetupVisible() | Show only product-appropriate built-in pages. |
+| Actions | portalSetActionEraseVisible(), portalSetActionRestartVisible(), portalSetActionExitVisible(), portalSetActionCloseCaptiveVisible(), portalSetActionBackVisible() | Control existing action affordances; hiding an action is not a security boundary. |
+| Layout | portalSetLayoutParamsLocation() | Put registered parameters on the Wi-Fi page or separate Setup page. |
+| Connection/portal behavior | portalSetBehaviorCaptivePortalEnabled(), portalSetBehaviorConnectOnSave(), portalSetBehaviorExitAllowed(), portalSetBehaviorConnectTimeoutSeconds(), portalSetBehaviorPortalTimeoutSeconds(), portalSetBehaviorAutoReconnect(), portalSetBehaviorApClientCheck(), portalSetBehaviorWebClientCheck() | Set built-in portal behavior. |
+| Fields | portalSetFieldPasswordPlaceholderMode(), portalSetFieldStaticIpVisibility(), portalSetFieldStaticDnsVisibility() | Limit password disclosure and network-field visibility. |
+
+The older setConfigPortalTimeout(), setSaveConnect(), setShowStaticFields(), and related methods remain available. Prefer a single vocabulary within a product; the portal-prefixed methods make the policy visible in the portal's structured model.
+
+## Structured content
+
+Use portalAddParameter() for editable product settings, portalAddInfoSection() for labelled read-only values, and portalAddHomeCard() for overview text or key/value cards. Parameters remain application-owned; information sections and cards are copied when registered.
+
+See [Portal content](PORTAL_CONTENT.md) for the full persistence, validation, callback, and lifetime rules. The buildable [Custom Portal Content](../examples/CustomPortalContent/) example shows all three content types.
+
+## What stays built in
+
+Branding, policy, and structured content configure the supplied portal. The
+portal's HTML shell, routes, navigation, stylesheet, and scripts stay owned by
+WiFiManager. There is no custom shell, route replacement, navigation injection,
+raw stylesheet, or script hook.
+
+For a product-specific web application, start that application's own server
+after WiFiManager has completed provisioning. If the supplied portal needs a
+reusable capability, add one focused public WiFiManager C++ API and test it on
+ESP8266 and ESP32.
+
+Back to the [documentation index](README.md) or [project overview](../README.md).

docs/PROVISIONING_LIFECYCLE.md

@@ -0,0 +1,92 @@
+# Provisioning lifecycle
+
+Choose a connection flow that matches the device's operating policy, then call process() regularly for as long as WiFiManager is active. It is a cooperative service call, not a hard real-time guarantee: target Wi-Fi or DNS work can occasionally take longer than a typical loop iteration. The consuming firmware owns its product-service lifecycle and restart decision.
+
+## Choose a flow
+
+| Need | Preferred API | What it does |
+| --- | --- | --- |
+| One saved station network, with portal fallback | autoConnect() | Tries saved credentials and starts the configuration portal when the attempt cannot connect. |
+| Primary plus fallback network with application-owned storage | setStationProfileStore() + startStationConnection() | Loads, selects, retries, and recovers a fixed two-profile station set. |
+| Verify a received profile before retaining it | startStationCandidate() | Attempts a primary/fallback candidate in memory and saves it only after success. |
+| Start setup under application control | startConfigPortal() | Starts an AP and captive configuration portal immediately. |
+| Show the portal while station Wi-Fi is already available | startWebPortal() | Starts the portal web service without starting a configuration AP. |
+
+The first two are the normal deployed-device flows. StartConfigPortal() and startWebPortal() are supported control APIs, but should be used only when the application has a clear policy for entering and leaving them.
+
+## Basic recovery flow
+
+~~~cpp
+#include <Arduino.h>
+#include <WiFiManager.h>
+
+WiFiManager wifi;
+
+void setup() {
+    Serial.begin(115200);
+    wifi.setConfigPortalTimeout(180);
+
+    if (wifi.autoConnect("Device Setup", "change-me")) {
+        startNormalApplication();
+    } else {
+        Serial.println("Wi-Fi setup portal is active");
+    }
+}
+
+void loop() {
+    wifi.process();
+
+    if (wifi.didConfigPortalConnectSucceed()) {
+        // The application decides whether to start services or reboot.
+        startNormalApplication();
+    }
+}
+~~~
+
+autoConnect() returns true when WiFiManager connected during that call. It returns false when it could not connect and has entered the portal path; false is not, by itself, an instruction to restart. Call process() every loop iteration while setup may be needed.
+
+A portal timeout is in seconds. setConfigPortalTimeout(0), the default, leaves the portal open. A field-installed product may deliberately use a longer bounded window, such as 15 minutes, so an installer has time to complete setup without leaving an unattended portal indefinitely.
+
+## Portal connection outcome
+
+For a portal save-and-connect attempt, use these getters instead of inferring state from the rendered page:
+
+| Getter | Meaning |
+| --- | --- |
+| getConfigPortalActive() | The configuration portal is currently running. |
+| hasEnteredConfigPortal() | The portal has been entered at least once this runtime session. |
+| isConfigPortalConnectPending() | A portal-submitted station connection is queued or waiting. |
+| didConfigPortalConnectSucceed() / didConfigPortalConnectFail() | Result of the last portal-submitted connection attempt. |
+| getConfigPortalConnectStatus() / getConfigPortalConnectMessage() | Platform Wi-Fi status and a human-readable result. |
+
+The local portal UI obtains the same state through its documented local API. Do not parse portal HTML to determine connection state.
+
+## Timing and policy
+
+Set these before the flow starts:
+
+| API | Use |
+| --- | --- |
+| setConfigPortalTimeout(seconds) | Limits a captive configuration session; setTimeout() is its deprecated alias. |
+| setConnectTimeout(seconds) and setConnectRetries(count) | Bounds legacy automatic connection attempts. |
+| setSaveConnectTimeout(seconds) | Bounds a portal save-and-connect attempt. |
+| setSaveConnect(enabled) | Controls whether a normal portal save attempts a station connection. |
+| setBreakAfterConfig(enabled) | Exits after a configuration submission even if the connection was unsuccessful. |
+| setEnableConfigPortal(enabled) / setDisableConfigPortal(enabled) | Controls autoConnect() portal fallback and its post-save shutdown behavior. |
+| setAPClientCheck(enabled) / setWebPortalClientCheck(enabled) | Controls whether AP/web-client activity affects the portal timeout. |
+
+The portal-prefixed behavior methods provide the same configuration through the structured portal contract; prefer one vocabulary consistently in a product.
+
+## Port ownership and clean handoff
+
+Before beginning a portal on port 80, stop any application server that already owns that port. After a portal connection succeeds, wait for the application's own readiness requirements before starting its server again. A successful station connection does not automatically make an application-level service ready.
+
+See [Local web-service handoff](recipes/LOCAL_WEB_SERVICE_HANDOFF.md) for the integration sequence.
+
+## Continue
+
+- [Station profiles](STATION_PROFILES.md)
+- [Observability](OBSERVABILITY.md)
+- [API reference](API_REFERENCE.md)
+
+Back to [documentation](README.md) · [project overview](../README.md).

docs/README.md

@@ -0,0 +1,20 @@
+# WiFiManager documentation
+
+| I want to… | Read |
+| --- | --- |
+| See what WiFiManager handles and what the firmware handles | [Integrating WiFiManager](ARCHITECTURE.md) |
+| Start a basic portal or install a released dependency | [Getting started](GETTING_STARTED.md) |
+| Choose and operate a provisioning flow | [Provisioning lifecycle](PROVISIONING_LIFECYCLE.md) |
+| Brand or constrain the built-in portal | [Portal UI and configuration](PORTAL_UI.md) |
+| Add and persist application settings, status, or home cards | [Portal content](PORTAL_CONTENT.md) |
+| Configure primary/fallback station profiles or their portal workflow | [Station profiles](STATION_PROFILES.md) |
+| Configure AP, station, scan, and reconnect settings | [Network configuration](NETWORK_CONFIGURATION.md) |
+| Surface portal and station state in product firmware | [Observability](OBSERVABILITY.md) |
+| Look up a supported C++ method and lifecycle rule | [API reference](API_REFERENCE.md) |
+| Maintain or test the built-in portal's browser protocol | [Portal browser protocol](PORTAL_API.md) |
+| Apply an existing device-integration pattern | [Recipes](recipes/README.md) |
+| Run documentation and board-free compile checks | [Testing](TESTING.md) |
+| Build or flash a complete example | [Examples](../examples/README.md) |
+| Work on this fork or make a release | [Development and releases](DEVELOPMENT.md) |
+
+Back to the [project overview](../README.md).

docs/STATION_PROFILES.md

@@ -0,0 +1,108 @@
+# Station profiles
+
+WiFiManager adds an opt-in station-profile controller for applications that need a primary Wi-Fi network and one fallback. It is independent of the legacy autoConnect() flow: existing WiFiManager consumers do not need to change.
+
+Profile mode is enabled only when the application supplies a WiFiManagerStationProfileStore. The store may be an in-memory implementation for a temporary session, but durable deployments should provide persistent storage.
+
+## Lifecycle
+
+A profile set has exactly two fixed slots:
+
+- **Primary** (slot 0) is required whenever the controller is enabled.
+- **Fallback** (slot 1) is optional.
+- The last successful slot is tried first on the next connection cycle, then the remaining enabled slot.
+
+The controller never treats the ESP SDK's saved single network as an additional source of truth. It begins one bounded connection attempt at a time, moves to the fallback after failure, and retries both profiles after a temporary loss of a previously working connection. If a new device has no valid profiles, it opens the normal configuration portal.
+
+A candidate submitted by the portal or another application subsystem is only committed after it connects and receives a usable IP address. A failed candidate leaves the last saved profile set intact.
+
+## Direct WiFiManager use
+
+Implement a small store appropriate to the application. The manager neither allocates nor owns it. This complete in-memory version makes the ownership and return contract visible; use the buildable EEPROM example when the profiles must survive a restart:
+
+```cpp
+class MemoryProfileStore final : public WiFiManagerStationProfileStore {
+public:
+    bool load(WiFiManagerStationProfiles& profiles) override {
+        if (!hasProfiles_) return false;  // No saved primary profile: open the portal.
+        profiles = profiles_;
+        return true;
+    }
+
+    bool save(const WiFiManagerStationProfiles& profiles) override {
+        profiles_ = profiles;
+        hasProfiles_ = true;
+        return true;  // A durable store must return false when its write fails.
+    }
+
+    bool clear() override {
+        profiles_ = {};
+        hasProfiles_ = false;
+        return true;
+    }
+
+private:
+    WiFiManagerStationProfiles profiles_{};
+    bool hasProfiles_ = false;
+};
+
+WiFiManager wifi;
+MemoryProfileStore profiles;  // Must outlive WiFiManager's asynchronous connection work.
+
+void setup() {
+    wifi.setStationProfileStore(&profiles);
+    wifi.setStationRecoveryInterval(30000);
+    wifi.startStationConnection("Example Setup", "setup-password");
+}
+
+void loop() {
+    wifi.process();  // Advances profile retries and serves the fallback portal.
+}
+```
+
+This memory-only store intentionally loses profiles on restart. The store must return a complete `WiFiManagerStationProfiles` value. Each enabled profile has a NUL-terminated SSID of at most 32 characters and an optional NUL-terminated password of at most 64 characters. Keep slot 0 enabled; set `hasPassword = false` for an open network.
+
+When load() returns false, WiFiManager treats the profile set as unavailable and opens the normal configuration portal. When save() or clear() returns false, getStationStatus().storageSaveFailed is set and the status message explains the failure.
+
+## Verified candidate flow
+
+Use startStationCandidate(candidate) when another application subsystem supplies a complete primary/fallback proposal:
+
+~~~cpp
+wifi.setStationProfileStore(&profiles);
+
+if (!wifi.startStationCandidate(candidate, "Example Setup", "setup-password")) {
+    reportInvalidProfileCandidate();
+}
+~~~
+
+WiFiManager tries the candidate in memory, then calls the attached store only after the station connects and has a usable IP address. Inspect getStationStatus() after WM_EVENT_STATION_PROFILE_CONNECTED: lastConnectionWasCandidate tells the application that this was a candidate, and storageSaveFailed distinguishes a usable but non-durable connection.
+
+Use saveStationProfiles(profiles) only when deliberately saving without a connection check. clearStationProfiles() asks the supplied store to clear profiles and disconnects the station only after that clear succeeds.
+
+The [Primary and fallback Wi-Fi recipe](recipes/PRIMARY_AND_FALLBACK_WIFI.md) shows why candidate verification protects known-good data.
+
+## Portal contract
+
+In profile mode, the existing Wi-Fi page becomes a two-profile form. It remains driven by the same local portal endpoints:
+
+- GET /api/wifi/meta returns profiles, activeSlot, and controller state without passwords.
+- POST /api/wifi/save accepts s0/p0 for primary and s1/p1 for fallback. A blank submitted password preserves an existing password; send clear0 or clear1 for an intentional open network.
+- A normal save verifies the candidate by connecting. The built-in portal polls GET /api/wifi/connect-status for its result.
+- stationAction=save stores the submitted profiles for a later connection attempt.
+
+The portal requires a non-empty primary SSID. Its local protocol never returns a password. See [Portal API](PORTAL_API.md) for the shared connection-status response.
+
+## Recovery and troubleshooting
+
+| Symptom | Inspect | Meaning |
+| --- | --- | --- |
+| Portal starts immediately | getStationStatus().configuredProfiles and message | Store had no valid primary profile, so WiFiManager did not fall back to SDK-owned credentials. |
+| Repeated network recovery | state, attemptedSlot, activeSlot, and WM_EVENT_STATION_BACKOFF | The controller is trying configured profiles with the recovery interval. |
+| Candidate is connected but lost after reboot | lastConnectionWasCandidate and storageSaveFailed | The candidate connected, but the application store did not retain it. |
+| Portal form rejects a save | Local API response/message | Primary profile was missing or SSID/password bounds were invalid. |
+| Profiles do not clear | storageSaveFailed and message | The application store rejected clear(); fix its storage error before assuming Wi-Fi was removed. |
+
+The buildable [Station Profiles](../examples/StationProfiles/) example contains a compact EEPROM-backed store for both supported ESP targets.
+
+Back to [documentation](README.md) · [project overview](../README.md).

docs/TESTING.md

@@ -0,0 +1,305 @@
+# Testing
+
+WiFiManager separates repeatable board-free builds from opt-in tests that flash
+a real board or join a captive portal. The normal commands never need a board,
+local Wi-Fi credentials, browser binary, or sibling checkout.
+
+| Physical test harness | Transport | Host adapter | Secret source | Required proof |
+| --- | --- | --- | --- | --- |
+| Portal lifecycle suite | Serial flash + captive-portal HTTP/browser | Named secondary adapter | safe fixture AP password | Unity/lifecycle checks and portal UI/API coverage |
+| Portal HTTP OTA | WiFiManager multipart `POST /u` | Named secondary adapter | safe fixture AP password | rendered upload succeeds, portal restarts automatically, and fixture marker changes A → B twice |
+
+The selected secondary adapter is intentionally never used for normal LAN
+testing. It is `never-default`, so the host's ordinary route remains intact.
+
+## Board-free fixture, consumer, and example builds
+
+The Unity compile check builds WiFiManager's own fixture without a board. The
+consumer check builds a project that declares only WiFiManager, proving that a
+normal PlatformIO dependency resolution can compile DFTE, ESPAsyncWebServer,
+and the correct ESP8266 or ESP32 TCP dependency. Normal commands reuse the
+persistent PlatformIO cache; they do not delete, reinstall, or separately
+assert the package graph.
+
+```bash
+./scripts/test.sh compile --platform esp8266
+./scripts/test.sh compile --platform esp32
+./scripts/test.sh unity --platform esp8266
+./scripts/test.sh unity --platform esp32
+./scripts/test.sh examples --platform esp8266
+./scripts/test.sh examples --platform esp32
+./scripts/test.sh ota-fixtures --platform esp8266
+./scripts/test.sh ota-fixtures --platform esp32
+```
+
+CI runs these board-free checks for pull requests and pushes to the maintained
+branch. `esp32` uses Arduino-ESP32 3.3.11 and compiles the guided examples.
+The OTA fixture builds compile both immutable A
+and B images against their tracked OTA partition layout. CI rejects equal A/B
+artifacts, an ESP32 image larger than either 0x1F0000-byte app slot, or a
+partition-table edit that breaks the required two-slot/no-filesystem layout. These checks
+intentionally do not require attached hardware, a local network, or Docker.
+
+Direct PlatformIO test-harness commands default to two compiler jobs. Set
+`PLATFORMIO_RUN_JOBS=3` only for an explicit local run on an otherwise idle
+host.
+
+Physical portal commands lock the shared `192.168.4.0/24` portal network, the
+selected secondary adapter, and the named serial device. These non-secret
+resource locks are shared with DeviceFramework's portal harness, so a collision
+fails before either runner changes a board or adapter while unrelated station
+tests can use their own resources.
+
+## Local hardware lifecycle tests
+
+The Unity suite runs portal-only firmware with no Wi-Fi credentials, MQTT,
+product application framework, or local profile. It verifies portal start/stop
+recovery, scan-cache release, and a real asynchronous Wi-Fi scan.
+
+Use a stable serial-by-id path rather than a changing `/dev/ttyUSB` number:
+
+```bash
+pio device list
+./scripts/test.sh hardware --platform esp8266 --port /dev/serial/by-id/usb-...
+./scripts/test.sh hardware --platform esp32 --port /dev/serial/by-id/usb-...
+```
+
+The runner flashes the selected board, captures normal-boot serial output with
+the repository Bash helper, requires Unity's `Tests 0 Failures` and `OK`
+summary, and prints lifecycle metrics. Hardware work shares a lock with the
+portal test harness and DeviceFramework's hardware runners on the same host, so
+two first-party invocations cannot flash or use the same board at once.
+
+## Docker portal test harness
+
+`test/portal-harness` is deliberately tiny portal-only firmware, not an example
+or consuming application. `tools/portal-hardware` flashes it to one explicitly
+selected board, joins its AP through one explicitly selected **secondary**
+Wi-Fi adapter, then runs its HTTP and browser test harness in a pinned Playwright
+Docker image. Docker uses host networking only to reach the already-routed
+portal; it never runs NetworkManager or changes host adapters.
+
+The runner resolves PlatformIO from `WIFIMANAGER_PIO_EXECUTABLE`, then `PATH`,
+then PlatformIO's standard `~/.platformio/penv/bin/pio` installation. That
+makes the same command work from a non-interactive SSH shell without modifying
+the user's `PATH`.
+
+### NetworkManager authorization
+
+The portal adapter is a host-side resource, separate from fixture credentials.
+The runner never reads a sudo password from `test/.env`, an environment file,
+or source control. `doctor` reports whether the current session can use
+NetworkManager directly or will need scoped sudo. In a graphical desktop,
+Polkit normally authorizes the selected adapter directly. In an SSH or other
+headless session with no Polkit agent, the runner visibly validates `sudo -v`
+before it erases or flashes the board, then uses `sudo -n nmcli` only to scan,
+disconnect, join, and remove its generated connection on the named secondary
+adapter.
+
+The normal setting is `WM_NMCLI_AUTH=auto`. Use `WM_NMCLI_AUTH=sudo` to choose
+the same scoped path deliberately, or `WM_NMCLI_AUTH=direct` only when a
+working Polkit policy already grants the required actions. Do not run the whole
+runner under `sudo`: its state files and browser artifacts intentionally remain
+owned by the invoking developer. If the sudo ticket expires during a long run,
+the runner stops with an actionable message rather than silently treating an
+unauthorized rescan as a missing portal SSID. `down` uses the same scoped path
+to remove a retained connection.
+
+```bash
+./tools/portal-hardware doctor --client-interface wlx74da385d4165
+./tools/portal-hardware run \
+  --platform esp8266 \
+  --port /dev/serial/by-id/usb-... \
+  --client-interface wlx74da385d4165
+```
+
+The command refuses the host default-route adapter. If the chosen secondary
+adapter is already connected, require an explicit acknowledgement before it is
+replaced:
+
+```bash
+./tools/portal-hardware run ... --take-over-client-adapter
+```
+
+The fixture opens a 15-minute portal session and includes thirteen harmless
+custom parameters. It verifies root/bootstrap/info/status API responses,
+concurrent low-priority requests, every custom field and value across repeated
+API fetches, timeout reset, an actual async scan, a missing-route response, and
+desktop/mobile portal rendering with no browser page errors. It also round-trips
+a value containing apostrophes, quotes, backslashes, angle brackets, and an
+ampersand through the rendered form and parameter-save API. Screenshots, traces
+on failure, JSON results, and the HTML report are saved under the printed XDG
+state-directory artifact path.
+
+On ESP8266, an AP+STA scan can briefly move the radio off the AP channel. The
+client may reconnect during that interval; the test harness deliberately retries
+that transport interruption and still requires a reachable portal with a
+complete, valid scan result.
+
+The normal browser test harness catches the common regression case. When changing
+parameter rendering, run the opt-in ESP8266 soak as well. It performs twelve
+full browser renders and API fetches while the AP is active, asserting all
+thirteen fields and their exact values on every pass. This targets the
+memory-sensitive rendering failure reported upstream in issue #1787 without
+making every ordinary hardware run unnecessarily long:
+
+```bash
+./tools/portal-hardware run \
+  --platform esp8266 \
+  --port /dev/serial/by-id/usb-... \
+  --client-interface wlx74da385d4165 \
+  --custom-parameter-stress
+```
+
+For interactive diagnosis, leave the temporary client connection up and remove
+only that managed connection when finished:
+
+```bash
+./tools/portal-hardware up --platform esp32 --port /dev/serial/by-id/usb-... \
+  --client-interface wlx74da385d4165
+./tools/portal-hardware down
+```
+
+An optional station handoff test is deliberately separate because it connects
+the fixture to a real LAN. Copy the ignored template below, add local
+credentials, and pass it explicitly. The runner parses only `WIFI_SSID` and
+`WIFI_PASSWORD` into a generated mode-600 two-key file, mounts that file
+read-only into the test container, and removes it after the browser run; it
+never mounts the complete local environment file or logs either value. Because
+browser traces can retain request bodies, this opt-in mode disables Playwright
+screenshots, video, and tracing, including explicit diagnostic screenshots. It
+cannot be combined with README-media capture. Docker builds from the tracked
+`tests/portal-harness` directory only, so neither the source environment file
+nor the generated two-key file enters its build context. Keep its private output
+directory private and review any remaining report before sharing it.
+
+After either a passing or failing station-handoff attempt, the runner
+serial-flashes the portal-only fixture once more. Its `setup()` clears saved
+station settings, so the selected test board returns to the clean no-station
+portal state and does not retain the developer's Wi-Fi credentials. A failed
+restore or a failure to see the cleaned fixture AP return makes the command
+fail. `--keep` affects only the runner's temporary
+secondary-adapter connection; it does not retain station credentials on the
+board.
+
+A retained session is deliberately never overwritten. Before touching
+NetworkManager, the runner atomically records its uniquely generated connection
+name; after creation it atomically replaces that pending record with the exact
+UUID. Ordinary failures and interrupts remove that connection immediately, and
+`down` accepts either record after an uncatchable host termination or an
+intentional `up`/`--keep` session. It never removes another NetworkManager
+connection.
+
+```bash
+cp test/portal-station.env.example test/portal-station.env
+./tools/portal-hardware run ... --station-env test/portal-station.env
+```
+
+## Refresh README media
+
+README media is an explicit ESP32-only capture, not part of normal testing or
+CI. It uses the same real-board portal test harness above, but records a short
+browser tour and stores all candidate files under the ignored
+`artifacts/readme-media/` directory by default:
+
+```bash
+./tools/portal-hardware run \
+  --platform esp32 \
+  --port /dev/serial/by-id/usb-... \
+  --client-interface USB_WIFI_ADAPTER \
+  --capture-readme-media
+```
+
+Review the printed artifact directory. To keep a run somewhere more convenient,
+pass `--output DIRECTORY`. After review, promote only the approved PNG/GIF
+files into tracked documentation assets:
+
+```bash
+./tools/promote-readme-media \
+  --from artifacts/readme-media/TIMESTAMP-esp32 \
+  --replace
+./scripts/check-docs.sh
+```
+
+The Docker renderer validates the GIF duration. The promotion tool requires the
+successful ESP32 media manifest, checks file types and size limits, and never
+copies raw video, browser reports, traces, or arbitrary artifact files. The
+renderer preserves the real recording but deliberately presents it at 1.25×
+duration and 6 fps so the
+README tour is readable; it does not change normal browser-test-harness timing.
+ESP8266 remains covered by the normal hardware and browser test harness but does
+not produce duplicate README media.
+
+## Portal HTTP OTA A/B test harness
+
+`portal-hardware ota` is a separate opt-in physical test for WiFiManager's
+built-in HTTP update path. It exercises the rendered firmware-update page and
+its real multipart `POST /u` request; it is not an ArduinoOTA/UDP test.
+
+```bash
+./tools/portal-hardware ota \
+  --platform esp8266 \
+  --port /dev/serial/by-id/usb-... \
+  --client-interface wlx74da385d4165
+```
+
+The selected `--client-interface` has exactly the same safety rules as the
+normal portal test harness: it must be the explicitly named secondary adapter and
+cannot be the host default-route interface. The test never attaches that
+adapter to a normal station network. The fixture AP uses the safe local
+`default1` WPA password; this is an AP-access test, not a claim that `/u` has
+HTTP route authentication.
+
+The test harness performs the following complete run:
+
+1. Builds immutable A and B fixture images from one platform environment. A
+   generated harness-only header in an ignored, per-run private directory is
+   the only changed input, so their marker is compiled into the binary rather
+   than saved in WiFiManager settings or EEPROM.
+2. Checks both ESP32 images against the explicit matching `app0`/`app1` slots;
+   ESP8266 validates B after A has booted against the exact aligned capacity
+   passed to `Update.begin()`.
+3. Erases the explicitly selected test board's flash, then flashes A over
+   serial and starts its captive portal.
+4. Joins that portal only through the named secondary adapter and requires the
+   A marker at `/api/test/firmware-marker`.
+5. Mounts B read-only into the Playwright container, chooses it in the real
+   `#wm-ota-file` browser input, and submits the rendered form.
+6. Requires the real `POST /u` success response, an automatic portal outage,
+   automatic restart, and two independent B-marker responses.
+
+The OTA command additionally requires Python with PySerial (the
+`python3-serial` package on Debian/Ubuntu) and retains a passive,
+no-reset `serial-ota.log` beside the browser artifacts. It attaches immediately
+after serial-flashing A releases the port—before portal association and the A
+marker check—and remains attached through the two B checks. A passing run
+requires a healthy recorder, but its contents are diagnostic evidence rather
+than a pass/fail comparison against product log strings. This preserves
+firmware-side portal-start and DHCP evidence without manufacturing a reset.
+OTA-only fixture images wait five seconds after their upload reset so
+the passive recorder can attach before A/B boot evidence is emitted; ordinary
+portal test-harness startup remains fast.
+
+The fixture marker endpoint exists only in `test/portal-harness`; it is not a
+WiFiManager library route or a product-firmware pattern. The test does not
+issue a manual reset. A board which boots B only after intervention is a
+failure, even if B later appears.
+
+Both fixture images are built with explicit OTA-capable layouts:
+
+| Platform | Fixture layout | Capacity check |
+| --- | --- | --- |
+| ESP8266 | `eagle.flash.4m1m.ld` | A's live `ESP.getFreeSketchSpace()` response |
+| ESP32 | two `0x1F0000` A/B app slots, no filesystem | tracked CSV `app1` size |
+
+These are 4 MB fixture layouts (`d1_mini` for ESP8266 and `esp32dev` for
+ESP32). Do not run this command against a board with another flash size unless
+its matching explicit A/B layout and capacity checks have been added first.
+
+The final board state is firmware B in the portal-only fixture: it clears
+saved station settings on every boot and leaves no developer Wi-Fi credential
+on the device. By default the temporary NetworkManager connection is removed
+when the test exits. Pass `--keep` only for interactive diagnosis, then run
+`./tools/portal-hardware down` to remove that named temporary connection.
+
+Back to [documentation](README.md) · [project overview](../README.md).

docs/recipes/FIELD_INSTALLER_PROVISIONING.md

@@ -0,0 +1,63 @@
+# Field installer provisioning
+
+A field-installed controller or sensor often needs more time for setup than a desk-bound demo, but should not host an unattended configuration portal forever. Existing consuming device sketches solve this by choosing a deliberate 15-minute configuration window and exposing clear local feedback while setup is active.
+
+## Flow
+
+1. Boot with the product's normal configuration.
+2. Try the stored primary/fallback profile set.
+3. If Wi-Fi is unavailable, start the local setup AP and portal.
+4. Keep the portal available for the installation window.
+5. On a successful connection, let the application start services or reboot according to its own policy.
+6. On timeout, return to the product's recovery policy rather than assuming the installer finished.
+
+~~~cpp
+constexpr unsigned long kInstallerWindowSeconds = 15 * 60;
+MyProfileStore profileStore;
+
+void setup() {
+    configureProductPortal();
+    wifi.setStationProfileStore(&profileStore);
+    wifi.setStationRecoveryInterval(30000);
+    wifi.setConfigPortalTimeout(kInstallerWindowSeconds);
+
+    wifi.setAPCallback([](WiFiManager*) {
+        setIndicator(IndicatorState::Setup);
+        showInstallerInstructions();
+    });
+
+    wifi.setConfigPortalTimeoutCallback([] {
+        setIndicator(IndicatorState::Offline);
+        recordSetupTimeout();
+    });
+
+    wifi.startStationConnection(deviceSetupName(), deviceSetupPassword());
+}
+
+void loop() {
+    wifi.process();
+    // Do not start or recreate an application server while the portal owns its port.
+}
+~~~
+
+The timeout is a product decision. A short interval is appropriate for a user-facing appliance; a longer maintenance window may be justified for a device installed in a cabinet or plant room. Set 0 only when an always-open setup portal is an explicit operational choice.
+
+## What to show an installer
+
+Keep feedback independent of a browser redirect:
+
+- the setup SSID and any required password;
+- the device's portal address and non-default port, if configured;
+- a distinct setup indicator while the portal is active;
+- a distinct failure/offline indication after timeout;
+- confirmation only after Wi-Fi has actually connected.
+
+Use getConfigPortalActive(), didConfigPortalConnectSucceed(), and getConfigPortalConnectMessage() for this state. See [Observability](../OBSERVABILITY.md).
+
+## Product boundary
+
+WiFiManager supplies the local portal and timer. The product decides what happens after timeout: keep retrying profiles, sleep, wait for a physical action, or operate in an offline mode. If startStationConnection() returns false because no usable stored profile exists, the portal may be the intended next state rather than a reason to reboot immediately.
+
+For a product that deliberately uses one platform-saved network rather than primary/fallback profiles, the smaller legacy equivalent is wifi.autoConnect(deviceSetupName(), deviceSetupPassword()). It has the same local portal fallback, but no application-owned profile store, candidate verification, or fallback network.
+
+Continue with [Provisioning lifecycle](../PROVISIONING_LIFECYCLE.md) or [Provisioning state feedback](PROVISIONING_STATE_FEEDBACK.md).

docs/recipes/LOCAL_WEB_SERVICE_HANDOFF.md

@@ -0,0 +1,40 @@
+# Local web-service handoff
+
+A product may already host its own local HTTP service when a later connection failure opens WiFiManager's provisioning portal. Because WiFiManager owns its portal server port while active, the product must release that port before WiFiManager registers its portal routes.
+
+A real consuming framework does this from the AP callback: it shuts down its normal web service after the setup AP has started but before WiFiManager registers portal routes.
+
+## Automatic recovery handoff
+
+~~~cpp
+MyProfileStore profileStore;
+
+void setup() {
+    wifi.setStationProfileStore(&profileStore);
+    wifi.setStationRecoveryInterval(30000);
+
+    wifi.setAPCallback([](WiFiManager*) {
+        stopApplicationWebServer();  // Releases port 80 for WiFiManager.
+        setIndicator(IndicatorState::Setup);
+    });
+
+    wifi.startStationConnection("Device Setup", "setup-password");
+}
+~~~
+
+The AP callback runs after AP mode begins and before the portal routes are registered. It is the appropriate hook for automatic portal fallback. This profile-controller form matches the consuming firmware's recovery flow. If a product deliberately uses one platform-saved network instead, replace startStationConnection(...) with wifi.autoConnect(...); the same AP callback ordering applies. If the application explicitly starts setup itself, release its server before calling startConfigPortal().
+
+## After a successful connection
+
+The portal's successful Wi-Fi connection means the station has an address. It does not guarantee that the product's own web application, MQTT connection, or sensors are ready. The product should:
+
+1. observe didConfigPortalConnectSucceed() or the matching event;
+2. persist any application settings required for normal operation;
+3. choose whether to restart or recreate its own server;
+4. only advertise the product service when it is ready.
+
+If the product uses a non-default WiFiManager HTTP port, it can avoid a port conflict but must treat the portal URL and its station-connect handoff URL as that non-default port.
+
+Do not add routes to WiFiManager's internal server through getServer(). That accessor is for testing/host integration, not a supported product-extension API.
+
+Continue with [Provisioning lifecycle](../PROVISIONING_LIFECYCLE.md) and [Observability](../OBSERVABILITY.md).

docs/recipes/PRIMARY_AND_FALLBACK_WIFI.md

@@ -0,0 +1,49 @@
+# Primary and fallback Wi-Fi
+
+Some deployed devices receive a primary Wi-Fi network and an optional fallback from a local provisioning source. The consuming framework uses WiFiManager's fixed two-profile controller so it can verify a candidate connection before replacing durable known-good profiles.
+
+## Flow
+
+1. The application obtains a complete candidate profile set.
+2. It gives the candidate to startStationCandidate().
+3. WiFiManager attempts the primary profile and then fallback when needed.
+4. On a usable station connection, WiFiManager saves the candidate through the application-owned store.
+5. If connection or storage fails, the application can report the result without silently replacing known-good data.
+
+~~~cpp
+WiFiManagerStationProfiles candidate = makeDeploymentProfiles();
+
+wifi.setStationProfileStore(&profileStore);
+wifi.setStationRecoveryInterval(30000);
+
+if (!wifi.startStationCandidate(candidate, "Device Setup", "setup-password")) {
+    reportRejectedProfileSet();
+}
+~~~
+
+A candidate needs a non-empty enabled primary slot. The fallback slot is optional. WiFiManager never exposes profile passwords through the portal metadata API.
+
+## Treat persistence result as part of success
+
+A candidate can connect successfully while the profile store fails to write. Read getStationStatus() when WM_EVENT_STATION_PROFILE_CONNECTED arrives:
+
+~~~cpp
+wifi.setEventCallback([](WiFiManager::wm_event_t event) {
+    if (event != WiFiManager::WM_EVENT_STATION_PROFILE_CONNECTED) {
+        return;
+    }
+
+    const auto& status = wifi.getStationStatus();
+    if (status.lastConnectionWasCandidate && status.storageSaveFailed) {
+        reportConnectedButNotRetained();
+    }
+});
+~~~
+
+This distinction matters in unattended devices: the device works now, but may fail to reconnect after a restart.
+
+## Bootstrap and reconcile are application decisions
+
+WiFiManager verifies and selects station profiles. It does not define whether a product should accept a supplied profile only on first boot, replace values after an explicit revision, or merge settings from another system. Keep that policy in the application, alongside its durable configuration and schema migration.
+
+See [Station profiles](../STATION_PROFILES.md) for store requirements, portal fields, and the complete controller lifecycle.

docs/recipes/PRODUCT_SETTINGS_AND_WIFI.md

@@ -0,0 +1,56 @@
+# Product settings and Wi-Fi
+
+A connected device often needs more than an SSID and password: a device name, broker host, endpoint, operating mode, or installer-selected option. The actual consuming framework pattern is to load those settings before WiFiManager begins, expose them as portal parameters, and persist them through the application's own storage layer.
+
+## Flow
+
+1. Load the application's durable settings and run its schema migration.
+2. Build WiFiManagerParameter objects from the loaded values.
+3. Register those parameters before a portal can start.
+4. Register the save-parameters callback.
+5. Validate and persist submitted application values through the application's storage layer.
+6. Separately observe a successful Wi-Fi configuration/save if product services need a connected station first.
+
+~~~cpp
+constexpr int kBrokerHostLength = 64;
+WiFiManagerParameter brokerHost(
+    "broker_host", "MQTT broker", "", kBrokerHostLength);
+
+void configurePortalFromSettings() {
+    brokerHost.setValue(settings.mqttHost.c_str(), kBrokerHostLength);
+    wifi.portalAddParameter(&brokerHost);
+
+    wifi.setSaveParamsCallback([](WiFiManager::WiFiManagerRequestArgs) {
+        const String requestedHost = brokerHost.getValue();
+
+        if (!isValidHostname(requestedHost)) {
+            logRejectedSetting("broker_host");
+            return;
+        }
+
+        settings.mqttHost = requestedHost;
+        if (!saveApplicationSettings(settings)) {
+            reportConfigurationStorageFailure();
+        }
+    });
+}
+~~~
+
+WiFiManager does not own settings, schema migration, or the storage transaction. In particular, an application should keep known-good settings if validation or storage fails.
+
+## Keep the two persistence paths separate
+
+| Data | Owner | Save trigger |
+| --- | --- | --- |
+| Wi-Fi credentials in legacy mode | WiFiManager/platform Wi-Fi | Portal Wi-Fi save and connection flow |
+| Primary/fallback station profiles | Application-provided profile store | Profile controller after verified candidate connection, or explicit save |
+| Product settings | Application | setSaveParamsCallback() and application validation |
+| Product schema/revision | Application | Application boot/migration policy |
+
+A profile provisioning revision is not the same thing as an application schema version. The application owns both migration and the decision to apply a configuration update.
+
+## Form placement
+
+Use portalSetLayoutParamsLocation(PortalParamsLocation::WiFiPage) for one or two values that naturally belong in initial connectivity setup. Use SetupPage for product configuration that deserves a separate step. Put read-only status in PortalInfoSection or PortalHomeCard rather than turning it into a parameter.
+
+For lifetime and callback details, see [Portal content](../PORTAL_CONTENT.md).

docs/recipes/PROVISIONING_STATE_FEEDBACK.md

@@ -0,0 +1,43 @@
+# Provisioning state feedback
+
+A physical device should give useful feedback without relying on a captive-browser redirect. Existing consuming firmware uses WiFiManager state to make setup, recovery, and connected states visible through an LED, display, or local log.
+
+## State model
+
+| Product state | WiFiManager signal | Typical feedback |
+| --- | --- | --- |
+| Normal connected operation | Station/profile controller connected, no configuration portal | Normal indicator and application services. |
+| Trying known networks | Profile status is attempting or switching | Short recovery indication; no claim that setup is active yet. |
+| Setup portal active | getConfigPortalActive() is true or WM_EVENT_PORTAL_STARTED | Installer-oriented setup indication and instructions. |
+| Portal submitted credentials | isConfigPortalConnectPending() is true | Progress indication. |
+| Portal connection succeeded | didConfigPortalConnectSucceed() or WM_EVENT_PORTAL_CONNECT_SUCCESS | Connected confirmation; application decides when services start. |
+| Portal connection failed | didConfigPortalConnectFail() or WM_EVENT_PORTAL_CONNECT_FAILED | Failure indication with retry/recovery policy. |
+| Candidate connected but not stored | Station event plus storageSaveFailed | Warning: active connection may not survive restart. |
+
+## Polling pattern
+
+~~~cpp
+void updateIndicator() {
+    if (wifi.getConfigPortalActive()) {
+        setIndicator(IndicatorState::Setup);
+    } else if (wifi.isConfigPortalConnectPending()) {
+        setIndicator(IndicatorState::Connecting);
+    } else if (wifi.didConfigPortalConnectFail()) {
+        setIndicator(IndicatorState::Offline);
+    } else {
+        setIndicator(IndicatorState::Normal);
+    }
+}
+~~~
+
+Call this from the application loop after wifi.process(). For profile mode, add getStationStatus() so the product can distinguish an active station recovery attempt from a portal session.
+
+## Event pattern
+
+Events reduce polling for transitions, but getters remain the authoritative state. Use setEventCallback() to record a transition or wake a product state machine, then read the relevant portal/profile status. Avoid performing long work in the callback; keep it suitable for the normal firmware loop.
+
+## Operator-facing messages
+
+Use getConfigPortalConnectMessage() and getWLStatusString() for concise local diagnostics. Never place Wi-Fi passwords, portal parameter values, or secrets in an operator display or remotely collected logs.
+
+See [Observability](../OBSERVABILITY.md) for the complete event list and [Field installer provisioning](FIELD_INSTALLER_PROVISIONING.md) for timeout policy.

docs/recipes/README.md

@@ -0,0 +1,15 @@
+# Integration recipes
+
+These patterns come from real firmware that consumes this WiFiManager fork. They describe the boundary between a product application and WiFiManager; they are not additional framework APIs and do not require a cloud service or companion app.
+
+| Scenario | Start here when… |
+| --- | --- |
+| [Field installer provisioning](FIELD_INSTALLER_PROVISIONING.md) | A physical device needs a deliberately bounded setup window on site. |
+| [Product settings and Wi-Fi](PRODUCT_SETTINGS_AND_WIFI.md) | The portal collects Wi-Fi and application-owned settings together. |
+| [Primary and fallback Wi-Fi](PRIMARY_AND_FALLBACK_WIFI.md) | A deployment supplies a candidate primary/fallback network that must be verified before storage. |
+| [Local web-service handoff](LOCAL_WEB_SERVICE_HANDOFF.md) | The application already owns port 80 when recovery provisioning may begin. |
+| [Provisioning state feedback](PROVISIONING_STATE_FEEDBACK.md) | LEDs, a display, or logs need to distinguish setup, recovery, and connected states. |
+
+The normal [Basic Portal](../../examples/BasicPortal/) example remains the shortest way to try the legacy saved-network-or-portal flow. These recipes explain the product concerns that a standalone example should not pretend to solve.
+
+Back to [documentation](../README.md) · [project overview](../../README.md).

examples/Advanced/Advanced.ino

@@ -1,141 +0,0 @@
-/**
- * WiFiManager advanced demo, contains advanced configurartion options
- * Implements TRIGGEN_PIN button press, press for ondemand configportal, hold for 3 seconds for reset settings.
- */
-#include <WiFiManager.h> // https://github.com/tzapu/WiFiManager
-
-#define TRIGGER_PIN 0
-
-// wifimanager can run in a blocking mode or a non blocking mode
-// Be sure to know how to process loops with no delay() if using non blocking
-bool wm_nonblocking = false; // change to true to use non blocking
-
-WiFiManager wm; // global wm instance
-WiFiManagerParameter custom_field; // global param ( for non blocking w params )
-
-void setup() {
-  WiFi.mode(WIFI_STA); // explicitly set mode, esp defaults to STA+AP  
-  Serial.begin(115200);
-  Serial.setDebugOutput(true);  
-  delay(3000);
-  Serial.println("\n Starting");
-
-  pinMode(TRIGGER_PIN, INPUT);
-  
-  // wm.resetSettings(); // wipe settings
-
-  if(wm_nonblocking) wm.setConfigPortalBlocking(false);
-
-  // add a custom input field
-  int customFieldLength = 40;
-
-
-  // new (&custom_field) WiFiManagerParameter("customfieldid", "Custom Field Label", "Custom Field Value", customFieldLength,"placeholder=\"Custom Field Placeholder\"");
-  
-  // test custom html input type(checkbox)
-  // new (&custom_field) WiFiManagerParameter("customfieldid", "Custom Field Label", "Custom Field Value", customFieldLength,"placeholder=\"Custom Field Placeholder\" type=\"checkbox\""); // custom html type
-  
-  // test custom html(radio)
-  const char* custom_radio_str = "<br/><label for='customfieldid'>Custom Field Label</label><input type='radio' name='customfieldid' value='1' checked> One<br><input type='radio' name='customfieldid' value='2'> Two<br><input type='radio' name='customfieldid' value='3'> Three";
-  new (&custom_field) WiFiManagerParameter(custom_radio_str); // custom html input
-  
-  wm.addParameter(&custom_field);
-  wm.setSaveParamsCallback(saveParamCallback);
-
-  // custom menu via array or vector
-  // 
-  // menu tokens, "wifi","wifinoscan","info","param","close","sep","erase","restart","exit" (sep is seperator) (if param is in menu, params will not show up in wifi page!)
-  // const char* menu[] = {"wifi","info","param","sep","restart","exit"}; 
-  // wm.setMenu(menu,6);
-  std::vector<const char *> menu = {"wifi","info","param","sep","restart","exit"};
-  wm.setMenu(menu);
-
-  // set dark theme
-  wm.setClass("invert");
-
-
-  //set static ip
-  // wm.setSTAStaticIPConfig(IPAddress(10,0,1,99), IPAddress(10,0,1,1), IPAddress(255,255,255,0)); // set static ip,gw,sn
-  // wm.setShowStaticFields(true); // force show static ip fields
-  // wm.setShowDnsFields(true);    // force show dns field always
-
-  // wm.setConnectTimeout(20); // how long to try to connect for before continuing
-  wm.setConfigPortalTimeout(30); // auto close configportal after n seconds
-  // wm.setCaptivePortalEnable(false); // disable captive portal redirection
-  // wm.setAPClientCheck(true); // avoid timeout if client connected to softap
-
-  // wifi scan settings
-  // wm.setRemoveDuplicateAPs(false); // do not remove duplicate ap names (true)
-  // wm.setMinimumSignalQuality(20);  // set min RSSI (percentage) to show in scans, null = 8%
-  // wm.setShowInfoErase(false);      // do not show erase button on info page
-  // wm.setScanDispPerc(true);       // show RSSI as percentage not graph icons
-  
-  // wm.setBreakAfterConfig(true);   // always exit configportal even if wifi save fails
-
-  bool res;
-  // res = wm.autoConnect(); // auto generated AP name from chipid
-  // res = wm.autoConnect("AutoConnectAP"); // anonymous ap
-  res = wm.autoConnect("AutoConnectAP","password"); // password protected ap
-
-  if(!res) {
-    Serial.println("Failed to connect or hit timeout");
-    // ESP.restart();
-  } 
-  else {
-    //if you get here you have connected to the WiFi    
-    Serial.println("connected...yeey :)");
-  }
-}
-
-void checkButton(){
-  // check for button press
-  if ( digitalRead(TRIGGER_PIN) == LOW ) {
-    // poor mans debounce/press-hold, code not ideal for production
-    delay(50);
-    if( digitalRead(TRIGGER_PIN) == LOW ){
-      Serial.println("Button Pressed");
-      // still holding button for 3000 ms, reset settings, code not ideaa for production
-      delay(3000); // reset delay hold
-      if( digitalRead(TRIGGER_PIN) == LOW ){
-        Serial.println("Button Held");
-        Serial.println("Erasing Config, restarting");
-        wm.resetSettings();
-        ESP.restart();
-      }
-      
-      // start portal w delay
-      Serial.println("Starting config portal");
-      wm.setConfigPortalTimeout(120);
-      
-      if (!wm.startConfigPortal("OnDemandAP","password")) {
-        Serial.println("failed to connect or hit timeout");
-        delay(3000);
-        // ESP.restart();
-      } else {
-        //if you get here you have connected to the WiFi
-        Serial.println("connected...yeey :)");
-      }
-    }
-  }
-}
-
-
-String getParam(String name){
-  //read parameter from server, for customhmtl input
-  String value;
-  if(wm.server->hasArg(name)) {
-    value = wm.server->arg(name);
-  }
-  return value;
-}
-
-void saveParamCallback(){
-  Serial.println("[CALLBACK] saveParamCallback fired");
-  Serial.println("PARAM customfieldid = " + getParam("customfieldid"));
-}
-
-void loop() {
-  if(wm_nonblocking) wm.process(); // avoid delays() in loop when non-blocking and other long running code  
-  checkButton();
-  // put your main code here, to run repeatedly:
-}

examples/Basic/Basic.ino

@@ -1,41 +0,0 @@
-#include <WiFiManager.h> // https://github.com/tzapu/WiFiManager
-
-
-void setup() {
-    // WiFi.mode(WIFI_STA); // explicitly set mode, esp defaults to STA+AP
-    // it is a good practice to make sure your code sets wifi mode how you want it.
-
-    // put your setup code here, to run once:
-    Serial.begin(115200);
-    
-    //WiFiManager, Local intialization. Once its business is done, there is no need to keep it around
-    WiFiManager wm;
-
-    // reset settings - wipe stored credentials for testing
-    // these are stored by the esp library
-    // wm.resetSettings();
-
-    // Automatically connect using saved credentials,
-    // if connection fails, it starts an access point with the specified name ( "AutoConnectAP"),
-    // if empty will auto generate SSID, if password is blank it will be anonymous AP (wm.autoConnect())
-    // then goes into a blocking loop awaiting configuration and will return success result
-
-    bool res;
-    // res = wm.autoConnect(); // auto generated AP name from chipid
-    // res = wm.autoConnect("AutoConnectAP"); // anonymous ap
-    res = wm.autoConnect("AutoConnectAP","password"); // password protected ap
-
-    if(!res) {
-        Serial.println("Failed to connect");
-        // ESP.restart();
-    } 
-    else {
-        //if you get here you have connected to the WiFi    
-        Serial.println("connected...yeey :)");
-    }
-
-}
-
-void loop() {
-    // put your main code here, to run repeatedly:   
-}

examples/BasicPortal/BasicPortal.ino

@@ -0,0 +1,20 @@
+#include <Arduino.h>
+#include <WiFiManager.h>
+
+WiFiManager portal;
+
+void setup() {
+    Serial.begin(115200);
+    portal.setConfigPortalTimeout(180);  // Do not leave a first-boot setup AP open forever.
+
+    // Returns true when saved station credentials connect; otherwise opens the portal.
+    if (portal.autoConnect("WiFiManager Basic", "example-pass")) {
+        Serial.println("Connected. Run your normal application here.");
+    } else {
+        Serial.println("Setup portal started at http://192.168.4.1/");
+    }
+}
+
+void loop() {
+    portal.process();  // Keeps DNS, HTTP, and station-recovery work responsive.
+}

examples/BasicPortal/README.md

@@ -0,0 +1,12 @@
+# Basic Portal
+
+This is the smallest useful WiFiManager application. It first tries the credentials the ESP platform already knows. If it cannot connect, it opens an access point named **WiFiManager Basic** with password **example-pass**.
+
+1. Build and flash the selected `esp8266` or `esp32` environment.
+2. Connect a phone or computer to **WiFiManager Basic**.
+3. Open `http://192.168.4.1/` if your captive-portal helper does not open it automatically.
+4. Select a network and save it. The board joins that network and the next reboot reconnects without opening the portal.
+
+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), [getting started](../../docs/GETTING_STARTED.md), and [provisioning lifecycle](../../docs/PROVISIONING_LIFECYCLE.md).

examples/BasicPortal/platformio.ini

@@ -0,0 +1,26 @@
+[platformio]
+default_envs = esp8266
+src_dir = .
+
+[common]
+framework = arduino
+lib_ldf_mode = deep+
+lib_deps =
+    WiFiManager=symlink://../..
+
+[env:esp8266]
+extends = common
+platform = espressif8266
+board = d1_mini
+platform_packages =
+    platformio/framework-arduinoespressif8266 @ https://github.com/esp8266/Arduino.git#521ae60a89e64bb0d1eb7a0b7addf620ced5cad3
+
+[env:esp32]
+extends = common
+platform = https://github.com/pioarduino/platform-espressif32/releases/download/55.03.311/platform-espressif32.zip
+board = esp32dev
+build_unflags = -std=gnu++11
+build_flags =
+    -std=gnu++14
+    -DSOC_WIFI_SUPPORTED=1
+    -I${platformio.packages_dir}/framework-arduinoespressif32/libraries/Network/src

examples/BrandedPortal/BrandedPortal.ino

@@ -0,0 +1,47 @@
+#include <Arduino.h>
+#include <WiFiManager.h>
+
+WiFiManager wifi;
+
+namespace {
+const char kPortalTitle[] PROGMEM = "Set up Temperature Monitor";
+const char kPortalIdentity[] PROGMEM = "Example Devices";
+const char kPortalTagline[] PROGMEM = "Reliable setup for connected devices.";
+const char kPortalLogoAlt[] PROGMEM = "Example Devices";
+const char kExampleLogo[] PROGMEM = "<svg viewBox='0 0 64 64' aria-hidden='true'><circle cx='32' cy='32' r='28' fill='#347a45'/></svg>";
+const char kPage[] PROGMEM = "#f4f7f3";
+const char kSurface[] PROGMEM = "#ffffff";
+const char kText[] PROGMEM = "#1c251e";
+const char kAccent[] PROGMEM = "#347a45";
+const char kAccentText[] PROGMEM = "#ffffff";
+
+WiFiManagerPortalConfig kPortalUI;
+}
+
+void setup() {
+    Serial.begin(115200);
+
+    // Brand the built-in portal; unassigned fields retain their default values.
+    kPortalUI.title = WiFiManagerPortalText::progmem(kPortalTitle);
+    kPortalUI.identityText = WiFiManagerPortalText::progmem(kPortalIdentity);
+    kPortalUI.tagline = WiFiManagerPortalText::progmem(kPortalTagline);
+    kPortalUI.logo = WiFiManagerPortalAsset::svgFromProgmem(kExampleLogo);
+    kPortalUI.logoAltText = WiFiManagerPortalText::progmem(kPortalLogoAlt);
+
+    // Override only the theme tokens that define this product's appearance.
+    kPortalUI.theme.pageBackground = WiFiManagerPortalText::progmem(kPage);
+    kPortalUI.theme.surface = WiFiManagerPortalText::progmem(kSurface);
+    kPortalUI.theme.text = WiFiManagerPortalText::progmem(kText);
+    kPortalUI.theme.accent = WiFiManagerPortalText::progmem(kAccent);
+    kPortalUI.theme.accentText = WiFiManagerPortalText::progmem(kAccentText);
+    kPortalUI.theme.cornerRadiusPx = 10;
+    kPortalUI.theme.smallCornerRadiusPx = 6;
+
+    if (!wifi.setPortalConfig(kPortalUI)) {
+        Serial.println("Portal UI configuration was rejected");
+    }
+    wifi.setConfigPortalTimeout(180);
+    wifi.autoConnect("Temperature Monitor");
+}
+
+void loop() { wifi.process(); }

examples/BrandedPortal/README.md

@@ -0,0 +1,9 @@
+# Branded Portal
+
+This example uses the supported `WiFiManagerPortalConfig` presentation API to give the built-in portal a product name, company identity, tagline, inline SVG mark, and semantic colour tokens.
+
+Flash the `esp8266` or `esp32` environment, join **Temperature Monitor**, and open `http://192.168.4.1/`. The visual changes come from static firmware data; WiFiManager still owns the portal routes, forms, validation, and captive-network behaviour.
+
+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 and configuration](../../docs/PORTAL_UI.md), [architecture boundaries](../../docs/ARCHITECTURE.md), and the shared [example guide](../README.md).

examples/BrandedPortal/platformio.ini

@@ -0,0 +1,26 @@
+[platformio]
+default_envs = esp8266
+src_dir = .
+
+[common]
+framework = arduino
+lib_ldf_mode = deep+
+lib_deps =
+    WiFiManager=symlink://../..
+
+[env:esp8266]
+extends = common
+platform = espressif8266
+board = d1_mini
+platform_packages =
+    platformio/framework-arduinoespressif8266 @ https://github.com/esp8266/Arduino.git#521ae60a89e64bb0d1eb7a0b7addf620ced5cad3
+
+[env:esp32]
+extends = common
+platform = https://github.com/pioarduino/platform-espressif32/releases/download/55.03.311/platform-espressif32.zip
+board = esp32dev
+build_unflags = -std=gnu++11
+build_flags =
+    -std=gnu++14
+    -DSOC_WIFI_SUPPORTED=1
+    -I${platformio.packages_dir}/framework-arduinoespressif32/libraries/Network/src

examples/CustomPortalContent/CustomPortalContent.ino

@@ -0,0 +1,43 @@
+#include <Arduino.h>
+#include <WiFiManager.h>
+
+WiFiManager portal;
+// WiFiManager reads this object while the portal is open, so it must outlive setup().
+WiFiManagerParameter brokerHost("broker_host", "MQTT broker", "mqtt.local", 40);
+
+void setup() {
+    Serial.begin(115200);
+
+    portal.portalAddParameter(&brokerHost);  // Adds an application-owned setting to the built-in form.
+
+    // WiFiManager copies this read-only status section when it is registered.
+    PortalInfoSection deviceInfo;
+    deviceInfo.id = "device";
+    deviceInfo.title = "Example device";
+    deviceInfo.items = {
+        {"firmware", "Firmware", "1.0.0"},
+        {"sensor", "Sensor", "Ready"},
+    };
+    portal.portalAddInfoSection(deviceInfo);
+
+    // This callout appears on the built-in portal overview.
+    PortalHomeCard hint;
+    hint.id = "hint";
+    hint.title = "What this example adds";
+    hint.kind = PortalHomeCardKind::Callout;
+    hint.text = "A normal text setting, a status section, and a home-page callout.";
+    portal.portalAddHomeCard(hint);
+
+    portal.setSaveParamsCallback([](WiFiManager::WiFiManagerRequestArgs) {
+        // Validate and persist a copy in the application; this example only reports it.
+        Serial.print("MQTT broker selected: ");
+        Serial.println(brokerHost.getValue());
+    });
+    portal.setConfigPortalTimeout(180);
+
+    portal.autoConnect("WiFiManager Content", "example-pass");
+}
+
+void loop() {
+    portal.process();  // Serves portal requests until provisioning completes or times out.
+}

examples/CustomPortalContent/README.md

@@ -0,0 +1,13 @@
+# Custom Portal Content
+
+This example keeps WiFiManager’s portal navigation, validation, and captive behaviour, while adding three application-owned pieces of content:
+
+- an editable MQTT broker host field;
+- a compact device-information section;
+- a callout on the portal overview.
+
+It opens **WiFiManager Content** with password **example-pass** until it has working station credentials. Save the form, then inspect serial output to see the selected broker value.
+
+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 [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/CustomPortalContent/platformio.ini

@@ -0,0 +1,26 @@
+[platformio]
+default_envs = esp8266
+src_dir = .
+
+[common]
+framework = arduino
+lib_ldf_mode = deep+
+lib_deps =
+    WiFiManager=symlink://../..
+
+[env:esp8266]
+extends = common
+platform = espressif8266
+board = d1_mini
+platform_packages =
+    platformio/framework-arduinoespressif8266 @ https://github.com/esp8266/Arduino.git#521ae60a89e64bb0d1eb7a0b7addf620ced5cad3
+
+[env:esp32]
+extends = common
+platform = https://github.com/pioarduino/platform-espressif32/releases/download/55.03.311/platform-espressif32.zip
+board = esp32dev
+build_unflags = -std=gnu++11
+build_flags =
+    -std=gnu++14
+    -DSOC_WIFI_SUPPORTED=1
+    -I${platformio.packages_dir}/framework-arduinoespressif32/libraries/Network/src

examples/NonBlocking/AutoConnectNonBlocking/AutoConnectNonBlocking.ino

@@ -1,27 +0,0 @@
-#include <WiFiManager.h> // https://github.com/tzapu/WiFiManager
-WiFiManager wm;
-
-void setup() {
-    WiFi.mode(WIFI_STA); // explicitly set mode, esp defaults to STA+AP    
-    // put your setup code here, to run once:
-    Serial.begin(115200);
-    
-    //reset settings - wipe credentials for testing
-    //wm.resetSettings();
-
-    wm.setConfigPortalBlocking(false);
-    wm.setConfigPortalTimeout(60);
-    //automatically connect using saved credentials if they exist
-    //If connection fails it starts an access point with the specified name
-    if(wm.autoConnect("AutoConnectAP")){
-        Serial.println("connected...yeey :)");
-    }
-    else {
-        Serial.println("Configportal running");
-    }
-}
-
-void loop() {
-    wm.process();
-    // put your main code here, to run repeatedly:
-}

examples/NonBlocking/AutoConnectNonBlockingwParams/AutoConnectNonBlockingwParams.ino

@@ -1,36 +0,0 @@
-#include <WiFiManager.h> // https://github.com/tzapu/WiFiManager
-WiFiManager wm;
-WiFiManagerParameter custom_mqtt_server("server", "mqtt server", "", 40);
-
-void setup() {
-    WiFi.mode(WIFI_STA); // explicitly set mode, esp defaults to STA+AP    
-    // put your setup code here, to run once:
-    Serial.begin(115200);
-    
-    //reset settings - wipe credentials for testing
-    //wm.resetSettings();
-    wm.addParameter(&custom_mqtt_server);
-    wm.setConfigPortalBlocking(false);
-    wm.setSaveParamsCallback(saveParamsCallback);
-
-    //automatically connect using saved credentials if they exist
-    //If connection fails it starts an access point with the specified name
-    if(wm.autoConnect("AutoConnectAP")){
-        Serial.println("connected...yeey :)");
-    }
-    else {
-        Serial.println("Configportal running");
-    }
-}
-
-void loop() {
-    wm.process();
-    // put your main code here, to run repeatedly:
-}
-
-void saveParamsCallback () {
-  Serial.println("Get Params:");
-  Serial.print(custom_mqtt_server.getID());
-  Serial.print(" : ");
-  Serial.println(custom_mqtt_server.getValue());
-}

examples/NonBlocking/OnDemandNonBlocking/OnDemandNonBlocking.ino

@@ -1,85 +0,0 @@
-/**
- * OnDemandNonBlocking.ino
- * example of running the webportal or configportal manually and non blocking
- * trigger pin will start a webportal for 120 seconds then turn it off.
- * startAP = true will start both the configportal AP and webportal
- */
-#include <WiFiManager.h> // https://github.com/tzapu/WiFiManager
-
-// include MDNS
-#ifdef ESP8266
-#include <ESP8266mDNS.h>
-#elif defined(ESP32)
-#include <ESPmDNS.h>
-#endif
-
-// select which pin will trigger the configuration portal when set to LOW
-#define TRIGGER_PIN 0
-
-WiFiManager wm;
-
-unsigned int  timeout   = 120; // seconds to run for
-unsigned int  startTime = millis();
-bool portalRunning      = false;
-bool startAP            = false; // start AP and webserver if true, else start only webserver
-
-void setup() {
-  WiFi.mode(WIFI_STA); // explicitly set mode, esp defaults to STA+AP  
-  // put your setup code here, to run once
-  Serial.begin(115200);
-  Serial.setDebugOutput(true);
-  delay(1000);
-  Serial.println("\n Starting");
-
-  pinMode(TRIGGER_PIN, INPUT_PULLUP);
-
-  // wm.resetSettings();
-  wm.setHostname("MDNSEXAMPLE");
-  // wm.setEnableConfigPortal(false);
-  // wm.setConfigPortalBlocking(false);
-  wm.autoConnect();
-}
-
-void loop() {
-  #ifdef ESP8266
-  MDNS.update();
-  #endif
-  doWiFiManager();
-  // put your main code here, to run repeatedly:
-}
-
-void doWiFiManager(){
-  // is auto timeout portal running
-  if(portalRunning){
-    wm.process(); // do processing
-
-    // check for timeout
-    if((millis()-startTime) > (timeout*1000)){
-      Serial.println("portaltimeout");
-      portalRunning = false;
-      if(startAP){
-        wm.stopConfigPortal();
-      }
-      else{
-        wm.stopWebPortal();
-      } 
-   }
-  }
-
-  // is configuration portal requested?
-  if(digitalRead(TRIGGER_PIN) == LOW && (!portalRunning)) {
-    if(startAP){
-      Serial.println("Button Pressed, Starting Config Portal");
-      wm.setConfigPortalBlocking(false);
-      wm.startConfigPortal();
-    }  
-    else{
-      Serial.println("Button Pressed, Starting Web Portal");
-      wm.startWebPortal();
-    }  
-    portalRunning = true;
-    startTime = millis();
-  }
-}
-
-

examples/Old_examples/AutoConnectWithFeedback/AutoConnectWithFeedback.ino

@@ -1,42 +0,0 @@
-#include <WiFiManager.h> // https://github.com/tzapu/WiFiManager
-
-void configModeCallback (WiFiManager *myWiFiManager) {
-  Serial.println("Entered config mode");
-  Serial.println(WiFi.softAPIP());
-  //if you used auto generated SSID, print it
-  Serial.println(myWiFiManager->getConfigPortalSSID());
-}
-
-void setup() {
-  // put your setup code here, to run once:
-  Serial.begin(115200);
-  
-  //WiFiManager
-  //Local intialization. Once its business is done, there is no need to keep it around
-  WiFiManager wifiManager;
-  //reset settings - for testing
-  //wifiManager.resetSettings();
-
-  //set callback that gets called when connecting to previous WiFi fails, and enters Access Point mode
-  wifiManager.setAPCallback(configModeCallback);
-
-  //fetches ssid and pass and tries to connect
-  //if it does not connect it starts an access point with the specified name
-  //here  "AutoConnectAP"
-  //and goes into a blocking loop awaiting configuration
-  if(!wifiManager.autoConnect()) {
-    Serial.println("failed to connect and hit timeout");
-    //reset and try again, or maybe put it to deep sleep
-    ESP.restart();
-    delay(1000);
-  } 
-
-  //if you get here you have connected to the WiFi
-  Serial.println("connected...yeey :)");
- 
-}
-
-void loop() {
-  // put your main code here, to run repeatedly:
-
-}

examples/Old_examples/AutoConnectWithReset/AutoConnectWithReset.ino

@@ -1,43 +0,0 @@
-#include <FS.h>          // this needs to be first, or it all crashes and burns...
-#include <WiFiManager.h> // https://github.com/tzapu/WiFiManager
-
-void setup() {
-  // put your setup code here, to run once:
-  Serial.begin(115200);
-  Serial.println();
-
-  //WiFiManager
-  //Local intialization. Once its business is done, there is no need to keep it around
-  WiFiManager wifiManager;
-
-  //exit after config instead of connecting
-  wifiManager.setBreakAfterConfig(true);
-
-  //reset settings - for testing
-  //wifiManager.resetSettings();
-
-
-  //tries to connect to last known settings
-  //if it does not connect it starts an access point with the specified name
-  //here  "AutoConnectAP" with password "password"
-  //and goes into a blocking loop awaiting configuration
-  if (!wifiManager.autoConnect("AutoConnectAP", "password")) {
-    Serial.println("failed to connect, we should reset as see if it connects");
-    delay(3000);
-    ESP.restart();
-    delay(5000);
-  }
-
-  //if you get here you have connected to the WiFi
-  Serial.println("connected...yeey :)");
-
-
-  Serial.println("local ip");
-  Serial.println(WiFi.localIP());
-}
-
-void loop() {
-  // put your main code here, to run repeatedly:
-
-
-}

examples/Old_examples/AutoConnectWithStaticIP/AutoConnectWithStaticIP.ino

@@ -1,71 +0,0 @@
-#include <FS.h>          // this needs to be first, or it all crashes and burns...
-#include <WiFiManager.h> // https://github.com/tzapu/WiFiManager
-
-/**************************************************************************************
- * this example shows how to set a static IP configuration for the ESP
- * although the IP shows in the config portal, the changes will revert 
- * to the IP set in the source file.
- * if you want the ability to configure and persist the new IP configuration
- * look at the FS examples, which save the config to file
- *************************************************************************************/
- 
-//default custom static IP
-//char static_ip[16] = "10.0.1.59";
-//char static_gw[16] = "10.0.1.1";
-//char static_sn[16] = "255.255.255.0";
-
-void setup() {
-  // put your setup code here, to run once:
-  Serial.begin(115200);
-  Serial.println();
-
-  //WiFiManager
-  //Local intialization. Once its business is done, there is no need to keep it around
-  WiFiManager wifiManager;
-
-  //reset settings - for testing
-  //wifiManager.resetSettings();
-
-  //set static ip
-  //block1 should be used for ESP8266 core 2.1.0 or newer, otherwise use block2
-
-  //start-block1
-  //IPAddress _ip,_gw,_sn;
-  //_ip.fromString(static_ip);
-  //_gw.fromString(static_gw);
-  //_sn.fromString(static_sn);
-  //end-block1
-
-  //start-block2
-  IPAddress _ip = IPAddress(10, 0, 1, 78);
-  IPAddress _gw = IPAddress(10, 0, 1, 1);
-  IPAddress _sn = IPAddress(255, 255, 255, 0);
-  //end-block2
-  
-  wifiManager.setSTAStaticIPConfig(_ip, _gw, _sn);
-
-
-  //tries to connect to last known settings
-  //if it does not connect it starts an access point with the specified name
-  //here  "AutoConnectAP" with password "password"
-  //and goes into a blocking loop awaiting configuration
-  if (!wifiManager.autoConnect("AutoConnectAP", "password")) {
-    Serial.println("failed to connect, we should reset as see if it connects");
-    delay(3000);
-    ESP.restart();
-    delay(5000);
-  }
-
-  //if you get here you have connected to the WiFi
-  Serial.println("connected...yeey :)");
-
-
-  Serial.println("local ip");
-  Serial.println(WiFi.localIP());
-}
-
-void loop() {
-  // put your main code here, to run repeatedly:
-
-
-}

examples/Old_examples/AutoConnectWithTimeout/AutoConnectWithTimeout.ino

@@ -1,38 +0,0 @@
-#include <WiFiManager.h> // https://github.com/tzapu/WiFiManager
-
-void setup() {
-  // put your setup code here, to run once:
-  Serial.begin(115200);
-  
-  //WiFiManager
-  //Local intialization. Once its business is done, there is no need to keep it around
-  WiFiManager wifiManager;
-  //reset settings - for testing
-  //wifiManager.resetSettings();
-
-  //sets timeout until configuration portal gets turned off
-  //useful to make it all retry or go to sleep
-  //in seconds
-  wifiManager.setConfigPortalTimeout(180);
-  
-  //fetches ssid and pass and tries to connect
-  //if it does not connect it starts an access point with the specified name
-  //here  "AutoConnectAP"
-  //and goes into a blocking loop awaiting configuration
-  if(!wifiManager.autoConnect("AutoConnectAP")) {
-    Serial.println("failed to connect and hit timeout");
-    delay(3000);
-    //reset and try again, or maybe put it to deep sleep
-    ESP.restart();
-    delay(5000);
-  } 
-
-  //if you get here you have connected to the WiFi
-  Serial.println("connected...yeey :)");
- 
-}
-
-void loop() {
-  // put your main code here, to run repeatedly:
-
-}

examples/OnDemand/OnDemandConfigPortal/OnDemandConfigPortal.ino

@@ -1,47 +0,0 @@
-/**
- * OnDemandConfigPortal.ino
- * example of running the configPortal AP manually, independantly from the captiveportal
- * trigger pin will start a configPortal AP for 120 seconds then turn it off.
- * 
- */
-#include <WiFiManager.h> // https://github.com/tzapu/WiFiManager
-
-// select which pin will trigger the configuration portal when set to LOW
-#define TRIGGER_PIN 0
-
-int timeout = 120; // seconds to run for
-
-void setup() {
-  WiFi.mode(WIFI_STA); // explicitly set mode, esp defaults to STA+AP  
-  // put your setup code here, to run once:
-  Serial.begin(115200);
-  Serial.println("\n Starting");
-  pinMode(TRIGGER_PIN, INPUT_PULLUP);
-}
-
-void loop() {
-  // is configuration portal requested?
-  if ( digitalRead(TRIGGER_PIN) == LOW) {
-    WiFiManager wm;    
-
-    //reset settings - for testing
-    //wm.resetSettings();
-  
-    // set configportal timeout
-    wm.setConfigPortalTimeout(timeout);
-
-    if (!wm.startConfigPortal("OnDemandAP")) {
-      Serial.println("failed to connect and hit timeout");
-      delay(3000);
-      //reset and try again, or maybe put it to deep sleep
-      ESP.restart();
-      delay(5000);
-    }
-
-    //if you get here you have connected to the WiFi
-    Serial.println("connected...yeey :)");
-
-  }
-
-  // put your main code here, to run repeatedly:
-}

examples/OnDemand/OnDemandWebPortal/OnDemandWebPortal.ino

@@ -1,51 +0,0 @@
-/**
- * OnDemandWebPortal.ino
- * example of running the webportal (always NON blocking)
- */
-#include <WiFiManager.h> // https://github.com/tzapu/WiFiManager
-
-// select which pin will trigger the configuration portal when set to LOW
-#define TRIGGER_PIN 0
-
-WiFiManager wm;
-
-bool portalRunning = false;
-
-void setup() {
-  WiFi.mode(WIFI_STA); // explicitly set mode, esp defaults to STA+AP 
-  // put your setup code here, to run once
-  Serial.begin(115200);
-  Serial.println("\n Starting");
-  pinMode(TRIGGER_PIN, INPUT_PULLUP);
-}
-
-void loop() {
-  checkButton();
-  // put your main code here, to run repeatedly:
-}
-
-void checkButton(){
-  // is auto timeout portal running
-  if(portalRunning){
-    wm.process();
-  }
-
-  // is configuration portal requested?
-  if(digitalRead(TRIGGER_PIN) == LOW) {
-    delay(50);
-    if(digitalRead(TRIGGER_PIN) == LOW) {
-      if(!portalRunning){
-        Serial.println("Button Pressed, Starting Portal");
-        wm.startWebPortal();
-        portalRunning = true;
-      }
-      else{
-        Serial.println("Button Pressed, Stopping Portal");
-        wm.stopWebPortal();
-        portalRunning = false;
-      }
-    }
-  }
-}
-
-

examples/Parameters/LittleFS/LittleFSParameters.ino

@@ -1,79 +0,0 @@
-/**
- * Basic example using LittleFS to store data
- */
-
-#include <Arduino.h>
-#include <LittleFS.h>
-#include <FS.h>
-
-String readFile(fs::FS &fs, const char * path){
-  Serial.printf("Reading file: %s\r\n", path);
-  File file = fs.open(path, "r");
-  if(!file || file.isDirectory()){
-    Serial.println("- empty file or failed to open file");
-    return String();
-  }
-  Serial.println("- read from file:");
-  String fileContent;
-  while(file.available()){
-    fileContent+=String((char)file.read());
-  }
-  file.close();
-  Serial.println(fileContent);
-  return fileContent;
-}
-void writeFile(fs::FS &fs, const char * path, const char * message){
-  Serial.printf("Writing file: %s\r\n", path);
-  File file = fs.open(path, "w");
-  if(!file){
-    Serial.println("- failed to open file for writing");
-    return;
-  }
-  if(file.print(message)){
-    Serial.println("- file written");
-  } else {
-    Serial.println("- write failed");
-  }
-  file.close();
-}
-
-int data = 4; 
-
-#include <WiFiManager.h>
-#define TRIGGER_PIN 2
-int timeout = 120; // seconds to run for
-
-void setup() {
-if (!LittleFS.begin()) { //to start littlefs
-Serial.println("LittleFS mount failed");
-return;
-}
-data = readFile(LittleFS, "/data.txt").toInt();
-WiFi.mode(WIFI_STA); // explicitly set mode, esp defaults to STA+AP  
-  // put your setup code here, to run once:
-  pinMode(TRIGGER_PIN, INPUT_PULLUP);
-  WiFiManager wm;
-  //wm.resetSettings();
-  bool res;
-  res = wm.autoConnect("Setup");
-  if(!res) {
-     Serial.println("Failed to connect");
-     // ESP.restart();
-  } 
-
-}
-
-void loop() {
-if ( digitalRead(TRIGGER_PIN) == LOW) {
-    WiFiManager wm;    
-    //wm.resetSettings();
-    wm.setConfigPortalTimeout(timeout);
-    if (!wm.startConfigPortal("Sharmander")) {
-      Serial.println("failed to connect and hit timeout");
-      delay(3000);
-      ESP.restart();
-      delay(5000);
-    }
-    Serial.println("connected...yeey :)");
-}
-}

examples/Parameters/SPIFFS/AutoConnectWithFSParameters/AutoConnectWithFSParameters.ino

@@ -1,169 +0,0 @@
-#include <FS.h>                   //this needs to be first, or it all crashes and burns...
-#include <WiFiManager.h>          //https://github.com/tzapu/WiFiManager
-
-#ifdef ESP32
-  #include <SPIFFS.h>
-#endif
-
-#include <ArduinoJson.h>          //https://github.com/bblanchon/ArduinoJson
-
-//define your default values here, if there are different values in config.json, they are overwritten.
-char mqtt_server[40];
-char mqtt_port[6] = "8080";
-char api_token[34] = "YOUR_API_TOKEN";
-
-//flag for saving data
-bool shouldSaveConfig = false;
-
-//callback notifying us of the need to save config
-void saveConfigCallback () {
-  Serial.println("Should save config");
-  shouldSaveConfig = true;
-}
-
-void setup() {
-  // put your setup code here, to run once:
-  Serial.begin(115200);
-  Serial.println();
-
-  //clean FS, for testing
-  //SPIFFS.format();
-
-  //read configuration from FS json
-  Serial.println("mounting FS...");
-
-  if (SPIFFS.begin()) {
-    Serial.println("mounted file system");
-    if (SPIFFS.exists("/config.json")) {
-      //file exists, reading and loading
-      Serial.println("reading config file");
-      File configFile = SPIFFS.open("/config.json", "r");
-      if (configFile) {
-        Serial.println("opened config file");
-        size_t size = configFile.size();
-        // Allocate a buffer to store contents of the file.
-        std::unique_ptr<char[]> buf(new char[size]);
-
-        configFile.readBytes(buf.get(), size);
-
- #if defined(ARDUINOJSON_VERSION_MAJOR) && ARDUINOJSON_VERSION_MAJOR >= 6
-        DynamicJsonDocument json(1024);
-        auto deserializeError = deserializeJson(json, buf.get());
-        serializeJson(json, Serial);
-        if ( ! deserializeError ) {
-#else
-        DynamicJsonBuffer jsonBuffer;
-        JsonObject& json = jsonBuffer.parseObject(buf.get());
-        json.printTo(Serial);
-        if (json.success()) {
-#endif
-          Serial.println("\nparsed json");
-          strcpy(mqtt_server, json["mqtt_server"]);
-          strcpy(mqtt_port, json["mqtt_port"]);
-          strcpy(api_token, json["api_token"]);
-        } else {
-          Serial.println("failed to load json config");
-        }
-        configFile.close();
-      }
-    }
-  } else {
-    Serial.println("failed to mount FS");
-  }
-  //end read
-
-  // The extra parameters to be configured (can be either global or just in the setup)
-  // After connecting, parameter.getValue() will get you the configured value
-  // id/name placeholder/prompt default length
-  WiFiManagerParameter custom_mqtt_server("server", "mqtt server", mqtt_server, 40);
-  WiFiManagerParameter custom_mqtt_port("port", "mqtt port", mqtt_port, 6);
-  WiFiManagerParameter custom_api_token("apikey", "API token", api_token, 32);
-
-  //WiFiManager
-  //Local intialization. Once its business is done, there is no need to keep it around
-  WiFiManager wifiManager;
-
-  //set config save notify callback
-  wifiManager.setSaveConfigCallback(saveConfigCallback);
-
-  //set static ip
-  wifiManager.setSTAStaticIPConfig(IPAddress(10, 0, 1, 99), IPAddress(10, 0, 1, 1), IPAddress(255, 255, 255, 0));
-
-  //add all your parameters here
-  wifiManager.addParameter(&custom_mqtt_server);
-  wifiManager.addParameter(&custom_mqtt_port);
-  wifiManager.addParameter(&custom_api_token);
-
-  //reset settings - for testing
-  //wifiManager.resetSettings();
-
-  //set minimu quality of signal so it ignores AP's under that quality
-  //defaults to 8%
-  //wifiManager.setMinimumSignalQuality();
-
-  //sets timeout until configuration portal gets turned off
-  //useful to make it all retry or go to sleep
-  //in seconds
-  //wifiManager.setTimeout(120);
-
-  //fetches ssid and pass and tries to connect
-  //if it does not connect it starts an access point with the specified name
-  //here  "AutoConnectAP"
-  //and goes into a blocking loop awaiting configuration
-  if (!wifiManager.autoConnect("AutoConnectAP", "password")) {
-    Serial.println("failed to connect and hit timeout");
-    delay(3000);
-    //reset and try again, or maybe put it to deep sleep
-    ESP.restart();
-    delay(5000);
-  }
-
-  //if you get here you have connected to the WiFi
-  Serial.println("connected...yeey :)");
-
-  //read updated parameters
-  strcpy(mqtt_server, custom_mqtt_server.getValue());
-  strcpy(mqtt_port, custom_mqtt_port.getValue());
-  strcpy(api_token, custom_api_token.getValue());
-  Serial.println("The values in the file are: ");
-  Serial.println("\tmqtt_server : " + String(mqtt_server));
-  Serial.println("\tmqtt_port : " + String(mqtt_port));
-  Serial.println("\tapi_token : " + String(api_token));
-
-  //save the custom parameters to FS
-  if (shouldSaveConfig) {
-    Serial.println("saving config");
- #if defined(ARDUINOJSON_VERSION_MAJOR) && ARDUINOJSON_VERSION_MAJOR >= 6
-    DynamicJsonDocument json(1024);
-#else
-    DynamicJsonBuffer jsonBuffer;
-    JsonObject& json = jsonBuffer.createObject();
-#endif
-    json["mqtt_server"] = mqtt_server;
-    json["mqtt_port"] = mqtt_port;
-    json["api_token"] = api_token;
-
-    File configFile = SPIFFS.open("/config.json", "w");
-    if (!configFile) {
-      Serial.println("failed to open config file for writing");
-    }
-
-#if defined(ARDUINOJSON_VERSION_MAJOR) && ARDUINOJSON_VERSION_MAJOR >= 6
-    serializeJson(json, Serial);
-    serializeJson(json, configFile);
-#else
-    json.printTo(Serial);
-    json.printTo(configFile);
-#endif
-    configFile.close();
-    //end save
-  }
-
-  Serial.println("local ip");
-  Serial.println(WiFi.localIP());
-}
-
-void loop() {
-  // put your main code here, to run repeatedly:
-
-}

examples/Parameters/SPIFFS/AutoConnectWithFSParametersAndCustomIP/AutoConnectWithFSParametersAndCustomIP.ino

@@ -1,194 +0,0 @@
-#include <FS.h>                   //this needs to be first, or it all crashes and burns...
-
-#include <WiFiManager.h>          //https://github.com/tzapu/WiFiManager
-
-#ifdef ESP32
-  #include <SPIFFS.h>
-#endif
-
-#include <ArduinoJson.h>          //https://github.com/bblanchon/ArduinoJson
-
-//define your default values here, if there are different values in config.json, they are overwritten.
-//length should be max size + 1
-char mqtt_server[40];
-char mqtt_port[6] = "8080";
-char api_token[34] = "YOUR_APITOKEN";
-//default custom static IP
-char static_ip[16] = "10.0.1.56";
-char static_gw[16] = "10.0.1.1";
-char static_sn[16] = "255.255.255.0";
-
-//flag for saving data
-bool shouldSaveConfig = false;
-
-//callback notifying us of the need to save config
-void saveConfigCallback () {
-  Serial.println("Should save config");
-  shouldSaveConfig = true;
-}
-
-void setup() {
-  // put your setup code here, to run once:
-  Serial.begin(115200);
-  Serial.println();
-
-  //clean FS, for testing
-  //SPIFFS.format();
-
-  //read configuration from FS json
-  Serial.println("mounting FS...");
-
-  if (SPIFFS.begin()) {
-    Serial.println("mounted file system");
-    if (SPIFFS.exists("/config.json")) {
-      //file exists, reading and loading
-      Serial.println("reading config file");
-      File configFile = SPIFFS.open("/config.json", "r");
-      if (configFile) {
-        Serial.println("opened config file");
-        size_t size = configFile.size();
-        // Allocate a buffer to store contents of the file.
-        std::unique_ptr<char[]> buf(new char[size]);
-
-        configFile.readBytes(buf.get(), size);
- #if defined(ARDUINOJSON_VERSION_MAJOR) && ARDUINOJSON_VERSION_MAJOR >= 6
-        DynamicJsonDocument json(1024);
-        auto deserializeError = deserializeJson(json, buf.get());
-        serializeJson(json, Serial);
-        if ( ! deserializeError ) {
-#else
-        DynamicJsonBuffer jsonBuffer;
-        JsonObject& json = jsonBuffer.parseObject(buf.get());
-        json.printTo(Serial);
-        if (json.success()) {
-#endif
-          Serial.println("\nparsed json");
-
-          strcpy(mqtt_server, json["mqtt_server"]);
-          strcpy(mqtt_port, json["mqtt_port"]);
-          strcpy(api_token, json["api_token"]);
-
-          if (json["ip"]) {
-            Serial.println("setting custom ip from config");
-            strcpy(static_ip, json["ip"]);
-            strcpy(static_gw, json["gateway"]);
-            strcpy(static_sn, json["subnet"]);
-            Serial.println(static_ip);
-          } else {
-            Serial.println("no custom ip in config");
-          }
-        } else {
-          Serial.println("failed to load json config");
-        }
-      }
-    }
-  } else {
-    Serial.println("failed to mount FS");
-  }
-  //end read
-  Serial.println(static_ip);
-  Serial.println(api_token);
-  Serial.println(mqtt_server);
-
-
-  // The extra parameters to be configured (can be either global or just in the setup)
-  // After connecting, parameter.getValue() will get you the configured value
-  // id/name placeholder/prompt default length
-  WiFiManagerParameter custom_mqtt_server("server", "mqtt server", mqtt_server, 40);
-  WiFiManagerParameter custom_mqtt_port("port", "mqtt port", mqtt_port, 5);
-  WiFiManagerParameter custom_api_token("apikey", "API token", api_token, 34);
-
-  //WiFiManager
-  //Local intialization. Once its business is done, there is no need to keep it around
-  WiFiManager wifiManager;
-
-  //set config save notify callback
-  wifiManager.setSaveConfigCallback(saveConfigCallback);
-
-  //set static ip
-  IPAddress _ip, _gw, _sn;
-  _ip.fromString(static_ip);
-  _gw.fromString(static_gw);
-  _sn.fromString(static_sn);
-
-  wifiManager.setSTAStaticIPConfig(_ip, _gw, _sn);
-
-  //add all your parameters here
-  wifiManager.addParameter(&custom_mqtt_server);
-  wifiManager.addParameter(&custom_mqtt_port);
-  wifiManager.addParameter(&custom_api_token);
-
-  //reset settings - for testing
-  //wifiManager.resetSettings();
-
-  //set minimu quality of signal so it ignores AP's under that quality
-  //defaults to 8%
-  wifiManager.setMinimumSignalQuality();
-
-  //sets timeout until configuration portal gets turned off
-  //useful to make it all retry or go to sleep
-  //in seconds
-  //wifiManager.setTimeout(120);
-
-  //fetches ssid and pass and tries to connect
-  //if it does not connect it starts an access point with the specified name
-  //here  "AutoConnectAP"
-  //and goes into a blocking loop awaiting configuration
-  if (!wifiManager.autoConnect("AutoConnectAP", "password")) {
-    Serial.println("failed to connect and hit timeout");
-    delay(3000);
-    //reset and try again, or maybe put it to deep sleep
-    ESP.restart();
-    delay(5000);
-  }
-
-  //if you get here you have connected to the WiFi
-  Serial.println("connected...yeey :)");
-
-  //read updated parameters
-  strcpy(mqtt_server, custom_mqtt_server.getValue());
-  strcpy(mqtt_port, custom_mqtt_port.getValue());
-  strcpy(api_token, custom_api_token.getValue());
-
-  //save the custom parameters to FS
-  if (shouldSaveConfig) {
-    Serial.println("saving config");
- #if defined(ARDUINOJSON_VERSION_MAJOR) && ARDUINOJSON_VERSION_MAJOR >= 6
-    DynamicJsonDocument json(1024);
-#else
-    DynamicJsonBuffer jsonBuffer;
-    JsonObject& json = jsonBuffer.createObject();
-#endif
-    json["mqtt_server"] = mqtt_server;
-    json["mqtt_port"] = mqtt_port;
-    json["api_token"] = api_token;
-
-    json["ip"] = WiFi.localIP().toString();
-    json["gateway"] = WiFi.gatewayIP().toString();
-    json["subnet"] = WiFi.subnetMask().toString();
-
-    File configFile = SPIFFS.open("/config.json", "w");
-    if (!configFile) {
-      Serial.println("failed to open config file for writing");
-    }
-
- #if defined(ARDUINOJSON_VERSION_MAJOR) && ARDUINOJSON_VERSION_MAJOR >= 6
-    serializeJson(json, Serial);
-    serializeJson(json, configFile);
-#else
-    json.printTo(Serial);
-    json.printTo(configFile);
-#endif
-    configFile.close();
-    //end save
-  }
-
-  Serial.println("local ip");
-  Serial.println(WiFi.localIP());
-  Serial.println(WiFi.gatewayIP());
-  Serial.println(WiFi.subnetMask());
-}
-
-void loop() {
-  // put your main code here, to run repeatedly:
-}

examples/ParamsChildClass/ParamsChildClass.ino

@@ -1,143 +0,0 @@
-/**
- * WiFiManagerParameter child class example
- */
-#include <WiFiManager.h> // https://github.com/tzapu/WiFiManager
-#include <Arduino.h>
-#include <EEPROM.h>
-
-#define SETUP_PIN 0
-
-class IPAddressParameter : public WiFiManagerParameter {
-public:
-    IPAddressParameter(const char *id, const char *placeholder, IPAddress address)
-        : WiFiManagerParameter("") {
-        init(id, placeholder, address.toString().c_str(), 16, "", WFM_LABEL_BEFORE);
-    }
-
-    bool getValue(IPAddress &ip) {
-        return ip.fromString(WiFiManagerParameter::getValue());
-    }
-};
-
-class IntParameter : public WiFiManagerParameter {
-public:
-    IntParameter(const char *id, const char *placeholder, long value, const uint8_t length = 10)
-        : WiFiManagerParameter("") {
-        init(id, placeholder, String(value).c_str(), length, "", WFM_LABEL_BEFORE);
-    }
-
-    long getValue() {
-        return String(WiFiManagerParameter::getValue()).toInt();
-    }
-};
-
-class FloatParameter : public WiFiManagerParameter {
-public:
-    FloatParameter(const char *id, const char *placeholder, float value, const uint8_t length = 10)
-        : WiFiManagerParameter("") {
-        init(id, placeholder, String(value).c_str(), length, "", WFM_LABEL_BEFORE);
-    }
-
-    float getValue() {
-        return String(WiFiManagerParameter::getValue()).toFloat();
-    }
-};
-
-struct Settings {
-    float f;
-    int i;
-    char s[20];
-    uint32_t ip;
-} sett;
-
-
-void setup() {
-    WiFi.mode(WIFI_STA); // explicitly set mode, esp defaults to STA+AP    
-    pinMode(SETUP_PIN, INPUT_PULLUP);
-    Serial.begin(115200); 
-
-    //Delay to push SETUP button
-    Serial.println("Press setup button");
-    for (int sec = 3; sec > 0; sec--) {
-        Serial.print(sec);
-        Serial.print("..");
-        delay(1000);
-    }
-
-    // warning for example only, this will initialize empty memory into your vars
-    // always init flash memory or add some checksum bits
-    EEPROM.begin( 512 );
-    EEPROM.get(0, sett);
-    Serial.println("Settings loaded");
-    
-    if (digitalRead(SETUP_PIN) == LOW) {  
-        // Button pressed 
-        Serial.println("SETUP");
-
-        WiFiManager wm;
-        
-        sett.s[19] = '\0';   //add null terminator at the end cause overflow
-        WiFiManagerParameter param_str( "str", "param_string",  sett.s, 20);
-        FloatParameter param_float( "float", "param_float",  sett.f);
-        IntParameter param_int( "int", "param_int",  sett.i);
-
-        IPAddress ip(sett.ip);
-        IPAddressParameter param_ip("ip", "param_ip", ip);
-
-        wm.addParameter( &param_str );
-        wm.addParameter( &param_float );
-        wm.addParameter( &param_int );
-        wm.addParameter( &param_ip );
-
-        //SSID & password parameters already included
-        wm.startConfigPortal();
-
-        strncpy(sett.s, param_str.getValue(), 20);
-        sett.s[19] = '\0'; 
-        sett.f = param_float.getValue();
-        sett.i = param_int.getValue();
-
-        Serial.print("String param: ");
-        Serial.println(sett.s);
-        Serial.print("Float param: ");
-        Serial.println(sett.f);
-        Serial.print("Int param: ");
-        Serial.println(sett.i, DEC);
-        
-        if (param_ip.getValue(ip)) {
-            sett.ip = ip;
-
-            Serial.print("IP param: ");
-            Serial.println(ip);
-        } else {
-            Serial.println("Incorrect IP");
-        }
-
-        EEPROM.put(0, sett);
-        if (EEPROM.commit()) {
-            Serial.println("Settings saved");
-        } else {
-            Serial.println("EEPROM error");
-        }
-    } 
-    else {  
-        Serial.println("WORK");
-
-        //connect to saved SSID
-        WiFi.begin();  
-
-        //do smth
-        Serial.print("String param: ");
-        Serial.println(sett.s);
-        Serial.print("Float param: ");
-        Serial.println(sett.f);
-        Serial.print("Int param: ");
-        Serial.println(sett.i, DEC);
-        Serial.print("IP param: ");
-        IPAddress ip(sett.ip);
-        Serial.println(ip);
-    }
-}
-
-void loop() {
-}

examples/README.md

@@ -0,0 +1,29 @@
+# WiFiManager examples
+
+Every directory below is a standalone PlatformIO project. Build it from the repository root or the example directory:
+
+```bash
+pio run -d examples/BasicPortal -e esp8266
+pio run -d examples/BasicPortal -e esp8266 -t upload
+pio device monitor -d examples/BasicPortal -e esp8266
+```
+
+Choose `esp32` for an ESP32 development board. The examples use the checked-out WiFiManager source, so they are also useful while developing this fork.
+
+| Example | Start here when you want to… |
+| --- | --- |
+| [Basic Portal](BasicPortal/) | provision one board through the normal saved-network-or-portal flow |
+| [Custom Portal Content](CustomPortalContent/) | add application settings and useful status cards to the built-in portal |
+| [Branded Portal](BrandedPortal/) | change the portal’s identity, logo, and semantic visual theme |
+| [Station Profiles](StationProfiles/) | remember a primary Wi-Fi network and one fallback in application-owned EEPROM storage |
+
+The portal examples intentionally begin with no station credentials. On first boot, connect to the matching setup network and open `http://192.168.4.1/`.
+
+| Example | Setup network | Password |
+| --- | --- | --- |
+| Basic Portal | WiFiManager Basic | example-pass |
+| Custom Portal Content | WiFiManager Content | example-pass |
+| Branded Portal | Temperature Monitor | none |
+| Station Profiles | WiFiManager Profiles | example-pass |
+
+Back to the [project overview](../README.md).

examples/StationProfiles/README.md

@@ -0,0 +1,9 @@
+# Station Profiles
+
+This example gives WiFiManager a small application-owned EEPROM store. The portal accepts a required primary Wi-Fi network and an optional fallback, verifies a submitted network before saving it, then remembers the last successful choice across restarts.
+
+On a blank board, connect to **WiFiManager Profiles** with password **example-pass** and open `http://192.168.4.1/`. Enter a primary network and, if useful, one fallback. After a successful connection, restart the board to confirm that it tries the saved profiles before reopening the portal.
+
+`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), [primary and fallback Wi-Fi](../../docs/recipes/PRIMARY_AND_FALLBACK_WIFI.md), and the shared [example guide](../README.md).

examples/StationProfiles/StationProfiles.ino

@@ -0,0 +1,68 @@
+#include <Arduino.h>
+#include <EEPROM.h>
+#include <WiFiManager.h>
+
+namespace {
+constexpr uint32_t kStoreMagic = 0x574D5031;  // "WMP1"
+
+struct StoredProfiles {
+    uint32_t magic;
+    WiFiManagerStationProfiles profiles;
+};
+
+// The application owns persistence; WiFiManager only chooses and verifies profiles.
+class EepromProfileStore final : public WiFiManagerStationProfileStore {
+public:
+    bool begin() {
+#if defined(ESP32)
+        // ESP32 EEPROM emulation can fail to reserve its backing region.
+        return EEPROM.begin(sizeof(StoredProfiles));
+#else
+        EEPROM.begin(sizeof(StoredProfiles));
+        return true;
+#endif
+    }
+
+    bool load(WiFiManagerStationProfiles& profiles) override {
+        StoredProfiles stored{};
+        EEPROM.get(0, stored);
+        if (stored.magic != kStoreMagic) {
+            // Treat erased or unrelated EEPROM as having no profiles.
+            return false;
+        }
+        profiles = stored.profiles;
+        return true;
+    }
+
+    bool save(const WiFiManagerStationProfiles& profiles) override {
+        // WiFiManager calls this only after it has verified the submitted candidate.
+        EEPROM.put(0, StoredProfiles{kStoreMagic, profiles});
+        return EEPROM.commit();
+    }
+
+    bool clear() override {
+        EEPROM.put(0, StoredProfiles{});
+        return EEPROM.commit();
+    }
+};
+
+EepromProfileStore profileStore;
+WiFiManager portal;
+}  // namespace
+
+void setup() {
+    Serial.begin(115200);
+    if (!profileStore.begin()) {
+        Serial.println("Could not initialise EEPROM profile storage");
+        return;
+    }
+
+    // Both objects are global because station retries continue after setup() returns.
+    portal.setStationProfileStore(&profileStore);
+    portal.setStationRecoveryInterval(30000);
+    portal.startStationConnection("WiFiManager Profiles", "example-pass");
+}
+
+void loop() {
+    portal.process();  // Advances connection attempts and serves provisioning when needed.
+}

examples/StationProfiles/platformio.ini

@@ -0,0 +1,26 @@
+[platformio]
+default_envs = esp8266
+src_dir = .
+
+[common]
+framework = arduino
+lib_ldf_mode = deep+
+lib_deps =
+    WiFiManager=symlink://../..
+
+[env:esp8266]
+extends = common
+platform = espressif8266
+board = d1_mini
+platform_packages =
+    platformio/framework-arduinoespressif8266 @ https://github.com/esp8266/Arduino.git#521ae60a89e64bb0d1eb7a0b7addf620ced5cad3
+
+[env:esp32]
+extends = common
+platform = https://github.com/pioarduino/platform-espressif32/releases/download/55.03.311/platform-espressif32.zip
+board = esp32dev
+build_unflags = -std=gnu++11
+build_flags =
+    -std=gnu++14
+    -DSOC_WIFI_SUPPORTED=1
+    -I${platformio.packages_dir}/framework-arduinoespressif32/libraries/Network/src

examples/Super/OnDemandConfigPortal/OnDemandConfigPortal.ino

@@ -1,444 +0,0 @@
-/**
- * This is a kind of unit test for DEV for now
- * It contains many of the public methods
- * 
- */
-#include <WiFiManager.h> // https://github.com/tzapu/WiFiManager
-#include <time.h>
-#include <stdio.h>
-
-#define USEOTA
-// enable OTA
-#ifdef USEOTA
-#include <WiFiUdp.h>
-#include <ArduinoOTA.h>
-#endif
-
-const char* modes[] = { "NULL", "STA", "AP", "STA+AP" };
-
-unsigned long mtime = 0;
-
-
-WiFiManager wm;
-
-
-// TEST OPTION FLAGS
-bool TEST_CP         = false; // always start the configportal, even if ap found
-int  TESP_CP_TIMEOUT = 90; // test cp timeout
-
-bool TEST_NET        = true; // do a network test after connect, (gets ntp time)
-bool ALLOWONDEMAND   = true; // enable on demand
-int  ONDDEMANDPIN    = 0; // gpio for button
-bool WMISBLOCKING    = true; // use blocking or non blocking mode, non global params wont work in non blocking
-
-uint8_t BUTTONFUNC   = 1; // 0 resetsettings, 1 configportal, 2 autoconnect
-
-// char ssid[] = "*************";  //  your network SSID (name)
-// char pass[] = "********";       // your network password
-
-
-//callbacks
-  // called after AP mode and config portal has started
-  //  setAPCallback( std::function<void(WiFiManager*)> func );
-  // called after webserver has started
-  //  setWebServerCallback( std::function<void()> func );
-  // called when settings reset have been triggered
-  //  setConfigResetCallback( std::function<void()> func );
-  // called when wifi settings have been changed and connection was successful ( or setBreakAfterConfig(true) )
-  //  setSaveConfigCallback( std::function<void()> func );
-  // called when saving either params-in-wifi or params page
-  //  setSaveParamsCallback( std::function<void()> func );
-  // called when saving params-in-wifi or params before anything else happens (eg wifi)
-  //  setPreSaveConfigCallback( std::function<void()> func );
-  // called just before doing OTA update
-  //  setPreOtaUpdateCallback( std::function<void()> func );
-
-void saveWifiCallback(){
-  Serial.println("[CALLBACK] saveCallback fired");
-}
-
-//gets called when WiFiManager enters configuration mode
-void configModeCallback (WiFiManager *myWiFiManager) {
-  Serial.println("[CALLBACK] configModeCallback fired");
-  // myWiFiManager->setAPStaticIPConfig(IPAddress(10,0,1,1), IPAddress(10,0,1,1), IPAddress(255,255,255,0)); 
-  // Serial.println(WiFi.softAPIP());
-  //if you used auto generated SSID, print it
-  // Serial.println(myWiFiManager->getConfigPortalSSID());
-  // 
-  // esp_wifi_set_bandwidth(WIFI_IF_AP, WIFI_BW_HT20);
-}
-
-void saveParamCallback(){
-  Serial.println("[CALLBACK] saveParamCallback fired");
-  // wm.stopConfigPortal();
-}
-
-void bindServerCallback(){
-  wm.server->on("/custom",handleRoute);
-
-  // you can override wm route endpoints, I have not found a way to remove handlers, but this would let you disable them or add auth etc.
-  // wm.server->on("/info",handleNotFound);
-  // wm.server->on("/update",handleNotFound);
-  wm.server->on("/erase",handleNotFound); // disable erase
-}
-
-void handleRoute(){
-  Serial.println("[HTTP] handle custom route");
-  wm.server->send(200, "text/plain", "hello from user code");
-}
-
-void handleNotFound(){
-  Serial.println("[HTTP] override handle route");
-  wm.handleNotFound();
-}
-
-void handlePreOtaUpdateCallback(){
-  Update.onProgress([](unsigned int progress, unsigned int total) {
-        Serial.printf("CUSTOM Progress: %u%%\r", (progress / (total / 100)));
-  });
-}
-
-void setup() {
-  // WiFi.mode(WIFI_STA); // explicitly set mode, esp can default to STA+AP
-  
-  // put your setup code here, to run once:
-  Serial.begin(115200);
-  delay(3000);
-  // Serial.setDebugOutput(true);
-
-  // WiFi.setTxPower(WIFI_POWER_8_5dBm);
-
-  Serial.println("\n Starting");
-  // WiFi.setSleepMode(WIFI_NONE_SLEEP); // disable sleep, can improve ap stability
-
-  Serial.println("Error - TEST");
-  Serial.println("Information- - TEST");
-
-  Serial.println("[ERROR]  TEST");
-  Serial.println("[INFORMATION] TEST");  
-
-
-  // WiFi.setScanMethod(WIFI_ALL_CHANNEL_SCAN); // wifi_scan_method_t scanMethod
-  // WiFi.setSortMethod(WIFI_CONNECT_AP_BY_SIGNAL); // wifi_sort_method_t sortMethod - WIFI_CONNECT_AP_BY_SIGNAL,WIFI_CONNECT_AP_BY_SECURITY
-  // WiFi.setMinSecurity(WIFI_AUTH_WPA2_PSK);
-
-  wm.setDebugOutput(true, WM_DEBUG_DEV);
-  wm.debugPlatformInfo();
-
-  //reset settings - for testing
-  // wm.resetSettings();
-  // wm.erase();
-
-  // setup some parameters
-
-  WiFiManagerParameter custom_html("<p style=\"color:pink;font-weight:Bold;\">This Is Custom HTML</p>"); // only custom html
-  WiFiManagerParameter custom_mqtt_server("server", "mqtt server", "", 40);
-  WiFiManagerParameter custom_mqtt_port("port", "mqtt port", "", 6);
-  WiFiManagerParameter custom_token("api_token", "api token", "", 16);
-  WiFiManagerParameter custom_tokenb("invalid token", "invalid token", "", 0); // id is invalid, cannot contain spaces
-  WiFiManagerParameter custom_ipaddress("input_ip", "input IP", "", 15,"pattern='\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}'"); // custom input attrs (ip mask)
-  WiFiManagerParameter custom_input_type("input_pwd", "input pass", "", 15,"type='password'"); // custom input attrs (ip mask)
-
-  const char _customHtml_checkbox[] = "type=\"checkbox\""; 
-  WiFiManagerParameter custom_checkbox("my_checkbox", "My Checkbox", "T", 2, _customHtml_checkbox, WFM_LABEL_AFTER);
-
-  const char *bufferStr = R"(
-  <!-- INPUT CHOICE -->
-  <br/>
-  <p>Select Choice</p>
-  <input style='display: inline-block;' type='radio' id='choice1' name='program_selection' value='1'>
-  <label for='choice1'>Choice1</label><br/>
-  <input style='display: inline-block;' type='radio' id='choice2' name='program_selection' value='2'>
-  <label for='choice2'>Choice2</label><br/>
-
-  <!-- INPUT SELECT -->
-  <br/>
-  <label for='input_select'>Label for Input Select</label>
-  <select name="input_select" id="input_select" class="button">
-  <option value="0">Option 1</option>
-  <option value="1" selected>Option 2</option>
-  <option value="2">Option 3</option>
-  <option value="3">Option 4</option>
-  </select>
-  )";
-
-  WiFiManagerParameter custom_html_inputs(bufferStr);
-
-  // callbacks
-  wm.setAPCallback(configModeCallback);
-  wm.setWebServerCallback(bindServerCallback);
-  wm.setSaveConfigCallback(saveWifiCallback);
-  wm.setSaveParamsCallback(saveParamCallback);
-  wm.setPreOtaUpdateCallback(handlePreOtaUpdateCallback);
-
-  // add all your parameters here
-  wm.addParameter(&custom_html);
-  wm.addParameter(&custom_mqtt_server);
-  wm.addParameter(&custom_mqtt_port);
-  wm.addParameter(&custom_token);
-  wm.addParameter(&custom_tokenb);
-  wm.addParameter(&custom_ipaddress);
-  wm.addParameter(&custom_checkbox);
-  wm.addParameter(&custom_input_type);
-
-  wm.addParameter(&custom_html_inputs);
-
-  // set values later if you want
-  custom_html.setValue("test",4);
-  custom_token.setValue("test",4);
-
-  // const char* icon = "
-  // <link rel='icon' type='image/png' sizes='16x16' href='data:image/png;base64,
-  // iVBORw0KGgoAAAANSUhEUgAAABAAAAAQBAMAAADt3eJSAAAAMFBMVEU0OkArMjhobHEoPUPFEBIu
-  // O0L+AAC2FBZ2JyuNICOfGx7xAwTjCAlCNTvVDA1aLzQ3COjMAAAAVUlEQVQI12NgwAaCDSA0888G
-  // CItjn0szWGBJTVoGSCjWs8TleQCQYV95evdxkFT8Kpe0PLDi5WfKd4LUsN5zS1sKFolt8bwAZrCa
-  // GqNYJAgFDEpQAAAzmxafI4vZWwAAAABJRU5ErkJggg==' />";
-
-
-  // set custom html head content , inside <head>
-  // examples of favicon, or meta tags etc
-  // const char* headhtml = "<link rel='icon' type='image/png' href='data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAADQElEQVRoQ+2YjW0VQQyE7Q6gAkgFkAogFUAqgFQAVACpAKiAUAFQAaECQgWECggVGH1PPrRvn3dv9/YkFOksoUhhfzwz9ngvKrc89JbnLxuA/63gpsCmwCADWwkNEji8fVNgotDM7osI/x777x5l9F6JyB8R4eeVql4P0y8yNsjM7KGIPBORp558T04A+CwiH1UVUItiUQmZ2XMReSEiAFgjAPBeVS96D+sCYGaUx4cFbLfmhSpnqnrZuqEJgJnd8cQplVLciAgX//Cf0ToIeOB9wpmloLQAwpnVmAXgdf6pwjpJIz+XNoeZQQZlODV9vhc1Tuf6owrAk/8qIhFbJH7eI3eEzsvydQEICqBEkZwiALfF70HyHPpqScPV5HFjeFu476SkRA0AzOfy4hYwstj2ZkDgaphE7m6XqnoS7Q0BOPs/sw0kDROzjdXcCMFCNwzIy0EcRcOvBACfh4k0wgOmBX4xjfmk4DKTS31hgNWIKBCI8gdzogTgjYjQWFMw+o9LzJoZ63GUmjWm2wGDc7EvDDOj/1IVMIyD9SUAL0WEhpriRlXv5je5S+U1i2N88zdPuoVkeB+ls4SyxCoP3kVm9jsjpEsBLoOBNC5U9SwpGdakFkviuFP1keblATkTENTYcxkzgxTKOI3jyDxqLkQT87pMA++H3XvJBYtsNbBN6vuXq5S737WqHkW1VgMQNXJ0RshMqbbT33sJ5kpHWymzcJjNTeJIymJZtSQd9NHQHS1vodoFoTMkfbJzpRnLzB2vi6BZAJxWaCr+62BC+jzAxVJb3dmmiLzLwZhZNPE5e880Suo2AZgB8e8idxherqUPnT3brBDTlPxO3Z66rVwIwySXugdNd+5ejhqp/+NmgIwGX3Py3QBmlEi54KlwmjkOytQ+iJrLJj23S4GkOeecg8G091no737qvRRdzE+HLALQoMTBbJgBsCj5RSWUlUVJiZ4SOljb05eLFWgoJ5oY6yTyJp62D39jDANoKKcSocPJD5dQYzlFAFZJflUArgTPZKZwLXAnHmerfJquUkKZEgyzqOb5TuDt1P3nwxobqwPocZA11m4A1mBx5IxNgRH21ti7KbAGiyNn3HoF/gJ0w05A8xclpwAAAABJRU5ErkJggg==' />";
-  // const char* headhtml = "<meta name='color-scheme' content='dark light'><style></style><script></script>";
-  // wm.setCustomHeadElement(headhtml);
-
-  // set custom html menu content , inside menu item "custom", see setMenu()
-  const char* menuhtml = "<form action='/custom' method='get'><button>Custom</button></form><br/>\n";
-  wm.setCustomMenuHTML(menuhtml);
-
-  // invert theme, dark
-  wm.setDarkMode(true);
-
-  // show scan RSSI as percentage, instead of signal stength graphic
-  // wm.setScanDispPerc(true);
-
-/*
-  Set cutom menu via menu[] or vector
-  const char* menu[] = {"wifi","wifinoscan","info","param","close","sep","erase","restart","exit"};
-  wm.setMenu(menu,9); // custom menu array must provide length
-*/
-
-  std::vector<const char *> menu = {"wifi","wifinoscan","info","param","custom","close","sep","erase","update","restart","exit"};
-  // wm.setMenu(menu); // custom menu, pass vector
-  
-  // wm.setParamsPage(true); // move params to seperate page, not wifi, do not combine with setmenu!
-
-  // set STA static ip
-  // wm.setSTAStaticIPConfig(IPAddress(10,0,1,99), IPAddress(10,0,1,1), IPAddress(255,255,255,0));
-  // wm.setShowStaticFields(false);
-  // wm.setShowDnsFields(false);
-
-  // set AP static ip
-  // wm.setAPStaticIPConfig(IPAddress(10,0,1,1), IPAddress(10,0,1,1), IPAddress(255,255,255,0));
-  // wm.setAPStaticIPConfig(IPAddress(10,0,1,99), IPAddress(10,0,1,1), IPAddress(255,255,255,0)); 
-
-  // set country
-  // setting wifi country seems to improve OSX soft ap connectivity, 
-  // may help others as well, default is CN which has different channels
-
-  // wm.setCountry("US"); // crashing on esp32 2.0
-
-  // set Hostname
-
-  // wm.setHostname(("WM_"+wm.getDefaultAPName()).c_str());
-  // wm.setHostname("WM_RANDO_1234");
-
-  // set custom channel
-  // wm.setWiFiAPChannel(13);
-  
-  // set AP hidden
-  // wm.setAPHidden(true);
-
-  // show password publicly in form
-  // wm.setShowPassword(true);
-
-  // sets wether wm configportal is a blocking loop(legacy) or not, use wm.process() in loop if false
-  // wm.setConfigPortalBlocking(false);
-  
-  if(!WMISBLOCKING){
-    wm.setConfigPortalBlocking(false);
-  }
-
-
-  //sets timeout until configuration portal gets turned off
-  //useful to make it all retry or go to sleep in seconds
-  wm.setConfigPortalTimeout(TESP_CP_TIMEOUT);
-  
-  // set min quality to show in web list, default 8%
-  // wm.setMinimumSignalQuality(50);
-
-  // set connection timeout
-  // wm.setConnectTimeout(20);
-
-  // set wifi connect retries
-  // wm.setConnectRetries(2);
-
-  // connect after portal save toggle
-  // wm.setSaveConnect(false); // do not connect, only save
-
-  // show static ip fields
-  // wm.setShowStaticFields(true);
-  
-  // wm.startConfigPortal("AutoConnectAP", "password");
-  
-  // This is sometimes necessary, it is still unknown when and why this is needed but it may solve some race condition or bug in esp SDK/lib
-  // wm.setCleanConnect(true); // disconnect before connect, clean connect
-  
-  wm.setBreakAfterConfig(true); // needed to use saveWifiCallback
-
-  // set custom webserver port, automatic captive portal does not work with custom ports!
-  // wm.setHttpPort(8080);
-
-  //fetches ssid and pass and tries to connect
-  //if it does not connect it starts an access point with the specified name
-  //here  "AutoConnectAP"
-  //and goes into a blocking loop awaiting configuration
-
-  // use autoconnect, but prevent configportal from auto starting
-  // wm.setEnableConfigPortal(false);
-
-  wifiInfo();
-
-  // to preload autoconnect with credentials
-  // wm.preloadWiFi("ssid","password");
-
-  if(!wm.autoConnect("WM_AutoConnectAP","12345678")) {
-    Serial.println("failed to connect and hit timeout");
-  }
-  else if(TEST_CP) {
-    // start configportal always
-    delay(1000);
-    Serial.println("TEST_CP ENABLED");
-    wm.setConfigPortalTimeout(TESP_CP_TIMEOUT);
-    wm.startConfigPortal("WM_ConnectAP","12345678");
-  }
-  else {
-    //if you get here you have connected to the WiFi
-     Serial.println("connected...yeey :)");
-  }
-  
-  wifiInfo();
-  pinMode(ONDDEMANDPIN, INPUT_PULLUP);
-
-  #ifdef USEOTA
-    ArduinoOTA.begin();
-  #endif
-
-}
-
-void wifiInfo(){
-  // can contain gargbage on esp32 if wifi is not ready yet
-  Serial.println("[WIFI] WIFI_INFO DEBUG");
-  WiFi.printDiag(Serial);
-  Serial.println("[WIFI] MODE: " + (String)(wm.getModeString(WiFi.getMode())));
-  Serial.println("[WIFI] SAVED: " + (String)(wm.getWiFiIsSaved() ? "YES" : "NO"));
-  Serial.println("[WIFI] SSID: " + (String)wm.getWiFiSSID());
-  Serial.println("[WIFI] PASS: " + (String)wm.getWiFiPass());
-  // Serial.println("[WIFI] HOSTNAME: " + (String)WiFi.getHostname());
-}
-
-void loop() {
-
-  if(!WMISBLOCKING){
-    wm.process();
-  }
-
-
-  #ifdef USEOTA
-  ArduinoOTA.handle();
-  #endif
-  // is configuration portal requested?
-  if (ALLOWONDEMAND && digitalRead(ONDDEMANDPIN) == LOW ) {
-    delay(100);
-    if ( digitalRead(ONDDEMANDPIN) == LOW || BUTTONFUNC == 2){
-      Serial.println("BUTTON PRESSED");
-
-      // button reset/reboot
-      if(BUTTONFUNC == 0){
-        wm.resetSettings();
-        wm.reboot();
-        delay(200);
-        return;
-      }
-      
-      // start configportal
-      if(BUTTONFUNC == 1){
-        if (!wm.startConfigPortal("OnDemandAP","12345678")) {
-          Serial.println("failed to connect and hit timeout");
-          delay(3000);
-        }
-        return;
-      }
-
-      //test autoconnect as reconnect etc.
-      if(BUTTONFUNC == 2){
-        wm.setConfigPortalTimeout(TESP_CP_TIMEOUT);
-        wm.autoConnect();
-        return;
-      }
-    
-    }
-    else {
-      //if you get here you have connected to the WiFi
-      Serial.println("connected...yeey :)");
-      getTime();
-    }
-  }
-
-  // every 10 seconds
-  if(millis()-mtime > 10000 ){
-    if(WiFi.status() == WL_CONNECTED){
-      getTime();
-    }
-    else Serial.println("No Wifi");  
-    mtime = millis();
-  }
-  // put your main code here, to run repeatedly:
-  delay(100);
-}
-
-void getTime() {
-  int tz           = -5;
-  int dst          = 0;
-  time_t now       = time(nullptr);
-  unsigned timeout = 5000; // try for timeout
-  unsigned start   = millis();
-  configTime(tz * 3600, dst * 3600, "pool.ntp.org", "time.nist.gov");
-  Serial.print("Waiting for NTP time sync: ");
-  while (now < 8 * 3600 * 2 ) { // what is this ?
-    delay(100);
-    Serial.print(".");
-    now = time(nullptr);
-    if((millis() - start) > timeout){
-      Serial.println("\n[ERROR] Failed to get NTP time.");
-      return;
-    }
-  }
-  Serial.println("");
-  struct tm timeinfo;
-  gmtime_r(&now, &timeinfo);
-  Serial.print("Current time: ");
-  Serial.print(asctime(&timeinfo));
-}
-
-void debugchipid(){
-  // WiFi.mode(WIFI_STA);
-  // WiFi.printDiag(Serial);
-  // Serial.println(modes[WiFi.getMode()]);
-  
-  // ESP.eraseConfig();
-  // wm.resetSettings();
-  // wm.erase(true);
-  WiFi.mode(WIFI_AP);
-  // WiFi.softAP();
-  WiFi.enableAP(true);
-  delay(500);
-  // esp_wifi_start();
-  delay(1000);
-  WiFi.printDiag(Serial);
-  delay(60000);
-  ESP.restart();
-
-  // AP esp_267751
-  // 507726A4AE30
-  // ESP32 Chip ID = 507726A4AE30
-}

examples/Tests/wifi_softap/wifi_softap.ino

@@ -1,51 +0,0 @@
-// wifi_basic.ino
-
-#include <Arduino.h>
-#include <WiFi.h>
-
-// #define NVSERASE
-#ifdef NVSERASE
-#include <nvs.h>
-#include <nvs_flash.h>
-#endif
-
-void setup(){
-    Serial.begin(115200);
-    delay(2000);
-    Serial.println("Startup....");
-
-    #ifdef NVSERASE
-        esp_err_t err;
-        err = nvs_flash_init();
-        err = nvs_flash_erase();
-    #endif
-
-    Serial.setDebugOutput(true);
-
-    WiFi.begin("hellowifi","noonehere");
-    
-    while (WiFi.status() != WL_CONNECTED && millis()<15000) {
-        delay(500);
-        Serial.print(".");
-    }
-    
-    if(WiFi.status() == WL_CONNECTED){
-        Serial.println("");
-        Serial.println("WiFi connected.");
-        Serial.println("IP address: ");
-        // Serial.println(WiFi.localIP());
-    }
-    else {
-        Serial.println("WiFi NOT CONNECTED, starting ap");
-        ///////////////
-        /// BUG
-        // WiFi.enableSTA(false); // BREAKS softap start, says ok BUT no ap found
-        
-        delay(2000);    
-        WiFi.softAP("espsoftap","12345678");
-    }
-}
-
-void loop(){
-
-}

examples/Unique/cb/AnonymousCB.ino

@@ -1,26 +0,0 @@
-#include <WiFiManager.h> // https://github.com/tzapu/WiFiManager
-
-bool _enteredConfigMode = false;
-
-void setup(){
-	Serial.begin(115200);
-	WiFiManager wifiManager;
-
-	// wifiManager.setAPCallback([this](WiFiManager* wifiManager) {
-	wifiManager.setAPCallback([&](WiFiManager* wifiManager) {
-		Serial.printf("Entered config mode:ip=%s, ssid='%s'\n", 
-                        WiFi.softAPIP().toString().c_str(), 
-                        wifiManager->getConfigPortalSSID().c_str());
-		_enteredConfigMode = true;
-	});
-	wifiManager.resetSettings();
-	if (!wifiManager.autoConnect()) {
-		Serial.printf("*** Failed to connect and hit timeout\n");
-		ESP.restart();
-		delay(1000);
-	}
-}
-
-void loop(){
-
-}

extras/WiFiManager.template.html

@@ -1,400 +0,0 @@
-<!-- HTTP_HEAD -->
-<!DOCTYPE html>
-<html lang="en">
-	<head>
-		<meta name=\"viewport\" content=\"width=device-width, initial-scale=1, user-scalable=no\"/>
-		<title>{v}</title>
-<!-- /HTTP_HEAD -->
-<!-- HTTP_STYLE -->
-<style>
-
-:root{
-	 /* CSS VARIABLE THEME COLOR */
-	/*--primarycolor:#9933CC;*/
-	--primarycolor:#1fa3ec;
-}
-
-body.invert,
-body.invert a,
-body.invert h1 {
-	background-color:#060606;
-	color:white;
-}
-body.invert .msg{
-	background-color: #282828;
-	border-top: 1px solid #555;
-	border-right: 1px solid #555;
-	border-bottom: 1px solid #555;
-	color:#fff;
-}
-body.invert .q[role=img] {
-    -webkit-filter: invert(1);
-    filter: invert(1);
-}
-.c,
-body {
-    text-align: center;
-    font-family: verdana
-}
-.wrap {
-	text-align:left;
-	display:inline-block;
-	min-width:260px;
-	max-width:500px;
-}
-div,
-input,select {
-    padding: 5px;
-    font-size: 1em;
-    /*width: 100%;*/
-    /*/*margin: 3px 0 10px 0; // BEFORE spacing shows label closer to input, but need to do same for AFTER*/
-    margin: 5px 0;
-	box-sizing: border-box;
-}
-div{
-	margin: 5px 0;
-}
-input,button,select,.msg{
-	border-radius:.3rem;
-    width: 100%;
-}
-input[type=radio],input[type=checkbox]{
-    width: auto;
-}
-button,input[type="button"],input[type="submit"] {
-    border: 0;
-    background-color: var(--primarycolor);
-    color: #fff;
-    line-height: 2.4rem;
-    font-size: 1.2rem;
-}
-input[type="file"]{
-	border: 1px solid var(--primarycolor);
-}
-a {
-    color: #000;
-    font-weight: 700;
-    text-decoration: none;
-}
-a:hover {
-    color: var(--primarycolor);
-    text-decoration: underline;
-}
-.h {
-	display: none;
-}
-.q {
-    height: 16px;
-    margin: 0;
-    padding: 0 5px;
-    text-align: right;
-    min-width: 38px;
-    float:right;
-}
-.q.q-0:after {
-    background-position-x: 0;
-}
-.q.q-1:after {
-    background-position-x: -16px;
-}
-.q.q-2:after {
-    background-position-x: -32px;
-}
-.q.q-3:after {
-    background-position-x: -48px;
-}
-.q.q-4:after {
-    background-position-x: -64px;
-}
-.q.l:before {
-    background-position-x: -80px;
-    padding-right: 5px
-}
-.ql .q {
-    float: left;
-}
-
-.q:after,
-.q:before {
-    content: '';width:16px;height:16px;display:inline-block;background-repeat:no-repeat;background-position: 16px 0;
- background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGAAAAAQCAMAAADeZIrLAAAAJFBMVEX///8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADHJj5lAAAAC3RSTlMAIjN3iJmqu8zd7vF8pzcAAABsSURBVHja7Y1BCsAwCASNSVo3/v+/BUEiXnIoXkoX5jAQMxTHzK9cVSnvDxwD8bFx8PhZ9q8FmghXBhqA1faxk92PsxvRc2CCCFdhQCbRkLoAQ3q/wWUBqG35ZxtVzW4Ed6LngPyBU2CobdIDQ5oPWI5nCUwAAAAASUVORK5CYII=');
-}
-@media (-webkit-min-device-pixel-ratio: 2),
-(min-resolution: 192dpi) {
-    .q:before,
-    .q:after {
-        background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAALwAAAAgCAMAAACfM+KhAAAALVBMVEX///8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADAOrOgAAAADnRSTlMAESIzRGZ3iJmqu8zd7gKjCLQAAACmSURBVHgB7dDBCoMwEEXRmKlVY3L//3NLhyzqIqSUggy8uxnhCR5Mo8xLt+14aZ7wwgsvvPA/ofv9+44334UXXngvb6XsFhO/VoC2RsSv9J7x8BnYLW+AjT56ud/uePMdb7IP8Bsc/e7h8Cfk912ghsNXWPpDC4hvN+D1560A1QPORyh84VKLjjdvfPFm++i9EWq0348XXnjhhT+4dIbCW+WjZim9AKk4UZMnnCEuAAAAAElFTkSuQmCC');
-        background-size: 95px 16px;
-    }
-}
-
-.msg {
-	padding: 20px;
-	margin: 20px 0;
-	border: 1px solid #eee;
-	border-left-width: 5px;
-	border-left-color: #777;
-}
-
-.msg h4 {
-    margin-top: 0;
-	margin-bottom: 5px;
-}
-.msg.P {
-    border-left-color: var(--primarycolor);
-}
-.msg.P h4 {
-    color: var(--primarycolor);
-}
-.msg.S {
-    border-left-color: #5cb85c;
-}
-.msg.S h4 {
-    color: #5cb85c;
-}
-.msg.D {
-    border-left-color: #dc3630;
-}
-.msg.D h4 {
-    color: #dc3630;
-}
-
-dt {
-	font-weight: bold;
-}
-dd {
-	margin: 0;
-	padding: 0 0 0.5em 0;
-}
-td {
-	vertical-align: top;
-}
-button.D{
-	background-color:#dc3630;
-}
-
-button{
-	/*transition: 0s filter;*/
-	transition: 0s opacity;
-	transition-delay: 3s;
-	transition-duration: 0s;
-	cursor: pointer;
-}
-
-button:active{
-	opacity: 50% !important;
-	/*filter: brightness(50%);*/
-	cursor: wait;
-	transition-delay: 0s;
-}
-
-button:hover{
-	/*opacity: 80%;*/
-}
-
-:disabled {
-	opacity: 0.5;
-}
-</style>
-<!-- /HTTP_STYLE -->
-<!-- HTTP_SCRIPT -->
-		<script>
-		function c(l){document.getElementById('s').value=l.innerText||l.textContent;
-		p = l.nextElementSibling.classList.contains('l');
-		document.getElementById('p').disabled = !p;
-		if(p)document.getElementById('p').focus()};
-		function f() {var x = document.getElementById('p');x.type==='password'?x.type='text':x.type='password';}
-		</script>
-<!-- /HTTP_SCRIPT -->
-<!-- HTTP_HEAD_END -->
-	</head>
-	<body class="invert">
-		<div class='wrap'>
-		<!-- <div class='wrap ql qinv'> -->
-<!-- /HTTP_HEAD_END -->
-			<!-- SAMPLE -->
-			<h2>/</h2><hR>
-			<!-- /SAMPLE -->
-			<!-- HTTP_PORTAL_OPTIONS -->
-			<!-- /HTTP_PORTAL_OPTIONS -->
-			<!-- HTTP_PORTAL_MENU[] -->
-			<form action='/wifi' method='get'><button>Configure WiFi</button></form><br/>
-			<form action='/0wifi' method='get'><button>Configure WiFi (No Scan)</button></form><br/>
-			<form action='/info' method='get'><button>Info</button></form><br/>
-			<form action='/param' method='get'><button>Setup</button></form><br/>
-			<Hr><br/>
-			<form action='/close' method='post'><button>Close</button></form><br/>
-			<form action='/erase' method='post'><button class='D'>Erase</button></form><br/>
-			<form action='/restart' method='post'><button>Restart</button></form><br/>
-			<form action='/exit' method='post'><button>Exit</button></form><br/>
-			<form action='/exit' method='post'><button>Update</button></form><br/>
-			<form action='/' method='post'><button>Back</button></form><br/>
-			<!-- /HTTP_PORTAL_MENU -->
-			<!-- SAMPLE -->
-			<h2>/wifi</h2><hr>
-			<div><a href='#p' onclick='c(this)'>Access Point 01</a><div role='img' aria-label='88%' title='88%' class='q q-4 l'></div></div>
-			<div><a href='#p' onclick='c(this)'>Access Point 02</a><div role='img' aria-label='88%' title='88%' class='q q-4'></div></div>
-			<div><a href='#p' onclick='c(this)'>Access Point 03</a><div role='img' aria-label='60%' title='60%' class='q q-3 l'></div></div>
-			<div><a href='#p' onclick='c(this)'>Access Point 04</a><div role='img' aria-label='60%' title='60%' class='q q-3'></div></div>
-			<div><a href='#p' onclick='c(this)'>Access Point 05</a><div role='img' aria-label='60%' title='60%' class='q q-3'></div></div>
-			<div><a href='#p' onclick='c(this)'>Access Point 06</a><div role='img' aria-label='40%' title='40%' class='q q-2'></div></div>
-			<div><a href='#p' onclick='c(this)'>Access Point 07</a><div role='img' aria-label='40%' title='40%' class='q q-2 l'></div></div>
-			<div><a href='#p' onclick='c(this)'>Access Point 08</a><div role='img' aria-label='20%' title='20%' class='q q-1'></div></div>
-			<div><a href='#p' onclick='c(this)'>Access Point 09</a><div role='img' aria-label='20%' title='20%' class='q q-1'></div></div>
-			<div><a href='#p' onclick='c(this)'>Access Point 10</a><div role='img' aria-label='20%' title='20%' class='q q-4 l'></div><div class='q '>100%</div></div>
-			<div><a href='#p' onclick='c(this)'>Access Point 11</a><div role='img' aria-label='10%' title='10%' class='q q-3'></div><div class='q '>70%</div></div>
-			<div><a href='#p' onclick='c(this)'>Access Point 12</a><div role='img' aria-label='10%' title='10%' class='q q-1 l'></div><div class='q '>10%</div></div>
-			<div><a href='#p' onclick='c(this)'>Access Point 13</a><div role='img' aria-label='10%' title='10%' class='q q-0 h'></div><div class='q '>100%</div></div>
-			<div><a href='#p' onclick='c(this)'>Access Point 14</a><div class='q'>66%</div></div>
-			<div><a href='#p' onclick='c(this)'>Access Point 15</a><div class='q'>56%</div></div>
-			<!-- /SAMPLE -->
-			<!-- HTTP_ITEM -->
-			<div><a href='#p' onclick='c(this)'>{v}</a><div role='img' aria-label='{r}%' title='{r}%' class='q q-{q} {i}'></div></div>
-			<!-- /HTTP_ITEM -->
-			<!-- HTTP_FORM_START -->
-			<form method='get' action='wifisave'><label for='s'>SSID</label><br/><input id='s' name='s' length=32 placeholder='SSID'><br/><label for='p'>Password</label><input id='p' name='p' length=64 type='password' placeholder='password'><input type='checkbox' id='show-password' onclick='f()'> <label for='show-password'>Show Password</label><br/>
-			<!-- /HTTP_FORM_START -->
-			<!-- SAMPLE -->
-			<h3>custom parameter</h3><hr>
-			<br/><label for='custom'>Label for Custom Param</label>
-			<br/><input id='custom' name='custom' length='255' placeholder='placeholder' value='' {c}>
-			<!-- /SAMPLE -->
-			<!-- HTTP_FORM_LABEL -->
-			<br/><label for='{i}'>{p}</label>
-			<!-- /HTTP_FORM_LABEL -->
-			<!-- HTTP_FORM_PARAM -->
-			<br/><input id='{i}' name='{n}' length='{l}' placeholder='{p}' value='{v}' {c}>
-			<!-- /HTTP_FORM_PARAM -->
-			<!-- HTTP_FORM_END -->
-			<br/><button type='submit'>Save</button></form>
-			<!-- /HTTP_FORM_END -->
-			<!-- HTTP_SCAN_LINK -->
-			<br/><form action='/wifi' method='get'><button>Refresh</button></form>
-			<!-- /HTTP_SCAN_LINK -->
-			<!-- HTTP_SAVED -->
-			<div class='msg'><h4>Saving Credentials</h4>Trying to connect ESP to network.<br />If it fails reconnect to AP to try again</div>
-			<!-- /HTTP_SAVED -->
-			<!-- HTTP_STATUS_ON -->
-			<div class='msg P'><strong>Connected</strong> to {v}<br/><em><small>with IP {i}</small></em></div>
-			<!-- /HTTP_STATUS_ON -->
-			<!-- HTTP_STATUS_OFF -->
-			<div class='msg {c}'><strong>Not Connected</strong> to {v}{r}</div>
-			<!-- /HTTP_STATUS_OFF -->
-			<!-- sample -->
-			<div class='msg D'><strong>Not Connected</strong> to apname
-			<!-- /sample -->
-			<!-- HTTP_STATUS_OFFPW -->
-				<br/>Authentication Failure
-			<!-- /HTTP_STATUS_OFFPW -->
-			<!-- HTTP_STATUS_OFFNOAP -->
-				<br/>AP not found
-			<!-- /HTTP_STATUS_OFFNOAP -->
-			<!-- HTTP_STATUS_OFFFAIL -->
-				<br/>Could not Connect
-			<!-- /HTTP_STATUS_OFFFAIL -->
-			</div>
-			<!-- HTTP_STATUS_NONE -->
-			<div class='msg'>No AP set</div>
-			<!-- /HTTP_STATUS_NONE -->
-			<!-- SAMPLE -->
-			<div class='msg P'><h4>H4 Color Header P</h4>content</div>
-			<!-- /SAMPLE -->
-			<!-- SAMPLE -->
-			<div class='msg S'><h4>H4 Color Header S</h4>content</div>
-			<!-- /SAMPLE -->
-			<!-- SAMPLE -->
-			<h1>Heading 1</h1>
-			<h2>Heading 2</h2>
-			<h3>Heading 3</h3>
-			<h4>Heading 4</h4>
-			<h3>WIFI HEAD <small><em>(WIFI_OFF)</em></small></h3><hr>
-			<dl>
-				<dt>Chip ID</dt><dd>123456</dd>
-				<dt>Flash Chip ID</dt><dd>1234556</dd>
-				<dt>IDE Flash Size</dt><dd>4194304 bytes</dd>
-				<dt>Real Flash Size</dt><dd>4194304 bytes</dd>
-				<dt>Empty</dt><dd></dd>
-				<dt>Soft AP IP</dt><dd>192.168.4.1</dd>
-				<dt>Soft AP MAC</dt><dd>00:00:00:00:00:00</dd>
-				<dt>Station MAC</dt><dd>00:00:00:00:00:00</dd>
-			</dl>
-			<!-- /SAMPLE -->
-			<!-- HTTP_HELP -->
-		 		<br/><h3>Available Pages</h3><hr>
-		 		<table class='table'>
-		 		<thead><tr><th>Page</th><th>Function</th></tr></thead><tbody>
-		 		<tr><td><a href='/'>/</a></td>
-		 		<td>Menu page.</td></tr>
-		 		<tr><td><a href='/wifi'>/wifi</a></td>
-		 		<td>Show WiFi scan results and enter WiFi configuration.(/0wifi noscan)</td></tr>
-		 		<tr><td><a href='/wifisave'>/wifisave</a></td>
-		 		<td>Save WiFi configuration information and configure device. Needs variables supplied.</td></tr>
-		 		<tr><td><a href='/close'>/close</a></td>
-		 		<td>Close the configuration server and configuration WiFi network.</td></tr>
-		 		<tr><td><a href='/info'>/info</a></td>
-		 		<td>Information page</td></tr>
- 				<tr><td><a href='/close'>/close</a></td>
- 				<td>Close the captiveportal popup,configportal will remain active</td></tr>
-		 		<tr><td><a href='/exit'>/exit</a></td>
-		 		<td>Exit Config Portal, configportal will close</td></tr>
-		 		<tr><td><a href='/restart'>/restart</a></td>
-		 		<td>Reboot the device</td></tr>
-		 		<tr><td><a href='/erase'>/erase</a></td>
-		 		<td>Erase WiFi configuration and reboot Device. Device will not reconnect to a network until new WiFi configuration data is entered.</td></tr>
-		 		</table>
-		 		<h3>About</h3><hr>
-		 		Version v1.x.x-xxxxx<Br/>
-		 		Build_date<br/>
-		 		Build_file<br/>
-		 		Arduino_version<br/>
-		 		<p/>Github <a href='https://github.com/tzapu/WiFiManager'>https://github.com/tzapu/WiFiManager</a>
-			<!-- /HTTP_HELP -->
-			<!-- FORM_UPLOAD -->
-			<Br/><br/>Form UPLOAD<br/>
-			<form method='POST' action='u' enctype='multipart/form-data'>
-				<input type='file' name='update' accept='.bin,application/octet-stream' onchange="(function(el){document.getElementById('uploadbin').style.display = el.value=='' ? 'none' : 'initial';})(this)">
-				<button id='uploadbin' class="h">Submit</button>
-			<a href='http://192.168.4.1' target='_blank'><small>* Upload may not function inside captive portal, Open in browser - http://192.168.4.1</a></small>
-			<!-- /FORM_UPLOAD -->
-
-
-			<!-- FORM_EXTRAS -->
-			<br/><br/><br/><hr>
-			<br/>
-			<label for='custom'>Label for Custom Param</label>
-			<br/>
-			<input id='custom' name='custom' length='255' placeholder='placeholder' value='' {c}>
-			<br/>
-
-			<!-- INOUT CHECKBOX -->
-			<!-- <label for='input_checkbox'>Label for Input Checkbox</label> -->
-			<input id='input_checkbox' name='input_checkbox' placeholder='placeholder' value='' type="checkbox" {c}>
-			<label for='input_checkbox'>Label for Input Checkbox</label>
-			<br/>
-
-			<!-- INPUT CHOICE -->
-			<p>Select Choice</p>
-			<input style='display: inline-block;' type='radio' id='choice1' name='program_selection' value='1'>
-  			<label for='choice1'>Choice1</label><br>
-  			<input style='display: inline-block;' type='radio' id='choice2' name='program_selection' value='2'>
-  			<label for='choice2'>Choice2</label><br>
-
-  			<!-- INPUT SELECT -->
-			<br/>
-			<label for='input_select'>Label for Input Select</label>
-			<select name="input_select" id="input_select" class="button">
-			<option value="0">Option 1</option>
-			<option value="1" selected>Option 2</option>
-			<option value="2">Option 3</option>
-			<option value="3">Option 4</option>
-			</select>
-
-			</form>
-
-			<!-- /FORM_EXTRAS -->
-
-<!-- HTTP_END -->
-    </div>
-	</body>
-</html>
-<!-- /HTTP_END -->

extras/parse.js

@@ -1,60 +0,0 @@
-'use strict';
-
-const fs = require('fs');
-
-console.log('starting');
-
-const inFile = 'WiFiManager.template.html';
-const outFile = 'template.h';
-
-const defineRegEx = /<!-- ([A-Z_]+) -->/gm;
-console.log('parsing', inFile);
-
-fs.readFile(inFile, 'utf8', function (err,data) {
-  if (err) {
-    return console.log(err);
-  }
-  //console.log(data);
-
-  let defines = data.match(defineRegEx);
-
-  //console.log(defines);
-  var stream = fs.createWriteStream(outFile);
-  stream.once('open', function(fd) {
-    for (const i in defines) {
-
-      const start = defines[i];
-      const end = start.replace('<!-- ', '<!-- /')
-      defineRegEx.lastIndex = 0;
-      const constantName = defineRegEx.exec(start)[1];
-
-      console.log(constantName);
-      var extractRE = new RegExp(start + '([\\s\\S]+)' + end, 'gm');
-      let extractArray = extractRE.exec(data);
-      if(extractArray.length > 1) {
-        let def = extractArray[1];
-        //console.log(def);
-        //minimise a bit
-        def = def.replace(/\s+/g, ' ');
-        def = def.replace(/>\s+</g, '><');
-        def = def.trim();
-        //more extraneous spaces - possible bad results, needs to be checked
-        //def = def.replace(/(\w)\s(\W)|(\W)\s(\w)|(\W)\s(\W)/g, '$1$2$3$4$5$6');
-        def = def.replace(/(\w)\s(\W)|(\W)\s(\w)/g, '$1$2$3$4');
-        //escape double quotes
-        def = def.replace(/\\([\s\S])|(")/g, "\\$1$2");
-
-
-        console.log(def);
-        //const char HTTP_HEAD[] PROGMEM            =
-        let string = 'const char ' + constantName + '[] PROGMEM';
-        for (let i = string.length; i < 42; i++) {
-          string += ' ';
-        }
-        string += '= "' + def + '";\n';
-        stream.write(string);
-      }
-    }
-    stream.end();
-  });
-});

extras/template.h

@@ -1,12 +0,0 @@
-const char HTTP_HEAD[] PROGMEM            = "<!DOCTYPE html><html lang=\"en\"><head><meta name=\"viewport\"content=\"width=device-width,initial-scale=1,user-scalable=no\"/><title>{v}</title>";
-const char HTTP_STYLE[] PROGMEM           = "<style> .c{text-align:center;}div,input{padding:5px;font-size:1em;}input{width:95%;}body{text-align:center;font-family:verdana;}button{border:0;border-radius:0.3rem;background-color:#1fa3ec;color:#fff;line-height:2.4rem;font-size:1.2rem;width:100%;} .q{float:right;width:64px;text-align:right;} .l{background:url(\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAMAAABEpIrGAAAALVBMVEX///8EBwfBwsLw8PAzNjaCg4NTVVUjJiZDRUUUFxdiZGSho6OSk5Pg4eFydHTCjaf3AAAAZElEQVQ4je2NSw7AIAhEBamKn97/uMXEGBvozkWb9C2Zx4xzWykBhFAeYp9gkLyZE0zIMno9n4g19hmdY39scwqVkOXaxph0ZCXQcqxSpgQpONa59wkRDOL93eAXvimwlbPbwwVAegLS1HGfZAAAAABJRU5ErkJggg==\")no-repeat left center;background-size:1em;} </style>";
-const char HTTP_SCRIPT[] PROGMEM          = "<script>function c(l){document.getElementById('s').value=l.innerText||l.textContent;document.getElementById('p').focus();} </script>";
-const char HTTP_HEAD_END[] PROGMEM        = "</head><body><div style=\"text-align:left;display:inline-block;min-width:260px;\">";
-const char HTTP_PORTAL_OPTIONS[] PROGMEM  = "<form action=\"/wifi\"method=\"get\"><button>Configure WiFi</button></form><br/><form action=\"/0wifi\"method=\"get\"><button>Configure WiFi(No Scan)</button></form><br/><form action=\"/i\"method=\"get\"><button>Info</button></form><br/><form action=\"/r\"method=\"post\"><button>Reset</button></form>";
-const char HTTP_ITEM[] PROGMEM            = "<div><a href='#p'onclick='c(this)'>{v}</a>&nbsp;<span class='q{i}'>{r}%</span></div>";
-const char HTTP_FORM_START[] PROGMEM      = "<form method='get'action='wifisave'><input id='s'name='s'length=32 placeholder='SSID'><br/><input id='p'name='p'length=64 type='password'placeholder='password'><br/>";
-const char HTTP_FORM_PARAM[] PROGMEM      = "<br/><input id='{i}'name='{n}'length={l}placeholder='{p}'value='{v}' {c}>";
-const char HTTP_FORM_END[] PROGMEM        = "<br/><button type='submit'>save</button></form>";
-const char HTTP_SCAN_LINK[] PROGMEM       = "<br/><div class=\"c\"><a href=\"/wifi\">Scan</a></div>";
-const char HTTP_SAVED[] PROGMEM           = "<div>Credentials Saved<br/>Trying to connect ESP to network.<br/>If it fails reconnect to AP to try again</div>";
-const char HTTP_END[] PROGMEM             = "</div></body></html>";

extras/test.html

@@ -1,182 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-
-<head>
-    <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no" />
-    <title>Config ESP</title>
-    <script>
-
-    function c(l,e) {
-    	console.log(l);
-    	// preventDefault();
-        document.getElementById('s').value = l.innerText || l.textContent;
-        // document.location.href = document.location +"#wmform";
-        p = l.nextElementSibling.classList.contains("l");
-        document.getElementById('p').disabled = !p;
-        if(p)document.getElementById('p').focus();
-        return false;
-    }
-
-    </script>
-
-<style>
-.c,
-body {
-    text-align: center
-}
-
-div,
-input {
-    padding: 5px;
-    font-size: 1em
-}
-
-input {
-    width: 95%
-}
-
-body {
-    font-family: verdana
-}
-
-button {
-    border: 0;
-    border-radius: .3rem;
-    background-color: #1fa3ec;
-    color: #fff;
-    line-height: 2.4rem;
-    font-size: 1.2rem;
-    width: 100%
-}
-
-a {
-    color: #000;
-    font-weight: 700;
-    text-decoration: none
-}
-
-a:hover {
-    color: #1fa3ec;
-    text-decoration: underline
-}
-
-.q {
-    height: 16px;
-    margin: 0;
-    padding: 0 5px;
-    text-align: right;
-    min-width: 38px
-}
-
-.q.q-0:after {
-    background-position-x: 0
-}
-
-.q.q-1:after {
-    background-position-x: -16px
-}
-
-.q.q-2:after {
-    background-position-x: -32px
-}
-
-.q.q-3:after {
-    background-position-x: -48px
-}
-
-.q.q-4:after {
-    background-position-x: -64px
-}
-
-.q.l:before {
-    background-position-x: -80px;
-    padding-right: 5px
-}
-
-.ql .q {
-    float: left
-}
-
-.qr .q {
-    float: right
-}
-
-.qinv .q {
-    -webkit-filter: invert(1);
-    filter: invert(1)
-}
-
-.q:after,
-.q:before {
-    content: '';
-    width: 16px;
-    height: 16px;
-    display: inline-block;
-    background-repeat: no-repeat;
-    background-position: 16px 0;
-    background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGAAAAAQCAMAAADeZIrLAAAAJFBMVEX///8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADHJj5lAAAAC3RSTlMAIjN3iJmqu8zd7vF8pzcAAABsSURBVHja7Y1BCsAwCASNSVo3/v+/BUEiXnIoXkoX5jAQMxTHzK9cVSnvDxwD8bFx8PhZ9q8FmghXBhqA1faxk92PsxvRc2CCCFdhQCbRkLoAQ3q/wWUBqG35ZxtVzW4Ed6LngPyBU2CobdIDQ5oPWI5nCUwAAAAASUVORK5CYII=');
-}
-
-@media (-webkit-min-device-pixel-ratio: 2),
-(min-resolution: 192dpi) {
-    .q:before,
-    .q:after {
-        background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAALwAAAAgCAMAAACfM+KhAAAALVBMVEX///8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADAOrOgAAAADnRSTlMAESIzRGZ3iJmqu8zd7gKjCLQAAACmSURBVHgB7dDBCoMwEEXRmKlVY3L//3NLhyzqIqSUggy8uxnhCR5Mo8xLt+14aZ7wwgsvvPA/ofv9+44334UXXngvb6XsFhO/VoC2RsSv9J7x8BnYLW+AjT56ud/uePMdb7IP8Bsc/e7h8Cfk912ghsNXWPpDC4hvN+D1560A1QPORyh84VKLjjdvfPFm++i9EWq0348XXnjhhT+4dIbCW+WjZim9AKk4UZMnnCEuAAAAAElFTkSuQmCC');
-        background-size: 95px 16px;
-    }
-}
-
-input:disabled {
-    opacity: 0.5;
-}
-
-</style>
-
-</head>
-
-<body>
- 	<!-- classes, left/right invert -->
-    <div class="qr" style='text-align:left;display:inline-block;min-width:260px;'>
-        <div><a href='#p' onclick='c(this)'>Access Point 01</a><div role='img' aria-label='88%' title='88%' class='q q-4 l'></div></div>
-        <div><a href='#p' onclick='c(this)'>Access Point 02</a><div role='img' aria-label='88%' title='88%' class='q q-4'></div></div>
-        <div><a href='#p' onclick='c(this)'>Access Point 03</a><div role='img' aria-label='88%' title='88%' class='q q-3'></div></div>
-        <div><a href='#p' onclick='c(this)'>Access Point 04</a><div role='img' aria-label='88%' title='88%' class='q q-3'></div></div>
-        <div><a href='#p' onclick='c(this)'>Access Point 05</a><div role='img' aria-label='88%' title='88%' class='q q-3'></div></div>
-        <div><a href='#p' onclick='c(this)'>Access Point 06</a><div role='img' aria-label='88%' title='88%' class='q q-2'></div></div>
-        <div><a href='#p' onclick='c(this)'>Access Point 07</a><div role='img' aria-label='88%' title='88%' class='q q-2'></div></div>
-        <div><a href='#p' onclick='c(this)'>Access Point 08</a><div role='img' aria-label='88%' title='88%' class='q q-1'></div></div>
-        <div><a href='#p' onclick='c(this)'>Access Point 09</a><div role='img' aria-label='88%' title='88%' class='q q-1'></div></div>
-        <div><a href='#p' onclick='c(this)'>Access Point 10</a><div role='img' aria-label='88%' title='88%' class='q q-1'></div></div>
-        <div><a href='#p' onclick='c(this)'>Access Point 11</a><div role='img' aria-label='88%' title='88%' class='q q-0'></div></div>
-        <div><a href='#p' onclick='c(this)'>Access Point 12</a><div role='img' aria-label='88%' title='88%' class='q q-0'></div></div>
-        <div><a href='#p' onclick='c(this)'>Access Point 13</a><div role='img' aria-label='88%' title='88%' class='q q-0'></div></div>
-        <div><a href='#p' onclick='c(this)'>Access Point 14</a><div role='img' aria-label='88%' title='88%' class='q q-0 l'></div></div>
-        <br/>
-        <form id="wmform" method='get' action='wifisave'>
-            <input id='s' name='s' length=32 placeholder='SSID'>
-            <br/>
-            <input id='p' name='p' length=64 type='password' placeholder='password'>
-            <br/>
-            <br/>
-            <input id='server' name='server' length=4 placeholder='mqtt server' value=''>
-            <br/>
-            <input id='port' name='port' length=5 placeholder='mqtt port' value='8080'>
-            <br/>
-            <input id='blynk' name='blynk' length=3 placeholder='blynk token' value='YOUR_BLYNK_TOKEN'>
-            <br/>
-            <br/>
-            <input id='ip' name='ip' length=15 placeholder='Static IP' value='10.0.1.56'>
-            <br/>
-            <input id='gw' name='gw' length=15 placeholder='Static Gateway' value='10.0.1.1'>
-            <br/>
-            <input id='sn' name='sn' length=15 placeholder='Subnet' value='255.255.255.0'>
-            <br/>
-            <br/>
-            <button type='submit'>save</button>
-        </form>
-        <br/>
-        <div class="c"><a href="/wifi">Scan</a></div>
-    </div>
-</body>
-
-</html>

keywords.txt

@@ -1,39 +0,0 @@
-#######################################
-# Syntax Coloring Map For WifiManager
-#######################################
-
-#######################################
-# Datatypes (KEYWORD1)
-#######################################
-
-WiFiManager	KEYWORD1
-WiFiManagerParameter KEYWORD1
-
-
-#######################################
-# Methods and Functions (KEYWORD2)
-#######################################
-autoConnect	KEYWORD2
-getSSID	KEYWORD2
-getPassword	KEYWORD2
-getConfigPortalSSID KEYWORD2
-resetSettings	KEYWORD2
-setConfigPortalTimeout	KEYWORD2
-setConnectTimeout KEYWORD2
-setDebugOutput	KEYWORD2
-setMinimumSignalQuality KEYWORD2
-setAPStaticIPConfig	KEYWORD2
-setSTAStaticIPConfig KEYWORD2
-setAPCallback	KEYWORD2
-setSaveConfigCallback KEYWORD2
-addParameter KEYWORD2
-getID KEYWORD2
-getValue KEYWORD2
-getPlaceholder KEYWORD2
-getValueLength KEYWORD2
-
-#######################################
-# Constants (LITERAL1)
-#######################################
-
-#	LITERAL1

lib/WiFiManager/include/WiFiManagerDfteLogger.h

@@ -0,0 +1,45 @@
+/**
+ * WiFiManagerDfteLogger.h
+ *
+ * @author alexhopeoconnor
+ * @license MIT
+ *
+ * Optional bridge from DFTE's logging hooks to WiFiManager::log.
+ * Enabled only when the sketch / library build defines WM_DFTE_LOGGING.
+ */
+
+#ifndef WiFiManagerDfteLogger_h
+#define WiFiManagerDfteLogger_h
+
+#if defined(ESP8266) || defined(ESP32)
+
+#include <DeviceFrameworkTemplateEngineDebug.h>
+#include "WiFiManager.h"
+
+/**
+ * Forwards DeviceFrameworkTemplateEngineLogger calls to WiFiManager logging
+ * with subsystem WM/DFTE.
+ */
+class WiFiManagerDfteLogger : public DeviceFrameworkTemplateEngineLogger {
+public:
+    explicit WiFiManagerDfteLogger(WiFiManager* wm) : _wm(wm) {}
+
+    void error(const String& msg) override { logLine(WiFiManagerLogLevel::Error, msg); }
+    void warn(const String& msg) override { logLine(WiFiManagerLogLevel::Warn, msg); }
+    void info(const String& msg) override { logLine(WiFiManagerLogLevel::Debug, msg); }
+    void debug(const String& msg) override { logLine(WiFiManagerLogLevel::Trace, msg); }
+
+private:
+    WiFiManager* _wm;
+
+    void logLine(WiFiManagerLogLevel level, const String& msg) {
+        if (!_wm) {
+            return;
+        }
+        _wm->log(level, "WM/DFTE", msg);
+    }
+};
+
+#endif // ESP8266 || ESP32
+
+#endif // WiFiManagerDfteLogger_h

lib/WiFiManager/include/WiFiManagerHandlers.h

@@ -0,0 +1,125 @@
+/**
+ * WiFiManagerHandlers.h
+ *
+ * HTTP request handlers for WiFiManager: single HTML shell + JSON APIs.
+ *
+ * @author alexhopeoconnor
+ * @license MIT
+ */
+
+#ifndef WiFiManagerHandlers_h
+#define WiFiManagerHandlers_h
+
+#if defined(ESP8266) || defined(ESP32)
+
+#include <ESPAsyncWebServer.h>
+#include <memory>
+#include "WiFiManager.h"
+
+#ifndef WM_TEMPLATE_REGISTRY_CAPACITY
+#define WM_TEMPLATE_REGISTRY_CAPACITY 16
+#endif
+
+// Portal UI customization is driven by WiFiManager `portal*` APIs and JSON (/api/...) — not by mutating template
+// placeholder registries.
+
+// -----------------------------------------------------------------------------------------------
+// FORM FIELD NAMES (for IP configuration forms)
+
+const char S_ip[]                 PROGMEM = "ip";
+const char S_gw[]                 PROGMEM = "gw";
+const char S_sn[]                 PROGMEM = "sn";
+const char S_dns[]                PROGMEM = "dns";
+
+// -----------------------------------------------------------------------------------------------
+// HTTP HEADERS
+
+const char HTTP_HEAD_CT[]         PROGMEM = "text/html";
+const char HTTP_HEAD_CT2[]        PROGMEM = "text/plain";
+const char HTTP_HEAD_CORS[]       PROGMEM = "Access-Control-Allow-Origin";
+const char HTTP_HEAD_CORS_ALLOW_ALL[]  PROGMEM = "*";
+
+class WiFiManagerHandlers {
+  public:
+    WiFiManagerHandlers(WiFiManager* wm);
+
+    void handleRoot(AsyncWebServerRequest *request);
+    void handleNotFound(AsyncWebServerRequest *request);
+    void handleRequest(AsyncWebServerRequest *request);
+    void handleUpdating(AsyncWebServerRequest *request, String filename, size_t index, uint8_t *data, size_t len, bool final);
+    void handleUpdateDone(AsyncWebServerRequest *request);
+
+    void handleApiBootstrap(AsyncWebServerRequest *request);
+    void handleApiWifiScanStatus(AsyncWebServerRequest *request);
+    void handleApiWifiScan(AsyncWebServerRequest *request);
+    void handleApiWifiMeta(AsyncWebServerRequest *request);
+    void handleApiWifiSave(AsyncWebServerRequest *request);
+    void handleApiWifiConnectStatus(AsyncWebServerRequest *request);
+    void handleApiWifiConnectComplete(AsyncWebServerRequest *request);
+    void handleApiPortalTimeoutReset(AsyncWebServerRequest *request);
+    void handleApiParamsGet(AsyncWebServerRequest *request);
+    void handleApiParamsSave(AsyncWebServerRequest *request);
+    void handleApiInfo(AsyncWebServerRequest *request);
+    void handleApiStatus(AsyncWebServerRequest *request);
+    void handleApiDeviceRestart(AsyncWebServerRequest *request);
+    void handleApiDeviceErase(AsyncWebServerRequest *request, boolean optionalErase = false);
+    void handleApiPortalClose(AsyncWebServerRequest *request);
+    void handleApiPortalExit(AsyncWebServerRequest *request);
+
+    boolean captivePortal(AsyncWebServerRequest *request);
+    void stopCaptivePortal();
+
+    /** True when the HTTP Host header does not match the portal’s canonical host:port (captive redirect needed). */
+    static bool shouldRedirectCaptiveForHost(const String& requestHost, const String& serverLocWithPort);
+
+    void doParamSave(WiFiManager::WiFiManagerRequestArgs requestArgs);
+
+    /** Portal bootstrap JSON (same payload as GET /api/bootstrap). Public for tests and host integration. */
+    String buildPortalBootstrapJson();
+    /** Same JSON body as GET /api/wifi/meta (tests + embedding). */
+    String buildApiWifiMetaJson();
+    /** Same JSON body as GET /api/info (tests + embedding). */
+    String buildApiInfoJson();
+    /** Same JSON body as GET /api/params (tests + embedding). */
+    String buildApiParamsGetJson();
+    /** Same JSON body as GET /api/status (tests + embedding). */
+    String buildApiStatusJson();
+    /** GET /api/wifi/connect-status (portal connect progress). */
+    String buildApiWifiConnectStatusJson();
+
+    /** Fixed JSON bodies for POST action endpoints (single source for handlers + tests). */
+    static String jsonApiWifiScanAccepted();
+    static String jsonApiDeviceRestartScheduled();
+    static String jsonApiParamsSaveOk();
+    static String jsonApiPortalCloseOk();
+    static String jsonApiPortalExitOk();
+    static String jsonApiPortalExitForbidden();
+    static String jsonApiOtaUpdateSuccess();
+    static String jsonApiEraseResponse(boolean success);
+
+  private:
+    WiFiManager* _wm;
+    void collectVisibleScanResults(std::vector<const WiFiManager::WiFiScanNetwork*>& networks);
+    void appendVisibleScanResultsJson(String& json, const std::vector<const WiFiManager::WiFiScanNetwork*>& networks);
+
+    void applyWifiAndParamsFromRequest(AsyncWebServerRequest *request);
+    bool buildStationProfilesFromRequest(AsyncWebServerRequest *request, WiFiManagerStationProfiles& profiles);
+    void buildPlainStatusSummary(String& out);
+    void appendPortalJsonStaticFields(String& json, bool& first);
+    void appendPortalJsonCustomParams(String& json, bool& first);
+
+    void appendPortalExtraInfoSectionsJson(String& json, bool& first);
+    void appendPortalExtraHomeCardsJson(String& json, bool& first);
+
+    void appendJsonKvItem(String& json, bool& first, const char* key, const String& label, const String& value);
+    void appendOneInfoItemForId(String& json, bool& first, const char* id);
+    void appendInfoSectionFromIds(String& json, const char* const* ids, size_t count, bool& first);
+
+    void appendApiInfoActionsJson(String& json);
+
+    static void sendApiJson(AsyncWebServerRequest *request, int code, const String& json);
+};
+
+#endif // defined(ESP8266) || defined(ESP32)
+
+#endif // WiFiManagerHandlers_h

lib/WiFiManager/include/WiFiManagerLogLevel.h

@@ -0,0 +1,35 @@
+/**
+ * WiFiManagerLogLevel.h
+ *
+ * @author alexhopeoconnor
+ * @license MIT
+ *
+ * Compile-time and runtime log levels for WiFiManager. Higher numeric values
+ * mean more verbose output. Matches the old 0..5 tier model for build flags.
+ */
+
+#ifndef WiFiManagerLogLevel_h
+#define WiFiManagerLogLevel_h
+
+#include <Arduino.h>
+
+/** Default subsystem tag for core WiFiManager messages (macro for C++11 embedded toolchains). */
+#define kWiFiMgrLogSubsystem "WM"
+
+enum class WiFiManagerLogLevel : uint8_t {
+    Silent = 0,
+    Error = 1,
+    Warn = 2,
+    Info = 3,
+    Debug = 4,
+    Trace = 5,
+};
+
+/** Full line delivered to Print or WiFiManagerLogSink (prefix and tags included). */
+struct WiFiManagerLogMessage {
+    WiFiManagerLogLevel level;
+    const char* subsystem;
+    String line;
+};
+
+#endif

lib/WiFiManager/include/WiFiManagerLogSink.h

@@ -0,0 +1,22 @@
+/**
+ * WiFiManagerLogSink.h
+ *
+ * @author alexhopeoconnor
+ * @license MIT
+ *
+ * Optional host-provided sink for WiFiManager log output. When set, logs are
+ * delivered here instead of the configured Print stream (usually Serial).
+ */
+
+#ifndef WiFiManagerLogSink_h
+#define WiFiManagerLogSink_h
+
+#include "WiFiManagerLogLevel.h"
+
+class WiFiManagerLogSink {
+public:
+    virtual void log(const WiFiManagerLogMessage& msg) = 0;
+    virtual ~WiFiManagerLogSink() = default;
+};
+
+#endif

lib/WiFiManager/include/WiFiManagerLogTemplates.h

@@ -0,0 +1,48 @@
+/**
+ * WiFiManagerLogTemplates.h
+ *
+ * @author alexhopeoconnor
+ * @license MIT
+ *
+ * Template implementations for WiFiManager::log(...). Included at the end of WiFiManager.h.
+ */
+
+#ifndef WiFiManagerLogTemplates_h
+#define WiFiManagerLogTemplates_h
+
+#include "WiFiManagerLogLevel.h"
+#include <IPAddress.h>
+#include <WString.h>
+
+#if defined(ESP8266) || defined(ESP32)
+
+inline String wmLogStringifyArg(const __FlashStringHelper* v) {
+    return String(v);
+}
+
+inline String wmLogStringifyArg(const IPAddress& v) {
+    return v.toString();
+}
+
+template<typename T>
+inline String wmLogStringifyArg(const T& v) {
+    return String(v);
+}
+
+template<typename T>
+inline void WiFiManager::log(WiFiManagerLogLevel level, const char* subsystem, T&& text) {
+#ifndef WM_NO_LOG
+    emitLogImpl(level, subsystem, wmLogStringifyArg(text), String());
+#endif
+}
+
+template<typename T, typename U>
+inline void WiFiManager::log(WiFiManagerLogLevel level, const char* subsystem, T&& a, U&& b) {
+#ifndef WM_NO_LOG
+    emitLogImpl(level, subsystem, wmLogStringifyArg(a), wmLogStringifyArg(b));
+#endif
+}
+
+#endif // ESP8266 || ESP32
+
+#endif // WiFiManagerLogTemplates_h

lib/WiFiManager/include/WiFiManagerParameter.h

@@ -0,0 +1,64 @@
+/**
+ * WiFiManagerParameter.h
+ *
+ * @author alexhopeoconnor
+ * @license MIT
+ */
+
+#ifndef WiFiManagerParameter_h
+#define WiFiManagerParameter_h
+
+#include <Arduino.h>
+
+class WiFiManager;
+
+#ifndef WIFI_MANAGER_MAX_PARAMS
+    #define WIFI_MANAGER_MAX_PARAMS 5 // params will autoincrement and realloc by this amount when max is reached
+#endif
+
+#define WFM_LABEL_BEFORE 1
+#define WFM_LABEL_AFTER 2
+#define WFM_NO_LABEL 0
+#define WFM_LABEL_DEFAULT 1
+
+class WiFiManagerParameter {
+  public:
+    /**
+        Create custom parameters that can be added to the WiFiManager setup web page
+        @id is used for HTTP queries and must not contain spaces nor other special characters
+    */
+    WiFiManagerParameter();
+    explicit WiFiManagerParameter(const char *custom);
+    WiFiManagerParameter(const char *id, const char *label);
+    WiFiManagerParameter(const char *id, const char *label, const char *defaultValue, int length);
+    WiFiManagerParameter(const char *id, const char *label, const char *defaultValue, int length, const char *custom);
+    WiFiManagerParameter(const char *id, const char *label, const char *defaultValue, int length, const char *custom, int labelPlacement);
+    virtual ~WiFiManagerParameter();
+
+    WiFiManagerParameter(const WiFiManagerParameter&) = delete;
+    WiFiManagerParameter& operator=(const WiFiManagerParameter&) = delete;
+
+    const char *getID() const;
+    const char *getValue() const;
+    const char *getLabel() const;
+    const char *getPlaceholder() const; // @deprecated, use getLabel
+    int         getValueLength() const;
+    int         getLabelPlacement() const;
+    virtual const char *getCustomHTML() const;
+    void        setValue(const char *defaultValue, int length);
+
+  protected:
+    void init(const char *id, const char *label, const char *defaultValue, int length, const char *custom, int labelPlacement);
+
+    const char *_id;
+    const char *_label;
+    char       *_value;
+    int         _length;
+    int         _labelPlacement;
+
+    const char *_customHTML;
+    friend class WiFiManager;
+};
+
+#endif // WiFiManagerParameter_h
+

lib/WiFiManager/include/WiFiManagerPortalUI.h

@@ -0,0 +1,93 @@
+/**
+ * WiFiManagerPortalUI.h
+ *
+ * Deliberate, portal-specific presentation configuration. This header does
+ * not depend on DeviceFramework: WiFiManager remains useful on its own.
+ */
+
+#ifndef WIFI_MANAGER_PORTAL_UI_H
+#define WIFI_MANAGER_PORTAL_UI_H
+
+#include <Arduino.h>
+
+enum class WiFiManagerPortalStorage : uint8_t {
+  Ram,
+  Progmem,
+};
+
+/** Non-owning static text. The caller retains the data for the firmware lifetime. */
+struct WiFiManagerPortalText {
+  const char* data = nullptr;
+  WiFiManagerPortalStorage storage = WiFiManagerPortalStorage::Ram;
+
+  static constexpr WiFiManagerPortalText ram(const char* value) {
+    return {value, WiFiManagerPortalStorage::Ram};
+  }
+  static constexpr WiFiManagerPortalText progmem(const char* value) {
+    return {value, WiFiManagerPortalStorage::Progmem};
+  }
+
+  bool empty() const { return data == nullptr || length() == 0; }
+  size_t length() const {
+    return data == nullptr ? 0 : (storage == WiFiManagerPortalStorage::Progmem ? strlen_P(data) : strlen(data));
+  }
+  char at(size_t index) const {
+    return storage == WiFiManagerPortalStorage::Progmem
+      ? static_cast<char>(pgm_read_byte(data + index))
+      : data[index];
+  }
+};
+
+/** Optional inline SVG branding asset. It is not a general HTML extension point. */
+struct WiFiManagerPortalAsset {
+  WiFiManagerPortalText svg;
+
+  static constexpr WiFiManagerPortalAsset svgFromRam(const char* value) {
+    return {WiFiManagerPortalText::ram(value)};
+  }
+  static constexpr WiFiManagerPortalAsset svgFromProgmem(const char* value) {
+    return {WiFiManagerPortalText::progmem(value)};
+  }
+
+  bool empty() const { return svg.empty(); }
+};
+
+/**
+ * Semantic colour and shape values for WiFiManager's built-in portal.
+ *
+ * Leave a value empty to retain the built-in stylesheet value. Values are
+ * validated before they are emitted into the portal stylesheet; they are not
+ * a general CSS injection mechanism.
+ */
+struct WiFiManagerPortalTheme {
+  WiFiManagerPortalText pageBackground;
+  WiFiManagerPortalText surface;
+  WiFiManagerPortalText text;
+  WiFiManagerPortalText mutedText;
+  WiFiManagerPortalText border;
+  WiFiManagerPortalText accent;
+  WiFiManagerPortalText accentHover;
+  WiFiManagerPortalText accentText;
+  WiFiManagerPortalText danger;
+  WiFiManagerPortalText dangerHover;
+  WiFiManagerPortalText success;
+  uint8_t cornerRadiusPx = 0;
+  uint8_t smallCornerRadiusPx = 0;
+};
+
+/**
+ * Complete setup-time presentation configuration for WiFiManager's portal.
+ *
+ * Text and SVG assets are non-owning static data in RAM or PROGMEM. Apply this
+ * before starting a portal; asynchronous portal responses use immutable state.
+ */
+struct WiFiManagerPortalConfig {
+  WiFiManagerPortalText title;
+  WiFiManagerPortalText identityText;
+  WiFiManagerPortalText tagline;
+  WiFiManagerPortalAsset logo;
+  WiFiManagerPortalText logoAltText;
+  WiFiManagerPortalTheme theme;
+};
+
+#endif  // WIFI_MANAGER_PORTAL_UI_H

lib/WiFiManager/include/WiFiManagerServer.h

@@ -0,0 +1,100 @@
+/**
+ * WiFiManagerServer.h
+ *
+ * @author alexhopeoconnor
+ * @license MIT
+ *
+ * HTTP server for the config portal: single HTML shell (GET /), JSON under /api/..., OTA POST /u,
+ * captive-portal redirects, and 404 handling. No legacy page routes.
+ *
+ * Supported surface (authoritative; registerRoutes mirrors this):
+ *   GET  /
+ *   GET  /api/bootstrap
+ *   GET  /api/wifi/scan-status
+ *   POST /api/wifi/scan
+ *   GET  /api/wifi/meta
+ *   POST /api/wifi/save
+ *   GET  /api/wifi/connect-status
+ *   POST /api/wifi/connect-complete
+ *   POST /api/portal/timeout-reset
+ *   GET  /api/params
+ *   POST /api/params/save
+ *   GET  /api/info
+ *   GET  /api/status
+ *   POST /api/device/restart
+ *   POST /api/device/erase
+ *   POST /api/portal/close
+ *   POST /api/portal/exit
+ *   POST /u                      (multipart firmware upload; JSON completion response)
+ *   notFound -> captive redirect or 404
+ */
+
+#ifndef WiFiManagerServer_h
+#define WiFiManagerServer_h
+
+#if defined(ESP8266) || defined(ESP32)
+
+#include <ESPAsyncWebServer.h>
+#include <DNSServer.h>
+#include <functional>
+#include <memory>
+
+class WiFiManager;
+class WiFiManagerHandlers;
+
+#ifdef WM_DFTE_LOGGING
+class WiFiManagerDfteLogger;
+#endif
+
+// -----------------------------------------------------------------------------------------------
+// HTTP routes (portal API only; no legacy /wifi, /info, … page URLs)
+
+const char R_root[]               PROGMEM = "/";
+
+const char R_api_bootstrap[]      PROGMEM = "/api/bootstrap";
+const char R_api_wifi_scan_status[] PROGMEM = "/api/wifi/scan-status";
+const char R_api_wifi_scan[]      PROGMEM = "/api/wifi/scan";
+const char R_api_wifi_meta[]      PROGMEM = "/api/wifi/meta";
+const char R_api_wifi_save[]      PROGMEM = "/api/wifi/save";
+const char R_api_wifi_connect_status[] PROGMEM = "/api/wifi/connect-status";
+const char R_api_wifi_connect_complete[] PROGMEM = "/api/wifi/connect-complete";
+const char R_api_portal_timeout_reset[] PROGMEM = "/api/portal/timeout-reset";
+const char R_api_params[]         PROGMEM = "/api/params";
+const char R_api_params_save[]    PROGMEM = "/api/params/save";
+const char R_api_info[]           PROGMEM = "/api/info";
+const char R_api_status[]         PROGMEM = "/api/status";
+const char R_api_device_restart[] PROGMEM = "/api/device/restart";
+const char R_api_device_erase[]   PROGMEM = "/api/device/erase";
+const char R_api_portal_close[]   PROGMEM = "/api/portal/close";
+const char R_api_portal_exit[]    PROGMEM = "/api/portal/exit";
+
+const char R_updatedone[]         PROGMEM = "/u";
+
+class WiFiManagerServer {
+  public:
+    WiFiManagerServer(WiFiManager* wm);
+    ~WiFiManagerServer();
+
+    void createServer(uint16_t port);
+    void registerRoutes();
+    void setupDNSD();
+    void processDNS();
+    void shutdownServer();
+    AsyncWebServer* getServer() { return server.get(); }
+    DNSServer* getDNSServer() { return dnsServer.get(); }
+
+  private:
+    WiFiManager* _wm;
+    std::unique_ptr<WiFiManagerHandlers> _handlers;
+    std::unique_ptr<AsyncWebServer> server;
+    std::unique_ptr<DNSServer> dnsServer;
+
+#ifdef WM_DFTE_LOGGING
+    std::unique_ptr<WiFiManagerDfteLogger> _dfteLogger;
+    bool _wmOwnsDfteLogSink = false;
+#endif
+};
+
+#endif // defined(ESP8266) || defined(ESP32)
+
+#endif // WiFiManagerServer_h

lib/WiFiManager/include/WiFiManagerUtils.h

@@ -0,0 +1,106 @@
+/**
+ * WiFiManagerUtils.h
+ * Pure utility functions for WiFiManager
+ * String conversions, HTML encoding, and helper calculations
+ * These functions have no dependency on WiFiManager instance state
+ *
+ * @author alexhopeoconnor
+ * @license MIT
+ */
+
+#ifndef _WIFI_MANAGER_UTILS_H_
+#define _WIFI_MANAGER_UTILS_H_
+
+#include <Arduino.h>
+
+// Forward declaration
+class IPAddress;
+
+namespace WiFiManagerUtils {
+
+// -----------------------------------------------------------------------------------------------
+// WIFI STATUS ARRAYS (for status string conversion)
+
+extern const char * const WIFI_STA_STATUS[] PROGMEM;
+extern const char * const WIFI_MODES[] PROGMEM;
+
+#ifdef ESP32
+extern const char * const AUTH_MODE_NAMES[] PROGMEM;
+#elif defined(ESP8266)
+extern const char * const AUTH_MODE_NAMES[] PROGMEM;
+#endif
+
+// -----------------------------------------------------------------------------------------------
+// STRING CONVERSION UTILITIES
+
+/**
+ * Convert WiFi status code to readable string
+ * @param status WiFi status code
+ * @return Status string or "Unknown" if invalid
+ */
+String getStatusString(uint8_t status);
+
+
+/**
+ * Convert WiFi mode code to readable string
+ * @param mode WiFi mode code
+ * @return Mode string or "Unknown" if invalid
+ */
+String getModeString(uint8_t mode);
+
+/**
+ * Convert encryption/auth mode to readable string
+ * @param authmode Encryption type code
+ * @return Encryption type string
+ */
+String getEncryptionString(uint8_t authmode);
+
+// -----------------------------------------------------------------------------------------------
+// HTML UTILITIES
+
+/**
+ * Encode HTML entities in a string
+ * @param str String to encode
+ * @param whitespace If true, also encode spaces as &#160;
+ * @return Encoded string
+ */
+String htmlEntities(const String& str, bool whitespace = false);
+
+// -----------------------------------------------------------------------------------------------
+// IP/STRING UTILITIES
+
+/**
+ * Check if string is a valid IP address
+ * @param str String to check
+ * @return true if valid IP address
+ */
+bool isValidIP(const String& str);
+
+/**
+ * Convert IPAddress to String
+ * @param ip IPAddress to convert
+ * @return IP address string
+ */
+String ipToString(IPAddress ip);
+
+/**
+ * Validate AP password format (8-63 characters)
+ * @param password Password to validate
+ * @return true if valid
+ */
+bool isValidAPPassword(const String& password);
+
+// -----------------------------------------------------------------------------------------------
+// HELPER CALCULATIONS
+
+/**
+ * Convert RSSI value to quality percentage (0-100)
+ * @param rssi RSSI value in dBm
+ * @return Quality percentage (0-100)
+ */
+int rssiToQuality(int rssi);
+
+} // namespace WiFiManagerUtils
+
+#endif // _WIFI_MANAGER_UTILS_H_
+

lib/WiFiManager/include/templates/CSS.h

@@ -0,0 +1,233 @@
+/**
+ * CSS.h
+ *
+ * @author alexhopeoconnor
+ * @license MIT
+ *
+ * CSS stylesheet for WiFiManager web interface.
+ * Embedded styles to avoid external file dependencies.
+ */
+
+#ifndef _CSS_TEMPLATES_H_
+#define _CSS_TEMPLATES_H_
+
+#include <Arduino.h>
+
+const char CSS_STYLE[] PROGMEM = "<style>"
+/* Design tokens */
+":root{"
+"--wm-bg:#f0f4f8;"
+"--wm-surface:#ffffff;"
+"--wm-text:#0f172a;"
+"--wm-muted:#64748b;"
+"--wm-border:#e2e8f0;"
+"--wm-brand:#0ea5e9;"
+"--wm-brand-hover:#0284c7;"
+"--wm-brand-text:#ffffff;"
+"--wm-danger:#dc2626;"
+"--wm-danger-hover:#b91c1c;"
+"--wm-success:#16a34a;"
+"--wm-radius:12px;"
+"--wm-radius-sm:8px;"
+"--wm-shadow:0 1px 3px rgba(15,23,42,.08),0 4px 16px rgba(15,23,42,.06);"
+"--wm-font:system-ui,-apple-system,'Segoe UI',Roboto,'Helvetica Neue',Arial,sans-serif;"
+"}"
+"body.invert{"
+"--wm-bg:#0c1222;"
+"--wm-surface:#151d2e;"
+"--wm-text:#f1f5f9;"
+"--wm-muted:#94a3b8;"
+"--wm-border:#334155;"
+"--wm-brand:#38bdf8;"
+"--wm-brand-hover:#7dd3fc;"
+"--wm-danger:#f87171;"
+"--wm-danger-hover:#fca5a5;"
+"--wm-success:#4ade80;"
+"--wm-shadow:0 4px 24px rgba(0,0,0,.45);"
+"}"
+/* Base */
+"*,*::before,*::after{box-sizing:border-box}"
+"body.portal{margin:0;min-height:100vh;background:var(--wm-bg);color:var(--wm-text);"
+"font-family:var(--wm-font);font-size:16px;line-height:1.5;-webkit-text-size-adjust:100%;text-align:left}"
+"a{color:var(--wm-brand);font-weight:600;text-decoration:none}"
+"a:hover{color:var(--wm-brand-hover);text-decoration:underline}"
+/* Layout shell */
+".wm-layout{width:100%;max-width:420px;margin:0 auto;padding:16px 18px 28px;}"
+"h1,h2,h3{margin:0 0 .35em;font-weight:700;letter-spacing:-.02em}"
+"h1{font-size:1.5rem}"
+"h2{font-size:1.15rem}"
+"h3{font-size:1rem}"
+"p{margin:.5em 0}"
+/* Top navigation — single row; overflow scrollable but scrollbar hidden (touch still pans) */
+".wm-nav{display:flex;flex-wrap:nowrap;align-items:stretch;gap:4px;margin:0 0 20px;padding:4px 6px;"
+"overflow-x:auto;-webkit-overflow-scrolling:touch;scrollbar-width:none;-ms-overflow-style:none;"
+"background:var(--wm-surface);border-radius:var(--wm-radius);box-shadow:var(--wm-shadow);border:1px solid var(--wm-border)}"
+".wm-nav::-webkit-scrollbar{display:none;width:0;height:0}"
+".wm-nav-link{display:inline-flex;align-items:center;justify-content:center;flex:0 0 auto;padding:6px 8px;border-radius:var(--wm-radius-sm);"
+"font-size:.8rem;font-weight:600;color:var(--wm-muted);text-decoration:none;border:1px solid transparent;white-space:nowrap}"
+".wm-nav-link:hover{color:var(--wm-brand);background:rgba(14,165,233,.08);text-decoration:none}"
+"body.invert .wm-nav-link:hover{background:rgba(56,189,248,.12)}"
+".wm-nav-link--active{color:var(--wm-text);background:rgba(14,165,233,.15);border-color:rgba(14,165,233,.35)}"
+"body.invert .wm-nav-link--active{background:rgba(56,189,248,.2);border-color:rgba(56,189,248,.4)}"
+".wm-nav .wm-icon-label{gap:4px}"
+".wm-nav .wm-icon{width:.95rem;height:.95rem;flex:0 0 .95rem}"
+".wm-icon-label{display:inline-flex;align-items:center;gap:8px;min-width:0}"
+".wm-icon{display:inline-flex;align-items:center;justify-content:center;width:1.1rem;height:1.1rem;flex:0 0 1.1rem;color:currentColor}"
+".wm-icon svg{display:block;width:100%;height:100%}"
+/* Header / page chrome */
+".wm-site-header{display:flex;align-items:center;gap:10px;min-height:40px;margin:0 0 12px}"
+".wm-site-logo{display:flex;align-items:center;justify-content:center;width:40px;height:40px;flex:0 0 40px;line-height:0}"
+".wm-site-logo svg{display:block;width:100%;height:100%}"
+".wm-site-brand-copy{min-width:0}"
+".wm-site-brand-name{margin:0;font-size:.78rem;font-weight:800;letter-spacing:.09em;text-transform:uppercase;color:var(--wm-text)}"
+".wm-site-tagline{margin:2px 0 0;font-size:.82rem;line-height:1.25;color:var(--wm-muted)}"
+".wm-page-head{margin-bottom:16px}"
+".wm-page-head h1{font-size:1.45rem}"
+".wm-page-desc{font-size:.95rem;color:var(--wm-muted);margin:.35em 0 0}"
+/* Cards */
+".wm-card{background:var(--wm-surface);border:1px solid var(--wm-border);border-radius:var(--wm-radius);"
+"box-shadow:var(--wm-shadow);padding:18px 16px;margin-bottom:16px;text-align:left}"
+".wm-scan-card,.wm-ota-card{position:relative;overflow:hidden}"
+".wm-scan-results{min-height:126px}"
+".wm-card-title{font-size:1rem;margin:0 0 12px;padding-bottom:10px;border-bottom:1px solid var(--wm-border);"
+"color:var(--wm-text)}"
+".wm-card-subtitle{margin:-4px 0 12px;font-size:.9rem;line-height:1.45;color:var(--wm-muted)}"
+".wm-lead{margin:0 0 8px;font-size:.95rem;color:var(--wm-muted);line-height:1.5}"
+".wm-home-summary{margin:0 0 14px;font-size:1rem;font-weight:600;line-height:1.45;color:var(--wm-text)}"
+/* Callout / status */
+".wm-callout{padding:12px 14px;border-radius:var(--wm-radius-sm);border:1px solid var(--wm-border);"
+"background:rgba(14,165,233,.06);margin-bottom:16px}"
+"body.invert .wm-callout{background:rgba(56,189,248,.08)}"
+".wm-callout--info{border-left:4px solid var(--wm-brand)}"
+".wm-info-summary{font-weight:600;color:var(--wm-text)}"
+".wm-status{margin:0 0 12px;padding:10px 12px;font-size:.92rem;font-weight:700;color:var(--wm-brand);"
+"text-align:center;border-radius:var(--wm-radius-sm);background:rgba(14,165,233,.08);border:1px solid rgba(14,165,233,.18)}"
+".wm-status--warning{color:#c2410c;background:rgba(249,115,22,.12);border-color:rgba(249,115,22,.28)}"
+".wm-status--caution{color:#a16207;background:rgba(234,179,8,.14);border-color:rgba(234,179,8,.3)}"
+".wm-status--danger{color:var(--wm-danger);background:rgba(220,38,38,.12);border-color:rgba(220,38,38,.28)}"
+"body.invert .wm-status{background:rgba(56,189,248,.12);border-color:rgba(56,189,248,.22)}"
+"body.invert .wm-status--warning{background:rgba(249,115,22,.18);border-color:rgba(249,115,22,.34)}"
+"body.invert .wm-status--caution{background:rgba(234,179,8,.18);border-color:rgba(234,179,8,.34)}"
+"body.invert .wm-status--danger{background:rgba(220,38,38,.18);border-color:rgba(220,38,38,.34)}"
+/* Form fields */
+".wm-field{margin-bottom:14px;text-align:left}"
+".wm-field:last-child{margin-bottom:0}"
+".wm-field label{display:block;font-size:.82rem;font-weight:600;color:var(--wm-muted);margin-bottom:6px}"
+"input[type=text],input[type=password],input[type=number],input[type=email],select{"
+"display:block;width:100%;padding:12px 14px;font-size:1rem;font-family:inherit;"
+"color:var(--wm-text);background:var(--wm-bg);border:1px solid var(--wm-border);border-radius:var(--wm-radius-sm);"
+"-webkit-appearance:none;appearance:none}"
+"input:focus,select:focus{outline:2px solid var(--wm-brand);outline-offset:0;border-color:var(--wm-brand)}"
+"input[type=radio],input[type=checkbox]{width:auto;margin-right:8px;accent-color:var(--wm-brand)}"
+".wm-checkbox-row{display:flex;align-items:center;gap:8px;margin:12px 0;font-size:.92rem}"
+".wm-checkbox-row label{display:inline;margin:0;font-weight:500;color:var(--wm-text)}"
+".wm-form-actions{margin-top:16px}"
+".wm-wifi-details-card{position:relative}"
+".wm-wifi-save-overlay{position:fixed;inset:0;z-index:10002;display:none;align-items:center;justify-content:center;padding:18px;"
+"box-sizing:border-box;background:rgba(15,23,42,.58)}"
+".wm-wifi-save-panel{display:flex;align-items:center;gap:14px;width:100%;max-width:340px;padding:18px;border:1px solid var(--wm-border);"
+"border-radius:var(--wm-radius-sm);background:var(--wm-surface);box-shadow:var(--wm-shadow);text-align:left}"
+".wm-wifi-save-panel strong{display:block;font-size:1rem;color:var(--wm-text)}"
+".wm-wifi-save-panel p{margin:4px 0 0;font-size:.9rem;line-height:1.45;color:var(--wm-muted)}"
+".wm-operation-overlay{position:absolute;inset:0;z-index:5;display:none;align-items:center;justify-content:center;padding:16px;background:rgba(15,23,42,.56)}"
+".wm-operation-panel{display:flex;align-items:center;gap:12px;width:100%;max-width:310px;padding:16px;border:1px solid var(--wm-border);border-radius:var(--wm-radius-sm);background:var(--wm-surface);box-shadow:var(--wm-shadow);text-align:left}"
+".wm-operation-panel strong{display:block;font-size:.98rem;color:var(--wm-text)}"
+".wm-operation-panel p{margin:3px 0 0;font-size:.88rem;line-height:1.4;color:var(--wm-muted)}"
+".wm-operation-progress{margin-top:10px}"
+".wm-operation-progress-track{height:7px;overflow:hidden;border-radius:999px;background:var(--wm-border)}"
+".wm-operation-progress-track span{display:block;width:0;height:100%;border-radius:inherit;background:var(--wm-brand);transition:width .15s ease}"
+".wm-operation-progress-label{display:block;margin-top:4px;font-size:.8rem;font-weight:700;color:var(--wm-muted);text-align:right}"
+".wm-portal-timeout-row{display:flex;align-items:stretch;gap:8px;margin:0 0 12px}"
+".wm-portal-timeout-row .wm-status{flex:1;margin:0}"
+".wm-icon-button{display:inline-flex;align-items:center;justify-content:center;width:42px;min-height:42px;padding:0;border:1px solid var(--wm-border);border-radius:var(--wm-radius-sm);background:var(--wm-bg);color:var(--wm-text);cursor:pointer}"
+".wm-icon-button:hover{border-color:var(--wm-brand);color:var(--wm-brand)}"
+".wm-icon-button:disabled{opacity:.5;cursor:not-allowed}"
+".wm-icon-button .wm-icon{width:1.05rem;height:1.05rem}"
+".wm-inline-link{display:inline-block;margin-top:12px;font-size:.92rem}"
+".wm-spinner{width:24px;height:24px;flex:0 0 24px;border:3px solid var(--wm-border);border-top-color:var(--wm-brand);border-radius:50%;animation:wm-spin .8s linear infinite}"
+"@keyframes wm-spin{to{transform:rotate(360deg)}}"
+"@media (prefers-reduced-motion:reduce){.wm-spinner{animation:none;border-right-color:var(--wm-brand)}}"
+/* Buttons */
+".wm-btn{display:inline-flex;align-items:center;justify-content:center;min-height:44px;padding:0 18px;"
+"font-size:1rem;font-weight:600;font-family:inherit;border-radius:var(--wm-radius-sm);border:0;cursor:pointer;"
+"transition:background .15s,transform .1s,opacity .15s}"
+".wm-btn:disabled{opacity:.5;cursor:not-allowed}"
+".wm-btn:active{transform:scale(.98)}"
+"a.wm-btn{box-sizing:border-box;text-decoration:none}"
+".wm-btn .wm-icon-label{justify-content:center}"
+".wm-btn--block{width:100%}"
+".wm-btn--primary{background:var(--wm-brand);color:var(--wm-brand-text)}"
+".wm-btn--primary:hover{background:var(--wm-brand-hover)}"
+".wm-btn--secondary{background:var(--wm-bg);color:var(--wm-text);border:1px solid var(--wm-border)}"
+".wm-btn--secondary:hover{border-color:var(--wm-brand);color:var(--wm-brand)}"
+".wm-btn--danger{background:var(--wm-danger);color:var(--wm-brand-text)}"
+".wm-btn--danger:hover{background:var(--wm-danger-hover)}"
+"input[type=file]{width:100%;padding:10px;border:1px dashed var(--wm-border);border-radius:var(--wm-radius-sm);"
+"background:var(--wm-bg);font-size:.9rem}"
+/* Legacy: unclassed submit in forms */
+"button[type=submit],.wm-form-actions .wm-btn--primary{background:var(--wm-brand);color:var(--wm-brand-text)}"
+"button[type=submit]:hover{background:var(--wm-brand-hover)}"
+/* Device actions / button stack */
+".wm-actions-stack{display:flex;flex-direction:column;gap:10px;margin-top:4px}"
+".wm-btn-group{display:flex;flex-direction:column;gap:10px}"
+/* WiFi scan list */
+".wm-scan-list{margin:0 0 12px;border:1px solid var(--wm-border);border-radius:var(--wm-radius-sm);"
+"overflow:hidden;background:var(--wm-bg)}"
+".wm-scan-row{display:flex;align-items:center;gap:10px;min-height:48px;padding:10px 12px;"
+"border-bottom:1px solid var(--wm-border);text-decoration:none;color:inherit;cursor:pointer}"
+".wm-scan-row:last-child{border-bottom:0}"
+".wm-scan-row:hover{background:rgba(14,165,233,.1)}"
+"body.invert .wm-scan-row:hover{background:rgba(56,189,248,.12)}"
+".wm-scan-ssid{flex:1;min-width:0;font-weight:600;font-size:.95rem;text-align:left;word-break:break-word}"
+".wm-scan-meta{display:flex;align-items:center;justify-content:flex-end;gap:6px;flex-shrink:0;min-width:78px}"
+".wm-scan-signal{display:block;flex-shrink:0;font-size:.8rem;color:var(--wm-muted);font-weight:600;min-width:38px;text-align:right}"
+".wm-scan-lock,.wm-scan-bars{display:block;flex:0 0 16px}"
+// quality icons
+".q{position:relative;height:16px;width:16px;margin:0;padding:0;flex-shrink:0}.q.q-0:after{background-position-x:0}.q.q-1:after{background-position-x:-16px}.q.q-2:after{background-position-x:-32px}.q.q-3:after{background-position-x:-48px}.q.q-4:after{background-position-x:-64px}.q.l:before{background-position-x:-80px}.ql .q{float:left}.q:after,.q:before{content:'';position:absolute;left:0;top:0;width:16px;height:16px;display:block;background-repeat:no-repeat;background-position:16px 0;"
+"background-image:url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGAAAAAQCAMAAADeZIrLAAAAJFBMVEX///8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADHJj5lAAAAC3RSTlMAIjN3iJmqu8zd7vF8pzcAAABsSURBVHja7Y1BCsAwCASNSVo3/v+/BUEiXnIoXkoX5jAQMxTHzK9cVSnvDxwD8bFx8PhZ9q8FmghXBhqA1faxk92PsxvRc2CCCFdhQCbRkLoAQ3q/wWUBqG35ZxtVzW4Ed6LngPyBU2CobdIDQ5oPWI5nCUwAAAAASUVORK5CYII=');}"
+".wm-scan-lock:after,.wm-scan-bars:before{content:none}"
+"@media (-webkit-min-device-pixel-ratio: 2),(min-resolution: 192dpi){.q:before,.q:after {"
+"background-image:url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAALwAAAAgCAMAAACfM+KhAAAALVBMVEX///8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADAOrOgAAAADnRSTlMAESIzRGZ3iJmqu8zd7gKjCLQAAACmSURBVHgB7dDBCoMwEEXRmKlVY3L//3NLhyzqIqSUggy8uxnhCR5Mo8xLt+14aZ7wwgsvvPA/ofv9+44334UXXngvb6XsFhO/VoC2RsSv9J7x8BnYLW+AjT56ud/uePMdb7IP8Bsc/e7h8Cfk912ghsNXWPpDC4hvN+D1560A1QPORyh84VKLjjdvfPFm++i9EWq0348XXnjhhT+4dIbCW+WjZim9AKk4UZMnnCEuAAAAAElFTkSuQmCC');"
+"background-size: 95px 16px;}}"
+// messages from firmware / server
+".msg{padding:16px;margin:12px 0;border-radius:var(--wm-radius-sm);border:1px solid var(--wm-border);"
+"border-left-width:4px;border-left-color:var(--wm-muted);background:var(--wm-surface);text-align:left}"
+".msg h4{margin:0 0 8px;font-size:1rem}"
+".msg.P{border-left-color:var(--wm-brand)}.msg.P h4{color:var(--wm-brand)}"
+".msg.D{border-left-color:var(--wm-danger)}.msg.D h4{color:var(--wm-danger)}"
+".msg.S{border-left-color:var(--wm-success)}.msg.S h4{color:var(--wm-success)}"
+"dt{font-weight:700;font-size:.85rem;color:var(--wm-muted)}dd{margin:2px 0 12px 0;padding:0;font-size:.95rem}"
+"td{vertical-align:top}"
+".h{display:none}"
+/* Info page key-value grid */
+".wm-kv{margin:0;padding:0}"
+".wm-kv dt{padding-top:10px}"
+".wm-kv dt:first-of-type{padding-top:0}"
+".wm-kv dd{margin-left:0;padding-bottom:4px;border-bottom:1px solid var(--wm-border)}"
+".wm-kv dd:last-of-type{border-bottom:0}"
+/* Feedback areas */
+"#wm-wifi-msg,#wm-param-msg{font-size:.9rem;margin-top:12px;min-height:1.2em;color:var(--wm-muted)}"
+// invert legacy body
+"body.invert{background-color:var(--wm-bg)}"
+"body.invert .msg{border-color:var(--wm-border)}"
+"body.invert .q[role=img]{-webkit-filter:invert(1);filter:invert(1)}"
+":disabled{opacity:.55}"
+// toast + modal
+".wm-toast{position:fixed;left:50%;top:12px;transform:translateX(-50%);z-index:10001;max-width:92%;padding:12px 16px;border-radius:var(--wm-radius-sm);"
+"box-shadow:var(--wm-shadow);font-size:.95rem;text-align:center;font-weight:600}"
+".wm-toast.ok{background:rgba(22,163,74,.15);border:1px solid var(--wm-success);color:var(--wm-text)}"
+".wm-toast.err{background:rgba(220,38,38,.12);border:1px solid var(--wm-danger);color:var(--wm-text)}"
+".wm-dialog{position:fixed;inset:0;z-index:10000;display:none;align-items:center;justify-content:center;padding:16px;box-sizing:border-box}"
+".wm-dialog-backdrop{position:absolute;inset:0;background:rgba(15,23,42,.5)}"
+".wm-dialog-panel{position:relative;z-index:1;background:var(--wm-surface);border-radius:var(--wm-radius);padding:20px 18px;max-width:400px;width:100%;"
+"box-shadow:var(--wm-shadow);border:1px solid var(--wm-border);text-align:left}"
+".wm-dialog-msg{margin:0 0 16px;line-height:1.45;color:var(--wm-text)}"
+".wm-dialog-actions{display:flex;gap:10px;justify-content:flex-end;flex-wrap:wrap}"
+".wm-dialog-actions .wm-btn{min-width:108px}"
+".wm-dialog-ok,.wm-btn.wm-dialog-ok{background:var(--wm-brand)!important;color:var(--wm-brand-text)!important}"
+".wm-dialog-ok:hover{background:var(--wm-brand-hover)!important}"
+"body.invert .wm-toast.ok{background:rgba(22,163,74,.2)}"
+"body.invert .wm-toast.err{background:rgba(220,38,38,.2)}"
+"</style>";
+
+#endif // _CSS_TEMPLATES_H_

lib/WiFiManager/include/templates/RootShell.h

@@ -0,0 +1,48 @@
+/**
+ * RootShell.h
+ *
+ * @author alexhopeoconnor
+ * @license MIT
+ *
+ * Single-page portal shell: only HTML document served for GET /.
+ * Dynamic UI is driven by embedded JS + JSON APIs under /api/...
+ *
+ * Placeholder keys (%PAGE_TITLE%, %STYLES%, %PORTAL_THEME%, %BOOTSTRAP_JSON%, %PORTAL_APP_JS%) are filled
+ * per request in WiFiManagerHandlers::handleRoot; do not treat placeholders as a customization API.
+ */
+
+#ifndef _WM_ROOT_SHELL_TEMPLATE_H_
+#define _WM_ROOT_SHELL_TEMPLATE_H_
+
+#include <Arduino.h>
+
+const char WM_ROOT_SHELL_TEMPLATE[] PROGMEM =
+    "<!DOCTYPE html>"
+    "<html lang='en'>"
+    "<head>"
+    "<meta name='format-detection' content='telephone=no'>"
+    "<meta charset='UTF-8'/>"
+    "<meta name='viewport' content='width=device-width,initial-scale=1,user-scalable=no'/>"
+    "<title>%PAGE_TITLE%</title>"
+    "%STYLES%"
+    "%PORTAL_THEME%"
+    "</head>"
+    "<body class='portal'>"
+    "<div id='wm-toast' class='wm-toast' aria-live='polite' role='status' style='display:none'></div>"
+    "<div id='wm-dialog' class='wm-dialog' style='display:none' aria-hidden='true'>"
+    "<div class='wm-dialog-backdrop' id='wm-dialog-backdrop'></div>"
+    "<div class='wm-dialog-panel'>"
+    "<p class='wm-dialog-msg' id='wm-dialog-msg'></p>"
+    "<div class='wm-dialog-actions'>"
+    "<button type='button' id='wm-dialog-cancel' class='wm-btn wm-btn--secondary'>Cancel</button>"
+    "<button type='button' id='wm-dialog-ok' class='wm-btn wm-btn--primary wm-dialog-ok'>OK</button>"
+    "</div></div></div>"
+    "<div id='app'></div>"
+    "<script id='wm-bootstrap' type='application/json'>%BOOTSTRAP_JSON%</script>"
+    "<script>"
+    "%PORTAL_APP_JS%"
+    "</script>"
+    "</body>"
+    "</html>";
+
+#endif  // _WM_ROOT_SHELL_TEMPLATE_H_

lib/WiFiManager/src/WiFiManagerParameter.cpp

@@ -0,0 +1,111 @@
+/**
+ * WiFiManagerParameter.cpp
+ *
+ * @author alexhopeoconnor
+ * @license MIT
+ */
+
+#include "WiFiManagerParameter.h"
+
+#include <cstring>
+#include <new>
+
+WiFiManagerParameter::WiFiManagerParameter()
+  : WiFiManagerParameter("")
+{
+}
+
+WiFiManagerParameter::WiFiManagerParameter(const char *custom) {
+  _id             = NULL;
+  _label          = NULL;
+  _length         = 0;
+  _value          = nullptr;
+  _labelPlacement = WFM_LABEL_DEFAULT;
+  _customHTML     = custom;
+}
+
+WiFiManagerParameter::WiFiManagerParameter(const char *id, const char *label) {
+  init(id, label, "", 0, "", WFM_LABEL_DEFAULT);
+}
+
+WiFiManagerParameter::WiFiManagerParameter(const char *id, const char *label, const char *defaultValue, int length) {
+  init(id, label, defaultValue, length, "", WFM_LABEL_DEFAULT);
+}
+
+WiFiManagerParameter::WiFiManagerParameter(const char *id, const char *label, const char *defaultValue, int length, const char *custom) {
+  init(id, label, defaultValue, length, custom, WFM_LABEL_DEFAULT);
+}
+
+WiFiManagerParameter::WiFiManagerParameter(const char *id, const char *label, const char *defaultValue, int length, const char *custom, int labelPlacement) {
+  init(id, label, defaultValue, length, custom, labelPlacement);
+}
+
+void WiFiManagerParameter::init(const char *id, const char *label, const char *defaultValue, int length, const char *custom, int labelPlacement) {
+  _id             = id;
+  _label          = label;
+  _labelPlacement = labelPlacement;
+  _customHTML     = custom;
+  _length         = 0;
+  _value          = nullptr;
+  setValue(defaultValue,length);
+}
+
+WiFiManagerParameter::~WiFiManagerParameter() {
+  if (_value != NULL) {
+    delete[] _value;
+  }
+  _length=0; // setting length 0, ideally the entire parameter should be removed, or added to wifimanager scope so it follows
+}
+
+// WiFiManagerParameter& WiFiManagerParameter::operator=(const WiFiManagerParameter& rhs){
+//   Serial.println("copy assignment op called");
+//   (*this->_value) = (*rhs._value);
+//   return *this;
+// }
+
+// @note debug is not available in wmparameter class
+void WiFiManagerParameter::setValue(const char *defaultValue, int length) {
+  if (!_id || length < 0) {
+    return;
+  }
+
+  if (_length != length || _value == nullptr) {
+    char* replacement = new (std::nothrow) char[static_cast<size_t>(length) + 1];
+    if (!replacement) {
+      return;
+    }
+
+    delete[] _value;
+    _value = replacement;
+    _length = length;
+  }
+
+  memset(_value, 0, static_cast<size_t>(_length) + 1);
+
+  if (defaultValue != nullptr) {
+    strncpy(_value, defaultValue, _length);
+  }
+}
+const char* WiFiManagerParameter::getValue() const {
+  // Serial.println(printf("Address of _value is %p\n", (void *)_value));
+  return _value;
+}
+const char* WiFiManagerParameter::getID() const {
+  return _id;
+}
+const char* WiFiManagerParameter::getPlaceholder() const {
+  return _label;
+}
+const char* WiFiManagerParameter::getLabel() const {
+  return _label;
+}
+int WiFiManagerParameter::getValueLength() const {
+  return _length;
+}
+int WiFiManagerParameter::getLabelPlacement() const {
+  return _labelPlacement;
+}
+const char* WiFiManagerParameter::getCustomHTML() const {
+  return _customHTML;
+}
+

lib/WiFiManager/src/WiFiManagerServer.cpp

@@ -0,0 +1,184 @@
+/**
+ * WiFiManagerServer.cpp
+ *
+ * @author alexhopeoconnor
+ * @license MIT
+ *
+ * HTTP server lifecycle and route registration only. HTML shell rendering is request-scoped in
+ * WiFiManagerHandlers (WM_ROOT_SHELL_TEMPLATE + per-request placeholder registry).
+ * Route inventory matches WiFiManagerServer.h (GET /, /api/..., POST /u, onNotFound).
+ */
+
+#include "WiFiManagerServer.h"
+#include "WiFiManager.h"
+#include "WiFiManagerHandlers.h"
+#ifdef WM_DFTE_LOGGING
+#include "WiFiManagerDfteLogger.h"
+#include <DeviceFrameworkTemplateEngineDebug.h>
+#endif
+
+#if defined(ESP8266) || defined(ESP32)
+
+WiFiManagerServer::WiFiManagerServer(WiFiManager* wm)
+    : _wm(wm), _handlers(std::make_unique<WiFiManagerHandlers>(wm)) {}
+
+WiFiManagerServer::~WiFiManagerServer() = default;
+
+void WiFiManagerServer::createServer(uint16_t port) {
+  if (server) {
+#ifndef WM_NO_LOG
+    _wm->log(WiFiManagerLogLevel::Debug, kWiFiMgrLogSubsystem, F("Server already exists, shutting down first"));
+#endif
+    shutdownServer();
+  }
+
+#ifndef WM_NO_LOG
+  _wm->log(WiFiManagerLogLevel::Info, kWiFiMgrLogSubsystem, F("Starting Web Portal"));
+#endif
+
+  if (port != 80) {
+#ifndef WM_NO_LOG
+    _wm->log(WiFiManagerLogLevel::Debug, kWiFiMgrLogSubsystem, F("http server started with custom port: "), port);
+#endif
+  }
+
+  server.reset(new AsyncWebServer(port));
+
+#ifdef WM_DFTE_LOGGING
+  // DFTE logging is still owned by server lifecycle; it is intentionally independent of
+  // request-scoped shell rendering / placeholder registration.
+  if (!deviceFrameworkTemplateEngineIsLoggingEnabled()) {
+    if (!_dfteLogger) {
+      _dfteLogger = std::make_unique<WiFiManagerDfteLogger>(_wm);
+    }
+    deviceFrameworkTemplateEngineEnableLogging(_dfteLogger.get(), static_cast<const void*>(this));
+    _wmOwnsDfteLogSink = true;
+  }
+#endif
+}
+
+void WiFiManagerServer::registerRoutes() {
+  if (!server) {
+#ifndef WM_NO_LOG
+    _wm->log(WiFiManagerLogLevel::Error, kWiFiMgrLogSubsystem, F("[ERROR] Server not created, call createServer() first"));
+#endif
+    return;
+  }
+
+  if (_wm->_webservercallback != NULL) {
+#ifndef WM_NO_LOG
+    _wm->log(WiFiManagerLogLevel::Debug, kWiFiMgrLogSubsystem, F("[CB] _webservercallback calling"));
+#endif
+    _wm->_webservercallback();
+  }
+
+  // Shell: only HTML document. JSON + actions + OTA below (no legacy /wifi, /info, … routes).
+
+  server->on(WM_G(R_root), HTTP_GET, [this](AsyncWebServerRequest *request) {
+    this->_handlers->handleRoot(request);
+  });
+
+  server->on(WM_G(R_api_bootstrap), HTTP_GET, [this](AsyncWebServerRequest *request) {
+    this->_handlers->handleApiBootstrap(request);
+  });
+  server->on(WM_G(R_api_wifi_scan_status), HTTP_GET, [this](AsyncWebServerRequest *request) {
+    this->_handlers->handleApiWifiScanStatus(request);
+  });
+  server->on(WM_G(R_api_wifi_scan), HTTP_POST, [this](AsyncWebServerRequest *request) {
+    this->_handlers->handleApiWifiScan(request);
+  });
+  server->on(WM_G(R_api_wifi_meta), HTTP_GET, [this](AsyncWebServerRequest *request) {
+    this->_handlers->handleApiWifiMeta(request);
+  });
+  server->on(WM_G(R_api_wifi_save), HTTP_POST, [this](AsyncWebServerRequest *request) {
+    this->_handlers->handleApiWifiSave(request);
+  });
+  server->on(WM_G(R_api_wifi_connect_status), HTTP_GET, [this](AsyncWebServerRequest *request) {
+    this->_handlers->handleApiWifiConnectStatus(request);
+  });
+  server->on(WM_G(R_api_wifi_connect_complete), HTTP_POST, [this](AsyncWebServerRequest *request) {
+    this->_handlers->handleApiWifiConnectComplete(request);
+  });
+  server->on(WM_G(R_api_portal_timeout_reset), HTTP_POST, [this](AsyncWebServerRequest *request) {
+    this->_handlers->handleApiPortalTimeoutReset(request);
+  });
+  server->on(WM_G(R_api_params), HTTP_GET, [this](AsyncWebServerRequest *request) {
+    this->_handlers->handleApiParamsGet(request);
+  });
+  server->on(WM_G(R_api_params_save), HTTP_POST, [this](AsyncWebServerRequest *request) {
+    this->_handlers->handleApiParamsSave(request);
+  });
+  server->on(WM_G(R_api_info), HTTP_GET, [this](AsyncWebServerRequest *request) {
+    this->_handlers->handleApiInfo(request);
+  });
+  server->on(WM_G(R_api_status), HTTP_GET, [this](AsyncWebServerRequest *request) {
+    this->_handlers->handleApiStatus(request);
+  });
+  server->on(WM_G(R_api_device_restart), HTTP_POST, [this](AsyncWebServerRequest *request) {
+    this->_handlers->handleApiDeviceRestart(request);
+  });
+  server->on(WM_G(R_api_device_erase), HTTP_POST, [this](AsyncWebServerRequest *request) {
+    this->_handlers->handleApiDeviceErase(request);
+  });
+  server->on(WM_G(R_api_portal_close), HTTP_POST, [this](AsyncWebServerRequest *request) {
+    this->_handlers->handleApiPortalClose(request);
+  });
+  server->on(WM_G(R_api_portal_exit), HTTP_POST, [this](AsyncWebServerRequest *request) {
+    this->_handlers->handleApiPortalExit(request);
+  });
+
+  server->on(WM_G(R_updatedone), HTTP_POST,
+              [this](AsyncWebServerRequest *request) {
+                this->_handlers->handleUpdateDone(request);
+              },
+              [this](AsyncWebServerRequest *request, String filename, size_t index, uint8_t *data, size_t len,
+                     bool final) {
+                this->_handlers->handleUpdating(request, filename, index, data, len, final);
+              });
+
+  server->onNotFound([this](AsyncWebServerRequest *request) {
+    this->_handlers->handleNotFound(request);
+  });
+
+  server->begin();
+#ifndef WM_NO_LOG
+  _wm->log(WiFiManagerLogLevel::Debug, kWiFiMgrLogSubsystem, F("HTTP server started"));
+#endif
+}
+
+void WiFiManagerServer::setupDNSD() {
+  dnsServer.reset(new DNSServer());
+  dnsServer->setErrorReplyCode(DNSReplyCode::NoError);
+#ifndef WM_NO_LOG
+  _wm->log(WiFiManagerLogLevel::Trace, kWiFiMgrLogSubsystem, F("dns server started with ip: "), WiFi.softAPIP());
+#endif
+  const uint8_t DNS_PORT = 53;
+  dnsServer->start(DNS_PORT, F("*"), WiFi.softAPIP());
+}
+
+void WiFiManagerServer::processDNS() {
+  if (dnsServer) {
+    dnsServer->processNextRequest();
+  }
+}
+
+void WiFiManagerServer::shutdownServer() {
+#ifdef WM_DFTE_LOGGING
+  if (_wmOwnsDfteLogSink) {
+    deviceFrameworkTemplateEngineDisableLoggingForOwner(static_cast<const void*>(this));
+    _dfteLogger.reset();
+    _wmOwnsDfteLogSink = false;
+  }
+#endif
+
+  if (server) {
+    server.reset();
+  }
+
+  if (dnsServer) {
+    dnsServer->stop();
+    dnsServer.reset();
+  }
+}
+
+#endif

lib/WiFiManager/src/WiFiManagerUtils.cpp

@@ -0,0 +1,135 @@
+/**
+ * WiFiManagerUtils.cpp
+ * Implementation of pure utility functions for WiFiManager
+ *
+ * @author alexhopeoconnor
+ * @license MIT
+ */
+
+#include "WiFiManagerUtils.h"
+
+#if defined(ESP8266)
+#include <ESP8266WiFi.h>
+#elif defined(ESP32)
+#include <WiFi.h>
+#endif
+
+namespace WiFiManagerUtils {
+
+// -----------------------------------------------------------------------------------------------
+// WIFI STATUS ARRAYS
+
+const char * const WIFI_STA_STATUS[] PROGMEM = {
+  "WL_IDLE_STATUS",     // 0 STATION_IDLE
+  "WL_NO_SSID_AVAIL",   // 1 STATION_NO_AP_FOUND
+  "WL_SCAN_COMPLETED",  // 2
+  "WL_CONNECTED",       // 3 STATION_GOT_IP
+  "WL_CONNECT_FAILED",  // 4 STATION_CONNECT_FAIL, STATION_WRONG_PASSWORD(NI)
+  "WL_CONNECTION_LOST", // 5
+  "WL_DISCONNECTED",    // 6
+  "WL_STATION_WRONG_PASSWORD" // 7 KLUDGE
+};
+
+#ifdef ESP32
+const char * const AUTH_MODE_NAMES[] PROGMEM = {
+    "OPEN",
+    "WEP",
+    "WPA_PSK",
+    "WPA2_PSK",
+    "WPA_WPA2_PSK",
+    "WPA2_ENTERPRISE",
+    "MAX"
+};
+#elif defined(ESP8266)
+const char * const AUTH_MODE_NAMES[] PROGMEM = {
+    "",
+    "",
+    "WPA_PSK",      // 2 ENC_TYPE_TKIP
+    "",
+    "WPA2_PSK",     // 4 ENC_TYPE_CCMP
+    "WEP",          // 5 ENC_TYPE_WEP
+    "",
+    "OPEN",         //7 ENC_TYPE_NONE
+    "WPA_WPA2_PSK", // 8 ENC_TYPE_AUTO
+};
+#endif
+
+const char* const WIFI_MODES[] PROGMEM = { "NULL", "STA", "AP", "STA+AP" };
+
+// -----------------------------------------------------------------------------------------------
+// STRING CONVERSION UTILITIES
+
+String getStatusString(uint8_t status) {
+  if(status <= 7) return FPSTR(WIFI_STA_STATUS[status]);
+  return F("Unknown");
+}
+
+
+String getModeString(uint8_t mode) {
+  if(mode <= 3) return FPSTR(WIFI_MODES[mode]);
+  return F("Unknown");
+}
+
+String getEncryptionString(uint8_t authmode) {
+  return FPSTR(AUTH_MODE_NAMES[authmode]);
+}
+
+// -----------------------------------------------------------------------------------------------
+// HTML UTILITIES
+
+String htmlEntities(const String& str, bool whitespace) {
+  String result = str;
+  result.replace("&","&amp;");
+  result.replace("<","&lt;");
+  result.replace(">","&gt;");
+  result.replace("'","&#39;");
+  if(whitespace) result.replace(" ","&#160;");
+  return result;
+}
+
+// -----------------------------------------------------------------------------------------------
+// IP/STRING UTILITIES
+
+bool isValidIP(const String& str) {
+  for (size_t i = 0; i < str.length(); i++) {
+    int c = str.charAt(i);
+    if (c != '.' && (c < '0' || c > '9')) {
+      return false;
+    }
+  }
+  return true;
+}
+
+String ipToString(IPAddress ip) {
+  String res = "";
+  for (int i = 0; i < 3; i++) {
+    res += String((ip >> (8 * i)) & 0xFF) + ".";
+  }
+  res += String(((ip >> 8 * 3)) & 0xFF);
+  return res;
+}
+
+bool isValidAPPassword(const String& password) {
+  if (password.length() < 8 || password.length() > 63) {
+    return false;
+  }
+  return true;
+}
+
+// -----------------------------------------------------------------------------------------------
+// HELPER CALCULATIONS
+
+int rssiToQuality(int rssi) {
+  int quality = 0;
+  if (rssi <= -100) {
+    quality = 0;
+  } else if (rssi >= -50) {
+    quality = 100;
+  } else {
+    quality = 2 * (rssi + 100);
+  }
+  return quality;
+}
+
+} // namespace WiFiManagerUtils
+

library.json

@@ -1,29 +1,80 @@
 {
   "name": "WiFiManager",
-  "version": "2.0.17",
-  "keywords": "wifi,wi-fi,esp,esp8266,esp32,espressif8266,espressif32,nodemcu,wemos,arduino",
-  "description": "WiFi Configuration manager with web configuration portal for ESP boards",
-  "authors":
-  [
+  "version": "3.2.5",
+  "keywords": [
+    "wifi",
+    "wi-fi",
+    "esp",
+    "esp8266",
+    "esp32",
+    "espressif8266",
+    "espressif32",
+    "nodemcu",
+    "wemos",
+    "arduino"
+  ],
+  "description": "Maintained ESP8266/ESP32 WiFi configuration portal with asynchronous web support.",
+  "authors": [
     {
-        "name": "tzapu",
-        "url": "https://github.com/tzapu"
+      "name": "tzapu",
+      "url": "https://github.com/tzapu"
     },
     {
-        "name": "tablatronix",
-        "url": "https://github.com/tablatronix",
-        "maintainer": true
+      "name": "tablatronix",
+      "url": "https://github.com/tablatronix",
+      "maintainer": true
+    },
+    {
+      "name": "Alex Hope-O'Connor",
+      "url": "https://github.com/alexhopeoconnor"
     }
   ],
-  "repository":
-  {
+  "repository": {
     "type": "git",
-    "url": "https://github.com/tzapu/WiFiManager.git"
+    "url": "https://github.com/alexhopeoconnor/WiFiManager.git"
   },
   "frameworks": "arduino",
-  "platforms": 
-  [
+  "platforms": [
     "espressif8266",
     "espressif32"
-  ]
-}
+  ],
+  "dependencies": [
+    {
+      "owner": "esp32async",
+      "name": "ESPAsyncWebServer",
+      "version": "3.9.1"
+    },
+    {
+      "owner": "esp32async",
+      "name": "ESPAsyncTCP",
+      "version": "^2.0.0",
+      "platforms": "espressif8266"
+    },
+    {
+      "owner": "esp32async",
+      "name": "AsyncTCP",
+      "version": "^3.4.9",
+      "platforms": "espressif32"
+    },
+    {
+      "name": "DeviceFrameworkTemplateEngine",
+      "version": "https://github.com/alexhopeoconnor/DFTE.git#v1.2.1"
+    }
+  ],
+  "build": {
+    "includeDir": "lib/WiFiManager/include",
+    "srcDir": "lib/WiFiManager/src"
+  },
+  "export": {
+    "include": [
+      "lib/WiFiManager/include",
+      "lib/WiFiManager/src",
+      "LICENSE",
+      "README.md",
+      "CHANGELOG.md",
+      "library.json"
+    ]
+  },
+  "$schema": "https://raw.githubusercontent.com/platformio/platformio-core/develop/platformio/assets/schema/library.json",
+  "homepage": "https://github.com/alexhopeoconnor/WiFiManager"
+}

library.properties

@@ -1,9 +0,0 @@
-name=WiFiManager
-version=2.0.17
-author=tzapu
-maintainer=tablatronix
-sentence=WiFi Configuration manager with web configuration portal for Espressif ESPx boards, by tzapu
-paragraph=Library for configuring ESP8266/ESP32 modules WiFi credentials and custom parameters at runtime with captive portal.
-category=Communication
-url=https://github.com/tzapu/WiFiManager.git
-architectures=esp8266,esp32

platformio.ini

@@ -0,0 +1,47 @@
+; PlatformIO Project Configuration File for WiFiManager Library
+; This file is used for building tests
+
+[env:esp8266]
+platform = espressif8266
+board = d1_mini
+framework = arduino
+; Postmortem jump relocation fix for large binaries (see ESP8266-LINKER-WORKAROUND.md in arduino-home-assistant)
+platform_packages =
+    platformio/framework-arduinoespressif8266 @ https://github.com/esp8266/Arduino.git#521ae60a89e64bb0d1eb7a0b7addf620ced5cad3
+monitor_speed = 115200
+test_framework = unity
+test_build_src = no
+build_flags =
+    -DWM_LOG_LEVEL=5
+    -DUNIT_TEST
+lib_deps = 
+    ESP32Async/ESPAsyncWebServer@3.9.1
+    DeviceFrameworkTemplateEngine=https://github.com/alexhopeoconnor/DFTE.git#v1.2.1
+    ESP32Async/ESPAsyncTCP@2.0.0
+
+[env:esp32]
+platform = https://github.com/pioarduino/platform-espressif32/releases/download/55.03.311/platform-espressif32.zip
+board = esp32dev
+framework = arduino
+monitor_speed = 115200
+test_framework = unity
+test_build_src = no
+build_unflags = 
+    -std=gnu++11
+build_flags = 
+    -std=gnu++14
+    -DSOC_WIFI_SUPPORTED=1
+    -I${platformio.packages_dir}/framework-arduinoespressif32/libraries/Network/src
+    -DWM_LOG_LEVEL=5
+    -DUNIT_TEST
+lib_deps = 
+    ESP32Async/ESPAsyncWebServer@3.9.1
+    DeviceFrameworkTemplateEngine=https://github.com/alexhopeoconnor/DFTE.git#v1.2.1
+    ESP32Async/AsyncTCP@^3.4.9
+
+; Optional: compile tests with DFTE logs bridged into WiFiManager::log (see README)
+[env:esp8266_dfte_log]
+extends = env:esp8266
+build_flags =
+    ${env:esp8266.build_flags}
+    -DWM_DFTE_LOGGING

scripts/bump-version.sh

@@ -0,0 +1,46 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+usage() {
+    echo "Usage: $0 vMAJOR.MINOR.PATCH" >&2
+    exit 2
+}
+
+tag="${1:-}"
+[[ "$tag" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]] || usage
+
+root="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+version="${tag#v}"
+repo_url="https://github.com/alexhopeoconnor/WiFiManager.git"
+reference_files=(README.md docs/GETTING_STARTED.md)
+
+current_version="$(sed -n 's/.*"version": "\([^"]*\)".*/\1/p' "$root/library.json" | head -n 1)"
+[[ "$current_version" != "$version" ]] || {
+    echo "library.json already declares $version; choose a new version." >&2
+    exit 1
+}
+grep -q "^## $version$" "$root/CHANGELOG.md" && {
+    echo "CHANGELOG.md already has a $version section; choose a new version." >&2
+    exit 1
+}
+
+sed -i -E '0,/"version": "[0-9]+\.[0-9]+\.[0-9]+"/s//"version": "'"$version"'"/' "$root/library.json"
+for file in "${reference_files[@]}"; do
+    sed -i -E "s|${repo_url}#v[0-9]+\.[0-9]+\.[0-9]+|${repo_url}#v${version}|g" "$root/$file"
+done
+
+temp_file="$(mktemp)"
+trap 'rm -f "$temp_file"' EXIT
+{
+    IFS= read -r changelog_heading < "$root/CHANGELOG.md"
+    [[ "$changelog_heading" == "# Changelog" ]] || {
+        echo "CHANGELOG.md must begin with # Changelog" >&2
+        exit 1
+    }
+    printf '%s\n\n## %s\n\n- TODO: Describe this release.\n' "$changelog_heading" "$version"
+    tail -n +2 "$root/CHANGELOG.md"
+} > "$temp_file"
+mv "$temp_file" "$root/CHANGELOG.md"
+
+echo "Updated WiFiManager declarations and canonical install references to $tag."
+echo "Replace the generated changelog TODO with the release summary, then run scripts/check-docs.sh and scripts/prepare-release.sh $tag."

scripts/capture-unity-serial.sh

@@ -0,0 +1,68 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+usage() {
+    echo "Usage: $0 --port /dev/serial/by-id/... [--timeout seconds]" >&2
+    exit 2
+}
+
+port=""
+timeout_seconds=300
+while [[ $# -gt 0 ]]; do
+    case "$1" in
+        --port) [[ $# -ge 2 ]] || usage; port="${2:-}"; shift 2 ;;
+        --timeout) [[ $# -ge 2 ]] || usage; timeout_seconds="${2:-}"; shift 2 ;;
+        *) usage ;;
+    esac
+done
+
+[[ -n "$port" && -e "$port" ]] || usage
+[[ "$timeout_seconds" =~ ^[1-9][0-9]*$ ]] || usage
+
+capture_file="$(mktemp -p /tmp wifimanager-unity.XXXXXX)"
+monitor_pid=""
+preserve_capture=false
+cleanup() {
+    if [[ -n "$monitor_pid" ]] && kill -0 "$monitor_pid" 2>/dev/null; then
+        kill "$monitor_pid" 2>/dev/null || true
+        wait "$monitor_pid" 2>/dev/null || true
+    fi
+    if [[ "$preserve_capture" == "false" ]]; then
+        rm -f "$capture_file"
+    fi
+}
+trap cleanup EXIT
+
+# Start immediately after upload. PlatformIO's interactive monitor cannot run
+# without a TTY; socat opens only this port and streams its configured 115200
+# baud output into the capture file without touching another board.
+timeout --foreground "$timeout_seconds" socat -u "FILE:$port,raw,echo=0,b115200" STDOUT \
+    >"$capture_file" 2>&1 &
+monitor_pid="$!"
+
+while kill -0 "$monitor_pid" 2>/dev/null; do
+    if grep -aqE '[0-9]+ Tests [0-9]+ Failures' "$capture_file"; then
+        kill "$monitor_pid" 2>/dev/null || true
+        wait "$monitor_pid" 2>/dev/null || true
+        monitor_pid=""
+
+        if grep -aq "Tests 0 Failures" "$capture_file" && grep -aq "^OK" "$capture_file"; then
+            grep -aE '\[METRIC\]|Tests [0-9]+ Failures|^OK$' "$capture_file" || true
+            exit 0
+        fi
+
+        echo "Unity reported a test failure:" >&2
+        grep -anE ':FAIL|FAIL$|\[METRIC\]|Tests [0-9]+ Failures' "$capture_file" >&2 || true
+        tail -n 80 "$capture_file" >&2 || true
+        preserve_capture=true
+        echo "Full serial capture retained at $capture_file" >&2
+        exit 1
+    fi
+    sleep 0.25
+done
+
+wait "$monitor_pid" || true
+monitor_pid=""
+preserve_capture=true
+echo "Serial monitoring ended before Unity produced a summary; capture retained at $capture_file" >&2
+exit 1

scripts/check-docs.sh

@@ -0,0 +1,118 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+root="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+failed=0
+
+check_cpp_fence_scope() {
+    local markdown="$1"
+    awk '
+        function brace_delta(line, copy) {
+            copy = line
+            return gsub(/\{/, "{", copy) - gsub(/\}/, "}", copy)
+        }
+        /^```cpp[[:space:]]*$/ { in_cpp = 1; depth = 0; next }
+        in_cpp && /^```[[:space:]]*$/ { in_cpp = 0; next }
+        in_cpp {
+            line = $0
+            sub(/^[[:space:]]+/, "", line)
+            if (depth == 0 &&
+                (line ~ /^(if|for|while|switch)[[:space:]]*\(/ ||
+                 line ~ /^[A-Za-z_][A-Za-z0-9_:]*::[A-Za-z0-9_]+[[:space:]]*\(/ ||
+                 line ~ /^[A-Za-z_][A-Za-z0-9_]*\./ ||
+                 line ~ /^[A-Za-z_][A-Za-z0-9_]*[[:space:]]*\(/)) {
+                printf "%s:%d: C++ expression appears at namespace scope; wrap it in a function.\n", FILENAME, FNR > "/dev/stderr"
+                failed = 1
+            }
+            depth += brace_delta($0)
+        }
+        END { exit failed }
+    ' "$markdown"
+}
+
+link_pattern='\]\(([^ )]+)'
+while IFS= read -r file; do
+    in_fence=false
+    while IFS= read -r line || [[ -n "$line" ]]; do
+        if [[ "$line" =~ ^[[:space:]]*(\`\`\`|~~~) ]]; then
+            [[ "$in_fence" == true ]] && in_fence=false || in_fence=true
+            continue
+        fi
+        [[ "$in_fence" == true ]] && continue
+        remainder="$line"
+        while [[ "$remainder" =~ $link_pattern ]]; do
+            target="${BASH_REMATCH[1]}"
+            remainder="${remainder#*]($target)}"
+            case "$target" in
+                \#*|http://*|https://*|mailto:*|tel:*) continue ;;
+            esac
+            target="${target%%#*}"
+            [[ -z "$target" ]] && continue
+            if [[ "$target" == /* ]]; then
+                candidate="$root/${target#/}"
+            else
+                candidate="$(dirname "$file")/$target"
+            fi
+            if [[ ! -e "$candidate" ]]; then
+                printf 'Broken local Markdown link: %s -> %s\n' "${file#$root/}" "$target" >&2
+                failed=1
+            fi
+        done
+    done < "$file"
+    check_cpp_fence_scope "$file" || failed=1
+done < <(find "$root" -path "$root/.git" -prune -o -path '*/.pio' -prune -o -type f -name '*.md' -print)
+
+for required in README.md CHANGELOG.md docs/README.md docs/GETTING_STARTED.md docs/PORTAL_UI.md docs/PORTAL_API.md docs/TESTING.md docs/DEVELOPMENT.md; do
+    if [[ ! -f "$root/$required" ]]; then
+        printf 'Missing required documentation file: %s\n' "$required" >&2
+        failed=1
+    fi
+done
+
+check_readme_media() {
+    local asset="$1"
+    local expected_type="$2"
+    local max_bytes="$3"
+    local path="$root/docs/assets/readme/$asset"
+    if [[ ! -s "$path" ]]; then
+        printf 'Missing README media asset: %s\n' "docs/assets/readme/$asset" >&2
+        failed=1
+        return
+    fi
+    if [[ "$(file --brief --mime-type "$path")" != "$expected_type" ]]; then
+        printf 'Unexpected README media type: %s\n' "docs/assets/readme/$asset" >&2
+        failed=1
+    fi
+    if (( $(wc -c < "$path") > max_bytes )); then
+        printf 'README media exceeds its size limit: %s\n' "docs/assets/readme/$asset" >&2
+        failed=1
+    fi
+}
+
+check_readme_media portal-tour.gif image/gif $((2 * 1024 * 1024))
+check_readme_media portal-overview.png image/png $((1024 * 1024))
+check_readme_media portal-wifi-settings.png image/png $((1024 * 1024))
+
+if [[ -n "$(git -C "$root" ls-files -- 'artifacts/readme-media/**')" ]]; then
+    printf 'Ignored README media artifacts must not be tracked.\n' >&2
+    failed=1
+fi
+
+while IFS= read -r example; do
+    for required in README.md platformio.ini; do
+        if [[ ! -f "$example/$required" ]]; then
+            printf 'Incomplete example: %s is missing %s\n' "${example#$root/}" "$required" >&2
+            failed=1
+        fi
+    done
+    if ! find "$example" -maxdepth 2 -type f \( -name '*.ino' -o -name '*.cpp' \) -print -quit | grep -q .; then
+        printf 'Incomplete example: %s has no sketch source\n' "${example#$root/}" >&2
+        failed=1
+    fi
+done < <(find "$root/examples" -mindepth 1 -maxdepth 1 -type d -print | sort)
+
+if [[ "$failed" -ne 0 ]]; then
+    exit 1
+fi
+
+echo "WiFiManager documentation checks passed"

scripts/prepare-release.sh

@@ -0,0 +1,67 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+usage() {
+    echo "Usage: $0 vMAJOR.MINOR.PATCH [--tag]"
+    exit 2
+}
+
+tag="${1:-}"
+[[ "$tag" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]] || usage
+[[ "${2:-}" == "" || "${2:-}" == "--tag" ]] || usage
+
+root="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+# shellcheck source=tools/lib/platformio.sh
+source "$root/tools/lib/platformio.sh"
+version="${tag#v}"
+manifest_version="$(sed -n 's/.*"version": "\([^"]*\)".*/\1/p' "$root/library.json" | head -n 1)"
+
+if [[ "$manifest_version" != "$version" ]]; then
+    echo "library.json is $manifest_version; expected $version for $tag" >&2
+    exit 1
+fi
+
+grep -q "^## $version$" "$root/CHANGELOG.md" || {
+    echo "CHANGELOG.md has no $version heading" >&2
+    exit 1
+}
+
+if [[ -f "$root/library.properties" ]]; then
+    properties_version="$(sed -n 's/^version=//p' "$root/library.properties" | head -n 1)"
+    if [[ "$properties_version" != "$version" ]]; then
+        echo "library.properties is $properties_version; expected $version for $tag" >&2
+        exit 1
+    fi
+fi
+
+if awk -v heading="## $version" '
+    $0 == heading { found = 1; next }
+    found && /^## / { exit }
+    found { print }
+' "$root/CHANGELOG.md" | grep -Fq 'TODO: Describe this release.'; then
+    echo "CHANGELOG.md still has the generated TODO for $version" >&2
+    exit 1
+fi
+repo_url="https://github.com/alexhopeoconnor/WiFiManager.git"
+validate_reference() {
+    local file="$1"
+    local reference_count
+    reference_count="$(grep -F "$repo_url#v" "$root/$file" | wc -l)"
+    [[ "$reference_count" -eq 1 ]] || { echo "$file must contain exactly one canonical release reference" >&2; exit 1; }
+    grep -Fq "$repo_url#$tag" "$root/$file" || { echo "$file does not reference $tag" >&2; exit 1; }
+}
+validate_reference README.md
+validate_reference docs/GETTING_STARTED.md
+
+git -C "$root" diff --check
+package_dir="$(mktemp -d)"
+trap 'rm -rf "$package_dir"' EXIT
+wm_pio pkg pack "$root" --output "$package_dir/package.tar.gz" >/dev/null
+echo "Validated release metadata and PlatformIO package for $tag"
+
+if [[ "${2:-}" == "--tag" ]]; then
+    git -C "$root" diff --quiet
+    git -C "$root" diff --cached --quiet
+    git -C "$root" tag -a "$tag" -m "Release $tag"
+    echo "Created $tag. Push the branch and tag; GitHub Actions will publish the release."
+fi