aaribaud/ESPSomfy-RTS
0
0
Fork 0
mirror of https://github.com/rstrouse/ESPSomfy-RTS.git synced 2026-10-31 13:52:15 +01:00
Code Issues Projects Releases Packages Wiki Activity
ESPSomfy-RTS/docs/adr/0007-no-github-update.md
cjkas e25747d395 docs: ADRs 0005-0007 for socket protocol 2 
ADR 0005: the web UI and Home Assistant talk to the device over one
websocket protocol (ops on loop(), sync with next, a JSON envelope a
binary encoding can reuse, short keys described by a schema).
ADR 0006: two security modes and eleven HTTP routes on port 80.
ADR 0007: the firmware no longer updates itself from GitHub.

ADR 0002 is amended: its single-writer rule stands, but edits now get
one reply and reads no longer go through a ModelSnapshot.
SECURITY_PLAN.md is revised to match, and keeps the token key, login
backoff, CORS and Origin work. PROTOCOL.md starts as an outline, and
GLOSSARY.md gains the socket protocol and security terms.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-22 20:50:33 +02:00

1.5 KiB
Raw Blame History

status
accepted

The firmware no longer updates itself from GitHub

The device fetched GitHub's release list, downloaded firmware and filesystem images, and checked daily for a newer release, all over HTTPS on the device itself. A TLS session needs one contiguous block of about 35–40 KB. On IDF 5.5 the heap's largest free block is often smaller (issue #76: "SSL - Memory allocation failed" with a 34.8 KB largest block). The download checked no certificate (setInsecure()), so anyone who could intercept it could serve their own firmware. Parts of it ran blocking on the web server's task, and its socket events from there were dropped. The web UI's update buttons sent PUT to routes that accept only GET, so they had been answering 404.

We removed it: the release check and its setting, the release list, download and cancel, /recoverFilesystem and the updateProgress event. Updates are done by uploading firmware.bin and littlefs.bin (/updateFirmware, /updateApplication), or over USB.

Consequences

  • Users download releases from GitHub themselves. The web UI's firmware page shows the installed version and the upload form.
  • Home Assistant's update entity shows the installed version only; it can no longer install.
  • A broken filesystem is recovered by uploading littlefs.bin, or over USB, rather than with /recoverFilesystem.
  • Issue #76 and PR #72 (GitOTA's per-chip littlefs file name) become obsolete.
  • The HTTPS client leaves the firmware, which frees flash in the 1.5 MB OTA slot.