Files
DigiRadio/Software/docs/TODO.md
T
micheleandCursor 8439ec4055 Sync all project docs for firmware 0.8.3 completion.
Update READMEs, manual chapters, agent guides, CONTRIBUTING, and TODO to reflect T1–T8 done, encrypted NVS, CI gates, and pending HIL checklist.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-07-07 07:49:07 +02:00

2.8 KiB
Raw Blame History

TODO — DigiRadio firmware

Agent task list and hardware-in-the-loop backlog. Working directory for all commands is Software/.

Current firmware: 0.8.3 — NVS + flash encryption (dev mode), tabbed Web UI, integration service, RDS/DLS metadata, CI gate (4 jobs).

Before writing code, read AGENTS.md, .cursor/rules/, and instructions.md. Definition of Done: Apache header, doc blocks, doxygen Doxyfile exits 0, host tests pass, check-manual-sync.py and check_si4684_blobs.py pass, no plaintext secrets.


Completed agent tasks (T1T8, fw 0.7.10.8.3)

Task Version Summary
T1 0.7.1 Doxygen warnings cleared
T2 0.7.1 CI workflow (host tests, Doxygen, manual sync)
T3 0.7.2 Preset reorder API/UI, DAB playing ids in status
T4 0.8.0 RDS/DLS broadcast metadata
T5 0.8.1 IntegrationService — startup, preset recall, last-preset NVS
T6 0.8.2 Tabbed configuration Web UI (full REST coverage)
T7 0.8.2 Si4684 blob policy — gitignore, docs, check_si4684_blobs.py
T8 0.8.3 NVS + flash encryption — initEncryptedStorage, security docs

Also landed (not numbered): BT1035 pairing (BluetoothService), station presets (fw 0.7.0), companion-chip boot (Slice 3), ADAU1701 runtime (Slice 5).


P4 — Hardware-in-the-loop (when PCB arrives)

Manual validation only — does not block host CI.

H1. Encrypted NVS boot path

Follow docs/security-flash-nvs.md: first flash with idf.py erase-flash flash, verify boot logs, Wi-Fi provisioning survives reboot, presets and last_preset survive power cycle.

H2. End-to-end listening

Si4684 DAB/FM tune, ADAU1701 profile apply, BT1035 A2DP to headphones, now-playing metadata in UI and /api/tuner/status.

H3. Production flash encryption (optional)

After H1 passes, trial build with sdkconfig.defaults.production overlay on a sacrificial unit; confirm RELEASE mode policy before shipping.


Open firmware polish (non-blocking)

  • BT1035: device name, paired-device list, auto-reconnect AT (driver stubs open).
  • Si4684: optional commands (STOP_DIGITAL_SERVICE, ensemble info) if product needs them.
  • FM seek down (API today is seek-up only).

Quality gates (run from Software/ before merge)

cmake -S components/core/test -B build-host && cmake --build build-host
ctest --test-dir build-host --output-on-failure
doxygen Doxyfile
python3 tools/check-manual-sync.py
python3 tools/check_si4684_blobs.py

After editing the web UI: tools/gzip-www.sh.


Notes for the agent

  • Extend existing patterns (AudioProfile / IAudioProfileStore shape).
  • Never invent Si4684 opcodes — cite AN649.
  • One logical change per commit; 50/72 messages.
  • Update ch-classes.tex / ch-api.tex when public API or HTTP changes.