Laurence
031074c9a9
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>
39 lines
No EOL
1.4 KiB
Markdown
39 lines
No EOL
1.4 KiB
Markdown
# OpenScribe firmware
|
|
|
|
ESP32-S3 recorder firmware. Built with PlatformIO + Arduino-ESP32.
|
|
|
|
> Status: M0 scaffold. Boots and reports the board profile + PSRAM. Audio, storage, WiFi,
|
|
> REST API, uploader and BLE land in milestones M1-M4 (see `../state/TODO.md`).
|
|
|
|
## Boards
|
|
|
|
Two profiles, matching `../hardware/BOM.md`:
|
|
|
|
- `esp32s3_dev` (default) - ESP32-S3 devkit with PSRAM, external I2S mic + SD module.
|
|
- `xiao_esp32s3` - Seeed XIAO ESP32-S3 (Sense): compact, onboard PDM mic + microSD.
|
|
|
|
## Build and flash
|
|
|
|
```bash
|
|
pio run # build default env (esp32s3_dev)
|
|
pio run -e xiao_esp32s3 # build the compact profile
|
|
pio run -t upload # flash over USB
|
|
pio device monitor # serial console at 115200
|
|
```
|
|
|
|
Install PlatformIO (`pip install platformio` or the VS Code extension). On Windows install
|
|
the USB-serial driver (CP210x / CH34x) so the board enumerates a COM port.
|
|
|
|
## Layout
|
|
|
|
```
|
|
platformio.ini Build profiles (esp32s3_dev, xiao_esp32s3)
|
|
include/pins.h Pin map (override per board; defaults = BOM Build B)
|
|
src/main.cpp Entry point + module seams
|
|
```
|
|
|
|
## Design
|
|
|
|
The device records audio to microSD and syncs three ways: BLE (control/provisioning),
|
|
WiFi REST API (transfer to the app), and independent WiFi upload to object storage when on
|
|
charge. See `../state/ARCHITECTURE.md` and the API in `../api/openapi.yaml`. |