laurence/openscribe
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
openscribe/state/TODO.md
Laurence 9237f4a37b
Some checks failed
ci / firmware (push) Failing after 37s
Details
ci / openapi (push) Failing after 33s
Details
ci / server (push) Failing after 32s
Details
ci / emulator (push) Failing after 38s
Details
docs(state): mark testing harness merged; M3 next 
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-03 12:17:04 +01:00

3.1 KiB
Raw Blame History

TODO

The current state of play. Keep it honest and current; this is what the next session reads to know what to do. Move items between sections as they progress.

In progress

  • (nothing active - M3 is next)

Pending (roughly in build order)

  • M3 Independent uploader: charge/VBUS detect -> powered mode, S3-compatible + WebDAV upload of audio + metadata (config store already landed in M2). (branch feature/fw-uploader)
  • M4 BLE GATT: device info, battery, record control, WiFi provisioning, status notifications; hand-off to WiFi for transfer. (branch feature/fw-ble)
  • M5 Server ingest + transcription: FastAPI ingest from object store/upload, store, faster-whisper transcription, DB, exports (audio/TXT/SRT/VTT/JSON). REST API. (branch feature/server-ingest-stt)
  • M6 Server summaries: Ollama LLM summary + action items, Markdown export. (branch feature/server-summary)
  • M7 Flutter app: BLE provisioning, device dashboard, library from server API, playback, transcript/summary view, export/share, settings. (branch feature/app-mvp)
  • M8 3D case: parametric OpenSCAD enclosure fit to the BOM board + battery; print/fit. (branch feature/case-v1)
  • M9 Hardening + OTA: API auth, credential handling, OTA update, docs handoff. (branch feature/hardening-ota)

Done

  • Dev testing + emulation harness - native unit tests (wav/range), Wokwi emulator, cppcheck + OpenAPI validation in CI, docs/testing.md (PR #3, 2026-07-03).
  • M2 On-device WiFi + REST API - WiFi/SoftAP + mDNS + config(NVS) + device REST API (status, list, metadata, audio-with-Range, delete, record start/stop, config). (PR #2 feature/fw-rest-api, 2026-07-03). Not yet hardware-verified.
  • M1 Firmware recording core - mic capture to WAV on SD + button/LED + metadata (merged: PR #1 feature/fw-recorder-core, 2026-07-03). Not yet hardware-verified.
  • M0 Scaffold - repo, licences, state docs, BOM, OpenAPI, skeletons, CI (merged to main, 2026-07-03)
  • Create Forgejo repo laurence/openscribe (public, main) - 2026-07-03
  • Decide hardware, sync model, AI stack, app platform, storage, licensing (see DECISIONS.md) - 2026-07-03

Follow-ups (deferred, do when convenient)

  • Audio calibration: INMP441 emits 24-bit samples in a 32-bit slot. M1 reads in 16-bit mode (usable for speech, may be quiet). If levels are low on the dev build, capture 32-bit and right-shift into int16 in audio.cpp.
  • Real timestamps: ids/started_at are uptime-based (no RTC/NTP yet). Add NTP now that WiFi exists (M2), and switch ids and started_at to real UTC.
  • API auth is open when no token set; SoftAP has a fixed default passphrase. Harden both before any deployment (see NOTES "Security follow-ups").

Blocked / waiting

  • Physical build + on-device verification - waiting on parts from hardware/BOM.md. Until parts arrive, firmware is validated by CI build (Forgejo Actions) of both board profiles, not on real hardware.