openscribe/state/TODO.md
Laurence 2af3c2043a
Some checks failed
ci / openapi (pull_request) Failing after 31s
ci / emulator (pull_request) Failing after 32s
ci / firmware (pull_request) Failing after 38s
ci / server (pull_request) Failing after 32s
docs: Plaud comparison + feature-gap backlog
Reviews the Plaud line (Note, Note Pro, NotePin/S) to make sure the OpenScribe
roadmap covers expected capabilities, and records where OpenScribe deliberately
differs (bring-your-own-AI, self-hosted, open).

What changed:
- docs/plaud-comparison.md: feature map (Plaud vs OpenScribe status), a derived
  backlog, and what we deliberately do not copy. Sourced from Plaud's site (July 2026).
- state/TODO.md: adds a Plaud-derived backlog section (diarisation, summary templating,
  Ask-AI/RAG, custom vocabulary, multimodal, mark-a-moment, auto-title, tags/folders/
  search, share links, optional OLED display, calendar) and a pluggable-AI-providers
  milestone.

Why:
- The user asked to review Plaud for other todos; this captures them and frames the
  bring-your-own-AI differentiator that the next feature implements.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-03 13:20:29 +01:00

83 lines
4.4 KiB
Markdown

# 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`)
## Pending - AI provider flexibility
- [~] Pluggable AI providers (server): transcription + LLM can target any open-standard
endpoint (OpenAI-compatible / local faster-whisper / Ollama) OR a commercial API
(OpenAI, Anthropic, Gemini). Config-driven, no lock-in. (branch
`feature/server-ai-providers`) - provider layer + HTTP providers landing now;
local faster-whisper wiring completes in M5.
## Pending - Plaud-derived backlog (see docs/plaud-comparison.md)
- [ ] Speaker diarisation + labels (server); rename-speaker in the app.
- [ ] Summary templating: built-in templates (meeting/action-items/to-do/mind-map/
decisions) + user templates; role-based multidimensional summaries.
- [ ] Ask AI: chat grounded in a recording's transcript (RAG), via the chosen LLM provider.
- [ ] Custom vocabulary / prompt hints for transcription + summary.
- [ ] Multimodal attachments: text notes + images attached to a recording.
- [ ] Mark-a-moment: device long-press during recording -> highlight timestamp, surfaced
in the app and used to focus summaries.
- [ ] Auto title + auto formatting of transcripts and summaries.
- [ ] Library organisation: tags, folders, full-text search (server + app).
- [ ] Share links for summaries (extends the export endpoint).
- [ ] Optional hardware variant with a small OLED status display (InstantView equivalent).
- [ ] Calendar integration (nice-to-have).
## Done
- [x] Dev testing + emulation harness - native unit tests (wav/range), Wokwi emulator,
cppcheck + OpenAPI validation in CI, docs/testing.md (PR #3, 2026-07-03).
- [x] 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.
- [x] 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.
- [x] M0 Scaffold - repo, licences, state docs, BOM, OpenAPI, skeletons, CI
(merged to `main`, 2026-07-03)
- [x] Create Forgejo repo `laurence/openscribe` (public, main) - 2026-07-03
- [x] 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.