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

platformio.ini: hardcoded upload_port is niet portable #11

New issue
Closed
opened 2026-08-02 20:34:35 +02:00 by eddy · 2 comments
eddy commented 2026-08-02 20:34:35 +02:00
Owner
Copy link

Probleem

In platformio.ini staat een hardcoded upload_port per environment:

[env:s3lite-server]
upload_port = /dev/serial/by-id/usb-Espressif_USB_JTAG_serial_debug_unit_44:1B:F6:F4:CF:14-if00

[env:s3lite-client]
upload_port = /dev/ttyACM2

Problemen:

  • Machine-specifiek — werkt niet op een andere computer of met een andere ESP32
  • /dev/ttyACM* kan wisselen als andere USB-apparaten worden aangesloten
  • De AGENTS.md zegt expliciet "NOOIT /dev/ttyACM0" (Atreus toetsenbord), maar /dev/ttyACM2 is even onbetrouwbaar

Oplossing

Verwijder upload_port uit platformio.ini en laat PlatformIO de juiste poort automatisch detecteren, óf gebruik een platformio.local.ini (gitignored) met machine-specifieke instellingen.

Optie A: Auto-detectie (aanbevolen)

Verwijder upload_port uit beide environments. PlatformIO kan automatisch de ESP32 vinden als er maar één verbonden is. Bij meerdere ESP32s kan de gebruiker pio run -e s3lite-server --target upload --upload-port /dev/... gebruiken.

Optie B: platformio.local.ini

  1. Voeg platformio.local.ini toe aan .gitignore
  2. Verplaats upload_port naar platformio.local.ini: 
    [env:s3lite-server]
upload_port = /dev/serial/by-id/usb-Espressif_...

[env:s3lite-client]
upload_port = /dev/serial/by-id/usb-Espressif_...
  3. PlatformIO merget platformio.local.ini automatisch met platformio.ini

Optie B geeft het gemak van hardcoded poorten zonder de machine-specifieke paden in git te committen.

## Probleem In `platformio.ini` staat een hardcoded upload_port per environment: ```ini [env:s3lite-server] upload_port = /dev/serial/by-id/usb-Espressif_USB_JTAG_serial_debug_unit_44:1B:F6:F4:CF:14-if00 [env:s3lite-client] upload_port = /dev/ttyACM2 ``` Problemen: - Machine-specifiek — werkt niet op een andere computer of met een andere ESP32 - `/dev/ttyACM*` kan wisselen als andere USB-apparaten worden aangesloten - De AGENTS.md zegt expliciet "NOOIT `/dev/ttyACM0`" (Atreus toetsenbord), maar `/dev/ttyACM2` is even onbetrouwbaar ## Oplossing Verwijder `upload_port` uit `platformio.ini` en laat PlatformIO de juiste poort automatisch detecteren, óf gebruik een `platformio.local.ini` (gitignored) met machine-specifieke instellingen. ### Optie A: Auto-detectie (aanbevolen) Verwijder `upload_port` uit beide environments. PlatformIO kan automatisch de ESP32 vinden als er maar één verbonden is. Bij meerdere ESP32s kan de gebruiker `pio run -e s3lite-server --target upload --upload-port /dev/...` gebruiken. ### Optie B: platformio.local.ini 1. Voeg `platformio.local.ini` toe aan `.gitignore` 2. Verplaats `upload_port` naar `platformio.local.ini`: ```ini [env:s3lite-server] upload_port = /dev/serial/by-id/usb-Espressif_... [env:s3lite-client] upload_port = /dev/serial/by-id/usb-Espressif_... ``` 3. PlatformIO merget `platformio.local.ini` automatisch met `platformio.ini` Optie B geeft het gemak van hardcoded poorten zonder de machine-specifieke paden in git te committen.
eddy commented 2026-08-02 21:15:23 +02:00
Author
Owner
Copy link

Oplossing

Verwijder upload_port uit platformio.ini en vervang door een POST-script dat automatisch de juiste ESP32 detecteert via een nieuw ID? serial commando.

1. Firmware: ID? commando

Beide firmwares krijgen een nieuw serial commando:

  • main.cpp: ID? → antwoordt SylDa_Server
  • client.cpp: ID? → antwoordt SylDa_Client

Dit past in de bestaande serial command chain naast KEY?, VERSION?, etc.

2. Script: tools/pio_upload_port.py (POST)

Gebaseerd op PlatformIO docs (geverifieerd):

  • env.AddPreAction("upload", callback) — hook vlak vóór upload
  • env["UPLOAD_PORT"] — dynamisch poort instellen
  • env.IsIntegrationDump() — overslaan tijdens IDE queries
  • input() — gebruiker prompt (officieel gedocumenteerd)

Logic:

  1. Registreer pre-upload hook
  2. In de hook: scan /dev/serial/by-id/usb-Espressif_* voor ESP32 poorten
  3. 1 poort → direct gebruiken (snel pad)
  4. 2+ poorten → stuur ID?\n naar elke poort, match met verwachte ID (s3lite-server → SylDa_Server, s3lite-client → SylDa_Client)
  5. Geen match (bijv. eerste flash) → prompt gebruiker om poort te kiezen

