laurence/openscribe
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Open-source, self-hosted AI voice recorder (Plaud-style): ESP32-S3 firmware, Flutter app, self-hosted transcription/summary server, open API, 3D-printed case.
16 commits 1 branch 0 tags 246 KiB
Find a file
Laurence 19c3e156a0
Some checks failed
ci / firmware (pull_request) Failing after 2s
Details
ci / openapi (pull_request) Failing after 32s
Details
ci / emulator (pull_request) Failing after 35s
Details
ci / server (pull_request) Failing after 29s
Details
feat(web): Nightjar web app - Plaud-style record/transcribe/summarise UI 
A runnable, self-hosted web interface so the whole workflow can be tested end to
end: record or upload audio in the browser, watch it transcribe and summarise,
browse a library, play back, and export.

What changed:
- server/app/store.py: SQLite + on-disk audio storage for recordings (stdlib only).
- server/app/pipeline.py: background task audio -> transcribe -> summarise via the
  existing provider layer, updating status (queued/transcribing/summarising/done/error).
- server/app/main.py: web API - POST upload, list, detail, audio (Range), delete, and
  export (txt/md/srt/vtt/json) - and serves the SPA at /.
- server/app/web/: Plaud-style single-page UI (index.html, styles.css, app.js). Sidebar
  library, in-browser recording (MediaRecorder) + file upload, live status polling,
  audio player, summary (overview/key points/actions), timestamped transcript, exports.
- server/Dockerfile + README: two-minute run instructions (default provider: Groq free
  tier for both Whisper + LLM), and a Docker option.
- config: env prefix switched OPENSCRIBE_ -> NIGHTJAR_ to match the brand and the site
  tutorials; .env.example rewritten with a ready Groq quick-start.
- state/TODO: web app recorded as done.

Why:
- User asked for a Plaud-like web interface to test how it all works. Nothing testable
  existed before (marketing site is a brochure; pipeline was unwired). This delivers a
  real, runnable product demo and effectively lands M5/M6 for the HTTP providers.

Notes:
- Slim by design: AI is offloaded to the configured provider, so no local ML deps needed
  for the demo. Byte-compiles clean; JS passes node --check. Local faster-whisper still
  needs its model (M5) for the fully-offline path.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-06 09:57:42 +01:00
.forgejo/workflows test(dev): emulation + linting harness (Wokwi, native tests, CI, docs) 2026-07-03 12:16:25 +01:00
api scaffold: OpenScribe open-source self-hosted AI voice recorder 2026-07-03 10:21:37 +01:00
app scaffold: OpenScribe open-source self-hosted AI voice recorder 2026-07-03 10:21:37 +01:00
case scaffold: OpenScribe open-source self-hosted AI voice recorder 2026-07-03 10:21:37 +01:00
docs docs+site: Nightjar brand, hosted service, infrastructure plan, saved site 2026-07-05 22:24:24 +01:00
firmware test(dev): emulation + linting harness (Wokwi, native tests, CI, docs) 2026-07-03 12:16:25 +01:00
hardware scaffold: OpenScribe open-source self-hosted AI voice recorder 2026-07-03 10:21:37 +01:00
LICENSES scaffold: OpenScribe open-source self-hosted AI voice recorder 2026-07-03 10:21:37 +01:00
server feat(web): Nightjar web app - Plaud-style record/transcribe/summarise UI 2026-07-06 09:57:42 +01:00
site docs+site: Nightjar brand, hosted service, infrastructure plan, saved site 2026-07-05 22:24:24 +01:00
state feat(web): Nightjar web app - Plaud-style record/transcribe/summarise UI 2026-07-06 09:57:42 +01:00
.gitignore scaffold: OpenScribe open-source self-hosted AI voice recorder 2026-07-03 10:21:37 +01:00
CLAUDE.md scaffold: OpenScribe open-source self-hosted AI voice recorder 2026-07-03 10:21:37 +01:00
LICENSE scaffold: OpenScribe open-source self-hosted AI voice recorder 2026-07-03 10:21:37 +01:00
LICENSING.md scaffold: OpenScribe open-source self-hosted AI voice recorder 2026-07-03 10:21:37 +01:00
README.md scaffold: OpenScribe open-source self-hosted AI voice recorder 2026-07-03 10:21:37 +01:00

README.md

OpenScribe

An open-source, self-hosted AI voice recorder in the style of the Plaud Note / NotePin. A small wearable device records audio to local storage, syncs to a mobile app and to a server you run, and produces transcripts and summaries, through a completely open API. No proprietary cloud, no lock-in.

Status: early scaffold (M0). The design, hardware BOM, and open API are defined; component code is being built milestone by milestone. See state/TODO.md.

Why

Commercial AI recorders send your conversations to a vendor's cloud. OpenScribe keeps the whole pipeline (capture, storage, transcription, summarisation, export) on hardware you own, under open licences, with an API documented so you can build against it.

What it does

  • Records voice to microSD on a small ESP32-S3 device (button start/stop, LED status).
  • Syncs three ways:
    1. BLE for control, status and WiFi provisioning.
    2. WiFi to the mobile app for fast bulk transfer.
    3. Independent WiFi upload to your storage when on charge / hard-powered, with no phone present.
  • Transcribes (faster-whisper) and summarises (local LLM via Ollama) on a server you host.
  • Exposes a completely open REST API with exports: audio, TXT, SRT, VTT, Markdown, JSON.
  • Ships a Flutter app (Android + iOS) and a 3D-printed parametric case.

Architecture at a glance

mic -> ESP32-S3 (record to microSD)
         |  BLE: control / provision
         |  WiFi REST API: transfer to app
         |  WiFi uploader (on charge) -> object storage (MinIO / WebDAV / NAS)
                                              |
                                    self-hosted server (FastAPI)
                                    faster-whisper -> Ollama -> open API + exports
                                              |
                              Flutter app (Android + iOS)

Full detail: state/ARCHITECTURE.md. The API contract: api/openapi.yaml.

Repository layout

firmware/   ESP32-S3 recorder firmware (PlatformIO, Arduino-ESP32)
server/     Self-hosted FastAPI server: ingest, transcribe, summarise, serve API
app/        Flutter mobile app (Android + iOS)
hardware/   BOM, wiring/pinout, build notes (off-the-shelf modules, no PCB in v1)
case/       Parametric 3D-printed enclosure (OpenSCAD)
api/        openapi.yaml - the single source of truth for the open API
docs/       Workflow docs (this project follows the Default Workflow SOP)
state/      Project memory: PROJECT, ARCHITECTURE, DECISIONS, TODO, NOTES
LICENSES/   Full licence texts

Hardware

You build the device from off-the-shelf parts. See hardware/BOM.md for the shopping list, wiring and pinout. Core: an ESP32-S3 board with PSRAM, an I2S MEMS microphone, a microSD card, a LiPo battery and a charge IC.

Self-hosted stack

Everything runs on hardware you own: Forgejo for the forge, faster-whisper for transcription, Ollama for summaries, MinIO (or WebDAV / NAS) for storage. Plain recording and transfer work without any server; the server adds transcription and summaries.

Getting started

Nothing to run end to end yet (M0 scaffold). To follow along:

Licensing

Multi-part, copyleft. Code is GPL-3.0-only, hardware is CERN-OHL-S-2.0, case and docs are CC-BY-SA-4.0. See LICENSING.md.

OpenScribe is an independent open-source project inspired by the Plaud class of device. It is not affiliated with or endorsed by Plaud.