Compare commits

...
Author SHA1 Message Date
twislaandClaude Sonnet 5.5 492d8bb187 Site: security.txt, robots.txt, and favicon fallbacks (ICO, touch icon)
Site / build (pull_request) Successful in 9s
security.txt (RFC 9116) under .well-known with the mailbox as contact and an
expiry in September 2027. robots.txt allows everything and points to the
sitemap. The pixel 9 gets a favicon.ico (32 and 48 px) and an
apple-touch-icon.png, drawn by tools/make_favicons.py from the same
rectangles as favicon.svg.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 20:12:54 +02:00
twisla 821949e3f8 Merge pull request 'Site: roro9stack.net phase 1 (home, Install with a browser flasher, Downloads), and a CI split for site changes' (#61) from site into main
CI / build (push) Successful in 1m8s
Site / build (push) Successful in 7s
Reviewed-on: #61
2026-10-06 16:33:07 +00:00
twislaandClaude Sonnet 5.5 9415c62132 Site: the build goes to public/ at the repository root, which git ignores
CI / build (pull_request) Canceled after 38s
Site / build (pull_request) Successful in 8s
output_dir in site/config.toml, so zola build in site/ and zola --root site
build from the root both write ./public. The ignore is /public/, not
site/public/.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 18:31:57 +02:00
twislaandClaude Sonnet 5.5 6680b752af W1: what was built and checked in phase 1; the site in the README
CI / build (pull_request) Successful in 8m27s
Site / build (pull_request) Successful in 8s
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 18:20:18 +02:00
twislaandClaude Sonnet 5.5 8f4b5e0ddc Site: roro9stack.net, phase 1 (the home page, Install with a browser flasher, Downloads)
A Zola site in site/, from the design: both themes on the device's
palette, notched shapes, self-hosted fonts, the wordmark and icons, two
generated hero drawings, nine App cards (the mesh messenger marked
planned), real screenshots, the updates and build sections. The Install
page builds ESP Web Tools' manifest in the browser from the Gitea API (it
needs Caddy to allow the origin), refuses any download that isn't on the
project's server, and falls back to the esptool steps. Downloads lists the
releases. The focus ring shows on notched controls. A page checker fails
the build if a page loads from another origin.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 18:20:18 +02:00
twislaandClaude Sonnet 5.5 b92fc6e2e5 CI: a Site workflow, and the firmware workflow skips changes that touch only the site and its documents
site.yml builds the site with a Zola pinned by its checksum and checks the
pages when site/, docs/, README.md or CONTEXT.md change. ci.yml gets
paths-ignore for the same files on pushes to main and on pull requests; a
tag always runs it (Gitea doesn't apply path filters to tags). A change
touching both runs both.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 18:20:18 +02:00
twislaandClaude Sonnet 5.5 a0939bf741 W1 plan: the flasher reads the release from Gitea behind Caddy's CORS header, no firmware copy
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 17:54:02 +02:00
twislaandClaude Sonnet 5.5 748890deb8 W1 plan: the project website at roro9stack.net (issue #12), the design round
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 17:35:25 +02:00
twisla 4f0918ceae Merge pull request 'v0.11.0 polish: the Debug Build message, the release badge on tags, the CI timings' (#56) from fix-release-polish into main
CI / build (push) Successful in 1m10s
Reviewed-on: #56
2026-10-06 15:21:42 +00:00
twislaandClaude Sonnet 5.5 12006bdf94 CI: the release badge follows a tag, not only a push to main
CI / build (pull_request) Successful in 8m6s
After v0.11.0 was published the badge still said v0.10.0 until the next
push to main. Tag runs run the tests and coverage already; they now
publish the badges too.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 17:01:04 +02:00
twislaandClaude Sonnet 5.5 148611ff4c Updates: the Debug Build message fits on one line of the screen
"A Debug Build keeps its console: update it from your PC" ran off the
edge of the release page. It now reads "Debug Build: update from the PC".

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 17:01:04 +02:00
twislaandClaude Sonnet 5.5 325e7755ad R1 plan: the CI timings, measured from the jobs' own start and end times
The first full run took 11.4 minutes, not 17: that was the waiting time.
A pull request takes about 8.7, a release build alone 5.5, a push to main
1.1.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 17:01:04 +02:00
twisla df2aaddbc8 Merge pull request 'Updates from Gitea: check, list and install releases from the device (#6)' (#55) from gitea-updates into main
CI / build (push) Successful in 14m4s
Reviewed-on: #55
2026-10-06 14:29:01 +00:00
twislaandClaude Sonnet 5.5 e2f00e93c2 CI: a branch's pushes run nothing, its pull request runs once
CI / build (pull_request) Successful in 8m43s
A branch with an open pull request ran twice per push: once for the push,
once for the pull request. Pushes to main still run the tests and publish
the badges; every other branch is tested by its pull request.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 16:17:52 +02:00
twislaandClaude Sonnet 5.5 d490a18b9a Updates from Gitea, step 5: the daily check's announcement, the docs, ADR 0009
The announcement was cut at the notification's 48 bytes; it now reads
"v0.11.0 is out: see Settings > Firmware". README: Updates from Gitea
and its limits. ADR 0009: the device trusts the two ISRG roots. R1.md:
what was built and the checks on the device, with what wasn't checked.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 16:16:32 +02:00
twislaandClaude Sonnet 5.5 4ef41347ab Updates from Gitea, step 4: the Firmware page shows the project's releases
Latest release (checked on Enter, or c), Older releases (the last ten,
newest first), a release page with the tag's message, and an install
dialog; going back to an older release asks differently. A failed check
someone asked for shows a Toast. A Debug Build shows the latest release
and says it can't install it: it would take its console away.

Tried on the device: a check, the list, the release page, the dialog
(Cancel is the default; Back cancels), and the install from the screen
with its progress screen, then the restart into the release build and its
confirmation.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 16:06:49 +02:00
twislaandClaude Sonnet 5.5 510ce42a99 Updates from Gitea, step 3: install from Gitea, and IRC steps aside for it
A release downloads straight into the inactive slot through the existing
install path: the signature is checked after 160 bytes, before anything
is written, the hash at the end. Tried on the device against the real
server: a download cut short, a flipped byte in the signature and one in
the image are each refused with the running firmware untouched; the real
v0.10.0 installed, restarted, and confirmed itself on Probation.

A TLS connection to Gitea peaks at about 52 KB of heap whether or not the
certificate is verified. With IRC connected (66 KB free) a check left 3 KB
and a download 836 bytes. A check, list or install a person asks for now
makes IRC step aside (holdForUpdate) and come back after: the lowest free
heap during a full download with IRC connected is 38 KB. The daily check
never interrupts IRC; with IRC up it waits. A TLS connection starts with
80 KB free (it was 55).

Debug Builds get test knobs: update probe <host>, update damage cut|flip,
update pretend <version>.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 15:51:10 +02:00
twislaandClaude Sonnet 5.5 5754ae5b57 Updates from Gitea, step 2: the connection (check and list work on the device)
The roots (ISRG X1 and X2), an HTTPS client that reads the answer as a
stream, GiteaReleases (the latest and a list of ten), the Update
Service's requests, install from Gitea through the existing install path,
the daily check's schedule, the Check for updates setting, and console
commands: update check | list | status | install <tag>.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 15:20:58 +02:00
twislaandClaude Sonnet 5.5 b0e8226943 Updates from Gitea, step 1: the model (host-tested)
A streaming JSON scanner (a 33 KB list of releases costs a few hundred
bytes), the release reader built on it, HTTP response heads and chunked
bodies, URLs, and the decisions: which release is an update, whether to
announce it, and which download URLs the device takes. Tested against the
real answers of git.twis.la.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 15:11:58 +02:00
twislaandClaude Sonnet 5.5 6b7e90765f R1 plan: updates from Gitea, the design round (Q162-Q174)
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 15:08:33 +02:00
twisla 3120c63b4b Merge pull request 'CI: coverage and badges; tests on a push, builds on a pull request' (#51) from coverage into main
CI / build (push) Successful in 1m7s
Reviewed-on: #51
2026-10-06 12:39:25 +00:00
twislaandClaude Opus 5.5 873af31e21 R1 plan: pull requests, merged by rebase then a merge commit (Q161)
CI / build (push) Successful in 1m6s
CI / build (pull_request) Successful in 8m17s
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 14:37:44 +02:00
twislaandClaude Opus 5.5 16345ed6b3 CI: the badges are published from main only
CI / build (push) Successful in 1m5s
CI / build (pull_request) Successful in 8m19s
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 14:23:08 +02:00
twislaandClaude Opus 5.5 86ddb87f54 CI: a push runs the tests, a pull request also builds the firmware
CI / build (push) Successful in 1m6s
Rebuilding both firmwares on every push was more than anyone looked at.
A push now runs the host tests with their coverage (under two minutes);
a pull request adds the release firmware and the Debug Build, and is how
changes reach main; a tag still does everything before it releases.
Pull requests from forks don't run. scripts/ci.sh takes 'tests' or
'builds' for one half; coverage.sh now fails when a test fails.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 14:19:56 +02:00
twislaandClaude Opus 5.5 5ecd5d003f Coverage of lib/ by the host tests, and badges in the README
CI / build (push) Successful in 9m9s
scripts/coverage.sh builds the host tests with coverage counters and
reports with gcovr: 94.6% of the 3,193 lines of lib/ today (lib/SD and
src/ have no host tests and aren't counted). CI runs it on every push,
puts the figure in the job's summary, and on main publishes a coverage
badge and a latest-release badge to the branch 'badges'. The README shows
them next to Gitea's own badge for the workflow.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 13:56:08 +02:00
twislaandClaude Opus 5.5 edc140e30c Merge branch 'ci': CI on every push, a signed release on every tag
CI / build (push) Successful in 8m10s
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 13:51:19 +02:00
twislaandClaude Opus 5.5 6459ca5446 R1 plan: CI and releases are in place
CI / build (push) Successful in 8m8s
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 13:51:18 +02:00
twislaandClaude Opus 5.5 a94c14f000 R1 plan: CI as built on the container runner
CI / build (push) Successful in 8m5s
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 12:52:43 +02:00
twislaandClaude Opus 5.5 db7e6ccc18 CI: jobs run in a container, PlatformIO directly in it, the toolchains in a volume
CI / build (push) Successful in 8m5s
The runner now gives each job a container. The workflow asks for
python:3.12-slim, installs git, a compiler and PlatformIO, and mounts the
roro9stack-pio volume as the cache; the scripts skip their own docker run
when RORO_NO_DOCKER says they're in the build container already. A tag
from before the framework was rebuilt gets the stock framework libraries
back before it builds.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 12:39:37 +02:00
twislaandClaude Opus 5.5 ababfaf993 Release build: tags from before Firmware Updates carry no public key to check against
CI / build (push) Failing after 12m51s
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 12:25:20 +02:00
twislaandClaude Opus 5.5 6b6bb975f5 R1 plan and ADR 0008: CI signs releases; README section on CI
CI / build (push) Successful in 8m0s
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 12:19:00 +02:00
twislaandClaude Opus 5.5 1fade6287b CI: tests and builds on every push, a signed release on a tag (#5)
CI / build (push) Successful in 11m26s
The workflow runs on the runner's host and builds in the project's Docker
image through scripts/ci.sh, as on a developer's machine. A tag v*, or a
run by hand for an older tag, builds that tag's sources, signs the Update
File with the key held in the repository's secrets, checks the signature
against the public key in the sources, and publishes a Gitea release with
the .ota, the factory image, the ELF and checksums.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 12:06:57 +02:00
twislaandClaude Opus 5.5 661227cd2d CI: try the runner's label as it is registered
CI / probe (push) Successful in 0s
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 11:58:53 +02:00
twislaandClaude Opus 5.5 c481bb5191 CI: a first workflow, to see what the runner gives a job (#5)
CI / probe (push) Successful in 19s
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 11:56:10 +02:00
twislaandClaude Opus 5.5 9f65c75f01 Merge branch 'notes': the Notes App
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 10:11:31 +02:00
twislaandClaude Opus 5.5 a35d82c654 F1 plan: Notes ships as v0.10.0
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 10:11:31 +02:00
twislaandClaude Opus 5.5 e8a654a15f Notes: plain text notes on the SD card, with an editor that saves by itself (#19)
The Notes App lists the files of /notes by their first line, newest first:
n starts a note, Enter opens it, r renames its file, d deletes it after
asking, s sorts by name. A new note's file is named after its first line.

The editor wraps at spaces, 38 columns by 8 rows; Fn+arrows move through
the wrapped text, Ctrl+A and Ctrl+E go to the ends of the line. There is no
save key: the note is written five seconds after the last key, on Back, on
leaving the App, when the screen turns off and before the device powers
off. A save writes a temporary file and puts it in the note's place; a save
cut short is put back, or offered, the next time.

A note is up to 16 KB, held in one buffer reserved when it's opened: the
file is read straight into it and typing never makes it grow. A failed
allocation aborts on this device, and with IRC connected the largest free
block is about 31 KB: a first version that copied the note once on loading
restarted the device when a full note was opened with IRC connected.
Editing files of any size is #47.

The Storage App's text viewer gets `e`, which edits a text file up to 16 KB
with the same editor unless the file is read-only.

439 host tests. Checked on the device: docs/milestones/F1.md.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 10:08:10 +02:00
twislaandClaude Opus 5.5 c868977f1c A key sent through the Debug Console could turn the screen "off" for a tick
The `key` command stamps the power timer from millis(); the power tick
then compared with its pass's older time, and the unsigned difference read
as 49 days without a key. The screen state went Off for one tick, and the
next key was swallowed as a wake-up: about one remote key in twenty-five.
Keys from the keyboard pass the loop's own time and were never affected.
The same shape as #46. PowerPolicy::update now treats a stamp from the
future as "just now", with a test.

rdbg.py: piped lines written while it was still connecting stayed in
Python's read buffer until the next line arrived (readline() behind
select()). It reads the descriptor directly now.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 10:08:10 +02:00
twislaandClaude Opus 5.5 4ab873e9f8 F1 plan: the Notes design round (Q141-Q150)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 09:29:38 +02:00
119 changed files with 7410 additions and 26 deletions
+114
View File
@@ -0,0 +1,114 @@
# CI and releases (docs/milestones/R1.md).
# A push to main: the host tests, with their coverage of lib/, and the README's badges
# published to the branch `badges`.
# A pull request: the same tests and coverage, then the release firmware and the Debug Build.
# A branch's pushes run nothing by themselves: its pull request runs, once.
# A tag v*: all of it, then a Gitea release with the signed Update File.
# Run by hand: the release of a tag that exists already (the ones from before CI).
#
# The job runs in a plain Python image, as scripts/ci.sh does on a developer's machine, with the
# toolchains in a Docker volume the runner allows (container.valid_volumes: roro9stack-pio): that
# volume is the cache. No JavaScript actions, so the image needs no Node: the checkout is git.
name: CI
on:
push:
branches: [main] # other branches are tested by their pull request: one run, not two
tags: ['v*']
# A change that touches nothing but the site and the documents it is built from runs the Site
# workflow only (a tag always runs this one: Gitea doesn't apply path filters to tags).
paths-ignore: ['site/**', 'docs/**', 'README.md', 'CONTEXT.md']
pull_request:
paths-ignore: ['site/**', 'docs/**', 'README.md', 'CONTEXT.md']
workflow_dispatch:
inputs:
tag:
description: An existing tag to build and publish as a release
required: true
jobs:
build:
runs-on: ubuntu
# A pull request from a fork would run someone else's code on our runner: not without us (Q154).
if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository
container:
image: python:3.12-slim
volumes:
- roro9stack-pio:/pio
env:
PLATFORMIO_CORE_DIR: /pio
RORO_NO_DOCKER: 1
steps:
- name: Tools
run: |
apt-get update -qq
apt-get install -y -qq --no-install-recommends git build-essential openssl >/dev/null
pip install -q --no-cache-dir --root-user-action=ignore platformio gcovr
pio --version; df -h /pio | tail -1; ls /pio | head
- name: Check out
run: |
find . -mindepth 1 -maxdepth 1 -exec rm -rf {} +
git config --global --add safe.directory '*'
git init -q .
git remote add origin "${{ github.server_url }}/${{ github.repository }}.git"
git fetch -q --tags origin '+refs/heads/*:refs/remotes/origin/*' '+refs/pull/*/head:refs/remotes/pull/*'
git checkout -q --detach "${{ github.sha }}"
git describe --tags --always
- name: Host tests, and their coverage of lib/
if: github.event_name != 'workflow_dispatch'
run: scripts/coverage.sh
- name: The release firmware and the Debug Build
if: github.event_name == 'pull_request' || github.ref_type == 'tag'
run: scripts/ci.sh builds
# The README's badges are files on a branch of their own, replaced at each push to main and
# at each tag (the release badge says which tag is the latest)
- name: Publish the badges
if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref_type == 'tag')
env:
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
run: |
rm -rf /tmp/badges && mkdir /tmp/badges
cp .pio/coverage/coverage.svg .pio/coverage/summary.json /tmp/badges/
scripts/coverage_badge.py --plain release "$(git describe --tags --abbrev=0)" /tmp/badges/release.svg
cd /tmp/badges
git init -q -b badges .
git add .
git -c user.name="roro9stack CI" -c user.email="ci@git.twis.la" commit -q -m "Coverage of ${{ github.ref_name }} at ${{ github.sha }}"
git push -q --force "$(echo "${{ github.server_url }}" | sed "s#://#://ci:${GITEA_TOKEN}@#")/${{ github.repository }}.git" badges
- name: Which release
id: release
run: |
if [ "${{ github.event_name }}" = workflow_dispatch ]; then
echo "tag=${{ inputs.tag }}" >> "$GITHUB_OUTPUT"
elif [ "${{ github.ref_type }}" = tag ]; then
echo "tag=${{ github.ref_name }}" >> "$GITHUB_OUTPUT"
fi
- name: Build and sign the release
if: steps.release.outputs.tag != ''
env:
OTA_SIGNING_KEY: ${{ secrets.OTA_SIGNING_KEY }}
run: |
# The sources of the tag in a clone of their own; the tools are this commit's.
rm -rf /tmp/release-src dist
git clone -q . /tmp/release-src
git -C /tmp/release-src checkout -q --detach "refs/tags/${{ steps.release.outputs.tag }}"
# The key exists as a file only while this step runs, in a container that goes with the job.
umask 077
export RORO_OTA_KEY="$(mktemp)"
trap 'rm -f "$RORO_OTA_KEY"' EXIT
printf '%s\n' "$OTA_SIGNING_KEY" > "$RORO_OTA_KEY"
umask 022
scripts/release_build.sh /tmp/release-src dist
- name: Publish the release
if: steps.release.outputs.tag != ''
env:
GITEA_API: ${{ github.server_url }}/api/v1
GITEA_REPO: ${{ github.repository }}
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
run: scripts/release_publish.py dist
+49
View File
@@ -0,0 +1,49 @@
# The project site (docs/milestones/W1.md): built with Zola to see that it builds and that its pages
# are sound. Publishing is the maintainer's: the web server pulls main and runs `zola build`.
#
# It runs when the site, or a document the site is built from, changes (a pull request, or a push to
# main); the firmware workflow (ci.yml) skips a change that touches only these files. A change that
# touches both runs both.
name: Site
on:
push:
branches: [main]
paths: ['site/**', 'docs/**', 'README.md', 'CONTEXT.md', '.gitea/workflows/site.yml']
pull_request:
paths: ['site/**', 'docs/**', 'README.md', 'CONTEXT.md', '.gitea/workflows/site.yml']
jobs:
build:
runs-on: ubuntu
# A pull request from a fork would run someone else's code on our runner: not without us.
if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository
container:
image: python:3.12-slim
steps:
- name: Tools
run: |
apt-get update -qq
apt-get install -y -qq --no-install-recommends git ca-certificates curl >/dev/null
# Zola, pinned by its checksum.
curl -fsSL -o /tmp/zola.tgz https://github.com/getzola/zola/releases/download/v0.22.0/zola-v0.22.0-x86_64-unknown-linux-gnu.tar.gz
echo "f1d491f8956b94384c27d75cb6b2bf60d3916d1ade9564bcbfe7c03f0258aebf /tmp/zola.tgz" | sha256sum -c -
tar xzf /tmp/zola.tgz -C /usr/local/bin zola
zola --version
- name: Check out
run: |
find . -mindepth 1 -maxdepth 1 -exec rm -rf {} +
git config --global --add safe.directory '*'
git init -q .
git remote add origin "${{ github.server_url }}/${{ github.repository }}.git"
git fetch -q origin '+refs/heads/*:refs/remotes/origin/*' '+refs/pull/*/head:refs/remotes/pull/*'
git checkout -q --detach "${{ github.sha }}"
- name: Build the site
run: |
cd site
zola check --skip-external-links
zola build --output-dir /tmp/site-out
- name: Check the pages
run: python3 site/tools/check_site.py /tmp/site-out
+3
View File
@@ -9,3 +9,6 @@
.dummy/
managed_components/
sdkconfig.*
# The built site (site/config.toml sends it here)
/public/
+8 -1
View File
@@ -128,6 +128,10 @@ The Notification raised once per boot when the SD card passes 80% full. It point
**Storage Clean-up**:
The screen where the user deletes old Logs and Captures by category and age, with a preview of the space freed. Notes are never offered for deletion. It lives in the Storage App, under Maintenance.
**Note**:
A plain text file in `/notes`, written on the device in the Notes App. Listed by its first line. Saved without being asked; never offered by Storage Clean-up.
_Avoid_: memo, document
**Storage App**:
The App that browses the SD card: folders and files, a clipboard for one item at a time (copy, cut, paste), rename, delete, new folder, and a viewer for each kind of file the firmware writes. The top-level folders, `/gemini/cache` and files being written are read-only.
_Avoid_: file manager, Files, explorer
@@ -137,7 +141,10 @@ The part of the Storage App that deletes in bulk: the card's usage, Storage Clea
_Avoid_: Settings > Storage
**Firmware Update**:
Installing a new firmware image without a USB cable: pushed over Wi-Fi from the developer's PC, or read from the SD card.
Installing a new firmware image without a USB cable: pushed over Wi-Fi from the developer's PC, read from the SD card, or downloaded from the project's Gitea **Release**.
**Release**:
A tag `v*` on the project's Gitea with a signed **Update File**, a factory image for USB, the ELF to decode crashes and checksums, built and published by CI. The device reads them to look for updates. Debug Builds aren't published.
_Avoid_: flash, upgrade (alone)
**Update File**:
+49 -2
View File
@@ -1,5 +1,7 @@
# roro9stack
[![CI](https://git.twis.la/twisla/roro9stack/actions/workflows/ci.yml/badge.svg?branch=main)](https://git.twis.la/twisla/roro9stack/actions?workflow=ci.yml) [![Coverage of lib/ by the host tests](https://git.twis.la/twisla/roro9stack/raw/branch/badges/coverage.svg)](#build-and-test-local-ci) [![Latest release](https://git.twis.la/twisla/roro9stack/raw/branch/badges/release.svg)](https://git.twis.la/twisla/roro9stack/releases/latest)
A multi-app firmware for the **M5Stack Cardputer ADV** with the **Cap LoRa-1262**. It's a Meshtastic-compatible mesh messenger, plus Wi-Fi tools, IRC, GNSS and more. Licensed GPL-3.0.
- Domain language: [CONTEXT.md](CONTEXT.md)
@@ -18,8 +20,27 @@ scripts/ci.sh
This runs the host-side unit tests (`test/`, `native` environment), then builds the firmware. The output is `.pio/build/cardputer-adv/firmware.factory.bin`.
`scripts/coverage.sh` runs the same tests with coverage counters and writes a line-by-line report to `.pio/coverage/index.html`. The badge above is its figure for `main`: the share of the lines of `lib/` that the host tests run. `lib/` is the logic that compiles on a PC; `lib/SD` (the card's driver) and `src/` (the Apps, the Services, everything that needs the device) have no host tests and aren't in that figure.
The framework is rebuilt with the TLS settings in `platformio.ini` (`custom_sdkconfig`, ADR 0006), so the first build after a fresh checkout takes about 4 minutes; later builds take under a minute.
## CI and releases
Gitea Actions (`.gitea/workflows/ci.yml`, docs/milestones/R1.md) runs the host tests on every push to `main`, and on a pull request also builds the release firmware and the Debug Build: changes reach `main` through pull requests. Pushing a tag `v*` runs all of it and publishes a release on Gitea with:
- `roro9stack-<version>.ota`, the signed Update File;
- `roro9stack-<version>-factory.bin`, the whole flash image for a first install over USB;
- `roro9stack-<version>.elf.gz`, to decode crash reports from that build;
- `SHA256SUMS`.
CI signs with the project's key, held as a repository secret (ADR 0008). Debug Builds are built but never published: each carries its builder's Debug Console token.
`scripts/ota_verify.py <file.ota>` checks an Update File on a PC the way a device does. `scripts/release_build.sh` and `scripts/release_publish.py` are what the workflow runs; they work the same by hand.
## The website
The project's site, **roro9stack.net**, is built from `site/` with Zola (see `site/README.md`): the home page, an Install page that flashes a Cardputer from the browser, and every release. Changes under `site/`, `docs/`, `README.md` and `CONTEXT.md` run only the site's CI job, not the firmware tests and builds.
## Flash
1. Connect the Cardputer by USB-C.
@@ -52,7 +73,21 @@ The device shows the push address in **Settings → Firmware**. It installs a co
To install from the SD card instead, copy the `.ota` file from `.pio/build/cardputer-adv/` into `/updates` on the card, then use **Settings → Firmware**. With the Cardputer on USB, the card can stay in: `scripts/sd_put.sh <file.ota>` sends it over the serial console into `/updates` (about 30 s for 1.6 MB, checked with SHA-256 before it's renamed into place; `SD_PUT_DEBUG=1` shows the console while it runs).
**The private key** lives in `~/.config/roro9stack/ota-key.pem` and must never be committed. If it's lost, generate a new pair and flash once over USB.
**The private key** lives in `~/.config/roro9stack/ota-key.pem` and must never be committed. If it's lost, generate a new pair and flash once over USB. (CI signs releases with a copy kept as a repository secret, ADR 0008.)
### Updates from Gitea
With no PC and no card, the device can install the project's releases itself (docs/milestones/R1.md). In **Settings → Firmware**:
- **Latest release** checks the server (Enter, or `c`) 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's newer. The download goes straight into the inactive slot, so no card is needed; the signature is checked after the first 160 bytes, before anything is written, and the image's hash at the end. The new firmware then runs on Probation as for any update.
- **Older releases** lists the last ten, newest first. Opening an older one offers to go back to it, with a different question.
- **Settings → Check for updates** (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 doesn't announce a version that already failed and rolled back on this device.
The connection is checked against the two ISRG roots Let's Encrypt chains end in (ADR 0009), not the usual bundle of about 130 authorities. Whatever the connection, the Update File's own signature is what decides what gets installed.
**IRC steps aside.** A secure connection takes about 52 KB of memory at its peak, and IRC's own takes 40 KB of the 107 KB there is. A check or an install 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 isn't, so while IRC stays connected for days it doesn't run, and **Latest release** is the way to check.
**A Debug Build** shows the latest release but doesn't install it: releases have no Debug Console (they aren't built with one, so that nobody's console token is published), and installing one would take it away. A Debug Build is updated from the PC with `scripts/flash.sh --debug --ota`.
## Networks without DHCP
@@ -99,7 +134,7 @@ A copy runs in the background of the card (about 400 KB a second) in short turns
Enter on a file opens it by type; Tab switches to the same file as a hex dump or as text:
- **Text** (`.txt`, `.log`, `.gmi`, `.csv`, and anything that looks like text): only the screen's worth is read from the card, so a file of any size opens at once. Logs open at the end. Up and Down move a line, Left and Right a page, `t` and `b` go to the top and the end.
- **Text** (`.txt`, `.log`, `.gmi`, `.csv`, and anything that looks like text): only the screen's worth is read from the card, so a file of any size opens at once. Logs open at the end. Up and Down move a line, Left and Right a page, `t` and `b` go to the top and the end, `e` edits it (up to 16 KB, see Notes).
- **Captures** (`.pcap`): the packets as the LoRa Scanner lists them; Enter shows one with its Meshtastic header and bytes.
- **Tracks** (`.gpx`): the number of points, the start, the duration and the distance.
- **Update Files** (`.ota`): the version, and whether the file would install: it's checked as an install checks it (signature and contents) without writing anything. Enter then installs it.
@@ -107,6 +142,16 @@ Enter on a file opens it by type; Tab switches to the same file as a hex dump or
At the top of the card the last row, **Maintenance** (also `m`), holds the card's usage, Storage Clean-up and "Erase SD card", behind a warning: those delete for good. It replaces Settings > Storage.
## Notes
The Notes App (docs/milestones/F1.md) keeps plain text notes in `/notes` on the SD card. The list shows each note's first line and its date, newest first; `s` switches to by file name. `n` starts a note, Enter opens one, `r` renames its file, `d` deletes it after asking.
In the editor, type. Enter starts a line, Del deletes backwards, Fn with the arrows moves the cursor through the wrapped text, Ctrl+A and Ctrl+E go to the start and the end of the line, Tab types two spaces, and the Compose Key gives accents as everywhere. **There's no save key:** the note is written five seconds after the last key, on Back, on leaving the App, when the screen turns off and before the device powers off. The top line says "typing" or "saved". Each save writes a temporary file and then puts it in the note's place, so a power cut costs a few seconds of typing and never the note; if a save was cut short, opening the note offers its copy back.
A new note has no file until something is typed; its file is then named after its first line (`shopping-list.txt`), or `note-<date>-<time>.txt`.
A note holds up to 16 KB while it's edited. A bigger text file opens read-only in the Storage App (editing any size is issue #47). The Storage App's text viewer has `e` to edit a file with the same editor, anywhere on the card, unless the file is read-only.
## Development aids
`scripts/serial_log.sh [seconds] [command…]` records the serial output, and can send commands to the firmware first. For example, `scripts/serial_log.sh 30 short sleep:12 burst` sets short screen timeouts, waits 12 s, then sends a burst of Toasts.
@@ -140,6 +185,8 @@ At the top of the card the last row, **Maintenance** (also `m`), holds the card'
| `ls [folder]` / `du <path>` | Lists a folder of the SD card with sizes and dates, or counts the files and bytes under a path |
| `cp [-f] <from> <to>` / `mv [-f] <from> <to>` / `rm <path>` / `mkdir <path>` / `cancel` | What the Storage App does, with its rules: copy (folders too), move or rename, delete (a folder with what's in it), new folder. `-f` replaces a file that's in the way; a tab separates paths that hold spaces; `cancel` stops a copy or a delete |
| `install <path>` | Update from SD with that `.ota` file, as Settings → Firmware does |
| `update check` / `update list` / `update status` / `update install <tag>` | The project's releases on Gitea: look at the latest, list the last ten, say what's known, or download and install one (not on a Debug Build) |
| `update pretend <version>` / `update probe <host>` / `update damage cut\|flip <n>` / `update daily` | Debug Builds: pretend to run another version (so a release counts as an update), see whether a server's certificate is accepted, cut or damage the next download, run the daily check again |
| `lora probe` | Finds the radio: chip, oscillator, antenna switch, DIO1 interrupt, noise floor |
| `lora status` | Radio settings, who's listening, packet and error counters, noise floor, task stack |
| `lora rx on` / `lora rx off` | Listens and prints each packet on the console |
+1 -1
View File
@@ -5,7 +5,7 @@ RUN apt-get update \
&& apt-get install -y --no-install-recommends git build-essential \
&& rm -rf /var/lib/apt/lists/*
RUN pip install --no-cache-dir platformio
RUN pip install --no-cache-dir platformio gcovr
# Toolchains and libraries are cached in a named volume mounted here.
RUN mkdir -p /pio && chmod 777 /pio
+17
View File
@@ -0,0 +1,17 @@
# CI signs releases with the project's key
A tag `v*` is built, signed and published by Gitea Actions with nobody at a keyboard. The signing key of ADR 0003 is therefore held twice: in `~/.config/roro9stack/ota-key.pem` on the development machine, as before, and as the repository secret `OTA_SIGNING_KEY`, which the release step writes to a file for as long as it runs.
We chose this over signing by hand after CI has built (a command per release, the key in one place), and over a second key for CI that the firmware would also trust. A release that needs a manual step isn't made on the day it's ready, and issue #6, the device installing releases by itself, needs releases that are always there and always signed.
## What it costs
- **Whoever can run a workflow in this repository can sign firmware every device accepts.** That means: anyone who can push to it, the runner's host and whoever administers it, and the Gitea instance with its database, where the secret is stored. Before, it took the development machine.
- The runner executes jobs **on its own host**, not in a container, as a user who can use Docker. A workflow is not confined.
- Pull requests from forks must never run with this secret. Gitea doesn't pass secrets to them; the workflow also only runs on pushes and by hand.
## What limits it
- The release step checks the signed file against the public key in the sources it built (`scripts/ota_verify.py`): a wrong or replaced secret stops the release instead of publishing a file no device takes.
- ADR 0003's way out stays: a firmware release can carry a new public key. If the secret is ever in doubt, make a new pair, ship it in a release signed with the old key, and replace the secret.
- A device still only installs what it's told to (until #6), keeps a new image on Probation, and rolls back one that doesn't hold.
@@ -0,0 +1,22 @@
# The device trusts the two ISRG roots for what it fetches
The firmware talks to the project's Gitea over HTTPS (issue #6, and #4 after it). A TLS client has to decide whose certificates it believes. Three ways were possible:
- **The framework's bundle**, about 130 certificate authorities (about 60 KB of flash). Any of them could vouch for `git.twis.la`.
- **Pin the server's certificate**, as the Gemini App does for capsules. The server's certificate is replaced every few months, so a pin would ask the question again at every renewal.
- **Carry the roots the server's chain ends in:** `ISRG Root X1` (RSA 4096) and `ISRG Root X2` (ECDSA P-384), the Let's Encrypt roots, about 2.7 KB of flash (`src/platform/ca_roots.h`).
We chose the third. The chain and the name are checked by mbedTLS during the handshake. It trusts one organisation's two roots, valid until 2035 and 2040, and a renewal changes nothing.
## What it costs
- **If the server moves to another CA, the device can no longer reach it**, and the next firmware, carrying that CA's root, has to come from the PC or the SD card. Both still work; they don't use TLS.
- The roots are public data checked against the published fingerprints (listed in the file), refreshed by hand if Let's Encrypt ever changes them.
## What it doesn't change
The Update File's own signature (ADR 0003) is what decides what gets installed. A hijacked connection could hide a release, or serve an older signed one, but never make the device install firmware that isn't ours. The TLS check matters more for #4, where a token will travel over it.
## Measured while building it
A TLS connection to this server peaks at about 52 KB of heap, **the same whether the certificate is checked or not**, so skipping the check would have saved nothing. The cost is the connection itself (record buffers and handshake), not the trust decision.
+74 -1
View File
@@ -1,6 +1,6 @@
# F1 — Files and Notes
**Status:** in progress. The Storage App (issue #3) shipped as **v0.9.0** on 2026-10-06. Notes (#19) and the card as a USB drive (#1) come after.
**Status:** in progress. The Storage App (issue #3) shipped as **v0.9.0** on 2026-10-06. Notes (#19) shipped as **v0.10.0** the same day. The card as a USB drive (#1) comes after.
**Goal:** get at what's on the SD card from the device itself: browse it, look inside the files the firmware writes, copy, move, rename and delete, and keep notes. A side milestone, like G1 and S1; Files and Notes were M3's original second half (Q30, Q89).
@@ -86,3 +86,76 @@ All in a scratch folder, `/f1test`, removed afterwards.
**One slip during the checks:** a scripted key sequence ran in the wrong folder and renamed `/gemini/saved` to `saved2`, then copied it to the top of the card. Both were put right at once (renamed back, the copy deleted; 7 files, 53,798 bytes, as before).
**Found on the way:** a panic at Wi-Fi join, there since v0.7.0 (SNTP started twice, issue #46). Fixed in v0.9.0.
## Notes (issue #19)
Plain text notes on the SD card, written on the device. Q30 settled the base: `.txt` files in `/notes`, created, edited and deleted from the device, never offered by Storage Clean-up.
### Decisions (design round 2026-10-06)
| # | Decision |
|---|---|
| Q141 | A **Notes** App in the Launcher. One row per note: its first line as the title, then the date. Newest first; `s` switches to by name. `n` new, Enter opens, `d` deletes after a confirmation, `r` renames the file. |
| Q142 | A new note's file name is never typed: it comes from the first line when the note is first saved (`shopping-list.txt`), or `note-20261006-0919.txt` if that line is empty. It doesn't change afterwards unless the note is renamed. |
| Q143 | **Autosave, no "discard changes?" prompt:** five seconds after the last key, on leaving the note or the App, and when the screen turns off. A save writes a temporary file and renames it over the note, so a power cut loses the last few seconds at most. A temporary file left behind is offered back at the next open. |
| Q144 | The whole note is in memory while it's edited, up to **16 KB**. A bigger text file opens read-only in the Storage App's viewer. The App refuses to open below the memory floors (Q86). **Editing files of any size must come in a later release: issue #47.** |
| Q145 | The editor wraps at spaces, 38 columns by 8 rows, with a line for the name and the state. Enter is a new line, Del deletes backwards, Fn+arrows move (the Text Entry rule), Ctrl+A and Ctrl+E go to the start and the end of the line, Tab types two spaces, Back saves and returns. The Compose Key works as elsewhere. |
| Q146 | The Storage App's text viewer gets `e`: edit this file with the same editor, for a text file up to 16 KB that isn't read-only. That lifts Q135 without Apps opening each other (#43 stays). |
| Q147 | The list is flat: the files directly in `/notes`. Sub-folders are reached through the Storage App. |
| Q148 | UTF-8, LF line ends; a file with CRLF is saved back with LF. Characters the font lacks are kept on save. |
| Q149 | Left out, each with its issue: editing files of any size (#47), searching inside notes (#48), undo (#49), selecting and copying text (#50). |
| Q150 | Ships as **v0.10.0** when built and checked on the device. |
### Done when
- A note can be started, typed with accents, left and found again in the list under its first line; renamed; deleted after a confirmation.
- What's typed is on the card five seconds after the last key, and after Back, Home, or the screen turning off, without a prompt.
- Pulling the power while typing loses a few seconds at most, and the note is never left empty or half-written.
- The cursor moves by character and by line through wrapped text, and the screen follows it; a 16 KB note edits without lag.
- A note at 16 KB refuses more text and says so; a bigger file opens read-only.
- `e` in the Storage App's text viewer edits a file; a read-only one is refused with its reason.
- Free heap stays above the floors with a 16 KB note open and IRC connected.
### Work breakdown
1. **Model** (host-tested): the text buffer with its cursor, wrapping and scrolling; file names from first lines.
2. **The editor on the device:** loading, drawing, keys, autosave through a temporary file, recovery.
3. **The Notes App:** the list with titles, new, rename, delete.
4. **`e` in the Storage App.**
5. **Checks on the device**, recorded here.
### As built
- **`NoteText`** (`lib/notes`, host-tested) is the text, its cursor and the screen around it. A line owns the space or the newline it ends with, so every byte is on exactly one line and the cursor has one place for each. **No index of lines is kept:** a note of newlines alone would need twice its own size for one. Where a line starts is worked out from the start of its paragraph.
- **One buffer, 16 KB, for as long as the editor is open.** It's reserved when the note is opened, the file is read straight into it, and typing never makes it grow. On this device a failed allocation is an abort, and with IRC connected the largest free block is about 31 KB whatever the total says: the first version read the file into one string and copied it into another, and opening a full note with IRC connected restarted the device. The editor now also refuses to open without a free block of 24 KB.
- **`NoteEditor`** (`src/apps/note_editor`) is shared by the Notes App and the Storage App's `e`. A save runs on the storage task while the main loop waits for it: no second copy of the note, and at 16 KB the wait is a fraction of a second at a moment when nobody has typed for five.
- **A save** writes `<note>.tmp`, checks its size, deletes the note and renames the temporary file (FAT can't rename onto a file). A cut between the last two steps leaves only the `.tmp`: the Notes list puts such a file back under its name. A `.tmp` next to its note is an unfinished save: opening the note offers it.
- **Titles** in the list are read from the card for the eight rows on screen, when the list moves.
- **Before powering off**, the firmware now leaves the foreground App (`PowerService::beforePowerOff`), which makes the editor save.
- Shift or Alt with Fn+Up and Fn+Down moves a page (not in Q145).
### Found on the way
- **The screen could go "off" for one tick after a key sent through the Debug Console**, and the next key was then swallowed as a wake-up: the `key` command stamps the power timer from `millis()`, the power tick compares with its pass's older time, and the unsigned difference read as 49 days idle. The same shape as #46. Fixed in `PowerPolicy::update` with a test. Keys from the keyboard were never affected. It explains remote keys "lost" in earlier sessions.
- **`scripts/rdbg.py` held back piped lines** written while it was still connecting, until the next line came (a buffered `readline()` behind `select()`). Fixed.
### Checks on the device (2026-10-06, Debug Build of branch `notes`)
Test notes were made in `/notes` and removed afterwards; the folder is left, empty.
| Check | Result |
|---|---|
| Host tests | 439 pass |
| A first note | "No notes yet", `n`, typed three lines: the top line says "typing", then "saved" five seconds after the last key, under `shopping-list.txt`. 63 keys in a row all arrived |
| Leaving | Back saves and returns to the list, which shows the note under its first line. Home in the middle of a new note saved it as `ideas.txt` |
| The cursor | Down, Right, an insertion in the middle of a line; the screen scrolls through a note of about 230 lines |
| A power cut | Typed, waited seven seconds, typed more and restarted the device at once (`reset`): the note has what was saved, whole, and not the last keys |
| An unfinished save | A `.tmp` next to its note: "Unsaved copy... Keep the note / Use the copy"; using it brings its text back and saves it. A `.tmp` alone was put back under its name when the list opened |
| 16 KB | A note of exactly 16,384 bytes opens and scrolls; one more character: "This note is full: 16 KB". A file of 16,398 bytes: "Too big to edit: 16 KB at most" |
| Rename, delete, sort | `r` renamed `orphan.txt` to `orphan2.txt`; `d` asked, then deleted; `s` switched between newest first and by file name |
| `e` in the Storage App | A note opened from the text viewer, edited, saved on Back; the listing shows its new size |
| Memory | IRC connected, the full 16 KB note open: 55 KB free, largest block 31.7 KB (72 KB free before opening) |
**Not checked:** accents through the Compose Key and Ctrl+A / Ctrl+E (the remote `key` command can't send them; the model's tests cover both), the power button's save (it needs a hand on the device), a missing card, and how typing feels on the keyboard itself.
**One slip during the checks:** a key sequence sent right after a restart opened IRC instead of Notes, and the test letters went into IRC's input line. Nothing was sent: the line was cleared and the App left. IRC connected to Libera as it does when opened.
+125
View File
@@ -0,0 +1,125 @@
# R1 — Releases
**Status:** in progress. CI and signed releases on Gitea (issue #5) are in place since 2026-10-06: every tag from v0.1.0 to v0.10.0 has its release. Updates from Gitea (issue #6) is built and checked on the device, on branch `gitea-updates`, not merged yet. The Issues App (#4) comes after.
**Goal:** a tag is a release, built the same way every time and published where a device can find it.
## CI and releases (issue #5)
Until now the tests, the builds, the signing and the flashing all happened on one machine, through `scripts/ci.sh` and `scripts/flash.sh`. Nothing was published.
### Decisions (design round 2026-10-06)
| # | Decision |
|---|---|
| Q151 | A push to `main`: the host tests (with their coverage). A push to another branch: nothing, its pull request is what runs (a branch with an open pull request ran twice, once for each). A pull request: the same and both builds; changes reach `main` through pull requests. A tag `v*`: all of it, then a release. (First: everything on every push, which rebuilt the firmware far more often than anyone looked at it.) |
| Q152 | **CI signs.** The signing key is the repository secret `OTA_SIGNING_KEY`; a tag push makes a complete, signed release with no manual step (ADR 0008). |
| Q153 | The Debug Build is built in CI with a token of the runner's own, to prove it compiles, and **isn't published**: it would hand everyone its Debug Console token. |
| Q154 | Pull requests from forks don't start a run. |
| Q155 | A release carries `roro9stack-<version>.ota` (signed), `-factory.bin` for USB, `.elf.gz` to decode crashes, and `SHA256SUMS`. |
| Q156 | Its text is the tag's message, what the files are, and the commits since the tag before. |
| Q157 | No cache service to begin with: measure first. |
| Q158 | Reproducible builds aren't needed for signing any more (Q152); not pursued here. |
| Q159 | **The tags from before CI get their releases too**, v0.1.0 to v0.10.0, built from each tag's own sources by running the workflow by hand. |
| Q160 | Actions is switched on for the repository. |
| Q161 | **Changes reach `main` through pull requests, merged as "rebase, then a merge commit"**, the only style the repository allows: the branch's commits keep their messages, the merge commit marks the pull request, and what CI tested is what lands. No squash, no fast-forward. |
### As built
- **One workflow, `.gitea/workflows/ci.yml`, one job**, on the runner `runner0` (label `ubuntu`). The job asks for a `python:3.12-slim` container, installs git, a compiler, openssl and PlatformIO, and runs the same scripts as a developer's machine. No Docker inside the job.
- **The cache is a Docker volume**, `roro9stack-pio`, mounted at `/pio`; the runner's `config.yaml` allows it under `container.valid_volumes`. A first run downloads about 1 GB and rebuilds the framework. Measured from the jobs' own start and end times: the first full run on an empty cache took 11.4 minutes (tests and both builds); the first run in a container, 8.1; a pull request now takes about 8.7 (tests, coverage and both builds), a release build alone 5.5, and a push to `main` (tests and coverage) 1.1. (An earlier version of this note said 17 minutes: that was the waiting time, not the job's.)
- **No JavaScript actions**, so the image needs no Node and nothing is fetched from GitHub: the checkout is four git commands.
- **`scripts/_docker.sh`** runs the command in place when `RORO_NO_DOCKER` is set (a CI job is already in a build container), and in the project's image otherwise. The Debug Build's token is made on the spot in CI and goes with the container.
- **`scripts/release_build.sh <checkout> <out>`** builds a tag's own sources with today's tools, signs, verifies against the public key in those sources, and writes the files and the release's text. **`scripts/release_publish.py`** creates the Gitea release or completes it; run twice, it replaces what's there. Both run the same on a developer's machine.
- **`scripts/ota_verify.py`** checks an Update File as a device does, on a PC.
- **The job's own token** (`secrets.GITEA_TOKEN`) is enough to create a release and upload its files.
- **Old tags.** v0.1.0 to v0.3.0 are from before the framework was rebuilt with our settings (ADR 0006) and can't link against a rebuilt one left in the cache: the release build puts the stock framework libraries back for them. v0.1.0 to v0.2.1 have no public key in their sources (Firmware Updates came with v0.3.0); their files are checked against today's.
### How it went
- **The runner's label took three tries.** Registered as `ubuntu://docker:ubuntu:resolute` and then as `ubuntu::docker://...`, Gitea took the whole string for the label's name; with the first, jobs ran on the runner's host itself. The first version of the workflow was written for that (plain shell, `docker run` for the build) and published v0.10.0 that way. `ubuntu:docker://docker.gitea.com/runner-images:ubuntu-latest` is the form that works.
- **Gitea 1.27's API can't cancel a run that isn't finished**, only delete a finished one; switching Actions off and on for the repository doesn't either. Runs queued for a label that no longer exists stay queued until cancelled in the web UI.
- **CI's image isn't byte-identical to a local build of the same tag** (same size, different bytes). Not pursued (Q158).
## Updates from Gitea (issue #6)
The device looks at the project's Gitea for a newer release, says so, and installs it on request, with the same signed Update Files, Probation and rollback as a push from the PC or an install from the card.
### What the server gives (checked 2026-10-06)
- **Its certificate** is Let's Encrypt, all ECDSA: leaf `git.twis.la` (renewed every few months, next expiry 2026-12-14) under the intermediate YE2, Root YE and ISRG Root X2, which X1 cross-signs. Pinning the leaf would ask a question at every renewal.
- **The API** answers over HTTP/1.1, chunked: `releases/latest` is 3.2 KB (about 350 bytes of it matter), a list of ten releases is 33 KB.
- **A download** is a direct 200 with `Content-Length` and no redirect; ranges work.
### Decisions (design round 2026-10-06)
| # | Decision |
|---|---|
| Q162 | **Trust:** the firmware carries ISRG Root X1 and X2 and checks the server's chain and name against them, not the framework's bundle of about 130 CAs (ADR 0009). Shared with #4. If the server moves to another CA, the next firmware comes from the PC. |
| Q163 | The Update File's own signature stays the real guard. A hijacked connection could hide a release or offer an older signed one, never install firmware that isn't ours. |
| Q164 | The source, `git.twis.la` and `twisla/roro9stack`, is a constant in the firmware. A fork changes it, and has its own key. |
| Q165 | **When:** on request in Settings > Firmware, and once a day in the background while Wi-Fi is up and the Clock is set (certificate dates need it). A setting, **Check for updates**, on by default. It installs nothing by itself; it skips quietly below the memory floor and never runs during an install. |
| Q166 | A Toast, "Update v0.11.0 available: see Settings > Firmware", once per version per boot. |
| Q167 | **The download goes straight into the inactive slot,** no card needed. A truncated or tampered file is refused after 160 bytes or at its end, and the running firmware is untouched. A failed download starts over. |
| Q168 | A version that failed (rolled back) isn't announced again by the background check until a newer one exists; it can still be installed by hand. |
| Q169 | **Older releases:** a list of the last ten, newest first, the running one marked. Installing an older one asks with a stronger warning. |
| Q170 | Enter on a release shows its version, date, size and the tag message, with Install. |
| Q171 | **Debug Builds** check and show the latest release, but don't install it: it would replace the Debug Build and its console (Q153: Debug Builds aren't published). Their updates come from the PC. |
| Q172 | **Memory, as measured:** a TLS connection peaks at about 52 KB of heap, with or without checking the certificate, so it starts with 80 KB free (Q86's 20 KB spare on top), not 55 KB. **A check, list or install someone asked for makes IRC step aside** and come back after; the daily check never does, and with IRC connected it waits. (First: 55 KB and nothing else. With IRC connected a check left 3 KB and a download 836 bytes.) |
| Q173 | Left out, each with its issue: installing automatically (#52), a release channel (#53), resuming a download (#54). |
| Q174 | Ships as **v0.11.0**. Tested on the device with the real signed releases; a Debug Build command pretends the device runs an older version, so v0.10.0 counts as an update. |
### Done when
- A check, by hand or daily, tells the right thing: up to date, newer available, no network, bad certificate, no clock, too little memory.
- A newer release installs from the Firmware page with no card and no PC, and the device restarts into it and confirms it.
- A tampered or truncated download is refused and the running firmware keeps running.
- The Older releases list shows ten, and installing one asks first.
- A release that rolled back isn't announced again.
- A Debug Build shows the latest release and doesn't install it.
- The daily check never runs below the memory floor, during an install, or without a clock.
### Work breakdown
1. **Model** (host-tested): a streaming JSON scanner, the release list read from it, HTTP response heads and chunked bodies, URLs, which release counts as an update.
2. **The connection:** the root certificates, an HTTPS client, a check and a list from the Update Service's task; console commands to try them.
3. **The download:** an HTTPS source for the existing install path.
4. **The screens:** the Firmware page's release rows, the release page, Older releases, the setting, the daily check and its Toast.
5. **Checks on the device**, recorded here.
### As built
- **`lib/release`** (host-tested): a streaming JSON scanner, the release reader built on it, HTTP heads and chunked bodies, URLs, and the decisions (which release is an update, whether to announce it, which download URLs are taken). A list of ten releases is 33 KB of JSON and costs a few hundred bytes of memory, because nothing is kept but the path.
- **`HttpsGet`** (`src/platform`): one GET, the answer read as a stream, redirects not followed. **`GiteaReleases`** keeps the latest and the list. **The Update Service** serves the requests on its own task (about 5.4 KB of its 7 KB stack at the peak) and installs through the install path that already existed, with an HTTPS source in place of the card or the TCP port.
- **The daily check** is scheduled from the Update Service's tick: Wi-Fi up, the Clock set, no Probation, nothing else going on, memory for a connection. The day it last succeeded is kept in flash.
- **A version that failed** (rolled back) is remembered as `ota_failed`, and isn't announced again by the daily check.
- **The screens:** the Firmware page's Latest release and Older releases rows, a release page with the tag's message, and the install dialog.
- **Debug Builds** get knobs to try what can't be tried otherwise: `update pretend`, `probe`, `damage` and `daily`.
- **The first message,** `... available: see Settings > Firmware`, was cut at 48 bytes by the notification's own limit; it now reads `v0.11.0 is out: see Settings > Firmware`.
### Checks on the device (2026-10-06, Debug Builds of branch `gitea-updates`)
| Check | Result |
|---|---|
| Host tests | 456 pass |
| Check and list against the live server | The certificate is accepted against the two embedded roots; `releases/latest` read; a list of ten (33 KB) streamed |
| Servers that must be refused | github.com, example.com, expired.badssl.com, self-signed.badssl.com, wrong.host.badssl.com, untrusted-root.badssl.com and the router: each "isn't accepted" or a TLS error |
| A download cut short at 800,000 bytes | Refused, "update file too short"; the running firmware untouched |
| One byte flipped in the signature | Refused after 160 bytes, "bad signature"; the image isn't read further |
| One byte flipped in the image | Downloaded in full, refused at its end, "image corrupted (hash mismatch)" |
| The real v0.10.0, from the console and then from the screen | Downloaded, restarted, confirmed on Probation: the slot table read `v0.10.0, valid` both times. The Debug Build was pushed back from the PC after each |
| The screens | Latest release (checking, then `(current)` or `(new)`), the release page with the tag's message, Older releases with ten rows, the install dialog (Cancel by default, Back cancels), the progress screen at 28% |
| IRC connected, before the hold | A check left 3 KB of heap; a full download, 836 bytes |
| IRC connected, with the hold | The lowest free heap during a full download: 38 KB. IRC reconnected afterwards (its counters kept growing) |
| The daily check | It ran by itself, announced `v0.10.0 is out: see Settings > Firmware` once; with IRC connected (68 KB free) it didn't run |
| Speed | 1.9 MB in about 46 s, 40 KB/s, over the guest Wi-Fi at -65 dBm; not investigated further |
**Not checked:** the certificate's **name** on its own. Connecting by IP makes the server end the handshake before it shows its certificate, so that test proved nothing; the library sets the name it verifies, and OpenSSL on the PC refused the wrong name against the same chain. A failed daily check retrying, the clock not being set, the release that failed before not being announced (host-tested, not on the device), and the hold when IRC isn't connected but Gemini holds memory.
**Limits worth knowing:**
- **With IRC connected for days, the daily check doesn't run.** It would have to take IRC down to make room. Opening Latest release does.
- **A server that changes CA can't be reached** until a firmware carrying the new root comes from the PC (ADR 0009).
- **No resuming:** a broken download starts over (#54).
- **A key press during the hold:** Back on the Firmware page while a check is going doesn't cancel it.
**Two slips during the checks:** a blind sequence of keys on the Firmware page opened the SD card's install dialog (the page keeps its selection between visits); it was cancelled with Back, nothing installed. And my port-polling while waiting for a restart took the Debug Console's only client slot, which made the first install attempt look like a failure.
+94
View File
@@ -0,0 +1,94 @@
# W1: Website
**Status:** phase 1 is built and checked in a browser (branch `site`, pull request to follow); the Install page works against the real server once Caddy allows the origin (below). Issue #12.
**Goal:** a public home for the project at **roro9stack.net**, separate from the blog (stories) and from Gitea (developers): what it is, how to install it, how to use each App, and the docs.
The home page was designed on a canvas in a Claude chat (a dark and a light theme, built on the device's own 256-colour palette, pixel-notched corners, DM Mono and Hanken Grotesk). It is the starting point, not the final copy: it has to say only what the firmware does today.
## What was found while planning (2026-10-06)
- `roro9stack.net` already points at the server that hosts Gitea. Plain HTTP redirects to HTTPS; HTTPS has no certificate yet, which is the server's side to set up.
- **Release downloads from Gitea carry no CORS header,** so a browser can't fetch the factory image from another origin as things are. Gitea is behind Caddy, which can add the header (below).
- Zola can read JSON from a URL at build time (`load_data`), so the home page's "latest version" can come from the Gitea API.
- There is no Gitea wiki: the design's "Wiki" links would 404.
- The blog is published by pulling its repository on the web server and running `zola build`. The site does the same.
## Decisions (design round 2026-10-06)
| # | Decision |
|---|---|
| Q175 | The site lives in this repository, in `site/`, so the documentation is built from `docs/`, `CONTEXT.md` and the README instead of being copied. |
| Q176 | **Zola,** like the blog. The design becomes a template, its tokens CSS custom properties. Dark and light follow the visitor's setting, with a visible switch. No JavaScript except the flasher's. |
| Q177 | Domain: **roro9stack.net.** The blog stays at experiments.twis.la. |
| Q178 | **Publishing is the blog's way:** the web server pulls `main` and runs `zola build`; that part is the maintainer's. Changes reach `main` through pull requests as everywhere. **CI is split:** a dedicated `site` job builds the site (`zola build`) when `site/`, `docs/`, `README.md` or `CONTEXT.md` change, and the firmware tests and builds skip a change that touches nothing else. A change that touches both runs both. |
| Q179 | Phases, each its own pull request: **1.** the CI split, the home page, an Install page with the browser flasher, downloads and the changelog. **2.** a user guide page per App. **3.** how-tos and the FAQ. **4.** developer docs generated from the repository. |
| Q180 | **A browser flasher** (ESP Web Tools), **without copying the firmware.** Caddy, in front of Gitea, adds `Access-Control-Allow-Origin: https://roro9stack.net` (and `Vary: Origin`) to GET and HEAD on `/twisla/roro9stack/releases/download/*` and `/api/v1/repos/twisla/roro9stack/releases*`: both are public already. The Install page asks the API for the latest release in the browser, finds the asset ending `-factory.bin`, and gives ESP Web Tools a manifest built on the spot, so it offers a new release as soon as it exists, with no rebuild. The library is **vendored** into `site/static/` (Apache-2.0), not loaded from a CDN. The file's SHA-256 is shown on the page. Chrome or Edge on a desktop only; other browsers, and visitors without JavaScript, get the `esptool` steps on the same page. |
| Q181 | Docs for the latest version only. The changelog is the Gitea releases, read at build time. |
| Q182 | English only. |
| Q183 | The FAQ starts from real questions: the README, and issues labelled `kind/docs`. |
| Q184 | Fonts are **self-hosted** (no request to a third party). The hero keeps the design's illustrations, labelled as illustrations, and a section of **real device screenshots** is added. |
| Q185 | **The site says only what the firmware does today.** Planned features are marked as planned, with their milestone. The mesh messenger is **planned**: the LoRa Scanner listens, nothing is sent. |
| Q186 | Left out, each with its issue: a Gemini capsule mirror (#57), French (#58), docs per version (#59), search (#60). |
| Q187 | The site has no version of its own. Contact is **contact@roro9stack.net,** and the issue tracker. |
## The design, reviewed
Kept as designed: the layout, the tokens, the nine App cards (their facts check out against the code: Probation 3 minutes, Safe Mode after 3 crashes, 60 seconds of typing before an update restarts the device).
Changed before it ships:
- **Install, not Download, is the first action.** Downloads are for developers; a visitor wants to try it.
- **A "what you need" strip:** Cardputer ADV, the Cap LoRa-1262 (only the radio needs it), a microSD card, Wi-Fi. And a plain status line: the version, and what isn't there yet.
- **The mesh card and the hero** no longer promise sending and reading mesh messages.
- **The latest version is read from the API,** not typed.
- **"Wiki" is replaced by Docs.** The updates section gains what v0.11.0 added: the device installs releases from the project's server itself.
- **An independence line:** not affiliated with or endorsed by M5Stack or Meshtastic.
- **No cookies, no analytics, no third-party requests,** said on the page (fonts self-hosted).
- **The keyboard focus ring** is invisible on the notched buttons: `clip-path` clips an outline. Another way to show focus is needed.
- **The wordmark SVGs** carry an embedded C2PA content-credentials block: stripped from the site's copies.
## Done when (phase 1)
- Pushing a change under `site/` runs the `site` job and not the firmware tests; a firmware change runs the firmware jobs and not the site's.
- The home page renders in both themes, at phone width, with the keyboard, and says nothing the firmware doesn't do.
- The latest version on the page is the latest release.
- The browser flasher installs the latest release on a Cardputer ADV from Chrome (tried by hand), the page shows the file's SHA-256, and the `esptool` steps are on the same page.
- A release published after the site was built is the one the Install page offers.
- The home and Downloads pages make no request to another origin, and the Install page only asks git.twis.la.
## Work breakdown
1. **CI split:** a `site` workflow, path filters on the firmware workflow.
2. **The skeleton:** `site/` with the tokens, fonts, base template and the theme switch.
3. **The home page,** from the design, with the changes above.
4. **Install and downloads:** the flasher with its manifest built in the page, the `esptool` steps, the changelog. Needs the Caddy headers on the Gitea host (the maintainer's side); the page is tested against them once they're in.
5. **Checks,** recorded here.
## As built (phase 1)
- **CI is split.** `ci.yml` (the firmware) has `paths-ignore: site/**, docs/**, README.md, CONTEXT.md` on pushes to `main` and on pull requests. `site.yml` runs `zola check` and `zola build` with a Zola pinned by its checksum, then `site/tools/check_site.py`, when those files change. Gitea's own source (v1.24, read, not run against the 1.27 server) shows that path filters count as matched for tag pushes, so a tag still releases. A change that touches both runs both.
- **The build output** goes to `public/` at the root of the repository, not into `site/`: `output_dir = "../public"` in `site/config.toml`, so `zola build` in `site/` and `zola --root site build` from the root agree, and git ignores `/public/`.
- **The site** is in `site/`: `config.toml`, templates (base, home, install, downloads, 404), `data/` for the App cards and the screenshots' captions, `static/` (stylesheet, theme switch, fonts, wordmark, icons, real screenshots, the vendored flasher). `site/README.md` says how to build it and what the server needs.
- **The home page** follows the design. Changed from it: the hero and the mesh card promise nothing that isn't built (the mesh messenger is a "planned" card), an Install button first, a status box, a "what you need" row, a section of real screenshots, the updates section says the device installs releases itself, an independence line and a statement about cookies and third-party requests in the footer, the latest version read from the Gitea API at build time, and the nav's Wiki replaced. The two hero drawings are generated by `site/tools/make_illustrations.py` (a port of the design's scripted shapes) as inline SVG.
- **The focus ring.** `clip-path` clips outlines, so a focused notched control drops its notches and shows square corners and its ring.
- **The Install page** asks the API for the latest release in the browser, builds the ESP Web Tools manifest as a blob, shows the version, size and SHA-256, and only ever hands the flasher a download from the project's own server for this repository. The flasher library (ESP Web Tools 10.4.0, Apache-2.0) is vendored, trimmed to the ESP32-S3. Fonts (DM Mono, Hanken Grotesk, SIL OFL) are self-hosted.
- **The Downloads page** lists the last 30 releases with their files, read at build time.
- **The wordmark SVGs** from the design carried an embedded C2PA content-credentials block; it is removed from the site's copies.
## Checks (2026-10-06)
| Check | Result |
|---|---|
| The Site workflow's own commands, in a clean container with the pinned Zola | `zola check` clean, build and page checks pass |
| `tools/check_site.py` | 4 pages, 0 problems: titles, descriptions, a language, every image with alt text, every local file referenced exists, nothing loaded from another origin |
| Browser tests (Chromium, 16 checks) | All pass: no request to another origin from the home, Downloads and 404 pages; no horizontal scroll at 1280 and 390 px; a visible focus ring on a notched button; the Install page reads the latest release, shows its version, size and SHA-256, builds a blob manifest naming an ESP32-S3 factory image at offset 0, and loads only git.twis.la; a download on another host is refused; the real server (no CORS header today) makes the page fall back to the esptool steps |
| The pages looked at | Home in dark and light, at desktop and phone width; Install; Downloads |
| `esptool` against the real v0.11.0 factory image | An ESP32-S3 image, bootloader at 0x0, partition table at 0x8000: flashing at offset 0 is right. The command's syntax was checked, not a flash |
**Not checked:**
- **Flashing a real Cardputer from Chrome.** It needs the device on a machine with a browser; the page's flasher logic is tested, the flashing itself isn't.
- **Caddy's headers** on the real server (not applied yet), and **HTTPS on roro9stack.net** (the name resolves, the certificate isn't there).
- **The CI split on a change that touches only `site/` or `docs/`.** This pull request touches both the workflows and the site, so it runs both; the first docs-only pull request will show it.
- Firefox and Safari rendering, screen readers, and a printed page.
- The unverified wording in the Install text is kept to what's known: nothing about how long flashing takes, or what the screen shows in download mode.
+3 -1
View File
@@ -23,7 +23,7 @@ const RowDef kRows[] = {
{Row::Gnss, Kind::Toggle, "GNSS"}, {Row::GnssQuiet, Kind::Toggle, "Pause GNSS for LoRa"},
{Row::Coordinates, Kind::Toggle, "Coordinates"},
{Row::ProbeMacs, Kind::Toggle, "Probe MACs"}, {Row::Wifi, Kind::Page, "Wi-Fi"},
{Row::Firmware, Kind::Page, "Firmware"},
{Row::CheckUpdates, Kind::Toggle, "Check for updates"}, {Row::Firmware, Kind::Page, "Firmware"},
{Row::About, Kind::Page, "About"},
};
@@ -82,6 +82,7 @@ std::string SettingsMenu::value(int i) const {
case Row::Sound: return settings_.getBool(Setting::Sound) ? "On" : "Off";
case Row::Gnss: return settings_.getBool(Setting::GnssEnabled) ? "On" : "Off";
case Row::GnssQuiet: return settings_.getBool(Setting::GnssQuietForLora) ? "On" : "Off";
case Row::CheckUpdates: return settings_.getBool(Setting::CheckUpdates) ? "Daily" : "Off";
case Row::Coordinates: return settings_.getBool(Setting::CoordinatesDms) ? "Deg min sec" : "Decimal";
case Row::ProbeMacs: return settings_.getBool(Setting::ProbeMacRaw) ? "Raw" : "Pseudonymised";
case Row::Wifi: return settings_.getBool(Setting::WifiEnabled) ? "On" : "Off";
@@ -128,6 +129,7 @@ void SettingsMenu::toggle(int i) {
if (row(i) == Row::Sound) settings_.setBool(Setting::Sound, !settings_.getBool(Setting::Sound));
if (row(i) == Row::Gnss) settings_.setBool(Setting::GnssEnabled, !settings_.getBool(Setting::GnssEnabled));
if (row(i) == Row::GnssQuiet) settings_.setBool(Setting::GnssQuietForLora, !settings_.getBool(Setting::GnssQuietForLora));
if (row(i) == Row::CheckUpdates) settings_.setBool(Setting::CheckUpdates, !settings_.getBool(Setting::CheckUpdates));
if (row(i) == Row::Coordinates) settings_.setBool(Setting::CoordinatesDms, !settings_.getBool(Setting::CoordinatesDms));
if (row(i) == Row::ProbeMacs) settings_.setBool(Setting::ProbeMacRaw, !settings_.getBool(Setting::ProbeMacRaw));
}
+1 -1
View File
@@ -11,7 +11,7 @@ namespace roro {
// values, choice lists and validation messages. Rendering and navigation live in the App.
class SettingsMenu {
public:
enum class Row { LongName, ShortName, Region, Timezone, Brightness, DimTimeout, OffTimeout, Sound, Gnss, GnssQuiet, Coordinates, ProbeMacs, Wifi, Firmware, About };
enum class Row { LongName, ShortName, Region, Timezone, Brightness, DimTimeout, OffTimeout, Sound, Gnss, GnssQuiet, Coordinates, ProbeMacs, Wifi, CheckUpdates, Firmware, About };
enum class Kind { Text, Choice, Toggle, Slider, Page };
explicit SettingsMenu(Settings& settings) : settings_(settings) {}
+329
View File
@@ -0,0 +1,329 @@
#include "note_text.h"
#include <algorithm>
namespace roro::notes {
namespace {
bool continuation(char c) { return (static_cast<uint8_t>(c) & 0xC0) == 0x80; }
} // namespace
NoteText::NoteText(int cols, int rows) : cols_(std::max(1, cols)), rows_(std::max(1, rows)) { text_.reserve(kMaxBytes); }
NoteText::NoteText(int cols, int rows, std::string&& text) : cols_(std::max(1, cols)), rows_(std::max(1, rows)), text_(std::move(text)) {
dropCarriageReturns();
if (text_.size() > kMaxBytes) text_.resize(kMaxBytes); // the caller checks sizes: not reached
text_.reserve(kMaxBytes);
}
void NoteText::dropCarriageReturns() {
size_t kept = 0;
for (size_t i = 0; i < text_.size(); i++)
if (!(text_[i] == '\r' && i + 1 < text_.size() && text_[i + 1] == '\n')) text_[kept++] = text_[i];
text_.resize(kept);
}
bool NoteText::setText(const std::string& text) {
size_t kept = text.size();
for (size_t i = 0; i + 1 < text.size(); i++)
if (text[i] == '\r' && text[i + 1] == '\n') kept--;
if (kept > kMaxBytes) return false;
text_.assign(text);
dropCarriageReturns();
cursor_ = top_ = 0;
goal_ = -1;
revision_++;
return true;
}
size_t NoteText::nextLine(size_t start) const {
size_t size = text_.size();
int count = 0;
size_t lastSpace = 0;
bool space = false;
for (size_t i = start; i < size; i++) {
char c = text_[i];
if (c == '\n') return i + 1;
if (continuation(c)) continue;
if (count == cols_) { // one character too many: wrap
if (c == ' ') return i + 1; // the space stays at the end of this line
if (space) return lastSpace + 1; // after the last space that fits
return i; // a word longer than the screen is cut
}
count++;
if (c == ' ') {
lastSpace = i;
space = true;
}
}
return size;
}
size_t NoteText::lineOf(size_t pos) const {
size_t size = text_.size();
pos = std::min(pos, size);
size_t a = pos; // the start of the paragraph: after the newline before `pos`
while (a > 0 && text_[a - 1] != '\n') a--;
while (a < size) {
size_t n = nextLine(a);
if (n > pos) return a;
// The end of the text is on the last line, unless that line ended with a newline: then
// it's on an empty line of its own.
if (n == size && pos == size && text_[size - 1] != '\n') return a;
a = n;
}
return a;
}
bool NoteText::hasLineAfter(size_t start) const {
size_t n = nextLine(start), size = text_.size();
if (n < size) return true;
return start < size && lineOf(size) != start; // the empty line after a final newline
}
size_t NoteText::lastSpot(size_t start) const {
size_t n = nextLine(start), size = text_.size();
if (n == start) return start; // the empty line at the end
if (n == size && lineOf(size) == start) return size;
size_t p = n - 1; // before the newline, the space or the last character the line ends with
while (p > start && continuation(text_[p])) p--;
return p;
}
int NoteText::columnOf(size_t start, size_t pos) const {
int col = 0;
for (size_t i = start; i < pos && i < text_.size(); i++)
if (!continuation(text_[i])) col++;
return col;
}
size_t NoteText::atColumn(size_t start, int col) const {
size_t last = lastSpot(start), p = start;
while (p < last && col > 0) {
p++;
while (p < last && continuation(text_[p])) p++;
col--;
}
return p;
}
void NoteText::moved(bool keepGoal) {
if (!keepGoal) goal_ = -1;
}
bool NoteText::insertText(const std::string& s) {
if (text_.size() + s.size() > kMaxBytes) return false;
text_.insert(cursor_, s);
cursor_ += s.size();
revision_++;
moved();
return true;
}
bool NoteText::insert(uint32_t cp) {
std::string s;
if (cp < 0x80) s += static_cast<char>(cp);
else if (cp < 0x800) {
s += static_cast<char>(0xC0 | (cp >> 6));
s += static_cast<char>(0x80 | (cp & 0x3F));
} else if (cp < 0x10000) {
s += static_cast<char>(0xE0 | (cp >> 12));
s += static_cast<char>(0x80 | ((cp >> 6) & 0x3F));
s += static_cast<char>(0x80 | (cp & 0x3F));
} else {
s += static_cast<char>(0xF0 | (cp >> 18));
s += static_cast<char>(0x80 | ((cp >> 12) & 0x3F));
s += static_cast<char>(0x80 | ((cp >> 6) & 0x3F));
s += static_cast<char>(0x80 | (cp & 0x3F));
}
return insertText(s);
}
void NoteText::backspace() {
if (cursor_ == 0) return;
size_t from = cursor_ - 1;
while (from > 0 && continuation(text_[from])) from--;
text_.erase(from, cursor_ - from);
cursor_ = from;
revision_++;
moved();
}
void NoteText::left() {
if (cursor_ == 0) return;
cursor_--;
while (cursor_ > 0 && continuation(text_[cursor_])) cursor_--;
moved();
}
void NoteText::right() {
if (cursor_ >= text_.size()) return;
cursor_++;
while (cursor_ < text_.size() && continuation(text_[cursor_])) cursor_++;
moved();
}
void NoteText::up() {
size_t line = lineOf(cursor_);
if (goal_ < 0) goal_ = columnOf(line, cursor_);
if (line == 0) return;
cursor_ = atColumn(lineOf(line - 1), goal_);
moved(true);
}
void NoteText::down() {
size_t line = lineOf(cursor_);
if (goal_ < 0) goal_ = columnOf(line, cursor_);
if (!hasLineAfter(line)) return;
size_t next = nextLine(line);
cursor_ = next >= text_.size() ? text_.size() : atColumn(next, goal_);
moved(true);
}
void NoteText::pageUp() {
for (int i = 1; i < rows_; i++) up();
}
void NoteText::pageDown() {
for (int i = 1; i < rows_; i++) down();
}
void NoteText::lineStart() {
cursor_ = lineOf(cursor_);
moved();
}
void NoteText::lineEnd() {
cursor_ = lastSpot(lineOf(cursor_));
moved();
}
void NoteText::toStart() {
cursor_ = 0;
moved();
}
void NoteText::toEnd() {
cursor_ = text_.size();
moved();
}
void NoteText::follow() {
size_t line = lineOf(cursor_);
top_ = lineOf(std::min(top_, text_.size())); // an edit above may have moved where lines start
if (line < top_) {
top_ = line;
return;
}
size_t a = top_;
for (int i = 0; i < rows_; i++) {
if (a == line) return; // on screen
if (!hasLineAfter(a)) return;
a = nextLine(a);
}
// Below the screen: the cursor's line becomes the last row.
top_ = line;
for (int i = 1; i < rows_ && top_ > 0; i++) top_ = lineOf(top_ - 1);
}
std::vector<std::string> NoteText::rows() {
follow();
std::vector<std::string> out;
size_t a = top_, size = text_.size();
for (int i = 0; i < rows_; i++) {
size_t n = nextLine(a);
std::string row = text_.substr(a, n - a);
if (!row.empty() && row.back() == '\n') row.pop_back();
for (char& c : row)
if (c == '\t') c = ' ';
out.push_back(std::move(row));
if (!hasLineAfter(a)) break;
a = n >= size ? size : n;
}
return out;
}
int NoteText::cursorRow() {
follow();
size_t line = lineOf(cursor_), a = top_;
for (int i = 0; i < rows_; i++) {
if (a == line) return i;
a = nextLine(a);
}
return rows_ - 1;
}
int NoteText::cursorCol() { return columnOf(lineOf(cursor_), cursor_); }
// At most a screen's worth of it: a note that is one line of 16 KB must not be copied whole.
std::string NoteText::firstLine() const { return text_.substr(0, std::min<size_t>(text_.find('\n'), 160)); }
namespace {
// U+00C0 to U+00FF as the plain letters a file name gets; 0: left out.
const char kPlain[64] = {
'a', 'a', 'a', 'a', 'a', 'a', 0, 'c', 'e', 'e', 'e', 'e', 'i', 'i', 'i', 'i', // À..Ï
0, 'n', 'o', 'o', 'o', 'o', 'o', 0, 'o', 'u', 'u', 'u', 'u', 'y', 0, 's', // Ð..ß
'a', 'a', 'a', 'a', 'a', 'a', 0, 'c', 'e', 'e', 'e', 'e', 'i', 'i', 'i', 'i', // à..ï
0, 'n', 'o', 'o', 'o', 'o', 'o', 0, 'o', 'u', 'u', 'u', 'u', 'y', 0, 'y'}; // ð..ÿ
// Drops a character the end of the string cuts in two.
void dropPartial(std::string& s) {
size_t k = s.size();
while (k > 0 && continuation(s[k - 1]) && s.size() - k < 3) k--;
if (k == 0) return;
uint8_t lead = static_cast<uint8_t>(s[k - 1]);
size_t want = lead >= 0xF0 ? 4 : lead >= 0xE0 ? 3 : lead >= 0xC0 ? 2 : 1;
if (s.size() - (k - 1) < want) s.resize(k - 1);
}
} // namespace
std::string nameFromFirstLine(const std::string& firstLine, const std::string& stamp) {
std::string out;
bool dash = false;
for (size_t i = 0; i < firstLine.size() && out.size() < 32; i++) {
uint8_t c = static_cast<uint8_t>(firstLine[i]);
char letter = 0;
if (c < 0x80) {
if (c >= 'A' && c <= 'Z') letter = static_cast<char>(c + 32);
else if ((c >= 'a' && c <= 'z') || (c >= '0' && c <= '9')) letter = static_cast<char>(c);
} else if (c == 0xC3 && i + 1 < firstLine.size()) { // U+00C0..U+00FF
letter = kPlain[static_cast<uint8_t>(firstLine[++i]) & 0x3F];
} else {
while (i + 1 < firstLine.size() && continuation(firstLine[i + 1])) i++; // anything else is left out
}
if (letter) {
if (dash && !out.empty()) out += '-';
dash = false;
out += letter;
} else {
dash = true;
}
}
return out.empty() ? "note-" + stamp : out;
}
std::string titleFrom(const std::string& head, size_t maxChars) {
for (size_t at = 0; at < head.size();) {
size_t end = head.find('\n', at);
bool cut = end == std::string::npos; // the line goes on past what was read
if (cut) end = head.size();
std::string line = head.substr(at, end - at);
if (cut) dropPartial(line);
while (!line.empty() && (line.back() == '\r' || line.back() == ' ' || line.back() == '\t')) line.pop_back();
size_t first = line.find_first_not_of(" \t");
if (first != std::string::npos) {
line.erase(0, first);
size_t bytes = 0;
for (size_t chars = 0; bytes < line.size() && chars < maxChars; chars++) {
bytes++;
while (bytes < line.size() && continuation(line[bytes])) bytes++;
}
line.resize(bytes);
return line;
}
at = end + 1;
}
return "";
}
} // namespace roro::notes
+81
View File
@@ -0,0 +1,81 @@
#pragma once
#include <cstddef>
#include <cstdint>
#include <string>
#include <vector>
namespace roro::notes {
// The text of a note while it's edited (F1, Q144, Q145): UTF-8 held whole in memory, a cursor, and
// the part of it on screen. Lines wrap at spaces, `cols` characters wide; a line owns the space or
// the newline it ends with, so every byte of the text belongs to exactly one line. No index of
// lines is kept (a note of newlines alone would need twice its size): where a line starts is
// worked out from the start of its paragraph, which is never far.
class NoteText {
public:
static constexpr size_t kMaxBytes = 16 * 1024;
// Room for a full note is reserved once, so typing never has to find a bigger block of memory:
// on the device a failed allocation is the end. The second form takes over a string the
// caller filled (and reserved): a note is never in memory twice.
NoteText(int cols, int rows);
NoteText(int cols, int rows, std::string&& text);
// Copied into the buffer already held. CRLF becomes LF (Q148). False, and nothing changes, if
// it's over kMaxBytes.
bool setText(const std::string& text);
const std::string& text() const { return text_; }
size_t cursor() const { return cursor_; }
uint32_t revision() const { return revision_; } // changes with every edit: is it saved?
bool insert(uint32_t codePoint); // false: the note is full
bool insertText(const std::string& s); // all of it or nothing
void backspace();
void left();
void right();
void up();
void down();
void pageUp();
void pageDown();
void lineStart();
void lineEnd();
void toStart();
void toEnd();
// The screen, kept around the cursor: its rows (tabs as spaces, the ending newline left out),
// and where the cursor is on it, in rows and characters.
std::vector<std::string> rows();
int cursorRow();
int cursorCol();
int percent() const { return text_.empty() ? 0 : static_cast<int>(top_ * 100 / text_.size()); }
std::string firstLine() const; // without its newline, for the title and the file's name
private:
size_t nextLine(size_t start) const; // where the line after the one at `start` starts
size_t lineOf(size_t pos) const; // the start of the line `pos` is on
size_t lastSpot(size_t start) const; // the last place the cursor can be on that line
size_t atColumn(size_t start, int col) const;
int columnOf(size_t start, size_t pos) const;
bool hasLineAfter(size_t start) const;
void moved(bool keepGoal = false);
void follow(); // scrolls so the cursor is on screen
void dropCarriageReturns();
int cols_, rows_;
std::string text_;
size_t cursor_ = 0, top_ = 0;
int goal_ = -1; // the column Up and Down aim for, across short lines
uint32_t revision_ = 0;
};
// The file a new note is saved as (Q142): from its first line, "Shopping list!" -> "shopping-list",
// or "note-<stamp>" when that gives nothing. No extension, no folder.
std::string nameFromFirstLine(const std::string& firstLine, const std::string& stamp);
// A row's title in the Notes list, from the first bytes of a file: its first line that isn't
// blank, cut to `maxChars`; "" if there's none.
std::string titleFrom(const std::string& head, size_t maxChars);
} // namespace roro::notes
+158
View File
@@ -0,0 +1,158 @@
#include "http_head.h"
#include <algorithm>
#include <cctype>
#include <cstdlib>
namespace roro::release {
namespace {
std::string lower(std::string s) {
for (char& c : s) c = static_cast<char>(std::tolower(static_cast<unsigned char>(c)));
return s;
}
} // namespace
size_t HttpHeadParser::feed(const char* data, size_t len) {
size_t used = 0;
while (used < len && !complete_ && !failed_) {
char c = data[used++];
total_++;
if (total_ > kMaxBytes) {
failed_ = true;
break;
}
if (c == '\n') {
if (!line_.empty() && line_.back() == '\r') line_.pop_back();
line();
line_.clear();
} else {
line_ += c;
}
}
return used;
}
void HttpHeadParser::line() {
if (first_) { // "HTTP/1.1 200 OK"
first_ = false;
if (line_.compare(0, 5, "HTTP/") != 0) {
failed_ = true;
return;
}
size_t space = line_.find(' ');
head_.status = space == std::string::npos ? 0 : std::atoi(line_.c_str() + space + 1);
if (head_.status < 100 || head_.status > 599) failed_ = true;
return;
}
if (line_.empty()) {
complete_ = true;
return;
}
size_t colon = line_.find(':');
if (colon == std::string::npos) return; // not a header: ignored
std::string name = lower(line_.substr(0, colon));
size_t from = line_.find_first_not_of(" \t", colon + 1);
std::string value = from == std::string::npos ? "" : line_.substr(from);
if (name == "content-length") head_.contentLength = std::atol(value.c_str());
else if (name == "transfer-encoding") head_.chunked = lower(value).find("chunked") != std::string::npos;
else if (name == "location") head_.location = value;
else if (name == "content-type") head_.contentType = value;
}
size_t ChunkedDecoder::decode(const uint8_t* in, size_t len, uint8_t* out) {
size_t written = 0;
for (size_t i = 0; i < len && !failed_ && state_ != State::Done; i++) {
uint8_t c = in[i];
switch (state_) {
case State::Size: {
int digit = c >= '0' && c <= '9' ? c - '0' : c >= 'a' && c <= 'f' ? c - 'a' + 10 : c >= 'A' && c <= 'F' ? c - 'A' + 10 : -1;
if (digit >= 0) {
if (remaining_ > (SIZE_MAX >> 5)) failed_ = true;
remaining_ = remaining_ * 16 + digit;
anyDigit_ = true;
} else if (c == ';' && anyDigit_) {
state_ = State::Extension;
} else if (c == '\r' && anyDigit_) {
state_ = State::SizeLf;
} else {
failed_ = true;
}
break;
}
case State::Extension:
if (c == '\r') state_ = State::SizeLf;
break;
case State::SizeLf:
if (c != '\n') {
failed_ = true;
} else if (remaining_ == 0) {
state_ = State::Trailer;
trailerLine_ = 0;
} else {
state_ = State::Data;
}
break;
case State::Data: {
size_t take = std::min(remaining_, len - i);
for (size_t k = 0; k < take; k++) out[written + k] = in[i + k];
written += take;
remaining_ -= take;
i += take - 1;
if (remaining_ == 0) state_ = State::DataCr;
break;
}
case State::DataCr:
if (c != '\r') failed_ = true;
else state_ = State::DataLf;
break;
case State::DataLf:
if (c != '\n') {
failed_ = true;
} else {
state_ = State::Size;
anyDigit_ = false;
}
break;
case State::Trailer: // header lines after the last chunk, until an empty one
if (c == '\n') {
if (trailerLine_ == 0) state_ = State::Done;
trailerLine_ = 0;
} else if (c != '\r') {
trailerLine_++;
}
break;
case State::Done: break;
}
}
return written;
}
Url parseUrl(const std::string& url) {
Url u;
size_t scheme = url.find("://");
if (scheme == std::string::npos) return u;
std::string s = lower(url.substr(0, scheme));
if (s != "http" && s != "https") return u;
u.https = s == "https";
size_t hostStart = scheme + 3, pathStart = url.find('/', hostStart);
std::string authority = url.substr(hostStart, pathStart == std::string::npos ? std::string::npos : pathStart - hostStart);
u.path = pathStart == std::string::npos ? "/" : url.substr(pathStart);
if (authority.empty() || authority.find('@') != std::string::npos) return u; // no credentials in a URL
size_t colon = authority.rfind(':');
u.port = u.https ? 443 : 80;
if (colon != std::string::npos) {
u.port = std::atoi(authority.c_str() + colon + 1);
authority.resize(colon);
if (u.port <= 0 || u.port > 65535) return u;
}
for (unsigned char c : authority)
if (!(std::isalnum(c) || c == '.' || c == '-')) return u;
for (unsigned char c : u.path)
if (c <= ' ' || c == 0x7F) return u;
u.host = lower(authority);
u.ok = !u.host.empty();
return u;
}
} // namespace roro::release
+62
View File
@@ -0,0 +1,62 @@
#pragma once
#include <cstddef>
#include <cstdint>
#include <string>
namespace roro::release {
// The status line and headers of an HTTP/1.1 response, read as bytes arrive.
struct HttpHead {
int status = 0;
long contentLength = -1; // -1: not given
bool chunked = false;
std::string location, contentType;
};
class HttpHeadParser {
public:
static constexpr size_t kMaxBytes = 4096;
// Takes bytes up to and including the blank line that ends the head; returns how many it used.
// What follows is the body.
size_t feed(const char* data, size_t len);
bool complete() const { return complete_; }
bool failed() const { return failed_; }
const HttpHead& head() const { return head_; }
private:
void line();
HttpHead head_;
std::string line_;
size_t total_ = 0;
bool first_ = true, complete_ = false, failed_ = false;
};
// Takes the chunks of "Transfer-Encoding: chunked" apart as they arrive.
class ChunkedDecoder {
public:
// `out` has room for `len` bytes (the body is never longer than what carried it).
size_t decode(const uint8_t* in, size_t len, uint8_t* out);
bool done() const { return state_ == State::Done; }
bool failed() const { return failed_; }
private:
enum class State : uint8_t { Size, Extension, SizeLf, Data, DataCr, DataLf, Trailer, Done };
State state_ = State::Size;
size_t remaining_ = 0;
bool anyDigit_ = false, failed_ = false;
size_t trailerLine_ = 0;
};
// "https://git.twis.la/twisla/x/releases/download/v1/a.ota" taken apart. Only http and https.
struct Url {
bool ok = false;
bool https = false;
std::string host, path; // path from the first "/", with its query; "/" if none
int port = 0;
};
Url parseUrl(const std::string& url);
} // namespace roro::release
+202
View File
@@ -0,0 +1,202 @@
#include "json_scan.h"
namespace roro::release {
namespace {
bool space(char c) { return c == ' ' || c == '\t' || c == '\r' || c == '\n'; }
bool continuation(char c) { return (static_cast<uint8_t>(c) & 0xC0) == 0x80; }
} // namespace
void JsonScanner::feed(const char* data, size_t len) {
for (size_t i = 0; i < len && !failed_; i++) step(data[i]);
}
std::string JsonScanner::path() const {
std::string p;
for (const Frame& f : stack_) {
if (f.isObject) {
if (!p.empty()) p += '.';
p += f.key;
} else {
p += '[' + std::to_string(f.index) + ']';
}
}
return p;
}
void JsonScanner::append(const char* bytes, size_t n) {
if (text_.size() + n > max_) {
truncated_ = true;
return;
}
text_.append(bytes, n);
}
void JsonScanner::appendCodePoint(uint32_t cp) {
char b[4];
size_t n;
if (cp < 0x80) {
b[0] = static_cast<char>(cp);
n = 1;
} else if (cp < 0x800) {
b[0] = static_cast<char>(0xC0 | (cp >> 6));
b[1] = static_cast<char>(0x80 | (cp & 0x3F));
n = 2;
} else if (cp < 0x10000) {
b[0] = static_cast<char>(0xE0 | (cp >> 12));
b[1] = static_cast<char>(0x80 | ((cp >> 6) & 0x3F));
b[2] = static_cast<char>(0x80 | (cp & 0x3F));
n = 3;
} else {
b[0] = static_cast<char>(0xF0 | (cp >> 18));
b[1] = static_cast<char>(0x80 | ((cp >> 12) & 0x3F));
b[2] = static_cast<char>(0x80 | ((cp >> 6) & 0x3F));
b[3] = static_cast<char>(0x80 | (cp & 0x3F));
n = 4;
}
append(b, n);
}
void JsonScanner::startString(bool key) {
inString_ = true;
isKey_ = key;
escape_ = false;
unicodeLeft_ = 0;
highSurrogate_ = 0;
truncated_ = false;
text_.clear();
}
void JsonScanner::stringChar(char c) {
if (unicodeLeft_ > 0) {
int digit = c >= '0' && c <= '9' ? c - '0' : c >= 'a' && c <= 'f' ? c - 'a' + 10 : c >= 'A' && c <= 'F' ? c - 'A' + 10 : -1;
if (digit < 0) return fail();
unicode_ = unicode_ * 16 + digit;
if (--unicodeLeft_ == 0) {
if (unicode_ >= 0xD800 && unicode_ < 0xDC00) {
highSurrogate_ = unicode_; // the low half comes next
} else if (unicode_ >= 0xDC00 && unicode_ < 0xE000 && highSurrogate_) {
appendCodePoint(0x10000 + ((highSurrogate_ - 0xD800) << 10) + (unicode_ - 0xDC00));
highSurrogate_ = 0;
} else {
appendCodePoint(unicode_);
highSurrogate_ = 0;
}
}
return;
}
if (escape_) {
escape_ = false;
switch (c) {
case 'n': append("\n", 1); break;
case 't': append("\t", 1); break;
case 'r': append("\r", 1); break;
case 'b': append("\b", 1); break;
case 'f': append("\f", 1); break;
case 'u': unicodeLeft_ = 4; unicode_ = 0; break;
default: append(&c, 1); break; // \" \\ \/
}
return;
}
if (c == '\\') {
escape_ = true;
} else if (c == '"') {
endString();
} else {
append(&c, 1);
}
}
void JsonScanner::endString() {
inString_ = false;
// A cut can leave half a character at the end.
while (truncated_ && !text_.empty()) {
size_t k = text_.size();
while (k > 0 && continuation(text_[k - 1])) k--;
if (k == 0) break;
uint8_t lead = static_cast<uint8_t>(text_[k - 1]);
size_t want = lead >= 0xF0 ? 4 : lead >= 0xE0 ? 3 : lead >= 0xC0 ? 2 : 1;
if (text_.size() - (k - 1) < want) text_.resize(k - 1);
break;
}
if (isKey_) {
stack_.back().key = text_;
expect_ = Expect::Colon;
return;
}
sink_(path(), text_, true, truncated_);
valueDone();
}
void JsonScanner::endLiteral() {
inLiteral_ = false;
sink_(path(), text_, false, false);
valueDone();
}
void JsonScanner::valueDone() {
if (stack_.empty()) {
done_ = true;
return;
}
expect_ = Expect::CommaOrEnd;
}
void JsonScanner::step(char c) {
if (inString_) return stringChar(c);
if (inLiteral_) {
if (space(c) || c == ',' || c == '}' || c == ']') {
endLiteral(); // and the character that ended it is read again below
} else {
if (text_.size() < max_) text_ += c;
return;
}
}
if (space(c)) return;
switch (expect_) {
case Expect::Value:
if (c == '{') {
stack_.push_back({true, "", 0});
expect_ = Expect::KeyOrEnd;
} else if (c == '[') {
stack_.push_back({false, "", 0});
expect_ = Expect::Value;
} else if (c == ']' && !stack_.empty() && !stack_.back().isObject && stack_.back().index == 0) {
stack_.pop_back(); // an empty array
valueDone();
} else if (c == '"') {
startString(false);
} else if (c == '-' || (c >= '0' && c <= '9') || c == 't' || c == 'f' || c == 'n') {
inLiteral_ = true;
text_.assign(1, c);
} else {
fail();
}
return;
case Expect::KeyOrEnd:
if (c == '"') startString(true);
else if (c == '}') {
stack_.pop_back();
valueDone();
} else fail();
return;
case Expect::Colon:
if (c == ':') expect_ = Expect::Value;
else fail();
return;
case Expect::CommaOrEnd:
if (c == ',') {
if (stack_.back().isObject) expect_ = Expect::KeyOrEnd;
else {
stack_.back().index++;
expect_ = Expect::Value;
}
} else if ((c == '}' && stack_.back().isObject) || (c == ']' && !stack_.back().isObject)) {
stack_.pop_back();
valueDone();
} else fail();
return;
}
}
} // namespace roro::release
+57
View File
@@ -0,0 +1,57 @@
#pragma once
#include <cstddef>
#include <cstdint>
#include <functional>
#include <string>
#include <vector>
namespace roro::release {
// Reads JSON as it arrives, a chunk at a time, and reports each plain value (a string, a number,
// true, false, null) with where it was found: "tag_name", "assets[1].name", "[2].draft". Nothing
// is kept but the path, so a 33 KB list of releases costs a few hundred bytes. A value longer than
// `maxValueBytes` is cut (never in the middle of a character) and reported as truncated.
// Meant for a server's answer, not for validating JSON: it only refuses what it can't follow.
class JsonScanner {
public:
using Sink = std::function<void(const std::string& path, const std::string& value, bool isString, bool truncated)>;
explicit JsonScanner(Sink sink, size_t maxValueBytes = 300) : sink_(std::move(sink)), max_(maxValueBytes) {}
void feed(const char* data, size_t len);
bool failed() const { return failed_; }
bool done() const { return done_ && !failed_; } // the top-level value is complete
private:
enum class Expect : uint8_t { Value, KeyOrEnd, Colon, CommaOrEnd };
struct Frame {
bool isObject;
std::string key;
int index;
};
void step(char c);
void startString(bool key);
void stringChar(char c);
void appendCodePoint(uint32_t cp);
void endString();
void endLiteral();
void valueDone();
void append(const char* bytes, size_t n);
std::string path() const;
void fail() { failed_ = true; }
Sink sink_;
size_t max_;
std::vector<Frame> stack_;
Expect expect_ = Expect::Value;
bool inString_ = false, isKey_ = false, escape_ = false, inLiteral_ = false;
int unicodeLeft_ = 0;
uint32_t unicode_ = 0, highSurrogate_ = 0;
bool truncated_ = false;
std::string text_;
bool failed_ = false, done_ = false;
};
} // namespace roro::release
+80
View File
@@ -0,0 +1,80 @@
#include "release_info.h"
#include <cstdlib>
namespace roro::release {
namespace {
bool endsWith(const std::string& s, const char* tail) {
size_t n = std::char_traits<char>::length(tail);
return s.size() >= n && s.compare(s.size() - n, n, tail) == 0;
}
} // namespace
std::string firstParagraph(const std::string& text, bool truncated) {
size_t end = text.find("\n\n");
size_t crlf = text.find("\r\n\r\n");
if (crlf != std::string::npos && (end == std::string::npos || crlf < end)) end = crlf;
std::string p = text.substr(0, end);
size_t first = p.find_first_not_of(" \t\r\n");
if (first == std::string::npos) return "";
p.erase(0, first);
while (!p.empty() && (p.back() == ' ' || p.back() == '\t' || p.back() == '\r' || p.back() == '\n')) p.pop_back();
if (truncated && end == std::string::npos) p += "...";
return p;
}
ReleaseReader::ReleaseReader(size_t maxReleases)
: scanner_([this](const std::string& path, const std::string& text, bool isString, bool truncated) {
value(path, text, isString, truncated);
}),
max_(maxReleases) {}
void ReleaseReader::end() { flushAsset(); }
void ReleaseReader::flushAsset() {
if (assetRelease_ >= 0 && assetRelease_ < static_cast<int>(releases_.size()) && endsWith(assetName_, ".ota") && !assetUrl_.empty()) {
releases_[assetRelease_].otaUrl = assetUrl_;
releases_[assetRelease_].otaSize = assetSize_;
}
assetRelease_ = assetIndex_ = -1;
assetName_.clear();
assetUrl_.clear();
assetSize_ = 0;
}
void ReleaseReader::value(const std::string& path, const std::string& text, bool isString, bool truncated) {
size_t index = 0;
std::string rest = path;
if (!path.empty() && path[0] == '[') { // a list: "[2].tag_name"
char* end;
index = static_cast<size_t>(std::strtol(path.c_str() + 1, &end, 10));
rest = *end == ']' ? std::string(end + 1) : "";
if (!rest.empty() && rest[0] == '.') rest.erase(0, 1);
}
if (index >= max_) return;
if (releases_.size() <= index) releases_.resize(index + 1);
Release& r = releases_[index];
if (rest == "tag_name") r.tag = text;
else if (rest == "published_at") r.published = text;
else if (rest == "body") r.notes = firstParagraph(text, truncated);
else if (rest == "draft") r.draft = text == "true";
else if (rest == "prerelease") r.prerelease = text == "true";
else if (rest.compare(0, 7, "assets[") == 0) {
char* end;
int j = static_cast<int>(std::strtol(rest.c_str() + 7, &end, 10));
if (static_cast<int>(index) != assetRelease_ || j != assetIndex_) {
flushAsset();
assetRelease_ = static_cast<int>(index);
assetIndex_ = j;
}
std::string field = *end == ']' && end[1] == '.' ? std::string(end + 2) : "";
if (field == "name") assetName_ = text;
else if (field == "size") assetSize_ = static_cast<uint32_t>(std::strtoul(text.c_str(), nullptr, 10));
else if (field == "browser_download_url") assetUrl_ = text;
}
(void)isString;
}
} // namespace roro::release
+52
View File
@@ -0,0 +1,52 @@
#pragma once
#include <cstdint>
#include <string>
#include <vector>
#include "json_scan.h"
namespace roro::release {
// What the device needs to know about one Gitea release (docs/milestones/R1.md, #6).
struct Release {
std::string tag; // "v0.10.0"
std::string published; // "2026-10-06T08:11:31Z"
std::string notes; // the first paragraph of the text: the tag's message
std::string otaUrl; // where the signed Update File is
uint32_t otaSize = 0;
bool draft = false, prerelease = false;
// Something that can be installed and that the project meant to publish (drafts and
// pre-releases are left out for now: a release channel is #53).
bool usable() const { return !draft && !prerelease && !tag.empty() && !otaUrl.empty(); }
std::string date() const { return published.substr(0, 10); } // "2026-10-06"
};
// Reads Gitea's answer as it arrives: `releases/latest` (one object) or `releases?limit=N` (a list).
class ReleaseReader {
public:
explicit ReleaseReader(size_t maxReleases = 10);
void feed(const char* data, size_t len) { scanner_.feed(data, len); }
void end(); // after the last chunk
bool ok() const { return !scanner_.failed(); }
bool complete() const { return scanner_.done(); }
const std::vector<Release>& releases() const { return releases_; }
private:
void value(const std::string& path, const std::string& text, bool isString, bool truncated);
void flushAsset();
JsonScanner scanner_;
size_t max_;
std::vector<Release> releases_;
int assetRelease_ = -1, assetIndex_ = -1;
std::string assetName_, assetUrl_;
uint32_t assetSize_ = 0;
};
// The first paragraph of a release's text, trimmed; "..." if the text was cut before it ended.
std::string firstParagraph(const std::string& text, bool truncated);
} // namespace roro::release
+15
View File
@@ -0,0 +1,15 @@
#include "update_check.h"
#include "http_head.h"
namespace roro::release {
bool trustedAssetUrl(const std::string& url, const std::string& host, const std::string& repo) {
Url u = parseUrl(url);
if (!u.ok || !u.https || u.port != 443 || u.host != host) return false;
std::string prefix = "/" + repo + "/releases/download/";
return u.path.compare(0, prefix.size(), prefix) == 0 && u.path.find("..") == std::string::npos &&
u.path.find('?') == std::string::npos && u.path.find('#') == std::string::npos;
}
} // namespace roro::release
+38
View File
@@ -0,0 +1,38 @@
#pragma once
#include <string>
#include "release_info.h"
#include "version_compare.h"
namespace roro::release {
// Where the project's releases are (Q164). A fork changes these, and its own signing key.
constexpr const char* kGiteaHost = "git.twis.la";
constexpr const char* kGiteaRepo = "twisla/roro9stack";
inline bool versionNewer(const std::string& a, const std::string& b) { return versionOlder(b, a); }
// "v0.10.0+debug": the Debug Build says so wherever the version shows (scripts/version.py).
inline bool isDebugBuild(const std::string& version) {
static const std::string tail = "+debug";
return version.size() >= tail.size() && version.compare(version.size() - tail.size(), tail.size(), tail) == 0;
}
// Is `release` a newer one than what runs?
inline bool isNewer(const Release& release, const std::string& running) {
return release.usable() && versionNewer(release.tag, running);
}
// Should the background check say so (Q166, Q168)? Not for a version that failed on this device
// before (it rolled back), and not twice for the same one.
inline bool shouldAnnounce(const Release& latest, const std::string& running, const std::string& failed, const std::string& announced) {
return isNewer(latest, running) && latest.tag != failed && latest.tag != announced;
}
// Is `url` a download this device takes from the project's server, for this repository? Whatever
// the API says, the device only fetches from where it asked (a redirected or rewritten answer
// can't send it elsewhere).
bool trustedAssetUrl(const std::string& url, const std::string& host = kGiteaHost, const std::string& repo = kGiteaRepo);
} // namespace roro::release
+4 -1
View File
@@ -10,7 +10,10 @@ bool PowerPolicy::activity(uint32_t nowMs) {
}
ScreenState PowerPolicy::update(uint32_t nowMs) {
uint32_t idle = nowMs - lastActivityMs_;
// Activity stamped from a clock read after this pass's nowMs (the Debug Console's `key`) is in
// the future, not 49 days ago: unsigned, the screen went off for a tick and ate the next key.
int32_t since = static_cast<int32_t>(nowMs - lastActivityMs_);
uint32_t idle = since < 0 ? 0 : static_cast<uint32_t>(since);
state_ = idle >= offMs_ ? ScreenState::Off : idle >= dimMs_ ? ScreenState::Dimmed : ScreenState::On;
if (notifying_) {
if (static_cast<int32_t>(nowMs - notifyUntilMs_) >= 0)
+1
View File
@@ -40,6 +40,7 @@ const Definition kDefinitions[] = {
{"ntp1", Kind::String, 0, "pool.ntp.org", 1, 63},
{"ntp2", Kind::String, 0, "time.cloudflare.com", 0, 63},
{"gnss_quiet", Kind::Bool, 0, nullptr, 0, 1}, // off: GNSS stays on, as decided in M2 (Q58)
{"check_updates", Kind::Bool, 1, nullptr, 0, 1}, // on: it only looks, and says so (R1, Q165)
};
static_assert(sizeof(kDefinitions) / sizeof(kDefinitions[0]) == static_cast<size_t>(Setting::Count),
"every Setting needs a definition");
+1
View File
@@ -30,6 +30,7 @@ enum class Setting : uint8_t {
Ntp1, // string: the first NTP server, a host name or an IPv4 address (S1, Q110)
Ntp2, // string: the second, or empty
GnssQuietForLora, // bool: put the GNSS receiver in standby while the LoRa radio listens (issue #20)
CheckUpdates, // bool: look for a newer release on Gitea once a day (R1, Q165)
Count
};
+11
View File
@@ -46,3 +46,14 @@ build_flags =
platform = native
lib_ldf_mode = deep+
build_flags = -std=gnu++17
; The same tests, built to count which lines of lib/ they run (scripts/coverage.sh).
[env:native-coverage]
extends = env:native
build_flags =
${env:native.build_flags}
--coverage
-O0
extra_scripts =
${env.extra_scripts}
pre:scripts/coverage_link.py
+7 -1
View File
@@ -1,8 +1,10 @@
# Shared helper: run a command inside the roro9stack build container.
# With RORO_NO_DOCKER set, the caller is in such a container already (a CI job): the command runs
# right here, in the checkout.
IMAGE=roro9stack-build
ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
docker build -q -t "$IMAGE" "$ROOT/docker" >/dev/null
[ -n "${RORO_NO_DOCKER:-}" ] || docker build -q -t "$IMAGE" "$ROOT/docker" >/dev/null
# The Debug Console token (ADR 0004): made once, kept with the OTA key, never committed.
DEBUG_TOKEN_FILE="$HOME/.config/roro9stack/debug-token"
@@ -12,6 +14,10 @@ if [ ! -s "$DEBUG_TOKEN_FILE" ]; then
fi
run_in_container() {
if [ -n "${RORO_NO_DOCKER:-}" ]; then
(cd "$ROOT" && RORO_DEBUG_TOKEN="$(cat "$DEBUG_TOKEN_FILE")" "$@")
return
fi
docker run --rm \
-u "$(id -u):$(id -g)" -e HOME=/tmp \
-e RORO_DEBUG_TOKEN="$(cat "$DEBUG_TOKEN_FILE")" \
+8 -1
View File
@@ -1,7 +1,14 @@
#!/usr/bin/env bash
# Local CI: run host unit tests, then build the firmware.
# Usage: scripts/ci.sh [tests|builds] one half only; both by default
set -euo pipefail
source "$(dirname "$0")/_docker.sh"
DOCKER_EXTRA=()
run_in_container bash -c 'git config --global --add safe.directory /work && pio test -e native && pio run -e cardputer-adv -e cardputer-adv-debug'
case "${1:-all}" in
tests) STEPS='pio test -e native' ;;
builds) STEPS='pio run -e cardputer-adv -e cardputer-adv-debug' ;;
all) STEPS='pio test -e native && pio run -e cardputer-adv -e cardputer-adv-debug' ;;
*) echo "Usage: scripts/ci.sh [tests|builds]" >&2; exit 1 ;;
esac
run_in_container bash -c 'git config --global --add safe.directory "$PWD" && '"$STEPS"
+21
View File
@@ -0,0 +1,21 @@
#!/usr/bin/env bash
# Runs the host tests and says how much of lib/ they run: they're built with coverage counters.
# Usage: scripts/coverage.sh [out folder, default .pio/coverage]
# Out: summary.json (gcovr), coverage.svg (the README's badge), index.html (line by line).
# What it measures: the lines of lib/ that compile on a PC. Not lib/SD (the card's driver) and not
# src/ (the Apps, the Services, everything that needs the device): those have no host tests.
set -euo pipefail
source "$(dirname "$0")/_docker.sh"
DOCKER_EXTRA=()
OUT="${1:-.pio/coverage}"
run_in_container bash -c '
set -eo pipefail # a failing test fails this script, tail or not
git config --global --add safe.directory "$PWD"
rm -rf .pio/build/native-coverage "'"$OUT"'"
mkdir -p "'"$OUT"'"
pio test -e native-coverage | tail -1
gcovr -r . --filter "lib/" --object-directory .pio/build/native-coverage \
--json-summary "'"$OUT"'/summary.json" --html-details "'"$OUT"'/index.html" --print-summary | tail -4
python3 scripts/coverage_badge.py "'"$OUT"'/summary.json" "'"$OUT"'/coverage.svg"
'
+46
View File
@@ -0,0 +1,46 @@
#!/usr/bin/env python3
"""Draws the README's coverage badge from gcovr's summary.
Usage: scripts/coverage_badge.py <summary.json> <out.svg>
scripts/coverage_badge.py --plain <label> <value> <out.svg> any other badge, in blue
Also prints one line, and appends a short table to $GITHUB_STEP_SUMMARY when CI sets it.
"""
import json
import os
import sys
def badge(label, value, color, title):
left, right = 6 * len(label) + 12, 7 * len(value) + 12
return f'''<svg xmlns="http://www.w3.org/2000/svg" width="{left + right}" height="20" role="img" aria-label="{label}: {value}">
<title>{title}</title>
<linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient>
<clipPath id="r"><rect width="{left + right}" height="20" rx="3" fill="#fff"/></clipPath>
<g clip-path="url(#r)"><rect width="{left}" height="20" fill="#555"/><rect x="{left}" width="{right}" height="20" fill="{color}"/><rect width="{left + right}" height="20" fill="url(#s)"/></g>
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
<text x="{left / 2}" y="14">{label}</text><text x="{left + right / 2}" y="14">{value}</text></g></svg>
'''
def main():
if sys.argv[1] == "--plain": # any other badge: --plain <label> <value> <out.svg>
label, value, out = sys.argv[2:5]
open(out, "w").write(badge(label, value, "#007ec6", f"{label}: {value}"))
return
summary = json.load(open(sys.argv[1]))
lines, branches = summary["line_percent"], summary["branch_percent"]
label, value = "lib coverage", f"{lines:.0f}%"
color = "#4c1" if lines >= 90 else "#a4a61d" if lines >= 75 else "#dfb317" if lines >= 60 else "#e05d44"
svg = badge(label, value, color, f"{label}: {value} of the lines of lib/ are run by the host tests")
open(sys.argv[2], "w").write(svg)
print(f"coverage of lib/: {lines:.1f}% of {summary['line_total']} lines, {branches:.1f}% of branches, {len(summary['files'])} files")
step = os.environ.get("GITHUB_STEP_SUMMARY")
if step:
worst = sorted((f["line_percent"], f["filename"]) for f in summary["files"] if f["line_total"] >= 10)[:5]
with open(step, "a") as out:
out.write(f"### Coverage of `lib/` by the host tests\n\n**{lines:.1f}%** of {summary['line_total']} lines, {branches:.1f}% of branches.\n\n")
out.write("| Least covered | Lines |\n|---|---|\n" + "".join(f"| `{name}` | {pct:.0f}% |\n" for pct, name in worst))
if __name__ == "__main__":
main()
+4
View File
@@ -0,0 +1,4 @@
# The coverage build must also link with --coverage (build_flags only reaches the compiler).
Import("env") # noqa: F821 (provided by PlatformIO)
env.Append(LINKFLAGS=["--coverage"]) # noqa: F821
+49
View File
@@ -0,0 +1,49 @@
#!/usr/bin/env python3
"""Checks an Update File (.ota) the way the device does, on a PC: header, signature, image hash.
Usage: scripts/ota_verify.py <file.ota> [public key, default keys/ota-public.pem]
Exits 0 and prints the version if a device would accept the file.
"""
import hashlib
import os
import struct
import subprocess
import sys
import tempfile
HEADER_SIZE = 160
SIGNED_BYTES = 80
def main():
if len(sys.argv) < 2:
sys.exit(__doc__)
root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
key = sys.argv[2] if len(sys.argv) > 2 else os.path.join(root, "keys", "ota-public.pem")
data = open(sys.argv[1], "rb").read()
if len(data) < HEADER_SIZE or data[:8] != b"RORO-OTA":
sys.exit("not an update file")
fmt, header_size, image_size = struct.unpack("<HHI", data[8:16])
if fmt != 1 or header_size != HEADER_SIZE:
sys.exit("unsupported update format")
image = data[HEADER_SIZE:]
if len(image) != image_size:
sys.exit(f"the header announces {image_size} bytes of image, the file has {len(image)}")
if hashlib.sha256(image).digest() != data[16:48]:
sys.exit("image corrupted (hash mismatch)")
version = data[48:80].split(b"\0")[0].decode()
(sig_len,) = struct.unpack("<H", data[80:82])
with tempfile.NamedTemporaryFile() as signed, tempfile.NamedTemporaryFile() as sig:
signed.write(data[:SIGNED_BYTES])
signed.flush()
sig.write(data[82:82 + sig_len])
sig.flush()
ok = subprocess.run(["openssl", "dgst", "-sha256", "-verify", key, "-signature", sig.name, signed.name],
capture_output=True).returncode == 0
if not ok:
sys.exit("bad signature (wrong key)")
print(f"{sys.argv[1]}: {version}, {image_size} bytes, signature good")
if __name__ == "__main__":
main()
+8 -3
View File
@@ -224,10 +224,15 @@ def interactive(sock):
sys.stdout.write(data.decode(errors="replace"))
sys.stdout.flush()
if sys.stdin in ready:
line = sys.stdin.readline()
if not line:
# Straight from the descriptor: readline() takes every waiting line into Python's own
# buffer and hands over one, and select() then sees nothing more to read. Piped input
# written while we were still connecting got stuck until the next line came.
data = os.read(sys.stdin.fileno(), 4096)
if not data:
return
sock.sendall(line.encode())
sock.setblocking(True)
sock.sendall(data)
sock.setblocking(False)
def main():
+62
View File
@@ -0,0 +1,62 @@
#!/usr/bin/env bash
# Builds what a release publishes, from a checkout of the repository at a tag (docs/milestones/R1.md).
# Usage: scripts/release_build.sh <checkout> <out folder>
# <checkout> a clone with its tags, at the commit to release: its own sources are built, with
# this copy's build image and signing tools, so an old tag can be released today.
# The signing key is read from $RORO_OTA_KEY (a file), as scripts/make_ota.py does.
# Out: roro9stack-<version>.ota (signed, checked), -factory.bin (USB), .elf.gz (to decode crashes),
# SHA256SUMS, and notes.md for the release's text.
set -euo pipefail
SRC="$(cd "$1" && pwd)"
mkdir -p "$2"
OUT="$(cd "$2" && pwd)"
TOOLS="$(cd "$(dirname "$0")" && pwd)"
VERSION="$(git -C "$SRC" describe --tags --always --dirty)"
case "$VERSION" in
*-dirty) echo "release: $SRC has uncommitted changes ($VERSION)" >&2; exit 1 ;;
esac
git -C "$SRC" describe --tags --exact-match >/dev/null 2>&1 || { echo "release: $VERSION is not a tag" >&2; exit 1; }
source "$TOOLS/_docker.sh"
ROOT="$SRC" # _docker.sh mounts $ROOT as /work: the checkout to build, not necessarily this copy
DOCKER_EXTRA=()
# A tag from before the framework was rebuilt with our settings (ADR 0006) can't link against a
# rebuilt one left in the toolchain cache: it gets the framework's libraries as they come.
if ! grep -q custom_sdkconfig "$SRC/platformio.ini"; then
run_in_container bash -c 'rm -rf "${PLATFORMIO_CORE_DIR:-/pio}/packages/framework-arduinoespressif32-libs"'
fi
run_in_container bash -c 'git config --global --add safe.directory "$PWD" && pio run -e cardputer-adv'
BUILD="$SRC/.pio/build/cardputer-adv"
NAME="roro9stack-$VERSION"
"$TOOLS/make_ota.py" "$BUILD/firmware.bin" "$VERSION" "$OUT/$NAME.ota"
# A wrong key must stop the release here, not on a device: checked against the public key the
# sources being built carry (the tags from before Firmware Updates have none: today's, then).
PUBLIC="$SRC/keys/ota-public.pem"
[ -e "$PUBLIC" ] || PUBLIC="$TOOLS/../keys/ota-public.pem"
"$TOOLS/ota_verify.py" "$OUT/$NAME.ota" "$PUBLIC"
cp "$BUILD/firmware.factory.bin" "$OUT/$NAME-factory.bin"
gzip -9 -c "$BUILD/firmware.elf" > "$OUT/$NAME.elf.gz"
(cd "$OUT" && sha256sum "$NAME.ota" "$NAME-factory.bin" "$NAME.elf.gz" > SHA256SUMS)
# The release's text: what the tag says, then what went in since the tag before.
PREVIOUS="$(git -C "$SRC" describe --tags --abbrev=0 "$VERSION^" 2>/dev/null || true)"
{
git -C "$SRC" tag -l --format='%(contents)' "$VERSION" | sed -e '/^-----BEGIN PGP/,$d'
echo
echo "## Files"
echo
echo "- \`$NAME.ota\`: the signed Update File. Copy it to \`/updates\` on the SD card and install it from Settings > Firmware or the Storage App, or push it over Wi-Fi with \`scripts/ota_push.py\`."
echo "- \`$NAME-factory.bin\`: the whole flash image, for a first install over USB at offset 0."
echo "- \`$NAME.elf.gz\`: the symbols, to decode a crash report from this build."
echo "- \`SHA256SUMS\`: checksums of the three."
if [ -n "$PREVIOUS" ]; then
echo
echo "## Changes since $PREVIOUS"
echo
git -C "$SRC" log --no-merges --format='- %s' "$PREVIOUS..$VERSION"
fi
} > "$OUT/notes.md"
echo "$VERSION" > "$OUT/version"
ls -l "$OUT"
+65
View File
@@ -0,0 +1,65 @@
#!/usr/bin/env python3
"""Creates or completes a Gitea release from what scripts/release_build.sh made.
Usage: scripts/release_publish.py <folder>
Environment: GITEA_API (https://host/api/v1), GITEA_REPO (owner/name), GITEA_TOKEN.
Run again for the same version, it replaces the files and the text instead of failing.
"""
import json
import os
import sys
import urllib.error
import urllib.parse
import urllib.request
API = os.environ.get("GITEA_API", "").rstrip("/")
REPO = os.environ.get("GITEA_REPO", "")
TOKEN = os.environ.get("GITEA_TOKEN", "")
def call(method, path, body=None, raw=None, content_type="application/json"):
data = raw if raw is not None else (json.dumps(body).encode() if body is not None else None)
request = urllib.request.Request(f"{API}/repos/{REPO}{path}", data=data, method=method)
request.add_header("Authorization", f"token {TOKEN}")
if data is not None:
request.add_header("Content-Type", content_type)
try:
with urllib.request.urlopen(request, timeout=300) as response:
text = response.read()
return response.status, json.loads(text) if text else None
except urllib.error.HTTPError as e:
return e.code, e.read().decode(errors="replace")[:300]
def main():
if len(sys.argv) != 2 or not (API and REPO and TOKEN):
sys.exit(__doc__)
folder = sys.argv[1]
version = open(os.path.join(folder, "version")).read().strip()
notes = open(os.path.join(folder, "notes.md")).read()
files = sorted(f for f in os.listdir(folder) if f not in ("version", "notes.md"))
status, release = call("GET", f"/releases/tags/{urllib.parse.quote(version)}")
fields = {"tag_name": version, "name": f"roro9stack {version}", "body": notes, "draft": False, "prerelease": False}
if status == 200:
status, release = call("PATCH", f"/releases/{release['id']}", fields)
else:
status, release = call("POST", "/releases", fields)
if status not in (200, 201):
sys.exit(f"release: Gitea answered {status}: {release}")
for asset in release.get("assets") or []: # a second run replaces what the first uploaded
if asset["name"] in files:
call("DELETE", f"/releases/{release['id']}/assets/{asset['id']}")
for name in files:
with open(os.path.join(folder, name), "rb") as f:
status, answer = call("POST", f"/releases/{release['id']}/assets?name={urllib.parse.quote(name)}", raw=f.read(),
content_type="application/octet-stream")
if status != 201:
sys.exit(f"release: uploading {name}: Gitea answered {status}: {answer}")
print(f"uploaded {name} ({answer['size']} bytes)")
print(f"published {release['html_url']}")
if __name__ == "__main__":
main()
+45
View File
@@ -0,0 +1,45 @@
# The roro9stack site
Source of https://roro9stack.net (docs/milestones/W1.md): a [Zola](https://www.getzola.org/) site. The home page, an Install page with a browser flasher, and the list of releases so far; the user guide, how-tos, FAQ and developer docs come next.
```
config.toml base_url, the repository and API addresses
content/ the pages (Markdown, with their template named in the front matter)
templates/ base, home, install, downloads, 404; illustrations/ is generated
data/ the App cards and the screenshots' captions
static/ css, js, fonts (self-hosted), img, screens (real screenshots), vendor/esp-web-tools
tools/ make_illustrations.py, check_site.py
```
## Build and look
```sh
docker run --rm -u "$(id -u):$(id -g)" -v "$PWD:/repo" -w /repo/site ghcr.io/getzola/zola:v0.22.0 build # writes ./public
docker run --rm -u "$(id -u):$(id -g)" -p 1111:1111 -v "$PWD:/repo" -w /repo/site ghcr.io/getzola/zola:v0.22.0 serve --interface 0.0.0.0
python3 site/tools/check_site.py public # what the pages promise, kept
```
Or `zola build` with a Zola of your own, in `site/` (or `zola --root site build` from the root). **The output goes to `public/` at the root of the repository,** not into `site/`: `output_dir` in `config.toml`, and git ignores that directory. The build reads the latest release and the list of releases from the Gitea API (`load_data`); if the server can't be reached, the pages say so instead of failing.
## Publishing
The web server pulls `main` and runs `zola build`, as for the blog. CI (`.gitea/workflows/site.yml`) builds the site and runs the checks when `site/`, `docs/`, `README.md` or `CONTEXT.md` change; the firmware workflow skips a change that touches only those.
## Things to know
- **The Install page needs Caddy's help.** Gitea's release downloads carry no CORS header, so the page asks the API from the browser only if Caddy, in front of Gitea, allows this origin:
```caddy
@releases {
method GET HEAD
path /twisla/roro9stack/releases/download/* /api/v1/repos/twisla/roro9stack/releases*
}
header @releases Access-Control-Allow-Origin "https://roro9stack.net"
header @releases Vary Origin
```
Without it the page says it can't reach the release server and points to the esptool steps.
- **No third-party requests.** Fonts and the flasher library are served from here; `tools/check_site.py` fails the build if a page loads anything from another origin.
- **Illustrations.** `templates/illustrations/*.html` are generated by `tools/make_illustrations.py`; run it again rather than editing them.
- **Updating the flasher library:** see `static/vendor/esp-web-tools/README.txt`.
- **Fonts** are DM Mono and Hanken Grotesk, under the SIL Open Font License (the licences are in `static/fonts/`).
+26
View File
@@ -0,0 +1,26 @@
# roro9stack.net (docs/milestones/W1.md). Build with `zola build`; the web server pulls main and does this.
base_url = "https://roro9stack.net"
title = "roro9stack"
description = "Open firmware for the M5Stack Cardputer ADV with the Cap LoRa-1262: a LoRa scanner, GNSS, a Gemini browser, IRC, Wi-Fi tools, notes and more."
default_language = "en"
compile_sass = false
build_search_index = false
generate_feeds = false
# The built site goes to public/ at the root of the repository (git ignores it), whether Zola is run
# from site/ or from the root with `--root site`.
output_dir = "../public"
[markdown]
smart_punctuation = false
[markdown.highlighting]
# Classes instead of inline colours; Zola 0.22 still wants a theme and writes giallo.css, which the
# templates don't link.
style = "class"
theme = "nord"
[extra]
repo = "https://git.twis.la/twisla/roro9stack"
api = "https://git.twis.la/api/v1/repos/twisla/roro9stack"
blog = "https://experiments.twis.la"
contact = "contact@roro9stack.net"
+4
View File
@@ -0,0 +1,4 @@
+++
title = "roro9stack"
template = "index.html"
+++
+5
View File
@@ -0,0 +1,5 @@
+++
title = "Downloads"
description = "Every release of roro9stack: the signed update file, the factory image for USB, and what changed."
template = "downloads.html"
+++
+41
View File
@@ -0,0 +1,41 @@
+++
title = "Install roro9stack"
description = "Flash roro9stack onto an M5Stack Cardputer ADV from your browser, or with esptool."
template = "install.html"
+++
## Before you start
- An **M5Stack Cardputer ADV**, and a **USB-C cable that carries data** (a charge-only cable won't show up).
- **Chrome or Edge on a desktop computer.** Flashing from a page uses Web Serial, which Firefox and Safari don't have. Without it, use esptool below.
- The **Cap LoRa-1262** is optional for the install: the LoRa Scanner and GNSS need it, the other Apps don't.
## Flash it
1. **Put the Cardputer in download mode.** Hold **G0**, the button next to the screen, while you plug in the USB-C cable.
2. Press **Install roro9stack** above, choose the Cardputer in the list of serial ports (it's usually named after its chip, *ESP32-S3*, or *USB JTAG/serial debug unit*), and confirm.
3. Wait for it to finish, and don't unplug it.
4. The Cardputer restarts into a short **first-boot setup**: a name, a short name for the mesh, your region and your time zone. An interrupted setup simply starts again at the next boot.
Flashing writes the firmware. What's on the SD card isn't touched.
## Without Chrome: esptool
Download the file ending in `-factory.bin` from [the downloads](/downloads/), put the Cardputer in download mode as above, and write it at offset 0:
```sh
pip install esptool
esptool --chip esp32s3 write-flash 0x0 roro9stack-<version>-factory.bin
```
With esptool 4, the command is `esptool.py --chip esp32s3 write_flash 0x0 …`. On Linux your user needs access to the serial port: `sudo usermod -aG dialout "$USER"`, then log out and back in. The file's SHA-256 is listed above and in the release's `SHA256SUMS`.
## After the first boot
- **Wi-Fi:** Settings → Wi-Fi → add your network.
- **Updates:** Settings → Firmware shows the latest release and installs it from the project's server, with no computer. It runs the new firmware on Probation and goes back by itself if it doesn't hold.
- **Something went wrong:** hold G0 while plugging in USB, and flash again. A device that keeps crashing starts in Safe Mode, where Wi-Fi and updates still work.
## Why this page loads from git.twis.la
The flasher asks the project's own Gitea for the latest release and gives the browser that release's factory image. Nothing is copied to this site, and a new release appears here as soon as it exists.
+75
View File
@@ -0,0 +1,75 @@
# The App cards on the home page. Each says what the firmware does today (docs/milestones/W1.md, Q185):
# what isn't built is marked planned, with its milestone. `icon` is a cell of static/img/icons-*.svg.
[[app]]
num = "01"
tag = "LoRa Scanner"
title = "See what is on the air"
text = "Lists every packet it hears with time, RSSI, SNR, sender and hops, reading the Meshtastic header. A Sweep shows signal strength from 863 to 870 MHz. Capture to a pcap for Wireshark."
fact = "Only listens, never transmits"
icon = 1
[[app]]
num = "02"
tag = "GNSS"
title = "Find your place in the sky"
text = "Position and Sky views show where you are and which satellites you can see. Tracks save to the SD card as GPX, and the clock follows the fix."
fact = "Sky view and GPX Tracks"
icon = 2
[[app]]
num = "03"
tag = "Gemini"
title = "Browse Geminispace"
text = "Follow links with Tab and Enter, go Back to where you were, bookmark pages and save them to the SD card to read offline."
fact = "Certificates trusted on first use"
icon = 4
[[app]]
num = "04"
tag = "IRC"
title = "Chat from the keyboard"
text = "Join channels and type commands as you would anywhere, with daily logs written to the SD card."
fact = "Logs to SD"
icon = 5
[[app]]
num = "05"
tag = "Wi-Fi tools"
title = "Scan the air for networks"
text = "See the networks around you, sort and filter the list, and log scans to a CSV file on the SD card."
fact = "Scans log to CSV"
icon = 3
[[app]]
num = "06"
tag = "Notes"
title = "Write it down"
text = "Keep plain text notes on the SD card. There is no save key: the editor writes five seconds after you stop typing, through a temporary file, so a power cut never costs the note."
fact = "Plain .txt files in /notes"
icon = 6
[[app]]
num = "07"
tag = "Storage"
title = "Manage the SD card"
text = "Browse, copy, cut, rename and delete with a clipboard. Copies run in the background and Back cancels one. Opens text, hex, captures, tracks and update files."
fact = "Checks every copy by size"
icon = 8
[[app]]
num = "08"
tag = "System"
title = "Watch it think"
text = "Per-core load, every task and its spare stack, free heap, network traffic, battery and chip temperature, live."
fact = "Live and read-only"
icon = 7
[[app]]
num = "09"
tag = "Planned"
title = "A mesh messenger"
text = "Sending and reading messages on a Meshtastic-compatible mesh. The radio listens today, in the LoRa Scanner; transmitting is the next step and waits for a second node to test with."
fact = "Milestones M4 and M5 · not built yet"
icon = 0
planned = true
+40
View File
@@ -0,0 +1,40 @@
# Real screenshots (the Debug Console's `screenshot` command, 240 x 135 pixels, shown at twice that).
[[screen]]
file = "sweep.png"
alt = "The LoRa Scanner's Sweep view: bars of signal strength from 863.0 to 870.0 MHz with peak marks, a waterfall under them, and a footer reading floor -100, 863.2 MHz at -89 dBm"
caption = "LoRa Scanner, Sweep"
[[screen]]
file = "sniffer.png"
alt = "The LoRa Scanner's packet list on LongFast 869.525 MHz while a Capture is recording: three packets, each with its time, RSSI, SNR and Meshtastic sender and hops"
caption = "LoRa Scanner, packets"
[[screen]]
file = "sky.png"
alt = "The GNSS App's sky view: a circle with the satellites of four constellations as coloured dots, and a legend counting them: GPS 7 of 10, GLONASS 5 of 5, Galileo 1 of 1, BeiDou 4 of 5, 3D Fix"
caption = "GNSS, sky"
[[screen]]
file = "gemini.png"
alt = "The Gemini App on the page Project Gemini at geminiprotocol.net: a heading, then the start of the text, Gemini in 100 words"
caption = "Gemini"
[[screen]]
file = "system.png"
alt = "The System App's overview: Core 0 at 47 percent, Core 1 at 64 percent, memory 49 KB free, network, battery 97 percent, uptime, and a graph of both cores over two minutes"
caption = "System"
[[screen]]
file = "notes.png"
alt = "The Notes editor on shopping-list.txt, 66 bytes, saved: Shopping list, milk, and a longer line that wraps on the screen"
caption = "Notes"
[[screen]]
file = "storage.png"
alt = "The Storage App at the top of the SD card: the folders captures, gemini, gnss, irc, updates and wifi, and a Maintenance row, with 7.3 GB free"
caption = "Storage"
[[screen]]
file = "update.png"
alt = "The full-screen progress of a firmware update: Receiving v0.10.0, a bar at 28 percent"
caption = "A firmware update"
+6
View File
@@ -0,0 +1,6 @@
# Security contact for roro9stack.net and the roro9stack firmware (RFC 9116).
# Please report vulnerabilities privately by email, not in the public issue tracker.
Contact: mailto:contact@roro9stack.net
Expires: 2027-09-30T00:00:00.000Z
Preferred-Languages: en, fr
Canonical: https://roro9stack.net/.well-known/security.txt
Binary file not shown.

After

Width:  |  Height:  |  Size: 555 B

+234
View File
@@ -0,0 +1,234 @@
/* roro9stack.net: the tokens and shapes of the design (docs/milestones/W1.md). Every colour is on the
device's RGB332 grid. Dark is the default; a visitor who prefers light gets light, and the switch
in the header overrides both. */
@font-face { font-family: "DM Mono"; src: url(/fonts/DMMono-Regular.woff2) format("woff2"); font-weight: 400; font-style: normal; font-display: swap; }
@font-face { font-family: "DM Mono"; src: url(/fonts/DMMono-Medium.woff2) format("woff2"); font-weight: 500; font-style: normal; font-display: swap; }
@font-face { font-family: "Hanken Grotesk"; src: url(/fonts/HankenGrotesk.woff2) format("woff2"); font-weight: 100 900; font-style: normal; font-display: swap; }
:root {
--mono: "DM Mono", ui-monospace, "SFMono-Regular", Menlo, Consolas, monospace;
--sans: "Hanken Grotesk", system-ui, -apple-system, "Segoe UI", sans-serif;
color-scheme: dark;
--s1: #494955; --s2: #000000; --s3: #6d6d55; --line: #6d6d55; --ls: #b6b6aa;
--ink: #ffffff; --muted: #b6dbff;
--cyan: #00dbff; --onfill: #000055; --cyandeep: #00dbff; --cyantext: #00dbff;
--mag: #ff00ff; --magtext: #ff92ff; --orange: #ff9200; --orangetext: #ffb655;
--icons: url(/img/icons-dark.svg);
--logo-dark: block; --logo-light: none;
}
@media (prefers-color-scheme: light) {
:root:not([data-theme="dark"]) {
color-scheme: light;
--s1: #ffffff; --s2: #dbffff; --s3: #b6dbff; --line: #92b6ff; --ls: #6d6daa;
--ink: #000055; --muted: #4949aa;
--cyandeep: #0092aa; --cyantext: #006daa; --magtext: #b600aa; --orangetext: #b64900;
--icons: url(/img/icons-light.svg);
--logo-dark: none; --logo-light: block;
}
}
:root[data-theme="light"] {
color-scheme: light;
--s1: #ffffff; --s2: #dbffff; --s3: #b6dbff; --line: #92b6ff; --ls: #6d6daa;
--ink: #000055; --muted: #4949aa;
--cyandeep: #0092aa; --cyantext: #006daa; --magtext: #b600aa; --orangetext: #b64900;
--icons: url(/img/icons-light.svg);
--logo-dark: none; --logo-light: block;
}
* { box-sizing: border-box; }
html { -webkit-text-size-adjust: 100%; scroll-behavior: smooth; }
@media (prefers-reduced-motion: reduce) { html { scroll-behavior: auto; } }
body { margin: 0; background: var(--s1); color: var(--ink); font: 400 16px/24px var(--sans); }
a { color: inherit; text-decoration: none; }
a:hover { text-decoration: underline; text-underline-offset: 4px; }
img { max-width: 100%; height: auto; }
h1, h2, h3, p, ul, ol, figure, dl, dd { margin: 0; }
ul, ol { padding: 0; list-style: none; }
/* A focus ring must show. clip-path clips an outline along with everything else outside the shape,
so a focused notched control drops its notches and shows square corners and its ring. */
:focus-visible { outline: 2px solid var(--cyandeep); outline-offset: 2px; }
.n-sm:focus-visible, .n-md:focus-visible, .n-lg:focus-visible { clip-path: none; }
.skip { position: absolute; left: 8px; top: -60px; z-index: 10; background: var(--cyan); color: var(--onfill); padding: 12px 16px; font: 500 14px/20px var(--mono); }
.skip:focus { top: 8px; }
/* Notched corners: whole steps on a 4px grid (the device draws no curves). */
.n-sm { clip-path: polygon(0 4px,4px 4px,4px 0,calc(100% - 4px) 0,calc(100% - 4px) 4px,100% 4px,100% calc(100% - 4px),calc(100% - 4px) calc(100% - 4px),calc(100% - 4px) 100%,4px 100%,4px calc(100% - 4px),0 calc(100% - 4px)); }
.n-md { clip-path: polygon(0 8px,4px 8px,4px 4px,8px 4px,8px 0,calc(100% - 8px) 0,calc(100% - 8px) 4px,calc(100% - 4px) 4px,calc(100% - 4px) 8px,100% 8px,100% calc(100% - 8px),calc(100% - 4px) calc(100% - 8px),calc(100% - 4px) calc(100% - 4px),calc(100% - 8px) calc(100% - 4px),calc(100% - 8px) 100%,8px 100%,8px calc(100% - 4px),4px calc(100% - 4px),4px calc(100% - 8px),0 calc(100% - 8px)); }
.n-lg { clip-path: polygon(0 16px,8px 16px,8px 8px,16px 8px,16px 0,calc(100% - 16px) 0,calc(100% - 16px) 8px,calc(100% - 8px) 8px,calc(100% - 8px) 16px,100% 16px,100% calc(100% - 16px),calc(100% - 8px) calc(100% - 16px),calc(100% - 8px) calc(100% - 8px),calc(100% - 16px) calc(100% - 8px),calc(100% - 16px) 100%,16px 100%,16px calc(100% - 8px),8px calc(100% - 8px),8px calc(100% - 16px),0 calc(100% - 16px)); }
.wrap { width: 100%; max-width: 1200px; margin: 0 auto; padding-left: 32px; padding-right: 32px; }
.mono { font-family: var(--mono); }
/* Header */
.bar { display: flex; flex-wrap: wrap; align-items: center; justify-content: space-between; gap: 16px; padding-top: 24px; padding-bottom: 24px; }
.brand { display: flex; align-items: center; min-height: 44px; }
.logo { height: 28px; width: auto; }
.logo-dark { display: var(--logo-dark); }
.logo-light { display: var(--logo-light); }
.bar nav { display: flex; flex-wrap: wrap; align-items: center; gap: 8px; }
.bar nav a, .link-btn { display: inline-flex; align-items: center; min-height: 44px; padding: 0 12px; font: 400 14px/20px var(--mono); }
.link-btn { background: none; border: 0; color: inherit; cursor: pointer; }
.link-btn:hover { text-decoration: underline; text-underline-offset: 4px; }
.js-only { display: none; }
.js .js-only { display: inline-flex; }
/* Buttons */
.btn { display: inline-flex; align-items: center; justify-content: center; min-height: 48px; padding: 0 24px; font: 500 14px/20px var(--mono); border: 0; cursor: pointer; }
.btn:hover { text-decoration: none; filter: brightness(1.08); }
.btn-primary { background: var(--cyan); color: var(--onfill); }
.btn-secondary { background: var(--s2); color: var(--ink); }
.bar nav a.btn { min-height: 44px; padding: 0 20px; }
.bar nav a.btn:hover { text-decoration: none; }
/* Type */
.eyebrow { font: 500 12px/16px var(--mono); letter-spacing: .08em; text-transform: uppercase; color: var(--cyantext); }
.eyebrow-row { display: flex; align-items: center; gap: 8px; }
.eyebrow .v { text-transform: none; }
.dot { width: 8px; height: 8px; background: var(--cyan); flex: none; }
h1, h2 { font-family: var(--mono); font-weight: 500; }
h1 { font-size: 64px; line-height: 64px; letter-spacing: -.02em; }
h2 { font-size: 40px; line-height: 44px; letter-spacing: -.01em; }
h3 { font-size: 24px; line-height: 30px; font-weight: 600; }
.accent { color: var(--cyantext); }
.lead { font-size: 18px; line-height: 28px; max-width: 520px; }
.muted { color: var(--muted); }
.small { font-size: 14px; line-height: 20px; }
.caption { font: 400 12px/16px var(--mono); color: var(--muted); }
code, .code { font-family: var(--mono); font-size: .9em; }
section { padding-top: 64px; padding-bottom: 64px; }
.section-head { display: flex; flex-direction: column; gap: 12px; max-width: 680px; }
.stack { display: flex; flex-direction: column; gap: 24px; }
/* Hero */
.hero { padding-top: 48px; padding-bottom: 32px; display: flex; flex-direction: column; gap: 48px; }
.hero-grid { display: flex; flex-wrap: wrap; align-items: flex-end; gap: 32px 56px; }
.hero-grid > div { flex: 1 1 360px; min-width: 0; display: flex; flex-direction: column; gap: 24px; }
.hero-grid > div:first-child { flex-basis: 480px; }
.actions { display: flex; flex-wrap: wrap; gap: 16px; }
.facts { display: flex; flex-wrap: wrap; gap: 8px 24px; }
.facts li { display: flex; align-items: center; gap: 8px; font: 400 14px/20px var(--mono); color: var(--muted); }
.facts li::before { content: ""; width: 8px; height: 8px; background: var(--mag); display: block; }
.slab { background: var(--cyan); padding: 40px; display: flex; flex-wrap: wrap; gap: 32px; }
.slab .device { flex: 1 1 440px; min-width: 0; }
.illustration { display: block; width: 100%; height: auto; }
.illustration .mono { font-family: var(--mono); }
.hero .caption { margin-top: -36px; }
/* Panels */
.panel { background: var(--s2); padding: 32px; }
.status-box { background: var(--s2); padding: 24px 32px; display: flex; flex-wrap: wrap; align-items: baseline; gap: 8px 24px; }
.status-box .eyebrow { color: var(--orangetext); }
.status-box p { flex: 1 1 420px; min-width: 0; }
.status-box a, .prose a, .steps a, .need a { color: var(--cyantext); text-decoration: underline; text-underline-offset: 4px; }
.need { display: grid; grid-template-columns: repeat(auto-fit, minmax(200px, 1fr)); gap: 24px; margin-top: 32px; }
.need li { display: flex; flex-direction: column; gap: 4px; padding-left: 16px; border-left: 4px solid var(--cyan); }
.need strong { font-weight: 600; }
.need span { color: var(--muted); }
/* App cards */
.cards { display: flex; flex-wrap: wrap; gap: 24px; margin-top: 40px; }
.card { flex: 1 1 320px; min-width: 0; background: var(--s2); padding: 32px; display: flex; flex-direction: column; gap: 16px; }
.card-top { display: flex; justify-content: space-between; align-items: center; }
.card .tag { font: 500 12px/16px var(--mono); letter-spacing: .08em; text-transform: uppercase; color: var(--cyantext); }
.card .num { font: 500 12px/16px var(--mono); letter-spacing: .08em; color: var(--muted); }
.card p { color: var(--muted); }
.card .fact { margin-top: auto; padding-top: 8px; display: flex; align-items: center; gap: 8px; font: 500 12px/16px var(--mono); letter-spacing: .04em; }
.card .fact::before { content: ""; width: 8px; height: 8px; background: var(--cyan); flex: none; }
.card.planned .tag { color: var(--orangetext); }
.card.planned .fact::before { background: var(--orange); }
.ic { width: 48px; height: 48px; flex: none; background-image: var(--icons); background-repeat: no-repeat; background-size: 144px 192px; image-rendering: pixelated; }
.i0 { background-position: 0 0; } .i1 { background-position: -48px 0; } .i2 { background-position: -96px 0; }
.i3 { background-position: 0 -48px; } .i4 { background-position: -48px -48px; } .i5 { background-position: -96px -48px; }
.i6 { background-position: 0 -96px; } .i7 { background-position: -48px -96px; } .i8 { background-position: -96px -96px; }
.i9 { background-position: 0 -144px; }
.cards-note { margin-top: 24px; font-size: 14px; line-height: 20px; color: var(--muted); }
/* Real screenshots */
.shots { display: grid; grid-template-columns: repeat(auto-fill, minmax(260px, 1fr)); gap: 24px; margin-top: 40px; }
.shot { background: var(--s2); padding: 16px; display: flex; flex-direction: column; gap: 12px; }
.shot img { display: block; width: 100%; height: auto; } /* shown at about half size: smoothed, not pixel-doubled */
.shot figcaption { font: 500 12px/16px var(--mono); letter-spacing: .08em; text-transform: uppercase; color: var(--muted); }
/* Updates */
.split { display: flex; flex-wrap: wrap; gap: 48px; }
.split > div { flex: 1 1 380px; min-width: 0; display: flex; flex-direction: column; gap: 24px; }
.split > .aside { flex-basis: 420px; justify-content: center; gap: 32px; }
.updates { background: var(--s2); padding: 48px; }
.terminal { background: var(--s1); padding: 16px 20px; font: 400 14px/20px var(--mono); overflow-x: auto; white-space: pre; }
.terminal .p { color: var(--cyantext); }
.terminal .c { color: var(--muted); }
.num-row { display: flex; flex-wrap: wrap; align-items: baseline; gap: 8px 24px; }
.num-row .big { flex: none; min-width: 160px; font: 500 64px/64px var(--mono); letter-spacing: -.02em; }
.num-row p { flex: 1 1 200px; min-width: 0; color: var(--muted); }
.big.c1 { color: var(--cyantext); } .big.c2 { color: var(--magtext); }
.split > .blocks { display: flex; flex-direction: column; gap: 4px; background: var(--s2); padding: 32px; font: 400 14px/20px var(--mono); overflow-x: auto; white-space: pre; }
.split > .blocks .gap { height: 16px; }
.split > .blocks .c { color: var(--muted); }
.split > .blocks .p { color: var(--cyantext); }
/* Call to action */
.cta { background: var(--cyan); color: var(--onfill); padding: 48px; display: flex; flex-wrap: wrap; align-items: center; justify-content: space-between; gap: 40px; }
.cta > div:not(.nine) { flex: 1 1 360px; min-width: 0; display: flex; flex-direction: column; gap: 20px; }
.cta p { font-size: 18px; line-height: 28px; max-width: 480px; }
.cta .btn { background: #000055; color: #ffffff; }
.nine { display: grid; grid-template-columns: repeat(5, 24px); gap: 4px; }
.nine i { display: block; width: 24px; height: 24px; }
.nine i.on { background: var(--s1); }
/* Footer */
footer .wrap { padding-top: 32px; padding-bottom: 64px; display: flex; flex-direction: column; gap: 24px; }
.foot-row { display: flex; flex-wrap: wrap; align-items: center; justify-content: space-between; gap: 16px; }
.foot-row span, footer small { font: 400 14px/20px var(--mono); color: var(--muted); }
footer nav { display: flex; flex-wrap: wrap; gap: 8px; }
footer nav a { display: inline-flex; align-items: center; min-height: 44px; padding: 0 12px; font: 400 14px/20px var(--mono); }
footer small { display: block; max-width: 760px; }
/* Pages: Install, Downloads, 404 */
.page { padding-top: 32px; padding-bottom: 64px; display: flex; flex-direction: column; gap: 40px; }
.page h1 { font-size: 48px; line-height: 52px; }
.page h2 { font-size: 32px; line-height: 36px; }
.prose { max-width: 720px; display: flex; flex-direction: column; gap: 16px; }
.prose h2 { margin-top: 24px; }
.prose ul { list-style: disc; padding-left: 24px; display: flex; flex-direction: column; gap: 8px; }
.prose ol, .steps { list-style: decimal; padding-left: 24px; display: flex; flex-direction: column; gap: 12px; }
.prose pre { margin: 0; padding: 16px 20px; background: var(--s2); font: 400 14px/20px var(--mono); overflow-x: auto; clip-path: polygon(0 8px,4px 8px,4px 4px,8px 4px,8px 0,calc(100% - 8px) 0,calc(100% - 8px) 4px,calc(100% - 4px) 4px,calc(100% - 4px) 8px,100% 8px,100% calc(100% - 8px),calc(100% - 4px) calc(100% - 8px),calc(100% - 4px) calc(100% - 4px),calc(100% - 8px) calc(100% - 4px),calc(100% - 8px) 100%,8px 100%,8px calc(100% - 4px),4px calc(100% - 4px),4px calc(100% - 8px),0 calc(100% - 8px)); }
.prose pre code { font-size: 14px; }
.prose :not(pre) > code { background: var(--s2); padding: 0 6px; }
.prose table { border-collapse: collapse; width: 100%; }
.prose th, .prose td { text-align: left; padding: 8px 12px; border-bottom: 1px solid var(--line); vertical-align: top; }
.flasher { background: var(--s2); padding: 32px; display: flex; flex-direction: column; gap: 20px; max-width: 720px; }
.flasher dl { display: grid; grid-template-columns: max-content 1fr; gap: 4px 20px; font: 400 14px/20px var(--mono); }
.flasher dt { color: var(--muted); }
.flasher dd { overflow-wrap: anywhere; }
.flasher [hidden] { display: none !important; }
.flasher .msg { color: var(--orangetext); }
.hash { word-break: break-all; }
.releases { display: flex; flex-direction: column; gap: 24px; }
.release { background: var(--s2); padding: 24px 32px; display: flex; flex-direction: column; gap: 12px; max-width: 880px; }
.release h2 { font-size: 28px; line-height: 32px; }
.release .meta { font: 400 14px/20px var(--mono); color: var(--muted); }
.release .files { display: flex; flex-wrap: wrap; gap: 8px 20px; font: 400 14px/20px var(--mono); }
.release .files a { color: var(--cyantext); text-decoration: underline; text-underline-offset: 4px; }
@media (max-width: 720px) {
h1 { font-size: 40px; line-height: 44px; }
h2 { font-size: 32px; line-height: 36px; }
.wrap { padding-left: 20px; padding-right: 20px; }
section { padding-top: 48px; padding-bottom: 48px; }
.slab, .updates, .cta { padding: 24px; }
.panel, .card { padding: 24px; }
.hero .caption { margin-top: -24px; }
.num-row .big { font-size: 48px; line-height: 48px; min-width: 120px; }
}
.accent-link { color: var(--cyantext); text-decoration: underline; text-underline-offset: 4px; }
.page > header { display: flex; flex-direction: column; gap: 12px; }
.page .lead { max-width: 720px; }
Binary file not shown.

After

Width:  |  Height:  |  Size: 302 B

Binary file not shown.
Binary file not shown.
Binary file not shown.
+93
View File
@@ -0,0 +1,93 @@
Copyright 2020 The DM Mono Project Authors (https://www.github.com/googlefonts/dm-mono)
This Font Software is licensed under the SIL Open Font License, Version 1.1.
This license is copied below, and is also available with a FAQ at:
http://scripts.sil.org/OFL
-----------------------------------------------------------
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
-----------------------------------------------------------
PREAMBLE
The goals of the Open Font License (OFL) are to stimulate worldwide
development of collaborative font projects, to support the font creation
efforts of academic and linguistic communities, and to provide a free and
open framework in which fonts may be shared and improved in partnership
with others.
The OFL allows the licensed fonts to be used, studied, modified and
redistributed freely as long as they are not sold by themselves. The
fonts, including any derivative works, can be bundled, embedded,
redistributed and/or sold with any software provided that any reserved
names are not used by derivative works. The fonts and derivatives,
however, cannot be released under any other type of license. The
requirement for fonts to remain under this license does not apply
to any document created using the fonts or their derivatives.
DEFINITIONS
"Font Software" refers to the set of files released by the Copyright
Holder(s) under this license and clearly marked as such. This may
include source files, build scripts and documentation.
"Reserved Font Name" refers to any names specified as such after the
copyright statement(s).
"Original Version" refers to the collection of Font Software components as
distributed by the Copyright Holder(s).
"Modified Version" refers to any derivative made by adding to, deleting,
or substituting -- in part or in whole -- any of the components of the
Original Version, by changing formats or by porting the Font Software to a
new environment.
"Author" refers to any designer, engineer, programmer, technical
writer or other person who contributed to the Font Software.
PERMISSION & CONDITIONS
Permission is hereby granted, free of charge, to any person obtaining
a copy of the Font Software, to use, study, copy, merge, embed, modify,
redistribute, and sell modified and unmodified copies of the Font
Software, subject to the following conditions:
1) Neither the Font Software nor any of its individual components,
in Original or Modified Versions, may be sold by itself.
2) Original or Modified Versions of the Font Software may be bundled,
redistributed and/or sold with any software, provided that each copy
contains the above copyright notice and this license. These can be
included either as stand-alone text files, human-readable headers or
in the appropriate machine-readable metadata fields within text or
binary files as long as those fields can be easily viewed by the user.
3) No Modified Version of the Font Software may use the Reserved Font
Name(s) unless explicit written permission is granted by the corresponding
Copyright Holder. This restriction only applies to the primary font name as
presented to the users.
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
Software shall not be used to promote, endorse or advertise any
Modified Version, except to acknowledge the contribution(s) of the
Copyright Holder(s) and the Author(s) or with their explicit written
permission.
5) The Font Software, modified or unmodified, in part or in whole,
must be distributed entirely under this license, and must not be
distributed under any other license. The requirement for fonts to
remain under this license does not apply to any document created
using the Font Software.
TERMINATION
This license becomes null and void if any of the above conditions are
not met.
DISCLAIMER
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
OTHER DEALINGS IN THE FONT SOFTWARE.
+94
View File
@@ -0,0 +1,94 @@
Copyright 2021 The Hanken Grotesk Project Authors (https://github.com/marcologous/hanken-grotesk)
This Font Software is licensed under the SIL Open Font License, Version 1.1.
This license is copied below, and is also available with a FAQ at:
http://scripts.sil.org/OFL
-----------------------------------------------------------
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
-----------------------------------------------------------
PREAMBLE
The goals of the Open Font License (OFL) are to stimulate worldwide
development of collaborative font projects, to support the font creation
efforts of academic and linguistic communities, and to provide a free and
open framework in which fonts may be shared and improved in partnership
with others.
The OFL allows the licensed fonts to be used, studied, modified and
redistributed freely as long as they are not sold by themselves. The
fonts, including any derivative works, can be bundled, embedded,
redistributed and/or sold with any software provided that any reserved
names are not used by derivative works. The fonts and derivatives,
however, cannot be released under any other type of license. The
requirement for fonts to remain under this license does not apply
to any document created using the fonts or their derivatives.
DEFINITIONS
"Font Software" refers to the set of files released by the Copyright
Holder(s) under this license and clearly marked as such. This may
include source files, build scripts and documentation.
"Reserved Font Name" refers to any names specified as such after the
copyright statement(s).
"Original Version" refers to the collection of Font Software components as
distributed by the Copyright Holder(s).
"Modified Version" refers to any derivative made by adding to, deleting,
or substituting -- in part or in whole -- any of the components of the
Original Version, by changing formats or by porting the Font Software to a
new environment.
"Author" refers to any designer, engineer, programmer, technical
writer or other person who contributed to the Font Software.
PERMISSION & CONDITIONS
Permission is hereby granted, free of charge, to any person obtaining
a copy of the Font Software, to use, study, copy, merge, embed, modify,
redistribute, and sell modified and unmodified copies of the Font
Software, subject to the following conditions:
1) Neither the Font Software nor any of its individual components,
in Original or Modified Versions, may be sold by itself.
2) Original or Modified Versions of the Font Software may be bundled,
redistributed and/or sold with any software, provided that each copy
contains the above copyright notice and this license. These can be
included either as stand-alone text files, human-readable headers or
in the appropriate machine-readable metadata fields within text or
binary files as long as those fields can be easily viewed by the user.
3) No Modified Version of the Font Software may use the Reserved Font
Name(s) unless explicit written permission is granted by the corresponding
Copyright Holder. This restriction only applies to the primary font name as
presented to the users.
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
Software shall not be used to promote, endorse or advertise any
Modified Version, except to acknowledge the contribution(s) of the
Copyright Holder(s) and the Author(s) or with their explicit written
permission.
5) The Font Software, modified or unmodified, in part or in whole,
must be distributed entirely under this license, and must not be
distributed under any other license. The requirement for fonts to
remain under this license does not apply to any document created
using the Font Software.
TERMINATION
This license becomes null and void if any of the above conditions are
not met.
DISCLAIMER
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
OTHER DEALINGS IN THE FONT SOFTWARE.
+213
View File
@@ -0,0 +1,213 @@
/*
* theme "nord" generated by giallo
*/
.z-code {
color: #D8DEE9;
background-color: #2E3440;
}
.z-hl {
background-color: #3B4252;
}
.giallo-ln {
color: #4C566A;
}
.z-emphasis { font-style: italic; }
.z-strong { font-weight: bold; }
.z-comment { color: #616E88; }
.z-keyword { color: #81A1C1; }
.z-punctuation { color: #ECEFF4; }
.z-storage { color: #81A1C1; }
.z-string { color: #A3BE8C; }
.z-punctuation { color: #5E81AC; }
.z-constant.z-character { color: #EBCB8B; }
.z-constant.z-language { color: #81A1C1; }
.z-constant.z-numeric { color: #B48EAD; }
.z-constant.z-regexp { color: #EBCB8B; }
.z-invalid.z-deprecated { color: #D8DEE9; background-color: #EBCB8B; }
.z-invalid.z-illegal { color: #D8DEE9; background-color: #BF616A; }
.z-keyword.z-operator { color: #81A1C1; }
.z-markup.z-bold { font-weight: bold; }
.z-markup.z-changed { color: #EBCB8B; }
.z-markup.z-deleted { color: #BF616A; }
.z-markup.z-inserted { color: #A3BE8C; }
.z-meta.z-preprocessor { color: #5E81AC; }
.z-punctuation.z-section { color: #ECEFF4; }
.z-punctuation.z-terminator { color: #81A1C1; }
.z-string.z-regexp { color: #EBCB8B; }
.z-support.z-class { color: #8FBCBB; }
.z-support.z-constant { color: #81A1C1; }
.z-support.z-function { color: #88C0D0; }
.z-support.z-type { color: #8FBCBB; }
.z-token.z-debug-token { color: #B48EAD; }
.z-token.z-error-token { color: #BF616A; }
.z-token.z-info-token { color: #88C0D0; }
.z-token.z-warn-token { color: #EBCB8B; }
.z-variable.z-other { color: #D8DEE9; }
.z-variable.z-language { color: #81A1C1; }
.z-variable.z-parameter { color: #D8DEE9; }
.z-markup.z-heading { color: #88C0D0; }
.z-meta.z-property-value { color: #88C0D0; }
.z-constant.z-other { color: #D8DEE9; }
.z-storage.z-type { color: #8FBCBB; }
.z-punctuation.z-decorator { color: #D08770; }
.z-markup.z-italic { font-style: italic; }
.z-markup.z-quote { color: #616E88; }
.z-meta.z-function-call { color: #88C0D0; }
.z-support.z-type { color: #88C0D0; }
.z-meta.z-attribute { color: #5E81AC; }
.z-variable.z-interpolation { color: #D8DEE9; font-style: italic; }
.z-punctuation.z-decorator { color: #D08770; }
.z-punctuation.z-decorator { color: #D08770; }
.z-support.z-class { color: #8FBCBB; }
.z-support.z-type { color: #8FBCBB; }
.z-support.z-class { color: #8FBCBB; }
.z-support.z-type { color: #8FBCBB; }
.z-support.z-variable { color: #D8DEE9; }
.z-support.z-variable { color: #D8DEE9; }
.z-meta.z-method { color: #88C0D0; }
.z-punctuation.z-definition { color: #8FBCBB; }
.z-support.z-type { color: #D08770; }
.z-keyword.z-operator { color: #5E81AC; }
.z-constant.z-character.z-escape { color: #EBCB8B; }
.z-entity.z-name.z-class { color: #8FBCBB; }
.z-entity.z-name.z-function { color: #88C0D0; }
.z-entity.z-name.z-tag { color: #81A1C1; }
.z-entity.z-other.z-attribute-name { color: #8FBCBB; }
.z-entity.z-other.z-inherited-class { color: #8FBCBB; font-weight: bold; }
.z-keyword.z-other.z-new { color: #81A1C1; }
.z-punctuation.z-definition.z-method-parameters { color: #ECEFF4; }
.z-punctuation.z-definition.z-function-parameters { color: #ECEFF4; }
.z-punctuation.z-definition.z-parameters { color: #ECEFF4; }
.z-punctuation.z-definition.z-tag { color: #81A1C1; }
.z-punctuation.z-definition.z-comment { color: #616E88; }
.z-punctuation.z-definition.z-variable { color: #81A1C1; }
.z-support.z-function.z-construct { color: #81A1C1; }
.z-support.z-type.z-exception { color: #8FBCBB; }
.z-meta.z-preprocessor.z-include { color: #8FBCBB; }
.z-punctuation.z-definition.z-directive { color: #5E81AC; font-weight: bold; }
.z-punctuation.z-definition.z-directive { color: #5E81AC; font-weight: bold; }
.z-punctuation.z-definition.z-keyword { color: #81A1C1; }
.z-support.z-type.z-property-name { color: #D8DEE9; }
.z-punctuation.z-definition.z-from-file { color: #8FBCBB; }
.z-punctuation.z-definition.z-range { color: #8FBCBB; }
.z-punctuation.z-definition.z-separator { color: #81A1C1; }
.z-keyword.z-other.z-documentation { color: #8FBCBB; }
.z-storage.z-modifier.z-import { color: #8FBCBB; }
.z-storage.z-modifier.z-package { color: #8FBCBB; }
.z-storage.z-type.z-annotation { color: #D08770; }
.z-storage.z-type.z-generic { color: #8FBCBB; }
.z-storage.z-type.z-primitive { color: #81A1C1; }
.z-meta.z-object-literal.z-key { color: #88C0D0; }
.z-support.z-type.z-primitive { color: #81A1C1; }
.z-variable.z-other.z-object { color: #D8DEE9; }
.z-constant.z-other.z-inline-data { color: #D08770; font-style: italic; }
.z-punctuation.z-definition.z-entity { color: #81A1C1; }
.z-markup.z-fenced_code.z-block { color: #8FBCBB; }
.z-markup.z-inline.z-raw { color: #8FBCBB; }
.z-markup.z-underline.z-link { text-decoration: underline; }
.z-punctuation.z-definition.z-heading { color: #81A1C1; }
.z-punctuation.z-definition.z-constant { color: #81A1C1; }
.z-punctuation.z-definition.z-string { color: #81A1C1; }
.z-punctuation.z-definition.z-variable { color: #D8DEE9; }
.z-meta.z-function-call.z-object { color: #88C0D0; }
.z-meta.z-function-call.z-generic { color: #88C0D0; }
.z-entity.z-name.z-type { color: #8FBCBB; }
.z-punctuation.z-definition.z-interpolation { color: #EBCB8B; }
.z-meta.z-object-literal.z-key { color: #D8DEE9; }
.z-meta.z-object-literal.z-key { color: #D8DEE9; }
.z-entity.z-name.z-type { color: #8FBCBB; }
.z-entity.z-name.z-class { color: #8FBCBB; }
.z-entity.z-name.z-type { color: #8FBCBB; }
.z-entity.z-name.z-class { color: #8FBCBB; }
.z-support.z-constant.z-math { color: #8FBCBB; }
.z-support.z-constant.z-dom { color: #8FBCBB; }
.z-support.z-constant.z-json { color: #8FBCBB; }
.z-support.z-constant.z-math { color: #8FBCBB; }
.z-support.z-constant.z-dom { color: #8FBCBB; }
.z-support.z-constant.z-json { color: #8FBCBB; }
.z-keyword.z-other.z-doctype { color: #5E81AC; }
.z-string.z-unquoted.z-cdata { color: #D08770; font-style: italic; }
.z-entity.z-name.z-tag { color: #8FBCBB; }
.z-punctuation.z-definition.z-keyword { color: #D08770; }
.z-variable.z-other.z-readwrite { color: #D08770; }
.z-entity.z-name.z-function { color: #D08770; }
.z-punctuation.z-definition.z-template-expression { color: #81A1C1; }
.z-meta.z-method-call.z-with-arguments { color: #ECEFF4; }
.z-meta.z-brace.z-square { color: #ECEFF4; }
.z-meta.z-brace.z-round { color: #ECEFF4; }
.z-meta.z-brace.z-square { color: #ECEFF4; }
.z-meta.z-brace.z-round { color: #ECEFF4; }
.z-punctuation.z-definition.z-raw { color: #8FBCBB; }
.z-entity.z-name.z-function { color: #88C0D0; font-weight: bold; }
.z-variable.z-other.z-readwrite { color: #D08770; }
.z-entity.z-name.z-function { color: #D08770; }
.z-variable.z-other.z-readwrite { color: #D08770; }
.z-entity.z-name.z-function { color: #D08770; }
.z-entity.z-name.z-function { color: #88C0D0; }
.z-entity.z-name.z-function { color: #88C0D0; }
.z-meta.z-brace.z-square { color: #ECEFF4; }
.z-meta.z-brace.z-round { color: #ECEFF4; }
.z-meta.z-brace.z-square { color: #ECEFF4; }
.z-meta.z-brace.z-round { color: #ECEFF4; }
.z-entity.z-name.z-tag { color: #5E81AC; }
.z-punctuation.z-definition.z-string { color: #D08770; font-style: italic; }
.z-support.z-variable.z-property { color: #D8DEE9; }
.z-variable.z-other.z-object { color: #D8DEE9; }
.z-entity.z-name.z-type.z-class { color: #8FBCBB; }
.z-punctuation.z-end.z-definition.z-comment { color: #616E88; }
.z-punctuation.z-start.z-definition.z-comment { color: #616E88; }
.z-punctuation.z-section.z-embedded.z-begin { color: #81A1C1; }
.z-punctuation.z-section.z-embedded.z-end { color: #81A1C1; }
.z-punctuation.z-separator.z-pointer-access.z-c { color: #81A1C1; }
.z-constant.z-other.z-symbol.z-elixir { color: #D8DEE9; font-weight: bold; }
.z-variable.z-other.z-constant.z-elixir { color: #8FBCBB; }
.z-keyword.z-control.z-directive.z-conditional { color: #5E81AC; font-weight: bold; }
.z-keyword.z-control.z-directive.z-conditional { color: #5E81AC; font-weight: bold; }
.z-constant.z-other.z-color.z-rgb-value { color: #B48EAD; }
.z-keyword.z-control.z-at-rule.z-media { color: #D08770; }
.z-meta.z-diff.z-range.z-context { color: #8FBCBB; }
.z-meta.z-diff.z-header.z-from-file { color: #8FBCBB; }
.z-constant.z-other.z-placeholder.z-go { color: #EBCB8B; }
.z-keyword.z-other.z-documentation.z-directive { color: #8FBCBB; }
.z-keyword.z-other.z-documentation.z-custom { color: #8FBCBB; }
.z-punctuation.z-definition.z-keyword.z-javadoc { color: #8FBCBB; }
.z-storage.z-type.z-class.z-jsdoc { color: #8FBCBB; }
.z-variable.z-other.z-readwrite.z-alias { color: #8FBCBB; }
.z-constant.z-character.z-entity.z-html { color: #EBCB8B; }
.z-meta.z-tag.z-sgml.z-doctype { color: #5E81AC; }
.z-punctuation.z-separator.z-key-value.z-ini { color: #81A1C1; }
.z-beginning.z-punctuation.z-definition.z-list { color: #81A1C1; }
.z-beginning.z-punctuation.z-definition.z-quote { color: #8FBCBB; }
.z-constant.z-character.z-math.z-tex { color: #81A1C1; }
.z-punctuation.z-definition.z-math.z-begin { color: #5E81AC; }
.z-punctuation.z-definition.z-math.z-end { color: #5E81AC; }
.z-punctuation.z-math.z-operator.z-latex { color: #81A1C1; }
.z-constant.z-other.z-reference.z-link { color: #88C0D0; }
.z-string.z-other.z-link.z-description { color: #88C0D0; }
.z-string.z-other.z-link.z-title { color: #88C0D0; }
.z-entity.z-name.z-function.z-decorator { color: #D08770; }
.z-variable.z-parameter.z-function.z-language { color: #D8DEE9; }
.z-entity.z-name.z-type.z-trait { font-weight: bold; }
.z-entity.z-name.z-tag.z-namespace { color: #8FBCBB; }
.z-punctuation.z-definition.z-entity.z-html { color: #81A1C1; }
.z-punctuation.z-quasi.z-element.z-begin { color: #81A1C1; }
.z-punctuation.z-quasi.z-element.z-end { color: #81A1C1; }
.z-entity.z-name.z-type.z-module.z-elixir { color: #8FBCBB; }
.z-variable.z-other.z-readwrite.z-module.z-elixir { color: #D8DEE9; font-weight: bold; }
.z-string.z-quoted.z-other.z-lt-gt.z-include { color: #8FBCBB; }
.z-keyword.z-other.z-documentation.z-author.z-javadoc { color: #8FBCBB; }
.z-keyword.z-other.z-documentation.z-see.z-javadoc { color: #8FBCBB; }
.z-meta.z-tag.z-template.z-link.z-javadoc { color: #8FBCBB; }
.z-string.z-other.z-link.z-title.z-javadoc { color: #8FBCBB; }
.z-meta.z-tag.z-template.z-value.z-javadoc { color: #88C0D0; }
.z-punctuation.z-definition.z-tag.z-begin.z-javadoc { color: #616E88; }
.z-punctuation.z-definition.z-tag.z-end.z-javadoc { color: #616E88; }
.z-entity.z-name.z-section.z-group-title.z-ini { color: #88C0D0; }
.z-punctuation.z-definition.z-function.z-math.z-tex { color: #88C0D0; }
.z-punctuation.z-definition.z-interpolation.z-begin.z-bracket.z-curly { color: #81A1C1; }
.z-punctuation.z-definition.z-interpolation.z-end.z-bracket.z-curly { color: #81A1C1; }
.z-variable.z-parameter.z-function.z-language.z-special.z-self { color: #81A1C1; }
+1
View File
@@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 7 7" shape-rendering="crispEdges"><rect width="7" height="7" fill="#000055"/><g fill="#00dbff"><rect x="1" y="0" width="3" height="1"/><rect x="0" y="1" width="1" height="2"/><rect x="4" y="1" width="1" height="5"/><rect x="1" y="3" width="3" height="1"/><rect x="0" y="6" width="3" height="1"/></g></svg>

After

Width:  |  Height:  |  Size: 359 B

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 15 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 15 KiB

+1
View File
@@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="-6.0 -78.0 612.0 85.2" role="img" aria-label="roro9stack"><path fill="#ffffff" d="M7.7 0V-9.2H19.8V-37.1Q19.8 -40.4 16.6 -40.4H8.7V-49.6H20.6Q24.7 -49.6 27.3 -47.2Q29.9 -44.9 29.9 -40.7V-39.5H30.4Q31.5 -45.1 35.2 -48Q38.8 -50.8 45.8 -50.8H53.5V-39.6H42.7Q36.8 -39.6 33.6 -35.5Q30.4 -31.4 30.4 -25.7V-9.2H45.8V0Z"></path><path fill="#ffffff" d="M90 1.2Q82.9 1.2 77.3 -2Q71.7 -5.2 68.5 -11.1Q65.3 -16.9 65.3 -24.8Q65.3 -32.7 68.5 -38.6Q71.7 -44.4 77.3 -47.6Q82.9 -50.8 90.1 -50.8Q97.3 -50.8 102.9 -47.6Q108.4 -44.4 111.6 -38.6Q114.7 -32.7 114.7 -24.8Q114.7 -16.9 111.5 -11.1Q108.3 -5.2 102.8 -2Q97.2 1.2 90 1.2ZM90 -8.9Q93.8 -8.9 97 -10.6Q100.2 -12.3 102.2 -15.9Q104.1 -19.4 104.1 -24.8Q104.1 -30.3 102.2 -33.8Q100.2 -37.3 97.1 -39Q93.9 -40.7 90.1 -40.7Q86.3 -40.7 83.1 -39Q79.9 -37.3 78 -33.8Q76 -30.3 76 -24.8Q76 -16.6 80.2 -12.8Q84.3 -8.9 90 -8.9Z"></path><path fill="#ffffff" d="M127.7 0V-9.2H139.8V-37.1Q139.8 -40.4 136.6 -40.4H128.7V-49.6H140.6Q144.7 -49.6 147.3 -47.2Q149.9 -44.9 149.9 -40.7V-39.5H150.4Q151.5 -45.1 155.2 -48Q158.8 -50.8 165.8 -50.8H173.5V-39.6H162.7Q156.8 -39.6 153.6 -35.5Q150.4 -31.4 150.4 -25.7V-9.2H165.8V0Z"></path><path fill="#ffffff" d="M210 1.2Q202.9 1.2 197.3 -2Q191.7 -5.2 188.5 -11.1Q185.3 -16.9 185.3 -24.8Q185.3 -32.7 188.5 -38.6Q191.7 -44.4 197.3 -47.6Q202.9 -50.8 210.1 -50.8Q217.3 -50.8 222.9 -47.6Q228.4 -44.4 231.6 -38.6Q234.7 -32.7 234.7 -24.8Q234.7 -16.9 231.5 -11.1Q228.3 -5.2 222.8 -2Q217.2 1.2 210 1.2ZM210 -8.9Q213.8 -8.9 217 -10.6Q220.2 -12.3 222.1 -15.9Q224.1 -19.4 224.1 -24.8Q224.1 -30.3 222.1 -33.8Q220.2 -37.3 217.1 -39Q213.9 -40.7 210.1 -40.7Q206.3 -40.7 203.1 -39Q199.9 -37.3 197.9 -33.8Q196 -30.3 196 -24.8Q196 -16.6 200.2 -12.8Q204.3 -8.9 210 -8.9Z"></path><path fill="#00dbff" d="M268.7 1.2Q262.1 1.2 257.1 -1.4Q252.1 -4 249.1 -8.4Q246.1 -12.9 245.5 -18.5H255.7Q256.7 -13.8 260.1 -11.1Q263.5 -8.4 268.7 -8.4Q276 -8.4 280.5 -14.8Q285 -21.1 285.7 -34.6H285Q282.5 -30.4 278.6 -27.7Q274.7 -25 267.5 -25Q261.5 -25 256.5 -27.9Q251.5 -30.7 248.5 -35.8Q245.5 -40.9 245.5 -47.6Q245.5 -54 248.4 -59.4Q251.3 -64.7 256.6 -68Q261.8 -71.2 269 -71.2Q278.2 -71.2 284.1 -67.1Q290 -62.9 292.9 -55.4Q295.7 -47.8 295.7 -37.5Q295.7 -25.9 292.5 -17.2Q289.4 -8.5 283.4 -3.6Q277.3 1.2 268.7 1.2ZM269.7 -34.5Q275.9 -34.5 279.6 -38.4Q283.4 -42.2 283.4 -48Q283.4 -53.9 279.6 -57.8Q275.9 -61.6 269.7 -61.6Q263.5 -61.6 259.8 -57.8Q256 -54 256 -48.1Q256 -42.2 259.8 -38.4Q263.5 -34.5 269.7 -34.5Z"></path><path fill="#ffffff" d="M330.4 1.2Q320.6 1.2 314.8 -3.4Q309 -8 308.2 -15.6H319.1Q319.7 -12.1 322.6 -9.9Q325.6 -7.7 330.5 -7.7Q335.2 -7.7 337.8 -9.7Q340.3 -11.6 340.3 -14.2Q340.3 -18 337.2 -19.4Q334.2 -20.8 328.3 -21.5Q323.2 -22.1 319 -23.9Q314.9 -25.6 312.5 -28.7Q310.1 -31.7 310.1 -36.3Q310.1 -42.8 315.2 -46.8Q320.3 -50.8 329.4 -50.8Q338.5 -50.8 343.5 -46.7Q348.5 -42.6 349.3 -35.5H339.1Q338.7 -38.5 336 -40.2Q333.3 -42 329.3 -42Q325.2 -42 322.8 -40.5Q320.4 -38.9 320.4 -36.4Q320.4 -31 332 -29.8Q337.5 -29.2 341.8 -27.8Q346.1 -26.3 348.6 -23.2Q351.1 -20.2 351.1 -14.7Q351.2 -10.2 348.5 -6.6Q345.9 -3 341.2 -0.9Q336.6 1.2 330.4 1.2Z"></path><path fill="#ffffff" d="M395.4 0Q388.1 0 383.8 -3.6Q379.5 -7.1 379.5 -16.2V-40.6H367V-49.6H374.4Q379.5 -49.6 380.4 -54.6L381.9 -62.6H390.1V-49.6H409.7V-40.6H390.1V-16.4Q390.1 -12.5 391.9 -10.9Q393.6 -9.4 397.9 -9.4H409.5V0Z"></path><path fill="#ffffff" d="M445.5 1.2Q439.6 1.2 435.6 -0.9Q431.6 -2.9 429.6 -6.4Q427.6 -9.8 427.6 -13.9Q427.6 -21.2 433 -25.3Q438.3 -29.4 448.1 -29.4H460.9V-30.5Q460.9 -41.7 450.5 -41.7Q446.2 -41.7 443.2 -39.9Q440.3 -38 439.3 -33.9H428.7Q429.5 -41.7 435.4 -46.2Q441.4 -50.8 450.5 -50.8Q461.5 -50.8 466.5 -45.4Q471.5 -40 471.5 -30.5V0H462.5L461.6 -7.3H460.9Q458.7 -3.8 455.4 -1.3Q452.1 1.2 445.5 1.2ZM447.5 -7.7Q454 -7.7 457.2 -11.7Q460.5 -15.6 460.8 -21.7H449.2Q443.5 -21.7 441.1 -19.9Q438.8 -18 438.8 -14.7Q438.8 -11.4 441.1 -9.6Q443.5 -7.7 447.5 -7.7Z"></path><path fill="#ffffff" d="M510.7 1.2Q503.8 1.2 498.4 -2Q492.9 -5.2 489.8 -11.1Q486.7 -16.9 486.7 -24.8Q486.7 -32.7 489.9 -38.5Q493 -44.3 498.4 -47.6Q503.8 -50.8 510.7 -50.8Q520.2 -50.8 526 -46.1Q531.9 -41.3 533.5 -33H522.4Q521.4 -36.6 518.3 -38.7Q515.3 -40.8 510.6 -40.8Q507.2 -40.8 504.1 -39Q501.1 -37.2 499.2 -33.7Q497.4 -30.1 497.4 -24.8Q497.4 -19.6 499.2 -16Q501.1 -12.4 504.1 -10.6Q507.2 -8.7 510.6 -8.7Q515.4 -8.7 518.3 -10.8Q521.2 -12.9 522.4 -16.6H533.5Q531.5 -8.4 525.7 -3.6Q519.9 1.2 510.7 1.2Z"></path><path fill="#ffffff" d="M549.8 0V-72H560.4V-28.8L579.4 -49.6H592.7L572 -27.6V-26.8L595.4 0H582.5L560.4 -25.5V0Z"></path></svg>

After

Width:  |  Height:  |  Size: 4.4 KiB

+1
View File
@@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="-6.0 -78.0 612.0 85.2" role="img" aria-label="roro9stack"><path fill="#000055" d="M7.7 0V-9.2H19.8V-37.1Q19.8 -40.4 16.6 -40.4H8.7V-49.6H20.6Q24.7 -49.6 27.3 -47.2Q29.9 -44.9 29.9 -40.7V-39.5H30.4Q31.5 -45.1 35.2 -48Q38.8 -50.8 45.8 -50.8H53.5V-39.6H42.7Q36.8 -39.6 33.6 -35.5Q30.4 -31.4 30.4 -25.7V-9.2H45.8V0Z"></path><path fill="#000055" d="M90 1.2Q82.9 1.2 77.3 -2Q71.7 -5.2 68.5 -11.1Q65.3 -16.9 65.3 -24.8Q65.3 -32.7 68.5 -38.6Q71.7 -44.4 77.3 -47.6Q82.9 -50.8 90.1 -50.8Q97.3 -50.8 102.9 -47.6Q108.4 -44.4 111.6 -38.6Q114.7 -32.7 114.7 -24.8Q114.7 -16.9 111.5 -11.1Q108.3 -5.2 102.8 -2Q97.2 1.2 90 1.2ZM90 -8.9Q93.8 -8.9 97 -10.6Q100.2 -12.3 102.2 -15.9Q104.1 -19.4 104.1 -24.8Q104.1 -30.3 102.2 -33.8Q100.2 -37.3 97.1 -39Q93.9 -40.7 90.1 -40.7Q86.3 -40.7 83.1 -39Q79.9 -37.3 78 -33.8Q76 -30.3 76 -24.8Q76 -16.6 80.2 -12.8Q84.3 -8.9 90 -8.9Z"></path><path fill="#000055" d="M127.7 0V-9.2H139.8V-37.1Q139.8 -40.4 136.6 -40.4H128.7V-49.6H140.6Q144.7 -49.6 147.3 -47.2Q149.9 -44.9 149.9 -40.7V-39.5H150.4Q151.5 -45.1 155.2 -48Q158.8 -50.8 165.8 -50.8H173.5V-39.6H162.7Q156.8 -39.6 153.6 -35.5Q150.4 -31.4 150.4 -25.7V-9.2H165.8V0Z"></path><path fill="#000055" d="M210 1.2Q202.9 1.2 197.3 -2Q191.7 -5.2 188.5 -11.1Q185.3 -16.9 185.3 -24.8Q185.3 -32.7 188.5 -38.6Q191.7 -44.4 197.3 -47.6Q202.9 -50.8 210.1 -50.8Q217.3 -50.8 222.9 -47.6Q228.4 -44.4 231.6 -38.6Q234.7 -32.7 234.7 -24.8Q234.7 -16.9 231.5 -11.1Q228.3 -5.2 222.8 -2Q217.2 1.2 210 1.2ZM210 -8.9Q213.8 -8.9 217 -10.6Q220.2 -12.3 222.1 -15.9Q224.1 -19.4 224.1 -24.8Q224.1 -30.3 222.1 -33.8Q220.2 -37.3 217.1 -39Q213.9 -40.7 210.1 -40.7Q206.3 -40.7 203.1 -39Q199.9 -37.3 197.9 -33.8Q196 -30.3 196 -24.8Q196 -16.6 200.2 -12.8Q204.3 -8.9 210 -8.9Z"></path><path fill="#0092aa" d="M268.7 1.2Q262.1 1.2 257.1 -1.4Q252.1 -4 249.1 -8.4Q246.1 -12.9 245.5 -18.5H255.7Q256.7 -13.8 260.1 -11.1Q263.5 -8.4 268.7 -8.4Q276 -8.4 280.5 -14.8Q285 -21.1 285.7 -34.6H285Q282.5 -30.4 278.6 -27.7Q274.7 -25 267.5 -25Q261.5 -25 256.5 -27.9Q251.5 -30.7 248.5 -35.8Q245.5 -40.9 245.5 -47.6Q245.5 -54 248.4 -59.4Q251.3 -64.7 256.6 -68Q261.8 -71.2 269 -71.2Q278.2 -71.2 284.1 -67.1Q290 -62.9 292.9 -55.4Q295.7 -47.8 295.7 -37.5Q295.7 -25.9 292.5 -17.2Q289.4 -8.5 283.4 -3.6Q277.3 1.2 268.7 1.2ZM269.7 -34.5Q275.9 -34.5 279.6 -38.4Q283.4 -42.2 283.4 -48Q283.4 -53.9 279.6 -57.8Q275.9 -61.6 269.7 -61.6Q263.5 -61.6 259.8 -57.8Q256 -54 256 -48.1Q256 -42.2 259.8 -38.4Q263.5 -34.5 269.7 -34.5Z"></path><path fill="#000055" d="M330.4 1.2Q320.6 1.2 314.8 -3.4Q309 -8 308.2 -15.6H319.1Q319.7 -12.1 322.6 -9.9Q325.6 -7.7 330.5 -7.7Q335.2 -7.7 337.8 -9.7Q340.3 -11.6 340.3 -14.2Q340.3 -18 337.2 -19.4Q334.2 -20.8 328.3 -21.5Q323.2 -22.1 319 -23.9Q314.9 -25.6 312.5 -28.7Q310.1 -31.7 310.1 -36.3Q310.1 -42.8 315.2 -46.8Q320.3 -50.8 329.4 -50.8Q338.5 -50.8 343.5 -46.7Q348.5 -42.6 349.3 -35.5H339.1Q338.7 -38.5 336 -40.2Q333.3 -42 329.3 -42Q325.2 -42 322.8 -40.5Q320.4 -38.9 320.4 -36.4Q320.4 -31 332 -29.8Q337.5 -29.2 341.8 -27.8Q346.1 -26.3 348.6 -23.2Q351.1 -20.2 351.1 -14.7Q351.2 -10.2 348.5 -6.6Q345.9 -3 341.2 -0.9Q336.6 1.2 330.4 1.2Z"></path><path fill="#000055" d="M395.4 0Q388.1 0 383.8 -3.6Q379.5 -7.1 379.5 -16.2V-40.6H367V-49.6H374.4Q379.5 -49.6 380.4 -54.6L381.9 -62.6H390.1V-49.6H409.7V-40.6H390.1V-16.4Q390.1 -12.5 391.9 -10.9Q393.6 -9.4 397.9 -9.4H409.5V0Z"></path><path fill="#000055" d="M445.5 1.2Q439.6 1.2 435.6 -0.9Q431.6 -2.9 429.6 -6.4Q427.6 -9.8 427.6 -13.9Q427.6 -21.2 433 -25.3Q438.3 -29.4 448.1 -29.4H460.9V-30.5Q460.9 -41.7 450.5 -41.7Q446.2 -41.7 443.2 -39.9Q440.3 -38 439.3 -33.9H428.7Q429.5 -41.7 435.4 -46.2Q441.4 -50.8 450.5 -50.8Q461.5 -50.8 466.5 -45.4Q471.5 -40 471.5 -30.5V0H462.5L461.6 -7.3H460.9Q458.7 -3.8 455.4 -1.3Q452.1 1.2 445.5 1.2ZM447.5 -7.7Q454 -7.7 457.2 -11.7Q460.5 -15.6 460.8 -21.7H449.2Q443.5 -21.7 441.1 -19.9Q438.8 -18 438.8 -14.7Q438.8 -11.4 441.1 -9.6Q443.5 -7.7 447.5 -7.7Z"></path><path fill="#000055" d="M510.7 1.2Q503.8 1.2 498.4 -2Q492.9 -5.2 489.8 -11.1Q486.7 -16.9 486.7 -24.8Q486.7 -32.7 489.9 -38.5Q493 -44.3 498.4 -47.6Q503.8 -50.8 510.7 -50.8Q520.2 -50.8 526 -46.1Q531.9 -41.3 533.5 -33H522.4Q521.4 -36.6 518.3 -38.7Q515.3 -40.8 510.6 -40.8Q507.2 -40.8 504.1 -39Q501.1 -37.2 499.2 -33.7Q497.4 -30.1 497.4 -24.8Q497.4 -19.6 499.2 -16Q501.1 -12.4 504.1 -10.6Q507.2 -8.7 510.6 -8.7Q515.4 -8.7 518.3 -10.8Q521.2 -12.9 522.4 -16.6H533.5Q531.5 -8.4 525.7 -3.6Q519.9 1.2 510.7 1.2Z"></path><path fill="#000055" d="M549.8 0V-72H560.4V-28.8L579.4 -49.6H592.7L572 -27.6V-26.8L595.4 0H582.5L560.4 -25.5V0Z"></path></svg>

After

Width:  |  Height:  |  Size: 4.4 KiB

+69
View File
@@ -0,0 +1,69 @@
// The Install page: asks the project's Gitea for the latest release, and gives ESP Web Tools a
// manifest for its factory image, built here, so the page offers a new release as soon as it exists
// and nothing is copied to this site (docs/milestones/W1.md, Q180). Gitea sits behind Caddy, which
// allows this origin to read the release API and the downloads.
(function () {
var box = document.getElementById("flasher");
if (!box) return;
var $ = function (id) { return document.getElementById(id); };
var status = $("flasher-status");
var apiOrigin = new URL(box.dataset.api).origin;
var downloads = box.dataset.releasesPath;
// A network error (which is also what a browser makes of a missing CORS header) and a release this
// page won't offer are different things to tell the visitor.
function fail(error) {
var unreachable = error instanceof TypeError;
status.textContent = (unreachable ? "Couldn't reach the release server (" + error.message + ")" : "This page can't offer the latest release (" + error.message + ")") +
". Use the esptool steps below, or take the file from the downloads page.";
status.className = "msg";
}
function human(bytes) {
return bytes >= 1048576 ? (bytes / 1048576).toFixed(2) + " MB" : Math.round(bytes / 1024) + " KB";
}
// Only a download from the project's own server, for this repository, is ever handed to the flasher.
function trusted(url) {
try {
var u = new URL(url);
return u.origin === apiOrigin && u.pathname.indexOf(downloads) === 0 && u.pathname.indexOf("..") < 0 && !u.search;
} catch (e) { return false; }
}
fetch(box.dataset.api + "/releases/latest", { headers: { Accept: "application/json" } })
.then(function (r) {
if (!r.ok) throw new Error("answer " + r.status);
return r.json();
})
.then(function (rel) {
var assets = rel.assets || [];
var bin = assets.filter(function (a) { return /-factory\.bin$/.test(a.name); })[0];
if (!bin) throw new Error("the latest release has no factory image");
if (!trusted(bin.browser_download_url)) throw new Error("its download isn't on the project's server");
var sums = assets.filter(function (a) { return a.name === "SHA256SUMS" && trusted(a.browser_download_url); })[0];
$("f-version").textContent = rel.tag_name;
$("f-size").textContent = human(bin.size);
if (rel.html_url) $("f-link").href = rel.html_url;
var manifest = {
name: "roro9stack",
version: rel.tag_name,
builds: [{ chipFamily: "ESP32-S3", parts: [{ path: bin.browser_download_url, offset: 0 }] }]
};
var url = URL.createObjectURL(new Blob([JSON.stringify(manifest)], { type: "application/json" }));
var button = $("f-button");
button.setAttribute("manifest", url);
button.hidden = false;
$("flasher-info").hidden = false;
status.textContent = "Latest release: " + rel.tag_name + ".";
if (!sums) { $("f-sha").textContent = "not published"; return; }
return fetch(sums.browser_download_url)
.then(function (r) { return r.ok ? r.text() : ""; })
.then(function (text) {
var line = text.split("\n").filter(function (l) { return l.indexOf(bin.name) >= 0; })[0];
$("f-sha").textContent = line ? line.split(/\s+/)[0] : "not listed";
})
.catch(function () { $("f-sha").textContent = "unavailable"; });
})
.catch(fail);
})();
+30
View File
@@ -0,0 +1,30 @@
// The theme switch. Without JavaScript the page follows the visitor's setting (prefers-color-scheme);
// this adds a button that overrides it, remembered in this browser only.
(function () {
var root = document.documentElement;
root.classList.add("js");
try {
var saved = localStorage.getItem("theme");
if (saved === "dark" || saved === "light") root.setAttribute("data-theme", saved);
} catch (e) { /* storage blocked: the setting just isn't remembered */ }
document.addEventListener("DOMContentLoaded", function () {
var button = document.getElementById("theme-toggle");
if (!button) return;
function current() {
return root.getAttribute("data-theme") || (window.matchMedia("(prefers-color-scheme: light)").matches ? "light" : "dark");
}
function show() {
var next = current() === "dark" ? "light" : "dark";
button.textContent = next === "light" ? "Light" : "Dark";
button.setAttribute("aria-label", "Switch to the " + next + " theme");
}
button.addEventListener("click", function () {
var next = current() === "dark" ? "light" : "dark";
root.setAttribute("data-theme", next);
try { localStorage.setItem("theme", next); } catch (e) { /* see above */ }
show();
});
show();
});
})();
+4
View File
@@ -0,0 +1,4 @@
User-agent: *
Allow: /
Sitemap: https://roro9stack.net/sitemap.xml
Binary file not shown.

After

Width:  |  Height:  |  Size: 3.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 KiB

+201
View File
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
+9
View File
@@ -0,0 +1,9 @@
ESP Web Tools 10.4.0 (https://github.com/esphome/esp-web-tools), Apache-2.0 (see LICENSE),
vendored so the Install page makes no request to a CDN.
Only the files an ESP32-S3 needs (the Cardputer ADV): install-button.js, its chunks, and the S3
flasher stub. The other chip families' chunks are loaded only if such a chip is detected, which this
page's manifest never asks for.
Updating: `npm pack esp-web-tools`, then copy the same set from package/dist/web/ (the chunk file
names carry a hash and change with the version) and update the references in this README.
+1
View File
@@ -0,0 +1 @@
import{ESP32ROM as t}from"./esp32-DNPRK0Ay.js";import"./install-dialog-im156JnI.js";import"./styles-sT2V1cOw.js";class i extends t{constructor(){super(...arguments),this.CHIP_NAME="ESP32-S3",this.IMAGE_CHIP_ID=9,this.EFUSE_BASE=1610641408,this.MAC_EFUSE_REG=this.EFUSE_BASE+68,this.EFUSE_BLOCK1_ADDR=this.EFUSE_BASE+68,this.EFUSE_BLOCK2_ADDR=this.EFUSE_BASE+92,this.UART_CLKDIV_REG=1610612756,this.UART_CLKDIV_MASK=1048575,this.UART_DATE_REG_ADDR=1610612864,this.FLASH_WRITE_SIZE=1024,this.BOOTLOADER_FLASH_OFFSET=0,this.SPI_REG_BASE=1610620928,this.SPI_USR_OFFS=24,this.SPI_USR1_OFFS=28,this.SPI_USR2_OFFS=32,this.SPI_MOSI_DLEN_OFFS=36,this.SPI_MISO_DLEN_OFFS=40,this.SPI_W0_OFFS=88,this.USB_RAM_BLOCK=2048,this.UARTDEV_BUF_NO_USB=3,this.UARTDEV_BUF_NO=1070526796,this.IROM_MAP_START=1107296256,this.IROM_MAP_END=1140850688,this.MEMORY_MAP=[[0,65536,"PADDING"],[1006632960,1023410176,"DROM"],[1023410176,1040187392,"EXTRAM_DATA"],[1611653120,1611661312,"RTC_DRAM"],[1070104576,1070596096,"BYTE_ACCESSIBLE"],[1070104576,1077813248,"MEM_INTERNAL"],[1070104576,1070596096,"DRAM"],[1073741824,1073848576,"IROM_MASK"],[1077346304,1077805056,"IRAM"],[1611653120,1611661312,"RTC_IRAM"],[1107296256,1115684864,"IROM"],[1342177280,1342185472,"RTC_DATA"]]}async getChipDescription(t){const i=await this.getMajorChipVersion(t),s=await this.getMinorChipVersion(t);return`${{0:"ESP32-S3 (QFN56)",1:"ESP32-S3-PICO-1 (LGA56)"}[await this.getPkgVersion(t)]||"unknown ESP32-S3"} (revision v${i}.${s})`}async getPkgVersion(t){return await t.readReg(this.EFUSE_BLOCK1_ADDR+12)>>21&7}async getRawMinorChipVersion(t){return((await t.readReg(this.EFUSE_BLOCK1_ADDR+20)>>23&1)<<3)+(await t.readReg(this.EFUSE_BLOCK1_ADDR+12)>>18&7)}async getMinorChipVersion(t){const i=await this.getRawMinorChipVersion(t);return await this.isEco0(t,i)?0:this.getRawMinorChipVersion(t)}async getRawMajorChipVersion(t){return await t.readReg(this.EFUSE_BLOCK1_ADDR+20)>>24&3}async getMajorChipVersion(t){const i=await this.getRawMinorChipVersion(t);return await this.isEco0(t,i)?0:this.getRawMajorChipVersion(t)}async getBlkVersionMajor(t){return await t.readReg(this.EFUSE_BLOCK2_ADDR+16)>>0&3}async getBlkVersionMinor(t){return await t.readReg(this.EFUSE_BLOCK1_ADDR+12)>>24&7}async isEco0(t,i){return 0==(7&i)&&1===await this.getBlkVersionMajor(t)&&1===await this.getBlkVersionMinor(t)}async getFlashCap(t){const i=this.EFUSE_BASE+68+12;return await t.readReg(i)>>27&7}async getFlashVendor(t){const i=this.EFUSE_BASE+68+16;return{1:"XMC",2:"GD",3:"FM",4:"TT",5:"BY"}[await t.readReg(i)>>0&7]||""}async getPsramCap(t){const i=this.EFUSE_BASE+68+16;return await t.readReg(i)>>3&3}async getPsramVendor(t){const i=this.EFUSE_BASE+68+16;return{1:"AP_3v3",2:"AP_1v8"}[await t.readReg(i)>>7&3]||""}async getChipFeatures(t){const i=["Wi-Fi","BLE"],s=await this.getFlashCap(t),e=await this.getFlashVendor(t),a={0:null,1:"Embedded Flash 8MB",2:"Embedded Flash 4MB"}[s],r=void 0!==a?a:"Unknown Embedded Flash";null!==a&&i.push(`${r} (${e})`);const n=await this.getPsramCap(t),_=await this.getPsramVendor(t),h={0:null,1:"Embedded PSRAM 8MB",2:"Embedded PSRAM 2MB"}[n],E=void 0!==h?h:"Unknown Embedded PSRAM";return null!==h&&i.push(`${E} (${_})`),i}async getCrystalFreq(t){return 40}_d2h(t){const i=(+t).toString(16);return 1===i.length?"0"+i:i}async postConnect(t){const i=255&await t.readReg(this.UARTDEV_BUF_NO);t.debug("In _post_connect "+i),i==this.UARTDEV_BUF_NO_USB&&(t.ESP_RAM_BLOCK=this.USB_RAM_BLOCK)}async readMac(t){let i=await t.readReg(this.MAC_EFUSE_REG);i>>>=0;let s=await t.readReg(this.MAC_EFUSE_REG+4);s=s>>>0&65535;const e=new Uint8Array(6);return e[0]=s>>8&255,e[1]=255&s,e[2]=i>>24&255,e[3]=i>>16&255,e[4]=i>>8&255,e[5]=255&i,this._d2h(e[0])+":"+this._d2h(e[1])+":"+this._d2h(e[2])+":"+this._d2h(e[3])+":"+this._d2h(e[4])+":"+this._d2h(e[5])}getEraseSize(t,i){return i}}export{i as ESP32S3ROM};
+129
View File
@@ -0,0 +1,129 @@
import{w as e,y as t,a as o,_ as i,t as l,i as n,x as a}from"./styles-sT2V1cOw.js";const s=e`
<svg
version="1.1"
id="Capa_1"
xmlns="http://www.w3.org/2000/svg"
xmlns:xlink="http://www.w3.org/1999/xlink"
x="0px"
y="0px"
viewBox="0 0 510.322 510.322"
xml:space="preserve"
style="width: 28px; vertical-align: middle;"
>
<g>
<path
style="fill:currentColor;"
d="M429.064,159.505c0-0.151,0.086-1.057,0.086-1.057c0-75.282-61.261-136.521-136.543-136.521 c-52.244,0-97.867,30.587-120.753,76.339c-11.67-9.081-25.108-15.682-40.273-15.682c-37.166,0-67.387,30.199-67.387,67.387 c0,0,0.453,3.279,0.798,5.824C27.05,168.716,0,203.423,0,244.516c0,25.389,9.901,49.268,27.848,67.171 c17.968,17.99,41.804,27.869,67.193,27.869h130.244v46.83h-54.66l97.694,102.008l95.602-102.008h-54.66v-46.83H419.25 c50.174,0,91.072-40.855,91.072-90.986C510.3,201.827,474.428,164.639,429.064,159.505z M419.207,312.744H309.26v-55.545h-83.975 v55.545H95.019c-18.184,0-35.333-7.075-48.211-19.996c-12.878-12.878-19.953-30.005-19.953-48.189 c0-32.68,23.21-60.808,55.264-66.956l12.511-2.394l-2.092-14.431l-1.488-10.785c0-22.347,18.184-40.51,40.531-40.51 c13.266,0,25.691,6.514,33.305,17.408l15.229,21.873l8.52-25.303c15.013-44.652,56.796-74.656,103.906-74.656 c60.506,0,109.709,49.203,109.709,109.644l-1.337,25.712l15.121,0.302l3.149-0.086c35.419,0,64.216,28.797,64.216,64.216 C483.401,283.969,454.604,312.744,419.207,312.744z"
/>
</g>
</svg>
`;let r=class extends n{render(){const e=(()=>{var e,t;const o=window.navigator.userAgent,i=(null===(t=null===(e=window.navigator)||void 0===e?void 0:e.userAgentData)||void 0===t?void 0:t.platform)||window.navigator.platform;return-1!==["macOS","Macintosh","MacIntel","MacPPC","Mac68K"].indexOf(i)?"Mac OS":-1!==["iPhone","iPad","iPod"].indexOf(i)?"iOS":-1!==["Win32","Win64","Windows","WinCE"].indexOf(i)?"Windows":/Android/.test(o)?"Android":/Linux/.test(i)?"Linux":null})();return a`
<ew-dialog open @closed=${this._handleClose}>
<div slot="headline">No port selected</div>
<div slot="content">
<div>
If you didn't select a port because you didn't see your device
listed, try the following steps:
</div>
<ol>
<li>
Make sure that the device is connected to this computer (the one
that runs the browser that shows this website)
</li>
<li>
Most devices have a tiny light when it is powered on. If yours has
one, make sure it is on.
</li>
<li>
Make sure that the USB cable you use can be used for data and is
not a power-only cable.
</li>
${"Linux"===e?a`
<li>
If you are using a Linux flavor, make sure that your user is
part of the <code>dialout</code> group so it has permission
to access the device.
<code class="block"
>sudo usermod -a -G dialout YourUserName</code
>
You may need to log out & back in or reboot to activate the
new group access.
</li>
`:""}
<li>
Make sure you have the right drivers installed. Below are the
drivers for common chips used in ESP devices:
<ul>
<li>
CP2102 drivers:
<a
href="https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers"
target="_blank"
rel="noopener"
>Windows & Mac</a
>
</li>
<li>
CH342, CH343, CH9102 drivers:
<a
href="https://www.wch.cn/downloads/CH343SER_ZIP.html"
target="_blank"
rel="noopener"
>Windows</a
>,
<a
href="https://www.wch.cn/downloads/CH34XSER_MAC_ZIP.html"
target="_blank"
rel="noopener"
>Mac</a
>
<br />
(download via blue button with ${s} icon)
</li>
<li>
CH340, CH341 drivers:
<a
href="https://www.wch.cn/downloads/CH341SER_ZIP.html"
target="_blank"
rel="noopener"
>Windows</a
>,
<a
href="https://www.wch.cn/downloads/CH341SER_MAC_ZIP.html"
target="_blank"
rel="noopener"
>Mac</a
>
<br />
(download via blue button with ${s} icon)
</li>
</ul>
</li>
</ol>
</div>
<div slot="actions">
${this.doTryAgain?a`
<ew-text-button @click=${this.close}>Cancel</ew-text-button>
<ew-text-button @click=${this.tryAgain}>
Try Again
</ew-text-button>
`:a`
<ew-text-button @click=${this.close}>Close</ew-text-button>
`}
</div>
</ew-dialog>
`}tryAgain(){var e;this.close(),null===(e=this.doTryAgain)||void 0===e||e.call(this)}close(){this.shadowRoot.querySelector("ew-dialog").close()}async _handleClose(){this.parentNode.removeChild(this)}};r.styles=[t,o`
li + li,
li > ul {
margin-top: 8px;
}
ul,
ol {
margin-bottom: 0;
padding-left: 1.5em;
}
li code.block {
display: block;
margin: 0.5em 0;
}
`],r=i([l("ewt-no-port-picked-dialog")],r);const d=async e=>{const t=document.createElement("ewt-no-port-picked-dialog");return t.doTryAgain=e,document.body.append(t),!0};export{d as openNoPortPickedDialog};
+1
View File
@@ -0,0 +1 @@
const e=async t=>{let o;import("./install-dialog-im156JnI.js").then((function(e){return e.i}));try{o=await navigator.serial.requestPort()}catch(o){return"NotFoundError"===o.name?void import("./index-Dt9w-IG1.js").then((o=>o.openNoPortPickedDialog((()=>e(t))))):void alert(`Error: ${o.message}`)}if(!o)return;try{await o.open({baudRate:115200,bufferSize:8192})}catch(e){return void alert(e.message)}const n=document.createElement("ewt-install-dialog");n.port=o,n.manifestPath=t.manifest||t.getAttribute("manifest"),n.overrides=t.overrides,n.addEventListener("closed",(()=>{o.close()}),{once:!0}),document.body.appendChild(n)};class t extends HTMLElement{connectedCallback(){if(this.renderRoot)return;if(this.renderRoot=this.attachShadow({mode:"open"}),!t.isSupported||!t.isAllowed)return this.toggleAttribute("install-unsupported",!0),void(this.renderRoot.innerHTML=t.isAllowed?"<slot name='unsupported'>Your browser does not support installing things on ESP devices. Use Mozilla Firefox, Google Chrome or Microsoft Edge.</slot>":"<slot name='not-allowed'>You can only install ESP devices on HTTPS websites or on the localhost.</slot>");this.toggleAttribute("install-supported",!0);const o=document.createElement("slot");o.addEventListener("click",(async t=>{t.preventDefault(),e(this)})),o.name="activate";const n=document.createElement("button");if(n.innerText="Connect",o.append(n),"adoptedStyleSheets"in Document.prototype&&"replaceSync"in CSSStyleSheet.prototype){const e=new CSSStyleSheet;e.replaceSync(t.style),this.renderRoot.adoptedStyleSheets=[e]}else{const e=document.createElement("style");e.innerText=t.style,this.renderRoot.append(e)}this.renderRoot.append(o)}}t.isSupported="serial"in navigator,t.isAllowed=window.isSecureContext,t.style='\n button {\n position: relative;\n cursor: pointer;\n font-size: 14px;\n font-weight: 500;\n padding: 10px 24px;\n color: var(--esp-tools-button-text-color, #fff);\n background-color: var(--esp-tools-button-color, #03a9f4);\n border: none;\n border-radius: var(--esp-tools-button-border-radius, 9999px);\n }\n button::before {\n content: " ";\n position: absolute;\n top: 0;\n bottom: 0;\n left: 0;\n right: 0;\n opacity: 0.2;\n border-radius: var(--esp-tools-button-border-radius, 9999px);\n }\n button:hover::before {\n background-color: rgba(255,255,255,.8);\n }\n button:focus {\n outline: none;\n }\n button:focus::before {\n background-color: white;\n }\n button:active::before {\n background-color: grey;\n }\n :host([active]) button {\n color: rgba(0, 0, 0, 0.38);\n background-color: rgba(0, 0, 0, 0.12);\n box-shadow: none;\n cursor: unset;\n pointer-events: none;\n }\n .hidden {\n display: none;\n }',customElements.define("esp-web-install-button",t);
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+8
View File
@@ -0,0 +1,8 @@
{% extends "base.html" %}
{% block title %}Not found: roro9stack{% endblock %}
{% block main %}
<div class="wrap page">
<h1>Not found.</h1>
<p class="prose">There's no page here. Try <a href="/">the home page</a>, <a href="/install/">Install</a> or <a href="/downloads/">Downloads</a>.</p>
</div>
{% endblock main %}
+61
View File
@@ -0,0 +1,61 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>{% block title %}roro9stack: open firmware for the Cardputer ADV{% endblock %}</title>
<meta name="description" content="{% block description %}{{ config.description }}{% endblock %}">
<meta name="color-scheme" content="dark light">
<meta name="author" content="Clément Martin">
<meta name="copyright" content="© 2026 Clément Martin">
{% if current_url %}<link rel="canonical" href="{{ current_url }}">{% endif %}
<link rel="icon" href="/img/favicon.svg" type="image/svg+xml">
<link rel="icon" href="/favicon.ico" sizes="32x32 48x48">
<link rel="apple-touch-icon" href="/apple-touch-icon.png">
<link rel="preload" href="/fonts/DMMono-Medium.woff2" as="font" type="font/woff2" crossorigin>
<link rel="preload" href="/fonts/HankenGrotesk.woff2" as="font" type="font/woff2" crossorigin>
<link rel="stylesheet" href="/css/site.css">
<script src="/js/theme.js"></script>
{% block head %}{% endblock %}
</head>
<body>
<a class="skip" href="#main">Skip to the content</a>
<header class="wrap bar">
<a class="brand" href="/" aria-label="roro9stack, home">
<img class="logo logo-dark" src="/img/logo-dark.svg" alt="roro9stack" width="201" height="28">
<img class="logo logo-light" src="/img/logo-light.svg" alt="" width="201" height="28">
</a>
<nav aria-label="Main">
<a href="/#apps">Apps</a>
<a href="/install/">Install</a>
<a href="/downloads/">Downloads</a>
<a href="{{ config.extra.blog }}">Blog</a>
<button class="link-btn js-only" id="theme-toggle" type="button">Light</button>
<a class="btn btn-primary n-md" href="{{ config.extra.repo }}">Source</a>
</nav>
</header>
<main id="main">
{% block main %}{% endblock %}
</main>
<footer>
<div class="wrap">
<div class="foot-row">
<span>© 2026 Clément Martin · Licensed GPL-3.0</span>
<nav aria-label="Footer">
<a href="{{ config.extra.repo }}">Source</a>
<a href="{{ config.extra.repo }}/releases">Releases</a>
<a href="{{ config.extra.repo }}/src/branch/main/docs">Docs in the repository</a>
<a href="{{ config.extra.repo }}/issues">Issues</a>
<a href="{{ config.extra.blog }}">Blog</a>
<a href="mailto:{{ config.extra.contact }}">Contact</a>
</nav>
</div>
<small>roro9stack is an independent project. It isn't affiliated with or endorsed by M5Stack or Meshtastic: those names belong to their owners.</small>
<small>This site sets no cookies and has no analytics, and its pages load nothing from other sites. The Install page asks the project's own server, git.twis.la, for the latest release. Questions, corrections: <a href="mailto:{{ config.extra.contact }}">{{ config.extra.contact }}</a>, or the issue tracker.</small>
</div>
</footer>
</body>
</html>
+34
View File
@@ -0,0 +1,34 @@
{% extends "base.html" %}
{% block title %}Downloads: roro9stack{% endblock %}
{% block description %}{{ page.description }}{% endblock %}
{% block main %}
{% set releases = load_data(url=config.extra.api ~ "/releases?limit=30&draft=false&pre-release=false", format="json", required=false) %}
<div class="wrap page">
<header>
<span class="eyebrow">Downloads</span>
<h1>{{ page.title }}</h1>
<p class="lead">{{ page.description }} To put one on a device, <a class="accent-link" href="/install/">install it from your browser</a>.</p>
</header>
<div class="prose">
<p>Each release has a <strong>signed update file</strong> (<code>.ota</code>: copy it to <code>/updates</code> on the SD card and install it from Settings → Firmware or the Storage App, or push it over Wi-Fi), a <strong>factory image</strong> (<code>-factory.bin</code>, the whole flash at offset 0 for a first install over USB), the <strong>symbols</strong> (<code>.elf.gz</code>, to decode a crash report) and <code>SHA256SUMS</code>. Debug Builds aren't published.</p>
</div>
{% if releases %}
<div class="releases">
{% for r in releases %}
<article class="release n-md">
<h2>{{ r.tag_name }}</h2>
<p class="meta">{{ r.published_at | date(format="%Y-%m-%d") }} · <a class="accent-link" href="{{ r.html_url }}">release notes</a></p>
<p>{{ r.body | split(pat="\n\n") | first }}</p>
<p class="files">
{% for a in r.assets %}<a href="{{ a.browser_download_url }}">{{ a.name }}</a> <span class="muted">({{ a.size | filesizeformat }})</span>{% endfor %}
</p>
</article>
{% endfor %}
</div>
{% else %}
<p class="prose">The list of releases couldn't be read when this page was built. They're all on <a class="accent-link" href="{{ config.extra.repo }}/releases">Gitea</a>.</p>
{% endif %}
</div>
{% endblock main %}
File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 29 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 22 KiB

+139
View File
@@ -0,0 +1,139 @@
{% extends "base.html" %}
{% block main %}
{% set latest = load_data(url=config.extra.api ~ "/releases/latest", format="json", required=false) %}
{% set apps = load_data(path="data/apps.toml", format="toml") %}
{% set screens = load_data(path="data/screens.toml", format="toml") %}
{% set px = [0,1,1,1,0, 1,0,0,0,1, 1,0,0,0,1, 0,1,1,1,1, 0,0,0,0,1, 0,0,0,0,1, 0,1,1,1,0] %}
<section class="wrap hero" aria-labelledby="hero-title">
<div class="hero-grid">
<div>
<div class="eyebrow-row"><span class="dot"></span><span class="eyebrow">Open firmware · GPL-3.0{% if latest %} · <span class="v">{{ latest.tag_name }}</span>{% endif %}</span></div>
<h1 id="hero-title">Open firmware for a <span class="accent">pocket computer.</span></h1>
</div>
<div>
<p class="lead">roro9stack is firmware for the M5Stack Cardputer ADV with the Cap LoRa-1262: a LoRa scanner that reads Meshtastic traffic, GNSS, IRC, a Gemini browser, Wi-Fi tools, notes and more.</p>
<div class="actions">
<a class="btn btn-primary n-md" href="/install/">Install{% if latest %} {{ latest.tag_name }}{% endif %}</a>
<a class="btn btn-secondary n-md" href="{{ config.extra.repo }}">Read the source</a>
</div>
<ul class="facts">
<li>GPL-3.0</li>
<li>Docker-only build</li>
<li>Signed updates</li>
</ul>
</div>
</div>
<div class="slab n-lg">
<div class="device">{% include "illustrations/sweep.html" %}</div>
<div class="device">{% include "illustrations/sky.html" %}</div>
</div>
<p class="caption">Drawings of the LoRa Scanner's Sweep view and the GNSS sky view, not screenshots: the real screens are further down.</p>
</section>
<section class="wrap" aria-labelledby="status-title">
<div class="status-box n-md">
<h2 id="status-title" class="eyebrow">Where it stands</h2>
<p>Early software{% if latest %}, {{ latest.tag_name }}{% endif %}. The radio listens; it doesn't transmit yet. Sending and reading mesh messages is planned and waits for a second node to test with. <a href="{{ config.extra.repo }}/milestones">The milestones</a> show what's done and what's next.</p>
</div>
</section>
<section class="wrap" id="need" aria-labelledby="need-title">
<div class="section-head">
<span class="eyebrow">Before you start</span>
<h2 id="need-title">What you need.</h2>
</div>
<ul class="need">
<li><strong>An M5Stack Cardputer ADV</strong><span>The handheld the firmware runs on.</span></li>
<li><strong>The Cap LoRa-1262</strong><span>The LoRa Scanner and GNSS need it. The other Apps don't use it.</span></li>
<li><strong>A microSD card</strong><span>For Notes, Storage, Logs, Captures and Tracks.</span></li>
<li><strong>Wi-Fi</strong><span>For IRC, Gemini and updates.</span></li>
<li><strong>A computer, for the first install</strong><span>Chrome or Edge, and a USB-C cable. After that the device updates itself.</span></li>
</ul>
</section>
<section class="wrap" id="apps" aria-labelledby="apps-title">
<div class="section-head">
<span class="eyebrow">What's inside</span>
<h2 id="apps-title">Apps for the radio, the web and the card.</h2>
</div>
<div class="cards">
{% for a in apps.app %}
<article class="card n-lg{% if a.planned %} planned{% endif %}">
<div class="ic i{{ a.icon }}" aria-hidden="true"></div>
<div class="card-top"><span class="tag">{{ a.tag }}</span><span class="num">{{ a.num }}</span></div>
<h3>{{ a.title }}</h3>
<p>{{ a.text }}</p>
<span class="fact">{{ a.fact }}</span>
</article>
{% endfor %}
</div>
<p class="cards-note">Plus Settings, with its Wi-Fi and Firmware pages.</p>
</section>
<section class="wrap" id="screens" aria-labelledby="screens-title">
<div class="section-head">
<span class="eyebrow">On the device</span>
<h2 id="screens-title">The real screens.</h2>
</div>
<div class="shots">
{% for s in screens.screen %}
<figure class="shot n-md">
<img src="/screens/{{ s.file }}" width="480" height="270" alt="{{ s.alt }}" loading="lazy">
<figcaption>{{ s.caption }}</figcaption>
</figure>
{% endfor %}
</div>
</section>
<section class="wrap" id="updates" aria-labelledby="updates-title">
<div class="updates n-lg split">
<div>
<span class="eyebrow">Updates</span>
<h2 id="updates-title">Update over Wi-Fi. It rolls back if it fails.</h2>
<p class="lead">Install a new release from the project's server in Settings, from the SD card, or push one from your computer. Every update is signed: the device checks the signature before it writes anything, restarts, and runs the new firmware on Probation. If it crashes, or can't reconnect Wi-Fi, it goes back to the previous firmware and says so.</p>
<div class="terminal n-md"><span class="p">$</span> scripts/flash.sh --ota 10.39.39.12</div>
</div>
<div class="aside">
<div class="num-row"><span class="big c1">60 s</span><p>The longest the device waits for you to stop typing before it restarts into an update.</p></div>
<div class="num-row"><span class="big c2">3 min</span><p>How long new firmware has to reconnect Wi-Fi on Probation before it rolls back.</p></div>
<div class="num-row"><span class="big c2">3</span><p>Crash restarts in a row, and it starts in Safe Mode: only Wi-Fi, updates and the Debug Console, so a fix can still be pushed.</p></div>
</div>
</div>
</section>
<section class="wrap split" id="build" aria-labelledby="build-title">
<div>
<span class="eyebrow">Build and flash</span>
<h2 id="build-title">Only Docker needed.</h2>
<p class="lead">PlatformIO and the ESP32 toolchain run in a container. The first build downloads about 1 GB; after that, builds take under a minute.</p>
<p class="muted">If the upload can't connect, hold G0, the button next to the screen, while plugging in USB, then retry.</p>
<p>Prefer a ready-made build? <a class="accent-link" href="/install/">Install it from your browser</a>, or take the factory image and the signed update file from <a class="accent-link" href="/downloads/">the downloads</a>.</p>
</div>
<div class="blocks n-lg">
<div class="c"># run the tests, then build</div>
<div><span class="p">$</span> scripts/ci.sh</div>
<div class="gap"></div>
<div class="c"># flash over USB-C</div>
<div><span class="p">$</span> scripts/flash.sh</div>
<div class="gap"></div>
<div class="c"># or update over Wi-Fi</div>
<div><span class="p">$</span> scripts/flash.sh --ota 10.39.39.12</div>
</div>
</section>
<section class="wrap" aria-labelledby="cta-title">
<div class="cta n-lg">
<div>
<h2 id="cta-title">Open source, GPL-3.0.</h2>
<p>Read the code, flash it, send a patch.</p>
<div class="actions">
<a class="btn n-md" href="{{ config.extra.repo }}">Source</a>
<a class="btn n-md" href="{{ config.extra.repo }}/releases">Releases</a>
<a class="btn n-md" href="{{ config.extra.repo }}/issues">Issues</a>
</div>
</div>
<div class="nine" aria-hidden="true">{% for v in px %}<i{% if v == 1 %} class="on"{% endif %}></i>{% endfor %}</div>
</div>
</section>
{% endblock main %}
+37
View File
@@ -0,0 +1,37 @@
{% extends "base.html" %}
{% block title %}Install roro9stack: flash a Cardputer ADV from your browser{% endblock %}
{% block description %}{{ page.description }}{% endblock %}
{% block head %}
<script type="module" src="/vendor/esp-web-tools/install-button.js"></script>
<script src="/js/install.js" defer></script>
{% endblock %}
{% block main %}
<div class="wrap page">
<header>
<span class="eyebrow">Install</span>
<h1>{{ page.title }}</h1>
<p class="lead">{{ page.description }}</p>
</header>
<div class="flasher n-lg" id="flasher" data-api="{{ config.extra.api }}" data-releases-path="/twisla/roro9stack/releases/download/">
<h2>Install from your browser</h2>
<p id="flasher-status" class="muted" role="status">Looking for the latest release…</p>
<dl id="flasher-info" hidden>
<dt>Version</dt><dd id="f-version"></dd>
<dt>Size</dt><dd id="f-size"></dd>
<dt>SHA-256</dt><dd id="f-sha" class="hash"></dd>
<dt>Release</dt><dd><a class="accent-link" id="f-link" href="{{ config.extra.repo }}/releases">release notes</a></dd>
</dl>
<esp-web-install-button id="f-button" hidden>
<button slot="activate" class="btn btn-primary n-md" type="button">Install roro9stack</button>
<span slot="unsupported" class="msg">This browser can't flash a device. Use Chrome or Edge on a desktop computer, or follow the esptool steps below.</span>
<span slot="not-allowed" class="msg">Flashing needs a secure (https) page.</span>
</esp-web-install-button>
<noscript><p class="msg">Flashing from this page needs JavaScript. Use the esptool steps below.</p></noscript>
</div>
<div class="prose">
{{ page.content | safe }}
</div>
</div>
{% endblock main %}
+90
View File
@@ -0,0 +1,90 @@
#!/usr/bin/env python3
"""Checks a built site (docs/milestones/W1.md): what the pages promise, kept.
Usage: site/tools/check_site.py <built site folder>
- No page loads anything from another origin: no script, stylesheet, image, font, frame or preload
from elsewhere (links a visitor follows are fine).
- Every page has a title, a description and a language, and every image has an alt attribute.
- Every file a page references on this site exists.
"""
import html.parser
import os
import re
import sys
import urllib.parse
ROOT = sys.argv[1] if len(sys.argv) > 1 else "public"
HERE = os.path.dirname(os.path.abspath(__file__))
BASE = re.search(r'base_url\s*=\s*"([^"]+)"', open(os.path.join(HERE, "..", "config.toml")).read()).group(1)
HOST = urllib.parse.urlparse(BASE).netloc
class Page(html.parser.HTMLParser):
def __init__(self):
super().__init__()
self.title = False
self.has_title = False
self.has_description = False
self.lang = None
self.loads = [] # (tag, url) of everything the page fetches by itself
self.images_without_alt = 0
def handle_starttag(self, tag, attrs):
a = dict(attrs)
if tag == "html":
self.lang = a.get("lang")
if tag == "title":
self.title = True
if tag == "meta" and a.get("name") == "description" and a.get("content"):
self.has_description = True
if tag in ("script", "img", "iframe", "frame", "embed", "source", "video", "audio") and a.get("src"):
self.loads.append((tag, a["src"]))
if tag == "link" and a.get("href") and a.get("rel", "") in ("stylesheet", "preload", "icon", "modulepreload", "prefetch"):
self.loads.append(("link " + a["rel"], a["href"]))
if tag == "img" and "alt" not in a:
self.images_without_alt += 1
def handle_data(self, data):
if self.title and data.strip():
self.has_title = True
def handle_endtag(self, tag):
if tag == "title":
self.title = False
problems = []
pages = 0
for folder, _, files in os.walk(ROOT):
for name in files:
if not name.endswith(".html"):
continue
path = os.path.join(folder, name)
shown = os.path.relpath(path, ROOT)
p = Page()
p.feed(open(path, encoding="utf-8").read())
pages += 1
if not p.has_title: problems.append(f"{shown}: no title")
if not p.has_description: problems.append(f"{shown}: no description")
if not p.lang: problems.append(f"{shown}: no language")
if p.images_without_alt: problems.append(f"{shown}: {p.images_without_alt} image(s) without alt")
for tag, url in p.loads:
u = urllib.parse.urlparse(url)
if u.netloc and u.netloc != HOST:
problems.append(f"{shown}: {tag} loads {url} from another origin")
elif not u.netloc and not u.scheme:
target = os.path.join(ROOT, u.path.lstrip("/")) if u.path.startswith("/") else os.path.join(folder, u.path)
if u.path and not os.path.exists(target):
problems.append(f"{shown}: {tag} {url} does not exist")
elif u.netloc == HOST:
target = os.path.join(ROOT, u.path.lstrip("/"))
if not os.path.exists(target):
problems.append(f"{shown}: {tag} {url} does not exist")
if not pages:
problems.append(f"no pages found in {ROOT}")
for p in problems:
print("site check:", p)
print(f"site check: {pages} pages, {len(problems)} problem(s)")
sys.exit(1 if problems else 0)
+61
View File
@@ -0,0 +1,61 @@
#!/usr/bin/env python3
"""Draw the pixel "9" of static/img/favicon.svg as PNGs and an ICO, with the standard library.
python3 site/tools/make_favicons.py
Writes static/favicon.ico (32 and 48 px, PNG inside) and static/apple-touch-icon.png (180 px).
The 9 is a 7x7 grid, scaled by a whole number and centred on the background colour."""
import struct
import zlib
from pathlib import Path
BG = (0x00, 0x00, 0x55)
FG = (0x00, 0xDB, 0xFF)
# x, y, w, h: the same rectangles as favicon.svg
RECTS = [(1, 0, 3, 1), (0, 1, 1, 2), (4, 1, 1, 5), (1, 3, 3, 1), (0, 6, 3, 1)]
GRID = 7
STATIC = Path(__file__).resolve().parent.parent / "static"
def cells():
on = set()
for x, y, w, h in RECTS:
on.update((x + i, y + j) for i in range(w) for j in range(h))
return on
def png(size):
scale = size // GRID
pad = (size - scale * GRID) // 2
on = cells()
rows = bytearray()
for py in range(size):
rows.append(0)
for px in range(size):
cx, cy = (px - pad) // scale, (py - pad) // scale
inside = 0 <= px - pad < scale * GRID and 0 <= py - pad < scale * GRID
rows.extend(FG if inside and (cx, cy) in on else BG)
def chunk(kind, data):
body = kind + data
return struct.pack(">I", len(data)) + body + struct.pack(">I", zlib.crc32(body))
return (b"\x89PNG\r\n\x1a\n" + chunk(b"IHDR", struct.pack(">IIBBBBB", size, size, 8, 2, 0, 0, 0)) +
chunk(b"IDAT", zlib.compress(bytes(rows), 9)) + chunk(b"IEND", b""))
def ico(sizes):
images = [png(s) for s in sizes]
out = struct.pack("<HHH", 0, 1, len(images))
offset = 6 + 16 * len(images)
for s, data in zip(sizes, images):
out += struct.pack("<BBBBHHII", s, s, 0, 0, 1, 32, len(data), offset)
offset += len(data)
return out + b"".join(images)
if __name__ == "__main__":
(STATIC / "favicon.ico").write_bytes(ico([32, 48]))
(STATIC / "apple-touch-icon.png").write_bytes(png(180))
print("wrote favicon.ico, apple-touch-icon.png")
+151
View File
@@ -0,0 +1,151 @@
#!/usr/bin/env python3
"""Writes the two illustrations on the home page (templates/illustrations/sweep.html and sky.html, inline SVG for Zola to include).
They are drawings of the LoRa Scanner's Sweep view and the GNSS App's sky view on the Cardputer,
not screenshots, and the page says so. Every colour is one of the device's own (RGB332). The shapes
come from a deterministic generator, so running this again gives the same files:
python3 site/tools/make_illustrations.py
"""
import math
import os
HERE = os.path.dirname(os.path.abspath(__file__))
OUT = os.path.join(HERE, "..", "templates", "illustrations")
BLACK, SLATE, DIM, CYAN, MAG, WHITE, LABEL, ONFILL = "#000000", "#494955", "#6d6d55", "#00dbff", "#ff00ff", "#ffffff", "#b6dbff", "#000055"
ORANGE = "#ff9200"
def notch(x, y, w, h, n):
"""A rectangle with its corners cut in two steps of n/2 (the site's .n-sm, .n-md and .n-lg)."""
a, b = n, n // 2
pts = [(0, a), (b, a), (b, b), (a, b), (a, 0), (w - a, 0), (w - a, b), (w - b, b), (w - b, a), (w, a), (w, h - a),
(w - b, h - a), (w - b, h - b), (w - a, h - b), (w - a, h), (a, h), (a, h - b), (b, h - b), (b, h - a), (0, h - a)]
return " ".join(f"{x + px:g},{y + py:g}" for px, py in pts)
def rnd(n):
x = math.sin(n * 127.1 + 311.7) * 43758.5453
return x - math.floor(x)
def jsround(v):
return math.floor(v + 0.5)
SOURCES = [(5, 0.72, 0.9), (13.5, 0.58, 1.2), (22, 0.95, 1.0), (27, 0.42, 0.8)]
def strength(i, r):
s = 0.05 + 0.1 * rnd(i * 7 + r * 13)
for k, (c, a, w) in enumerate(SOURCES):
if rnd(k * 10 + r) > 0.2:
g = math.exp(-((i - c) ** 2) / (2 * w * w))
s = max(s, a * g * (0.6 + 0.4 * rnd(i * 3 + r * 5 + k)))
return min(s, 1)
def frame(parts, label):
keys_y = 306
kw = (480 - 13 * 4) / 14
keys = []
for row in range(4):
for col in range(14):
x, y = 20 + col * (kw + 4), keys_y + row * 26
keys.append(f'<polygon points="{notch(x, y, kw, 22, 4)}" fill="{SLATE}"/>')
return (
f'<svg xmlns="http://www.w3.org/2000/svg" class="illustration" viewBox="0 0 520 426" role="img" aria-label="{label}" shape-rendering="crispEdges">'
f'<polygon points="{notch(0, 0, 520, 426, 16)}" fill="{BLACK}"/>'
f'<polygon points="{notch(20, 20, 480, 270, 8)}" fill="{SLATE}"/>'
+ "".join(parts) + "".join(keys) + "</svg>\n"
)
def label(x, y, text, fill, anchor="start", weight=400, spacing=0.08):
return (f'<text x="{x:g}" y="{y:g}" fill="{fill}" text-anchor="{anchor}" font-size="11" font-weight="{weight}" '
f'letter-spacing="{spacing}em" class="mono">{text}</text>')
def sweep():
p = []
# Tabs and Status Bar letters
p.append(label(40, 44, "SNIFFER", LABEL, weight=500))
p.append(f'<rect x="104" y="32" width="54" height="16" fill="{CYAN}"/>')
p.append(label(112, 44, "SWEEP", ONFILL, weight=500))
p.append(label(488, 44, "CAP", LABEL, "end", 500))
p.append(label(457, 44, "SW", CYAN, "end", 500))
p.append(label(434, 44, "L", CYAN, "end", 500))
# Bars with peak hold
p.append(f'<rect x="32" y="60" width="456" height="124" fill="{BLACK}"/>')
colw = (448 - 31 * 2) / 32
for i in range(32):
s = strength(i, 0)
h = max(4, jsround(s * 100 / 4) * 4)
gap = jsround(rnd(i * 11 + 3) * 3) * 4
gap = min(gap, 112 - h - 4 if 112 - h - 4 > 0 else 0)
x = 36 + i * (colw + 2)
p.append(f'<rect x="{x:.2f}" y="{180 - h}" width="{colw:.2f}" height="{h}" fill="{MAG if s > 0.6 else CYAN}"/>')
p.append(f'<rect x="{x:.2f}" y="{180 - h - gap - 4}" width="{colw:.2f}" height="4" fill="{WHITE}"/>')
# Waterfall, newest row on top
p.append(f'<rect x="32" y="192" width="456" height="66" fill="{BLACK}"/>')
for r in range(6):
for i in range(32):
s = strength(i, r + 1)
if s < 0.3:
continue
color = CYAN if s < 0.6 else MAG if s < 0.85 else WHITE
p.append(f'<rect x="{36 + i * (colw + 2):.2f}" y="{196 + r * 10}" width="{colw:.2f}" height="8" fill="{color}"/>')
p.append(label(32, 276, "863", LABEL, spacing=0))
p.append(label(260, 276, "866.5", LABEL, "middle", spacing=0))
p.append(label(488, 276, "870 MHz", LABEL, "end", spacing=0))
return frame(p, "Illustration of the Cardputer showing the LoRa Scanner's Sweep view: bars of signal strength from 863 to 870 MHz with peak marks, and a waterfall under them")
def sky():
p = []
p.append(label(32, 44, "GNSS", WHITE, weight=500))
p.append(f'<rect x="449.5" y="32" width="38.5" height="16" fill="{CYAN}"/>')
p.append(label(457.5, 44, "SKY", ONFILL, weight=500))
p.append(label(445.5, 44, "POSITION", LABEL, "end", 500))
p.append(f'<rect x="32" y="60" width="456" height="218" fill="{BLACK}"/>')
ox, oy, CELL, NC, CC = 48, 86, 5, 33, 16
for y in range(NC):
for x in range(NC):
dx, dy = x - CC, y - CC
d = math.sqrt(dx * dx + dy * dy)
if any(abs(d - R) <= 0.5 for R in (15, 10, 5)):
color = DIM
elif (dx == 0 or dy == 0) and d < 15 and abs(dx + dy) % 2 == 0 and d > 0:
color = SLATE
else:
continue
p.append(f'<rect x="{ox + x * CELL}" y="{oy + y * CELL}" width="{CELL}" height="{CELL}" fill="{color}"/>')
cols = [CYAN, MAG, ORANGE, WHITE]
sats = [(20, 70, 0.8, 0), (75, 40, 0.6, 1), (130, 25, 0.35, 2), (160, 60, 0.9, 0), (210, 15, 0.25, 3), (250, 50, 0.7, 1),
(290, 30, 0.5, 0), (320, 75, 0.85, 2), (345, 35, 0.55, 1)]
for az, el, snr, ci in sats:
r = (90 - el) / 90 * 15
a = az * math.pi / 180
cx, cy = jsround(CC + r * math.sin(a)), jsround(CC - r * math.cos(a))
p.append(f'<rect x="{ox + cx * CELL - 4}" y="{oy + cy * CELL - 4}" width="14" height="14" fill="{BLACK}"/>')
p.append(f'<rect x="{ox + cx * CELL - 2}" y="{oy + cy * CELL - 2}" width="10" height="10" fill="{cols[ci]}"/>')
p.append(label(ox + 82.5, 80, "N", MAG, "middle", 500, 0))
p.append(label(ox + 82.5, 265, "S", LABEL, "middle", 500, 0))
p.append(label(ox - 14, 172, "W", LABEL, "start", 500, 0))
p.append(label(ox + 165 + 14, 172, "E", LABEL, "end", 500, 0))
# Signal strength of each satellite
p.append(label(237, 107, "SNR", LABEL, weight=500))
bw = (235 - 8 * 6) / 9
for i, (az, el, snr, ci) in enumerate(sats):
h = max(8, jsround(snr * 124 / 4) * 4)
p.append(f'<rect x="{237 + i * (bw + 6):.2f}" y="{243 - h}" width="{bw:.2f}" height="{h}" fill="{cols[ci]}"/>')
return frame(p, "Illustration of the GNSS App's sky view: the satellites' positions in a circle, and the signal strength of each as a bar")
if __name__ == "__main__":
os.makedirs(OUT, exist_ok=True)
for name, svg in (("sweep.html", sweep()), ("sky.html", sky())):
with open(os.path.join(OUT, name), "w") as f:
f.write(svg)
print(name, len(svg), "bytes")
+13 -1
View File
@@ -204,6 +204,7 @@ void FileViewer::close() {
file_.reset();
pager_.reset();
confirm_.reset();
message_.clear();
std::vector<std::string>().swap(shown_);
std::vector<std::string>().swap(details_);
packets_.setCount(0);
@@ -216,6 +217,11 @@ void FileViewer::show(Mode mode) {
rowsFrom_ = -1;
}
void FileViewer::say(const std::string& text) {
message_ = text;
messageMs_ = millis();
}
std::string FileViewer::title() const { return files::fitName(files::baseName(path_), 24); }
void FileViewer::scroll(int lines) {
@@ -314,6 +320,10 @@ bool FileViewer::onKey(const KeyEvent& e) {
}
bool FileViewer::update(uint32_t) {
if (!message_.empty() && millis() - messageMs_ >= 4000) {
message_.clear();
return true;
}
if (!scan_) return false;
if (scan_->done && !scanShown_) {
scanShown_ = true;
@@ -387,6 +397,7 @@ void FileViewer::draw(Canvas& c) {
}
right = formatBytes(size_);
keys = std::string("Tab: ") + (mode_ != base_ ? "back" : mode_ == Mode::Text ? "hex" : "text") + " t: top b: end";
if (mode_ == Mode::Text) keys += " e: edit";
break;
}
case Mode::Gpx: {
@@ -452,7 +463,8 @@ void FileViewer::draw(Canvas& c) {
c.setTextDatum(top_right);
c.drawString(right.c_str(), area.w - 3, area.y + 1);
c.setTextDatum(top_left);
c.drawString(keys.c_str(), 4, area.y + area.h - 9);
if (!message_.empty()) c.setTextColor(theme::kWarning);
c.drawString(message_.empty() ? keys.c_str() : message_.c_str(), 4, area.y + area.h - 9);
}
} // namespace roro
+8
View File
@@ -30,6 +30,12 @@ class FileViewer {
bool update(uint32_t nowMs); // true: draw again
void draw(Canvas& c);
// For `e` in the Storage App: is this a text small enough to edit (Q146)? And a line to say why not.
bool showingText() const { return mode_ == Mode::Text; }
const std::string& path() const { return path_; }
uint32_t size() const { return size_; }
void say(const std::string& text);
private:
enum class Mode { Text, Hex, Gpx, Pcap, Packet, Ota };
static constexpr int kRows = 8;
@@ -62,6 +68,8 @@ class FileViewer {
std::vector<std::string> details_;
int detailsTop_ = 0;
std::unique_ptr<DialogModel> confirm_;
std::string message_;
uint32_t messageMs_ = 0;
};
} // namespace roro
+184 -1
View File
@@ -2,7 +2,14 @@
#include <SD.h>
#include <algorithm>
#include "cleanup_plan.h"
#include "text_wrap.h"
#include "ui/fonts.h"
#include "ui/widgets.h"
#include "update_check.h"
#include "version.h"
namespace roro {
@@ -17,6 +24,9 @@ bool endsWith(const std::string& s, const std::string& suffix) {
void FirmwarePage::enter() {
confirm_.reset();
ask_ = Ask::None;
view_ = View::Main;
message_.clear();
{
std::lock_guard<std::mutex> g(lock_);
files_.clear();
@@ -40,7 +50,76 @@ std::vector<std::string> FirmwarePage::files() {
return files_;
}
void FirmwarePage::say(const std::string& text) {
message_ = text;
messageMs_ = millis();
}
// The row for the latest release: what's known, in a few words.
std::string FirmwarePage::latestText(bool& warn) const {
warn = false;
GiteaReleases& g = update_.gitea();
if (update_.giteaBusy() || g.status() == GiteaReleases::Status::Busy) return "checking...";
release::Release r;
if (g.status() == GiteaReleases::Status::Failed && !g.latest(r)) {
warn = true;
return "failed: Enter retries";
}
if (!g.latest(r)) return "Enter: check";
return r.tag + (release::isNewer(r, update_.runningVersion()) ? " (new)" : " (current)");
}
void FirmwarePage::openRelease(const release::Release& r) {
shown_ = r;
shownTop_ = 0;
view_ = View::Release;
}
// Can the release on the page be installed from here, and if not, why (in words for the screen)?
bool FirmwarePage::installable(std::string& why) const {
std::string running = update_.runningVersion();
if (!shown_.usable()) why = "Nothing to install in it";
else if (!release::versionNewer(shown_.tag, running) && !versionOlder(shown_.tag, running)) why = "That's the version running";
else if (release::isDebugBuild(running)) why = "Debug Build: update from the PC"; // it keeps its console (Q171)
else if (wifi_.state() != WifiController::State::Connected) why = "Not connected to Wi-Fi";
else return true;
return false;
}
bool FirmwarePage::onKey(const KeyEvent& e) {
if (view_ != View::Main) {
if (confirm_) {
confirm_->onKey(e);
if (confirm_->result() == 1 && ask_ == Ask::Release) {
std::string why = update_.requestInstall(shown_.tag);
if (!why.empty()) say(why);
}
if (confirm_->result() != DialogModel::kPending) confirm_.reset();
return true;
}
if (view_ == View::Release) {
if (e.key == Key::Back) view_ = olderReleases_.empty() || older_.count() == 0 ? View::Main : View::Older;
else if (e.key == Key::Up) shownTop_ = std::max(0, shownTop_ - 1);
else if (e.key == Key::Down) shownTop_++; // clamped when drawn
else if (e.key == Key::Char && (e.ch == 'c' || e.ch == 'C') && !update_.giteaBusy()) update_.requestCheck();
else if (e.key == Key::Select) {
std::string why;
if (!installable(why)) return say(why), true;
ask_ = Ask::Release;
confirm_.reset(new DialogModel({"Cancel", "Install"}));
}
return true;
}
// The older releases.
if (e.key == Key::Back) view_ = View::Main;
else if (e.key == Key::Up) older_.up();
else if (e.key == Key::Down) older_.down();
else if (e.key == Key::Char && (e.ch == 'c' || e.ch == 'C') && !update_.giteaBusy()) update_.requestList();
else if (e.key == Key::Select && older_.selected() >= 0 && older_.selected() < static_cast<int>(olderReleases_.size()))
openRelease(olderReleases_[older_.selected()]);
return true;
}
auto found = files();
if (confirm_) {
confirm_->onKey(e);
@@ -54,8 +133,22 @@ bool FirmwarePage::onKey(const KeyEvent& e) {
case Key::Up: list_.up(); break;
case Key::Down: list_.down(); break;
case Key::Back: return false;
case Key::Char:
if ((e.ch == 'c' || e.ch == 'C') && !update_.giteaBusy()) update_.requestCheck();
break;
case Key::Select:
if (list_.selected() >= kFixed) confirm_.reset(new DialogModel({"Cancel", "Install"}));
if (list_.selected() == kLatest) {
release::Release r;
if (update_.giteaBusy()) break;
if (update_.gitea().latest(r)) openRelease(r);
else update_.requestCheck();
} else if (list_.selected() == kOlder) {
view_ = View::Older;
if (olderReleases_.empty() && !update_.giteaBusy()) update_.requestList();
} else if (list_.selected() >= kFixed) {
ask_ = Ask::SdFile;
confirm_.reset(new DialogModel({"Cancel", "Install"}));
}
break;
default: break;
}
@@ -63,6 +156,89 @@ bool FirmwarePage::onKey(const KeyEvent& e) {
}
void FirmwarePage::draw(Canvas& c) {
if (!message_.empty() && millis() - messageMs_ > 4000) message_.clear();
// What the last answer left: the list of older releases.
if (update_.gitea().seq() != olderSeq_ && !update_.giteaBusy()) {
olderSeq_ = update_.gitea().seq();
olderReleases_ = update_.gitea().list();
older_.setCount(static_cast<int>(olderReleases_.size()));
}
switch (view_) {
case View::Main: drawMain(c); break;
case View::Release: drawRelease(c); break;
case View::Older: drawOlder(c); break;
}
if (confirm_ && view_ != View::Main) {
std::string running = update_.runningVersion();
bool older = versionOlder(shown_.tag, running);
widgets::dialog(c, older ? "Go back?" : "Install update?",
older ? shown_.tag + " is older than " + running + ". Install it anyway? The device restarts."
: shown_.tag + " replaces " + running + ". The device restarts once it's written.",
*confirm_);
}
if (!message_.empty() && !confirm_) {
c.setFont(&fonts::small);
c.setTextColor(theme::kWarning);
c.setTextDatum(top_left);
c.drawString(message_.c_str(), 4, theme::kContent.y + theme::kContent.h - 9);
}
}
void FirmwarePage::drawRelease(Canvas& c) {
const auto& area = theme::kContent;
std::string running = update_.runningVersion();
std::vector<std::string> lines;
lines.push_back(shown_.tag + (shown_.tag == running ? " (running)" : ""));
lines.push_back("Published " + shown_.date() + ", " + formatBytes(shown_.otaSize));
if (versionOlder(shown_.tag, running)) lines.push_back("Older than what's running");
auto measure = widgets::bodyMeasure(c);
lines.push_back("");
for (auto& l : wrapText(shown_.notes, area.w - 12, measure)) lines.push_back(l);
int rows = (area.h - 12) / theme::kLineHeight;
shownTop_ = std::clamp(shownTop_, 0, std::max(0, static_cast<int>(lines.size()) - rows));
widgets::textLines(c, lines, shownTop_, {area.x + 2, area.y + 2, area.w - 2, area.h - 12});
std::string why;
bool ok = installable(why);
c.setFont(&fonts::small);
c.setTextDatum(top_left);
c.setTextColor(theme::kMuted);
c.drawString(ok ? "Enter: install c: check again" : (why + " c: check").c_str(), 4, area.y + area.h - 9);
}
void FirmwarePage::drawOlder(Canvas& c) {
const auto& area = theme::kContent;
GiteaReleases& g = update_.gitea();
c.setTextDatum(top_left);
if (update_.giteaBusy() || g.status() == GiteaReleases::Status::Busy) {
c.setFont(&fonts::body);
c.setTextColor(theme::kMuted);
c.drawString("Looking at the server...", 4, area.y + 4);
return;
}
if (olderReleases_.empty()) {
c.setFont(&fonts::body);
c.setTextColor(g.status() == GiteaReleases::Status::Failed ? theme::kWarning : theme::kMuted);
c.drawString(g.status() == GiteaReleases::Status::Failed ? g.error().c_str() : "No releases known.", 4, area.y + 4);
c.setFont(&fonts::small);
c.setTextColor(theme::kMuted);
c.drawString("c: look again", 4, area.y + area.h - 9);
return;
}
std::string running = update_.runningVersion();
widgets::list(
c, older_, {area.x, area.y, area.w, area.h - 11},
[&](int i) {
const auto& r = olderReleases_[i];
return r.tag + (r.tag == running ? " (running)" : release::versionNewer(r.tag, running) ? " (new)" : "");
},
[&](int i) { return olderReleases_[i].date(); });
c.setFont(&fonts::small);
c.setTextColor(theme::kMuted);
c.drawString("Enter: details c: look again", 4, area.y + area.h - 9);
}
void FirmwarePage::drawMain(Canvas& c) {
auto found = files();
bool listed;
{
@@ -78,6 +254,8 @@ void FirmwarePage::draw(Canvas& c) {
case kVersion: return "Version";
case kStatus: return "Status";
case kAddress: return "Push to";
case kLatest: return "Latest release";
case kOlder: return "Older releases";
case kSdHeader: return listed ? (found.empty() ? "No .ota files in /updates" : "On the SD card:") : "Looking on the SD card...";
default: return " " + found[i - kFixed].substr(std::string(kUpdatesFolder).size() + 1);
}
@@ -87,6 +265,11 @@ void FirmwarePage::draw(Canvas& c) {
case kVersion: return versionString();
case kStatus: return update_.onProbation() ? "on probation" : "confirmed";
case kAddress: return ip.empty() ? "Wi-Fi not connected" : ip + ":" + std::to_string(UpdateService::kPort);
case kLatest: {
bool warn;
return latestText(warn);
}
case kOlder: return ">";
case kSdHeader: return "";
default: return "install >";
}
+24 -3
View File
@@ -8,6 +8,7 @@
#include "dialog_model.h"
#include "key_event.h"
#include "list_model.h"
#include "release_info.h"
#include "services/storage_service.h"
#include "services/update_service.h"
#include "services/wifi_service.h"
@@ -16,8 +17,9 @@
namespace roro {
// Settings → Firmware: the running version and its Probation, where to push Firmware Updates, and
// the Update Files on the SD card (in /updates) to install from.
// Settings → Firmware: the running version and its Probation, where to push Firmware Updates, the
// project's releases on Gitea (the latest, and the ten before it), and the Update Files on the SD
// card (in /updates) to install from.
class FirmwarePage {
public:
FirmwarePage(UpdateService& update, WifiService& wifi, StorageService& storage)
@@ -28,15 +30,34 @@ class FirmwarePage {
void draw(Canvas& c);
private:
enum Row { kVersion, kStatus, kAddress, kSdHeader, kFixed };
enum Row { kVersion, kStatus, kAddress, kLatest, kOlder, kSdHeader, kFixed };
enum class View { Main, Release, Older };
enum class Ask { None, SdFile, Release };
std::vector<std::string> files();
std::string latestText(bool& warn) const;
void openRelease(const release::Release& r);
bool installable(std::string& why) const; // the shown release: can it be installed from here?
void drawMain(Canvas& c);
void drawRelease(Canvas& c);
void drawOlder(Canvas& c);
void say(const std::string& text);
UpdateService& update_;
WifiService& wifi_;
StorageService& storage_;
ListModel list_{theme::kContent.h / theme::kLineHeight};
ListModel older_{(theme::kContent.h - 11) / theme::kLineHeight}; // above the hint line
std::unique_ptr<DialogModel> confirm_;
Ask ask_ = Ask::None;
View view_ = View::Main;
release::Release shown_; // the release page
std::vector<release::Release> olderReleases_;
uint32_t olderSeq_ = 0;
int shownTop_ = 0;
std::string message_;
uint32_t messageMs_ = 0;
// Filled on the storage task.
std::mutex lock_;
+1 -1
View File
@@ -16,7 +16,7 @@ const char* statusText(Status s) {
case Status::Connecting: return "connecting...";
case Status::Registering: return "logging in...";
case Status::Online: return "";
case Status::Paused: return "paused (Wi-Fi monitoring)";
case Status::Paused: return "paused (Wi-Fi monitoring or an update)";
case Status::Retrying: return "retrying soon";
}
return "";
+303
View File
@@ -0,0 +1,303 @@
#include "note_editor.h"
#include <Arduino.h>
#include <SD.h>
#include <ctime>
#include "cleanup_plan.h"
#include "file_list.h"
#include "file_names.h"
#include "ui/fonts.h"
#include "ui/theme.h"
#include "ui/widgets.h"
namespace roro {
using notes::NoteText;
namespace {
constexpr uint32_t kMessageMs = 4000;
// One block the size of a full note, and something left: without it, nothing is opened. Free
// memory in total isn't the measure: with IRC connected the largest free block is about 31 KB.
constexpr size_t kRoomWanted = NoteText::kMaxBytes + 8 * 1024;
const char* const kNoRoom = "Not enough memory to edit: close IRC or a Gemini page";
// On the storage task. Reads a file of up to `limit` bytes into a string that has that capacity
// already; false if it can't be read whole.
bool readWhole(const std::string& path, std::string& into, size_t limit) {
File f = SD.open(path.c_str(), FILE_READ);
if (!f) return false;
size_t size = f.size();
if (size > limit) {
f.close();
return false;
}
into.resize(size);
size_t got = size ? f.read(reinterpret_cast<uint8_t*>(&into[0]), size) : 0;
f.close();
return got == size;
}
} // namespace
void NoteEditor::say(const std::string& text) {
message_ = text;
messageMs_ = millis();
redraw_ = true;
}
std::string NoteEditor::open(const std::string& path) {
close();
if (ESP.getMaxAllocHeap() < kRoomWanted) return kNoRoom;
std::string body, left, why;
body.reserve(NoteText::kMaxBytes); // the note's own buffer from here on: read into, then handed over
bool ran = storage_.runAndWait([&]() {
File f = SD.open(path.c_str(), FILE_READ);
if (!f) {
why = "The card refused to open it";
return;
}
size_t size = f.size();
f.close();
if (size > NoteText::kMaxBytes) why = "Too big to edit: 16 KB at most";
else if (!readWhole(path, body, NoteText::kMaxBytes)) why = "The card refused to read it";
if (!why.empty()) return;
// A save that never finished: its temporary file is offered back (Q143), if there's the
// memory to look at it now. If not, it stays for the next time.
std::string tmp = path + ".tmp";
File t = SD.open(tmp.c_str(), FILE_READ);
if (!t) return;
size_t tmpSize = t.size();
t.close();
if (tmpSize > 0 && tmpSize <= NoteText::kMaxBytes && ESP.getMaxAllocHeap() < tmpSize + 8 * 1024) return;
left.reserve(tmpSize <= NoteText::kMaxBytes ? tmpSize : 0);
if (!readWhole(tmp, left, NoteText::kMaxBytes) || left == body || left.empty()) {
std::string().swap(left);
SD.remove(tmp.c_str());
}
});
if (!ran) return "No SD card";
if (!why.empty()) return why;
text_.reset(new NoteText(kCols, kRows, std::move(body)));
path_ = path;
folder_ = files::parentOf(path);
savedRevision_ = text_->revision();
problem_.clear();
message_.clear();
lastKeyMs_ = millis();
if (!left.empty()) {
recovered_ = std::move(left);
ask_ = Ask::Recover;
dialog_.reset(new DialogModel({"Keep the note", "Use the copy"}));
}
return "";
}
std::string NoteEditor::openNew(const std::string& folder) {
close();
if (ESP.getMaxAllocHeap() < kRoomWanted) return kNoRoom;
text_.reset(new NoteText(kCols, kRows));
path_.clear();
folder_ = folder;
savedRevision_ = text_->revision();
problem_.clear();
message_.clear();
lastKeyMs_ = millis();
return "";
}
void NoteEditor::close() {
if (dirty()) save();
text_.reset();
dialog_.reset();
ask_ = Ask::None;
std::string().swap(recovered_);
}
// On the main loop, waiting for the storage task: no second copy of the note is made, and at
// 16 KB the wait is a fraction of a second, when nobody has typed for five.
bool NoteEditor::save() {
if (!text_) return true;
lastTryMs_ = millis();
const std::string& body = text_->text();
if (path_.empty() && body.empty()) { // a new note nothing was typed in: no file
savedRevision_ = text_->revision();
return true;
}
std::string path = path_, why;
if (path.empty()) {
char stamp[20] = "new";
int64_t now = clock_.utcNow();
if (now >= 0) {
time_t t = static_cast<time_t>(now);
struct tm local;
localtime_r(&t, &local);
std::snprintf(stamp, sizeof stamp, "%04d%02d%02d-%02d%02d", local.tm_year + 1900, local.tm_mon + 1, local.tm_mday, local.tm_hour,
local.tm_min);
}
path = files::joinPath(folder_, notes::nameFromFirstLine(text_->firstLine(), stamp) + ".txt");
}
bool fresh = path_.empty();
bool ran = storage_.runAndWait([&]() {
if (!SD.exists(folder_.c_str()) && !SD.mkdir(folder_.c_str())) {
why = "the card refused to make " + folder_;
return;
}
if (fresh) { // a name nothing has yet: "list (2).txt"
std::string name = files::baseName(path);
for (int n = 2; n < 100 && SD.exists(path.c_str()); n++) path = files::joinPath(folder_, files::copyName(name, n));
}
std::string tmp = path + ".tmp";
File f = SD.open(tmp.c_str(), FILE_WRITE);
if (!f) {
why = "the card refused to open a file";
return;
}
size_t wrote = body.empty() ? 0 : f.write(reinterpret_cast<const uint8_t*>(body.data()), body.size());
f.close();
File check = SD.open(tmp.c_str(), FILE_READ);
bool whole = wrote == body.size() && check && check.size() == body.size();
if (check) check.close();
if (!whole) {
SD.remove(tmp.c_str());
why = "the card refused a write";
return;
}
// FAT can't rename onto a file. Between these two lines only the temporary file exists:
// the Notes list puts such a file back under its name.
if (SD.exists(path.c_str())) SD.remove(path.c_str());
if (!SD.rename(tmp.c_str(), path.c_str())) why = "the card refused to rename the file";
});
if (!ran) why = "no SD card";
if (!why.empty()) {
if (problem_ != why) say("Not saved: " + why);
problem_ = why;
return false;
}
path_ = path;
problem_.clear();
savedRevision_ = text_->revision();
redraw_ = true;
return true;
}
bool NoteEditor::onKey(const KeyEvent& e) {
if (!text_) return false;
redraw_ = true;
if (dialog_) {
dialog_->onKey(e);
int result = dialog_->result();
if (result == DialogModel::kPending) return true;
Ask asked = ask_;
ask_ = Ask::None;
dialog_.reset();
if (asked == Ask::Recover) {
if (result == 1) {
if (text_->setText(recovered_)) say("The unsaved copy is back"); // different from the card: saved in five seconds
else say("That copy is too big to edit");
} else {
std::string tmp = path_ + ".tmp";
storage_.runJob([tmp]() { SD.remove(tmp.c_str()); });
}
std::string().swap(recovered_);
return true;
}
if (asked == Ask::LeaveUnsaved && result == 1) {
savedRevision_ = text_->revision(); // given up on
return false;
}
return true;
}
lastKeyMs_ = millis();
bool page = e.shift || e.alt;
switch (e.key) {
case Key::Char: {
uint32_t lower = e.ch >= 'A' && e.ch <= 'Z' ? e.ch + 32 : e.ch;
if (e.ctrl) {
if (lower == 'a') text_->lineStart();
else if (lower == 'e') text_->lineEnd();
break;
}
if (!text_->insert(e.ch)) say("This note is full: 16 KB");
break;
}
case Key::Select:
if (!text_->insert('\n')) say("This note is full: 16 KB");
break;
case Key::Tab:
if (!text_->insertText(" ")) say("This note is full: 16 KB");
break;
case Key::Delete: text_->backspace(); break;
case Key::Left: text_->left(); break;
case Key::Right: text_->right(); break;
case Key::Up: page ? text_->pageUp() : text_->up(); break;
case Key::Down: page ? text_->pageDown() : text_->down(); break;
case Key::Back:
if (!dirty() || save()) return false;
ask_ = Ask::LeaveUnsaved;
dialog_.reset(new DialogModel({"Stay", "Leave"}));
break;
default: break;
}
return true;
}
bool NoteEditor::update(uint32_t) {
if (!text_) return false;
uint32_t now = millis();
// A save that failed is tried again every five seconds, not at every pass.
if (dirty() && !dialog_ && now - lastTryMs_ >= kSaveAfterMs &&
(now - lastKeyMs_ >= kSaveAfterMs || power_.screen() == ScreenState::Off))
save();
if (!message_.empty() && now - messageMs_ >= kMessageMs) {
message_.clear();
redraw_ = true;
}
bool r = redraw_;
redraw_ = false;
return r;
}
void NoteEditor::draw(Canvas& c) {
if (!text_) return;
const auto& area = theme::kContent;
c.setTextDatum(top_left);
// The name, and whether the card has what's on screen.
c.setFont(&fonts::small);
c.setTextColor(theme::kMuted);
std::string name = path_.empty() ? "New note" : files::fitName(files::baseName(path_), 26);
c.drawString(name.c_str(), 4, area.y + 1);
std::string state = formatBytes(text_->text().size()) + (dirty() ? (problem_.empty() ? ", typing" : ", NOT SAVED") : ", saved");
if (path_.empty() && !dirty()) state = "empty";
c.setTextDatum(top_right);
c.setTextColor(dirty() && !problem_.empty() ? theme::kWarning : theme::kMuted);
c.drawString(state.c_str(), area.w - 3, area.y + 1);
c.setTextDatum(top_left);
int top = area.y + 10;
auto rows = text_->rows();
c.setFont(&fonts::body);
c.setTextColor(theme::kText);
for (size_t i = 0; i < rows.size(); i++) c.drawString(rows[i].c_str(), 4, top + 1 + static_cast<int>(i) * theme::kLineHeight);
c.fillRect(3 + text_->cursorCol() * 6, top + text_->cursorRow() * theme::kLineHeight, 1, theme::kLineHeight, theme::kAccent);
if (text_->text().size() > static_cast<size_t>(kCols * kRows)) { // more than a screen: where we are in it
int h = kRows * theme::kLineHeight, barH = 12;
c.fillRect(area.w - 2, top + (h - barH) * text_->percent() / 100, 2, barH, theme::kMuted);
}
c.setFont(&fonts::small);
bool showMessage = !message_.empty() && millis() - messageMs_ < kMessageMs;
c.setTextColor(showMessage ? theme::kWarning : theme::kMuted);
c.drawString(showMessage ? message_.c_str() : "Fn+arrows: move Ctrl+A/E: line Back: done", 4, area.y + area.h - 9);
if (dialog_ && ask_ == Ask::Recover)
widgets::dialog(c, "Unsaved copy", "A save of this note was cut short. Its copy has " + formatBytes(recovered_.size()) + ", the note " +
formatBytes(text_->text().size()) + ".",
*dialog_);
else if (dialog_)
widgets::dialog(c, "Not saved", "The note couldn't be saved: " + problem_ + ". Leave and lose what was typed?", *dialog_);
}
} // namespace roro
+60
View File
@@ -0,0 +1,60 @@
#pragma once
#include <memory>
#include <string>
#include <vector>
#include "dialog_model.h"
#include "key_event.h"
#include "note_text.h"
#include "services/clock_service.h"
#include "services/power_service.h"
#include "services/storage_service.h"
#include "ui/canvas.h"
namespace roro {
// Edits one text file of up to 16 KB (F1, Q143-Q145): the Notes App's editor, and the Storage
// App's for `e`. It saves by itself: five seconds after the last key, when the screen turns off,
// and on close. A save writes `<file>.tmp`, then puts it in the note's place, so the note on the
// card is always a whole one.
class NoteEditor {
public:
static constexpr int kCols = 38, kRows = 8;
static constexpr uint32_t kSaveAfterMs = 5000;
NoteEditor(StorageService& storage, ClockService& clock, PowerService& power)
: storage_(storage), clock_(clock), power_(power) {}
std::string open(const std::string& path); // "" or why it can't be edited
std::string openNew(const std::string& folder); // the same; no file until there's something to save (Q142)
void close(); // saves what isn't yet
bool isOpen() const { return static_cast<bool>(text_); }
const std::string& path() const { return path_; } // "" for a new note nothing was typed in
bool onKey(const KeyEvent& e); // false: done, and saved
bool update(uint32_t nowMs); // true: draw again
void draw(Canvas& c);
private:
enum class Ask { None, Recover, LeaveUnsaved };
bool dirty() const { return text_ && text_->revision() != savedRevision_; }
bool save(); // true if the card has it now (or there was nothing to save)
void say(const std::string& text);
StorageService& storage_;
ClockService& clock_;
PowerService& power_;
std::unique_ptr<notes::NoteText> text_;
std::string path_, folder_;
uint32_t savedRevision_ = 0, lastKeyMs_ = 0, lastTryMs_ = 0;
std::string recovered_; // what a temporary file left behind holds, until the user has chosen
Ask ask_ = Ask::None;
std::unique_ptr<DialogModel> dialog_;
std::string message_, problem_;
uint32_t messageMs_ = 0;
bool redraw_ = false;
};
} // namespace roro
+346
View File
@@ -0,0 +1,346 @@
#include "notes_app.h"
#include <Arduino.h>
#include <SD.h>
#include <algorithm>
#include <cstring>
#include "file_names.h"
#include "ui/canvas.h"
#include "ui/fonts.h"
#include "ui/widgets.h"
namespace roro {
using files::baseName;
using files::joinPath;
namespace {
constexpr uint32_t kMessageMs = 4000;
constexpr size_t kTitleChars = 26;
bool endsWith(const std::string& s, const char* tail) {
size_t n = std::strlen(tail);
return s.size() >= n && s.compare(s.size() - n, n, tail) == 0;
}
} // namespace
void NotesApp::onEnter() {
view_ = ESP.getFreeHeap() < kStartFloor ? View::NoMemory : View::List;
dialog_.reset();
message_.clear();
cardPresent_ = storage_.state().present;
mended_ = false;
if (view_ == View::List) reload();
requestRedraw();
}
void NotesApp::onExit() {
editor_.close(); // saves
if (wait_ == Wait::List) ops_.cancel();
wait_ = Wait::None;
wantList_ = loaded_ = false;
list_ = files::FileList();
std::vector<uint16_t>().swap(notes_);
std::vector<std::string>().swap(titles_);
titlesFrom_ = -1;
rows_.setCount(0);
}
void NotesApp::say(const std::string& text) {
message_ = text;
messageMs_ = millis();
requestRedraw();
}
void NotesApp::reload(const std::string& select) {
selectAfter_ = select;
wantList_ = true;
}
std::string NotesApp::selectedPath() const {
int i = rows_.selected();
if (!loaded_ || i < 0 || i >= static_cast<int>(notes_.size())) return "";
return joinPath(kFolder, list_.name(notes_[i]));
}
void NotesApp::leaveEditor() {
std::string path = editor_.path();
editor_.close();
view_ = View::List;
reload(path.empty() ? "" : baseName(path));
}
void NotesApp::update(uint32_t nowMs) {
bool present = storage_.state().present;
if (present != cardPresent_) {
cardPresent_ = present;
if (view_ == View::Name) view_ = View::List;
loaded_ = false;
wantList_ = present && view_ == View::List;
requestRedraw();
}
if (view_ == View::Edit) {
if (editor_.update(nowMs)) requestRedraw();
return;
}
if (wantList_ && present && wait_ == Wait::None && !ops_.busy() && ops_.list(kFolder).empty()) {
wantList_ = false;
wait_ = Wait::List;
}
FileOps::Status s;
if (wait_ != Wait::None && ops_.finished(s)) {
onFinished(s);
requestRedraw();
}
if (!message_.empty() && millis() - messageMs_ >= kMessageMs) {
message_.clear();
requestRedraw();
}
}
void NotesApp::onFinished(const FileOps::Status& s) {
Wait was = wait_;
wait_ = Wait::None;
if (was == Wait::Work) {
if (!s.error.empty()) say(s.error);
else say(s.op == FileOps::Op::Delete ? "Deleted" : "Renamed");
return reload(selectAfter_);
}
list_.clear();
notes_.clear();
if (s.error.empty()) { // no /notes yet is an empty list, not an error
ops_.takeListing(list_);
list_.sort(sort_);
}
// A save cut between its two last steps left "x.txt.tmp" and no "x.txt": the whole note, under
// the wrong name. Put back once, then listed again.
std::vector<std::string> orphans;
for (size_t i = 0; i < list_.count(); i++) {
std::string name = list_.name(i);
if (list_.folder(i)) continue;
if (endsWith(name, ".tmp")) {
if (list_.find(name.substr(0, name.size() - 4)) < 0) orphans.push_back(name);
continue;
}
notes_.push_back(static_cast<uint16_t>(i));
}
if (!orphans.empty() && !mended_) {
mended_ = true;
storage_.runAndWait([&]() {
for (auto& name : orphans) {
std::string from = joinPath(kFolder, name);
SD.rename(from.c_str(), from.substr(0, from.size() - 4).c_str());
}
});
return reload(selectAfter_);
}
loaded_ = true;
titlesFrom_ = -1;
rows_.setCount(static_cast<int>(notes_.size()));
int at = -1;
for (size_t i = 0; i < notes_.size() && !selectAfter_.empty(); i++)
if (selectAfter_ == list_.name(notes_[i])) at = static_cast<int>(i);
rows_.select(at >= 0 ? at : selectIndex_);
selectAfter_.clear();
selectIndex_ = 0;
}
// The first line of each note on screen, read when the list moves: eight short reads.
void NotesApp::readTitles() {
if (titlesFrom_ == rows_.firstVisible()) return;
titlesFrom_ = rows_.firstVisible();
titles_.clear();
std::vector<std::string> paths;
for (int i = titlesFrom_; i < titlesFrom_ + kRows && i < static_cast<int>(notes_.size()); i++) paths.push_back(joinPath(kFolder, list_.name(notes_[i])));
titles_.resize(paths.size());
storage_.runAndWait([&]() {
for (size_t i = 0; i < paths.size(); i++) {
File f = SD.open(paths[i].c_str(), FILE_READ);
if (!f) continue;
char head[120];
int n = f.read(reinterpret_cast<uint8_t*>(head), sizeof head);
f.close();
if (n > 0) titles_[i] = notes::titleFrom(std::string(head, n), kTitleChars);
}
});
}
std::string NotesApp::titleOf(int row) {
size_t i = static_cast<size_t>(row - titlesFrom_);
if (i < titles_.size() && !titles_[i].empty()) return titles_[i];
return files::fitName(list_.name(notes_[row]), kTitleChars); // an empty note, or not a text
}
bool NotesApp::onKey(const KeyEvent& e) {
requestRedraw();
if (view_ == View::NoMemory) return false;
if (view_ == View::Edit) {
if (!editor_.onKey(e)) leaveEditor();
return true;
}
if (dialog_) {
dialog_->onKey(e);
int result = dialog_->result();
if (result == DialogModel::kPending) return true;
dialog_.reset();
if (result == 1) {
selectIndex_ = rows_.selected();
selectAfter_.clear();
std::string why = ops_.remove(target_, false);
if (why.empty()) wait_ = Wait::Work;
else say(why);
}
return true;
}
if (wantList_ || wait_ != Wait::None) return true; // a moment
if (view_ == View::Name) return onNameKey(e);
return onListKey(e);
}
bool NotesApp::onNameKey(const KeyEvent& e) {
switch (e.key) {
case Key::Char: name_.insert(e.ch); break;
case Key::Delete: name_.backspace(); break;
case Key::Left: name_.left(); break;
case Key::Right: name_.right(); break;
case Key::Back: view_ = View::List; break;
case Key::Select: {
std::string name = name_.text() + ".txt";
std::string why = files::checkName(name);
if (why.empty() && name != baseName(target_)) {
why = ops_.move(target_, false, joinPath(kFolder, name));
if (why.empty()) {
wait_ = Wait::Work;
selectAfter_ = name;
}
}
if (why.empty()) view_ = View::List;
else say(why);
break;
}
default: break;
}
return true;
}
bool NotesApp::onListKey(const KeyEvent& e) {
if (e.key == Key::Back) return false;
if (!cardPresent_ || !loaded_) return true;
uint32_t ch = e.key == Key::Char ? (e.ch >= 'A' && e.ch <= 'Z' ? e.ch + 32 : e.ch) : 0;
std::string path = selectedPath();
switch (e.key) {
case Key::Up: rows_.up(); return true;
case Key::Down: rows_.down(); return true;
case Key::Left: rows_.pageUp(); return true;
case Key::Right: rows_.pageDown(); return true;
case Key::Select: {
if (path.empty()) return true;
std::string why = editor_.open(path);
if (why.empty()) view_ = View::Edit;
else say(why);
return true;
}
case Key::Delete: ch = 'd'; break;
default: break;
}
if (ch == 'n') {
std::string why = editor_.openNew(kFolder);
if (why.empty()) view_ = View::Edit;
else say(why);
} else if (ch == 's') {
sort_ = sort_ == files::FileSort::Date ? files::FileSort::Name : files::FileSort::Date;
std::string keep = path.empty() ? "" : baseName(path);
list_.sort(sort_);
notes_.clear();
for (size_t i = 0; i < list_.count(); i++)
if (!list_.folder(i) && !endsWith(list_.name(i), ".tmp")) notes_.push_back(static_cast<uint16_t>(i));
for (size_t i = 0; i < notes_.size(); i++)
if (keep == list_.name(notes_[i])) rows_.select(static_cast<int>(i));
titlesFrom_ = -1;
say(sort_ == files::FileSort::Date ? "Newest first" : "By file name");
} else if (path.empty()) {
// nothing selected: the keys below need a note
} else if (ch == 'd') {
target_ = path;
question_ = "Delete " + files::fitName(baseName(path), 22) + ", \"" + titleOf(rows_.selected()).substr(0, 20) + "\"? It can't be undone.";
dialog_.reset(new DialogModel({"Cancel", "Delete"}));
} else if (ch == 'r') {
target_ = path;
std::string name = baseName(path);
size_t dot = name.rfind('.');
name_.setText(dot == std::string::npos || dot == 0 ? name : name.substr(0, dot));
view_ = View::Name;
}
return true;
}
void NotesApp::draw(Canvas& c) {
lastDrawMs_ = millis();
const auto& area = theme::kContent;
c.setTextDatum(top_left);
if (view_ == View::NoMemory) {
c.setFont(&fonts::bold);
c.setTextColor(theme::kWarning);
c.drawString("Not enough memory", 4, area.y + 4);
c.setFont(&fonts::body);
c.setTextColor(theme::kMuted);
c.drawString("Close what's running (IRC, a page", 4, area.y + 22);
c.drawString("in Gemini) and open Notes again.", 4, area.y + 22 + theme::kLineHeight);
return;
}
if (view_ == View::Edit) return editor_.draw(c);
c.setFont(&fonts::small);
c.setTextColor(theme::kMuted);
c.drawString(kFolder, 4, area.y + 1);
if (loaded_) {
std::string count = std::to_string(notes_.size()) + (notes_.size() == 1 ? " note" : " notes");
if (list_.more() > 0) count = "the first " + std::to_string(notes_.size()) + " notes";
c.setTextDatum(top_right);
c.drawString(count.c_str(), area.w - 3, area.y + 1);
c.setTextDatum(top_left);
}
theme::Rect rows{area.x, area.y + 10, area.w, kRows * theme::kLineHeight};
c.setFont(&fonts::body);
if (!storage_.state().present) {
c.setTextColor(theme::kWarning);
c.drawString("No SD card", 4, rows.y + 4);
c.setTextColor(theme::kMuted);
c.drawString("Notes are kept on the card.", 4, rows.y + 4 + theme::kLineHeight);
} else if (!loaded_) {
// a moment
} else if (notes_.empty()) {
c.setTextColor(theme::kMuted);
c.drawString("No notes yet.", 4, rows.y + 4);
c.drawString("n starts one.", 4, rows.y + 4 + theme::kLineHeight);
} else {
readTitles();
widgets::list(
c, rows_, rows, [&](int i) { return titleOf(i); },
[&](int i) {
std::string stamp = files::formatStamp(list_.modified(notes_[i]));
return stamp.size() >= 10 ? stamp.substr(0, 10) : stamp;
});
}
c.setFont(&fonts::small);
bool showMessage = !message_.empty() && millis() - messageMs_ < kMessageMs;
c.setTextColor(showMessage ? theme::kWarning : theme::kMuted);
c.drawString(showMessage ? message_.c_str() : "n: new Enter: open r: name d: del s: sort", 4, area.y + area.h - 9);
if (view_ == View::Name) {
theme::Rect box{16, 44, theme::kWidth - 32, 48};
c.fillRect(box.x, box.y, box.w, box.h, theme::kBackground);
c.drawRect(box.x, box.y, box.w, box.h, theme::kAccent);
c.setFont(&fonts::bold);
c.setTextColor(theme::kText);
c.drawString("File name (.txt)", box.x + 6, box.y + 4);
widgets::lineEditor(c, name_, {box.x + 6, box.y + 22, box.w - 12, theme::kLineHeight + 4});
}
if (dialog_) widgets::dialog(c, "Delete", question_, *dialog_);
}
} // namespace roro
+71
View File
@@ -0,0 +1,71 @@
#pragma once
#include <memory>
#include <string>
#include <vector>
#include "app.h"
#include "apps/note_editor.h"
#include "dialog_model.h"
#include "file_list.h"
#include "line_editor.h"
#include "list_model.h"
#include "services/file_ops.h"
#include "ui/theme.h"
namespace roro {
// Notes (docs/milestones/F1.md, Q141-Q150): plain text files in /notes, listed by their first line,
// newest first. n starts one, Enter opens it in the editor, which saves by itself; r renames the
// file, d deletes it after asking, s sorts by name or by date.
class NotesApp : public App {
public:
NotesApp(FileOps& ops, StorageService& storage, ClockService& clock, PowerService& power)
: ops_(ops), storage_(storage), editor_(storage, clock, power) {}
void onEnter() override;
void onExit() override;
bool onKey(const KeyEvent& e) override;
bool textEntryActive() const override { return view_ == View::Edit || view_ == View::Name; }
void update(uint32_t nowMs) override;
void draw(Canvas& c) override;
private:
enum class View { List, Edit, Name, NoMemory };
enum class Wait { None, List, Work };
static constexpr int kRows = 8;
static constexpr size_t kStartFloor = 55 * 1024; // Q86, Q144
static constexpr const char* kFolder = "/notes";
void reload(const std::string& select = "");
void onFinished(const FileOps::Status& s);
bool onListKey(const KeyEvent& e);
bool onNameKey(const KeyEvent& e);
void leaveEditor();
std::string selectedPath() const; // "" in an empty list
std::string titleOf(int row);
void readTitles();
void say(const std::string& text);
FileOps& ops_;
StorageService& storage_;
NoteEditor editor_;
View view_ = View::List;
files::FileList list_;
std::vector<uint16_t> notes_; // the entries of list_ that are notes
files::FileSort sort_ = files::FileSort::Date;
ListModel rows_{kRows};
bool wantList_ = false, loaded_ = false, cardPresent_ = false, mended_ = false;
std::string selectAfter_;
int selectIndex_ = 0;
Wait wait_ = Wait::None;
std::vector<std::string> titles_; // of the rows on screen
int titlesFrom_ = -1;
std::unique_ptr<DialogModel> dialog_;
std::string target_, question_;
LineEditor name_{40};
std::string message_;
uint32_t messageMs_ = 0, lastDrawMs_ = 0;
};
} // namespace roro
+31 -1
View File
@@ -51,6 +51,7 @@ void StorageApp::onExit() {
ops_.cancel();
wait_ = Wait::None;
}
noteEditor_.close(); // saves
viewer_.close();
wantList_ = false;
loaded_ = false;
@@ -105,7 +106,8 @@ void StorageApp::update(uint32_t nowMs) {
wantList_ = present;
clip_ = Item();
if (view_ == View::Viewer) viewer_.close();
if (view_ == View::Details || view_ == View::Name || view_ == View::Viewer) view_ = View::Browse;
if (view_ == View::Editor) noteEditor_.close();
if (view_ == View::Details || view_ == View::Name || view_ == View::Viewer || view_ == View::Editor) view_ = View::Browse;
requestRedraw();
}
if (wantList_ && present && wait_ == Wait::None && !ops_.busy() && ops_.list(want_).empty()) {
@@ -114,6 +116,7 @@ void StorageApp::update(uint32_t nowMs) {
waitSinceMs_ = nowMs;
}
if (view_ == View::Viewer && viewer_.update(nowMs)) requestRedraw();
if (view_ == View::Editor && noteEditor_.update(nowMs)) requestRedraw();
FileOps::Status s;
if (wait_ != Wait::None && ops_.finished(s)) {
onFinished(s);
@@ -280,6 +283,32 @@ bool StorageApp::onKey(const KeyEvent& e) {
}
return true;
}
if (view_ == View::Editor) {
if (!noteEditor_.onKey(e)) {
std::string name = baseName(noteEditor_.path());
noteEditor_.close();
view_ = View::Browse;
open(cwd_, name); // its size and date have changed
}
return true;
}
if (view_ == View::Viewer && viewer_.showingText() && e.key == Key::Char && (e.ch == 'e' || e.ch == 'E')) {
// Edit it (Q146), if the rules and its size allow.
std::string path = viewer_.path(), why = ops_.whyReadOnly(path, false);
if (why.empty() && viewer_.size() > notes::NoteText::kMaxBytes) why = "Too big to edit: 16 KB at most";
if (why.empty()) {
viewer_.close();
why = noteEditor_.open(path);
if (why.empty()) view_ = View::Editor;
else {
view_ = View::Browse;
say(why);
}
} else {
viewer_.say(why);
}
return true;
}
if (view_ == View::Viewer) {
if (!viewer_.onKey(e)) {
viewer_.close();
@@ -453,6 +482,7 @@ void StorageApp::draw(Canvas& c) {
return;
case View::Maintenance: maintenance_.draw(c); return;
case View::Viewer: viewer_.draw(c); return;
case View::Editor: noteEditor_.draw(c); return;
case View::Details: {
std::vector<std::string> lines;
auto measure = widgets::bodyMeasure(c);
+6 -4
View File
@@ -7,6 +7,7 @@
#include "app.h"
#include "apps/file_viewer.h"
#include "apps/maintenance_page.h"
#include "apps/note_editor.h"
#include "dialog_model.h"
#include "event_bus.h"
#include "file_list.h"
@@ -25,17 +26,17 @@ namespace roro {
// usage, Storage Clean-up and erasing the card, behind a warning (Q128).
class StorageApp : public App {
public:
StorageApp(FileOps& ops, StorageService& storage, ClockService& clock, UpdateService& update, EventBus& bus)
: ops_(ops), storage_(storage), bus_(bus), maintenance_(storage, clock, bus), viewer_(storage, update) {}
StorageApp(FileOps& ops, StorageService& storage, ClockService& clock, UpdateService& update, PowerService& power, EventBus& bus)
: ops_(ops), storage_(storage), bus_(bus), maintenance_(storage, clock, bus), viewer_(storage, update), noteEditor_(storage, clock, power) {}
void onEnter() override;
void onExit() override;
bool onKey(const KeyEvent& e) override;
bool textEntryActive() const override { return view_ == View::Name; }
bool textEntryActive() const override { return view_ == View::Name || view_ == View::Editor; }
void update(uint32_t nowMs) override;
void draw(Canvas& c) override;
private:
enum class View { Browse, Details, Name, Viewer, Maintenance, NoMemory };
enum class View { Browse, Details, Name, Viewer, Editor, Maintenance, NoMemory };
enum class Ask { None, Delete, Replace, Maintenance };
enum class Wait { None, List, CountToDelete, CountForDetails, Work }; // what the running operation is for
static constexpr int kRows = 8;
@@ -67,6 +68,7 @@ class StorageApp : public App {
EventBus& bus_;
MaintenancePage maintenance_;
FileViewer viewer_;
NoteEditor noteEditor_; // `e` in the text viewer (Q146)
View view_ = View::Browse;
std::string cwd_ = "/", want_ = "/"; // the folder on screen; the one being read
+89 -1
View File
@@ -13,6 +13,7 @@
#include "apps/irc_app.h"
#include "apps/launcher_app.h"
#include "apps/lora_scanner_app.h"
#include "apps/notes_app.h"
#include "apps/settings_app.h"
#include "apps/storage_app.h"
#include "apps/system_app.h"
@@ -37,6 +38,7 @@
#include "services/clock_service.h"
#include "services/debug_console.h"
#include "services/file_ops.h"
#include "update_check.h"
#include "services/gemini_service.h"
#include "services/gnss_service.h"
#include "services/power_service.h"
@@ -181,6 +183,8 @@ void setup() {
wifi = new WifiService(settings, *savedNetworks, *clockService);
update = new UpdateService(nvs, *wifi, *savedNetworks, *storageService, bus, settings);
fileOps = new FileOps(*storageService, filesInUse);
update->enableDailyCheck();
update->holdMemory = [](bool hold) { irc->holdForUpdate(hold); }; // see UpdateService::holdMemory
irc = new IrcService(nvs, "roro_" + identity::defaultShortName(), *wifi, *storageService, *clockService, bus);
notifier = new Notifier(bus, settings);
notifier->onShow = [](uint32_t now, uint32_t until) { power->onNotification(now, until); };
@@ -210,7 +214,10 @@ void setup() {
apps->registerApp({"gnss", "GNSS", false, new GnssApp(*gnssService, settings)});
apps->registerApp({"gemini", "Gemini", false, new GeminiApp(*geminiService)});
apps->registerApp({"lora", "LoRa Scanner", false, new LoraScannerApp(*radioService, *loraCapture, settings, *clockService)});
apps->registerApp({"storage", "Storage", false, new StorageApp(*fileOps, *storageService, *clockService, *update, bus)});
apps->registerApp({"storage", "Storage", false, new StorageApp(*fileOps, *storageService, *clockService, *update, *power, bus)});
apps->registerApp({"notes", "Notes", false, new NotesApp(*fileOps, *storageService, *clockService, *power)});
// Leaving the foreground App makes it save: a note being typed, when the device is powered off.
power->beforePowerOff = []() { apps->home(); };
apps->registerApp({"system", "System", false,
new SystemApp(*wifi, *battery, *storageService, *radioService, *gnssService, nvs)});
apps->registerApp({"settings", "Settings", false,
@@ -437,6 +444,84 @@ static void fileOpsStep() {
else console.printf("%s: ok\n", name);
}
// `update ...`: the project's releases on Gitea (R1, #6). The answers come from the Update Service's
// task a moment later; updateStep() prints them.
static int updateWatch = 0; // 1: a check, 2: a list
static void printReleases(bool list) {
GiteaReleases& g = update->gitea();
if (g.status() == GiteaReleases::Status::Failed) return (void)console.printf("update: %s\n", g.error().c_str());
std::string running = update->runningVersion();
if (!list) {
release::Release r;
if (!g.latest(r)) return (void)console.println("update: nothing known yet");
console.printf("update: latest %s of %s, %u bytes: %s (running %s)\n", r.tag.c_str(), r.date().c_str(), (unsigned)r.otaSize,
release::isNewer(r, running) ? "newer" : "not newer", running.c_str());
console.printf("update: %s\n", r.notes.c_str());
return;
}
for (auto& r : g.list())
console.printf("update: %-8s %s %8u B %s\n", r.tag.c_str(), r.date().c_str(), (unsigned)r.otaSize, r.notes.substr(0, 60).c_str());
console.println("update: end of list");
}
static void updateStep() {
if (!updateWatch || update->giteaBusy()) return;
#ifdef RORO_DEBUG
if (updateWatch == 3) {
console.printf("update: probe: %s\n", update->probeResult().c_str());
updateWatch = 0;
return;
}
#endif
printReleases(updateWatch == 2);
updateWatch = 0;
}
static void updateCommand(const String& args) {
if (args == "check" || args == "list") {
if (update->giteaBusy()) return (void)console.println("update: busy");
args == "check" ? update->requestCheck() : update->requestList();
updateWatch = args == "check" ? 1 : 2;
} else if (args == "status") {
GiteaReleases& g = update->gitea();
console.printf("update: running %s, failed here before: %s, daily check %s, heap %u\n", update->runningVersion().c_str(),
update->failedVersion().empty() ? "none" : update->failedVersion().c_str(),
settings.getBool(Setting::CheckUpdates) ? "on" : "off", (unsigned)ESP.getFreeHeap());
console.printf("update: gitea %s %s\n", g.status() == GiteaReleases::Status::Done ? "done" : g.status() == GiteaReleases::Status::Failed ? "failed" : g.status() == GiteaReleases::Status::Busy ? "busy" : "never asked", g.error().c_str());
printReleases(false);
} else if (args.startsWith("install ")) {
String rest = args.substring(8);
bool force = rest.endsWith(" force");
if (force) rest.remove(rest.length() - 6);
#ifndef RORO_DEBUG
force = false; // only the Debug Console may install on a Debug Build, which a release isn't
#endif
std::string why = update->requestInstall(rest.c_str(), force);
console.printf("update: %s\n", why.empty() ? "installing" : why.c_str());
#ifdef RORO_DEBUG
} else if (args.startsWith("probe ")) { // update probe <host> [path]: is that server's certificate accepted?
String rest = args.substring(6);
int space = rest.indexOf(' ');
update->requestProbe((space < 0 ? rest : rest.substring(0, space)).c_str(), space < 0 ? "/" : rest.substring(space + 1).c_str());
updateWatch = 3;
} else if (args.startsWith("damage ")) { // update damage cut <bytes> | flip <offset>: for the next download
long n = args.substring(args.lastIndexOf(' ') + 1).toInt();
args.startsWith("damage cut") ? update->damageNextDownload(n, -1) : update->damageNextDownload(-1, n);
console.printf("update: the next download will be %s at byte %ld\n", args.startsWith("damage cut") ? "cut" : "damaged", n);
} else if (args == "daily") { // forget today's check: the daily one runs again at once, if it may
update->forgetToday();
console.println("update: the daily check will run at the next tick if Wi-Fi, the clock and memory allow");
} else if (args.startsWith("pretend ")) { // update pretend v0.9.0 | off: what the comparisons take as running
update->pretendVersion(args.substring(8) == "off" ? "" : args.substring(8).c_str());
console.printf("update: running %s\n", update->runningVersion().c_str());
#endif
} else {
console.println("update: check | list | status | install <tag>");
}
}
static void fileCommand(const String& line) {
int space = line.indexOf(' ');
std::string command = line.substring(0, space).c_str(), rest = line.substring(space + 1).c_str();
@@ -503,6 +588,7 @@ static const char* const kHelp =
"gemini get <url> fetch a Gemini page and report header, size, certificate, heap\n"
"irc start | irc stop | irc dump | irc say <buffer> <text>\n"
"install <path.ota> Update from SD\n"
"update check | list | status | install <tag> the project's releases on Gitea\n"
"sd card | sd list | cat <path> | log <text> | burst | sound on|off | short | normal\n"
#ifdef RORO_DEBUG
"crash abort|wdt crash on purpose (to test crash reports and Safe Mode)\n"
@@ -567,6 +653,7 @@ static void runCommand(String line) {
esp_log_level_set("*", static_cast<esp_log_level_t>(constrain(level, 0, 5)));
console.printf("log level: %d\n", constrain(level, 0, 5));
}
if (line.startsWith("update ")) updateCommand(line.substring(7));
if (line.startsWith("cp ") || line.startsWith("mv ") || line.startsWith("rm ") || line.startsWith("mkdir ") ||
line.startsWith("du ") || line == "cancel")
fileCommand(line);
@@ -1006,6 +1093,7 @@ static void loopPass() {
if (noiseTest) noiseTest->step(now);
#endif
noteStableOnce(now);
updateStep();
fileOpsStep();
uploadStep();
printListingWhenReady();

Some files were not shown because too many files have changed in this diff Show More