3. platformio.ini

extra_scripts =
    pre:tools/pio_version_pre.py
    post:tools/pio_upload_port.py

Geen upload_port meer. Poort wordt dynamisch bepaald per upload.

Beperking

Bij eerste-flash (lege ESP32) kan geen ID? query beantwoord worden → gebruiker kiest handmatig uit beschikbare poorten.

## Oplossing Verwijder `upload_port` uit `platformio.ini` en vervang door een POST-script dat automatisch de juiste ESP32 detecteert via een nieuw `ID?` serial commando. ### 1. Firmware: `ID?` commando Beide firmwares krijgen een nieuw serial commando: - **main.cpp**: `ID?` → antwoordt `SylDa_Server` - **client.cpp**: `ID?` → antwoordt `SylDa_Client` Dit past in de bestaande serial command chain naast `KEY?`, `VERSION?`, etc. ### 2. Script: `tools/pio_upload_port.py` (POST) Gebaseerd op PlatformIO docs (geverifieerd): - `env.AddPreAction("upload", callback)` — hook vlak vóór upload - `env["UPLOAD_PORT"]` — dynamisch poort instellen - `env.IsIntegrationDump()` — overslaan tijdens IDE queries - `input()` — gebruiker prompt (officieel gedocumenteerd) **Logic:** 1. Registreer pre-upload hook 2. In de hook: scan `/dev/serial/by-id/usb-Espressif_*` voor ESP32 poorten 3. **1 poort** → direct gebruiken (snel pad) 4. **2+ poorten** → stuur `ID?\n` naar elke poort, match met verwachte ID (`s3lite-server` → `SylDa_Server`, `s3lite-client` → `SylDa_Client`) 5. **Geen match** (bijv. eerste flash) → prompt gebruiker om poort te kiezen ### 3. `platformio.ini` ```ini extra_scripts = pre:tools/pio_version_pre.py post:tools/pio_upload_port.py ``` Geen `upload_port` meer. Poort wordt dynamisch bepaald per upload. ### Beperking Bij eerste-flash (lege ESP32) kan geen `ID?` query beantwoord worden → gebruiker kiest handmatig uit beschikbare poorten.
eddy commented 2026-08-02 21:18:57 +02:00
Author
Owner
Copy link

Geïmplementeerd in PR #13.

Wat is er gedaan

  • ID? serial commando toegevoegd aan beide firmwares (server antwoordt SylDa_Server, client SylDa_Client)
  • tools/pio_upload_port.py POST-script gemaakt dat:
    • ESP32 poorten scant via /dev/serial/by-id/usb-Espressif_*
    • Bij 1 poort: direct gebruiken
    • Bij 2+ poorten: ID? query sturen en matchen met verwachte identiteit
    • Bij geen match: gebruiker prompt om poort te kiezen (eerste-flash scenario)
  • upload_port verwijderd uit platformio.ini
  • extra_scripts uitgebreid met post:tools/pio_upload_port.py
  • Vereist pyserial (graceful fallback als niet geïnstalleerd)
  • PlatformIO API geverifieerd tegen officiële docs: env.AddPreAction("upload", ...), env["UPLOAD_PORT"], env.IsIntegrationDump(), input()
Geïmplementeerd in PR #13. ### Wat is er gedaan - `ID?` serial commando toegevoegd aan beide firmwares (server antwoordt `SylDa_Server`, client `SylDa_Client`) - `tools/pio_upload_port.py` POST-script gemaakt dat: - ESP32 poorten scant via `/dev/serial/by-id/usb-Espressif_*` - Bij 1 poort: direct gebruiken - Bij 2+ poorten: `ID?` query sturen en matchen met verwachte identiteit - Bij geen match: gebruiker prompt om poort te kiezen (eerste-flash scenario) - `upload_port` verwijderd uit `platformio.ini` - `extra_scripts` uitgebreid met `post:tools/pio_upload_port.py` - Vereist `pyserial` (graceful fallback als niet geïnstalleerd) - PlatformIO API geverifieerd tegen officiële docs: `env.AddPreAction("upload", ...)`, `env["UPLOAD_PORT"]`, `env.IsIntegrationDump()`, `input()`
eddy closed this issue 2026-08-02 21:19:05 +02:00
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
feature/client-ble-ota
v1.2
v1.1
v1.0
v2.0
Labels
Clear labels   
bug
Iets werkt niet correct

  
bug
Something isn't working

  
critical
Kritieke prioriteit

  
documentation
Documentatie

  
duplicate
This issue or pull request already exists

  
enhancement
Verbetering van bestaande functionaliteit

  
enhancement
New feature or request

  
feature
Nieuwe functionaliteit

  
good first issue
Good for newcomers

  
help wanted
Extra attention is needed

  
invalid
This doesn't seem right

  
question
Further information is requested

  
security
Beveiligingsprobleem

  
wontfix
This will not be worked on

No labels
bug
bug
critical
documentation
duplicate
enhancement
enhancement
feature
good first issue
help wanted
invalid
question
security
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
eddy/Project_SylDa#11
No description provided.