twislaandClaude Opus 5.5
34e6714785
Every screen's keys are constant tables in lib/core/src/app_keys.h (52 of them, each under an `// id: Title` comment). An App's help() picks the table of the state it is in. site/tools/gen_dev_docs.py reads the same file and writes site/data/keys.toml; the `keys` shortcode shows a screen's tables on its guide page, and /guide/keys/ shows all of them. The Site job fails when the data file is out of date or a page asks for a table that doesn't exist, and now also runs when app_keys.h changes. A key added to an App shows up on the website without anyone editing a page. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
3.7 KiB
+++ title = "Updates" description = "How the device updates itself from the project's releases, from the SD card or from a PC, and how it protects itself when an update goes wrong." weight = 11 [extra] tag = "Firmware" screens = ["update.png"] +++
Every update is one signed file (.ota). The device installs only a file signed with the project's key, so it cannot be tricked into installing anything else, whichever way the file arrives.
Settings → Firmware
The page shows the version running, its status, the address to push updates to over Wi-Fi, and:
- Latest release: Enter (or c) asks the server and says
v0.11.0 (new)or(current). Enter again opens the release: its version, date, size and the tag's message, with Install when it is newer. - Older releases: the last ten, newest first. Opening an older one offers to go back to it, with a different question.
- On the SD card: the
.otafiles found in/updates, ready to install. Copy one there with a computer or the Storage App; the Storage App also opens an.otafile and says whether it would install.
An install needs Wi-Fi if it is a download. The new firmware is checked before anything is written (the signature after the first 160 bytes) and again at the end (the image's hash). Then the device restarts. It will wait up to 60 seconds if you are typing, so that a restart never eats a note.
Check for updates
Settings → Check for updates is on by default. Once a day, with Wi-Fi up and the clock set, the device looks at the latest release and says v0.11.0 is out: see Settings > Firmware, once per version. It installs nothing by itself, and it does not announce a version that already failed and rolled back on this device.
Probation and Rollback
A newly installed firmware runs on Probation: it must boot, draw its screen, start its services and run 30 seconds without a crash, and reconnect Wi-Fi if that is configured (within 3 minutes), before it is confirmed for good. If it crashes or restarts, or cannot get Wi-Fi back, the device rolls back to the previous firmware by itself and says so.
Safe Mode
If a confirmed firmware crashes and restarts 3 times in a row, the device starts in Safe Mode instead: only Wi-Fi and firmware updates, so a fix can be installed without a cable. A normal restart leaves it.
IRC steps aside
A secure connection takes about 52 KB of memory at its peak, and IRC's own takes about 40 KB of the 107 KB there is. So a check or an install that you ask for makes IRC disconnect for the few seconds it takes, and reconnect afterwards. The daily check never does that: with IRC connected it waits for a moment when IRC is not, so if IRC stays connected for days the daily check does not run, and Latest release is the way to check.
How the connection is trusted
The connection to the project's server is checked against the two root certificates that Let's Encrypt's chains end in, not against the usual bundle of about 130 authorities. Whatever the connection, the update file's own signature decides what gets installed.
For developers
Updates can also be pushed from a PC over Wi-Fi, with scripts/flash.sh --ota <ip>, or put on the card with scripts/sd_put.sh: see the README. The firmware's console can be reached over Wi-Fi too: see The Debug Console.
The keys, as the device lists them
What Fn + h shows on these screens. These tables are generated from the firmware's own lists, so they are always the current ones.
{{ keys(scopes=["firmware", "firmware-release", "firmware-older"]) }}