Compare commits

...
Author SHA1 Message Date
twislaandClaude Opus 5.5 544bd726df GNSS App: a Compass, with Places to be led back to and a level
CI / build (pull_request) Successful in 2m20s
Site / build (pull_request) Successful in 10s
Tab goes on from the Sky to a third view (issue #16): a rose that turns
with the device, the heading, where north came from and how long ago,
the sun on the rose, and a level. m marks where you stand as a Place,
t picks one as the target: an arrowhead on the rose, its distance and
bearing. The sensor's directions were checked by hand on the device.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0162FokPdvY2KsS4NBfwyWPk
2026-10-11 17:01:57 +02:00
twislaandClaude Opus 5.5 65a9643910 Console: imu prints what the motion sensor reads
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0162FokPdvY2KsS4NBfwyWPk
2026-10-11 17:01:57 +02:00
twislaandClaude Opus 5.5 a87c3016cc GNSS: Places, kept as GPX waypoints
A Place is a named position the user marked (issue #16). The list is
read from and written to a GPX file, so a map program opens it and
waypoints made by one are read here. Host-tested.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0162FokPdvY2KsS4NBfwyWPk
2026-10-11 17:01:57 +02:00
twislaandClaude Opus 5.5 da311a11b6 GNSS: a heading from the gyroscope, the course and the sun
The device has no magnetometer (issue #16): north is given by the course
over ground while walking, or by aiming at the sun, and the gyroscope
follows the turn around the vertical in between. With the sun's position
from the time and the place, the bearing to a point, the 16 points and
distances as text. Host-tested.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0162FokPdvY2KsS4NBfwyWPk
2026-10-11 17:01:57 +02:00
twisla fd534af971 Merge pull request 'Launcher grid with icons, themes, Settings in groups, the website's colours' (#97) from launcher-grid into main
Site / build (push) Successful in 12s
CI / build (push) Successful in 3m11s
2026-10-09 22:25:49 +00:00
twislaandClaude Opus 5.5 0c52613b72 Settings: its rows in five groups
CI / build (pull_request) Successful in 2m22s
Site / build (pull_request) Successful in 10s
Settings had grown to 21 rows in one list. It opens on five groups (This
device, Display, GNSS and radio, Network, System); Enter opens one, Back
returns to the groups, and Back from the groups leaves Settings.

SettingsMenu holds the groups and which one is open (host-tested: every
setting is in exactly one group). The guide, the how-tos, the README,
the scripts' messages and the firmware's own name the new paths, such as
"Settings > System > Firmware".

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0162FokPdvY2KsS4NBfwyWPk
2026-10-10 00:11:52 +02:00
twislaandClaude Opus 5.5 37335b4829 UI: seven themes, each dark and light, chosen in the Settings
Settings > Theme and Settings > Light or dark pick the colours of every
screen (issue #10): roro9stack (the website's, the default), Catppuccin,
Dracula, Nord, ANSI terminal, Gruvbox and Solarized.

- A palette is 14 roles (lib/ui/src/palette.h). theme::kText and the
  others are now references into the one in use, so the Apps are
  unchanged; the main loop applies it when a Setting changes.
- Every colour is one the RGB332 frame buffer holds exactly: the themes'
  own were rounded, and those that fell together or lost contrast were
  picked by hand. test_palette checks exactness and 18 contrast ratios
  for each palette.
- The Sky view's constellation colours come from the theme.
- `theme [0-6] [light|dark]` on the consoles.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0162FokPdvY2KsS4NBfwyWPk
2026-10-10 00:11:52 +02:00
twislaandClaude Opus 5.5 10627e6e18 Launcher: the selected icon in slate, the name in white
The selected icon was dark blue on its cyan tile, which read as black:
it is the Status Bar's slate now. The App's name under the grid is
white instead of cyan.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0162FokPdvY2KsS4NBfwyWPk
2026-10-09 23:23:20 +02:00
twislaandClaude Opus 5.5 e2326e113b Launcher: a grid of icons, with badges; the list stays as a Setting
The Launcher shows the Apps as a 4 x 3 grid of 32 x 32 icons, the
selected one's name under it (issue #9). The icons are the website's
own, doubled, and two drawn the same way for SSH and the Shell; they
are PNGs in assets/icons, turned into arrays by scripts/make_icons.py,
which CI checks. The selected tile is the website's: dark blue on cyan,
with notched corners.

- GridModel (lib/ui, host-tested) holds the selection and the scrolling.
- App::badge(): a dot on the tile for unread IRC messages, a Track
  recording, a Capture running, an SSH session open.
- Settings > Launcher: Grid or List.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0162FokPdvY2KsS4NBfwyWPk
2026-10-09 23:14:37 +02:00
twislaandClaude Opus 5.5 aadfd8cb37 UI: the website's colours, on every screen
The theme takes the website's palette, each a colour the RGB332 frame
buffer holds exactly: cyan for the accent, a selected row and a chosen
button in cyan with dark blue text, a slate Status Bar (the grey it
asked for was shown as a dull olive), the website's orange for
warnings and its pink for messages. "Good" (a Fix, the quietest
channel) keeps a green of its own, which the website doesn't have.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0162FokPdvY2KsS4NBfwyWPk
2026-10-09 23:14:37 +02:00
twislaandClaude Opus 5.5 b1c80c912f SSH App: its messages were cleared the moment they were set
The bottom-line message (a malformed address, not enough memory, a
session still closing) is timed from millis() when a key sets it, and
update() compared that with the pass's own time, read before the keys
were handled. The unsigned difference wrapped, so the message was
cleared before it was ever drawn: Enter on a new connection that was
refused looked like it did nothing.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0162FokPdvY2KsS4NBfwyWPk
2026-10-09 23:14:20 +02:00
twisla 015a9c59bc Merge pull request 'LoRa Scanner: a MeshCore preset (the default), its packets and public channel read' (#96) from meshcore-scanner into main
CI / build (push) Successful in 1m0s
Site / build (push) Successful in 13s
2026-10-09 20:23:28 +00:00
92 changed files with 2790 additions and 183 deletions
+3
View File
@@ -83,6 +83,9 @@ jobs:
git checkout -q --detach "${{ github.sha }}"
git describe --tags --always
- name: The icons are what their pictures give
run: python3 scripts/make_icons.py --check
- name: Host tests, and their coverage of lib/
if: github.event_name != 'workflow_dispatch'
run: |
+11
View File
@@ -64,6 +64,17 @@ _Avoid_: lock, signal
A route recorded from GNSS positions to a GPX file on the SD card, started and stopped by the user.
_Avoid_: trace, log (a Log is recorded on its own)
**Compass**:
The third view of the GNSS App: a rose turned by the Heading, and the way to the target Place.
**Heading**:
Where the top of the device points, in degrees from true north. It is given by the course over ground while walking or by aiming at the sun, and held by the gyroscope in between.
_Avoid_: course (the course is the direction of travel, from the receiver), bearing (a bearing is the direction to somewhere else)
**Place**:
A named position the user marked, kept as a GPX waypoint on the SD card, that the Compass can lead back to.
_Avoid_: waypoint, POI
**Wi-Fi Service**:
The Service that owns the Wi-Fi radio. It's always in exactly one mode: *Off*, *Connected* (joined to a Saved Network) or *Monitoring* (passively observing). When Wi-Fi is enabled in Settings, it stays Connected whenever a Saved Network is in range. It goes Monitoring only while Wi-Fi Tools needs it, then reconnects.
_Avoid_: network manager
+14 -10
View File
@@ -7,7 +7,7 @@ A multi-app firmware for the **M5Stack Cardputer ADV** with the **Cap LoRa-1262*
What it does today:
- **LoRa Scanner:** every packet it hears, with the Meshtastic or MeshCore header read; a spectrum Sweep; captures for Wireshark. It listens and never transmits: the mesh messenger is the next milestone.
- **GNSS:** position, sky view, tracks as GPX.
- **GNSS:** position, sky view, a compass that leads back to a marked place, tracks as GPX.
- **Gemini:** a browser, with bookmarks and pages saved for offline.
- **IRC:** over TLS, with logs on the card.
- **Wi-Fi Tools:** the networks around, sorted, filtered, logged.
@@ -43,6 +43,8 @@ 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/make_icons.py` turns the Launcher's icons (`assets/icons/<App id>.png`, 32 × 32, one colour) into the arrays in `src/ui/icons.cpp`; run it after changing a picture. CI fails when the two don't match.
`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 6 minutes; later builds take about 15 seconds when little has changed. The platform knows the framework is already rebuilt by `sdkconfig.defaults` in the project folder, which it writes and git ignores: delete it and the next build rebuilds the framework. CI keeps that file, a build cache and ccache in its volume (docs/milestones/R1.md).
@@ -92,19 +94,19 @@ scripts/ota_keygen.sh # once: creates the signing key (see ADR
scripts/flash.sh --ota 10.39.39.12 # build, sign and push; or set RORO_OTA_HOST
```
The device shows the push address in **Settings → Firmware**. It installs a correctly signed update right away, restarts (waiting up to 60 s if you're typing), and runs the new firmware on **Probation**. If the new firmware crashes, or can't reconnect Wi-Fi within 3 minutes, it rolls back to the previous one and says so.
The device shows the push address in **Settings → System → Firmware**. It installs a correctly signed update right away, restarts (waiting up to 60 s if you're typing), and runs the new firmware on **Probation**. If the new firmware crashes, or can't reconnect Wi-Fi within 3 minutes, it rolls back to the previous one and says so.
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).
To install from the SD card instead, copy the `.ota` file from `.pio/build/cardputer-adv/` into `/updates` on the card, then use **Settings → System → 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. (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**:
With no PC and no card, the device can install the project's releases itself (docs/milestones/R1.md). In **Settings → System → 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.
- **Settings → System → 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 > System > 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.
@@ -114,7 +116,7 @@ The connection is checked against the two ISRG roots Let's Encrypt chains end in
## Networks without DHCP
Each Saved Network gets its address automatically (DHCP) or has a Fixed one (docs/milestones/S1.md): in Settings > Wi-Fi, Enter on a network opens its page, where "IP address" switches between Automatic and Fixed, with an address, a prefix length (24 is 255.255.255.0) and an optional gateway. Switching to Fixed starts from what the network is giving the device at that moment. The setting is checked and applied when you leave the page. IPv4 only.
Each Saved Network gets its address automatically (DHCP) or has a Fixed one (docs/milestones/S1.md): in Settings > Network > Wi-Fi, Enter on a network opens its page, where "IP address" switches between Automatic and Fixed, with an address, a prefix length (24 is 255.255.255.0) and an optional gateway. Switching to Fixed starts from what the network is giving the device at that moment. The setting is checked and applied when you leave the page. IPv4 only.
"DNS and NTP" on the same screen holds two DNS servers (9.9.9.9 and 1.1.1.1 by default), used on Fixed networks, or on every network with "Always use my DNS"; and two NTP servers (pool.ntp.org and time.cloudflare.com), used after any the network's DHCP offers. Enter on "Status" shows what's in use and where each value came from.
@@ -138,7 +140,7 @@ On a page, `b` bookmarks it, `s` saves it to the SD card to read offline (a non-
## LoRa Scanner
The LoRa Scanner (docs/milestones/M3.md) listens with the Cap's radio and **never transmits**. The Sniffer lists what it hears, newest first: time, RSSI, SNR, and for Meshtastic packets the sender and receiver (their last 4 hex digits) and hops; for MeshCore packets what they are (an advert with the node's name, a message with the first byte of each node's key, a message on the public channel read, with the name its sender gives; any other channel message with the channel's byte) and the hops in their path. Enter shows a packet's details: what is never encrypted (the Meshtastic header; MeshCore's header, path and, in an advert, the node's name, kind, key and position; and a public channel message's sender, time and text, decrypted with the channel's published key) and a hex dump. `p` picks **MeshCore** (the default; its EU/UK Narrow setting: 869.618 MHz, 62.5 kHz, SF8, CR 4/8) or one of the 7 Meshtastic presets allowed in EU868, `c` starts or stops a Capture: a pcap file with LoRaTap headers in `/captures/lora/`, for Wireshark. A Capture keeps recording with the App closed; otherwise the radio sleeps when the App isn't open. Tab switches to **Sweep**: the signal strength across 863–870 MHz in 100 kHz steps, as bars with peak hold and a waterfall, with the Sniffer's frequency marked; the Sniffer is paused meanwhile and picks up where it was. The GNSS receiver on the same Cap raises the radio's noise floor by 8 dB while it runs: Settings > "Pause GNSS for LoRa" (off by default) puts it in standby while the radio listens, except during a Track. The Status Bar shows `L` while the radio listens (bright for a moment on each packet), `SW` while sweeping, and `CAP` while capturing.
The LoRa Scanner (docs/milestones/M3.md) listens with the Cap's radio and **never transmits**. The Sniffer lists what it hears, newest first: time, RSSI, SNR, and for Meshtastic packets the sender and receiver (their last 4 hex digits) and hops; for MeshCore packets what they are (an advert with the node's name, a message with the first byte of each node's key, a message on the public channel read, with the name its sender gives; any other channel message with the channel's byte) and the hops in their path. Enter shows a packet's details: what is never encrypted (the Meshtastic header; MeshCore's header, path and, in an advert, the node's name, kind, key and position; and a public channel message's sender, time and text, decrypted with the channel's published key) and a hex dump. `p` picks **MeshCore** (the default; its EU/UK Narrow setting: 869.618 MHz, 62.5 kHz, SF8, CR 4/8) or one of the 7 Meshtastic presets allowed in EU868, `c` starts or stops a Capture: a pcap file with LoRaTap headers in `/captures/lora/`, for Wireshark. A Capture keeps recording with the App closed; otherwise the radio sleeps when the App isn't open. Tab switches to **Sweep**: the signal strength across 863–870 MHz in 100 kHz steps, as bars with peak hold and a waterfall, with the Sniffer's frequency marked; the Sniffer is paused meanwhile and picks up where it was. The GNSS receiver on the same Cap raises the radio's noise floor by 8 dB while it runs: Settings > GNSS and radio > "Pause GNSS for LoRa" (off by default) puts it in standby while the radio listens, except during a Track. The Status Bar shows `L` while the radio listens (bright for a moment on each packet), `SW` while sweeping, and `CAP` while capturing.
## Storage
@@ -186,7 +188,7 @@ The terminal (`lib/term`, host-tested) understands what a shell, `less`, `top`,
## VPN
A WireGuard tunnel (docs/milestones/N1.md), over whatever Wi-Fi the device is on: one peer, IPv4. Copy a client's `.conf` to the card as `/vpn/wg0.conf` and import it in Settings > VPN (or `vpn import`); the configuration, private key included, is then kept in the device and never shown, and Settings offers to delete the file. A switch brings the tunnel up until the next restart; "Start with Wi-Fi" does it every time. It waits for the clock, which WireGuard needs. `VPN` shows in the Status Bar, bright once the server has answered.
A WireGuard tunnel (docs/milestones/N1.md), over whatever Wi-Fi the device is on: one peer, IPv4. Copy a client's `.conf` to the card as `/vpn/wg0.conf` and import it in Settings > Network > VPN (or `vpn import`); the configuration, private key included, is then kept in the device and never shown, and Settings offers to delete the file. A switch brings the tunnel up until the next restart; "Start with Wi-Fi" does it every time. It waits for the clock, which WireGuard needs. `VPN` shows in the Status Bar, bright once the server has answered.
**What goes through it is one of two things:** everything, when AllowedIPs has `0.0.0.0/0` (and then nothing leaves the device while the server is silent), or the one subnet the device's tunnel address is in. A home network behind the server needs the first: lwIP routes by an interface's subnet or by default, nothing finer, and the import says how many ranges it can't reach. With the tunnel up the Debug Console and the Update Service answer on the tunnel address too, behind their token and their signature. It costs 63 KB of flash and under 2 KB of memory while up.
@@ -203,6 +205,7 @@ The Shell App (docs/milestones/S1.md) runs the commands below on the device's ow
| `burst` | Publishes 5 Notifications at once |
| `key up\|down\|left\|right\|select\|back\|home\|del\|tab\|space\|help\|shot`, or `key <char>` | Injects a key press (`help` is Fn+h: the keys of the screen that is showing; `shot` is Fn+p: a screenshot). `ctrl-`, `alt-` and `shift-` before it hold that key: `key ctrl-down`, `key alt-up`, `key ctrl-b` |
| `sound on` / `sound off` | Toggles the Sound setting (beep + LED) |
| `theme` / `theme <0-6> [light\|dark]` | Lists the colour themes, or picks one and its side |
| `short` / `normal` | Screen timeouts 5 s / 10 s, or 30 s / 60 s |
| `wifi add <ssid><TAB><password>` | Adds a Saved Network (so credentials stay out of the repo) |
| `wifi ip <ssid> dhcp` / `wifi ip <ssid> <address>/<prefix> [gateway]` | A Saved Network's IP setting: Automatic, or Fixed. Add `try <seconds>` to go back to the previous setting unless `wifi ip keep` follows |
@@ -228,7 +231,7 @@ The Shell App (docs/milestones/S1.md) runs the commands below on the device's ow
| `ls [folder]` / `du <path>` | Lists a folder of the SD card with sizes and dates, or counts the files and bytes under a path |
| `screenshot [seconds]` | The screen as a PNG in `/screenshots` on the card, now or after a pause to get to the screen you want (240 x 135, about 33 KB). Over the Debug Console a bare `screenshot` sends the screen to the PC instead |
| `cp [-f] <from> <to>` / `mv [-f] <from> <to>` / `rm [-r] [-f] <path>` / `mkdir <path>` / `cancel` | What the Storage App does, with its rules: copy (folders too), move or rename, delete (`rm -r` for a folder and what's in it, as Unix has it), new folder. `-f` replaces a file that's in the way; `*` and `?` in the last part of a path (`ls`, `du`, `rm`, `cp`, `mv`) run the command for each name matched, 64 at most; 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 |
| `install <path>` | Update from SD with that `.ota` file, as Settings → System → 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 |
| `update pretend <version>` / `update probe <host>` / `update damage cut\|flip <n>` / `update daily` | 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 |
@@ -238,6 +241,7 @@ The Shell App (docs/milestones/S1.md) runs the commands below on the device's ow
| `lora capture start` / `lora capture stop` | A LoRa Capture, as `c` in the App |
| `lora sweep on [from MHz] [to MHz] [step kHz]` / `lora sweep off` / `lora sweep dump` | Sweep a band (863 870 100 by default), with a summary every 2 s (floor, strongest, peaks), or print the latest pass |
| `gnss quiet on` / `gnss quiet off` | The "Pause GNSS for LoRa" setting |
| `imu` | What the motion sensor reads: g on its three axes, then degrees a second (the Compass, issue #16) |
| `gnss status` / `gnss restart` | The receiver's state, and a restart of it |
| `gnss track start` / `gnss track stop` | A Track, as `r` in the GNSS App (the reason is printed if it can't start) |
| `gnss nmea on` / `gnss nmea off` | Prints each NMEA sentence the receiver sends, as `nmea: …` |
@@ -263,7 +267,7 @@ The Shell App (docs/milestones/S1.md) runs the commands below on the device's ow
### The Debug Console
Every firmware has the Debug Console (ADR 0010): the serial console over Wi-Fi, on TCP 2323. It is **off** until you switch it on in **Settings → Debug Console**, which also makes its token and shows it. With the device on USB, `scripts/flash.sh --debug` flashes it, switches the console on and gives it the token in `~/.config/roro9stack/debug-token`, so nothing has to be typed. Then, with `RORO_OTA_HOST` set to the device's IP:
Every firmware has the Debug Console (ADR 0010): the serial console over Wi-Fi, on TCP 2323. It is **off** until you switch it on in **Settings → System → Debug Console**, which also makes its token and shows it. With the device on USB, `scripts/flash.sh --debug` flashes it, switches the console on and gives it the token in `~/.config/roro9stack/debug-token`, so nothing has to be typed. Then, with `RORO_OTA_HOST` set to the device's IP:
```sh
scripts/rdbg.py # interactive: the console backlog, live lines, and commands
Binary file not shown.

After

Width:  |  Height:  |  Size: 108 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 121 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 85 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 99 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 102 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 117 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 97 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 99 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 104 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 96 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 107 B

+39
View File
@@ -0,0 +1,39 @@
# H1 — On-board hardware
**Status:** in progress. Built, not released yet: the Compass (issue #16). Not started: the IR Remote (#15), the Audio App (#14).
**Goal:** the hardware the device already carries and nothing used yet (the motion sensor, the infrared LED, the microphone and speaker) each gets something useful to do.
## The Compass (issue #16)
The device has a GNSS receiver and a motion sensor (a BMI270: an accelerometer and a gyroscope) but **no magnetometer**: standing still, nothing in it knows where north is. The receiver gives the direction of travel while walking; the gyroscope measures turns, but not from where.
### Decisions (design round 2026-10-10)
| # | Decision |
|---|---|
| Q267 | **A third view of the GNSS App,** after Position and Sky, not an App of its own: Tab goes round the three. |
| Q268 | **North comes from outside, and the gyroscope holds it.** Walking at 3 km/h or more, each course the receiver reports pulls the heading 30 % of the way to it. Standing, the gyroscope follows the turns, and the screen says how long ago north was last given. |
| Q269 | **The sun gives north too:** `s` with the top of the device aimed at the sun sets the heading to the sun's azimuth, worked out from the time and the position. The sun is drawn on the rose, as something to check north against. |
| Q270 | **The heading is where the top of the device points.** The turn that counts is the one around the vertical, which the accelerometer gives: it works however the device is held. Walking, the device is taken to point the way you walk. |
| Q271 | **Places:** `m` marks where you stand, under a name; `t` picks one as the target. The rose then carries an arrowhead to it, with its distance and bearing. Targets from Tracks, typed coordinates or Gemini links are for later. |
| Q272 | **Places are GPX waypoints** in `/gnss/places.gpx` on the SD card, 50 at most: a map program opens the file, and waypoints made by one are read here. The whole file is written at each change. |
| Q273 | **A level** from the accelerometer, next to the readouts: the heading is only as good as the device is flat when aiming at the sun. |
| Q274 | **Not now:** a magnetometer on the Grove port (and so declination), a faster GNSS rate, sunrise and sunset, an estimated time of arrival. |
### As built
- **`lib/gnss/src/compass.{h,cpp}`**, host-tested (13 tests): `HeadingFilter` (the turn around "up" from the gyroscope, the course and the sun as references, the gyroscope's offset learnt while the device lies still), `sunPosition` (the Astronomical Almanac's low-precision formulas), `bearingDegrees`, `cardinal`, `formatDistance`.
- **`lib/gnss/src/places.{h,cpp}`**, host-tested (5 tests): the Places as GPX waypoints, read and written.
- **The GNSS App** reads the sensor 100 times a second while it is in front, in any of its views, and forgets north when it is left: the turns made meanwhile were not followed. The Compass is drawn again when the heading moves by a degree or the level moves, at most 20 times a second.
- **`imu`** on the consoles prints what the sensor reads.
### Checked on the device (2026-10-11)
- The sensor answers as a BMI270 through M5Unified, and reads about 0.5 degrees a second on one axis lying still.
- Turning the device clockwise makes the heading go up, and the level's bubble goes to the edge that is lifted: the sensor's axes are as the code took them.
- Not checked yet: north from the course while walking, north from the sun against a real compass, and how far the heading drifts in the hand.
### What the sensor's offset costs
A gyroscope reads a little even when nothing turns (up to about 0.5 degrees a second for this one), which would turn the rose by itself. The filter takes what the sensor reads while it has been still for a second (under 2 degrees a second on all axes) as that offset. In the hand the device is rarely that still: lay it down for a few seconds first. After 3 minutes without north the screen shows the age of the heading in the warning colour.
+77 -1
View File
@@ -1,6 +1,6 @@
# U1 — Look and feel
**Status:** in progress. Shipped: the help key (issue #69) and the key tables the website shares with it (#72), both in **v0.13.0**; the screenshot key (#83, **v0.17.0**). Not started: screen recording (#17), a Launcher of tiles (#9), themes (#10).
**Status:** in progress. Shipped: the help key (issue #69) and the key tables the website shares with it (#72), both in **v0.13.0**; the screenshot key (#83, **v0.17.0**). The Launcher as a grid of icons (#9) and themes (#10) are done, not released yet. Not started: screen recording (#17).
**Goal:** the interface is consistent and uncrowded: the same thing is done the same way on every screen, and the 135 pixels of height go to content.
@@ -59,3 +59,79 @@ A screenshot could only be taken by typing `screenshot` in the Shell, where "now
**Checked on the device** (2026-10-07, with `key shot`): in the Launcher, a 33,383-byte PNG appears in `/screenshots` and is the Launcher; with the help panel open, the picture is of the panel (which now lists Fn p) and the panel stays open; on Settings > Debug Console, no file is written; back on the Settings list, one is. The test pictures were removed.
**Not checked:** the real Fn+p on the keyboard (the mapper is host-tested); the two Toasts that refuse, which weren't looked at (one of them is on the page that mustn't be photographed); a device with no card.
## The Launcher as a grid (issue #9)
The Launcher was a list of names. It is now a grid of icons.
| Question in the issue | Decided |
|---|---|
| Layout | **4 × 3** tiles of 60 × 36, so the 11 Apps are on one page. Only the selected App's name is written, on a line under the grid: a name under every tile doesn't fit 60 pixels ("LoRa Scanner"). More than 12 Apps: the rows scroll |
| Icons | **The website's own**: its nine 16 × 16 pictures (`site/static/img/icons-dark.svg`), doubled to 32 × 32, and two drawn the same way for SSH and the Shell. 1 bit a pixel (128 bytes each, in flash). The pictures are PNGs in `assets/icons/`, named after the App's id; `scripts/make_icons.py` writes `src/ui/icons.cpp` from them and CI checks the two match |
| Colours | **The website's**: cyan (#00dbff) on black, and the selected tile slate (#494955, the Status Bar's) on a cyan fill with notched corners. Both are RGB332 colours. The name under the grid is white |
| Live state | **A dot** on the tile, from `App::badge()`: IRC (unread messages), GNSS (a Track recording), the LoRa Scanner (a Capture running), SSH (a session open). The Launcher asks every App on each pass and redraws when an answer changes |
| Order | As registered, as before |
| Shortcuts | None for now |
| The list | Kept: **Settings > Launcher**, Grid or List. Both keep the same selection |
- `GridModel` (`lib/ui`) holds the selection and the scrolling, host-tested: left and right go through every item and wrap; up and down stay in the column, and land on the last item where the last row is short.
- An App registered without an icon shows its first letter in a frame.
- No animation: not asked for, and not measured.
## The website's colours, on every screen
Every screen takes its colours from `src/ui/theme.h`, so the palette changed there, to the website's (`site/static/css/site.css`, dark side). Each is a colour the RGB332 frame buffer holds exactly.
| | Was | Is |
|---|---|---|
| Accent | teal-blue | cyan `#00dbff` |
| A selected row, a dialog's chosen button | darker teal, white text | cyan, dark blue text (`#000055`) |
| Status Bar | `#202020`, which the frame buffer showed as a dull olive | slate `#494955`; what is idle on it in light grey `#b6b6aa` |
| Muted text | grey, as the frame buffer rounded it | the same grey, exact: `#9292aa` |
| Warning | orange | the website's orange `#ff9200` |
| Someone wrote (unread count, a mention, a message Toast) | green | pink `#ff92ff` |
| Good (a Fix, the quietest channel, a live task) | the same green | green `#49db55`, the one colour that isn't the website's: it has no green |
| Text on a Toast | black | dark blue |
Looked at on the device, by screenshot: the Launcher, IRC, Wi-Fi Tools (menu, channel occupancy), GNSS (position, sky), Gemini, the LoRa Scanner (Sniffer, Sweep, presets), Storage, Notes, SSH, the Shell, System, Settings and the help panel. Not looked at: dialogs, a warning or a message Toast, the SSH terminal (which keeps its own 16 ANSI colours), the Setup screens.
## Themes (issue #10)
Seven themes, each with a dark and a light side, chosen in **Settings > Theme** and **Settings > Light or dark**: roro9stack (the website's, the default), Catppuccin (Mocha and Latte), Dracula (and Alucard), Nord, ANSI terminal, Gruvbox, Solarized.
| Question in the issue | Decided |
|---|---|
| Which themes | The seven above. Not the high-contrast and phosphor ones the issue suggested: ANSI terminal dark (grey and green on black) and light (black on white) come close |
| Fonts and spacing too | No: colours only |
| Themes from the SD card | No: built in |
| A preview while picking | The Setting applies at once, so the Settings screen is the preview |
| Constellation colours | From the theme (its accent, its "good", and three roles named red, yellow and violet), so they read on every background |
| Light by day, dark by night | No |
- **A palette is 14 roles** (`lib/ui/src/palette.h`): background, text, muted, faint, the bar and its idle marks, accent, what is drawn on an accent, warning, message, good, and red, yellow and violet.
- **`theme::kText` and the others are now references** into the palette in use (`src/ui/theme.h`), so no App changed: they still read as constants. The main loop applies the palette when either Setting changes, and draws everything again.
- **RGB332.** Every colour in the table is one the frame buffer holds exactly. The themes' own colours were rounded to those; where two roles fell together or lost contrast, one was picked by hand (Nord's accent and muted text, Gruvbox's greys, Solarized's surfaces). `test_palette` checks that every colour is exact, and 18 contrast ratios for each of the 14 palettes (text on background at 4.5 or more, the rest at 2 to 3).
- **What it costs in fidelity:** blue has four levels, so Dracula and Nord share a dark background (#242455), which was Catppuccin's too: Catppuccin dark is on black instead (its "crust"), with that blue for its bar and its brighter accents (peach, pink, green, sky), to tell it from Dracula; Solarized light's cream becomes white, and Gruvbox's dark brown becomes a dark olive (#242400).
- `theme [0-6] [light|dark]` on the consoles lists them or picks one.
**Looked at on the device**, by screenshot: the Launcher in all 14; and in Gruvbox light, Settings, GNSS (position and sky), the Sweep, Storage, the help panel, Gemini and Wi-Fi Tools' channel occupancy. Nothing was drawn for black only.
**Kept as they are:** the SSH terminal's 16 ANSI colours and its black background, the Sweep's waterfall scale, pictures, and the screen shown while the device powers off.
**Not looked at:** the other 12 palettes beyond the Launcher, dialogs and Toasts in any theme but the default, the Setup screens. In Gruvbox light, the Sky view's GPS, GLONASS and BeiDou colours are three close shades of brown and red.
## Settings in groups
Settings had grown to 21 rows in one list. It now opens on five groups, each a short list of its own:
| Group | Rows |
|---|---|
| This device | Long name, Short name, Region, Timezone, Sound & LED |
| Display | Brightness, Dim after, Screen off after, Theme, Light or dark, Launcher |
| GNSS and radio | GNSS, Pause GNSS for LoRa, Coordinates, Probe MACs |
| Network | Wi-Fi, VPN |
| System | Check for updates, Firmware, Debug Console, About |
- Enter opens a group, Back returns to the groups with the selection on the one just left, and Back from the groups leaves Settings. An open group has its name over its rows.
- `SettingsMenu` (`lib/apps_model`) holds the groups and which one is open; every index is into what is listed. Host-tested: every setting is in exactly one group, and no group has more rows than fit under its name.
- The guide, the how-tos, the README, the scripts' messages and the firmware's own (the Toast for a new release, the GNSS App's hint) name the new paths: "Settings > System > Firmware". The milestone notes and the devlog keep the paths of their day.
+92 -15
View File
@@ -1,6 +1,7 @@
#include "settings_menu.h"
#include "choices.h"
#include "palette.h"
namespace roro {
@@ -15,18 +16,50 @@ struct RowDef {
const char* label;
};
const RowDef kRows[] = {
{Row::LongName, Kind::Text, "Long name"}, {Row::ShortName, Kind::Text, "Short name"},
{Row::Region, Kind::Choice, "Region"}, {Row::Timezone, Kind::Choice, "Timezone"},
{Row::Brightness, Kind::Slider, "Brightness"}, {Row::DimTimeout, Kind::Choice, "Dim after"},
{Row::OffTimeout, Kind::Choice, "Screen off after"}, {Row::Sound, Kind::Toggle, "Sound & LED"},
{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::CheckUpdates, Kind::Toggle, "Check for updates"}, {Row::Firmware, Kind::Page, "Firmware"},
{Row::Vpn, Kind::Page, "VPN"},
{Row::DebugConsole, Kind::Page, "Debug Console"}, {Row::About, Kind::Page, "About"},
const RowDef kGroups[] = {
{Row::GroupDevice, Kind::Group, "This device"}, {Row::GroupDisplay, Kind::Group, "Display"},
{Row::GroupPosition, Kind::Group, "GNSS and radio"}, {Row::GroupNetwork, Kind::Group, "Network"},
{Row::GroupSystem, Kind::Group, "System"},
};
constexpr int kGroupCount = sizeof(kGroups) / sizeof(kGroups[0]);
struct Member {
int group; // an index into kGroups
RowDef def;
};
// In the order each group lists them.
const Member kRows[] = {
{0, {Row::LongName, Kind::Text, "Long name"}},
{0, {Row::ShortName, Kind::Text, "Short name"}},
{0, {Row::Region, Kind::Choice, "Region"}},
{0, {Row::Timezone, Kind::Choice, "Timezone"}},
{0, {Row::Sound, Kind::Toggle, "Sound & LED"}},
{1, {Row::Brightness, Kind::Slider, "Brightness"}},
{1, {Row::DimTimeout, Kind::Choice, "Dim after"}},
{1, {Row::OffTimeout, Kind::Choice, "Screen off after"}},
{1, {Row::Theme, Kind::Choice, "Theme"}},
{1, {Row::ThemeLight, Kind::Toggle, "Light or dark"}},
{1, {Row::Launcher, Kind::Toggle, "Launcher"}},
{2, {Row::Gnss, Kind::Toggle, "GNSS"}},
{2, {Row::GnssQuiet, Kind::Toggle, "Pause GNSS for LoRa"}},
{2, {Row::Coordinates, Kind::Toggle, "Coordinates"}},
{2, {Row::ProbeMacs, Kind::Toggle, "Probe MACs"}},
{3, {Row::Wifi, Kind::Page, "Wi-Fi"}},
{3, {Row::Vpn, Kind::Page, "VPN"}},
{4, {Row::CheckUpdates, Kind::Toggle, "Check for updates"}},
{4, {Row::Firmware, Kind::Page, "Firmware"}},
{4, {Row::DebugConsole, Kind::Page, "Debug Console"}},
{4, {Row::About, Kind::Page, "About"}},
};
// Row i of what is listed: a group, or the i-th row of the open one.
const RowDef& at(int group, int i) {
if (group < 0) return kGroups[i < 0 || i >= kGroupCount ? 0 : i];
for (const Member& m : kRows)
if (m.group == group && i-- == 0) return m.def;
return kGroups[group]; // out of range: harmless
}
const int kDimSeconds[] = {10, 15, 30, 60, 120, 300};
const int kOffSeconds[] = {30, 60, 120, 300, 600, 1800};
@@ -63,10 +96,42 @@ int indexOf(const int (&table)[N], int value) {
} // namespace
int SettingsMenu::count() const { return sizeof(kRows) / sizeof(kRows[0]); }
SettingsMenu::Row SettingsMenu::row(int i) const { return kRows[i].row; }
SettingsMenu::Kind SettingsMenu::kind(int i) const { return kRows[i].kind; }
std::string SettingsMenu::label(int i) const { return kRows[i].label; }
bool SettingsMenu::open(int i) {
if (group_ >= 0 || i < 0 || i >= kGroupCount) return false;
group_ = lastGroup_ = i;
return true;
}
bool SettingsMenu::close() {
if (group_ < 0) return false;
group_ = -1;
return true;
}
std::string SettingsMenu::title() const { return group_ < 0 ? "" : kGroups[group_].label; }
bool SettingsMenu::reveal(Row r, int& index) {
int seen[kGroupCount] = {};
for (const Member& m : kRows) {
if (m.def.row == r) {
group_ = lastGroup_ = m.group;
index = seen[m.group];
return true;
}
seen[m.group]++;
}
return false;
}
int SettingsMenu::count() const {
if (group_ < 0) return kGroupCount;
int n = 0;
for (const Member& m : kRows) n += m.group == group_;
return n;
}
SettingsMenu::Row SettingsMenu::row(int i) const { return at(group_, i).row; }
SettingsMenu::Kind SettingsMenu::kind(int i) const { return at(group_, i).kind; }
std::string SettingsMenu::label(int i) const { return at(group_, i).label; }
std::string SettingsMenu::value(int i) const {
switch (row(i)) {
@@ -80,6 +145,9 @@ std::string SettingsMenu::value(int i) const {
case Row::Brightness: return std::to_string(settings_.getInt(Setting::Brightness)) + "%";
case Row::DimTimeout: return formatSeconds(settings_.getInt(Setting::DimTimeoutS));
case Row::OffTimeout: return formatSeconds(settings_.getInt(Setting::OffTimeoutS));
case Row::Launcher: return settings_.getBool(Setting::LauncherList) ? "List" : "Grid";
case Row::Theme: return ui::themeName(settings_.getInt(Setting::Theme));
case Row::ThemeLight: return settings_.getBool(Setting::ThemeLight) ? "Light" : "Dark";
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";
@@ -97,6 +165,11 @@ std::vector<std::string> SettingsMenu::choices(int i) const {
switch (row(i)) {
case Row::Region: return labels(kRegions);
case Row::Timezone: return labels(kTimezones);
case Row::Theme: {
std::vector<std::string> names;
for (int t = 0; t < ui::kThemeCount; ++t) names.push_back(ui::themeName(t));
return names;
}
case Row::DimTimeout: return durations(kDimSeconds);
case Row::OffTimeout: return durations(kOffSeconds);
default: return {};
@@ -107,6 +180,7 @@ int SettingsMenu::currentChoice(int i) const {
switch (row(i)) {
case Row::Region: return indexOf(kRegions, settings_.getString(Setting::Region));
case Row::Timezone: return indexOf(kTimezones, settings_.getString(Setting::Timezone));
case Row::Theme: return settings_.getInt(Setting::Theme);
case Row::DimTimeout: return indexOf(kDimSeconds, settings_.getInt(Setting::DimTimeoutS));
case Row::OffTimeout: return indexOf(kOffSeconds, settings_.getInt(Setting::OffTimeoutS));
default: return -1;
@@ -120,6 +194,7 @@ std::string SettingsMenu::choose(int i, int c) {
settings_.setBool(Setting::RegionConfirmed, true);
return "";
case Row::Timezone: settings_.setString(Setting::Timezone, kTimezones[c].value); return "";
case Row::Theme: settings_.setInt(Setting::Theme, c); return "";
case Row::DimTimeout:
return settings_.setInt(Setting::DimTimeoutS, kDimSeconds[c]) ? "" : "Dimming must happen before screen off";
case Row::OffTimeout:
@@ -129,6 +204,8 @@ std::string SettingsMenu::choose(int i, int c) {
}
void SettingsMenu::toggle(int i) {
if (row(i) == Row::ThemeLight) settings_.setBool(Setting::ThemeLight, !settings_.getBool(Setting::ThemeLight));
if (row(i) == Row::Launcher) settings_.setBool(Setting::LauncherList, !settings_.getBool(Setting::LauncherList));
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));
+16 -4
View File
@@ -7,15 +7,26 @@
namespace roro {
// What the Settings App lists: one row per user-facing setting (plus sub-pages), with readable
// values, choice lists and validation messages. Rendering and navigation live in the App.
// What the Settings App lists: the groups first, then, with one open, a row per user-facing setting
// of that group (plus sub-pages), with readable values, choice lists and validation messages.
// Rendering and navigation live in the App. Every index is into what is listed now.
class SettingsMenu {
public:
enum class Row { LongName, ShortName, Region, Timezone, Brightness, DimTimeout, OffTimeout, Sound, Gnss, GnssQuiet, Coordinates, ProbeMacs, Wifi, CheckUpdates, Firmware, Vpn, DebugConsole, About };
enum class Kind { Text, Choice, Toggle, Slider, Page };
enum class Row { LongName, ShortName, Region, Timezone, Brightness, DimTimeout, OffTimeout, Launcher, Theme, ThemeLight, Sound, Gnss, GnssQuiet, Coordinates, ProbeMacs, Wifi, CheckUpdates, Firmware, Vpn, DebugConsole, About,
GroupDevice, GroupDisplay, GroupPosition, GroupNetwork, GroupSystem };
enum class Kind { Text, Choice, Toggle, Slider, Page, Group };
explicit SettingsMenu(Settings& settings) : settings_(settings) {}
// The groups are listed until one is opened; close() lists them again.
bool open(int i); // false when row i isn't a group
bool close(); // false when the groups were listed already
bool inGroup() const { return group_ >= 0; }
std::string title() const; // the open group's name, or ""
int groupIndex() const { return lastGroup_; } // where the group last opened is among the groups
// Opens the group a row is in, and says where the row is in it. False for a row there isn't.
bool reveal(Row r, int& index);
int count() const;
Row row(int i) const;
Kind kind(int i) const;
@@ -37,6 +48,7 @@ class SettingsMenu {
private:
Settings& settings_;
int group_ = -1, lastGroup_ = 0;
};
} // namespace roro
+4
View File
@@ -50,6 +50,10 @@ class App {
virtual bool retainsContent() const { return false; }
virtual void contentLost() {}
// True while something goes on in the App that is worth a look, whether it is in front or
// not (unread messages, a recording running): the Launcher marks its tile (issue #9).
virtual bool badge() const { return false; }
void requestRedraw() { redraw_ = true; }
bool consumeRedraw() {
+20 -3
View File
@@ -48,7 +48,7 @@ inline constexpr KeyHelp kText[] = {
// launcher: The Launcher
inline constexpr KeyHelp kLauncher[] = {
{"; .", "up, down"},
{"; . , /", "move"},
{"Enter", "open the App"},
};
@@ -134,10 +134,26 @@ inline constexpr KeyHelp kWifiTracker[] = {
// gnss: GNSS
inline constexpr KeyHelp kGnss[] = {
{"Tab", "the position, or the sky"},
{"Tab", "position, sky, compass"},
{"r", "record a Track, or stop it"},
};
// gnss-compass: GNSS, the compass
inline constexpr KeyHelp kGnssCompass[] = {
{"Tab", "position, sky, compass"},
{"m", "mark this place"},
{"t", "the target: a place"},
{"s", "aimed at the sun: north"},
{"r", "record a Track, or stop it"},
};
// gnss-places: GNSS, the places
inline constexpr KeyHelp kGnssPlaces[] = {
{"; .", "up, down"},
{"Enter", "the target"},
{"d Del", "remove the place"},
};
// gemini: Gemini, a page
inline constexpr KeyHelp kGemini[] = {
{"Tab", "the next link"},
@@ -414,8 +430,9 @@ inline constexpr KeyHelp kSystemSystem[] = {
// settings: Settings
inline constexpr KeyHelp kSettings[] = {
{"; .", "up, down"},
{"Enter", "edit, or open the page"},
{"Enter", "open the group or the page, or edit"},
{", /", "change a switch or a slider"},
{"`", "back to the groups"},
};
// settings-choice: Settings, a choice
+3
View File
@@ -1,5 +1,7 @@
#pragma once
#include <cstdint>
#include <string>
#include <vector>
@@ -12,6 +14,7 @@ struct AppInfo {
const char* title;
bool hidden; // not listed in the Launcher, but can still be opened
App* app;
const uint8_t* icon = nullptr; // the Launcher's picture of it (ui/icons.h); none: its first letter
};
// Owns which App is in the foreground and routes keys. Home always returns to the Launcher;
+123
View File
@@ -0,0 +1,123 @@
#include "compass.h"
#include <cmath>
#include <cstdio>
namespace roro::gnss {
namespace {
constexpr double kRad = M_PI / 180.0;
// The sensor's axes are right-handed, so a positive turn around "up" is anticlockwise seen from
// above, and the heading (clockwise) goes down. Measured on the device: issue #16.
constexpr float kTurnSign = -1.0f;
} // namespace
float wrap360(float degrees) {
float d = std::fmod(degrees, 360.0f);
return d < 0 ? d + 360.0f : d;
}
float angleDiff(float to, float from) {
float d = wrap360(to - from);
return d >= 180.0f ? d - 360.0f : d;
}
double bearingDegrees(double lat1, double lon1, double lat2, double lon2) {
double p1 = lat1 * kRad, p2 = lat2 * kRad, dl = (lon2 - lon1) * kRad;
double y = std::sin(dl) * std::cos(p2);
double x = std::cos(p1) * std::sin(p2) - std::sin(p1) * std::cos(p2) * std::cos(dl);
double b = std::atan2(y, x) / kRad;
return b < 0 ? b + 360.0 : b;
}
const char* cardinal(float degrees) {
static const char* const kPoints[16] = {"N", "NNE", "NE", "ENE", "E", "ESE", "SE", "SSE",
"S", "SSW", "SW", "WSW", "W", "WNW", "NW", "NNW"};
return kPoints[static_cast<int>(wrap360(degrees) / 22.5f + 0.5f) % 16];
}
std::string formatDistance(double meters) {
char buf[24];
if (meters < 999.5) std::snprintf(buf, sizeof buf, "%.0f m", meters);
else if (meters < 9950.0) std::snprintf(buf, sizeof buf, "%.1f km", meters / 1000.0);
else std::snprintf(buf, sizeof buf, "%.0f km", meters / 1000.0);
return buf;
}
SunPosition sunPosition(int64_t utcSeconds, double latitude, double longitude) {
double d = utcSeconds / 86400.0 - 10957.5; // days since 2000-01-01 12:00 UTC
double g = (357.529 + 0.98560028 * d) * kRad; // mean anomaly
double q = 280.459 + 0.98564736 * d; // mean longitude
double l = (q + 1.915 * std::sin(g) + 0.020 * std::sin(2 * g)) * kRad; // ecliptic longitude
double e = (23.439 - 0.00000036 * d) * kRad; // the ecliptic's tilt
double rightAscension = std::atan2(std::cos(e) * std::sin(l), std::cos(l));
double declination = std::asin(std::sin(e) * std::sin(l));
double siderealDeg = std::fmod(18.697374558 + 24.06570982441908 * d, 24.0) * 15.0; // at Greenwich
double hourAngle = (siderealDeg + longitude) * kRad - rightAscension;
double lat = latitude * kRad;
double elevation = std::asin(std::sin(lat) * std::sin(declination) +
std::cos(lat) * std::cos(declination) * std::cos(hourAngle));
double azimuth = std::atan2(-std::sin(hourAngle),
std::tan(declination) * std::cos(lat) - std::sin(lat) * std::cos(hourAngle));
return {wrap360(static_cast<float>(azimuth / kRad)), static_cast<float>(elevation / kRad)};
}
void HeadingFilter::motion(const float gyro[3], const float accel[3], float dt) {
if (dt <= 0) return;
// "Up" is where the accelerometer points at rest, smoothed so a shake doesn't move it.
float norm = std::sqrt(accel[0] * accel[0] + accel[1] * accel[1] + accel[2] * accel[2]);
if (norm > 0.5f && norm < 1.5f) {
float k = any_ ? std::fmin(1.0f, dt / kUpSeconds) : 1.0f;
float length = 0;
for (int i = 0; i < 3; i++) {
up_[i] += k * (accel[i] / norm - up_[i]);
length += up_[i] * up_[i];
}
length = std::sqrt(length);
if (length > 0.01f)
for (float& u : up_) u /= length;
any_ = true;
}
float rate[3], turning = 0;
for (int i = 0; i < 3; i++) {
rate[i] = gyro[i] - bias_[i];
turning += rate[i] * rate[i];
}
if (std::sqrt(turning) < kStillDps) {
stillFor_ += dt;
if (stillFor_ >= kStillSeconds) { // lying still: what the gyroscope still reads is its offset
float k = std::fmin(1.0f, dt / kBiasSeconds);
for (int i = 0; i < 3; i++) {
bias_[i] += k * rate[i];
rate[i] = gyro[i] - bias_[i];
}
}
} else stillFor_ = 0;
if (!known()) return;
float aroundUp = rate[0] * up_[0] + rate[1] * up_[1] + rate[2] * up_[2];
heading_ = wrap360(heading_ + kTurnSign * aroundUp * dt);
held_ += dt;
}
void HeadingFilter::course(float courseDeg, float speedKmh) {
if (speedKmh < kMinSpeedKmh) return;
heading_ = known() ? wrap360(heading_ + kCourseGain * angleDiff(courseDeg, heading_)) : wrap360(courseDeg);
source_ = Source::Course;
held_ = 0;
}
void HeadingFilter::sun(float azimuthDeg) {
heading_ = wrap360(azimuthDeg);
source_ = Source::Sun;
held_ = 0;
}
void HeadingFilter::forget() {
source_ = Source::None;
held_ = 0;
stillFor_ = 0;
}
} // namespace roro::gnss
+72
View File
@@ -0,0 +1,72 @@
#pragma once
#include <cstdint>
#include <string>
namespace roro::gnss {
// Angles are degrees from true north, clockwise, 0 up to 360.
float wrap360(float degrees);
// How far to turn from `from` to `to`: -180 up to 180, positive clockwise.
float angleDiff(float to, float from);
// The initial great-circle bearing from the first point to the second.
double bearingDegrees(double lat1, double lon1, double lat2, double lon2);
// One of the 16 points: "N", "NNE", "NE"...
const char* cardinal(float degrees);
// "340 m", "1.2 km", "12 km".
std::string formatDistance(double meters);
// Where the sun is in the sky, from the time and the place (the low-precision formulas of the
// Astronomical Almanac: within a hundredth of a degree until 2050, far finer than a hand can aim).
struct SunPosition {
float azimuthDeg;
float elevationDeg; // above the horizon; refraction is left out
};
SunPosition sunPosition(int64_t utcSeconds, double latitude, double longitude);
// The Compass's heading (issue #16): where the top of the device points. There is no
// magnetometer, so north comes from outside (the course over ground while walking, or the sun
// when the user aims at it) and the gyroscope follows the turns in between. Host-tested.
class HeadingFilter {
public:
enum class Source : uint8_t { None, Course, Sun };
// Below a walking pace the receiver's course is noise.
static constexpr float kMinSpeedKmh = 3.0f;
// Each course reading pulls the heading this much of the way: a few seconds to settle,
// without jumping at every reading.
static constexpr float kCourseGain = 0.3f;
// The gyroscope's own offset is learnt while the device lies still: turning slower than
// this for kStillSeconds counts as still.
static constexpr float kStillDps = 2.0f;
static constexpr float kStillSeconds = 1.0f;
static constexpr float kBiasSeconds = 4.0f;
// How fast the measured "up" follows the accelerometer.
static constexpr float kUpSeconds = 0.3f;
// One reading of the IMU: degrees a second and g, on the sensor's axes, `dt` seconds after
// the one before. Only the turn around the vertical counts, however the device is held.
void motion(const float gyro[3], const float accel[3], float dt);
// The receiver's course over ground, once a second: used when moving fast enough.
void course(float courseDeg, float speedKmh);
// The top of the device is aimed at the sun, which is at this azimuth.
void sun(float azimuthDeg);
void forget(); // the device was not watched for a while: north has to come again
bool known() const { return source_ != Source::None; }
float heading() const { return heading_; }
Source source() const { return source_; }
// Seconds the gyroscope has carried the heading alone since north was last given.
float heldSeconds() const { return held_; }
// "Up" along the sensor's x and y axes, -1 to 1: both 0 when the device lies flat.
float tiltX() const { return up_[0]; }
float tiltY() const { return up_[1]; }
bool still() const { return stillFor_ >= kStillSeconds; }
private:
float heading_ = 0, held_ = 0, stillFor_ = 0;
float up_[3] = {0, 0, 1}, bias_[3] = {0, 0, 0};
bool any_ = false;
Source source_ = Source::None;
};
} // namespace roro::gnss
+1 -1
View File
@@ -6,7 +6,7 @@ namespace roro::gnss {
// "50.86920° N": five decimals, about a metre.
std::string formatDecimal(double degrees, bool latitude);
// "50° 52' 09.1\" N" (Settings → Coordinates, Q64).
// "50° 52' 09.1\" N" (Settings → GNSS and radio → Coordinates, Q64).
std::string formatDms(double degrees, bool latitude);
// The 6-character Maidenhead locator ("JO20ef"), as radio amateurs give their square.
std::string maidenhead(double latitude, double longitude);
+102
View File
@@ -0,0 +1,102 @@
#include "places.h"
#include <cstdio>
#include <cstdlib>
namespace roro::gnss {
namespace {
struct Entity {
const char* text;
char ch;
};
constexpr Entity kEntities[] = {{"&amp;", '&'}, {"&lt;", '<'}, {"&gt;", '>'}, {"&quot;", '"'}, {"&apos;", '\''}};
std::string escaped(const std::string& s) {
std::string out;
for (char c : s) {
const char* entity = nullptr;
for (auto& e : kEntities)
if (e.ch == c) entity = e.text;
if (entity) out += entity;
else out += c;
}
return out;
}
std::string unescaped(const std::string& s) {
std::string out;
for (size_t i = 0; i < s.size();) {
bool found = false;
if (s[i] == '&')
for (auto& e : kEntities) {
std::string text = e.text;
if (s.compare(i, text.size(), text) == 0) {
out += e.ch;
i += text.size();
found = true;
break;
}
}
if (!found) out += s[i++];
}
return out;
}
// The value of ` name="..."` in a tag; false if it isn't there or isn't a number.
bool attribute(const std::string& tag, const char* name, double& value) {
std::string key = std::string(" ") + name + "=";
size_t at = tag.find(key);
if (at == std::string::npos || at + key.size() >= tag.size()) return false;
at += key.size();
char quote = tag[at];
if (quote != '"' && quote != '\'') return false;
size_t end = tag.find(quote, at + 1);
if (end == std::string::npos) return false;
std::string text = tag.substr(at + 1, end - at - 1);
char* rest = nullptr;
value = std::strtod(text.c_str(), &rest);
return !text.empty() && rest && *rest == 0;
}
} // namespace
std::vector<Place> parsePlaces(const std::string& gpx) {
std::vector<Place> places;
size_t at = 0;
while (places.size() < kMaxPlaces && (at = gpx.find("<wpt", at)) != std::string::npos) {
size_t tagEnd = gpx.find('>', at);
if (tagEnd == std::string::npos) break;
std::string tag = gpx.substr(at, tagEnd - at);
bool alone = !tag.empty() && tag.back() == '/'; // <wpt .../>: no name
size_t close = alone ? tagEnd : gpx.find("</wpt>", tagEnd);
if (close == std::string::npos) break;
Place p;
if (attribute(tag, "lat", p.latitude) && attribute(tag, "lon", p.longitude) && p.latitude >= -90 &&
p.latitude <= 90 && p.longitude >= -180 && p.longitude <= 180) {
size_t name = alone ? std::string::npos : gpx.find("<name>", tagEnd);
if (name != std::string::npos && name < close) {
size_t nameEnd = gpx.find("</name>", name);
if (nameEnd != std::string::npos && nameEnd < close) p.name = unescaped(gpx.substr(name + 6, nameEnd - name - 6));
}
if (p.name.empty()) p.name = "Place " + std::to_string(places.size() + 1);
places.push_back(p);
}
at = close + 1;
}
return places;
}
std::string placesGpx(const std::vector<Place>& places) {
std::string out = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
"<gpx version=\"1.1\" creator=\"roro9stack\" xmlns=\"http://www.topografix.com/GPX/1/1\">\n";
for (auto& p : places) {
char buf[80];
std::snprintf(buf, sizeof buf, "<wpt lat=\"%.7f\" lon=\"%.7f\"><name>", p.latitude, p.longitude);
out += buf + escaped(p.name) + "</name></wpt>\n";
}
return out + "</gpx>\n";
}
} // namespace roro::gnss
+24
View File
@@ -0,0 +1,24 @@
#pragma once
#include <cstddef>
#include <string>
#include <vector>
namespace roro::gnss {
// A Place (issue #16): somewhere the user marked, to be led back to by the Compass.
struct Place {
std::string name;
double latitude = 0, longitude = 0;
};
constexpr const char* kPlacesPath = "/gnss/places.gpx";
constexpr size_t kMaxPlaces = 50;
constexpr size_t kPlaceNameBytes = 24;
// The Places are kept as GPX waypoints, so a map program opens the file, and a file made by one
// is read here: every <wpt> with a latitude and a longitude, named by its <name>.
std::vector<Place> parsePlaces(const std::string& gpx);
std::string placesGpx(const std::vector<Place>& places);
} // namespace roro::gnss
+3
View File
@@ -53,6 +53,9 @@ const Definition kDefinitions[] = {
{"ssh_key", Kind::String, 0, "", 0, 800},
{"ssh_public", Kind::String, 0, "", 0, 200},
{"ssh_font", Kind::Int, 1, nullptr, 0, 4},
{"launcher_list", Kind::Bool, 0, nullptr, 0, 1}, // off: the grid
{"theme", Kind::Int, 0, nullptr, 0, 6}, // roro9stack's own; ui::kThemeCount of them
{"theme_light", Kind::Bool, 0, nullptr, 0, 1},
};
static_assert(sizeof(kDefinitions) / sizeof(kDefinitions[0]) == static_cast<size_t>(Setting::Count),
"every Setting needs a definition");
+3
View File
@@ -41,6 +41,9 @@ enum class Setting : uint8_t {
SshKey, // string: this device's own SSH private key, as OpenSSH writes one: never shown
SshPublic, // string: its public half, the line to put in a server's authorized_keys
SshFont, // int: the terminal's font, 0 (smallest) to 4
LauncherList, // bool: the Launcher is a list of names instead of a grid of icons (issue #9)
Theme, // int: the colour theme, an index into ui::palette (issue #10)
ThemeLight, // bool: its light side instead of its dark one
Count
};
+47
View File
@@ -0,0 +1,47 @@
#include "grid_model.h"
namespace roro {
void GridModel::setCount(int count) {
count_ = count < 0 ? 0 : count;
if (count_ == 0) {
selected_ = -1;
first_ = 0;
return;
}
select(selected_ < 0 ? 0 : selected_);
}
void GridModel::select(int index) {
if (count_ == 0) return;
selected_ = index < 0 ? 0 : index >= count_ ? count_ - 1 : index;
int row = selected_ / cols_;
if (row < first_) first_ = row;
if (row >= first_ + rows_) first_ = row - rows_ + 1;
int maxFirst = rows() > rows_ ? rows() - rows_ : 0;
if (first_ > maxFirst) first_ = maxFirst;
}
void GridModel::left() {
if (count_) select(selected_ == 0 ? count_ - 1 : selected_ - 1);
}
void GridModel::right() {
if (count_) select(selected_ == count_ - 1 ? 0 : selected_ + 1);
}
void GridModel::up() {
if (!count_) return;
int col = selected_ % cols_, row = selected_ / cols_;
row = row == 0 ? rows() - 1 : row - 1;
select(row * cols_ + col); // past the end of a short last row: the last item
}
void GridModel::down() {
if (!count_) return;
int col = selected_ % cols_, row = selected_ / cols_;
row = row == rows() - 1 ? 0 : row + 1;
select(row * cols_ + col);
}
} // namespace roro
+33
View File
@@ -0,0 +1,33 @@
#pragma once
namespace roro {
// Selection and scrolling for a grid of `cols` columns showing `visibleRows` rows at a time, filled
// row by row. Left and Right go through every item and wrap around; Up and Down stay in the
// column and wrap around, landing on the last item where the last row has no such column.
class GridModel {
public:
GridModel(int cols, int visibleRows) : cols_(cols), rows_(visibleRows) {}
void setCount(int count);
int count() const { return count_; }
int selected() const { return selected_; } // -1 when empty
int cols() const { return cols_; }
int rows() const { return count_ ? (count_ - 1) / cols_ + 1 : 0; }
int firstVisibleRow() const { return first_; }
int visibleRows() const { return rows_; }
void select(int index);
void left();
void right();
void up();
void down();
private:
int cols_, rows_;
int count_ = 0;
int selected_ = -1;
int first_ = 0;
};
} // namespace roro
+59
View File
@@ -0,0 +1,59 @@
#include "palette.h"
namespace roro::ui {
namespace {
// 0xRRGGBB to RGB565. Every colour below is one the RGB332 frame buffer holds exactly: three bits
// of red and of green (00 24 49 6d 92 b6 db ff) and two of blue (00 55 aa ff). The themes' own
// colours were rounded to those, then the ones that fell together or lost their contrast were
// chosen by hand (test_palette checks both).
constexpr uint16_t c(uint32_t rgb) {
return static_cast<uint16_t>(((rgb >> 19) & 0x1F) << 11 | ((rgb >> 10) & 0x3F) << 5 | ((rgb >> 3) & 0x1F));
}
const char* const kNames[kThemeCount] = {"roro9stack", "Catppuccin", "Dracula", "Nord", "ANSI terminal", "Gruvbox", "Solarized"};
// background, text, muted, faint, bar, barMuted, accent, onAccent, warning, message, good, red, yellow, violet
constexpr Palette kPalettes[kThemeCount][2] = {
{
{c(0x000000), c(0xffffff), c(0x9292aa), c(0x494955), c(0x494955), c(0xb6b6aa), c(0x00dbff), c(0x000055), c(0xff9200), c(0xff92ff), c(0x49db55), c(0xff2455), c(0xffdb00), c(0xb692ff)}, // roro9stack, dark
{c(0xffffff), c(0x000055), c(0x4949aa), c(0xb6dbff), c(0xb6dbff), c(0x4949aa), c(0x0092aa), c(0xffffff), c(0xb64900), c(0xb600aa), c(0x006d00), c(0xb60000), c(0x926d00), c(0x6d49ff)}, // roro9stack, light
},
{
{c(0x000000), c(0xdbdbff), c(0x9292ff), c(0x494955), c(0x242455), c(0xb6b6ff), c(0xdbb6ff), c(0x000000), c(0xffb655), c(0xff92ff), c(0x92ffaa), c(0xff6daa), c(0xffdb55), c(0x6db6ff)}, // Catppuccin, dark
{c(0xffffff), c(0x242455), c(0x6d6daa), c(0xb6b6aa), c(0xb6b6aa), c(0x494955), c(0x9249ff), c(0xffffff), c(0xdb6d00), c(0xdb6daa), c(0x499255), c(0xdb0055), c(0xdb9200), c(0x246dff)}, // Catppuccin, light
},
{
{c(0x242455), c(0xffffff), c(0x6d6daa), c(0x494955), c(0x494955), c(0xb6b6aa), c(0xb692ff), c(0x242455), c(0xffb655), c(0xff6daa), c(0x49ff55), c(0xff4955), c(0xffffaa), c(0x92dbff)}, // Dracula, dark
{c(0xffffff), c(0x242400), c(0x6d6d55), c(0xdbdbff), c(0xdbdbff), c(0x6d6d55), c(0x6d49aa), c(0xffffff), c(0x924900), c(0x922455), c(0x246d00), c(0xdb4900), c(0x926d00), c(0x006daa)}, // Dracula, light
},
{
{c(0x242455), c(0xdbffff), c(0x9292aa), c(0x494955), c(0x494955), c(0xdbdbff), c(0x92dbff), c(0x242455), c(0xdb9255), c(0xb692aa), c(0x92b6aa), c(0xb66d55), c(0xdbdbaa), c(0x9292aa)}, // Nord, dark
{c(0xdbffff), c(0x242455), c(0x494955), c(0xdbdbff), c(0xdbdbff), c(0x494955), c(0x496daa), c(0xdbffff), c(0xb64900), c(0x9249aa), c(0x496d00), c(0xb66d55), c(0xb66d00), c(0x9292aa)}, // Nord, light
},
{
{c(0x000000), c(0xb6b6aa), c(0x6d6d55), c(0x494955), c(0x0000aa), c(0xb6b6aa), c(0x49ff55), c(0x000000), c(0xffff55), c(0xff49ff), c(0x49ffff), c(0xff4955), c(0xffff55), c(0x4949ff)}, // ANSI terminal, dark
{c(0xffffff), c(0x000000), c(0x494955), c(0xb6b6aa), c(0xb6b6aa), c(0x494955), c(0x0000aa), c(0xffffff), c(0xb64900), c(0xb600aa), c(0x006d00), c(0xb60000), c(0xb64900), c(0x00b6aa)}, // ANSI terminal, light
},
{
{c(0x242400), c(0xdbdbaa), c(0x929255), c(0x492400), c(0x492400), c(0xdbb6aa), c(0xffb655), c(0x242400), c(0xff9200), c(0xdb92aa), c(0xb6b600), c(0xff4955), c(0xffb655), c(0x92b6aa)}, // Gruvbox, dark
{c(0xffffaa), c(0x494955), c(0x6d6d55), c(0xdbdbaa), c(0xdbdbaa), c(0x494955), c(0xb64900), c(0xffffaa), c(0xb66d00), c(0x924955), c(0x6d6d00), c(0x920000), c(0xb66d00), c(0x006d55)}, // Gruvbox, light
},
{
{c(0x002455), c(0xb6b6aa), c(0x6d92aa), c(0x004955), c(0x004955), c(0x9292aa), c(0x2492aa), c(0xffffff), c(0xdb4900), c(0xdb24aa), c(0x929200), c(0xdb2455), c(0xb69200), c(0x6d6daa)}, // Solarized, dark
{c(0xffffff), c(0x244955), c(0x9292aa), c(0xdbdbaa), c(0xdbdbaa), c(0x6d6daa), c(0x2492aa), c(0xffffff), c(0xdb4900), c(0xdb24aa), c(0x929200), c(0xdb2455), c(0xb69200), c(0x6d6daa)}, // Solarized, light
},
};
} // namespace
const char* themeName(int theme) { return kNames[theme < 0 || theme >= kThemeCount ? 0 : theme]; }
const Palette& palette(int theme, bool light) { return kPalettes[theme < 0 || theme >= kThemeCount ? 0 : theme][light ? 1 : 0]; }
uint32_t rgb888(uint16_t c) {
// As the display shows an RGB332 pixel: the bits kept, spread over 8.
uint32_t r = ((c >> 13) & 7) * 0x49 >> 1, g = ((c >> 8) & 7) * 0x49 >> 1, b = ((c >> 3) & 3) * 0x55;
return r << 16 | g << 8 | b;
}
} // namespace roro::ui
+29
View File
@@ -0,0 +1,29 @@
#pragma once
#include <cstdint>
// The colour themes (issue #10): each a dark and a light set of the same roles, as RGB565.
namespace roro::ui {
struct Palette {
uint16_t background, text;
uint16_t muted; // secondary text
uint16_t faint; // grid lines, what stays behind
uint16_t bar; // the Status Bar's background
uint16_t barMuted; // what is idle, on the bar
uint16_t accent; // what is chosen, what is live: also the fill behind a selected row
uint16_t onAccent; // text on an accent, warning or message fill
uint16_t warning;
uint16_t message; // someone wrote
uint16_t good; // a Fix, the best of a set
uint16_t red, yellow, violet; // to tell things apart (the constellations of the Sky view)
};
constexpr int kThemeCount = 7;
const char* themeName(int theme); // "roro9stack", "Catppuccin", "Dracula", ...
const Palette& palette(int theme, bool light); // out of range: the first
// What the 8-bit frame buffer shows for a colour, as 0xRRGGBB.
uint32_t rgb888(uint16_t rgb565);
} // namespace roro::ui
+1 -1
View File
@@ -2,7 +2,7 @@
# Flash the firmware over USB, then open the serial monitor.
# Usage: scripts/flash.sh [--debug] [port] USB (default: the first Espressif device found)
# scripts/flash.sh --ota [host] Wi-Fi: build, sign and push a Firmware Update
# (host: the device's IP from Settings > Firmware, or $RORO_OTA_HOST)
# (host: the device's IP from Settings > System > Firmware, or $RORO_OTA_HOST)
# --debug (USB only): once flashed, switches the Debug Console on and gives it the token in
# ~/.config/roro9stack/debug-token, over the serial port (ADR 0010, Q192), so scripts/rdbg.py works
# at once. The settings survive later updates: it is needed once for a device, not at each flash.
+115
View File
@@ -0,0 +1,115 @@
#!/usr/bin/env python3
"""Turns the Launcher's icons (assets/icons/<App id>.png) into C arrays: src/ui/icons.h and icons.cpp.
An icon is 32 x 32 and one colour: a pixel is drawn where the picture is light and opaque, and left
alone where it is dark or transparent. Any image editor's PNG will do (grey, RGB, palette, with or
without alpha, 1 or 8 bits a channel, not interlaced). Run this after changing a picture:
python3 scripts/make_icons.py
CI runs it with --check, which fails when the arrays are not what the pictures give.
"""
import os
import struct
import sys
import zlib
ROOT = os.path.join(os.path.dirname(os.path.abspath(__file__)), "..")
SOURCE = os.path.join(ROOT, "assets", "icons")
SIZE = 32
def read_png(path):
"""The picture as rows of booleans: True where a pixel is drawn."""
data = open(path, "rb").read()
if data[:8] != b"\x89PNG\r\n\x1a\n":
raise ValueError("not a PNG")
at, idat, palette, alpha = 8, b"", None, None
while at < len(data):
(length,), kind = struct.unpack(">I", data[at:at + 4]), data[at + 4:at + 8]
body = data[at + 8:at + 8 + length]
at += 12 + length
if kind == b"IHDR":
width, height, depth, colour, _, _, interlace = struct.unpack(">IIBBBBB", body)
elif kind == b"PLTE":
palette = [body[i:i + 3] for i in range(0, len(body), 3)]
elif kind == b"tRNS":
alpha = body
elif kind == b"IDAT":
idat += body
if interlace or depth not in (1, 8) or (depth == 1 and colour not in (0, 3)):
raise ValueError("save it as a plain 8-bit or 1-bit PNG, not interlaced")
channels = {0: 1, 2: 3, 3: 1, 4: 2, 6: 4}[colour]
step = channels if depth == 8 else 1 # bytes a pixel, for the filters
stride = (width * channels * depth + 7) // 8
raw, rows, before = zlib.decompress(idat), [], bytes(stride)
for y in range(height):
kind, line = raw[y * (stride + 1)], bytearray(raw[y * (stride + 1) + 1:(y + 1) * (stride + 1)])
for i in range(stride):
a = line[i - step] if i >= step else 0
b, c = before[i], before[i - step] if i >= step else 0
if kind == 1:
line[i] = (line[i] + a) & 255
elif kind == 2:
line[i] = (line[i] + b) & 255
elif kind == 3:
line[i] = (line[i] + (a + b) // 2) & 255
elif kind == 4:
p = a + b - c
pa, pb, pc = abs(p - a), abs(p - b), abs(p - c)
line[i] = (line[i] + (a if pa <= pb and pa <= pc else b if pb <= pc else c)) & 255
before = bytes(line)
row = []
for x in range(width):
if depth == 1:
v = (line[x // 8] >> (7 - x % 8)) & 1
px = [v * 255] if colour == 0 else [v]
else:
px = line[x * channels:(x + 1) * channels]
if colour == 3:
opaque = alpha is None or px[0] >= len(alpha) or alpha[px[0]] > 127
light = sum(palette[px[0]]) > 381
elif colour in (0, 4):
opaque, light = colour == 0 or px[1] > 127, px[0] > 127
else:
opaque, light = colour == 2 or px[3] > 127, sum(px[:3]) > 381
row.append(opaque and light)
rows.append(row)
return rows
def main():
names = sorted(f[:-4] for f in os.listdir(SOURCE) if f.endswith(".png"))
header = ["// Made by scripts/make_icons.py from assets/icons/*.png: change the pictures, not this file.", "#pragma once", "",
"#include <cstdint>", "", "namespace roro::icons {", "",
"// One bit a pixel, the leftmost first, a row after another: what Canvas::drawBitmap takes.",
f"constexpr int kSize = {SIZE};", ""]
body = ["// Made by scripts/make_icons.py from assets/icons/*.png: change the pictures, not this file.", '#include "icons.h"', "",
"namespace roro::icons {", ""]
for name in names:
rows = read_png(os.path.join(SOURCE, name + ".png"))
if len(rows) != SIZE or len(rows[0]) != SIZE:
sys.exit(f"{name}.png is {len(rows[0])} x {len(rows)}: an icon is {SIZE} x {SIZE}")
ident = name.replace("-", "_")
header.append(f"extern const uint8_t {ident}[{SIZE * SIZE // 8}]; // {name}.png")
body.append(f"const uint8_t {ident}[{SIZE * SIZE // 8}] = {{")
for row in rows:
packed = [sum(0x80 >> i for i in range(8) if row[b * 8 + i]) for b in range(SIZE // 8)]
body.append(" " + ", ".join(f"0x{v:02x}" for v in packed) + ", // " + "".join("#" if v else "." for v in row))
body += ["};", ""]
header += ["", "} // namespace roro::icons", ""]
body += ["} // namespace roro::icons", ""]
out = {os.path.join(ROOT, "src", "ui", "icons.h"): "\n".join(header), os.path.join(ROOT, "src", "ui", "icons.cpp"): "\n".join(body)}
if "--check" in sys.argv:
stale = [os.path.relpath(p, ROOT) for p, text in out.items() if not os.path.exists(p) or open(p).read() != text]
if stale:
sys.exit("out of date: " + ", ".join(stale) + " (run scripts/make_icons.py)")
print(f"{len(names)} icons, up to date")
return
for path, text in out.items():
open(path, "w").write(text)
print(f"{len(names)} icons written")
if __name__ == "__main__":
main()
+1 -1
View File
@@ -2,7 +2,7 @@
"""Pushes a signed Update File to a Cardputer over Wi-Fi (TCP 3232) and reports the result.
Usage: scripts/ota_push.py <file.ota> <host>
<host> is the device's IP (shown in Settings > Firmware).
<host> is the device's IP (shown in Settings > System > Firmware).
"""
import socket
import sys
+7 -7
View File
@@ -1,11 +1,11 @@
#!/usr/bin/env python3
"""The Debug Console, over Wi-Fi (TCP 2323, see ADR 0010). Switch it on first: Settings > Debug Console.
"""The Debug Console, over Wi-Fi (TCP 2323, see ADR 0010). Switch it on first: Settings > System > Debug Console.
Usage: scripts/rdbg.py [-H host] [-t token] [-b] [command ...]
no command interactive: type commands, see every console line live; Ctrl-D or `quit` leaves
command runs it and prints what follows, until the console has been quiet for a moment
-H host the device's IP (Settings > Debug Console), default $RORO_OTA_HOST
-t token the device's token (also --token), as Settings > Debug Console shows it: dashes and
-H host the device's IP (Settings > System > Debug Console), default $RORO_OTA_HOST
-t token the device's token (also --token), as Settings > System > Debug Console shows it: dashes and
case don't matter. Otherwise $RORO_DEBUG_TOKEN, otherwise ~/.config/roro9stack/debug-token
-b also print the backlog the device sends on connecting (boot messages and so on)
@@ -55,7 +55,7 @@ def find_token(given):
token = tidy_token(token or "")
if not token:
sys.exit("No token: pass -t <token>, set RORO_DEBUG_TOKEN, or put it in " + TOKEN_FILE +
"\n(the device shows it in Settings > Debug Console)")
"\n(the device shows it in Settings > System > Debug Console)")
return token
@@ -63,7 +63,7 @@ def log_in(sock, token):
"""Answers the device's challenge; returns the banner line, or exits saying what went wrong."""
first = read_until(sock, b"\n", 10)
if first is None:
sys.exit("device: nothing came back. Is the console switched on (Settings > Debug Console)?")
sys.exit("device: nothing came back. Is the console switched on (Settings > System > Debug Console)?")
line = first.decode(errors="replace").strip()
if line.startswith("locked"):
sys.exit("device: closed for a minute after too many wrong tokens")
@@ -75,7 +75,7 @@ def log_in(sock, token):
if banner is None:
sys.exit("device: no answer")
if banner.startswith(b"denied"):
sys.exit("device: wrong token (Settings > Debug Console shows the right one)")
sys.exit("device: wrong token (Settings > System > Debug Console shows the right one)")
return banner
@@ -326,7 +326,7 @@ def main():
try:
sock = socket.create_connection((host, PORT), timeout=10)
except OSError as e:
sys.exit(f"device: can't connect to {host}:{PORT} ({e}). Is the console switched on (Settings > Debug Console)?")
sys.exit(f"device: can't connect to {host}:{PORT} ({e}). Is the console switched on (Settings > System > Debug Console)?")
with sock:
banner = log_in(sock, token)
show = sys.stdout if backlog or not args else None
+1 -1
View File
@@ -47,7 +47,7 @@ PREVIOUS="$(git -C "$SRC" describe --tags --abbrev=0 "$VERSION^" 2>/dev/null ||
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.ota\`: the signed Update File. Copy it to \`/updates\` on the SD card and install it from Settings > System > 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."
+1 -1
View File
@@ -2,7 +2,7 @@
"""Copies a file to the Cardputer's SD card over the USB serial console (the `sd put` command).
Usage: scripts/sd_put.sh <file> [card path]
The card path defaults to /updates/<file name>, where Settings > Firmware finds Update Files.
The card path defaults to /updates/<file name>, where Settings > System > Firmware finds Update Files.
The device acknowledges each chunk once it's on the card, checks the SHA-256 of the whole file,
and only then renames <card path>.part to <card path>.
"""
+2
View File
@@ -20,6 +20,8 @@ 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/make_icons.py` turns the Launcher's icons (`assets/icons/<App id>.png`, 32 × 32, one colour) into the arrays in `src/ui/icons.cpp`; run it after changing a picture. CI fails when the two don't match.
`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 6 minutes; later builds take about 15 seconds when little has changed. The platform knows the framework is already rebuilt by `sdkconfig.defaults` in the project folder, which it writes and git ignores: delete it and the next build rebuilds the framework. CI keeps that file, a build cache and ccache in its volume (docs/milestones/R1.md).
+4 -4
View File
@@ -36,19 +36,19 @@ scripts/ota_keygen.sh # once: creates the signing key (see ADR
scripts/flash.sh --ota 10.39.39.12 # build, sign and push; or set RORO_OTA_HOST
```
The device shows the push address in **Settings → Firmware**. It installs a correctly signed update right away, restarts (waiting up to 60 s if you're typing), and runs the new firmware on **Probation**. If the new firmware crashes, or can't reconnect Wi-Fi within 3 minutes, it rolls back to the previous one and says so.
The device shows the push address in **Settings → System → Firmware**. It installs a correctly signed update right away, restarts (waiting up to 60 s if you're typing), and runs the new firmware on **Probation**. If the new firmware crashes, or can't reconnect Wi-Fi within 3 minutes, it rolls back to the previous one and says so.
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).
To install from the SD card instead, copy the `.ota` file from `.pio/build/cardputer-adv/` into `/updates` on the card, then use **Settings → System → 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. (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**:
With no PC and no card, the device can install the project's releases itself (docs/milestones/R1.md). In **Settings → System → 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.
- **Settings → System → 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 > System > 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.
@@ -34,8 +34,8 @@ scripts/flash.sh --ota 10.39.39.12 # builds, signs and pushe
{{ diagram(src="ways-in.svg", min_width=580, caption="Every path ends at the same Update Service and the same signature check.") }}
1. **Push over Wi-Fi** to TCP 3232: `scripts/flash.sh --ota`. The device always listens while Wi-Fi is connected.
2. **From the SD card**: a `.ota` in `/updates`, installed from Settings → Firmware, from the Storage App, or with the `install <path>` command. Put it there by hand, with `scripts/rdbg.py put` over Wi-Fi, or with `scripts/sd_put.sh` over USB.
3. **From the project's releases** on Gitea, which the device downloads itself over TLS (Settings → Firmware, or `update check` / `update install <tag>`): see [Flash and update](/dev/build/flash/).
2. **From the SD card**: a `.ota` in `/updates`, installed from Settings → System → Firmware, from the Storage App, or with the `install <path>` command. Put it there by hand, with `scripts/rdbg.py put` over Wi-Fi, or with `scripts/sd_put.sh` over USB.
3. **From the project's releases** on Gitea, which the device downloads itself over TLS (Settings → System → Firmware, or `update check` / `update install <tag>`): see [Flash and update](/dev/build/flash/).
All three feed the same parser: the **header and signature are checked first**, the image is written to the **other app slot** while it is hashed, and the slot becomes the next boot **only if the hash matches**. Anything wrong ends in a Toast and **nothing changes**. A downgrade is allowed, and shows "older than the installed version".
@@ -21,7 +21,7 @@
<rect class="wi-panel" x="288" y="176" width="200" height="88" rx="8"/>
<text x="302" y="200" font-size="12" font-weight="600">SD card</text>
<text x="302" y="219" font-size="11">/updates/*.ota</text>
<text x="302" y="238" font-size="11" class="wi-dim">Settings → Firmware,</text>
<text x="302" y="238" font-size="11" class="wi-dim">Settings → System → Firmware,</text>
<text x="302" y="254" font-size="11" class="wi-dim">or install &lt;path&gt;</text>
<rect class="wi-hot" x="536" y="32" width="208" height="158" rx="8"/>

Before

Width:  |  Height:  |  Size: 4.3 KiB

After

Width:  |  Height:  |  Size: 4.4 KiB

+7 -4
View File
@@ -26,6 +26,7 @@ lora capture start|stop a LoRa Capture to /captures/lora (pcap, LoRaTap)
lora sweep on [from MHz] [to MHz] [step kHz] | lora sweep off | lora sweep dump RSSI across a band (863 870 100)
lora custom <MHz> <BW kHz> <SF> <CR 5-8> <sync hex> [preamble] e.g. 868.1 125 7 5 34 8 (LoRaWAN)
gnss quiet on|off pause the GNSS receiver while the LoRa radio listens (it costs the radio 8 dB)
imu what the motion sensor reads: g on its three axes, then degrees a second
gnss status | gnss restart | gnss track start|stop | gnss nmea on|off | gnss send <sentence without $ and checksum>
crash the last crash: firmware, reason, task, backtrace
coredump erase forget the core dump in flash
@@ -37,7 +38,7 @@ gemini get <url> fetch a Gemini page and report header, size, certificate, heap
irc start | irc stop | irc dump | irc say <buffer> <text>
install <path.ota> Update from SD
update check | update list | update status | update install <tag> the project's releases on Gitea
sd card | sd list | cat <path> | log <text> | burst | sound on|off | short | normal
sd card | sd list | cat <path> | log <text> | burst | sound on|off | theme [0-6] [light|dark] | short | normal
Irc | Wifi | Gnss | Gemini | Lora | Storage | Notes | Shell | System | Settings open that App: a capital letter is an App, not a command
ping <host> [count] [size] | nslookup <name> [server] | port <host> <port> | traceroute <host> | cancel is it there, does its name resolve, is its port open, which way; one at a time
tls <host> [port] | ntp [server] a TLS handshake: who the certificate is for, by whom, until when, and whether this device trusts it; a time server's clock against this one
@@ -45,8 +46,8 @@ ifconfig | arp | netstat the interfaces (Wi-Fi and the VPN), their addresses,
uname the firmware, its version and the chip it is built for
scp [-f] [-P port] <file on the card> user@host:path | scp [-f] [-P port] user@host:path <file on the card> one file over SSH, with this device's key or, in the Shell, a password, to a server the SSH App already trusts; -f replaces a file on the card; `cancel` stops it
ssh user@host[:port] | ssh status | ssh stop a terminal on another machine, in the SSH App; the password is asked there, never here
vpn status | vpn up [seconds] | vpn down | vpn import [path] | vpn forget | vpn auto on|off the WireGuard tunnel (Settings > VPN); import reads /vpn/wg0.conf; with seconds, it goes down by itself
debug status | debug off [seconds] the Debug Console over Wi-Fi (Settings > Debug Console); with seconds, it comes back
vpn status | vpn up [seconds] | vpn down | vpn import [path] | vpn forget | vpn auto on|off the WireGuard tunnel (Settings > Network > VPN); import reads /vpn/wg0.conf; with seconds, it goes down by itself
debug status | debug off [seconds] the Debug Console over Wi-Fi (Settings > System > Debug Console); with seconds, it comes back
debug on | debug token <16 to 64 characters> | debug token new (USB serial only) switch it on, set its token
crash abort|wdt crash on purpose (to test crash reports and Safe Mode)
wifi ip ... try <seconds> | wifi ip keep a trial IP setting: back to the previous one unless kept
@@ -71,6 +72,7 @@ In **Safe Mode** (see [Crashes and Safe Mode](/dev/debug/crashes/)) only a few r
| `burst` | Publishes 5 Notifications at once |
| `key up\|down\|left\|right\|select\|back\|home\|del\|tab\|space\|help\|shot`, or `key <char>` | Injects a key press (`help` is Fn+h: the keys of the screen that is showing; `shot` is Fn+p: a screenshot). `ctrl-`, `alt-` and `shift-` before it hold that key: `key ctrl-down`, `key alt-up`, `key ctrl-b` |
| `sound on` / `sound off` | Toggles the Sound setting (beep + LED) |
| `theme` / `theme <0-6> [light\|dark]` | Lists the colour themes, or picks one and its side |
| `short` / `normal` | Screen timeouts 5 s / 10 s, or 30 s / 60 s |
| `wifi add <ssid><TAB><password>` | Adds a Saved Network (so credentials stay out of the repo) |
| `wifi ip <ssid> dhcp` / `wifi ip <ssid> <address>/<prefix> [gateway]` | A Saved Network's IP setting: Automatic, or Fixed. Add `try <seconds>` to go back to the previous setting unless `wifi ip keep` follows |
@@ -96,7 +98,7 @@ In **Safe Mode** (see [Crashes and Safe Mode](/dev/debug/crashes/)) only a few r
| `ls [folder]` / `du <path>` | Lists a folder of the SD card with sizes and dates, or counts the files and bytes under a path |
| `screenshot [seconds]` | The screen as a PNG in `/screenshots` on the card, now or after a pause to get to the screen you want (240 x 135, about 33 KB). Over the Debug Console a bare `screenshot` sends the screen to the PC instead |
| `cp [-f] <from> <to>` / `mv [-f] <from> <to>` / `rm [-r] [-f] <path>` / `mkdir <path>` / `cancel` | What the Storage App does, with its rules: copy (folders too), move or rename, delete (`rm -r` for a folder and what's in it, as Unix has it), new folder. `-f` replaces a file that's in the way; `*` and `?` in the last part of a path (`ls`, `du`, `rm`, `cp`, `mv`) run the command for each name matched, 64 at most; 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 |
| `install <path>` | Update from SD with that `.ota` file, as Settings → System → 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 |
| `update pretend <version>` / `update probe <host>` / `update damage cut\|flip <n>` / `update daily` | 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 |
@@ -106,6 +108,7 @@ In **Safe Mode** (see [Crashes and Safe Mode](/dev/debug/crashes/)) only a few r
| `lora capture start` / `lora capture stop` | A LoRa Capture, as `c` in the App |
| `lora sweep on [from MHz] [to MHz] [step kHz]` / `lora sweep off` / `lora sweep dump` | Sweep a band (863 870 100 by default), with a summary every 2 s (floor, strongest, peaks), or print the latest pass |
| `gnss quiet on` / `gnss quiet off` | The "Pause GNSS for LoRa" setting |
| `imu` | What the motion sensor reads: g on its three axes, then degrees a second (the Compass, issue #16) |
| `gnss status` / `gnss restart` | The receiver's state, and a restart of it |
| `gnss track start` / `gnss track stop` | A Track, as `r` in the GNSS App (the reason is printed if it can't start) |
| `gnss nmea on` / `gnss nmea off` | Prints each NMEA sentence the receiver sends, as `nmea: …` |
+1 -1
View File
@@ -16,7 +16,7 @@ Before version 0.12 this was a separate *Debug Build* with a token compiled in f
## On the device
**Settings → Debug Console:**
**Settings → System → Debug Console:**
| Row | Does |
|---|---|
+47
View File
@@ -0,0 +1,47 @@
+++
title = "On-board hardware"
description = "The hardware the device already carries and nothing used yet (the motion sensor, the infrared LED, the microphone and speaker) each gets something useful to do."
weight = 110
[extra]
docs = true
source = "docs/milestones/H1.md"
tag = "H1"
+++
**Status:** in progress. Built, not released yet: the Compass (issue #16). Not started: the IR Remote (#15), the Audio App (#14).
**Goal:** the hardware the device already carries and nothing used yet (the motion sensor, the infrared LED, the microphone and speaker) each gets something useful to do.
## The Compass (issue #16)
The device has a GNSS receiver and a motion sensor (a BMI270: an accelerometer and a gyroscope) but **no magnetometer**: standing still, nothing in it knows where north is. The receiver gives the direction of travel while walking; the gyroscope measures turns, but not from where.
### Decisions (design round 2026-10-10)
| # | Decision |
|---|---|
| Q267 | **A third view of the GNSS App,** after Position and Sky, not an App of its own: Tab goes round the three. |
| Q268 | **North comes from outside, and the gyroscope holds it.** Walking at 3 km/h or more, each course the receiver reports pulls the heading 30 % of the way to it. Standing, the gyroscope follows the turns, and the screen says how long ago north was last given. |
| Q269 | **The sun gives north too:** `s` with the top of the device aimed at the sun sets the heading to the sun's azimuth, worked out from the time and the position. The sun is drawn on the rose, as something to check north against. |
| Q270 | **The heading is where the top of the device points.** The turn that counts is the one around the vertical, which the accelerometer gives: it works however the device is held. Walking, the device is taken to point the way you walk. |
| Q271 | **Places:** `m` marks where you stand, under a name; `t` picks one as the target. The rose then carries an arrowhead to it, with its distance and bearing. Targets from Tracks, typed coordinates or Gemini links are for later. |
| Q272 | **Places are GPX waypoints** in `/gnss/places.gpx` on the SD card, 50 at most: a map program opens the file, and waypoints made by one are read here. The whole file is written at each change. |
| Q273 | **A level** from the accelerometer, next to the readouts: the heading is only as good as the device is flat when aiming at the sun. |
| Q274 | **Not now:** a magnetometer on the Grove port (and so declination), a faster GNSS rate, sunrise and sunset, an estimated time of arrival. |
### As built
- **`lib/gnss/src/compass.{h,cpp}`**, host-tested (13 tests): `HeadingFilter` (the turn around "up" from the gyroscope, the course and the sun as references, the gyroscope's offset learnt while the device lies still), `sunPosition` (the Astronomical Almanac's low-precision formulas), `bearingDegrees`, `cardinal`, `formatDistance`.
- **`lib/gnss/src/places.{h,cpp}`**, host-tested (5 tests): the Places as GPX waypoints, read and written.
- **The GNSS App** reads the sensor 100 times a second while it is in front, in any of its views, and forgets north when it is left: the turns made meanwhile were not followed. The Compass is drawn again when the heading moves by a degree or the level moves, at most 20 times a second.
- **`imu`** on the consoles prints what the sensor reads.
### Checked on the device (2026-10-11)
- The sensor answers as a BMI270 through M5Unified, and reads about 0.5 degrees a second on one axis lying still.
- Turning the device clockwise makes the heading go up, and the level's bubble goes to the edge that is lifted: the sensor's axes are as the code took them.
- Not checked yet: north from the course while walking, north from the sun against a real compass, and how far the heading drifts in the hand.
### What the sensor's offset costs
A gyroscope reads a little even when nothing turns (up to about 0.5 degrees a second for this one), which would turn the rose by itself. The filter takes what the sensor reads while it has been still for a second (under 2 degrees a second on all axes) as that offset. In the hand the device is rarely that still: lay it down for a few seconds first. After 3 minutes without north the screen shows the age of the heading in the warning colour.
+77 -1
View File
@@ -8,7 +8,7 @@ docs = true
source = "docs/milestones/U1.md"
tag = "U1"
+++
**Status:** in progress. Shipped: the help key (issue #69) and the key tables the website shares with it (#72), both in **v0.13.0**; the screenshot key (#83, **v0.17.0**). Not started: screen recording (#17), a Launcher of tiles (#9), themes (#10).
**Status:** in progress. Shipped: the help key (issue #69) and the key tables the website shares with it (#72), both in **v0.13.0**; the screenshot key (#83, **v0.17.0**). The Launcher as a grid of icons (#9) and themes (#10) are done, not released yet. Not started: screen recording (#17).
**Goal:** the interface is consistent and uncrowded: the same thing is done the same way on every screen, and the 135 pixels of height go to content.
@@ -67,3 +67,79 @@ A screenshot could only be taken by typing `screenshot` in the Shell, where "now
**Checked on the device** (2026-10-07, with `key shot`): in the Launcher, a 33,383-byte PNG appears in `/screenshots` and is the Launcher; with the help panel open, the picture is of the panel (which now lists Fn p) and the panel stays open; on Settings > Debug Console, no file is written; back on the Settings list, one is. The test pictures were removed.
**Not checked:** the real Fn+p on the keyboard (the mapper is host-tested); the two Toasts that refuse, which weren't looked at (one of them is on the page that mustn't be photographed); a device with no card.
## The Launcher as a grid (issue #9)
The Launcher was a list of names. It is now a grid of icons.
| Question in the issue | Decided |
|---|---|
| Layout | **4 × 3** tiles of 60 × 36, so the 11 Apps are on one page. Only the selected App's name is written, on a line under the grid: a name under every tile doesn't fit 60 pixels ("LoRa Scanner"). More than 12 Apps: the rows scroll |
| Icons | **The website's own**: its nine 16 × 16 pictures (`site/static/img/icons-dark.svg`), doubled to 32 × 32, and two drawn the same way for SSH and the Shell. 1 bit a pixel (128 bytes each, in flash). The pictures are PNGs in `assets/icons/`, named after the App's id; `scripts/make_icons.py` writes `src/ui/icons.cpp` from them and CI checks the two match |
| Colours | **The website's**: cyan (#00dbff) on black, and the selected tile slate (#494955, the Status Bar's) on a cyan fill with notched corners. Both are RGB332 colours. The name under the grid is white |
| Live state | **A dot** on the tile, from `App::badge()`: IRC (unread messages), GNSS (a Track recording), the LoRa Scanner (a Capture running), SSH (a session open). The Launcher asks every App on each pass and redraws when an answer changes |
| Order | As registered, as before |
| Shortcuts | None for now |
| The list | Kept: **Settings > Launcher**, Grid or List. Both keep the same selection |
- `GridModel` (`lib/ui`) holds the selection and the scrolling, host-tested: left and right go through every item and wrap; up and down stay in the column, and land on the last item where the last row is short.
- An App registered without an icon shows its first letter in a frame.
- No animation: not asked for, and not measured.
## The website's colours, on every screen
Every screen takes its colours from `src/ui/theme.h`, so the palette changed there, to the website's (`site/static/css/site.css`, dark side). Each is a colour the RGB332 frame buffer holds exactly.
| | Was | Is |
|---|---|---|
| Accent | teal-blue | cyan `#00dbff` |
| A selected row, a dialog's chosen button | darker teal, white text | cyan, dark blue text (`#000055`) |
| Status Bar | `#202020`, which the frame buffer showed as a dull olive | slate `#494955`; what is idle on it in light grey `#b6b6aa` |
| Muted text | grey, as the frame buffer rounded it | the same grey, exact: `#9292aa` |
| Warning | orange | the website's orange `#ff9200` |
| Someone wrote (unread count, a mention, a message Toast) | green | pink `#ff92ff` |
| Good (a Fix, the quietest channel, a live task) | the same green | green `#49db55`, the one colour that isn't the website's: it has no green |
| Text on a Toast | black | dark blue |
Looked at on the device, by screenshot: the Launcher, IRC, Wi-Fi Tools (menu, channel occupancy), GNSS (position, sky), Gemini, the LoRa Scanner (Sniffer, Sweep, presets), Storage, Notes, SSH, the Shell, System, Settings and the help panel. Not looked at: dialogs, a warning or a message Toast, the SSH terminal (which keeps its own 16 ANSI colours), the Setup screens.
## Themes (issue #10)
Seven themes, each with a dark and a light side, chosen in **Settings > Theme** and **Settings > Light or dark**: roro9stack (the website's, the default), Catppuccin (Mocha and Latte), Dracula (and Alucard), Nord, ANSI terminal, Gruvbox, Solarized.
| Question in the issue | Decided |
|---|---|
| Which themes | The seven above. Not the high-contrast and phosphor ones the issue suggested: ANSI terminal dark (grey and green on black) and light (black on white) come close |
| Fonts and spacing too | No: colours only |
| Themes from the SD card | No: built in |
| A preview while picking | The Setting applies at once, so the Settings screen is the preview |
| Constellation colours | From the theme (its accent, its "good", and three roles named red, yellow and violet), so they read on every background |
| Light by day, dark by night | No |
- **A palette is 14 roles** (`lib/ui/src/palette.h`): background, text, muted, faint, the bar and its idle marks, accent, what is drawn on an accent, warning, message, good, and red, yellow and violet.
- **`theme::kText` and the others are now references** into the palette in use (`src/ui/theme.h`), so no App changed: they still read as constants. The main loop applies the palette when either Setting changes, and draws everything again.
- **RGB332.** Every colour in the table is one the frame buffer holds exactly. The themes' own colours were rounded to those; where two roles fell together or lost contrast, one was picked by hand (Nord's accent and muted text, Gruvbox's greys, Solarized's surfaces). `test_palette` checks that every colour is exact, and 18 contrast ratios for each of the 14 palettes (text on background at 4.5 or more, the rest at 2 to 3).
- **What it costs in fidelity:** blue has four levels, so Dracula and Nord share a dark background (#242455), which was Catppuccin's too: Catppuccin dark is on black instead (its "crust"), with that blue for its bar and its brighter accents (peach, pink, green, sky), to tell it from Dracula; Solarized light's cream becomes white, and Gruvbox's dark brown becomes a dark olive (#242400).
- `theme [0-6] [light|dark]` on the consoles lists them or picks one.
**Looked at on the device**, by screenshot: the Launcher in all 14; and in Gruvbox light, Settings, GNSS (position and sky), the Sweep, Storage, the help panel, Gemini and Wi-Fi Tools' channel occupancy. Nothing was drawn for black only.
**Kept as they are:** the SSH terminal's 16 ANSI colours and its black background, the Sweep's waterfall scale, pictures, and the screen shown while the device powers off.
**Not looked at:** the other 12 palettes beyond the Launcher, dialogs and Toasts in any theme but the default, the Setup screens. In Gruvbox light, the Sky view's GPS, GLONASS and BeiDou colours are three close shades of brown and red.
## Settings in groups
Settings had grown to 21 rows in one list. It now opens on five groups, each a short list of its own:
| Group | Rows |
|---|---|
| This device | Long name, Short name, Region, Timezone, Sound & LED |
| Display | Brightness, Dim after, Screen off after, Theme, Light or dark, Launcher |
| GNSS and radio | GNSS, Pause GNSS for LoRa, Coordinates, Probe MACs |
| Network | Wi-Fi, VPN |
| System | Check for updates, Firmware, Debug Console, About |
- Enter opens a group, Back returns to the groups with the selection on the one just left, and Back from the groups leaves Settings. An open group has its name over its rows.
- `SettingsMenu` (`lib/apps_model`) holds the groups and which one is open; every index is into what is listed. Host-tested: every setting is in exactly one group, and no group has more rows than fit under its name.
- The guide, the how-tos, the README, the scripts' messages and the firmware's own (the Toast for a new release, the GNSS App's hint) name the new paths: "Settings > System > Firmware". The milestone notes and the devlog keep the paths of their day.
+2 -2
View File
@@ -39,7 +39,7 @@ The browser flasher uses Web Serial, which Chrome and Edge have on desktop and F
## How do I update it?
Three ways, all with the same signed update file: from the project's releases on the device itself (**Settings → Firmware**), from the SD card, or pushed over Wi-Fi from a PC. See [Updates](/guide/updates/) and [Install an update from the SD card](/howto/update-from-sd/).
Three ways, all with the same signed update file: from the project's releases on the device itself (**Settings → System → Firmware**), from the SD card, or pushed over Wi-Fi from a PC. See [Updates](/guide/updates/) and [Install an update from the SD card](/howto/update-from-sd/).
## Is it safe to update? What if it goes wrong?
@@ -51,7 +51,7 @@ Yes: it is [open source](https://git.twis.la/twisla/roro9stack) (GPL-3.0). The d
## Does it phone home? What about privacy?
**The firmware contacts the project's server once a day,** to see whether a new release exists: **Settings → Check for updates**, on by default, only when Wi-Fi is up and the clock is set. It installs nothing by itself, and you can switch it off. Besides that, the device talks to what you ask it to: the IRC server and Gemini capsules you open, DNS servers (9.9.9.9 and 1.1.1.1 by default) and time servers (pool.ntp.org and time.cloudflare.com by default), all of which you can change. There is no account, no analytics and no telemetry.
**The firmware contacts the project's server once a day,** to see whether a new release exists: **Settings → System → Check for updates**, on by default, only when Wi-Fi is up and the clock is set. It installs nothing by itself, and you can switch it off. Besides that, the device talks to what you ask it to: the IRC server and Gemini capsules you open, DNS servers (9.9.9.9 and 1.1.1.1 by default) and time servers (pool.ntp.org and time.cloudflare.com by default), all of which you can change. There is no account, no analytics and no telemetry.
**It listens on the network only for what you switched on:** the port that receives signed firmware updates, always; the Debug Console, the card shared with a browser and the VPN, only while you have them on. The SSH App connects out to the server you name and listens for nothing.
+8 -2
View File
@@ -36,7 +36,13 @@ While you type text (a note, an IRC line, a setting), `;` `.` `,` `/` type their
## The Launcher
The home screen lists the Apps. Move with the arrows, open one with <kbd>Enter</kbd>. Back inside an App returns here.
The home screen shows the Apps as a grid of icons, four to a row, with the name of the selected one written under the grid. Move with the four arrows, open an App with <kbd>Enter</kbd>. Back inside an App returns here.
Left and right go through every App and wrap around; up and down stay in the column.
**An orange dot on an icon** says something is going on in that App: unread messages in IRC, a Track being recorded in GNSS, a Capture running in the LoRa Scanner, a session open in SSH.
If you prefer the list of names the Launcher used to be, **Settings → Display → Launcher** switches between **Grid** and **List**. In the list, a `*` on the right stands for the dot.
## The Status Bar
@@ -51,7 +57,7 @@ A strip at the top of every screen: the name of the App on the left, and on the
| bars and `W` | Wi-Fi connected, with its signal; `W?` is searching; `MON` is the Wi-Fi radio in its monitoring mode, which pauses IRC |
| `SSH` | An [SSH session](/guide/ssh/) is open, whatever App is in front |
| `VPN` | The [WireGuard tunnel](/guide/vpn/) is wanted; brighter once the server has answered |
| `DBG` | The Debug Console is switched on (Settings → Debug Console); brighter while a PC is connected to it |
| `DBG` | The Debug Console is switched on (Settings → System → Debug Console); brighter while a PC is connected to it |
| `REC` | A GNSS Track is being recorded |
| `CAP` | A LoRa capture is being recorded |
| `L` | The radio is listening; it lights up for a moment on each packet. `SW` while a Sweep runs |
+26 -5
View File
@@ -1,19 +1,19 @@
+++
title = "GNSS"
description = "Where you are and which satellites you can see, from the Cap's receiver, with Tracks saved to the SD card as GPX."
description = "Where you are, which satellites you can see, and a compass that leads back to a place you marked, from the Cap's receiver, with Tracks saved to the SD card as GPX."
weight = 3
[extra]
tag = "GNSS"
screens = ["sky.png"]
+++
GNSS needs the **Cap LoRa-1262**, an antenna with a view of the sky, and **Settings → GNSS** switched **On**. Otherwise the App says `GNSS is off` (or `paused`, when "Pause GNSS for LoRa" has put the receiver on standby while the radio listens). A first fix outdoors can take a while: the App says how long it has been searching.
GNSS needs the **Cap LoRa-1262**, an antenna with a view of the sky, and **Settings → GNSS and radio → GNSS** switched **On**. Otherwise the App says `GNSS is off` (or `paused`, when "Pause GNSS for LoRa" has put the receiver on standby while the radio listens). A first fix outdoors can take a while: the App says how long it has been searching.
## Position
The first view shows the fix (`No Fix`, `2D Fix` or `3D Fix`, and how many satellites it uses), then:
- **Lat** and **Lon**, in decimal degrees or degrees, minutes and seconds (**Settings → Coordinates**);
- **Lat** and **Lon**, in decimal degrees or degrees, minutes and seconds (**Settings → GNSS and radio → Coordinates**);
- the **Locator**, the Maidenhead grid square;
- **Altitude**, **Speed** and the direction you are moving;
- **HDOP**, the horizontal precision: a smaller number is better;
@@ -23,7 +23,28 @@ Once there is a fix, the device's clock follows it.
## Sky
<kbd>Tab</kbd> switches between Position and **Sky**: a circle with N, E, S and W, where each satellite is a dot, coloured by constellation, and filled when the receiver uses it. A legend counts, for each constellation (GPS, GLONASS, Galileo, BeiDou), the satellites used and in view.
<kbd>Tab</kbd> goes from Position to **Sky**: a circle with N, E, S and W, where each satellite is a dot, coloured by constellation, and filled when the receiver uses it. A legend counts, for each constellation (GPS, GLONASS, Galileo, BeiDou), the satellites used and in view.
## Compass
<kbd>Tab</kbd> once more shows the **Compass**: a rose that turns with the device, so that its red `N` and the bright half of its needle stay to the north. The mark at the top of the rose is the top of the device, and the number beside it is where that points, in degrees and as one of 16 points (`247° WSW`).
The device has **no magnetometer**, so it cannot find north by itself. It learns it in one of two ways, then follows your turns with its motion sensor:
- **Walk.** At a walking pace (3 km/h or more) the receiver knows which way you are going, and the Compass takes that as where the device points. Hold it pointing ahead of you.
- **Aim at the sun.** Hold the device flat, point its top edge at the sun, and press <kbd>s</kbd>: the Compass works out where the sun is from the time and your position. It needs a fix, and the sun above the horizon.
Until one of these has happened the rose is dim and the screen says `North is not known`. After that, the line under the heading says where north came from and how long ago (`the sun, 40 s ago`). The motion sensor drifts by a few degrees a minute, so north should be given again now and then: after three minutes the line changes colour. Laying the device down for a few seconds lets the sensor steady itself and drift less. Leaving the GNSS App forgets north.
A yellow dot on the rose is the **sun**, where it is now: if the dot is not towards the sun, north is off.
The circle at the bottom is a **level**: its bubble is in the middle, and green, when the device is flat.
### Places
<kbd>m</kbd> **marks** where you are standing as a **Place**, under a name you type (the car, the tent), and makes it the target. With a target, the rose carries a cyan arrowhead that points to it, and the screen shows its name, how far it is and its bearing (`340 m 285°`): turn until the arrowhead is at the top and walk.
<kbd>t</kbd> lists the Places with their distances, to pick another target, or none; <kbd>d</kbd> in that list removes one. The Places are kept on the SD card in `/gnss/places.gpx`, as GPX waypoints: a map program opens the file, and waypoints you put in it from one show up in the list (50 at most).
## Tracks
@@ -33,4 +54,4 @@ Once there is a fix, the device's clock follows it.
What <kbd>Fn</kbd> + <kbd>h</kbd> shows on these screens. These tables are generated from the firmware's own lists, so they are always the current ones.
{{ keys(scopes=["gnss"]) }}
{{ keys(scopes=["gnss", "gnss-compass", "gnss-places"]) }}
+1 -1
View File
@@ -63,7 +63,7 @@ A capture records packets into a **pcap** file with LoRaTap headers in `/capture
## The GNSS receiver raises the noise
The GNSS receiver on the same Cap makes the radio's noise floor about **8 dB** worse while it runs. **Settings → Pause GNSS for LoRa** (off by default) puts the receiver on standby while the radio listens, except while a Track is being recorded.
The GNSS receiver on the same Cap makes the radio's noise floor about **8 dB** worse while it runs. **Settings → GNSS and radio → Pause GNSS for LoRa** (off by default) puts the receiver on standby while the radio listens, except while a Track is being recorded.
## The keys, as the device lists them
+39 -3
View File
@@ -6,23 +6,51 @@ weight = 11
tag = "Settings"
+++
Move with the arrows. On a toggle, a choice or a slider, left and right change the value; <kbd>Enter</kbd> opens a text field or a list of choices, or a page marked `>`. Back leaves.
Settings opens on five **groups**. <kbd>Enter</kbd> opens a group, and Back returns to the groups; Back from the groups leaves Settings.
Inside a group, move with the arrows. On a toggle, a choice or a slider, left and right change the value; <kbd>Enter</kbd> opens a text field or a list of choices, or a page marked `>`.
### This device
| Setting | What it is |
|---|---|
| **Long name**, **Short name** | The names you gave in the first-start Setup (up to 39 bytes, and up to 4 characters) |
| **Region** | The regulatory region; EU868 |
| **Timezone** | For the clock and the dates in file names |
| **Sound & LED** | The beep and the flash on a [Toast](/guide/basics/) |
### Display
| Setting | What it is |
|---|---|
| **Brightness** | A slider |
| **Dim after**, **Screen off after** | Screen timeouts. Dimming must come before the screen turns off |
| **Sound & LED** | The beep and the flash on a [Toast](/guide/basics/) |
| **Theme** | The colours of every screen: **roro9stack** (the website's), **Catppuccin**, **Dracula**, **Nord**, **ANSI terminal**, **Gruvbox** or **Solarized** |
| **Light or dark** | Which side of the theme: every one has both |
| **Launcher** | The home screen as a **Grid** of icons or a **List** of names (see [The basics](/guide/basics/#the-launcher)) |
### GNSS and radio
| Setting | What it is |
|---|---|
| **GNSS** | Switches the receiver on and off (see [GNSS](/guide/gnss/)) |
| **Pause GNSS for LoRa** | Puts the receiver on standby while the radio listens (see [LoRa Scanner](/guide/lora-scanner/)) |
| **Coordinates** | Decimal degrees, or degrees, minutes and seconds |
| **Probe MACs** | Whether the Wi-Fi Tools' logs of probe requests keep the addresses as they are (**Raw**) or **Pseudonymised** |
### Network
| Setting | What it is |
|---|---|
| **Wi-Fi** | The page below |
| **VPN** | A WireGuard tunnel: its switch, "Start with Wi-Fi", and importing its configuration from the card. See [VPN](/guide/vpn/) |
### System
| Setting | What it is |
|---|---|
| **Check for updates** | Once a day, see [Updates](/guide/updates/) |
| **Firmware** | The page described in [Updates](/guide/updates/) |
| **VPN** | A WireGuard tunnel: its switch, "Start with Wi-Fi", and importing its configuration from the card. See [VPN](/guide/vpn/) |
| **Debug Console** | Off unless you switch it on. It lets a PC on the same network read the device's console and drive it, with a token shown on this page: see [the developer docs](/dev/debug/switch-it-on/). Leave it off if that means nothing to you |
| **About** | The firmware version, the node number, battery, memory, uptime, clock and licence |
@@ -48,3 +76,11 @@ Two DNS servers (9.9.9.9 and 1.1.1.1 by default), used on Fixed networks, or on
What <kbd>Fn</kbd> + <kbd>h</kbd> shows on these screens. These tables are generated from the firmware's own lists, so they are always the current ones.
{{ keys(scopes=["settings", "settings-choice", "wifi", "wifi-servers", "wifi-network", "wifi-status", "wifi-scan", "wifi-name", "vpn", "debug-console"]) }}
## Themes
A theme changes the colours and nothing else: the fonts and the layout stay. It applies at once, to every App, and is kept across restarts.
The screen shows **256 colours**, so a theme here is the nearest the screen can do to the palette it is named after, not an exact copy: pale backgrounds turn white or cream, and dark ones turn a deep blue or olive. Each theme is checked for contrast after that rounding.
Three things keep their own colours whatever the theme: the SSH terminal (the 16 colours a remote program asks for), the Sweep's waterfall (its colours are a scale of signal strength), and pictures.
+2 -2
View File
@@ -9,7 +9,7 @@ screens = ["update.png"]
Every update is one **signed file** (`.ota`). The device installs only a file signed with the project's key, so it cannot be tricked into installing anything else, whichever way the file arrives.
## Settings → Firmware
## Settings → System → Firmware
The page shows the **version** running, its **status**, the address to **push updates to** over Wi-Fi, and:
@@ -21,7 +21,7 @@ An install needs Wi-Fi if it is a download. The new firmware is checked before a
## Check for updates
**Settings → Check for updates** is on by default. Once a day, with Wi-Fi up and the clock set, the device looks at the latest release and says `v0.11.0 is out: see Settings > Firmware`, once per version. It installs **nothing** by itself, and it does not announce a version that already failed and rolled back on this device.
**Settings → System → Check for updates** is on by default. Once a day, with Wi-Fi up and the clock set, the device looks at the latest release and says `v0.11.0 is out: see Settings > System > Firmware`, once per version. It installs **nothing** by itself, and it does not announce a version that already failed and rolled back on this device.
## Probation and Rollback
+2 -2
View File
@@ -15,14 +15,14 @@ You need a WireGuard server, yours or a provider's, and the configuration file i
1. On the server, make a configuration for a new client, as you would for a phone.
2. Copy the file to the SD card as **`/vpn/wg0.conf`**.
3. On the device: **Settings → VPN → Import /vpn/wg0.conf**.
3. On the device: **Settings → Network → VPN → Import /vpn/wg0.conf**.
4. Say yes when it offers to **delete the file**: the configuration is now stored in the device, and the file on the card still holds the private key in clear.
If the file can't be used, the page says which line and why. The key itself is never shown, anywhere, once imported.
## Using it
**Settings → VPN** has a switch. `VPN` appears in the [Status Bar](/guide/basics/#the-status-bar) while the tunnel is wanted, and turns bright once the server has answered. The page shows the state, the server, this device's address in the tunnel, what goes through it, and how long ago the server was last heard.
**Settings → Network → VPN** has a switch. `VPN` appears in the [Status Bar](/guide/basics/#the-status-bar) while the tunnel is wanted, and turns bright once the server has answered. The page shows the state, the server, this device's address in the tunnel, what goes through it, and how long ago the server was last heard.
- **The switch is for now.** It doesn't survive a restart.
- **Start with Wi-Fi**, off by default, starts the tunnel whenever Wi-Fi connects.
+2 -2
View File
@@ -6,14 +6,14 @@ weight = 4
tag = "Wi-Fi"
+++
1. **Add the network first.** In **Settings → Wi-Fi**, choose **Add a network**, pick it and type the password. (A hidden network has its own entry, which asks for the name first.)
1. **Add the network first.** In **Settings → Network → Wi-Fi**, choose **Add a network**, pick it and type the password. (A hidden network has its own entry, which asks for the name first.)
2. **Open the network's page:** <kbd>Enter</kbd> on it in the list of saved networks.
3. **Set *IP address* to *Fixed*.** The address, the prefix and the gateway start from what the network is giving the device at that moment, so you only change what is wrong.
- **Address:** four numbers, like `10.39.39.13`.
- **Prefix:** 1 to 30. 24 is 255.255.255.0.
- **Gateway:** optional; empty means none.
4. **Leave the page.** The setting is checked and applied then; a bad address is refused with the reason.
5. **Check it.** Back in **Settings → Wi-Fi**, <kbd>Enter</kbd> on **Status** shows the address, the mask, the gateway, the DNS and NTP servers, and where each came from.
5. **Check it.** Back in **Settings → Network → Wi-Fi**, <kbd>Enter</kbd> on **Status** shows the address, the mask, the gateway, the DNS and NTP servers, and where each came from.
## DNS and time
+1 -1
View File
@@ -8,7 +8,7 @@ tag = "GNSS"
You need the **Cap LoRa-1262**, an **SD card**, and a place with a view of the sky.
1. **Switch the receiver on:** **Settings → GNSS** to *On*. The Status Bar shows `G` once it is searching.
1. **Switch the receiver on:** **Settings → GNSS and radio → GNSS** to *On*. The Status Bar shows `G` once it is searching.
2. **Open the GNSS App** and wait for a fix. The first line says `Searching: n in view` and how long it has been, then `3D Fix, n of m satellites`. The first fix outdoors can take a while.
3. **The clock must be set.** A fix sets it, and so does Wi-Fi. A Track will not start without one: the App says `Waiting for the time`.
4. **Press <kbd>r</kbd>.** The bottom line says `REC`, with the number of points and how long it has been going, and the Status Bar shows `REC`. You can leave the App: the Track keeps recording.
+1 -1
View File
@@ -14,5 +14,5 @@ tag = "Screen"
- It needs an SD card.
- The files are PNGs of 240 by 135 pixels, named by date and time.
- **It refuses on Settings → Debug Console**, the page that shows the console's token: a picture of it would be a copy of the token.
- **It refuses on Settings → System → Debug Console**, the page that shows the console's token: a picture of it would be a copy of the token.
- From the [Shell](/guide/shell/), `screenshot 5` takes the picture five seconds later, for a screen you can't press keys on.
+1 -1
View File
@@ -8,7 +8,7 @@ tag = "Updates"
1. **Get the update file.** On the [Downloads page](/downloads/), take the `.ota` file of the release you want: `roro9stack-<version>.ota`. Every release has one.
2. **Copy it to `/updates`** on the SD card, from a computer. If the folder is not there, create it. (With the Cardputer on USB, a developer can also send it with `scripts/sd_put.sh`; see the [README](https://git.twis.la/twisla/roro9stack#firmware-updates-over-wi-fi-ota).)
3. **Put the card in the Cardputer.** Open **Settings → Firmware.** Under *On the SD card* the file is listed. If it says `No .ota files in /updates`, the name or the folder is wrong.
3. **Put the card in the Cardputer.** Open **Settings → System → Firmware.** Under *On the SD card* the file is listed. If it says `No .ota files in /updates`, the name or the folder is wrong.
4. **Press Enter on the file,** then **Install**. The device checks the signature and the contents before it writes anything, installs, and restarts. It waits up to 60 seconds if you are typing.
5. **After the restart** the new firmware is on **Probation**: if it crashes or cannot get Wi-Fi back within 3 minutes, the device goes back to the previous version by itself and says so.
+1 -1
View File
@@ -12,7 +12,7 @@ You need a WireGuard server, and a **client configuration** made on it for the C
2. On the Cardputer, open **Storage** and press <kbd>w</kbd>; open the page on the phone ([Move files with your phone](/howto/phone-files/)).
3. In the page, tap **New folder**, name it `vpn`, go into it, and **upload `wg0.conf`**.
4. On the Cardputer, press Back to stop sharing.
5. Open **Settings → VPN → Import /vpn/wg0.conf**. You should see "Imported", and a question: **delete the file**. Say yes: the configuration is now in the device, and the file still holds the private key in clear.
5. Open **Settings → Network → VPN → Import /vpn/wg0.conf**. You should see "Imported", and a question: **delete the file**. Say yes: the configuration is now in the device, and the file still holds the private key in clear.
6. Switch **VPN** to On. `VPN` appears in the Status Bar, and turns bright once the server has answered, usually within seconds. The page says "It is up".
7. To have it start by itself, switch on **Start with Wi-Fi**.
+24 -3
View File
@@ -36,7 +36,7 @@ rows = [
id = "launcher"
title = "The Launcher"
rows = [
["; .", "up, down"],
["; . , /", "move"],
["Enter", "open the App"],
]
@@ -142,10 +142,30 @@ rows = [
id = "gnss"
title = "GNSS"
rows = [
["Tab", "the position, or the sky"],
["Tab", "position, sky, compass"],
["r", "record a Track, or stop it"],
]
[[scope]]
id = "gnss-compass"
title = "GNSS, the compass"
rows = [
["Tab", "position, sky, compass"],
["m", "mark this place"],
["t", "the target: a place"],
["s", "aimed at the sun: north"],
["r", "record a Track, or stop it"],
]
[[scope]]
id = "gnss-places"
title = "GNSS, the places"
rows = [
["; .", "up, down"],
["Enter", "the target"],
["d Del", "remove the place"],
]
[[scope]]
id = "gemini"
title = "Gemini, a page"
@@ -488,8 +508,9 @@ id = "settings"
title = "Settings"
rows = [
["; .", "up, down"],
["Enter", "edit, or open the page"],
["Enter", "open the group or the page, or edit"],
[", /", "change a switch or a slider"],
["`", "back to the groups"],
]
[[scope]]
+1 -1
View File
@@ -11,7 +11,7 @@
</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>.</p>
<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 → System → 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>.</p>
</div>
{% if releases %}
+1 -1
View File
@@ -25,7 +25,7 @@ REPO = SITE.parent
OUT = SITE / "content" / "dev"
REPO_URL = re.search(r'repo\s*=\s*"([^"]+)"', (SITE / "config.toml").read_text()).group(1)
MILESTONES = ["OTA", "M2", "G1", "M3", "S1", "F1", "R1", "W1", "U1", "N1"] # in the order they were done
MILESTONES = ["OTA", "M2", "G1", "M3", "S1", "F1", "R1", "W1", "U1", "N1", "H1"] # in the order they were done
# Left out on purpose: docs/milestones/M0.md, M1.md and CONTEXT.md (the glossary) describe Wi-Fi monitoring, which this site does not publish.
# They stay in the repository.
+1 -1
View File
@@ -15,7 +15,7 @@
namespace roro {
// Settings → Debug Console (ADR 0010): the switch, where to connect, and the token, which is shown
// Settings → System → Debug Console (ADR 0010): the switch, where to connect, and the token, which is shown
// here and nowhere else. Switching on makes a token if there's none; a new one, or one typed by
// hand, ends the connection of whoever holds the old one.
class DebugConsolePage {
+1 -1
View File
@@ -18,7 +18,7 @@
namespace roro {
// Settings → Firmware: the running version and its Probation, where to push Firmware Updates, the
// Settings → System → 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 {
+1 -1
View File
@@ -534,7 +534,7 @@ void GeminiApp::drawLine(Canvas& c, size_t i, int firstRow, int y, int rowsLeft)
for (int r = firstRow; r < static_cast<int>(rows.size()) && r - firstRow < rowsLeft; r++) {
int ry = y + (r - firstRow) * theme::kLineHeight;
if (isSelected) c.fillRect(0, ry, theme::kWidth - 3, theme::kLineHeight, theme::kSelection);
c.setTextColor(isSelected ? theme::kText : st.color);
c.setTextColor(isSelected ? theme::kOnAccent : st.color);
std::string text = rows[r];
if (g.type == LineType::Preformatted) text = hscroll_ < static_cast<int>(text.size()) ? text.substr(hscroll_) : "";
c.drawString(text.c_str(), kMargin, ry + 1);
+389 -21
View File
@@ -2,14 +2,19 @@
#include "gnss_app.h"
#include <Arduino.h>
#include <M5Unified.h>
#include <SD.h>
#include <algorithm>
#include <cmath>
#include <cstdio>
#include "geo_format.h"
#include "track.h"
#include "ui/canvas.h"
#include "ui/fonts.h"
#include "ui/theme.h"
#include "ui/widgets.h"
namespace roro {
@@ -17,14 +22,14 @@ using namespace gnss;
namespace {
// One colour per constellation, readable in the 8-bit frame buffer.
// One colour per constellation, from the theme: readable on its background.
uint16_t colorOf(Constellation c) {
switch (c) {
case Constellation::Gps: return theme::kAccent;
case Constellation::Glonass: return 0xF8C8; // red
case Constellation::Galileo: return theme::kMessage;
case Constellation::BeiDou: return 0xFEA0; // yellow
case Constellation::Qzss: return 0xC99F; // violet
case Constellation::Glonass: return theme::kRed;
case Constellation::Galileo: return theme::kGood;
case Constellation::BeiDou: return theme::kYellow;
case Constellation::Qzss: return theme::kViolet;
default: return theme::kText;
}
}
@@ -39,27 +44,201 @@ std::string duration(uint32_t ms) {
return buf;
}
// How the IMU sits in the device, checked by hand (issue #16): which way the sensor's x and y run on the
// screen, for the level's bubble, which goes to the side that is higher.
constexpr float kLevelX = 1.0f, kLevelY = -1.0f;
constexpr uint32_t kImuEveryMs = 10;
constexpr uint32_t kCompassFrameMs = 50;
constexpr uint32_t kSayMs = 4000;
} // namespace
void GnssApp::onEnter() {
mode_ = Mode::View;
dialog_.reset();
heading_.forget(); // the turns made while the App was closed were not followed
imuUs_ = 0;
courseSecond_ = -1;
requestRedraw();
}
void GnssApp::say(const std::string& text) {
refusal_ = text;
refusalMs_ = millis();
requestRedraw();
}
bool GnssApp::onKey(const KeyEvent& e) {
requestRedraw();
if (mode_ != Mode::View) return placesKey(e);
if (e.key == Key::Tab) {
sky_ = !sky_;
requestRedraw();
view_ = view_ == View::Position ? View::Sky : view_ == View::Sky ? View::Compass : View::Position;
if (view_ == View::Compass) loadPlaces();
return true;
}
if (e.key == Key::Char && (e.ch == 'r' || e.ch == 'R')) { // record a Track, or stop it
if (gnss_.tracking()) gnss_.stopTrack();
else {
refusal_ = gnss_.startTrack(millis());
refusalMs_ = millis();
}
requestRedraw();
else say(gnss_.startTrack(millis()));
return true;
}
if (view_ == View::Compass && gnss_.on()) return compassKey(e);
return false; // Back leaves the App
}
bool GnssApp::compassKey(const KeyEvent& e) {
if (e.key != Key::Char) return false;
switch (e.ch) {
case 'm': case 'M': mark(); return true;
case 's': case 'S': aimAtSun(); return true;
case 't': case 'T':
loadPlaces();
list_.setCount(static_cast<int>(places_.size()) + 1);
list_.select(target_ + 1);
mode_ = Mode::Places;
return true;
default: return false;
}
}
bool GnssApp::placesKey(const KeyEvent& e) {
if (dialog_) { // remove this Place?
dialog_->onKey(e);
int result = dialog_->result();
if (result == DialogModel::kPending) return true;
dialog_.reset();
int at = list_.selected() - 1;
if (result == 1 && at >= 0 && at < static_cast<int>(places_.size())) {
places_.erase(places_.begin() + at);
if (target_ == at) target_ = -1;
else if (target_ > at) target_--;
savePlaces();
list_.setCount(static_cast<int>(places_.size()) + 1);
}
return true;
}
if (mode_ == Mode::Name) {
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: mode_ = Mode::View; break;
case Key::Select: {
const GnssState& s = gnss_.state();
mode_ = Mode::View;
if (!s.positionValid) {
say("The Fix was lost");
break;
}
std::string name = name_.text();
if (name.empty()) name = "Place " + std::to_string(places_.size() + 1);
places_.push_back({name, s.latitude, s.longitude});
target_ = static_cast<int>(places_.size()) - 1;
savePlaces();
say("Marked");
break;
}
default: break;
}
return true;
}
switch (e.key) {
case Key::Up: list_.up(); break;
case Key::Down: list_.down(); break;
case Key::Back: mode_ = Mode::View; break;
case Key::Select:
target_ = list_.selected() - 1;
mode_ = Mode::View;
break;
case Key::Delete:
if (list_.selected() > 0) dialog_.reset(new DialogModel({"Cancel", "Remove"}));
break;
case Key::Char:
if ((e.ch == 'd' || e.ch == 'D') && list_.selected() > 0) dialog_.reset(new DialogModel({"Cancel", "Remove"}));
break;
default: break;
}
return true;
}
void GnssApp::mark() {
loadPlaces();
if (!gnss_.state().positionValid) return say("No Fix yet");
if (!storage_.state().present) return say("No SD card");
if (places_.size() >= kMaxPlaces) return say("Too many places");
name_.setText("");
mode_ = Mode::Name;
}
void GnssApp::aimAtSun() {
const GnssState& s = gnss_.state();
if (!s.positionValid || !s.timeValid) return say("No Fix yet");
SunPosition sun = sunPosition(s.utcSeconds(), s.latitude, s.longitude);
if (sun.elevationDeg < 0) return say("The sun is down");
heading_.sun(sun.azimuthDeg);
say("North from the sun");
}
// The Places are few and the file is small: read whole once, written whole at each change.
void GnssApp::loadPlaces() {
if (placesLoaded_ || !storage_.state().present) return;
std::string text;
bool ran = storage_.runAndWait([&]() {
File f = SD.open(kPlacesPath, FILE_READ);
if (!f) return;
size_t size = std::min<size_t>(f.size(), 16 * 1024);
text.resize(size);
text.resize(f.read(reinterpret_cast<uint8_t*>(&text[0]), size));
f.close();
});
if (!ran) return;
places_ = parsePlaces(text);
placesLoaded_ = true;
target_ = -1;
}
void GnssApp::savePlaces() {
std::string text = placesGpx(places_);
storage_.runJob([text]() {
if (!SD.exists("/gnss")) SD.mkdir("/gnss");
File f = SD.open(kPlacesPath, FILE_WRITE);
if (!f) return;
f.write(reinterpret_cast<const uint8_t*>(text.data()), text.size());
f.close();
});
}
void GnssApp::readImu() {
if (!M5.Imu.update()) return;
auto data = M5.Imu.getImuData();
uint32_t us = micros();
float dt = imuUs_ ? (us - imuUs_) / 1e6f : 0;
imuUs_ = us;
if (dt > 0.2f) dt = 0; // the loop was held up: a turn that long ago is not known
const float gyro[3] = {data.gyro.x, data.gyro.y, data.gyro.z};
const float accel[3] = {data.accel.x, data.accel.y, data.accel.z};
heading_.motion(gyro, accel, dt);
}
void GnssApp::update(uint32_t nowMs) {
// The heading is followed in every view, so the Compass is right when Tab comes back to it.
if (nowMs - imuMs_ >= kImuEveryMs) {
imuMs_ = nowMs;
readImu();
}
const GnssState& s = gnss_.state();
if (gnss_.on() && s.timeValid && s.second != courseSecond_) { // a new report from the receiver
courseSecond_ = s.second;
if (s.positionValid && s.courseValid) heading_.course(s.courseDeg, s.speedKmh);
}
if (view_ == View::Compass && mode_ == Mode::View && nowMs - lastDrawMs_ >= kCompassFrameMs) {
bool turned = heading_.known() && std::fabs(angleDiff(heading_.heading(), shownHeading_)) >= 1.0f;
bool tilted = std::fabs(heading_.tiltX() - shownTiltX_) > 0.01f || std::fabs(heading_.tiltY() - shownTiltY_) > 0.01f;
if (turned || tilted) {
lastDrawMs_ = nowMs;
requestRedraw();
}
}
if (nowMs - lastDrawMs_ >= 1000) { // the receiver reports once a second
lastDrawMs_ = nowMs;
requestRedraw();
@@ -76,17 +255,32 @@ void GnssApp::draw(Canvas& c) {
c.drawString(held ? "GNSS is paused" : "GNSS is off", 4, area.y + 4);
c.setFont(&fonts::body);
c.setTextColor(theme::kMuted);
c.drawString(held ? "The LoRa radio is listening, and" : "Settings > GNSS turns it on.", 4, area.y + 22);
c.drawString(held ? "The LoRa radio is listening, and" : "On: Settings > GNSS and radio > GNSS", 4, area.y + 22);
if (held) c.drawString("Settings pauses GNSS for it.", 4, area.y + 22 + theme::kLineHeight);
return;
}
sky_ ? drawSky(c) : drawPosition(c);
if (mode_ != Mode::View) return drawPlaces(c);
switch (view_) {
case View::Position: drawPosition(c); break;
case View::Sky: drawSky(c); break;
case View::Compass: drawCompass(c); break;
}
}
void GnssApp::help(std::vector<KeyHelp>& out) const {
if (dialog_) return keys::add(out, keys::kDialog);
if (mode_ == Mode::Name) return keys::add(out, keys::kText);
if (mode_ == Mode::Places) return keys::add(out, keys::kGnssPlaces);
if (view_ == View::Compass) return keys::add(out, keys::kGnssCompass);
keys::add(out, keys::kGnss);
}
const char* GnssApp::helpTitle() const {
if (mode_ == Mode::Name) return "GNSS: a new place";
if (mode_ == Mode::Places) return "GNSS: the places";
return view_ == View::Compass ? "GNSS: the compass" : nullptr;
}
void GnssApp::drawPosition(Canvas& c) {
const auto& area = theme::kContent;
const GnssState& s = gnss_.state();
@@ -96,7 +290,7 @@ void GnssApp::drawPosition(Canvas& c) {
char line[64];
c.setFont(&fonts::bold);
c.setTextColor(s.fix == FixType::None ? theme::kWarning : theme::kMessage);
c.setTextColor(s.fix == FixType::None ? theme::kWarning : theme::kGood);
if (!gnss_.receiving(now)) std::snprintf(line, sizeof line, "No data from the receiver");
else if (s.fix == FixType::None)
std::snprintf(line, sizeof line, "Searching: %u in view, %s", (unsigned)s.satellites.size(),
@@ -141,7 +335,7 @@ void GnssApp::drawPosition(Canvas& c) {
c.setTextColor(theme::kWarning);
std::snprintf(line, sizeof line, "REC %d point%s, %s", gnss_.trackPoints(),
gnss_.trackPoints() == 1 ? "" : "s", duration(now - gnss_.trackStartMs()).c_str());
} else if (!refusal_.empty() && now - refusalMs_ < 4000) {
} else if (!refusal_.empty() && now - refusalMs_ < kSayMs) {
c.setTextColor(theme::kWarning);
std::snprintf(line, sizeof line, "%s", refusal_.c_str());
} else line[0] = 0;
@@ -155,10 +349,10 @@ void GnssApp::drawSky(Canvas& c) {
// The sky from above: horizon, 30° and 60° elevation rings, north up.
c.drawCircle(cx, cy, radius, theme::kMuted);
c.drawCircle(cx, cy, radius * 2 / 3, 0x4208);
c.drawCircle(cx, cy, radius / 3, 0x4208);
c.drawFastHLine(cx - radius, cy, 2 * radius, 0x4208);
c.drawFastVLine(cx, cy - radius, 2 * radius, 0x4208);
c.drawCircle(cx, cy, radius * 2 / 3, theme::kFaint);
c.drawCircle(cx, cy, radius / 3, theme::kFaint);
c.drawFastHLine(cx - radius, cy, 2 * radius, theme::kFaint);
c.drawFastVLine(cx, cy - radius, 2 * radius, theme::kFaint);
c.setFont(&fonts::small);
c.setTextColor(theme::kMuted);
c.setTextDatum(middle_center);
@@ -201,11 +395,185 @@ void GnssApp::drawSky(Canvas& c) {
c.drawString("No satellites", x, y);
y += theme::kLineHeight;
}
c.setTextColor(s.fix == FixType::None ? theme::kWarning : theme::kMessage);
c.setTextColor(s.fix == FixType::None ? theme::kWarning : theme::kGood);
c.drawString(fixLabel(s.fix), x, y + 4);
c.setFont(&fonts::small);
c.setTextColor(theme::kMuted);
c.drawString("filled: in use", x, area.y + area.h - 20);
}
void GnssApp::drawCompass(Canvas& c) {
const auto& area = theme::kContent;
const GnssState& s = gnss_.state();
const int radius = 54, cx = 4 + radius + 2, cy = area.y + area.h / 2 + 2;
bool known = heading_.known();
float heading = known ? heading_.heading() : 0; // north up until north is known
shownHeading_ = heading;
shownTiltX_ = heading_.tiltX();
shownTiltY_ = heading_.tiltY();
// A point of the rose: `bearing` from north, `r` from the centre. The top of the screen is
// where the top of the device points.
auto at = [&](float bearing, float r, int& x, int& y) {
float a = (bearing - heading) * static_cast<float>(M_PI) / 180.0f;
x = cx + static_cast<int>(std::lround(r * std::sin(a)));
y = cy - static_cast<int>(std::lround(r * std::cos(a)));
};
c.drawCircle(cx, cy, radius, known ? theme::kMuted : theme::kFaint);
for (int b = 0; b < 360; b += 10) {
int x0, y0, x1, y1;
bool major = b % 30 == 0;
at(b, radius - (major ? 6 : 3), x0, y0);
at(b, radius - 1, x1, y1);
c.drawLine(x0, y0, x1, y1, major && known ? theme::kMuted : theme::kFaint);
}
if (known) { // the needle: its bright half to the north
int nx, ny, sx, sy, lx, ly, rx, ry;
at(0, radius - 24, nx, ny);
at(180, radius - 24, sx, sy);
at(90, 5, rx, ry);
at(270, 5, lx, ly);
c.fillTriangle(sx, sy, lx, ly, rx, ry, theme::kFaint);
c.fillTriangle(nx, ny, lx, ly, rx, ry, theme::kRed);
}
c.setTextDatum(middle_center);
static const char* const kLetters[4] = {"N", "E", "S", "W"};
for (int i = 0; i < 4; i++) {
int x, y;
at(i * 90.0f, radius - 14, x, y);
c.setFont(i == 0 ? &fonts::bold : &fonts::body);
c.setTextColor(!known ? theme::kFaint : i == 0 ? theme::kRed : theme::kText);
c.drawString(kLetters[i], x, y);
}
bool placed = s.positionValid;
if (known && placed && s.timeValid) { // the sun, where it is now: something to check north against
SunPosition sun = sunPosition(s.utcSeconds(), s.latitude, s.longitude);
if (sun.elevationDeg > 0) {
int x, y;
at(sun.azimuthDeg, radius - 4, x, y);
c.fillCircle(x, y, 3, theme::kYellow);
}
}
const Place* target = target_ >= 0 && target_ < static_cast<int>(places_.size()) ? &places_[static_cast<size_t>(target_)] : nullptr;
double bearing = 0, distance = 0;
if (target && placed) {
bearing = bearingDegrees(s.latitude, s.longitude, target->latitude, target->longitude);
distance = distanceMeters(s.latitude, s.longitude, target->latitude, target->longitude);
if (known) { // an arrowhead on the rim, the way to go
int tx, ty, ax, ay, bx, by;
at(static_cast<float>(bearing), radius + 1, tx, ty);
at(static_cast<float>(bearing) - 7, radius - 12, ax, ay);
at(static_cast<float>(bearing) + 7, radius - 12, bx, by);
c.fillTriangle(tx, ty, ax, ay, bx, by, theme::kAccent);
}
}
// The mark the rose is read against: the top of the device.
c.fillTriangle(cx, cy - radius + 2, cx - 4, cy - radius - 5, cx + 4, cy - radius - 5, theme::kText);
// The readouts, to the right.
const int x = cx + radius + 10;
char line[48];
c.setTextDatum(top_left);
c.setFont(&fonts::large);
c.setTextColor(known ? theme::kText : theme::kMuted);
if (known) std::snprintf(line, sizeof line, "%03d\xC2\xB0 %s", static_cast<int>(std::lround(heading)) % 360, cardinal(heading));
else std::snprintf(line, sizeof line, "---\xC2\xB0");
c.drawString(line, x, area.y + 3);
c.setFont(&fonts::small);
c.setTextColor(theme::kMuted);
if (!known) {
c.drawString("North is not known:", x, area.y + 22);
c.drawString("walk, or aim at the", x, area.y + 31);
c.drawString("sun and press s", x, area.y + 40);
} else {
const char* from = heading_.source() == HeadingFilter::Source::Sun ? "the sun" : "the course";
int held = static_cast<int>(heading_.heldSeconds());
if (held < 3) std::snprintf(line, sizeof line, "from %s", from);
else if (held < 120) std::snprintf(line, sizeof line, "%s, %d s ago", from, held);
else std::snprintf(line, sizeof line, "%s, %d min ago", from, held / 60);
// The gyroscope drifts: after a few minutes without north, say it is a guess.
c.setTextColor(held >= 180 ? theme::kWarning : theme::kMuted);
c.drawString(line, x, area.y + 22);
c.setTextColor(theme::kMuted);
if (placed) {
std::snprintf(line, sizeof line, "%.1f km/h", s.speedKmh);
c.drawString(line, x, area.y + 31);
}
}
c.setFont(&fonts::bold);
int y = area.y + 54;
if (target) {
c.setTextColor(theme::kAccent);
c.drawString(target->name.c_str(), x, y);
c.setFont(&fonts::body);
c.setTextColor(theme::kText);
if (placed) {
std::snprintf(line, sizeof line, "%s %03d\xC2\xB0", formatDistance(distance).c_str(), static_cast<int>(std::lround(bearing)) % 360);
c.drawString(line, x, y + theme::kLineHeight);
} else c.drawString("No Fix", x, y + theme::kLineHeight);
} else {
c.setFont(&fonts::small);
c.setTextColor(theme::kMuted);
c.drawString("No target: t", x, y);
c.drawString("m marks this place", x, y + 9);
}
// The level: the bubble goes to the higher side, and is in the middle when the device is flat.
const int lr = 17, bubble = 5, lx = x + lr, ly = area.y + area.h - lr - 3;
float bx = kLevelX * heading_.tiltX(), by = kLevelY * heading_.tiltY();
bool flat = std::sqrt(bx * bx + by * by) < 0.035f; // within 2 degrees
const float kFull = 0.26f; // 15 degrees puts the bubble at the edge
float reach = std::sqrt(bx * bx + by * by) / kFull;
if (reach > 1.0f) {
bx /= reach;
by /= reach;
}
c.drawCircle(lx, ly, lr, theme::kMuted);
c.drawCircle(lx, ly, bubble + 2, theme::kFaint);
const float travel = lr - bubble - 1;
c.fillCircle(lx + static_cast<int>(std::lround(bx / kFull * travel)), ly + static_cast<int>(std::lround(by / kFull * travel)), bubble,
flat ? theme::kGood : theme::kText);
c.setFont(&fonts::small);
if (!refusal_.empty() && millis() - refusalMs_ < kSayMs) {
c.setTextColor(theme::kWarning);
c.drawString(refusal_.c_str(), lx + lr + 5, ly - 3);
} else {
c.setTextColor(theme::kMuted);
c.drawString(flat ? "flat" : "tilted", lx + lr + 5, ly - 3);
}
}
void GnssApp::drawPlaces(Canvas& c) {
const auto& area = theme::kContent;
const GnssState& s = gnss_.state();
c.setFont(&fonts::bold);
c.setTextColor(theme::kText);
if (mode_ == Mode::Name) {
c.drawString("A name for this place", 4, area.y + 4);
widgets::lineEditor(c, name_, {4, area.y + 24, area.w - 8, 0});
c.setFont(&fonts::body);
c.setTextColor(theme::kMuted);
c.drawString("The Compass will lead back to it.", 4, area.y + 46);
c.drawString("Left empty, it gets a number.", 4, area.y + 46 + theme::kLineHeight);
return;
}
c.drawString("Where to?", 4, area.y + 2);
theme::Rect rows{0, area.y + 18, area.w, list_.visibleRows() * theme::kLineHeight};
widgets::list(
c, list_, rows,
[&](int i) { return i == 0 ? std::string("No target") : places_[static_cast<size_t>(i - 1)].name; },
[&](int i) {
if (i == 0 || !s.positionValid) return std::string();
const Place& p = places_[static_cast<size_t>(i - 1)];
return formatDistance(distanceMeters(s.latitude, s.longitude, p.latitude, p.longitude));
});
c.setFont(&fonts::small);
c.setTextColor(theme::kMuted);
c.drawString(places_.empty() ? "No place yet: m in the compass marks one" : "Enter: go there d: remove it", 4, area.y + area.h - 9);
if (dialog_ && list_.selected() > 0) widgets::dialog(c, "Remove this place?", places_[static_cast<size_t>(list_.selected() - 1)].name, *dialog_);
}
} // namespace roro
+46 -6
View File
@@ -1,34 +1,74 @@
#pragma once
#include <memory>
#include <string>
#include <vector>
#include "app.h"
#include "compass.h"
#include "dialog_model.h"
#include "line_editor.h"
#include "list_model.h"
#include "places.h"
#include "services/gnss_service.h"
#include "services/storage_service.h"
#include "settings.h"
namespace roro {
// GNSS (see docs/milestones/M2.md, Q59): the Position view, and the Sky view with every satellite
// in view placed by direction and elevation. Tab switches between them.
// GNSS (see docs/milestones/M2.md, Q59): the Position view, the Sky view with every satellite in
// view placed by direction and elevation, and the Compass (issue #16, docs/milestones/H1.md): a
// rose that turns with the device, and the way to a Place the user marked. Tab goes round them.
class GnssApp : public App {
public:
GnssApp(GnssService& gnss, const Settings& settings) : gnss_(gnss), settings_(settings) {}
void onEnter() override { requestRedraw(); }
GnssApp(GnssService& gnss, const Settings& settings, StorageService& storage)
: gnss_(gnss), settings_(settings), storage_(storage) {}
void onEnter() override;
bool onKey(const KeyEvent& e) override;
bool textEntryActive() const override { return mode_ == Mode::Name; }
void update(uint32_t nowMs) override;
void draw(Canvas& c) override;
void help(std::vector<KeyHelp>& out) const override;
const char* helpTitle() const override;
bool badge() const override { return gnss_.tracking(); }
private:
enum class View { Position, Sky, Compass };
// Over the Compass: the list of Places, and the name of a new one.
enum class Mode { View, Places, Name };
void drawPosition(Canvas& c);
void drawSky(Canvas& c);
void drawCompass(Canvas& c);
void drawPlaces(Canvas& c);
bool compassKey(const KeyEvent& e);
bool placesKey(const KeyEvent& e);
void readImu();
void loadPlaces();
void savePlaces();
void mark();
void aimAtSun();
void say(const std::string& text);
GnssService& gnss_;
const Settings& settings_;
bool sky_ = false;
StorageService& storage_;
View view_ = View::Position;
Mode mode_ = Mode::View;
uint32_t lastDrawMs_ = 0;
std::string refusal_; // why a Track couldn't start, shown for a few seconds
std::string refusal_; // why something couldn't be done, or that it was: shown for a few seconds
uint32_t refusalMs_ = 0;
gnss::HeadingFilter heading_;
uint32_t imuUs_ = 0, imuMs_ = 0;
int courseSecond_ = -1; // the Fix whose course was last given to the filter
float shownHeading_ = -1, shownTiltX_ = 0, shownTiltY_ = 0;
std::vector<gnss::Place> places_;
bool placesLoaded_ = false;
int target_ = -1; // in places_; -1: none
ListModel list_{6};
LineEditor name_{gnss::kPlaceNameBytes};
std::unique_ptr<DialogModel> dialog_;
};
} // namespace roro
+1
View File
@@ -26,6 +26,7 @@ class IrcApp : public App {
void draw(Canvas& c) override;
void help(std::vector<KeyHelp>& out) const override;
const char* helpTitle() const override;
bool badge() const override { return irc_.totalUnread() > 0; }
private:
enum class Page { Chat, Settings };
+89 -5
View File
@@ -1,27 +1,111 @@
#include "launcher_app.h"
#include "ui/fonts.h"
#include "ui/icons.h"
#include "ui/widgets.h"
namespace roro {
void LauncherApp::onEnter() { list_.setCount(static_cast<int>(manager_->visibleApps().size())); }
void LauncherApp::onEnter() {
int count = static_cast<int>(manager_->visibleApps().size());
list_.setCount(count);
grid_.setCount(count);
badges_ = badges();
}
bool LauncherApp::onKey(const KeyEvent& e) {
bool list = asList();
switch (e.key) {
case Key::Up: list_.up(); break;
case Key::Down: list_.down(); break;
case Key::Up: list ? list_.up() : grid_.up(); break;
case Key::Down: list ? list_.down() : grid_.down(); break;
case Key::Left:
if (list) return false;
grid_.left();
break;
case Key::Right:
if (list) return false;
grid_.right();
break;
case Key::Select:
if (list_.selected() >= 0) manager_->open(manager_->visibleApps()[list_.selected()]->id);
return true;
default: return false;
}
// The view that didn't move follows.
if (list) grid_.select(list_.selected());
else list_.select(grid_.selected());
requestRedraw();
return true;
}
void LauncherApp::draw(Canvas& c) {
uint32_t LauncherApp::badges() const {
uint32_t bits = 0;
auto apps = manager_->visibleApps();
widgets::list(c, list_, theme::kContent, [&](int i) { return std::string(apps[i]->title); });
for (size_t i = 0; i < apps.size() && i < 32; ++i)
if (apps[i]->app->badge()) bits |= 1u << i;
return bits;
}
void LauncherApp::update(uint32_t) {
uint32_t now = badges();
if (now == badges_) return;
badges_ = now;
requestRedraw();
}
void LauncherApp::draw(Canvas& c) {
if (!asList()) return drawGrid(c);
auto apps = manager_->visibleApps();
widgets::list(c, list_, theme::kContent, [&](int i) { return std::string(apps[i]->title); },
[&](int i) { return std::string(badges_ & (1u << i) ? "*" : ""); });
}
void LauncherApp::drawGrid(Canvas& c) {
using namespace theme;
auto apps = manager_->visibleApps();
int selected = grid_.selected();
for (int row = 0; row < kRows; ++row) {
for (int col = 0; col < kCols; ++col) {
int i = (grid_.firstVisibleRow() + row) * kCols + col;
if (i >= static_cast<int>(apps.size())) break;
int x = kContent.x + col * kTileW, y = kContent.y + row * kTileH;
int ix = x + (kTileW - icons::kSize) / 2, iy = y + (kTileH - icons::kSize) / 2;
// As on the website: cyan on black, and the chosen one on a cyan tile with notched corners,
// in the Status Bar's slate.
uint16_t ink = i == selected ? kFaint : kAccent;
if (i == selected) {
int tx = ix - 6, tw = icons::kSize + 12;
c.fillRect(tx + 4, y, tw - 8, kTileH, kAccent);
c.fillRect(tx + 2, y + 2, tw - 4, kTileH - 4, kAccent);
c.fillRect(tx, y + 4, tw, kTileH - 8, kAccent);
}
if (apps[i]->icon) {
c.drawBitmap(ix, iy, apps[i]->icon, icons::kSize, icons::kSize, ink);
} else { // an App without a picture: its first letter, framed
c.drawRect(ix + 2, iy + 2, icons::kSize - 4, icons::kSize - 4, ink);
c.setFont(&fonts::large);
c.setTextColor(ink);
c.setTextDatum(middle_center);
c.drawString(std::string(1, apps[i]->title[0]).c_str(), ix + icons::kSize / 2, iy + icons::kSize / 2);
}
if (badges_ & (1u << i)) { // a square dot on the icon's corner, with a margin to stand out from it
c.fillRect(ix + icons::kSize - 6, iy - 1, 10, 10, i == selected ? kAccent : kBackground);
c.fillRect(ix + icons::kSize - 4, iy + 1, 6, 6, kWarning);
}
}
}
// More rows than fit: where these are among them.
if (grid_.rows() > kRows) {
int h = kRows * kTileH, barH = h * kRows / grid_.rows();
c.fillRect(kContent.x + kContent.w - 2, kContent.y + (h - barH) * grid_.firstVisibleRow() / (grid_.rows() - kRows), 2, barH, kMuted);
}
if (selected >= 0) {
c.setFont(&fonts::bold);
c.setTextColor(kText);
c.setTextDatum(top_center);
c.drawString(apps[selected]->title, kContent.x + kContent.w / 2, kContent.y + kRows * kTileH + 1);
}
c.setTextDatum(top_left);
}
} // namespace roro
+18 -1
View File
@@ -3,23 +3,40 @@
#include "app.h"
#include "app_keys.h"
#include "app_manager.h"
#include "grid_model.h"
#include "list_model.h"
#include "settings.h"
#include "ui/theme.h"
namespace roro {
// Home screen: lists the visible Apps; Select opens one.
// Home screen: the visible Apps as a grid of icons, with the selected one's name under it, or as
// a list of names (Settings > Display > Launcher). Select opens one. An App with something going on has a
// dot on its tile (App::badge, issue #9).
class LauncherApp : public App {
public:
void setManager(AppManager& manager) { manager_ = &manager; }
void setSettings(const Settings& settings) { settings_ = &settings; }
void onEnter() override;
bool onKey(const KeyEvent& e) override;
void update(uint32_t nowMs) override;
void draw(Canvas& c) override;
void help(std::vector<KeyHelp>& out) const override { keys::add(out, keys::kLauncher); }
private:
static constexpr int kCols = 4, kRows = 3;
static constexpr int kTileW = theme::kWidth / kCols, kTileH = 36;
bool asList() const { return settings_ && settings_->getBool(Setting::LauncherList); }
uint32_t badges() const; // one bit a visible App
void drawGrid(Canvas& c);
AppManager* manager_ = nullptr;
const Settings* settings_ = nullptr;
// One selection, kept in both: the view can change in the Settings.
ListModel list_{theme::kContent.h / theme::kLineHeight};
GridModel grid_{kCols, kRows};
uint32_t badges_ = 0;
};
} // namespace roro
+1 -1
View File
@@ -327,7 +327,7 @@ void LoraScannerApp::drawSweep(Canvas& c) {
uint32_t hz = radio_.config().frequencyHz;
if (hz >= f.fromHz && hz <= f.fromHz + (f.steps - 1) * f.stepHz) {
int x = x0 + static_cast<int>((hz - f.fromHz) / f.stepHz) * cell + cell / 2;
for (int y = barTop; y < barBottom; y += 3) c.drawPixel(x, y, theme::kMessage);
for (int y = barTop; y < barBottom; y += 3) c.drawPixel(x, y, theme::kGood);
}
// The waterfall.
+1
View File
@@ -28,6 +28,7 @@ class LoraScannerApp : public App {
void draw(Canvas& c) override;
void help(std::vector<KeyHelp>& out) const override;
const char* helpTitle() const override;
bool badge() const override { return capture_.capturing(); }
private:
enum class View { Packets, Details, Presets, Sweep };
+27 -4
View File
@@ -15,7 +15,9 @@ using Row = SettingsMenu::Row;
void SettingsApp::onEnter() {
page_ = Page::Menu;
menu_.close();
list_.setCount(menu_.count());
list_.select(0);
}
void SettingsApp::warn(const std::string& text) {
@@ -56,7 +58,12 @@ bool SettingsApp::onMenuKey(const KeyEvent& e) {
if (menu_.kind(i) == Kind::Toggle) menu_.toggle(i);
return true;
case Key::Select: break;
default: return false; // Back leaves Settings
case Key::Back:
if (!menu_.close()) return false; // from the groups, Back leaves Settings
list_.setCount(menu_.count());
list_.select(menu_.groupIndex());
return true;
default: return false;
}
editingRow_ = i;
switch (menu_.kind(i)) {
@@ -72,6 +79,11 @@ bool SettingsApp::onMenuKey(const KeyEvent& e) {
break;
case Kind::Toggle: menu_.toggle(i); break;
case Kind::Slider: break;
case Kind::Group:
menu_.open(i);
list_.setCount(menu_.count());
list_.select(0);
break;
case Kind::Page:
switch (menu_.row(i)) {
case Row::Wifi:
@@ -194,16 +206,27 @@ std::vector<std::string> SettingsApp::aboutLines() const {
void SettingsApp::draw(Canvas& c) {
const auto& area = theme::kContent;
switch (page_) {
case Page::Menu:
case Page::Menu: {
// An open group has its name on a line of its own, over its rows.
theme::Rect rows = area;
if (menu_.inGroup()) {
c.setFont(&fonts::bold);
c.setTextDatum(top_left);
c.setTextColor(theme::kMuted);
c.drawString(menu_.title().c_str(), 4, area.y + 1);
rows.y += theme::kLineHeight;
rows.h -= theme::kLineHeight;
}
widgets::list(
c, list_, area, [this](int i) { return menu_.label(i); },
c, list_, rows, [this](int i) { return menu_.label(i); },
[this](int i) {
auto kind = menu_.kind(i);
if (kind == Kind::Page) return std::string(">");
if (kind == Kind::Page || kind == Kind::Group) return std::string(">");
if (kind == Kind::Slider) return "< " + menu_.value(i) + " >";
return menu_.value(i);
});
break;
}
case Page::Text:
c.setFont(&fonts::body);
c.setTextColor(theme::kMuted);
+1 -1
View File
@@ -35,7 +35,7 @@ struct SettingsAppDeps {
VpnService& vpn;
};
// Settings: every user-facing setting, plus the Wi-Fi, Firmware, Debug Console and About pages.
// Settings: every user-facing setting, in groups, plus the Wi-Fi, VPN, Firmware, Debug Console and About pages.
class SettingsApp : public App {
public:
explicit SettingsApp(const SettingsAppDeps& deps)
+4 -2
View File
@@ -311,7 +311,9 @@ bool SshApp::onKey(const KeyEvent& e) {
}
void SshApp::update(uint32_t nowMs) {
if (!message_.empty() && nowMs - messageMs_ >= kMessageMs) {
// nowMs was read before this pass handled its keys: a message a key just set is "later" than it,
// and an unsigned difference would call that 49 days old, and clear it at once.
if (!message_.empty() && static_cast<int32_t>(nowMs - messageMs_) >= static_cast<int32_t>(kMessageMs)) {
message_.clear();
requestRedraw();
}
@@ -422,7 +424,7 @@ void SshApp::drawTerminal(Canvas& c) {
c.setFont(&fonts::small);
c.setTextDatum(top_right);
c.fillRect(area.x + area.w - 5 * static_cast<int>(where.size()) - 3, area.y, 5 * static_cast<int>(where.size()) + 3, 9, theme::kAccent);
c.setTextColor(0x0000);
c.setTextColor(theme::kOnAccent);
c.drawString(where.c_str(), area.x + area.w - 1, area.y + 1);
c.setTextDatum(top_left);
}
+1
View File
@@ -28,6 +28,7 @@ class SshApp : public App {
bool textEntryActive() const override { return view_ == View::Entry || (view_ == View::Session && !dialog_); }
void help(std::vector<KeyHelp>& out) const override;
const char* helpTitle() const override;
bool badge() const override { return ssh_.active(); }
void update(uint32_t nowMs) override;
void draw(Canvas& c) override;
+4 -4
View File
@@ -232,7 +232,7 @@ void SystemApp::drawOverview(Canvas& c) {
const auto& h = loadHistory_[core];
for (size_t i = 1; i < h.size(); i++) {
int x0 = gx + 1 + static_cast<int>((i - 1) * gw / kHistory), x1 = gx + 1 + static_cast<int>(i * gw / kHistory);
c.drawLine(x0, gy + gh - h.at(i - 1) * gh / 100, x1, gy + gh - h.at(i) * gh / 100, core ? theme::kMessage : theme::kAccent);
c.drawLine(x0, gy + gh - h.at(i - 1) * gh / 100, x1, gy + gh - h.at(i) * gh / 100, core ? theme::kGood : theme::kAccent);
}
}
}
@@ -290,7 +290,7 @@ void SystemApp::drawMemory(Canvas& c) {
struct {
size_t bytes;
uint16_t color;
} floors[] = {{GeminiService::kStartFloor, theme::kMuted}, {GeminiService::kSteadyFloor, theme::kWarning}, {GeminiService::kTransientFloor, theme::kMessage}};
} floors[] = {{GeminiService::kStartFloor, theme::kMuted}, {GeminiService::kSteadyFloor, theme::kWarning}, {GeminiService::kTransientFloor, theme::kGood}};
for (auto& f : floors) {
int kb = static_cast<int>(f.bytes / 1024), y = yOf(kb);
for (int x = gx + 1; x < gx + gw - 1; x += 4) c.drawPixel(x, y, f.color);
@@ -335,13 +335,13 @@ void SystemApp::drawNetwork(Canvas& c) {
for (size_t i = 0; i < kUsers; i++) {
bool active = rateIn_[i] || rateOut_[i];
c.setTextDatum(top_left);
c.setTextColor(active ? theme::kMessage : theme::kText);
c.setTextColor(active ? theme::kGood : theme::kText);
c.drawString(net::userName(static_cast<net::User>(i)), 4, y);
c.setTextDatum(top_right);
c.setTextColor(theme::kText);
c.drawString(net::formatTraffic(traffic_[i].in).c_str(), 124, y);
c.drawString(net::formatTraffic(traffic_[i].out).c_str(), 168, y);
c.setTextColor(active ? theme::kMessage : theme::kMuted);
c.setTextColor(active ? theme::kGood : theme::kMuted);
c.drawString(active ? net::formatTraffic(rateIn_[i] + rateOut_[i]).c_str() : "-", area.w - 4, y);
y += theme::kLineHeight;
}
+1 -1
View File
@@ -16,7 +16,7 @@
namespace roro {
// Settings > VPN (issue #8): the switch, "Start with Wi-Fi", importing a `.conf` from the card
// Settings > Network > VPN (issue #8): the switch, "Start with Wi-Fi", importing a `.conf` from the card
// and forgetting it, and what the tunnel is doing. No key is ever on this page.
class VpnPage {
public:
+1 -1
View File
@@ -17,7 +17,7 @@
namespace roro {
// Settings → Wi-Fi: the On/Off switch, the connection and its details, DNS and NTP servers, and
// Settings → Network → Wi-Fi: the On/Off switch, the connection and its details, DNS and NTP servers, and
// the Saved Networks: adding one from a scan or by name (hidden), and each one's own page with its
// IP setting, Automatic or Fixed (docs/milestones/S1.md, Q113). Owned by the Settings App.
class WifiSettingsPage {
+3 -3
View File
@@ -232,9 +232,9 @@ void WifiToolsApp::drawChannels(Canvas& c) {
for (int ch = 1; ch <= 13; ch++) {
int x = x0 + (ch - 1) * slot;
int h = static_cast<int>(load[ch] / maxLoad * barMaxH);
uint16_t color = ch == best ? theme::kMessage : (ch == 1 || ch == 6 || ch == 11) ? theme::kAccent : theme::kMuted;
uint16_t color = ch == best ? theme::kGood : (ch == 1 || ch == 6 || ch == 11) ? theme::kAccent : theme::kMuted;
if (h > 0) c.fillRect(x, baseY - h, slot - 4, h, color);
c.setTextColor(ch == best ? theme::kMessage : theme::kText);
c.setTextColor(ch == best ? theme::kGood : theme::kText);
c.setTextDatum(top_center);
c.drawString(std::to_string(ch).c_str(), x + (slot - 4) / 2, baseY + 3);
c.setTextDatum(top_left);
@@ -265,7 +265,7 @@ void WifiToolsApp::drawTracker(Canvas& c) {
int strength = lost ? 0 : std::min(100, std::max(0, (tracker_.latest() + 95) * 100 / 60));
int barW = area.w - 8;
c.drawRect(4, area.y + 60, barW, 8, theme::kMuted);
c.fillRect(5, area.y + 61, (barW - 2) * strength / 100, 6, theme::kMessage);
c.fillRect(5, area.y + 61, (barW - 2) * strength / 100, 6, theme::kGood);
const int gy = area.y + 74, gh = area.h - 76;
const auto& h = tracker_.history();
+47 -18
View File
@@ -62,6 +62,7 @@
#include "safe_mode.h"
#include "settings.h"
#include "storage_paths.h"
#include "ui/icons.h"
#include "ui/notifier.h"
#include "ui/screen.h"
#include "scp_args.h"
@@ -192,6 +193,7 @@ void setup() {
Serial.begin(115200);
settings.load();
theme::apply(ui::palette(settings.getInt(Setting::Theme), settings.getBool(Setting::ThemeLight)));
if (safeMode) return setupSafeMode(crashes);
battery = new BatteryService(bus);
@@ -230,19 +232,20 @@ void setup() {
apps = new AppManager(launcher);
launcher.setManager(*apps);
apps->registerApp({"irc", "IRC", false, new IrcApp(*irc, *clockService, bus)});
apps->registerApp({"wifi-tools", "Wi-Fi Tools", false, new WifiToolsApp(*wifi, *storageService, *clockService)});
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, *power, bus, *new WebShare(*storageService, *fileOps, *wifi))});
apps->registerApp({"notes", "Notes", false, new NotesApp(*fileOps, *storageService, *clockService, *power)});
launcher.setSettings(settings);
apps->registerApp({"irc", "IRC", false, new IrcApp(*irc, *clockService, bus), icons::irc});
apps->registerApp({"wifi-tools", "Wi-Fi Tools", false, new WifiToolsApp(*wifi, *storageService, *clockService), icons::wifi_tools});
apps->registerApp({"gnss", "GNSS", false, new GnssApp(*gnssService, settings, *storageService), icons::gnss});
apps->registerApp({"gemini", "Gemini", false, new GeminiApp(*geminiService), icons::gemini});
apps->registerApp({"lora", "LoRa Scanner", false, new LoraScannerApp(*radioService, *loraCapture, settings, *clockService), icons::lora});
apps->registerApp({"storage", "Storage", false, new StorageApp(*fileOps, *storageService, *clockService, *update, *power, bus, *new WebShare(*storageService, *fileOps, *wifi)), icons::storage});
apps->registerApp({"notes", "Notes", false, new NotesApp(*fileOps, *storageService, *clockService, *power), icons::notes});
sshService = new SshService(settings);
sshApp = new SshApp(*sshService, settings, *storageService);
scpService = new ScpService(settings, *storageService, *fileOps);
apps->registerApp({"ssh", "SSH", false, sshApp});
apps->registerApp({"ssh", "SSH", false, sshApp, icons::ssh});
shellApp = new ShellApp(shellRun, shellProbe, shellList, shellCount, helpText(), *apps);
apps->registerApp({"shell", "Shell", false, shellApp});
apps->registerApp({"shell", "Shell", false, shellApp, icons::shell});
shellApp->asking = [] { return scpService->asking(); };
shellApp->answer = [](const std::string& password) { scpService->answer(password); };
shellApp->abort = [] { scpService->cancel(); };
@@ -252,9 +255,9 @@ void setup() {
// A long note being rewritten (issue #47): the editor waits for the card, so it draws from there.
NoteEditor::onProgress = [](const std::string& name, int percent) { screen.renderUpdate("Saving", name, percent); };
apps->registerApp({"system", "System", false,
new SystemApp(*wifi, *battery, *storageService, *radioService, *gnssService, nvs)});
new SystemApp(*wifi, *battery, *storageService, *radioService, *gnssService, nvs), icons::system});
apps->registerApp({"settings", "Settings", false,
new SettingsApp({settings, bus, *apps, *battery, *storageService, *clockService, *wifi, *savedNetworks, *update, *vpnService})});
new SettingsApp({settings, bus, *apps, *battery, *storageService, *clockService, *wifi, *savedNetworks, *update, *vpnService}), icons::settings});
apps->registerApp({"demo", "Widget demo", true, new DemoApp(bus)});
apps->registerApp({"setup", "Setup", true, new SetupApp(settings, *apps)});
@@ -681,6 +684,7 @@ static const char* const kHelp =
"lora sweep on [from MHz] [to MHz] [step kHz] | lora sweep off | lora sweep dump RSSI across a band (863 870 100)\n"
"lora custom <MHz> <BW kHz> <SF> <CR 5-8> <sync hex> [preamble] e.g. 868.1 125 7 5 34 8 (LoRaWAN)\n"
"gnss quiet on|off pause the GNSS receiver while the LoRa radio listens (it costs the radio 8 dB)\n"
"imu what the motion sensor reads: g on its three axes, then degrees a second\n"
"gnss status | gnss restart | gnss track start|stop | gnss nmea on|off | gnss send <sentence without $ and checksum>\n"
"crash the last crash: firmware, reason, task, backtrace\n"
"coredump erase forget the core dump in flash\n"
@@ -692,7 +696,7 @@ static const char* const kHelp =
"irc start | irc stop | irc dump | irc say <buffer> <text>\n"
"install <path.ota> Update from SD\n"
"update check | update list | update status | update install <tag> the project's releases on Gitea\n"
"sd card | sd list | cat <path> | log <text> | burst | sound on|off | short | normal\n"
"sd card | sd list | cat <path> | log <text> | burst | sound on|off | theme [0-6] [light|dark] | short | normal\n"
"Irc | Wifi | Gnss | Gemini | Lora | Storage | Notes | Shell | System | Settings open that App: a capital letter is an App, not a command\n"
"ping <host> [count] [size] | nslookup <name> [server] | port <host> <port> | traceroute <host> | cancel is it there, does its name resolve, is its port open, which way; one at a time\n"
"tls <host> [port] | ntp [server] a TLS handshake: who the certificate is for, by whom, until when, and whether this device trusts it; a time server's clock against this one\n"
@@ -700,8 +704,8 @@ static const char* const kHelp =
"uname the firmware, its version and the chip it is built for\n"
"scp [-f] [-P port] <file on the card> user@host:path | scp [-f] [-P port] user@host:path <file on the card> one file over SSH, with this device's key or, in the Shell, a password, to a server the SSH App already trusts; -f replaces a file on the card; `cancel` stops it\n"
"ssh user@host[:port] | ssh status | ssh stop a terminal on another machine, in the SSH App; the password is asked there, never here\n"
"vpn status | vpn up [seconds] | vpn down | vpn import [path] | vpn forget | vpn auto on|off the WireGuard tunnel (Settings > VPN); import reads /vpn/wg0.conf; with seconds, it goes down by itself\n"
"debug status | debug off [seconds] the Debug Console over Wi-Fi (Settings > Debug Console); with seconds, it comes back\n"
"vpn status | vpn up [seconds] | vpn down | vpn import [path] | vpn forget | vpn auto on|off the WireGuard tunnel (Settings > Network > VPN); import reads /vpn/wg0.conf; with seconds, it goes down by itself\n"
"debug status | debug off [seconds] the Debug Console over Wi-Fi (Settings > System > Debug Console); with seconds, it comes back\n"
"debug on | debug token <16 to 64 characters> | debug token new (USB serial only) switch it on, set its token\n"
"crash abort|wdt crash on purpose (to test crash reports and Safe Mode)\n"
"wifi ip ... try <seconds> | wifi ip keep a trial IP setting: back to the previous one unless kept\n"
@@ -894,13 +898,13 @@ static void debugCommand(const String& args, bool fromSerial) {
debugResumes = true;
console.printf("debug: off for %lu s\n", (unsigned long)seconds);
} else if (!fromSerial) {
console.println("debug: over USB serial only (or Settings > Debug Console)");
console.println("debug: over USB serial only (or Settings > System > Debug Console)");
} else if (args == "on") {
DebugConsole::switchOn(settings);
console.println("debug: on (the token is in Settings > Debug Console)");
console.println("debug: on (the token is in Settings > System > Debug Console)");
} else if (args == "token new") {
settings.setString(Setting::DebugToken, DebugConsole::freshToken());
console.println("debug: a new token (it is in Settings > Debug Console)");
console.println("debug: a new token (it is in Settings > System > Debug Console)");
} else if (args.startsWith("token ")) {
std::string token = debug::tidyToken(args.substring(6).c_str());
bool ok = debug::validToken(token) && settings.setString(Setting::DebugToken, token);
@@ -1138,10 +1142,18 @@ static void runCommand(String line, bool fromSerial = false) {
if (found) radioService->setPreset(p);
console.printf("lora preset: %s\n", found ? p.name : "unknown (LongFast LongSlow MediumSlow MediumFast ShortSlow ShortFast LongMod MeshCore)");
}
if (line == "gnss quiet on" || line == "gnss quiet off") { // Settings > Pause GNSS for LoRa (issue #20)
if (line == "gnss quiet on" || line == "gnss quiet off") { // Settings > GNSS and radio > Pause GNSS for LoRa (issue #20)
settings.setBool(Setting::GnssQuietForLora, line.endsWith("on"));
console.printf("gnss quiet: %s\n", line.endsWith("on") ? "GNSS pauses while the LoRa radio listens" : "GNSS stays on");
}
if (line == "imu") { // the Compass's sensor (issue #16), as it reads now
if (!M5.Imu.update()) console.println("imu: no reading");
else {
auto d = M5.Imu.getImuData();
console.printf("imu: type %d, accel %.2f %.2f %.2f g, gyro %.1f %.1f %.1f deg/s\n", static_cast<int>(M5.Imu.getType()),
d.accel.x, d.accel.y, d.accel.z, d.gyro.x, d.gyro.y, d.gyro.z);
}
}
if (line == "gnss status" && gnssService) gnssService->printStatus(console, millis());
if ((line == "gnss nmea on" || line == "gnss nmea off") && gnssService) gnssService->setEcho(line.endsWith("on"));
if (line == "gnss restart" && gnssService) gnssService->restart(millis());
@@ -1326,6 +1338,14 @@ static void runCommand(String line, bool fromSerial = false) {
settings.setBool(Setting::DnsAlways, line.endsWith("on"));
wifi->serversChanged();
}
if (line == "theme" || line.startsWith("theme ")) { // theme [0-6] [light|dark]
std::string rest = line.length() > 6 ? line.substring(6).c_str() : "";
if (!rest.empty() && isdigit(static_cast<unsigned char>(rest[0]))) settings.setInt(Setting::Theme, rest[0] - '0');
if (rest.find("light") != std::string::npos) settings.setBool(Setting::ThemeLight, true);
if (rest.find("dark") != std::string::npos) settings.setBool(Setting::ThemeLight, false);
for (int t = 0; t < ui::kThemeCount; ++t)
console.printf("theme: %d %s%s\n", t, ui::themeName(t), t == settings.getInt(Setting::Theme) ? (settings.getBool(Setting::ThemeLight) ? " (light)" : " (dark)") : "");
}
if (line == "sound off") settings.setBool(Setting::Sound, false);
if (line == "sound on") settings.setBool(Setting::Sound, true);
if (line == "short") {
@@ -1565,6 +1585,15 @@ static void loopPass() {
StatusInfo status = currentStatus();
const Toast* toast = notifier->toasts().current(now);
bool toastChanged = notifier->toasts().takeChanged();
// The theme, when the Settings (or the `theme` command) changed it: every colour is drawn again.
static int shownTheme = settings.getInt(Setting::Theme) * 2 + settings.getBool(Setting::ThemeLight);
int wantedTheme = settings.getInt(Setting::Theme) * 2 + settings.getBool(Setting::ThemeLight);
if (wantedTheme != shownTheme) {
shownTheme = wantedTheme;
theme::apply(ui::palette(wantedTheme / 2, wantedTheme % 2));
screen.invalidate();
redrawAfterUpdate = true;
}
if (apps->takeRedraw() || toastChanged || status != lastStatus || redrawAfterUpdate) {
lastStatus = status;
redrawAfterUpdate = false;
+1 -1
View File
@@ -16,7 +16,7 @@ namespace roro {
// The GNSS receiver on the Cap LoRa-1262 (see CONTEXT.md and docs/milestones/M2.md): reads its
// NMEA from the main loop's tick (about 450 bytes/s, so a 512-byte UART buffer covers a second),
// holds the current Fix, and sets the clock from it. Settings → GNSS switches it on and off.
// holds the current Fix, and sets the clock from it. Settings → GNSS and radio → GNSS switches it on and off.
class GnssService : public Service {
public:
static constexpr int kRxPin = 15, kTxPin = 13; // measured: M2 step 1
+1 -1
View File
@@ -284,7 +284,7 @@ void UpdateService::serve() {
if (r == Request::BackgroundCheck && gitea_.latest(latest) &&
release::shouldAnnounce(latest, runningVersion(), failedVersion(), announced_)) {
announced_ = latest.tag;
notify(latest.tag + " is out: see Settings > Firmware", NotificationLevel::Info); // 48 bytes at most
notify(latest.tag + " is out: Settings > System > Firmware", NotificationLevel::Info); // 48 bytes at most
}
break;
}
+391
View File
@@ -0,0 +1,391 @@
// Made by scripts/make_icons.py from assets/icons/*.png: change the pictures, not this file.
#include "icons.h"
namespace roro::icons {
const uint8_t gemini[128] = {
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x3f, 0xff, 0xff, 0xfc, // ..############################..
0x3f, 0xff, 0xff, 0xfc, // ..############################..
0x33, 0x30, 0x00, 0x0c, // ..##..##..##................##..
0x33, 0x30, 0x00, 0x0c, // ..##..##..##................##..
0x30, 0x00, 0x00, 0x0c, // ..##........................##..
0x30, 0x00, 0x00, 0x0c, // ..##........................##..
0x3f, 0xff, 0xff, 0xfc, // ..############################..
0x3f, 0xff, 0xff, 0xfc, // ..############################..
0x30, 0x00, 0x00, 0x0c, // ..##........................##..
0x30, 0x00, 0x00, 0x0c, // ..##........................##..
0x30, 0xc0, 0xc0, 0x0c, // ..##....##......##..........##..
0x30, 0xc0, 0xc0, 0x0c, // ..##....##......##..........##..
0x30, 0x30, 0x30, 0x0c, // ..##......##......##........##..
0x30, 0x30, 0x30, 0x0c, // ..##......##......##........##..
0x30, 0x0c, 0x0c, 0x0c, // ..##........##......##......##..
0x30, 0x0c, 0x0c, 0x0c, // ..##........##......##......##..
0x30, 0x30, 0x30, 0x0c, // ..##......##......##........##..
0x30, 0x30, 0x30, 0x0c, // ..##......##......##........##..
0x30, 0xc0, 0xc0, 0x0c, // ..##....##......##..........##..
0x30, 0xc0, 0xc0, 0x0c, // ..##....##......##..........##..
0x30, 0x00, 0x00, 0x0c, // ..##........................##..
0x30, 0x00, 0x00, 0x0c, // ..##........................##..
0x3f, 0xff, 0xff, 0xfc, // ..############################..
0x3f, 0xff, 0xff, 0xfc, // ..############################..
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
};
const uint8_t gnss[128] = {
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x3f, 0xc0, 0x00, // ..........########..............
0x00, 0x3f, 0xc0, 0x00, // ..........########..............
0x03, 0xc0, 0x0f, 0x00, // ......####..........####........
0x03, 0xc0, 0x0f, 0x00, // ......####..........####........
0x0c, 0x00, 0x0f, 0x30, // ....##..............####..##....
0x0c, 0x00, 0x0f, 0x30, // ....##..............####..##....
0x30, 0x00, 0x00, 0x0c, // ..##........................##..
0x30, 0x00, 0x00, 0x0c, // ..##........................##..
0x30, 0x0f, 0xf0, 0x0c, // ..##........########........##..
0x30, 0x0f, 0xf0, 0x0c, // ..##........########........##..
0x00, 0x30, 0x0c, 0x0c, // ..........##........##......##..
0x00, 0x30, 0x0c, 0x0c, // ..........##........##......##..
0x3c, 0x30, 0x0c, 0x0c, // ..####....##........##......##..
0x3c, 0x30, 0x0c, 0x0c, // ..####....##........##......##..
0x3c, 0x30, 0x0c, 0x0c, // ..####....##........##......##..
0x3c, 0x30, 0x0c, 0x0c, // ..####....##........##......##..
0x00, 0x30, 0x0c, 0x0c, // ..........##........##......##..
0x00, 0x30, 0x0c, 0x0c, // ..........##........##......##..
0x30, 0x0f, 0xf0, 0x0c, // ..##........########........##..
0x30, 0x0f, 0xf0, 0x0c, // ..##........########........##..
0x30, 0x00, 0x00, 0x0c, // ..##........................##..
0x30, 0x00, 0x00, 0x0c, // ..##........................##..
0x0c, 0x00, 0x00, 0x30, // ....##....................##....
0x0c, 0x00, 0x00, 0x30, // ....##....................##....
0x03, 0xc0, 0x03, 0xc0, // ......####............####......
0x03, 0xc0, 0x03, 0xc0, // ......####............####......
0x00, 0x3f, 0xfc, 0x00, // ..........############..........
0x00, 0x3f, 0xfc, 0x00, // ..........############..........
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
};
const uint8_t irc[128] = {
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x0f, 0xff, 0xff, 0xf0, // ....########################....
0x0f, 0xff, 0xff, 0xf0, // ....########################....
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x0f, 0xff, 0xff, 0xf0, // ....########################....
0x0f, 0xff, 0xff, 0xf0, // ....########################....
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
};
const uint8_t lora[128] = {
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x0c, 0x00, 0x00, // ............##..................
0x00, 0x0c, 0x00, 0x00, // ............##..................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x0c, 0x00, 0x00, // ............##..................
0x00, 0x0c, 0x00, 0x00, // ............##..................
0x00, 0x0c, 0x0c, 0x00, // ............##......##..........
0x00, 0x0c, 0x0c, 0x00, // ............##......##..........
0x00, 0x0c, 0x00, 0x00, // ............##..................
0x00, 0x0c, 0x00, 0x00, // ............##..................
0x00, 0x0c, 0x0c, 0x00, // ............##......##..........
0x00, 0x0c, 0x0c, 0x00, // ............##......##..........
0x00, 0x0c, 0x0c, 0x00, // ............##......##..........
0x00, 0x0c, 0x0c, 0x00, // ............##......##..........
0x00, 0xcc, 0x0c, 0xc0, // ........##..##......##..##......
0x00, 0xcc, 0x0c, 0xc0, // ........##..##......##..##......
0x00, 0xcc, 0xcc, 0xc0, // ........##..##..##..##..##......
0x00, 0xcc, 0xcc, 0xc0, // ........##..##..##..##..##......
0x0c, 0xcc, 0xcc, 0xc0, // ....##..##..##..##..##..##......
0x0c, 0xcc, 0xcc, 0xc0, // ....##..##..##..##..##..##......
0x0c, 0xcc, 0xcc, 0xc0, // ....##..##..##..##..##..##......
0x0c, 0xcc, 0xcc, 0xc0, // ....##..##..##..##..##..##......
0x0c, 0xcc, 0xcc, 0xc0, // ....##..##..##..##..##..##......
0x0c, 0xcc, 0xcc, 0xc0, // ....##..##..##..##..##..##......
0x3f, 0xff, 0xff, 0xfc, // ..############################..
0x3f, 0xff, 0xff, 0xfc, // ..############################..
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
};
const uint8_t notes[128] = {
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0xc3, 0x0c, 0x00, // ........##....##....##..........
0x00, 0xc3, 0x0c, 0x00, // ........##....##....##..........
0x00, 0xc3, 0x0c, 0x00, // ........##....##....##..........
0x00, 0xc3, 0x0c, 0x00, // ........##....##....##..........
0x0f, 0xff, 0xff, 0xf0, // ....########################....
0x0f, 0xff, 0xff, 0xf0, // ....########################....
0x0c, 0xc3, 0x0c, 0x30, // ....##..##....##....##....##....
0x0c, 0xc3, 0x0c, 0x30, // ....##..##....##....##....##....
0x0c, 0x00, 0x00, 0x30, // ....##....................##....
0x0c, 0x00, 0x00, 0x30, // ....##....................##....
0x0c, 0x00, 0x00, 0x30, // ....##....................##....
0x0c, 0x00, 0x00, 0x30, // ....##....................##....
0x0c, 0xff, 0xff, 0x30, // ....##..################..##....
0x0c, 0xff, 0xff, 0x30, // ....##..################..##....
0x0c, 0x00, 0x00, 0x30, // ....##....................##....
0x0c, 0x00, 0x00, 0x30, // ....##....................##....
0x0c, 0xff, 0xff, 0x30, // ....##..################..##....
0x0c, 0xff, 0xff, 0x30, // ....##..################..##....
0x0c, 0x00, 0x00, 0x30, // ....##....................##....
0x0c, 0x00, 0x00, 0x30, // ....##....................##....
0x0c, 0xff, 0xc0, 0x30, // ....##..##########........##....
0x0c, 0xff, 0xc0, 0x30, // ....##..##########........##....
0x0c, 0x00, 0x00, 0x30, // ....##....................##....
0x0c, 0x00, 0x00, 0x30, // ....##....................##....
0x0c, 0x00, 0x00, 0x30, // ....##....................##....
0x0c, 0x00, 0x00, 0x30, // ....##....................##....
0x0f, 0xff, 0xff, 0xf0, // ....########################....
0x0f, 0xff, 0xff, 0xf0, // ....########################....
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
};
const uint8_t settings[128] = {
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x0f, 0xf0, 0x00, // ............########............
0x00, 0x0f, 0xf0, 0x00, // ............########............
0x03, 0xcc, 0x33, 0xc0, // ......####..##....##..####......
0x03, 0xcc, 0x33, 0xc0, // ......####..##....##..####......
0x0c, 0x30, 0x0c, 0x30, // ....##....##........##....##....
0x0c, 0x30, 0x0c, 0x30, // ....##....##........##....##....
0x0c, 0x00, 0x00, 0x30, // ....##....................##....
0x0c, 0x00, 0x00, 0x30, // ....##....................##....
0x03, 0x0f, 0xf0, 0xc0, // ......##....########....##......
0x03, 0x0f, 0xf0, 0xc0, // ......##....########....##......
0x3c, 0x3c, 0x3c, 0x3c, // ..####....####....####....####..
0x3c, 0x3c, 0x3c, 0x3c, // ..####....####....####....####..
0x30, 0x30, 0x0c, 0x0c, // ..##......##........##......##..
0x30, 0x30, 0x0c, 0x0c, // ..##......##........##......##..
0x30, 0x30, 0x0c, 0x0c, // ..##......##........##......##..
0x30, 0x30, 0x0c, 0x0c, // ..##......##........##......##..
0x3c, 0x3c, 0x3c, 0x3c, // ..####....####....####....####..
0x3c, 0x3c, 0x3c, 0x3c, // ..####....####....####....####..
0x03, 0x0f, 0xf0, 0xc0, // ......##....########....##......
0x03, 0x0f, 0xf0, 0xc0, // ......##....########....##......
0x0c, 0x00, 0x00, 0x30, // ....##....................##....
0x0c, 0x00, 0x00, 0x30, // ....##....................##....
0x0c, 0x30, 0x0c, 0x30, // ....##....##........##....##....
0x0c, 0x30, 0x0c, 0x30, // ....##....##........##....##....
0x03, 0xcc, 0x33, 0xc0, // ......####..##....##..####......
0x03, 0xcc, 0x33, 0xc0, // ......####..##....##..####......
0x00, 0x0f, 0xf0, 0x00, // ............########............
0x00, 0x0f, 0xf0, 0x00, // ............########............
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
};
const uint8_t shell[128] = {
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x3c, 0x00, 0x00, 0x00, // ..####..........................
0x3c, 0x00, 0x00, 0x00, // ..####..........................
0x0f, 0x00, 0x00, 0x00, // ....####........................
0x0f, 0x00, 0x00, 0x00, // ....####........................
0x03, 0xc0, 0x00, 0x00, // ......####......................
0x03, 0xc0, 0x00, 0x00, // ......####......................
0x00, 0xf0, 0x00, 0x00, // ........####....................
0x00, 0xf0, 0x00, 0x00, // ........####....................
0x00, 0x3c, 0x00, 0x00, // ..........####..................
0x00, 0x3c, 0x00, 0x00, // ..........####..................
0x00, 0x0f, 0x00, 0x00, // ............####................
0x00, 0x0f, 0x00, 0x00, // ............####................
0x00, 0x3c, 0x00, 0x00, // ..........####..................
0x00, 0x3c, 0x00, 0x00, // ..........####..................
0x00, 0xf0, 0x00, 0x00, // ........####....................
0x00, 0xf0, 0x00, 0x00, // ........####....................
0x03, 0xc0, 0x00, 0x00, // ......####......................
0x03, 0xc0, 0x00, 0x00, // ......####......................
0x0f, 0x00, 0x00, 0x00, // ....####........................
0x0f, 0x00, 0x00, 0x00, // ....####........................
0x3c, 0x00, 0xff, 0xfc, // ..####..........##############..
0x3c, 0x00, 0xff, 0xfc, // ..####..........##############..
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
};
const uint8_t ssh[128] = {
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x0f, 0xf0, 0x00, 0x00, // ....########....................
0x0f, 0xf0, 0x00, 0x00, // ....########....................
0x30, 0x0c, 0x00, 0x00, // ..##........##..................
0x30, 0x0c, 0x00, 0x00, // ..##........##..................
0xc0, 0x03, 0x00, 0x00, // ##............##................
0xc0, 0x03, 0x00, 0x00, // ##............##................
0xc3, 0xc3, 0xff, 0xff, // ##....####....##################
0xc3, 0xc3, 0xff, 0xff, // ##....####....##################
0xc3, 0xc3, 0x00, 0xcc, // ##....####....##........##..##..
0xc3, 0xc3, 0x00, 0xcc, // ##....####....##........##..##..
0xc0, 0x03, 0x00, 0xcc, // ##............##........##..##..
0xc0, 0x03, 0x00, 0xcc, // ##............##........##..##..
0x30, 0x0c, 0x00, 0x00, // ..##........##..................
0x30, 0x0c, 0x00, 0x00, // ..##........##..................
0x0f, 0xf0, 0x00, 0x00, // ....########....................
0x0f, 0xf0, 0x00, 0x00, // ....########....................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
};
const uint8_t storage[128] = {
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x03, 0xff, 0xf0, 0x00, // ......##############............
0x03, 0xff, 0xf0, 0x00, // ......##############............
0x03, 0x00, 0x0c, 0x00, // ......##............##..........
0x03, 0x00, 0x0c, 0x00, // ......##............##..........
0x03, 0x33, 0x03, 0x00, // ......##..##..##......##........
0x03, 0x33, 0x03, 0x00, // ......##..##..##......##........
0x03, 0x33, 0x00, 0xc0, // ......##..##..##........##......
0x03, 0x33, 0x00, 0xc0, // ......##..##..##........##......
0x03, 0x33, 0x00, 0xc0, // ......##..##..##........##......
0x03, 0x33, 0x00, 0xc0, // ......##..##..##........##......
0x03, 0x33, 0x00, 0xc0, // ......##..##..##........##......
0x03, 0x33, 0x00, 0xc0, // ......##..##..##........##......
0x03, 0x00, 0x00, 0xc0, // ......##................##......
0x03, 0x00, 0x00, 0xc0, // ......##................##......
0x03, 0x00, 0x00, 0xc0, // ......##................##......
0x03, 0x00, 0x00, 0xc0, // ......##................##......
0x03, 0x3f, 0xfc, 0xc0, // ......##..############..##......
0x03, 0x3f, 0xfc, 0xc0, // ......##..############..##......
0x03, 0x30, 0x0c, 0xc0, // ......##..##........##..##......
0x03, 0x30, 0x0c, 0xc0, // ......##..##........##..##......
0x03, 0x30, 0x0c, 0xc0, // ......##..##........##..##......
0x03, 0x30, 0x0c, 0xc0, // ......##..##........##..##......
0x03, 0x3f, 0xfc, 0xc0, // ......##..############..##......
0x03, 0x3f, 0xfc, 0xc0, // ......##..############..##......
0x03, 0x00, 0x00, 0xc0, // ......##................##......
0x03, 0x00, 0x00, 0xc0, // ......##................##......
0x03, 0xff, 0xff, 0xc0, // ......####################......
0x03, 0xff, 0xff, 0xc0, // ......####################......
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
};
const uint8_t system[128] = {
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0xff, 0xff, 0x00, // ........################........
0x00, 0xff, 0xff, 0x00, // ........################........
0x0f, 0xc0, 0x03, 0xf0, // ....######............######....
0x0f, 0xc0, 0x03, 0xf0, // ....######............######....
0x00, 0xcf, 0xf3, 0x00, // ........##..########..##........
0x00, 0xcf, 0xf3, 0x00, // ........##..########..##........
0x00, 0xcf, 0xf3, 0x00, // ........##..########..##........
0x00, 0xcf, 0xf3, 0x00, // ........##..########..##........
0x00, 0xcf, 0xf3, 0x00, // ........##..########..##........
0x00, 0xcf, 0xf3, 0x00, // ........##..########..##........
0x00, 0xcf, 0xf3, 0x00, // ........##..########..##........
0x00, 0xcf, 0xf3, 0x00, // ........##..########..##........
0x0f, 0xc0, 0x03, 0xf0, // ....######............######....
0x0f, 0xc0, 0x03, 0xf0, // ....######............######....
0x00, 0xff, 0xff, 0x00, // ........################........
0x00, 0xff, 0xff, 0x00, // ........################........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
};
const uint8_t wifi_tools[128] = {
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x3f, 0xfc, 0x00, // ..........############..........
0x00, 0x3f, 0xfc, 0x00, // ..........############..........
0x03, 0xc0, 0x03, 0xc0, // ......####............####......
0x03, 0xc0, 0x03, 0xc0, // ......####............####......
0x0c, 0x00, 0x00, 0x30, // ....##....................##....
0x0c, 0x00, 0x00, 0x30, // ....##....................##....
0x30, 0x3f, 0xfc, 0x0c, // ..##......############......##..
0x30, 0x3f, 0xfc, 0x0c, // ..##......############......##..
0x03, 0xc0, 0x03, 0xc0, // ......####............####......
0x03, 0xc0, 0x03, 0xc0, // ......####............####......
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x0f, 0xf0, 0x00, // ............########............
0x00, 0x0f, 0xf0, 0x00, // ............########............
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x30, 0x0c, 0x00, // ..........##........##..........
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x03, 0xc0, 0x00, // ..............####..............
0x00, 0x03, 0xc0, 0x00, // ..............####..............
0x00, 0x03, 0xc0, 0x00, // ..............####..............
0x00, 0x03, 0xc0, 0x00, // ..............####..............
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
0x00, 0x00, 0x00, 0x00, // ................................
};
} // namespace roro::icons
+23
View File
@@ -0,0 +1,23 @@
// Made by scripts/make_icons.py from assets/icons/*.png: change the pictures, not this file.
#pragma once
#include <cstdint>
namespace roro::icons {
// One bit a pixel, the leftmost first, a row after another: what Canvas::drawBitmap takes.
constexpr int kSize = 32;
extern const uint8_t gemini[128]; // gemini.png
extern const uint8_t gnss[128]; // gnss.png
extern const uint8_t irc[128]; // irc.png
extern const uint8_t lora[128]; // lora.png
extern const uint8_t notes[128]; // notes.png
extern const uint8_t settings[128]; // settings.png
extern const uint8_t shell[128]; // shell.png
extern const uint8_t ssh[128]; // ssh.png
extern const uint8_t storage[128]; // storage.png
extern const uint8_t system[128]; // system.png
extern const uint8_t wifi_tools[128]; // wifi-tools.png
} // namespace roro::icons
+2
View File
@@ -14,6 +14,8 @@ class Screen {
// Takes over the screen while a Firmware Update is received or about to restart.
void renderUpdate(const std::string& title, const std::string& detail, int percent);
Canvas& canvas() { return canvas_; }
// The colours changed: an App that keeps what it drew has to draw it all again.
void invalidate() { lost_ = true; }
private:
Canvas canvas_;
+23 -9
View File
@@ -2,17 +2,31 @@
#include <cstdint>
#include "palette.h"
namespace roro::theme {
// RGB565
constexpr uint16_t kBackground = 0x0000;
constexpr uint16_t kText = 0xFFFF;
constexpr uint16_t kMuted = 0x8410; // grey
constexpr uint16_t kAccent = 0x2CBF; // teal-blue
constexpr uint16_t kSelection = 0x1A6F; // darker accent behind selected rows
constexpr uint16_t kBar = 0x2104; // Status Bar background
constexpr uint16_t kWarning = 0xFC60; // orange
constexpr uint16_t kMessage = 0x3666; // green
// The colours every screen draws with: the theme chosen in the Settings (issue #10, lib/ui's
// palette.h), set at boot and whenever it changes. They read as constants, and are references into
// the palette in use, so a draw after apply() is in the new colours.
inline ui::Palette current = ui::palette(0, false);
inline void apply(const ui::Palette& p) { current = p; }
inline const uint16_t& kBackground = current.background;
inline const uint16_t& kText = current.text;
inline const uint16_t& kAccent = current.accent; // what is chosen, what is live
inline const uint16_t& kOnAccent = current.onAccent; // text and pictures on an accent fill
inline const uint16_t& kSelection = current.accent; // behind a selected row, whose text is kOnAccent
inline const uint16_t& kMuted = current.muted;
inline const uint16_t& kFaint = current.faint; // grid lines, what stays behind
inline const uint16_t& kBar = current.bar; // Status Bar background
inline const uint16_t& kBarMuted = current.barMuted; // what is idle, on the bar
inline const uint16_t& kWarning = current.warning;
inline const uint16_t& kMessage = current.message; // someone wrote
inline const uint16_t& kGood = current.good; // a Fix, the best of a set
inline const uint16_t& kRed = current.red; // these three: to tell things apart
inline const uint16_t& kYellow = current.yellow;
inline const uint16_t& kViolet = current.violet;
constexpr int kWidth = 240;
constexpr int kHeight = 135;
+12 -12
View File
@@ -32,43 +32,43 @@ void statusBar(Canvas& c, const StatusInfo& info) {
if (info.unread > 0) right("[" + std::to_string(info.unread) + "]", kMessage);
if (info.batteryPercent >= 0)
right(std::to_string(info.batteryPercent) + "%", info.batteryPercent <= 15 ? kWarning : kText);
if (info.sdPresent) right("SD", info.sdLevel >= 80 ? kWarning : kMuted);
if (info.sdPresent) right("SD", info.sdLevel >= 80 ? kWarning : kBarMuted);
switch (info.wifi) {
case StatusInfo::Wifi::Connected: {
// Three signal bars, then the label.
for (int i = 0; i < 3; i++) {
int h = 2 + 2 * i;
c.fillRect(x - 10 + 4 * i, 9 - h, 3, h, i < info.wifiBars ? kText : kMuted);
c.fillRect(x - 10 + 4 * i, 9 - h, 3, h, i < info.wifiBars ? kText : kBackground);
}
x -= 14;
right("W", kText);
break;
}
case StatusInfo::Wifi::Searching: right("W?", kMuted); break;
case StatusInfo::Wifi::Searching: right("W?", kBarMuted); break;
case StatusInfo::Wifi::Monitoring: right("MON", kAccent); break;
case StatusInfo::Wifi::None: break;
}
switch (info.vpn) { // Q252: there while the tunnel is wanted, bright once the peer has answered
case StatusInfo::Vpn::Trying: right("VPN", kMuted); break;
case StatusInfo::Vpn::Trying: right("VPN", kBarMuted); break;
case StatusInfo::Vpn::Up: right("VPN", kAccent); break;
case StatusInfo::Vpn::Off: break;
}
if (info.ssh) right("SSH", kAccent); // Q260: a session goes on, whatever App is in front
switch (info.debug) { // Q190: there while the console listens, bright with someone connected
case StatusInfo::Debug::On: right("DBG", kMuted); break;
case StatusInfo::Debug::On: right("DBG", kBarMuted); break;
case StatusInfo::Debug::Client: right("DBG", kAccent); break;
case StatusInfo::Debug::Off: break;
}
if (info.tracking) right("REC", kWarning);
if (info.capturing) right("CAP", kWarning);
switch (info.radio) { // Q101: muted while listening, bright for a moment on each packet
case StatusInfo::Radio::Listening: right("L", kMuted); break;
case StatusInfo::Radio::Listening: right("L", kBarMuted); break;
case StatusInfo::Radio::Packet: right("L", kAccent); break;
case StatusInfo::Radio::Sweep: right("SW", kMuted); break; // the Sniffer is paused
case StatusInfo::Radio::Sweep: right("SW", kBarMuted); break; // the Sniffer is paused
case StatusInfo::Radio::None: break;
}
switch (info.gnss) { // Q61: muted while searching, normal with a Fix, the count with a 3D Fix
case StatusInfo::Gnss::Searching: right("G", kMuted); break;
case StatusInfo::Gnss::Searching: right("G", kBarMuted); break;
case StatusInfo::Gnss::TwoD: right("G", kText); break;
case StatusInfo::Gnss::ThreeD: right("G" + std::to_string(info.gnssSatellites), kText); break;
case StatusInfo::Gnss::None: break;
@@ -88,10 +88,10 @@ void list(Canvas& c, const ListModel& model, Rect area, const std::function<std:
int y = area.y + row * kLineHeight;
bool selected = i == model.selected();
if (selected) c.fillRect(area.x, y, area.w - 4, kLineHeight, kSelection);
c.setTextColor(kText);
c.setTextColor(selected ? kOnAccent : kText);
c.drawString(label(i).c_str(), area.x + 4, y + 1);
if (value) {
c.setTextColor(selected ? kText : kMuted);
c.setTextColor(selected ? kOnAccent : kMuted);
c.setTextDatum(top_right);
c.drawString(value(i).c_str(), area.x + area.w - 8, y + 1);
c.setTextDatum(top_left);
@@ -159,7 +159,7 @@ void dialog(Canvas& c, const std::string& title, const std::string& message, con
bool selected = i == model.selected();
if (selected) c.fillRect(x, box.y + box.h - 19, w, 15, kAccent);
else c.drawRect(x, box.y + box.h - 19, w, 15, kMuted);
c.setTextColor(selected ? kBackground : kText);
c.setTextColor(selected ? kOnAccent : kText);
c.drawString(buttons[i].c_str(), x + 6, box.y + box.h - 17);
x -= 6;
}
@@ -174,7 +174,7 @@ void toast(Canvas& c, const Toast& t) {
if (w > kWidth - 8) w = kWidth - 8;
int x = (kWidth - w) / 2, y = kHeight - 22;
c.fillRect(x, y, w, 18, color);
c.setTextColor(kBackground);
c.setTextColor(kOnAccent);
c.setTextDatum(top_left);
c.setClipRect(x + 4, y, w - 8, 18);
c.drawString(t.text.c_str(), x + 8, y + 3);
+194
View File
@@ -0,0 +1,194 @@
#include <unity.h>
#include <cmath>
#include <string>
#include "compass.h"
using namespace roro::gnss;
void setUp() {}
void tearDown() {}
namespace {
const float kFlat[3] = {0, 0, 1};
const float kNoTurn[3] = {0, 0, 0};
// `seconds` of readings at 100 Hz.
void run(HeadingFilter& f, const float gyro[3], const float accel[3], float seconds) {
for (int i = 0; i < static_cast<int>(seconds * 100 + 0.5f); i++) f.motion(gyro, accel, 0.01f);
}
} // namespace
void test_angles_wrap() {
TEST_ASSERT_FLOAT_WITHIN(0.001, 350.0, wrap360(-10.0f));
TEST_ASSERT_FLOAT_WITHIN(0.001, 10.0, wrap360(370.0f));
TEST_ASSERT_FLOAT_WITHIN(0.001, 20.0, angleDiff(10.0f, 350.0f));
TEST_ASSERT_FLOAT_WITHIN(0.001, -20.0, angleDiff(350.0f, 10.0f));
TEST_ASSERT_FLOAT_WITHIN(0.001, -180.0, angleDiff(180.0f, 0.0f));
}
void test_bearing_to_a_point() {
TEST_ASSERT_FLOAT_WITHIN(0.01, 0.0, bearingDegrees(50.0, 4.0, 51.0, 4.0));
TEST_ASSERT_FLOAT_WITHIN(0.01, 180.0, bearingDegrees(50.0, 4.0, 49.0, 4.0));
TEST_ASSERT_FLOAT_WITHIN(0.5, 90.0, bearingDegrees(50.0, 4.0, 50.0, 4.1));
TEST_ASSERT_FLOAT_WITHIN(0.5, 270.0, bearingDegrees(50.0, 4.0, 50.0, 3.9));
// Brussels to Paris: south-south-west.
TEST_ASSERT_FLOAT_WITHIN(1.0, 214.0, bearingDegrees(50.8503, 4.3517, 48.8566, 2.3522));
}
void test_cardinal_points() {
TEST_ASSERT_EQUAL_STRING("N", cardinal(0));
TEST_ASSERT_EQUAL_STRING("N", cardinal(359));
TEST_ASSERT_EQUAL_STRING("NNE", cardinal(22.5f));
TEST_ASSERT_EQUAL_STRING("E", cardinal(90));
TEST_ASSERT_EQUAL_STRING("WSW", cardinal(247));
TEST_ASSERT_EQUAL_STRING("NNW", cardinal(340));
TEST_ASSERT_EQUAL_STRING("N", cardinal(-5));
}
void test_distances_read_well() {
TEST_ASSERT_EQUAL_STRING("0 m", formatDistance(0.2).c_str());
TEST_ASSERT_EQUAL_STRING("340 m", formatDistance(340.4).c_str());
TEST_ASSERT_EQUAL_STRING("1.0 km", formatDistance(999.6).c_str());
TEST_ASSERT_EQUAL_STRING("1.2 km", formatDistance(1234).c_str());
TEST_ASSERT_EQUAL_STRING("12 km", formatDistance(12345).c_str());
}
void test_the_sun_at_an_equinox() {
// 2024-03-20 03:06 UTC, the March equinox: the sun is over the equator. Twelve hours of
// turning later, at 12:07:30 UTC (the equation of time is -7.5 min), it is over Greenwich.
int64_t noon = 1710936450;
SunPosition s = sunPosition(noon, 0.0, 0.0);
TEST_ASSERT_FLOAT_WITHIN(0.3, 90.0, s.elevationDeg);
s = sunPosition(noon, 50.0, 0.0); // from 50° north: due south, 40° up
TEST_ASSERT_FLOAT_WITHIN(0.5, 180.0, s.azimuthDeg);
TEST_ASSERT_FLOAT_WITHIN(0.3, 40.0, s.elevationDeg);
s = sunPosition(noon, -50.0, 0.0); // from 50° south: due north
TEST_ASSERT_TRUE(s.azimuthDeg < 1.0f || s.azimuthDeg > 359.0f);
// Six hours earlier it rises, due east at an equinox, anywhere.
s = sunPosition(noon - 6 * 3600, 50.0, 0.0);
TEST_ASSERT_FLOAT_WITHIN(1.0, 90.0, s.azimuthDeg);
TEST_ASSERT_FLOAT_WITHIN(1.0, 0.0, s.elevationDeg);
s = sunPosition(noon + 6 * 3600, 50.0, 0.0); // and sets due west
TEST_ASSERT_FLOAT_WITHIN(1.0, 270.0, s.azimuthDeg);
}
void test_the_sun_at_a_solstice() {
// 2024-06-20 20:51 UTC: 23.44° north of the equator. At noon in Brussels that day
// (11:44 UTC by the sun) it stands 90 - 50.85 + 23.44 = 62.6° up, in the south.
SunPosition s = sunPosition(1718883840, 50.85, 4.35);
TEST_ASSERT_FLOAT_WITHIN(1.0, 180.0, s.azimuthDeg);
TEST_ASSERT_FLOAT_WITHIN(0.3, 62.6, s.elevationDeg);
// At midnight it is under the horizon, in the north.
s = sunPosition(1718883840 + 12 * 3600, 50.85, 4.35);
TEST_ASSERT_TRUE(s.elevationDeg < 0);
TEST_ASSERT_TRUE(s.azimuthDeg < 3.0f || s.azimuthDeg > 357.0f);
}
void test_no_heading_until_north_is_given() {
HeadingFilter f;
const float turn[3] = {0, 0, 30};
run(f, turn, kFlat, 1);
TEST_ASSERT_FALSE(f.known());
f.course(120, 1.0f); // too slow: the course means nothing
TEST_ASSERT_FALSE(f.known());
f.course(120, 4.0f);
TEST_ASSERT_TRUE(f.known());
TEST_ASSERT_FLOAT_WITHIN(0.01, 120.0, f.heading());
TEST_ASSERT_TRUE(f.source() == HeadingFilter::Source::Course);
}
void test_the_gyroscope_follows_a_turn() {
HeadingFilter f;
f.course(100, 5.0f);
// A positive turn around "up" is anticlockwise from above: the heading goes down.
const float left[3] = {0, 0, 45};
run(f, left, kFlat, 2);
TEST_ASSERT_FLOAT_WITHIN(0.5, 10.0, f.heading());
const float right[3] = {0, 0, -45};
run(f, right, kFlat, 4);
TEST_ASSERT_FLOAT_WITHIN(0.5, 190.0, f.heading());
TEST_ASSERT_FLOAT_WITHIN(0.05, 6.0, f.heldSeconds());
}
void test_only_the_turn_around_the_vertical_counts() {
HeadingFilter f;
f.course(0, 5.0f);
// Held upright, the screen facing the user: "up" is along the sensor's y.
const float upright[3] = {0, 1, 0};
run(f, kNoTurn, upright, 1);
const float roll[3] = {0, 0, 90}; // around the screen's own axis: no change of heading
run(f, roll, upright, 1);
TEST_ASSERT_TRUE(std::fabs(angleDiff(f.heading(), 0)) < 0.5f);
const float yaw[3] = {0, -90, 0}; // around the vertical
run(f, yaw, upright, 1);
TEST_ASSERT_FLOAT_WITHIN(1.0, 90.0, f.heading());
}
void test_the_course_pulls_the_heading_gently() {
HeadingFilter f;
f.course(350, 5.0f);
f.course(10, 5.0f); // through north, the short way
TEST_ASSERT_FLOAT_WITHIN(0.01, 356.0, f.heading());
for (int i = 0; i < 20; i++) f.course(10, 5.0f);
TEST_ASSERT_FLOAT_WITHIN(0.1, 10.0, f.heading());
TEST_ASSERT_FLOAT_WITHIN(0.001, 0.0, f.heldSeconds());
}
void test_the_sun_sets_north() {
HeadingFilter f;
f.sun(203);
TEST_ASSERT_TRUE(f.known());
TEST_ASSERT_TRUE(f.source() == HeadingFilter::Source::Sun);
TEST_ASSERT_FLOAT_WITHIN(0.01, 203.0, f.heading());
f.forget();
TEST_ASSERT_FALSE(f.known());
}
void test_the_gyroscope_offset_is_learnt_at_rest() {
HeadingFilter f;
f.sun(90);
const float offset[3] = {0.3f, -0.2f, 0.8f}; // what a BMI270 reads lying still
run(f, offset, kFlat, 30);
TEST_ASSERT_TRUE(f.still());
float before = f.heading();
run(f, offset, kFlat, 60); // a minute later it has not drifted
TEST_ASSERT_FLOAT_WITHIN(0.2, before, f.heading());
// A real turn is still measured, with the offset taken off.
const float turn[3] = {0.3f, -0.2f, 0.8f - 90.0f};
run(f, turn, kFlat, 1);
TEST_ASSERT_FLOAT_WITHIN(0.5, before + 90.0f, f.heading());
TEST_ASSERT_FALSE(f.still());
}
void test_tilt_follows_the_accelerometer() {
HeadingFilter f;
run(f, kNoTurn, kFlat, 1);
TEST_ASSERT_FLOAT_WITHIN(0.01, 0.0, f.tiltX());
TEST_ASSERT_FLOAT_WITHIN(0.01, 0.0, f.tiltY());
const float tilted[3] = {0.5f, 0, 0.866f}; // 30° over
run(f, kNoTurn, tilted, 2);
TEST_ASSERT_FLOAT_WITHIN(0.01, 0.5, f.tiltX());
const float shaken[3] = {3, 3, 3}; // not gravity: ignored
run(f, kNoTurn, shaken, 1);
TEST_ASSERT_FLOAT_WITHIN(0.01, 0.5, f.tiltX());
}
int main() {
UNITY_BEGIN();
RUN_TEST(test_angles_wrap);
RUN_TEST(test_bearing_to_a_point);
RUN_TEST(test_cardinal_points);
RUN_TEST(test_distances_read_well);
RUN_TEST(test_the_sun_at_an_equinox);
RUN_TEST(test_the_sun_at_a_solstice);
RUN_TEST(test_no_heading_until_north_is_given);
RUN_TEST(test_the_gyroscope_follows_a_turn);
RUN_TEST(test_only_the_turn_around_the_vertical_counts);
RUN_TEST(test_the_course_pulls_the_heading_gently);
RUN_TEST(test_the_sun_sets_north);
RUN_TEST(test_the_gyroscope_offset_is_learnt_at_rest);
RUN_TEST(test_tilt_follows_the_accelerometer);
return UNITY_END();
}
+97
View File
@@ -0,0 +1,97 @@
#include <unity.h>
#include "grid_model.h"
using namespace roro;
void setUp() {}
void tearDown() {}
void test_empty_grid_has_no_selection() {
GridModel g(4, 3);
TEST_ASSERT_EQUAL(-1, g.selected());
g.right();
g.down();
TEST_ASSERT_EQUAL(-1, g.selected());
TEST_ASSERT_EQUAL(0, g.rows());
}
void test_left_and_right_go_through_every_item() {
GridModel g(4, 3);
g.setCount(11);
TEST_ASSERT_EQUAL(0, g.selected());
g.right();
TEST_ASSERT_EQUAL(1, g.selected());
g.select(3);
g.right(); // onto the next row
TEST_ASSERT_EQUAL(4, g.selected());
g.left();
TEST_ASSERT_EQUAL(3, g.selected());
g.select(10);
g.right(); // around
TEST_ASSERT_EQUAL(0, g.selected());
g.left();
TEST_ASSERT_EQUAL(10, g.selected());
}
void test_up_and_down_stay_in_the_column() {
GridModel g(4, 3);
g.setCount(11); // rows of 4, 4 and 3
g.select(1);
g.down();
TEST_ASSERT_EQUAL(5, g.selected());
g.down();
TEST_ASSERT_EQUAL(9, g.selected());
g.down(); // around
TEST_ASSERT_EQUAL(1, g.selected());
g.up();
TEST_ASSERT_EQUAL(9, g.selected());
}
void test_a_short_last_row_gives_its_last_item() {
GridModel g(4, 3);
g.setCount(11);
g.select(7); // the fourth column, which the last row doesn't have
g.down();
TEST_ASSERT_EQUAL(10, g.selected());
g.select(3);
g.up();
TEST_ASSERT_EQUAL(10, g.selected());
}
void test_rows_scroll_to_keep_the_selection_in_view() {
GridModel g(4, 3);
g.setCount(18); // 5 rows
TEST_ASSERT_EQUAL(5, g.rows());
TEST_ASSERT_EQUAL(0, g.firstVisibleRow());
g.select(12); // the fourth row
TEST_ASSERT_EQUAL(1, g.firstVisibleRow());
g.select(17);
TEST_ASSERT_EQUAL(2, g.firstVisibleRow());
g.select(5);
TEST_ASSERT_EQUAL(1, g.firstVisibleRow());
g.select(0);
TEST_ASSERT_EQUAL(0, g.firstVisibleRow());
}
void test_a_smaller_count_keeps_the_selection_inside() {
GridModel g(4, 3);
g.setCount(18);
g.select(17);
g.setCount(6);
TEST_ASSERT_EQUAL(5, g.selected());
TEST_ASSERT_EQUAL(0, g.firstVisibleRow());
g.setCount(0);
TEST_ASSERT_EQUAL(-1, g.selected());
}
int main() {
UNITY_BEGIN();
RUN_TEST(test_empty_grid_has_no_selection);
RUN_TEST(test_left_and_right_go_through_every_item);
RUN_TEST(test_up_and_down_stay_in_the_column);
RUN_TEST(test_a_short_last_row_gives_its_last_item);
RUN_TEST(test_rows_scroll_to_keep_the_selection_in_view);
RUN_TEST(test_a_smaller_count_keeps_the_selection_inside);
return UNITY_END();
}
+101
View File
@@ -0,0 +1,101 @@
#include <unity.h>
#include <cmath>
#include <cstdio>
#include <string>
#include "palette.h"
using namespace roro::ui;
void setUp() {}
void tearDown() {}
namespace {
double channel(uint32_t v) {
double c = v / 255.0;
return c <= 0.03928 ? c / 12.92 : std::pow((c + 0.055) / 1.055, 2.4);
}
double luminance(uint16_t c) {
uint32_t rgb = rgb888(c);
return 0.2126 * channel(rgb >> 16) + 0.7152 * channel((rgb >> 8) & 255) + 0.0722 * channel(rgb & 255);
}
// The WCAG contrast ratio of two colours as the frame buffer shows them: 1 (the same) to 21.
double contrast(uint16_t a, uint16_t b) {
double la = luminance(a), lb = luminance(b);
return (std::fmax(la, lb) + 0.05) / (std::fmin(la, lb) + 0.05);
}
void atLeast(double wanted, uint16_t a, uint16_t b, const char* what, int theme, bool light) {
char msg[96];
std::snprintf(msg, sizeof msg, "%s %s: %s is %.1f, under %.1f", themeName(theme), light ? "light" : "dark", what, contrast(a, b), wanted);
TEST_ASSERT_TRUE_MESSAGE(contrast(a, b) >= wanted, msg);
}
} // namespace
void test_seven_themes_with_names() {
TEST_ASSERT_EQUAL(7, kThemeCount);
TEST_ASSERT_EQUAL_STRING("roro9stack", themeName(0));
for (int t = 0; t < kThemeCount; ++t) TEST_ASSERT_TRUE(std::string(themeName(t)).size() > 0 && std::string(themeName(t)).size() <= 14);
// Out of range: the first, rather than whatever is next in memory.
TEST_ASSERT_EQUAL_STRING("roro9stack", themeName(7));
TEST_ASSERT_EQUAL_STRING("roro9stack", themeName(-1));
TEST_ASSERT_EQUAL_PTR(&palette(0, true), &palette(99, true));
}
// The frame buffer keeps 3 bits of red and green and 2 of blue: a colour it would round is a
// colour that isn't the one shown.
void test_every_colour_is_one_the_frame_buffer_holds() {
for (int t = 0; t < kThemeCount; ++t)
for (int light = 0; light < 2; ++light) {
const Palette& p = palette(t, light);
const uint16_t* c = &p.background;
for (size_t i = 0; i < sizeof(Palette) / sizeof(uint16_t); ++i) {
uint32_t rgb = rgb888(c[i]);
uint16_t back = static_cast<uint16_t>(((rgb >> 19) & 0x1F) << 11 | ((rgb >> 10) & 0x3F) << 5 | ((rgb >> 3) & 0x1F));
TEST_ASSERT_EQUAL_HEX16(back, c[i]);
}
}
}
void test_every_theme_reads() {
for (int t = 0; t < kThemeCount; ++t)
for (int light = 0; light < 2; ++light) {
const Palette& p = palette(t, light);
atLeast(4.5, p.text, p.background, "text", t, light);
atLeast(3, p.muted, p.background, "muted text", t, light);
atLeast(1.3, p.muted, p.text, "muted against text", t, light);
atLeast(3, p.accent, p.background, "the accent", t, light);
atLeast(3, p.onAccent, p.accent, "text on the accent", t, light);
atLeast(4.5, p.text, p.bar, "text on the bar", t, light);
atLeast(2.5, p.barMuted, p.bar, "idle marks on the bar", t, light);
atLeast(2, p.accent, p.bar, "live marks on the bar", t, light);
atLeast(3, p.warning, p.background, "a warning", t, light);
atLeast(3, p.message, p.background, "a message", t, light);
atLeast(3, p.good, p.background, "good", t, light);
atLeast(3, p.onAccent, p.warning, "text on a warning Toast", t, light);
atLeast(3, p.onAccent, p.message, "text on a message Toast", t, light);
atLeast(2, p.faint, p.accent, "the Launcher's selected icon", t, light);
atLeast(1.15, p.faint, p.background, "grid lines", t, light);
atLeast(2.5, p.red, p.background, "red", t, light);
atLeast(2.5, p.yellow, p.background, "yellow", t, light);
atLeast(2.5, p.violet, p.background, "violet", t, light);
}
}
void test_the_first_is_the_websites() {
const Palette& p = palette(0, false);
TEST_ASSERT_EQUAL_HEX32(0x000000, rgb888(p.background));
TEST_ASSERT_EQUAL_HEX32(0x00dbff, rgb888(p.accent));
TEST_ASSERT_EQUAL_HEX32(0x494955, rgb888(p.bar));
TEST_ASSERT_EQUAL_HEX32(0xffffff, rgb888(palette(0, true).background));
}
int main() {
UNITY_BEGIN();
RUN_TEST(test_seven_themes_with_names);
RUN_TEST(test_every_colour_is_one_the_frame_buffer_holds);
RUN_TEST(test_every_theme_reads);
RUN_TEST(test_the_first_is_the_websites);
return UNITY_END();
}
+75
View File
@@ -0,0 +1,75 @@
#include <unity.h>
#include <cmath>
#include <string>
#include "places.h"
using namespace roro::gnss;
void setUp() {}
void tearDown() {}
void test_places_round_trip() {
std::vector<Place> places = {{"Car", 50.8503123, 4.3517456}, {"Tent <A&B>", -33.9, -151.2}};
std::string gpx = placesGpx(places);
TEST_ASSERT_NOT_EQUAL(std::string::npos, gpx.find("<wpt lat=\"50.8503123\" lon=\"4.3517456\"><name>Car</name></wpt>"));
TEST_ASSERT_NOT_EQUAL(std::string::npos, gpx.find("<name>Tent &lt;A&amp;B&gt;</name>"));
TEST_ASSERT_NOT_EQUAL(std::string::npos, gpx.find("</gpx>"));
std::vector<Place> back = parsePlaces(gpx);
TEST_ASSERT_EQUAL(2, back.size());
TEST_ASSERT_EQUAL_STRING("Car", back[0].name.c_str());
TEST_ASSERT_TRUE(std::fabs(back[0].latitude - (50.8503123)) < 1e-7);
TEST_ASSERT_TRUE(std::fabs(back[0].longitude - (4.3517456)) < 1e-7);
TEST_ASSERT_EQUAL_STRING("Tent <A&B>", back[1].name.c_str());
TEST_ASSERT_TRUE(std::fabs(back[1].longitude - (-151.2)) < 1e-7);
}
void test_an_empty_list_is_still_gpx() {
std::string gpx = placesGpx({});
TEST_ASSERT_NOT_EQUAL(std::string::npos, gpx.find("<gpx version=\"1.1\""));
TEST_ASSERT_EQUAL(0, parsePlaces(gpx).size());
TEST_ASSERT_EQUAL(0, parsePlaces("").size());
}
void test_waypoints_from_a_map_program() {
std::string gpx =
"<?xml version='1.0'?>\n<gpx>\n"
" <wpt lon='4.40' lat='51.22'>\n <ele>7</ele>\n <name>Antwerp</name>\n <sym>City</sym>\n </wpt>\n"
" <wpt lat=\"50.0\" lon=\"5.0\"/>\n"
" <wpt lat=\"95.0\" lon=\"5.0\"><name>Nowhere</name></wpt>\n"
" <wpt lat=\"x\" lon=\"5.0\"><name>Broken</name></wpt>\n"
" <wpt lat=\"50.5\" lon=\"5.5\"><desc>no name</desc></wpt>\n"
" <trk><trkseg><trkpt lat=\"1\" lon=\"2\"><name>not a place</name></trkpt></trkseg></trk>\n"
"</gpx>\n";
std::vector<Place> p = parsePlaces(gpx);
TEST_ASSERT_EQUAL(3, p.size());
TEST_ASSERT_EQUAL_STRING("Antwerp", p[0].name.c_str());
TEST_ASSERT_TRUE(std::fabs(p[0].latitude - (51.22)) < 1e-7);
TEST_ASSERT_TRUE(std::fabs(p[0].longitude - (4.40)) < 1e-7);
TEST_ASSERT_EQUAL_STRING("Place 2", p[1].name.c_str());
TEST_ASSERT_EQUAL_STRING("Place 3", p[2].name.c_str());
}
void test_a_cut_file_gives_what_is_whole() {
std::string gpx = placesGpx({{"A", 1, 2}, {"B", 3, 4}});
gpx.resize(gpx.find("<name>B"));
std::vector<Place> p = parsePlaces(gpx);
TEST_ASSERT_EQUAL(1, p.size());
TEST_ASSERT_EQUAL_STRING("A", p[0].name.c_str());
}
void test_no_more_than_the_limit() {
std::vector<Place> many(kMaxPlaces + 10, Place{"P", 1, 2});
TEST_ASSERT_EQUAL(kMaxPlaces, parsePlaces(placesGpx(many)).size());
}
int main() {
UNITY_BEGIN();
RUN_TEST(test_places_round_trip);
RUN_TEST(test_an_empty_list_is_still_gpx);
RUN_TEST(test_waypoints_from_a_map_program);
RUN_TEST(test_a_cut_file_gives_what_is_whole);
RUN_TEST(test_no_more_than_the_limit);
return UNITY_END();
}
+79 -3
View File
@@ -12,10 +12,10 @@ struct Fixture {
Settings settings{store, bus};
SettingsMenu menu{settings};
Fixture() { settings.load(); }
// Opens the group the row is in: the index is into that group.
int row(SettingsMenu::Row r) {
for (int i = 0; i < menu.count(); i++)
if (menu.row(i) == r) return i;
return -1;
int i = -1;
return menu.reveal(r, i) ? i : -1;
}
};
@@ -28,6 +28,53 @@ void test_every_row_has_a_label() {
for (int i = 0; i < f.menu.count(); i++) TEST_ASSERT_FALSE(f.menu.label(i).empty());
}
void test_the_groups_are_listed_first() {
Fixture f;
TEST_ASSERT_FALSE(f.menu.inGroup());
TEST_ASSERT_EQUAL(5, f.menu.count());
for (int i = 0; i < f.menu.count(); i++)
TEST_ASSERT_EQUAL(static_cast<int>(SettingsMenu::Kind::Group), static_cast<int>(f.menu.kind(i)));
TEST_ASSERT_EQUAL_STRING("This device", f.menu.label(0).c_str());
TEST_ASSERT_EQUAL_STRING("Display", f.menu.label(1).c_str());
TEST_ASSERT_FALSE(f.menu.close()); // nothing to close: Back leaves Settings
}
void test_a_group_opens_and_closes() {
Fixture f;
TEST_ASSERT_TRUE(f.menu.open(1));
TEST_ASSERT_TRUE(f.menu.inGroup());
TEST_ASSERT_EQUAL_STRING("Display", f.menu.title().c_str());
TEST_ASSERT_EQUAL(6, f.menu.count());
TEST_ASSERT_EQUAL_STRING("Brightness", f.menu.label(0).c_str());
TEST_ASSERT_EQUAL_STRING("Launcher", f.menu.label(5).c_str());
TEST_ASSERT_FALSE(f.menu.open(0)); // a row of a group isn't a group
TEST_ASSERT_TRUE(f.menu.close());
TEST_ASSERT_EQUAL(1, f.menu.groupIndex()); // where the selection goes back to
TEST_ASSERT_EQUAL(5, f.menu.count());
TEST_ASSERT_FALSE(f.menu.open(5));
}
void test_every_setting_is_in_one_group() {
Fixture f;
int total = 0;
for (int g = 0; g < 5; g++) {
TEST_ASSERT_TRUE(f.menu.open(g));
TEST_ASSERT_TRUE(f.menu.count() > 0 && f.menu.count() <= 8); // a title and 8 rows fit the screen
for (int i = 0; i < f.menu.count(); i++) {
TEST_ASSERT_FALSE(f.menu.label(i).empty());
TEST_ASSERT_NOT_EQUAL(static_cast<int>(SettingsMenu::Kind::Group), static_cast<int>(f.menu.kind(i)));
}
total += f.menu.count();
f.menu.close();
}
TEST_ASSERT_EQUAL(21, total);
int i = -1;
TEST_ASSERT_TRUE(f.menu.reveal(SettingsMenu::Row::Vpn, i));
TEST_ASSERT_EQUAL_STRING("Network", f.menu.title().c_str());
TEST_ASSERT_EQUAL_STRING("VPN", f.menu.label(i).c_str());
TEST_ASSERT_FALSE(f.menu.reveal(SettingsMenu::Row::GroupDisplay, i));
}
void test_values_are_human_readable() {
Fixture f;
TEST_ASSERT_EQUAL_STRING("60%", f.menu.value(f.row(SettingsMenu::Row::Brightness)).c_str());
@@ -46,6 +93,30 @@ void test_toggle_rows_flip_on_select() {
TEST_ASSERT_FALSE(f.settings.getBool(Setting::Sound));
}
void test_the_theme_and_its_side() {
Fixture f;
int theme = f.row(SettingsMenu::Row::Theme), side = f.row(SettingsMenu::Row::ThemeLight);
TEST_ASSERT_EQUAL_STRING("roro9stack", f.menu.value(theme).c_str());
TEST_ASSERT_EQUAL(7, static_cast<int>(f.menu.choices(theme).size()));
TEST_ASSERT_EQUAL(0, f.menu.currentChoice(theme));
TEST_ASSERT_EQUAL_STRING("", f.menu.choose(theme, 2).c_str());
TEST_ASSERT_EQUAL_INT32(2, f.settings.getInt(Setting::Theme));
TEST_ASSERT_EQUAL_STRING("Dracula", f.menu.value(theme).c_str());
TEST_ASSERT_EQUAL_STRING("Dark", f.menu.value(side).c_str());
f.menu.toggle(side);
TEST_ASSERT_TRUE(f.settings.getBool(Setting::ThemeLight));
TEST_ASSERT_EQUAL_STRING("Light", f.menu.value(side).c_str());
}
void test_the_launcher_is_a_grid_or_a_list() {
Fixture f;
int launcher = f.row(SettingsMenu::Row::Launcher);
TEST_ASSERT_EQUAL_STRING("Grid", f.menu.value(launcher).c_str());
f.menu.toggle(launcher);
TEST_ASSERT_TRUE(f.settings.getBool(Setting::LauncherList));
TEST_ASSERT_EQUAL_STRING("List", f.menu.value(launcher).c_str());
}
void test_choice_rows_list_options_and_mark_the_current_one() {
Fixture f;
int tz = f.row(SettingsMenu::Row::Timezone);
@@ -159,8 +230,13 @@ void test_gnss_and_coordinate_rows_toggle() {
int main() {
UNITY_BEGIN();
RUN_TEST(test_every_row_has_a_label);
RUN_TEST(test_the_groups_are_listed_first);
RUN_TEST(test_a_group_opens_and_closes);
RUN_TEST(test_every_setting_is_in_one_group);
RUN_TEST(test_values_are_human_readable);
RUN_TEST(test_toggle_rows_flip_on_select);
RUN_TEST(test_the_launcher_is_a_grid_or_a_list);
RUN_TEST(test_the_theme_and_its_side);
RUN_TEST(test_choice_rows_list_options_and_mark_the_current_one);
RUN_TEST(test_choosing_applies_the_setting);
RUN_TEST(test_choice_that_breaks_a_rule_is_refused_with_a_reason);