laurence/openscribe
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
openscribe/state/TODO.md
Laurence 87a00265a3
Some checks failed
ci / server (pull_request) Failing after 27s
Details
ci / firmware (pull_request) Failing after 36s
Details
feat(firmware): M2 WiFi + on-device REST API 
Adds the WiFi-to-app sync path and the on-device open REST API implementing the
device paths of api/openapi.yaml, plus persistent config in NVS.

What changed:
- firmware/src/config.{h,cpp}: NVS (Preferences) store - stable device id from MAC,
  WiFi SSID/PSK, API bearer token, upload settings. Secrets stay off the SD card.
- firmware/src/net_wifi.{h,cpp}: station join with stored creds; SoftAP provisioning
  fallback when no creds / join fails; mDNS openscribe.local; reconnect in loop().
- firmware/src/api_http.{h,cpp}: synchronous WebServer on :80. Routes: GET /device,
  GET/PUT /device/config, GET /recordings, GET /recordings/{id}, GET
  /recordings/{id}/audio (HTTP Range -> 206 + Content-Range), DELETE /recordings/{id},
  POST /record/start|stop. Bearer-token auth on mutating calls (open when no token).
- firmware/src/storage.{h,cpp}: list/read/delete/count helpers + path builders.
- firmware/src/main.cpp: wire config + WiFi + API into setup/loop; bump fw to 0.2.0.
- firmware/platformio.ini: add bblanchon/ArduinoJson@^7 (only new dep).
- state/: ARCHITECTURE, NOTES, TODO updated; security + NTP follow-ups recorded.

Why:
- This is the WiFi transfer channel and the device half of the "completely open API":
  clients can list, download (resumable), delete and control without any cloud.

Notes:
- Not compiled locally (no PlatformIO on the dev host) or hardware-verified; CI builds
  both board profiles. Security follow-ups logged: API is open when no token is set,
  and the SoftAP uses a fixed default passphrase (make user-set at M4/BLE).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-03 12:09:41 +01:00

3 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

  • M2 On-device WiFi + REST API - code complete on feature/fw-rest-api, in PR. Not compiled locally / hardware-verified; CI builds both profiles.

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

  • 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.