Laurence
87a00265a3
Adds the WiFi-to-app sync path and the on-device open REST API implementing the
device paths of api/openapi.yaml, plus persistent config in NVS.
What changed:
- firmware/src/config.{h,cpp}: NVS (Preferences) store - stable device id from MAC,
WiFi SSID/PSK, API bearer token, upload settings. Secrets stay off the SD card.
- firmware/src/net_wifi.{h,cpp}: station join with stored creds; SoftAP provisioning
fallback when no creds / join fails; mDNS openscribe.local; reconnect in loop().
- firmware/src/api_http.{h,cpp}: synchronous WebServer on :80. Routes: GET /device,
GET/PUT /device/config, GET /recordings, GET /recordings/{id}, GET
/recordings/{id}/audio (HTTP Range -> 206 + Content-Range), DELETE /recordings/{id},
POST /record/start|stop. Bearer-token auth on mutating calls (open when no token).
- firmware/src/storage.{h,cpp}: list/read/delete/count helpers + path builders.
- firmware/src/main.cpp: wire config + WiFi + API into setup/loop; bump fw to 0.2.0.
- firmware/platformio.ini: add bblanchon/ArduinoJson@^7 (only new dep).
- state/: ARCHITECTURE, NOTES, TODO updated; security + NTP follow-ups recorded.
Why:
- This is the WiFi transfer channel and the device half of the "completely open API":
clients can list, download (resumable), delete and control without any cloud.
Notes:
- Not compiled locally (no PlatformIO on the dev host) or hardware-verified; CI builds
both board profiles. Security follow-ups logged: API is open when no token is set,
and the SoftAP uses a fixed default passphrase (make user-set at M4/BLE).
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
||
|---|---|---|
| .. | ||
| include | ||
| src | ||
| platformio.ini | ||
| README.md | ||
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.