From e7feac61e5ea275f303574fedd942ebed8fc8e73 Mon Sep 17 00:00:00 2001 From: Luke Hoersten Date: Sat, 13 Jun 2026 22:42:14 -0500 Subject: M4: NVS-backed /config with partial updates + validation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit nvs_config.{h,c} — persist the runtime config (viewport, scrypted, idle_timeout_ms, orientation, brightness) under a single NVS namespace. nvs_config_load() applies persisted values over the in-RAM defaults on boot and flips state from UNCONFIGURED to ASLEEP once both name and Scrypted URL are present. nvs_config_save() commits the whole record atomically. http_api.c — add GET /config and POST /config: - GET serializes viewport_state to the spec's JSON shape, with null for unset string fields and defaults filled in for the rest. - POST is partial: each field is optional; only present fields are validated and applied. Validation runs on a staged copy and errors short-circuit with 400 + reason before any state mutation, so a rejected request leaves the device untouched. - Validation rules: viewport non-empty <64 chars; scrypted starts with http:// and <256 chars; idle_timeout_ms 0 or >=5000; orientation in {portrait,landscape}; brightness 0..100. - Side-effects fire after the lock + save: brightness change pushes PWM to the panel MCU; viewport/orientation change reapplies mDNS hostname + TXT. - 204 on success; 400 with a single-line reason on validation error. app_main calls nvs_config_load() right after viewport_state_init(), so mdns_service_start() and display_init() see the persisted hostname, orientation, and brightness from the first packet/PWM. Build clean against ESP-IDF 5.4 (binary ~620 KB). TESTING.md M3 now documents the Hosyond jumper wiring (5V/GND/SDA=GPIO7/ SCL=GPIO8 from board to panel header; DSI FPC carries only the high- speed lanes). M4 entry expands the validation matrix and side-effects to verify. --- TESTING.md | 80 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 75 insertions(+), 5 deletions(-) (limited to 'TESTING.md') diff --git a/TESTING.md b/TESTING.md index dde0cdc..dd17d94 100644 --- a/TESTING.md +++ b/TESTING.md @@ -91,11 +91,52 @@ Expected mDNS browse output should show a `_scrypted-viewport._tcp` instance wit ## M3 — Display Bring-Up -**Acceptance**: panel shows a test pattern; backlight toggles via API. +**Acceptance**: panel powers on, MCU at I2C 0x45 responds, color-bar test pattern renders, brightness control works. -**How to verify**: TBD (write after M3 implementation). +**Wiring** (Hosyond 5" 800x480 panel ↔ Waveshare ESP32-P4-ETH): -**Status**: ⬜ pending. +The DSI FPC adapter (15-pin Pi side → 22-pin Waveshare side) carries the DSI data lanes and power. I2C and panel power are jumpered separately from the ESP32-P4 board to the Hosyond's auxiliary header (the same header Pi users normally connect to the Pi's 40-pin GPIO): + +| Hosyond panel pin | Wire to ESP32-P4 board | +| --- | --- | +| 5V | board 5V rail | +| GND | board GND | +| SDA | GPIO 7 | +| SCL | GPIO 8 | + +GPIO 7/8 match Waveshare's BSP convention for touch I2C on their bundled-panel kit. If different pins are more convenient, change `PIN_I2C_SDA` / `PIN_I2C_SCL` in `display.c`. + +**Bring-up sequence** + +1. Power the ESP32-P4 board over USB (don't plug DSI yet). +2. Connect 5V + GND jumpers to the panel. Panel LED (if present) should light. +3. Connect SDA + SCL jumpers. +4. Plug the DSI FPC cable. +5. Flash: + +```bash +idf.py -p /dev/cu.usbmodem* flash monitor +``` + +**Expected log** + +``` +I (xxx) display: panel MCU id 0xC3 — Pi 7" architecture ack'd +I (xxx) display: panel powered on +I (xxx) display: DSI up: 800x480 30 MHz, 2-lane 480 Mbps +I (xxx) viewport: display up — test pattern on screen +``` + +**Visual check**: 8 vertical color bars (white, yellow, cyan, green, magenta, red, blue, black) across the panel. Brightness should look perceptually mid-range (default 80/100 with gamma). + +**Failure-mode signals** + +- `panel MCU @0x45 unreachable` → jumper or pull-up problem on I2C, no need to suspect DSI yet. +- I2C ack but no image → DSI cable / FPC adapter orientation. Pi FPCs are easy to install upside-down. +- Image but wrong colors → check RGB565 byte order; flip `LCD_COLOR_PIXEL_FORMAT_RGB565` to a variant with swap. +- Image but vertical/horizontal sync issues → adjust the `PANEL_*SYNC_*` timings; Pi 7" canonical values used as defaults. + +**Status**: 🟡 builds clean against ESP-IDF 5.4. Driver ported from Linux `panel-raspberrypi-touchscreen.c`. Awaiting hardware bring-up with confirmed jumper wiring. --- @@ -123,9 +164,38 @@ curl -X POST -H "Content-Type: application/json" \ curl http:///config | jq . ``` -Also verify validation: `idle_timeout_ms: 1000` (below 5000) returns 400; `orientation: "sideways"` returns 400; etc. +Also verify validation: -**Status**: ⬜ pending. +```bash +# idle_timeout_ms below 5000 (and non-zero) — expect 400: +curl -i -X POST -H "Content-Type: application/json" \ + -d '{"idle_timeout_ms":1000}' http:///config + +# bogus orientation — expect 400: +curl -i -X POST -H "Content-Type: application/json" \ + -d '{"orientation":"sideways"}' http:///config + +# brightness out of range — expect 400: +curl -i -X POST -H "Content-Type: application/json" \ + -d '{"brightness":150}' http:///config + +# scrypted without http:// — expect 400: +curl -i -X POST -H "Content-Type: application/json" \ + -d '{"scrypted":"scrypted.local"}' http:///config + +# Garbage JSON — expect 400: +curl -i -X POST -H "Content-Type: application/json" \ + -d 'not json' http:///config +``` + +Idle-timer disable (`idle_timeout_ms: 0`) is intentionally allowed. + +Side-effects to confirm: +- After `POST /config` with `brightness`: panel brightness changes immediately (if display is up). +- After `POST /config` with `viewport` or `orientation`: mDNS TXT records update; `viewport-.local` resolves; browse shows new TXT. +- After `POST /config` with both `viewport` and `scrypted` (any order, on any subsequent call): `GET /state` shows `configured: true`, `state: "asleep"`. + +**Status**: 🟡 builds clean against ESP-IDF 5.4. Logic exercised in code but unverified on hardware. --- -- cgit v1.2.3