Setup AP
Without stored Wi-Fi credentials, the reader creates Aliro-Setup-XXXX and serves the configuration UI at 192.168.4.1.
07 / WEB INTERFACE
The reader has a control plane.
The firmware embeds a lightweight configuration UI. Hardware wiring, networking, lock output and MQTT are runtime settings rather than rebuild-time assumptions.
Configuration
Hardware pins, NFC frontend, lock output, device identity and network settings are validated by the device before being persisted.
MQTT
Optional topics expose lock state, tap results and unlock commands, with Home Assistant discovery available.
API SURFACE
Small, explicit endpoints.
| Method | Path | Purpose |
|---|---|---|
| GET | / | Embedded UI. |
| GET | /api/status | Firmware, heap, network, lock, reader and MQTT state. |
| GET | /api/hardware | Chip-specific usable and restricted GPIO information. |
| GET | /api/config | Current configuration with secrets masked. |
| POST | /api/config | Validate and persist a configuration patch. |
| POST | /api/unlock | Drive the lock output using the same access path as a granted tap. |
| POST | /api/reboot | Restart so saved boot-time configuration takes effect. |
SECURITY
v0.3 closes a real hole.
The latest beta adds optional HTTP Basic authentication and applies it to endpoints that read configuration or change state, including OTA. Authentication is intentionally off by default for easy bench bring-up, and the UI warns when the network-facing controls are open.
Production warning: a configuration UI connected to a real lock is a security boundary. Enable authentication, isolate the device network and treat firmware, credentials and private keys as sensitive.