laurence/openscribe

Fork 0

History

Laurence 031074c9a9 Some checks failed ci / firmware (push) Failing after 2s Details ci / server (push) Failing after 45s Details scaffold: OpenScribe open-source self-hosted AI voice recorder Bootstrap of the project (M0). Sets up the monorepo, design docs, hardware BOM, the open API contract, component skeletons, licensing and CI, following the Default Workflow SOP. What changed: - CLAUDE.md + docs/: copied the Default Workflow so sessions load the SOP. - state/: PROJECT, ARCHITECTURE, DECISIONS, TODO, NOTES filled in for OpenScribe. ARCHITECTURE captures the four-part design (firmware, server, app, case) and the three sync paths; DECISIONS records the hardware, AI-stack, storage, app and licensing choices; TODO lays out milestones M1-M9. - hardware/BOM.md: two build options (compact XIAO ESP32-S3 Sense; dev ESP32-S3 + I2S mic + SD), wiring/pinout, indicative cost. - api/openapi.yaml: the completely open API (device + server surfaces), including recording list/download/delete and exports (wav/ogg/txt/srt/vtt/md/json). - firmware/: PlatformIO ESP32-S3 project, two board profiles, pin map, boot scaffold with module seams for M1-M4. - server/: FastAPI skeleton mirroring the OpenAPI, config for self-hosted MinIO, faster-whisper and Ollama; stub routes browsable at /docs. - app/, case/: Flutter app plan; parametric OpenSCAD enclosure. - Licensing: GPL-3.0 (code), CERN-OHL-S-2.0 (hardware), CC-BY-SA-4.0 (case/docs), REUSE-style LICENSES/ with SPDX headers; LICENSING.md explains the split. - CI: Forgejo Actions workflow builds firmware (both profiles) and lints/imports server. Why: - Everything self-hosted and openly licensed per the user's requirements: an open API, three sync paths (BLE control, WiFi transfer, independent WiFi upload on charge to generic cloud storage), and a full self-hosted transcription+summary stack. Notes: - No custom PCB in v1; off-the-shelf modules. Physical verification waits on parts. - Component code is stubs at M0; features land milestone by milestone, each as its own branch/PR per the workflow. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>	2026-07-03 10:21:37 +01:00
..
openscribe_case.scad	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

Laurence 031074c9a9

ci / firmware (push) Failing after 2s

Details

ci / server (push) Failing after 45s

Details

scaffold: OpenScribe open-source self-hosted AI voice recorder

Bootstrap of the project (M0). Sets up the monorepo, design docs, hardware BOM,
the open API contract, component skeletons, licensing and CI, following the
Default Workflow SOP.

What changed:
- CLAUDE.md + docs/: copied the Default Workflow so sessions load the SOP.
- state/: PROJECT, ARCHITECTURE, DECISIONS, TODO, NOTES filled in for OpenScribe.
  ARCHITECTURE captures the four-part design (firmware, server, app, case) and the
  three sync paths; DECISIONS records the hardware, AI-stack, storage, app and
  licensing choices; TODO lays out milestones M1-M9.
- hardware/BOM.md: two build options (compact XIAO ESP32-S3 Sense; dev ESP32-S3 +
  I2S mic + SD), wiring/pinout, indicative cost.
- api/openapi.yaml: the completely open API (device + server surfaces), including
  recording list/download/delete and exports (wav/ogg/txt/srt/vtt/md/json).
- firmware/: PlatformIO ESP32-S3 project, two board profiles, pin map, boot scaffold
  with module seams for M1-M4.
- server/: FastAPI skeleton mirroring the OpenAPI, config for self-hosted MinIO,
  faster-whisper and Ollama; stub routes browsable at /docs.
- app/, case/: Flutter app plan; parametric OpenSCAD enclosure.
- Licensing: GPL-3.0 (code), CERN-OHL-S-2.0 (hardware), CC-BY-SA-4.0 (case/docs),
  REUSE-style LICENSES/ with SPDX headers; LICENSING.md explains the split.
- CI: Forgejo Actions workflow builds firmware (both profiles) and lints/imports server.

Why:
- Everything self-hosted and openly licensed per the user's requirements: an open
  API, three sync paths (BLE control, WiFi transfer, independent WiFi upload on
  charge to generic cloud storage), and a full self-hosted transcription+summary stack.

Notes:
- No custom PCB in v1; off-the-shelf modules. Physical verification waits on parts.
- Component code is stubs at M0; features land milestone by milestone, each as its
  own branch/PR per the workflow.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

2026-07-03 10:21:37 +01:00

openscribe_case.scad

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 case

Parametric 3D-printed enclosure, in OpenSCAD.

Status: M0 scaffold. openscribe_case.scad is a parametric two-part shell with the openings a recorder needs (mic port, button, USB, LED). M8 measures the chosen build, tunes the parameters, adds a clip/lanyard mount and print tolerances, and exports STLs.

Render / export

Open openscribe_case.scad in OpenSCAD.
Set part to bottom, top or both, then F5 (preview) / F6 (render).
Export STL (or use the CLI): openscad -o case_top.stl -D 'part="top"' openscribe_case.scad

Parameters

Board and battery dimensions default to Build A (XIAO ESP32-S3 Sense + a small LiPo). Edit the [Board] / [Battery] / [Enclosure] / [Openings] variables at the top to fit your build from ../hardware/BOM.md.

Printing

Material: PLA or PETG. 0.2 mm layers, 3 perimeters.
STL/3MF/gcode exports are gitignored; commit only the .scad source.