Laurence
f84bbca80b
Answers "how do we emulate/lint this?" with runnable tooling for every part, and factors the pure firmware logic out so it is unit-testable on the host. What changed: - firmware/src/wav.h, firmware/src/httprange.h: pure, header-only WAV header builder and HTTP Range parser (no Arduino deps), so the tricky byte-layout and range logic can be tested on a PC. storage.cpp and api_http.cpp refactored to use them. - firmware/test/test_pure/: Unity tests for the WAV header fields and Range parsing (start-end, open-ended, clamped, unsatisfiable, non-bytes). Run: pio test -e native. - firmware/platformio.ini: add [env:native] (host tests) and [env:esp32s3_wokwi] (emulator build with default WiFi = Wokwi-GUEST so the API comes up in the sim). - firmware/wokwi.toml + firmware/diagram.json: Wokwi emulator harness (ESP32-S3 + microSD + button + LED). Note: Wokwi has no I2S mic part, so audio isn't emulated; the harness targets boot + WiFi + REST API. - firmware/src/main.cpp + config.cpp: bring up WiFi + API even if audio/SD init fails (device stays reachable, reports the fault via GET /device); compile-time default WiFi honoured when NVS is empty (used by the Wokwi build). - .forgejo/workflows/ci.yml: add native tests + cppcheck to the firmware job; new openapi job (openapi-spec-validator) and emulator job (Wokwi build, plus a full run when WOKWI_CLI_TOKEN is set). - docs/testing.md: the full emulate/lint guide for firmware, server, API, app, case. - state/: NOTES points at the guide; TODO reflects this branch. Why: - The firmware can't be flashed yet (no parts) and doesn't build on this dev host, so we need host-runnable checks. Pure-logic unit tests + OpenAPI validation run anywhere; Wokwi emulates boot/WiFi/API; CI compiles the real firmware. Verified locally: the OpenAPI spec validates (12 paths, 10 schemas). Notes: - Native tests and cppcheck run in CI (no compiler on the dev host). The Wokwi full run is skipped unless a WOKWI_CLI_TOKEN secret is present; the build is still verified. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> |
||
|---|---|---|
| .. | ||
| include | ||
| src | ||
| test/test_pure | ||
| diagram.json | ||
| platformio.ini | ||
| README.md | ||
| wokwi.toml | ||
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
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.