mirror of
https://github.com/alexhopeoconnor/WiFiManager.git
synced 2026-10-21 10:12:37 +10:00
feat: add reproducible portal README media
This commit is contained in:
@@ -4,6 +4,16 @@ WiFiManagerPortalConfig is the supported presentation API for the built-in provi
|
||||
|
||||
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 contract 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 |
|
||||
| --- | --- |
|
||||
|  |  |
|
||||
|
||||
## Standalone branded portal
|
||||
|
||||
~~~cpp
|
||||
|
||||
@@ -102,4 +102,39 @@ 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 contract 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-contract timing.
|
||||
ESP8266 remains covered by the normal hardware and browser contract but does
|
||||
not produce duplicate README media.
|
||||
|
||||
Back to [documentation](README.md) · [project overview](../README.md).
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 108 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 109 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 55 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.4 MiB |
Binary file not shown.
|
After Width: | Height: | Size: 62 KiB |
Reference in New Issue
Block a user