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.
14 commits 1 branch 0 tags 246 KiB
Find a file
Laurence 8fd9b694f8
Some checks failed
ci / firmware (pull_request) Failing after 31s
Details
ci / openapi (pull_request) Failing after 33s
Details
ci / emulator (pull_request) Failing after 24s
Details
ci / server (pull_request) Failing after 37s
Details
docs+site: Nightjar brand, hosted service, infrastructure plan, saved site 
Persists the branding/commercial/infrastructure work (previously only in chat and
on the live site) into version control.

What changed:
- docs/naming.md: due-diligence and the decision to brand the product Nightjar
  (OpenScribe domain/GitHub/trademark collisions; alternatives screened; why Nightjar).
- docs/hosted-service.md: the commercial model - plan tiers (Self-host / Cloud
  Starter / Cloud Pro / Private), indicative pricing, backend mapping, and the
  build-to-sell roadmap (metering, billing, provisioning, DPA).
- docs/infrastructure.md: backend infra plan. Primary option = self-host on the
  3x Minisforum MS-02 cluster (one with an RTX 3050 6GB) fronted by a Cloudflare
  Tunnel, with node roles, the 3050 capacity reality, caveats, and a Hetzner cloud
  fallback. Provision-later.
- site/: reproducible marketing-site source - block content for all 11 pages
  (rebranded to Nightjar), the navigation, the Contact Form 7 config (honeypot),
  the ApisCP SOAP helper (tools/apiscp.php, no secret), and a README on how the
  WordPress site is built and managed via the API.
- state/: DECISIONS (Nightjar rebrand, hosted service, MS-02 backend), PROJECT
  (brand + commercial section), TODO (rename decision, trademark, mailbox, pricing,
  hosted-service build, infra provisioning).

Why:
- User asked to save everything to the repo. Captures the product rebrand, the
  commercialisation plan, and the infrastructure decision so a cold session has the
  full picture.

Notes:
- The repo is still named `openscribe`; the product/brand is Nightjar. A full
  codebase rename is deferred (tracked in TODO + docs/naming.md).
- No secrets committed: the ApisCP API key is read from a local scratch file, never
  the repo.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-05 22:24:24 +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(server): pluggable AI providers - any open-standard or commercial AI 2026-07-03 18:56:58 +01:00
site docs+site: Nightjar brand, hosted service, infrastructure plan, saved site 2026-07-05 22:24:24 +01:00
state docs+site: Nightjar brand, hosted service, infrastructure plan, saved site 2026-07-05 22:24:24 +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.