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>
56 lines
1.7 KiB
C++
56 lines
1.7 KiB
C++
// SPDX-License-Identifier: GPL-3.0-only
|
|
// microSD storage: a streaming WAV writer plus sidecar JSON metadata.
|
|
#pragma once
|
|
|
|
#include <Arduino.h>
|
|
#include <FS.h>
|
|
#include <SD.h>
|
|
|
|
namespace storage {
|
|
|
|
// Mount the microSD card over SPI using the pins in pins.h. Creates OSC_REC_DIR.
|
|
bool begin();
|
|
|
|
uint64_t totalBytes();
|
|
uint64_t freeBytes();
|
|
|
|
// Streaming writer for a canonical 16-bit PCM WAV file. Writes a placeholder header on
|
|
// open(), appends PCM with write(), and patches the RIFF/data sizes on close().
|
|
class WavWriter {
|
|
public:
|
|
bool open(const String &path, uint32_t sampleRate, uint16_t bitsPerSample,
|
|
uint16_t channels);
|
|
size_t write(const uint8_t *data, size_t len);
|
|
bool close();
|
|
uint32_t dataBytes() const { return dataBytes_; }
|
|
bool isOpen() const { return (bool)file_; }
|
|
|
|
private:
|
|
File file_;
|
|
uint32_t dataBytes_ = 0;
|
|
uint32_t sampleRate_ = 0;
|
|
uint16_t bits_ = 0;
|
|
uint16_t channels_ = 0;
|
|
};
|
|
|
|
// Write a sidecar JSON metadata file next to a recording.
|
|
bool writeMetadata(const String &path, const String &json);
|
|
|
|
// Path helpers for a recording id.
|
|
String recWavPath(const String &id);
|
|
String recMetaPath(const String &id);
|
|
|
|
// Read a whole (small) file into a String; empty String if it does not exist.
|
|
String readFile(const String &path);
|
|
|
|
// Delete a recording's audio + metadata. Returns true if anything was removed.
|
|
bool removeRecording(const String &id);
|
|
|
|
// Count recordings (by .wav files) currently on the card.
|
|
uint32_t countRecordings();
|
|
|
|
// Build the RecordingPage JSON by concatenating every sidecar metadata object. This is
|
|
// the body for GET /recordings and matches api/openapi.yaml.
|
|
String listRecordingsJson();
|
|
|
|
} // namespace storage
|