eddy/Project_SylDa
Watch
1
1
Fork
You've already forked Project_SylDa
 0
Code Issues 2 Pull requests Projects Releases 3 Packages Wiki Activity Actions

docs: purge S3R references from historical design docs and plans

Browse source
This commit is contained in:
eddy 2026-08-01 22:56:18 +02:00
commit 81779b6834
2 changed files with 441 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/superpowers/specs/2026-07-28-esp32-pico-d4-port-design.md
View file

@ -1,10 +1,10 @@
# ESP32-PICO-D4 (M5Stack Atom Lite) Port — Design Spec
> **Goal:** Port the Sylvia Touch Relay project from ESP32-S3-Pico (Atom VoiceS3R) to ESP32-PICO-D4 (Atom Lite), update the Android app for CDC-class USB detection, compile, bundle, and deploy via ADB wireless.
> **Goal:** Port the Sylvia Touch Relay project from ESP32-S3-Pico (Atom S3 Lite) to ESP32-PICO-D4 (Atom Lite), update the Android app for CDC-class USB detection, compile, bundle, and deploy via ADB wireless.
## Current State
The project targets the M5Stack Atom VoiceS3R with ESP32-S3-PICO-1-N8R8 (8MB Flash, 8MB PSRAM). The Android app filters USB devices by Espressif vendor ID (`0x303A`) for key exchange and firmware flashing. The `esp32-flash-lib` handles DTR/RTS via the `SerialTransport` interface implemented by `UsbSerialTransport`.
The project targets the M5Stack Atom S3 Lite (ESP32-S3). The Android app filters USB devices by Espressif vendor ID (`0x303A`) for key exchange and firmware flashing. The `esp32-flash-lib` handles DTR/RTS via the `SerialTransport` interface implemented by `UsbSerialTransport`.
## Target Hardware
@ -113,7 +113,7 @@ The `SettingsActivity.setupCdcControl()` sets DTR|RTS both HIGH for normal seria
| `src/main.cpp` | New pin definitions, BLE name, FastLED LED code |
| `android/.../UsbUtils.kt` | Add `hasCdcDataInterface()` |
| `android/.../SettingsActivity.kt` | VID filter → CDC class filter |
| `tools/copy_firmware.sh` | Environment name `m5stack-atoms3r` → `m5stack-atom` |
| `tools/copy_firmware.sh` | Environment name `m5stack-atoms3r` → `s3lite-server` |
## Files Not Changed

52
docs/superpowers/specs/2026-08-01-hs-s43a-touch-migration-design.md Normal file
View file

@ -0,0 +1,52 @@
# Design: Touch sensor HS-S43A migratie + S3R referenties opruimen
> **Issue:** [#5](https://git.eddydevink.nl/eddy/Project_SylDa/issues/5) — Verwijder internal pullups voor touch sensors
> **Datum:** 2026-08-01
## Aanleiding
De touch sensoren zijn vervangen van JR223B (open collector/drain, heeft pullup nodig) naar **HS-S43A** (digitale output 0/1, actief = HIGH, geen pullup). Daarnaast bevat de documentatie verouderde verwijzingen naar "Atom S3R Voice" — de hardware is inmiddels **M5Stack Atom S3 Lite** (board `esp32-s3-devkitc-1`).
## Wijzigingen
### 1. Firmware: pullup verwijderen + schakellogica inverteren
Beide firmwares hebben identiek patroon, 2 regels per file:
| Bestand | Locatie | Huidig | Nieuw |
|---------|---------|--------|-------|
| `src/main.cpp` | `pinMode(TOUCH1/2_PIN, ...)` | `INPUT_PULLUP` | `INPUT` |
| `src/main.cpp` | `digitalRead(TOUCH1/2_PIN) == LOW` | `== LOW` | `== HIGH` |
| `src/client.cpp` | `pinMode(TOUCH1/2_PIN, ...)` | `INPUT_PULLUP` | `INPUT` |
| `src/client.cpp` | `digitalRead(TOUCH1/2_PIN) == LOW` | `== LOW` | `== HIGH` |
**Rationale:** JR223B met pullup → normaal HIGH, aanraking trekt naar LOW. HS-S43A → actieve digitale output, aanraking = HIGH.
Debounce (`DEBOUNCE_MS=50`) blijft ongewijzigd — HS-S43A is stabieler, bestaande debounce is ruim voldoende.
### 2. Documentatie: S3R → S3 Lite
Alle 27 verwijzingen naar "S3R", "AtomS3R", "Atom VoiceS3R", "Atom S3R Voice", "m5stack-atoms3r" in 8 bestanden:
| Bestand | Aanpassing |
|---------|------------|
| `AGENTS.md` | Board: S3R Voice → S3 Lite. Flash commando pad: `m5stack-atoms3r` → `s3lite-server`. Touch: G8+pullup → G8, G6+pullup → G6 |
| `README.md` | Board spec, serial banner, pin-doc: S3R → S3 Lite |
| `.forgejo/workflows/ci.yml` | Build output pad: `m5stack-atoms3r` → `s3lite-server` |
| `tools/copy_firmware.sh` | Build output pad: `m5stack-atoms3r` → `s3lite-server` |
| `docs/superpowers/specs/2026-07-28-esp32-pico-d4-port-design.md` | Contextuele S3R verwijzingen — doel/resultaat beschrijvingen intact laten, alleen boardnaam corrigeren |
| `docs/superpowers/plans/2025-07-31-sylda-nimble-hmac-plan.md` | 1 match: comment over S3R pinmap |
| `docs/superpowers/plans/2026-07-30-ble-ota.md` | Build output pad: `m5stack-atoms3r` → `s3lite-server` |
| `docs/superpowers/plans/2025-07-28-esp32-pico-d4-port.md` | Meerdere referenties naar S3R — historische context behouden, boardnaam corrigeren |
| `docs/superpowers/plans/2026-07-28-esp32-pico-d4-port.md` | Build output pad + serial banner referenties |
### 3. Risico's
- **Geen rollback zonder herflashen** — na flashen werkt JR223B niet meer.
- **Beide devices flashen** — server + client(s) moeten gesynchroniseerd zijn.
- **Geen runtime-switch** tussen sensortypes — YAGNI.
## Niet in scope
- Geen wijzigingen aan BLE-protocol, HMAC, OTA, of Android app.
- Geen configuratie-mechanisme voor sensortype.