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>
54 lines
No EOL
1.7 KiB
INI
54 lines
No EOL
1.7 KiB
INI
; SPDX-License-Identifier: GPL-3.0-only
|
|
; OpenScribe firmware - PlatformIO project.
|
|
; Two build profiles: a dev board (Build B) and the compact XIAO ESP32-S3 (Build A).
|
|
; See ../hardware/BOM.md for the matching hardware and pinout.
|
|
|
|
[platformio]
|
|
default_envs = esp32s3_dev
|
|
src_dir = src
|
|
include_dir = include
|
|
|
|
[env]
|
|
platform = espressif32
|
|
framework = arduino
|
|
monitor_speed = 115200
|
|
build_flags =
|
|
-DCORE_DEBUG_LEVEL=3
|
|
; PSRAM is required for audio ring buffers
|
|
-DBOARD_HAS_PSRAM
|
|
lib_deps =
|
|
; JSON for the on-device REST API (M2). I2S/SD/WiFi/WebServer/mDNS/Preferences are all
|
|
; bundled with the Arduino-ESP32 core, so no other deps are needed yet.
|
|
bblanchon/ArduinoJson@^7.0
|
|
|
|
; --- Build B: ESP32-S3 dev board with PSRAM (N16R8), external I2S mic + SD ---
|
|
[env:esp32s3_dev]
|
|
board = esp32-s3-devkitc-1
|
|
board_build.arduino.memory_type = qio_opi
|
|
build_flags =
|
|
${env.build_flags}
|
|
-DOPENSCRIBE_BOARD_DEV=1
|
|
|
|
; --- Build A: Seeed XIAO ESP32-S3 (Sense) - compact wearable, onboard PDM mic + SD ---
|
|
[env:xiao_esp32s3]
|
|
board = seeed_xiao_esp32s3
|
|
build_flags =
|
|
${env.build_flags}
|
|
-DOPENSCRIBE_BOARD_XIAO=1
|
|
|
|
; --- Emulator build: ESP32-S3 in Wokwi, with default WiFi = Wokwi-GUEST (open). ---
|
|
; Build then run the emulator: pio run -e esp32s3_wokwi (see ../docs/testing.md)
|
|
[env:esp32s3_wokwi]
|
|
extends = env:esp32s3_dev
|
|
build_flags =
|
|
${env:esp32s3_dev.build_flags}
|
|
-DOSC_DEFAULT_WIFI_SSID="\"Wokwi-GUEST\""
|
|
-DOSC_DEFAULT_WIFI_PSK="\"\""
|
|
|
|
; --- Host unit tests for the pure logic (wav.h, httprange.h). No hardware needed. ---
|
|
; Run: pio test -e native (see ../docs/testing.md)
|
|
[env:native]
|
|
platform = native
|
|
test_framework = unity
|
|
build_src_filter = -<*> ; exclude Arduino sources; tests include the pure headers
|
|
build_flags = -std=gnu++17 -I src |