feat(calibration): auto edge-calibration backend core (phase 1)
Backend engine for guided LED-chase calibration, driven by the upcoming
auto-calibration UI (phase 3) and first-run wizard (phase 4).
- solve_calibration(): pure function mapping start corner + direction + 4
corner-tap indices to per-edge LED counts, consistent with EDGE_ORDER/
EDGE_REVERSE so it round-trips through build_segments().
- CalibrationChaseMixin.set_calibration_pixel(): light a specific LED index
(+ optional window) on a device, reusing the device_test_mode idle-client
send path.
- CalibrationSession: single-active session with start/position/stop/cancel,
a 60s idle-timeout watchdog, and a concurrency lock so interleaved calls
can't corrupt the stop/restore bookkeeping — start() stops + remembers any
running target on the device and stop/cancel/timeout always restore it
(never leaves the device dark or stuck in chase).
- Routes /api/v1/calibration/{session,session/position,session/stop,
session/cancel,session/state,solve} (all AuthRequired, bounds-validated);
calibration is persisted by reusing the existing PUT /color-strip-sources/
{id} (hot-reloads running streams) rather than a duplicate endpoint.
- Tests: 19 solver pure-logic + 19 route/bounds. docs/API.md updated.
Part of the edge-calibration + first-run-wizard feature (Big Bang; intermediate
phase — full build/suite gated at the final phase).
This commit is contained in:
+68
-1
@@ -238,7 +238,7 @@ A single aggregated poll endpoint for low-overhead clients.
|
||||
|
||||
| Method | Path | Description |
|
||||
| ------ | ---- | ----------- |
|
||||
| GET | `/api/v1/snapshot` | Full poll payload (targets, states, metrics, devices, brightness, color/value sources, scene presets, sync clocks, system) in one response. Use `?include=` to request a subset; per-section fault isolation. |
|
||||
| GET | `/api/v1/snapshot` | Full poll payload (targets, states, metrics, devices, brightness, color/value sources, scene presets, scene playlists + cycling state, sync clocks, system) in one response. Use `?include=` to request a subset; per-section fault isolation. |
|
||||
|
||||
## Devices
|
||||
|
||||
@@ -649,6 +649,73 @@ The wiring-graph: schema registry, topology, dependents, validation, and subgrap
|
||||
| POST | `/api/v1/graph/validate-connection` | Validate a proposed wiring edit (existence, kind, no cycle). |
|
||||
| POST | `/api/v1/graph/duplicate` | Deep-clone selected value/color-strip sources with remapped wiring. |
|
||||
|
||||
## Calibration
|
||||
|
||||
Guided LED chase and auto-solver for the `CalibrationConfig` stored on a
|
||||
color-strip source. The flow is:
|
||||
|
||||
1. **Start** a session (`POST /session`) — stops any running target on the
|
||||
device and remembers it for restore on stop.
|
||||
2. **Position** the chase pixel (`POST /session/position`) to walk through
|
||||
each physical corner and record the LED index.
|
||||
3. **Solve** (`POST /solve`) — the server computes per-edge LED counts.
|
||||
4. **Persist** — call `PUT /api/v1/color-strip-sources/{id}` with the solved
|
||||
`calibration` object to save and hot-reload.
|
||||
5. **Stop** (`POST /session/stop`) — clears the device and restores the prior
|
||||
target.
|
||||
|
||||
| Method | Path | Description |
|
||||
| ------ | ---- | ----------- |
|
||||
| POST | `/api/v1/calibration/session` | Start a calibration session on a device (stops the running target, clears to black). |
|
||||
| POST | `/api/v1/calibration/session/position` | Advance the chase pixel to LED `index` (± `window` dim neighbours). |
|
||||
| POST | `/api/v1/calibration/session/stop` | End the session: clear to black and restore the prior target. |
|
||||
| POST | `/api/v1/calibration/session/cancel` | Alias for stop — no calibration is applied. |
|
||||
| GET | `/api/v1/calibration/session/state` | Current session state (active, device_id, led_count, last_activity). |
|
||||
| POST | `/api/v1/calibration/solve` | Solve per-edge LED counts from 4 corner tap indices. Returns solved config dict (does NOT persist). |
|
||||
|
||||
**Session state** response shape:
|
||||
|
||||
```json
|
||||
{
|
||||
"active": true,
|
||||
"device_id": "dev_abc123",
|
||||
"led_count": 100,
|
||||
"prior_target_id": "ot_xyz456",
|
||||
"last_activity": "2026-06-08T12:34:56.789Z"
|
||||
}
|
||||
```
|
||||
|
||||
**Solve request** (body):
|
||||
|
||||
```json
|
||||
{
|
||||
"device_id": "dev_abc123",
|
||||
"start_position": "bottom_left",
|
||||
"layout": "clockwise",
|
||||
"corner_indices": [0, 30, 60, 80],
|
||||
"offset": 0
|
||||
}
|
||||
```
|
||||
|
||||
`corner_indices` must be exactly 4 integers, one per screen corner, in the
|
||||
strip-walk order defined by `(start_position, layout)`. Provide either
|
||||
`device_id` (preferred — server derives `led_count`) or `led_count` directly.
|
||||
|
||||
**Important session behavior:**
|
||||
|
||||
- **Stops the running output target** — starting a calibration session immediately
|
||||
stops any output target currently running on that device. Other clients driving
|
||||
that device will lose their output for the duration of the session.
|
||||
- **Single session only** — only one calibration session runs at a time across the
|
||||
whole server. Starting a new session automatically ends the previous one (clearing
|
||||
and restoring its device first), regardless of which device each session is on.
|
||||
- **Idle auto-end** — a session that receives no `position` calls for ~60 seconds is
|
||||
automatically stopped and the prior target restored, so devices are never left dark
|
||||
indefinitely.
|
||||
|
||||
**Idle timeout:** a session that receives no `position` calls for 60 seconds
|
||||
is automatically stopped and the prior target restored.
|
||||
|
||||
## Web UI & PWA
|
||||
|
||||
App-level routes served by FastAPI (not under `/api/v1`).
|
||||
|
||||
Reference in New Issue
Block a user