adebaumann/Rotary-Dial
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README: uploadfs, factory reset table, HTTP API, logo, reset button

Browse Source
This commit is contained in:
Adrian A. Baumann
2026-06-29 01:14:32 +02:00
parent 411500680b
commit 65babb5faa
1 changed files with 43 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+43 -9
View File
@@ -26,33 +26,67 @@ If your dial's contact is normally closed instead, change the interrupt trigger
## Building and flashing
```bash
# Build (S3 DevKit)
pio run -e esp32-s3-devkitc-1
# Build
pio run -e esp32dev
# Flash
pio run -e esp32-s3-devkitc-1 --target upload
# Flash firmware
pio run -e esp32dev --target upload
# Serial monitor (115200 baud)
# Upload filesystem image (logo, etc.) — only needed when data/ changes
pio run -e esp32dev --target uploadfs
# Serial monitor (115 200 baud)
pio device monitor
```
> **Note:** close the serial monitor before uploading — it holds the serial port exclusively.
Board targets: `esp32dev`, `esp32-s3-devkitc-1`
## First-time Wi-Fi setup
On first boot the device opens an access point named **Rotary-Dial**. Connect with any phone or laptop; a captive portal will appear.
1. Enter your Wi-Fi credentials.
2. Optionally set the **Device hostname** (default: `rotary-dial`).
2. Optionally set the **Device hostname** (default: `rotary-dial`, max 63 characters).
3. Save. The device joins your network and restarts.
Reachable at `http://rotary-dial.local` or the IP shown in the serial monitor.
### Factory reset
Power-cycle or press EN **5 times in quick succession** (before boot completes). All settings are cleared and the device restarts into the Wi-Fi portal.
Power-cycle (or press EN) rapidly before the 3-second boot window expires. The reset counter accumulates across rapid reboots:
| Cycles | Effect |
|--------|--------|
| 5 – 9 | Clears hostname, auth, and MQTT config; restarts into normal Wi-Fi |
| 10+ | Clears all of the above **plus** stored Wi-Fi credentials; restarts into captive portal |
Serial output shows the accumulated count:
```
[BOOT] reset count 3
[BOOT] reset count 4
...
[BOOT] reset count 5, triggering factory reset
[BOOT] factory reset triggered (clearWifi=0)!
[BOOT] factory reset complete, restarting...
```
## Web UI
Browse to the device address to configure hostname, authentication, and MQTT.
Browse to the device address to configure hostname, authentication, and MQTT. The logo in the header is served from `data/logo.png` in the filesystem image.
Click **Save** to persist settings. Changing the hostname automatically restarts the device. Click **Reset Device** to restart immediately.
## HTTP API
| Method | Path | Description |
|--------|------|-------------|
| `GET` | `/` | HTML configuration page |
| `GET` | `/logo.png` | Logo image served from LittleFS |
| `POST` | `/config` | Save configuration; redirects to `/`. Restarts if hostname changed |
| `POST` | `/reset` | Restart the device immediately |
## MQTT
@@ -67,7 +101,7 @@ Default prefix: `dial`
### Home Assistant
On MQTT connect the device publishes a discovery payload so HA automatically creates a **sensor** entity (`sensor.<hostname>_dialed_number`) that shows the last dialled number.
On MQTT connect the device publishes a discovery payload so HA automatically creates a **sensor** entity that shows the last dialled number.
Example automation: