Compare commits

...
9 Commits
Author SHA1 Message Date
twislaandClaude Opus 5.5 c4465675a0 S1 plan: the resting loop and the GNSS pause ship in v0.8.1
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 06:42:33 +02:00
twislaandClaude Opus 5.5 70fb37ebb5 The radio's noise: the GNSS receiver costs 8 dB; a setting pauses it (#20)
Debug Builds: `lora noise test` changes one thing at a time, Sweeps the
band, and reports the floor under each condition; it runs on the device
by itself, since one condition pauses Wi-Fi (not saved, so a restart
brings it back). Result, at 125 kHz: -117 dBm with the antenna switched
off, -106 with the GNSS receiver in standby, -98 with it running. The
receiver's serial line isn't it (one sentence a second changes nothing),
and neither are the main loop, the CPU frequency, Wi-Fi, the screen or
the radio's own regulator, all within 1 dB.

Settings > "Pause GNSS for LoRa", off by default: the receiver waits in
standby while the radio listens or sweeps, except during a Track, and
has a Fix again about 7 s after. The GNSS App says it's paused.

11 dB remain between the antenna with GNSS quiet and the chip alone,
untouched by anything that can be switched from the firmware.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 03:41:15 +02:00
twislaandClaude Opus 5.5 06a593293d The main loop rests between passes (#40)
It made 50,000 passes a second and kept core 1 100 % busy at rest. Keys
are buffered by the keyboard controller, the consoles and the radio have
their own tasks, and no Service ticks more often than every 50 ms, so
the loop now rests 5 ms after a pass with the screen on and 20 ms with
it off; never during a serial file transfer. Safe Mode's loop too.

Screen off: 50 passes a second and core 1 at 1 %; screen on: 167 and
10 %. The chip settles 4 C cooler (34.3 against 38.3). GNSS, Gemini, an
upload, the Sweep and the radio's interrupt all checked at the new pace.
`tasks` shows the loop's passes; Debug Builds: `loop spin on|off`.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 03:08:02 +02:00
twislaandClaude Opus 5.5 9078ab9c39 Merge branch 's1': the System App, and traffic counted per service
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 01:32:01 +02:00
twislaandClaude Opus 5.5 06aa3fe28b S1 plan: the System App ships in v0.8.0
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 01:32:01 +02:00
twislaandClaude Opus 5.5 e36aa50922 S1 #11: the System App: tasks, memory, network and system, live
Five views, Tab between them: Overview (each core's load, memory,
traffic, battery, two minutes of load), Tasks (share of a core over the
last second, lowest free stack, flagged under 512 bytes; `s` sorts),
Memory (free heap against the floors of Q86), Network (bytes per
service, and what's moving now), System (what `info` prints, plus
battery, card, radio, GNSS). It samples once a second and keeps history
only while open.

The arithmetic is host-tested, including the trap found on the device: a
task's run-time counter only moves when it's switched out, so the task
that samples (the main loop, alone on its core) gets what's left of its
core. `tasks` now samples across a second of normal running instead of
inside its own wait. The main loop uses 100 % of core 1 at rest (#40).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 01:28:26 +02:00
twislaandClaude Opus 5.5 70bb2a4137 S1 #11: bytes read and written, counted per network service
A Counted<> wrapper around the network clients adds what goes through
their buffer read and write to a per-service counter (IRC, Gemini, Debug
Console, Updates); the single-byte calls and print() end up there, so
each byte counts once. `net` prints the totals. For TLS it's the plain
text the service sees.

Checked on the device: a Gemini fetch counts 164,986 in (a 164,970-byte
page and its 16-byte header) and 42 out (the URL and CRLF).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 01:10:55 +02:00
twislaandClaude Opus 5.5 1df94b684a S1 #11: the System Monitor's design round (Q117-Q127)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 01:04:41 +02:00
twislaandClaude Opus 5.5 00f69e8d53 S1 plan: fixed IPv4 shipped in v0.7.0
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
2026-10-06 00:55:32 +02:00
32 changed files with 1414 additions and 30 deletions
+18 -2
View File
@@ -60,6 +60,18 @@ Each Saved Network gets its address automatically (DHCP) or has a Fixed one (doc
"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. "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.
## System
The System App (docs/milestones/S1.md) shows what the device is doing, live and read-only, in any build. Tab moves between five views:
- **Overview:** each core's load, free memory, network traffic, battery, uptime and chip temperature, and both cores' load over the last two minutes.
- **Tasks:** every FreeRTOS task with its core, its share of a core over the last second, and the least stack it ever had left (in the warning colour under 512 bytes). `s` sorts by share, stack or name.
- **Memory:** free heap, the lowest since boot and the largest free block, with two minutes of free heap drawn against the three memory floors (55, 40 and 20 KB).
- **Network:** the connection, then for IRC, Gemini, the Debug Console and Firmware Updates the bytes read and written since boot and what's moving now. For TLS connections these are the bytes the service sees, without the encryption overhead.
- **System:** what `info` prints, plus the battery, the SD card with its write faults, the radio and the GNSS receiver.
It samples once a second and keeps its history only while it's open.
## Gemini ## Gemini
The Gemini App browses Geminispace (docs/milestones/G1.md): Tab and Shift+Tab pick a link, Enter follows it, Back returns (to where the page was scrolled), Space pages down, `g` types an address. Certificates are trusted on first use; a changed one stops the page and asks. The Gemini App browses Geminispace (docs/milestones/G1.md): Tab and Shift+Tab pick a link, Enter follows it, Back returns (to where the page was scrolled), Space pages down, `g` types an address. Certificates are trusted on first use; a changed one stops the page and asks.
@@ -68,7 +80,7 @@ On a page, `b` bookmarks it, `s` saves it to the SD card to read offline (a non-
## LoRa Scanner ## 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. Enter shows a packet's details: the Meshtastic header (which is never encrypted) and a hex dump. `p` picks one of the 7 Meshtastic presets allowed in EU868 (LongFast by default), `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 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. Enter shows a packet's details: the Meshtastic header (which is never encrypted) and a hex dump. `p` picks one of the 7 Meshtastic presets allowed in EU868 (LongFast by default), `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.
## Development aids ## Development aids
@@ -95,7 +107,8 @@ The LoRa Scanner (docs/milestones/M3.md) listens with the Cap's radio and **neve
| `irc dump` | Prints IRC status, memory, and the last lines of each Buffer | | `irc dump` | Prints IRC status, memory, and the last lines of each Buffer |
| `wifi status` | Prints Wi-Fi state, network, signal, clock and free heap, then the address, gateway, DNS and NTP servers in use and where each came from | | `wifi status` | Prints Wi-Fi state, network, signal, clock and free heap, then the address, gateway, DNS and NTP servers in use and where each came from |
| `info` | Firmware, uptime, last start reason, memory, Wi-Fi, the SD card and its write faults since boot, and both app slots with their versions and OTA states | | `info` | Firmware, uptime, last start reason, memory, Wi-Fi, the SD card and its write faults since boot, and both app slots with their versions and OTA states |
| `tasks` | FreeRTOS tasks: state, priority, lowest free stack, CPU share | | `tasks` | FreeRTOS tasks over the next second: state, priority, lowest free stack, share of a core, each core's load, and how many passes the main loop made |
| `net` | Bytes each network service has read and written since boot |
| `reboot` / `boot other` | Restart, or restart into the other app slot (a manual Rollback) | | `reboot` / `boot other` | Restart, or restart into the other app slot (a manual Rollback) |
| `log level <0-5>` | ESP-IDF log level | | `log level <0-5>` | ESP-IDF log level |
| `ls [folder]` / `rm <path>` | Lists a folder of the SD card, or deletes a file | | `ls [folder]` / `rm <path>` | Lists a folder of the SD card, or deletes a file |
@@ -106,9 +119,12 @@ The LoRa Scanner (docs/milestones/M3.md) listens with the Cap's radio and **neve
| `lora preset <name>` / `lora custom <MHz> <BW kHz> <SF> <CR> <sync hex> [preamble]` | Receive settings: a Meshtastic preset, or anything else (`lora custom 868.1 125 7 5 34 8` for LoRaWAN) | | `lora preset <name>` / `lora custom <MHz> <BW kHz> <SF> <CR> <sync hex> [preamble]` | Receive settings: a Meshtastic preset, or anything else (`lora custom 868.1 125 7 5 34 8` for LoRaWAN) |
| `lora capture start` / `lora capture stop` | A LoRa Capture, as `c` in the App | | `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 | | `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 |
| `lora noise test [gnss\|quiet]` / `lora noise report` | Debug Builds: Sweep under one changed condition at a time to find what raises the noise floor (Wi-Fi goes off for a few seconds); then the result |
| `lora inject <hex> [rssi] [snr]` | Debug Builds: a packet into the Scanner as if received (nothing is sent) | | `lora inject <hex> [rssi] [snr]` | Debug Builds: a packet into the Scanner as if received (nothing is sent) |
| `crash` | The last crash: which firmware, why, task, PC and backtrace (from the core dump in flash) | | `crash` | The last crash: which firmware, why, task, PC and backtrace (from the core dump in flash) |
| `coredump erase` | Forgets the core dump | | `coredump erase` | Forgets the core dump |
| `loop spin on` / `loop spin off` | Debug Builds: make the main loop spin without resting, to compare load and radio noise |
| `crash abort` / `crash wdt` | Debug Builds: crash on purpose, or hang the main loop until the watchdog fires | | `crash abort` / `crash wdt` | Debug Builds: crash on purpose, or hang the main loop until the watchdog fires |
| `help` | Lists the commands | | `help` | Lists the commands |
+78 -1
View File
@@ -1,6 +1,6 @@
# S1 — System basics # S1 — System basics
**Status:** in progress (branch `s1`). The SD driver fix shipped in v0.6.1 (issue #21, ADR 0007). Fixed IPv4 settings (issue #7) are done and checked on the device. The System Monitor (#11) hasn't started. **Status:** the three planned items are done: the SD driver fix in v0.6.1 (issue #21, ADR 0007), fixed IPv4 settings in v0.7.0 (issue #7), the System App in v0.8.0 (issue #11). v0.8.1 adds the resting main loop (issue #40) and the GNSS pause for the radio's noise (issue #20, still open for the 11 dB that remain). Still open in the milestone: #39, following the SD driver upstream.
**Goal:** the device works on any network, the card can be trusted, and you can see what the system is doing. A side milestone, like G1. **Goal:** the device works on any network, the card can be trusted, and you can see what the system is doing. A side milestone, like G1.
@@ -59,3 +59,80 @@ The network is 10.39.39.0/24, gateway 10.39.39.1; DHCP gives 10.39.39.1 as DNS a
3. **Wi-Fi Service:** apply it when joining; DNS and NTP; `wifi status` and the console commands. 3. **Wi-Fi Service:** apply it when joining; DNS and NTP; `wifi status` and the console commands.
4. **Settings:** the network page, the DNS and NTP rows, connection details. 4. **Settings:** the network page, the DNS and NTP rows, connection details.
5. **Tests on the device**, recorded here. 5. **Tests on the device**, recorded here.
## System Monitor (issue #11)
Every milestone so far was driven by measurements, heap floors, stack sizes, TLS dips, that needed a Debug Build and a computer. The System App shows them on the device, in any build.
### Decisions (design round 2026-10-06)
| # | Decision |
|---|---|
| Q117 | An App of its own, **System**, in release builds too. Read-only. |
| Q118 | Four views, switched with Tab: **Overview** (CPU per core, memory, network, battery), **Tasks**, **Memory**, **System**. |
| Q119 | Sampled once a second. A task's share is its run time over the last second; a core's load is 100 % minus its idle task's share. |
| Q120 | **History only while the App is open:** two minutes at one sample a second, about 1 KB. The system already keeps what matters afterwards: the lowest free heap since boot and each task's lowest free stack. |
| Q121 | **Bytes are counted per service:** IRC, Gemini, the Debug Console and Firmware Updates add what they read and write to a shared counter. The network view shows the connection details, each service's bytes in and out, and the signal strength. |
| Q122 | Tasks: name, core, share, state and lowest free stack, sorted by share; `s` cycles the sort (share, stack, name). **Under 512 bytes of stack left shows in the warning colour.** |
| Q123 | Memory: free heap, lowest since boot, largest free block, and a two-minute graph of free heap **with the floors of Q86 drawn as lines** (55, 40 and 20 KB). |
| Q124 | System: uptime and why it last started, firmware and both app slots, chip temperature and CPU frequency, battery voltage and percentage, SD usage and write faults, the radio's and the GNSS receiver's state. |
| Q125 | `info` and `tasks` are split into a **snapshot** that the console and the App share; the arithmetic (shares from two samples, sorting, the stack warning) is host-tested. |
| Q126 | Left out: acting on tasks, an event log, exporting snapshots to the card. |
| Q127 | The main loop uses about 81 % of a core. The App shows it; fixing it is issue #40, not part of #11. |
The App has five views, not four: Q121's network view is one of its own (Overview, Tasks, Memory, Network, System).
### Measured (2026-10-06)
- **Traffic counters are exact.** A Gemini fetch of a 164,970-byte page counts 164,986 bytes in (the page and its 16-byte header line) and 42 out (the 40-character URL and CRLF). A 1,797,760-byte upload counts 1,798,123 in for the Debug Console, commands included.
- **The Memory view shows a TLS dip as it happens.** Starting IRC and a 165 KB Gemini fetch together: free heap falls from about 100 KB through the three floors to a low of 12.1 KB, then settles near 50 KB. That's the dip accepted in G1 (Q86).
- **A run-time counter only moves when its task is switched out.** FreeRTOS adds to a task's run time at the context switch. The main loop takes the samples, and with core 1 to itself it's never switched out: its counter said 2 % while the core's idle task had 0 %. So the task that samples gets what's left of its core. With that: **the main loop uses 100 % of core 1 at rest** (issue #40 said 81 %, an average since boot).
- **`tasks` on the console** sampled twice inside one command at first, a quarter second apart, and showed the loop at 1 %: it was asleep in the command's own wait. It now samples, lets the loop run for a second, and prints.
- **Low stack, flagged:** `IDLE0` (232 bytes left), `IDLE1` (328 to 352) and `spk_task` (256 to 264), all the framework's own tasks.
- **Cost:** 15.6 KB of flash for the App and the counters (1,742,723 bytes, release). Nothing while it's closed; about 2 KB of history and samples while it's open.
## The main loop rests (issue #40)
The loop polled the keyboard, ticked the Services, ran the consoles and redrew when needed, then came straight back: 50,000 passes a second, and core 1 100 % busy with the device idle and the screen off.
Nothing needs that. The keyboard controller buffers key events; the consoles and the radio have their own tasks or interrupts; no Service asks for a tick more often than every 50 ms. So after each pass the loop now rests: **5 ms with the screen on, 20 ms with it off**, and not at all during a serial file transfer (`sd put`), which reads its bytes from the loop. Safe Mode's loop rests 5 ms too. Debug Builds have `loop spin on|off` to bring the old behaviour back for comparison.
### Measured (2026-10-06, Debug Build, Wi-Fi connected, GNSS on, on USB power)
| | Spinning | Resting |
|---|---|---|
| Passes a second, screen off | 50,160 | 50 |
| Core 1 load, screen off | 100 % | 1 % |
| Passes a second, screen on (Launcher) | 1,203 | 167 |
| Core 1 load, screen on | 62 % | 10 % |
| Chip temperature at rest, settled | 38.3 C | 34.3 C |
| A 1.8 MB upload over the Debug Console | about 230 KB/s | 288 KB/s |
- Still working at this pace: GNSS (a 3D Fix, 22 satellites), a Gemini fetch (52 KB), the upload read back by SHA-256, the Sweep (still 606 to 610 ms a pass), the radio's DIO1 interrupt.
- **Not measured:** the current drawn (no meter on the battery line), and how typing feels on the real keyboard: a key now waits up to 5 ms for the loop, 20 ms if it's the one that wakes the screen.
- **The radio's noise floor didn't move** (-97 to -99 dBm at 125 kHz either way): the spinning loop wasn't the source (issue #20).
- **Not done:** real sleep. The framework is built without power management (`CONFIG_PM_ENABLE` is off), so an idle core only halts until the next interrupt. Automatic light sleep would need the framework rebuilt with it, Wi-Fi in modem sleep, and the USB serial port's behaviour checked. A next step if battery life calls for it.
## The radio's noise: the GNSS receiver (issue #20)
M3 found the LoRa radio's noise floor about 15 dB above what the chip hears alone, and that the source travels with the device. Which part? Debug Builds got a self-test, `lora noise test`: it changes one thing at a time, Sweeps the band eight passes (568 readings), records the median as the floor, and puts the thing back. It runs on the device by itself, because one condition switches Wi-Fi off, and `lora noise report` prints the result afterwards.
### Measured (2026-10-06, indoors, on USB power, dBm at 125 kHz)
| Condition | Floor |
|---|---|
| Antenna switched off (the chip alone) | -117 |
| Antenna on, GNSS in standby | -106 |
| Antenna on, GNSS running (as shipped) | -98 |
- **The GNSS receiver, while it runs, raises the floor by 8 dB.** Three runs: -98 or -99 with it running, -106 in standby, every time. On LongFast (250 kHz) the Sniffer's own reading goes from about -93.5 to -101.5 dBm.
- **It's the receiver working, not its serial line:** with one NMEA sentence a second instead of twenty (`PCAS03`), the receiver still tracking, the floor stays at -98.
- **Nothing else moves it by more than 1 dB**, with GNSS running or in standby: the main loop spinning or resting, the CPU at 240, 160 or 80 MHz, Wi-Fi on or off, the screen on or off, the radio chip's regulator as DC-DC or LDO, its receive gain boosted or not.
- **11 dB remain** between the antenna connected with GNSS quiet (-106) and the chip alone (-117). It comes in through the antenna and none of those switches changes it: the surroundings, or parts of the Cardputer that can't be switched off. Not separated: that needs another place, or the antenna on a cable away from the case.
- M3's quick check had GNSS at "1 or 2 dB": it read one frequency for a few seconds, in a noisier spot. The median over the band is the better measure.
### What the firmware does about it
**Settings > Pause GNSS for LoRa**, off by default: while the LoRa radio listens or sweeps, the GNSS receiver waits in standby, and wakes when the radio goes back to sleep (a Fix again after about 7 s here). Never during a Track. The GNSS App says "GNSS is paused" meanwhile. `gnss quiet on|off` on the console.
It's off by default because GNSS on by default was decided in M2 (Q58), and from M4 the radio listens all the time: then "pause while listening" means GNSS mostly off, which is a decision about position, the clock and Tracks, for M4's design round (issue #23).
+4 -1
View File
@@ -20,7 +20,8 @@ const RowDef kRows[] = {
{Row::Region, Kind::Choice, "Region"}, {Row::Timezone, Kind::Choice, "Timezone"}, {Row::Region, Kind::Choice, "Region"}, {Row::Timezone, Kind::Choice, "Timezone"},
{Row::Brightness, Kind::Slider, "Brightness"}, {Row::DimTimeout, Kind::Choice, "Dim after"}, {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::OffTimeout, Kind::Choice, "Screen off after"}, {Row::Sound, Kind::Toggle, "Sound & LED"},
{Row::Gnss, Kind::Toggle, "GNSS"}, {Row::Coordinates, Kind::Toggle, "Coordinates"}, {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::ProbeMacs, Kind::Toggle, "Probe MACs"}, {Row::Wifi, Kind::Page, "Wi-Fi"},
{Row::Storage, Kind::Page, "Storage"}, {Row::Storage, Kind::Page, "Storage"},
{Row::Firmware, Kind::Page, "Firmware"}, {Row::Firmware, Kind::Page, "Firmware"},
@@ -81,6 +82,7 @@ std::string SettingsMenu::value(int i) const {
case Row::OffTimeout: return formatSeconds(settings_.getInt(Setting::OffTimeoutS)); case Row::OffTimeout: return formatSeconds(settings_.getInt(Setting::OffTimeoutS));
case Row::Sound: return settings_.getBool(Setting::Sound) ? "On" : "Off"; case Row::Sound: return settings_.getBool(Setting::Sound) ? "On" : "Off";
case Row::Gnss: return settings_.getBool(Setting::GnssEnabled) ? "On" : "Off"; case Row::Gnss: return settings_.getBool(Setting::GnssEnabled) ? "On" : "Off";
case Row::GnssQuiet: return settings_.getBool(Setting::GnssQuietForLora) ? "On" : "Off";
case Row::Coordinates: return settings_.getBool(Setting::CoordinatesDms) ? "Deg min sec" : "Decimal"; case Row::Coordinates: return settings_.getBool(Setting::CoordinatesDms) ? "Deg min sec" : "Decimal";
case Row::ProbeMacs: return settings_.getBool(Setting::ProbeMacRaw) ? "Raw" : "Pseudonymised"; case Row::ProbeMacs: return settings_.getBool(Setting::ProbeMacRaw) ? "Raw" : "Pseudonymised";
case Row::Wifi: return settings_.getBool(Setting::WifiEnabled) ? "On" : "Off"; case Row::Wifi: return settings_.getBool(Setting::WifiEnabled) ? "On" : "Off";
@@ -126,6 +128,7 @@ std::string SettingsMenu::choose(int i, int c) {
void SettingsMenu::toggle(int i) { void SettingsMenu::toggle(int i) {
if (row(i) == Row::Sound) settings_.setBool(Setting::Sound, !settings_.getBool(Setting::Sound)); 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::Gnss) settings_.setBool(Setting::GnssEnabled, !settings_.getBool(Setting::GnssEnabled));
if (row(i) == Row::GnssQuiet) settings_.setBool(Setting::GnssQuietForLora, !settings_.getBool(Setting::GnssQuietForLora));
if (row(i) == Row::Coordinates) settings_.setBool(Setting::CoordinatesDms, !settings_.getBool(Setting::CoordinatesDms)); if (row(i) == Row::Coordinates) settings_.setBool(Setting::CoordinatesDms, !settings_.getBool(Setting::CoordinatesDms));
if (row(i) == Row::ProbeMacs) settings_.setBool(Setting::ProbeMacRaw, !settings_.getBool(Setting::ProbeMacRaw)); if (row(i) == Row::ProbeMacs) settings_.setBool(Setting::ProbeMacRaw, !settings_.getBool(Setting::ProbeMacRaw));
} }
+1 -1
View File
@@ -11,7 +11,7 @@ namespace roro {
// values, choice lists and validation messages. Rendering and navigation live in the App. // values, choice lists and validation messages. Rendering and navigation live in the App.
class SettingsMenu { class SettingsMenu {
public: public:
enum class Row { LongName, ShortName, Region, Timezone, Brightness, DimTimeout, OffTimeout, Sound, Gnss, Coordinates, ProbeMacs, Wifi, Storage, Firmware, About }; enum class Row { LongName, ShortName, Region, Timezone, Brightness, DimTimeout, OffTimeout, Sound, Gnss, GnssQuiet, Coordinates, ProbeMacs, Wifi, Storage, Firmware, About };
enum class Kind { Text, Choice, Toggle, Slider, Page }; enum class Kind { Text, Choice, Toggle, Slider, Page };
explicit SettingsMenu(Settings& settings) : settings_(settings) {} explicit SettingsMenu(Settings& settings) : settings_(settings) {}
+46
View File
@@ -0,0 +1,46 @@
#include "traffic.h"
#include <atomic>
#include <cstdio>
namespace roro::net {
namespace {
constexpr size_t kUsers = static_cast<size_t>(User::Count);
std::atomic<uint32_t> in_[kUsers], out_[kUsers];
} // namespace
const char* userName(User user) {
switch (user) {
case User::Irc: return "IRC";
case User::Gemini: return "Gemini";
case User::DebugConsole: return "Debug Console";
case User::Updates: return "Updates";
default: return "?";
}
}
void received(User user, size_t bytes) { in_[static_cast<size_t>(user)] += static_cast<uint32_t>(bytes); }
void sent(User user, size_t bytes) { out_[static_cast<size_t>(user)] += static_cast<uint32_t>(bytes); }
Traffic traffic(User user) { return {in_[static_cast<size_t>(user)], out_[static_cast<size_t>(user)]}; }
void resetTraffic() {
for (size_t i = 0; i < kUsers; i++) in_[i] = out_[i] = 0;
}
uint32_t bytesPerSecond(uint32_t before, uint32_t now, uint32_t elapsedMs) {
if (!elapsedMs) return 0;
return static_cast<uint32_t>(static_cast<uint64_t>(now - before) * 1000 / elapsedMs); // wraps with the counter
}
std::string formatTraffic(uint32_t bytes) {
char s[16];
if (bytes < 1000) std::snprintf(s, sizeof s, "%u B", static_cast<unsigned>(bytes));
else if (bytes < 10 * 1024) std::snprintf(s, sizeof s, "%.1f KB", bytes / 1024.0);
else if (bytes < 1000 * 1024) std::snprintf(s, sizeof s, "%u KB", static_cast<unsigned>(bytes / 1024));
else if (bytes < 10u * 1024 * 1024) std::snprintf(s, sizeof s, "%.1f MB", bytes / 1048576.0);
else std::snprintf(s, sizeof s, "%u MB", static_cast<unsigned>(bytes / 1048576));
return s;
}
} // namespace roro::net
+26
View File
@@ -0,0 +1,26 @@
#pragma once
#include <cstddef>
#include <cstdint>
#include <string>
namespace roro::net {
// Bytes each network service has read and written since boot (S1, Q121), as the service sees
// them: for TLS connections that's the plain text, without the handshake or record overhead.
// Counted from the services' own tasks, read from the main loop.
enum class User : uint8_t { Irc, Gemini, DebugConsole, Updates, Count };
const char* userName(User user);
struct Traffic {
uint32_t in = 0, out = 0;
};
void received(User user, size_t bytes);
void sent(User user, size_t bytes);
Traffic traffic(User user);
void resetTraffic(); // for tests
uint32_t bytesPerSecond(uint32_t before, uint32_t now, uint32_t elapsedMs);
std::string formatTraffic(uint32_t bytes); // "999 B", "1.5 KB", "12 KB", "1.7 MB"
} // namespace roro::net
+1
View File
@@ -39,6 +39,7 @@ const Definition kDefinitions[] = {
{"dns_always", Kind::Bool, 0, nullptr, 0, 1}, {"dns_always", Kind::Bool, 0, nullptr, 0, 1},
{"ntp1", Kind::String, 0, "pool.ntp.org", 1, 63}, {"ntp1", Kind::String, 0, "pool.ntp.org", 1, 63},
{"ntp2", Kind::String, 0, "time.cloudflare.com", 0, 63}, {"ntp2", Kind::String, 0, "time.cloudflare.com", 0, 63},
{"gnss_quiet", Kind::Bool, 0, nullptr, 0, 1}, // off: GNSS stays on, as decided in M2 (Q58)
}; };
static_assert(sizeof(kDefinitions) / sizeof(kDefinitions[0]) == static_cast<size_t>(Setting::Count), static_assert(sizeof(kDefinitions) / sizeof(kDefinitions[0]) == static_cast<size_t>(Setting::Count),
"every Setting needs a definition"); "every Setting needs a definition");
+1
View File
@@ -29,6 +29,7 @@ enum class Setting : uint8_t {
DnsAlways, // bool: use them on Automatic (DHCP) networks too, instead of DHCP's DnsAlways, // bool: use them on Automatic (DHCP) networks too, instead of DHCP's
Ntp1, // string: the first NTP server, a host name or an IPv4 address (S1, Q110) Ntp1, // string: the first NTP server, a host name or an IPv4 address (S1, Q110)
Ntp2, // string: the second, or empty Ntp2, // string: the second, or empty
GnssQuietForLora, // bool: put the GNSS receiver in standby while the LoRa radio listens (issue #20)
Count Count
}; };
+72
View File
@@ -0,0 +1,72 @@
#include "task_stats.h"
#include <algorithm>
#include <cctype>
#include <cstring>
namespace roro {
std::vector<TaskRow> taskRows(const std::vector<TaskSample>& before, uint32_t totalBefore,
const std::vector<TaskSample>& now, uint32_t totalNow) {
uint32_t elapsed = totalNow - totalBefore; // unsigned: right across one wrap
std::vector<TaskRow> rows;
rows.reserve(now.size());
for (const TaskSample& t : now) {
uint32_t ran = t.runtime; // a task that wasn't there before ran all of it since
for (const TaskSample& b : before)
if (b.id == t.id) {
ran = t.runtime - b.runtime;
break;
}
TaskRow r;
r.name = t.name;
r.core = t.core;
r.state = t.state;
r.priority = t.priority;
r.stackFree = t.stackFree;
r.permille = elapsed ? static_cast<uint16_t>(std::min<uint64_t>(1000, static_cast<uint64_t>(ran) * 1000 / elapsed)) : 0;
r.lowStack = t.stackFree < kLowStackBytes;
r.idle = std::strncmp(t.name, "IDLE", 4) == 0;
rows.push_back(r);
}
// The task that took the sample is running, and FreeRTOS counts a task's time when it's
// switched out: with its core to itself it never was, and its counter hardly moved. Give it
// what's left of its core once the idle task and the other tasks pinned there are counted.
for (TaskRow& r : rows) {
if (r.state != 0 || r.idle || r.core < 0) continue; // 0: eRunning
int others = 0;
bool idleSeen = false;
for (const TaskRow& o : rows) {
if (&o == &r || o.core != r.core) continue;
others += o.permille;
idleSeen |= o.idle;
}
if (idleSeen && elapsed && 1000 - others > r.permille) r.permille = static_cast<uint16_t>(std::max(0, 1000 - others));
}
return rows;
}
int coreLoad(const std::vector<TaskRow>& rows, int core) {
for (const TaskRow& r : rows)
if (r.idle && r.core == core) return 100 - (r.permille + 5) / 10;
return -1;
}
void sortTasks(std::vector<TaskRow>& rows, TaskSort by) {
auto lower = [](const std::string& s) {
std::string l = s;
for (char& c : l) c = static_cast<char>(std::tolower(static_cast<unsigned char>(c)));
return l;
};
std::stable_sort(rows.begin(), rows.end(), [&](const TaskRow& a, const TaskRow& b) {
switch (by) {
case TaskSort::Share:
if (a.idle != b.idle) return !a.idle; // idle tasks last
return a.permille > b.permille;
case TaskSort::Stack: return a.stackFree < b.stackFree;
default: return lower(a.name) < lower(b.name);
}
});
}
} // namespace roro
+65
View File
@@ -0,0 +1,65 @@
#pragma once
#include <cstddef>
#include <cstdint>
#include <cstdio>
#include <string>
#include <vector>
namespace roro {
// One task as FreeRTOS reports it at one moment.
struct TaskSample {
uint32_t id = 0; // unique per task: a new task with an old name has another
char name[17] = {};
uint32_t runtime = 0; // microseconds on a CPU since it started; 32 bits, so it wraps every 71 minutes
uint16_t stackFree = 0; // the least it ever had left, bytes
int8_t core = -1; // -1: not pinned
uint8_t state = 0; // eTaskState
uint8_t priority = 0;
};
// What the System App and `tasks` show for a task (S1, Q119, Q122).
struct TaskRow {
std::string name;
int core = -1;
uint8_t state = 0, priority = 0;
uint16_t stackFree = 0;
uint16_t permille = 0; // share of one core over the interval, in tenths of a percent
bool lowStack = false;
bool idle = false; // a core's idle task: what's left over
};
constexpr uint16_t kLowStackBytes = 512;
// Shares from two samples: each task's run time between them over the time that passed. The
// 32-bit counters may have wrapped once in between. The task that took the samples (the one
// running) gets what's left of its core: see the .cpp.
std::vector<TaskRow> taskRows(const std::vector<TaskSample>& before, uint32_t totalBefore,
const std::vector<TaskSample>& now, uint32_t totalNow);
// A core's load in percent: what its idle task didn't use. -1 without that task in the rows.
int coreLoad(const std::vector<TaskRow>& rows, int core);
enum class TaskSort : uint8_t { Share, Stack, Name };
void sortTasks(std::vector<TaskRow>& rows, TaskSort by);
// The last N samples, oldest first (Q120).
template <typename T, size_t N>
class History {
public:
void push(T value) {
values_[(first_ + size_) % N] = value;
if (size_ < N) size_++;
else first_ = (first_ + 1) % N;
}
size_t size() const { return size_; }
T at(size_t i) const { return values_[(first_ + i) % N]; } // 0: the oldest kept
void clear() { first_ = size_ = 0; }
private:
T values_[N] = {};
size_t first_ = 0, size_ = 0;
};
} // namespace roro
+4 -2
View File
@@ -71,10 +71,12 @@ void GnssApp::draw(Canvas& c) {
if (!gnss_.on()) { if (!gnss_.on()) {
c.setFont(&fonts::bold); c.setFont(&fonts::bold);
c.setTextColor(theme::kText); c.setTextColor(theme::kText);
c.drawString("GNSS is off", 4, area.y + 4); bool held = gnss_.heldForLora();
c.drawString(held ? "GNSS is paused" : "GNSS is off", 4, area.y + 4);
c.setFont(&fonts::body); c.setFont(&fonts::body);
c.setTextColor(theme::kMuted); c.setTextColor(theme::kMuted);
c.drawString("Settings > GNSS turns it on.", 4, area.y + 22); c.drawString(held ? "The LoRa radio is listening, and" : "Settings > GNSS turns it on.", 4, area.y + 22);
if (held) c.drawString("Settings pauses GNSS for it.", 4, area.y + 22 + theme::kLineHeight);
return; return;
} }
sky_ ? drawSky(c) : drawPosition(c); sky_ ? drawSky(c) : drawPosition(c);
+361
View File
@@ -0,0 +1,361 @@
#include "system_app.h"
#include <Arduino.h>
#include <SD.h>
#include <esp_heap_caps.h>
#include <algorithm>
#include <cstdio>
#include "cleanup_plan.h"
#include "platform/system_info.h"
#include "sd_fault.h"
#include "services/gemini_service.h"
#include "ui/canvas.h"
#include "ui/fonts.h"
#include "ui/theme.h"
#include "ui/widgets.h"
namespace roro {
namespace {
constexpr size_t kUsers = static_cast<size_t>(net::User::Count);
// Collects what the console's `info` prints, so the System view can't drift from it (Q125).
class Lines : public Print {
public:
size_t write(uint8_t ch) override {
if (ch == '\n') {
lines.push_back(current_);
current_.clear();
} else if (ch != '\r') {
current_ += static_cast<char>(ch);
}
return 1;
}
std::vector<std::string> lines;
private:
std::string current_;
};
std::string duration(uint32_t seconds) {
char s[24];
if (seconds < 3600) std::snprintf(s, sizeof s, "%lu min %02lu s", (unsigned long)(seconds / 60), (unsigned long)(seconds % 60));
else std::snprintf(s, sizeof s, "%lu h %02lu min", (unsigned long)(seconds / 3600), (unsigned long)(seconds / 60 % 60));
return s;
}
// A filled bar for a percentage; the warning colour from 90 %.
void bar(Canvas& c, int x, int y, int w, int percent) {
c.drawRect(x, y, w, 9, theme::kMuted);
int filled = std::clamp(percent, 0, 100) * (w - 2) / 100;
if (filled > 0) c.fillRect(x + 1, y + 1, filled, 7, percent >= 90 ? theme::kWarning : theme::kAccent);
}
} // namespace
void SystemApp::onEnter() {
view_ = View::Overview;
beforeTotal_ = system_info::sampleTasks(before_);
sampledMs_ = millis();
for (size_t i = 0; i < kUsers; i++) traffic_[i] = net::traffic(static_cast<net::User>(i));
requestRedraw();
}
void SystemApp::onExit() { // nothing is kept while it's closed (Q120)
std::vector<TaskSample>().swap(before_);
std::vector<TaskRow>().swap(rows_);
std::vector<std::string>().swap(systemLines_);
for (auto& h : loadHistory_) h.clear();
heapHistory_.clear();
load_[0] = load_[1] = -1;
}
bool SystemApp::onKey(const KeyEvent& e) {
if (e.key == Key::Tab) {
int n = static_cast<int>(View::Count), v = static_cast<int>(view_);
view_ = static_cast<View>(e.shift ? (v + n - 1) % n : (v + 1) % n);
taskTop_ = systemTop_ = 0;
requestRedraw();
return true;
}
int step = e.key == Key::Up ? -1 : e.key == Key::Down ? 1 : 0;
if (step && view_ == View::Tasks) {
taskTop_ = std::clamp(taskTop_ + step, 0, std::max(0, static_cast<int>(rows_.size()) - kTaskRows));
requestRedraw();
return true;
}
if (step && view_ == View::System) {
systemTop_ = std::clamp(systemTop_ + step, 0, std::max(0, wrappedLines_ - 8));
requestRedraw();
return true;
}
if (view_ == View::Tasks && e.key == Key::Char && (e.ch == 's' || e.ch == 'S')) { // Q122
sort_ = static_cast<TaskSort>((static_cast<int>(sort_) + 1) % 3);
sortTasks(rows_, sort_);
taskTop_ = 0;
requestRedraw();
return true;
}
return false; // Back leaves the App
}
void SystemApp::update(uint32_t nowMs) {
if (nowMs - sampledMs_ >= 1000) sample(nowMs);
}
// Once a second (Q119): the tasks' shares over that second, the cores' load, the heap, the traffic.
void SystemApp::sample(uint32_t nowMs) {
uint32_t elapsedMs = nowMs - sampledMs_;
sampledMs_ = nowMs;
std::vector<TaskSample> now;
uint32_t total = system_info::sampleTasks(now);
rows_ = taskRows(before_, beforeTotal_, now, total);
sortTasks(rows_, sort_);
before_.swap(now);
beforeTotal_ = total;
for (int core = 0; core < 2; core++) {
load_[core] = coreLoad(rows_, core);
loadHistory_[core].push(static_cast<uint8_t>(std::max(0, load_[core])));
}
heapHistory_.push(static_cast<uint16_t>(ESP.getFreeHeap() / 1024));
for (size_t i = 0; i < kUsers; i++) {
net::Traffic t = net::traffic(static_cast<net::User>(i));
rateIn_[i] = net::bytesPerSecond(traffic_[i].in, t.in, elapsedMs);
rateOut_[i] = net::bytesPerSecond(traffic_[i].out, t.out, elapsedMs);
traffic_[i] = t;
}
if (view_ == View::System) { // the slow things: only while they're on screen
Lines out;
system_info::printSystem(out);
const BatteryEstimator& b = battery_.estimator();
if (b.hasReading()) out.printf("battery: %d %%, %d.%02d V\n", b.percent(), b.millivolts() / 1000, b.millivolts() % 1000 / 10);
StorageState card = storage_.state();
if (card.present)
out.printf("sd: %s of %s used, %u write faults\n", formatBytes(card.usedBytes).c_str(), formatBytes(card.totalBytes).c_str(),
(unsigned)sdLastFault().count);
else out.println("sd: no card");
out.printf("radio: %s\n", !radio_.present() ? "none" : radio_.sweeping() ? "sweeping" : radio_.listening() ? "listening" : "asleep");
const auto& g = gnss_.state();
out.printf("gnss: %s, %d satellites used\n", !gnss_.on() ? "off" : gnss_.receiving(nowMs) ? "receiving" : "silent", g.satellitesUsed);
system_info::printSlots(out, store_);
systemLines_.swap(out.lines);
}
requestRedraw();
}
void SystemApp::footer(Canvas& c, const char* keys) {
const auto& area = theme::kContent;
c.setFont(&fonts::small);
c.setTextColor(theme::kMuted);
c.setTextDatum(top_left);
c.drawString(keys, 4, area.y + area.h - 9);
}
void SystemApp::draw(Canvas& c) {
c.setTextDatum(top_left);
switch (view_) {
case View::Overview: drawOverview(c); break;
case View::Tasks: drawTasks(c); break;
case View::Memory: drawMemory(c); break;
case View::Network: drawNetwork(c); break;
case View::System: drawSystem(c); break;
default: break;
}
}
void SystemApp::drawOverview(Canvas& c) {
const auto& area = theme::kContent;
char line[72];
c.setFont(&fonts::body);
int y = area.y + 2;
for (int core = 0; core < 2; core++) {
c.setTextColor(theme::kMuted);
std::snprintf(line, sizeof line, "Core %d", core);
c.drawString(line, 4, y);
bar(c, 52, y + 2, 130, load_[core]);
c.setTextColor(theme::kText);
if (load_[core] >= 0) std::snprintf(line, sizeof line, "%d%%", load_[core]);
else std::snprintf(line, sizeof line, "...");
c.drawString(line, 190, y);
y += theme::kLineHeight;
}
auto row = [&](const char* label, const std::string& value) {
c.setTextColor(theme::kMuted);
c.drawString(label, 4, y);
c.setTextColor(theme::kText);
c.drawString(value.c_str(), 62, y);
y += theme::kLineHeight;
};
std::snprintf(line, sizeof line, "%u KB free, lowest %u", (unsigned)(ESP.getFreeHeap() / 1024), (unsigned)(ESP.getMinFreeHeap() / 1024));
row("Memory", line);
uint32_t in = 0, out = 0;
for (size_t i = 0; i < kUsers; i++) in += rateIn_[i], out += rateOut_[i];
if (wifi_.state() == WifiController::State::Connected)
std::snprintf(line, sizeof line, "%s/s in, %s/s out", net::formatTraffic(in).c_str(), net::formatTraffic(out).c_str());
else std::snprintf(line, sizeof line, "not connected");
row("Network", line);
const BatteryEstimator& b = battery_.estimator();
if (b.hasReading()) std::snprintf(line, sizeof line, "%d%%, %d.%02d V", b.percent(), b.millivolts() / 1000, b.millivolts() % 1000 / 10);
else std::snprintf(line, sizeof line, "...");
row("Battery", line);
std::snprintf(line, sizeof line, "%s, %.0f C", duration(millis() / 1000).c_str(), temperatureRead());
row("Uptime", line);
// Both cores over the last two minutes: core 0 in the accent colour, core 1 in green.
int gx = 4, gy = y + 3, gw = static_cast<int>(kHistory) * 2 - 8, gh = area.y + area.h - 12 - gy;
if (gh > 8) {
c.drawRect(gx, gy, gw + 2, gh + 2, theme::kMuted);
for (int core = 0; core < 2; core++) {
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);
}
}
}
footer(c, "Tab: tasks, memory, network, system");
}
void SystemApp::drawTasks(Canvas& c) {
const auto& area = theme::kContent;
c.setFont(&fonts::small);
c.setTextColor(theme::kMuted);
c.drawString("task", 4, area.y + 2);
c.setTextDatum(top_right);
c.drawString("core", 128, area.y + 2);
c.drawString("cpu", 176, area.y + 2);
c.drawString("stack left", area.w - 4, area.y + 2);
c.setFont(&fonts::body);
char cell[16];
for (int i = 0; i < kTaskRows && taskTop_ + i < static_cast<int>(rows_.size()); i++) {
const TaskRow& r = rows_[taskTop_ + i];
int y = area.y + 12 + i * theme::kLineHeight;
c.setTextDatum(top_left);
c.setTextColor(r.idle ? theme::kMuted : theme::kText);
c.drawString(r.name.c_str(), 4, y);
c.setTextDatum(top_right);
c.setTextColor(theme::kMuted);
c.drawString(r.core < 0 ? "any" : std::to_string(r.core).c_str(), 128, y);
c.setTextColor(r.idle ? theme::kMuted : theme::kText);
std::snprintf(cell, sizeof cell, "%u.%u%%", r.permille / 10, r.permille % 10);
c.drawString(cell, 176, y);
c.setTextColor(r.lowStack ? theme::kWarning : theme::kMuted); // Q122: under 512 bytes
c.drawString(std::to_string(r.stackFree).c_str(), area.w - 4, y);
}
c.setTextDatum(top_left);
std::string keys = std::string("s: by ") + (sort_ == TaskSort::Share ? "stack" : sort_ == TaskSort::Stack ? "name" : "cpu") +
" " + std::to_string(rows_.size()) + " tasks Tab: memory";
footer(c, keys.c_str());
}
void SystemApp::drawMemory(Canvas& c) {
const auto& area = theme::kContent;
char line[72];
c.setFont(&fonts::body);
c.setTextColor(theme::kText);
std::snprintf(line, sizeof line, "%.1f KB free, lowest %.1f", ESP.getFreeHeap() / 1024.0, ESP.getMinFreeHeap() / 1024.0);
c.drawString(line, 4, area.y + 2);
c.setTextColor(theme::kMuted);
std::snprintf(line, sizeof line, "largest free block %.1f KB", heap_caps_get_largest_free_block(MALLOC_CAP_8BIT) / 1024.0);
c.drawString(line, 4, area.y + 2 + theme::kLineHeight);
// Free heap over two minutes, with the floors of Q86 as lines.
int gx = 26, gy = area.y + 32, gw = area.w - gx - 6, gh = area.y + area.h - 12 - gy;
uint16_t top = 128; // KB at the top of the scale: more if the heap has been higher
for (size_t i = 0; i < heapHistory_.size(); i++) top = std::max<uint16_t>(top, heapHistory_.at(i) + 8);
auto yOf = [&](int kb) { return gy + gh - std::clamp(kb, 0, static_cast<int>(top)) * gh / top; };
c.drawRect(gx, gy, gw, gh + 1, theme::kMuted);
c.setFont(&fonts::small);
struct {
size_t bytes;
uint16_t color;
} floors[] = {{GeminiService::kStartFloor, theme::kMuted}, {GeminiService::kSteadyFloor, theme::kWarning}, {GeminiService::kTransientFloor, theme::kMessage}};
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);
c.setTextColor(f.color);
c.setTextDatum(top_right);
c.drawString(std::to_string(kb).c_str(), gx - 3, y - 3);
}
c.setTextDatum(top_left);
for (size_t i = 1; i < heapHistory_.size(); i++) {
int x0 = gx + 1 + static_cast<int>((i - 1) * (gw - 2) / kHistory), x1 = gx + 1 + static_cast<int>(i * (gw - 2) / kHistory);
c.drawLine(x0, yOf(heapHistory_.at(i - 1)), x1, yOf(heapHistory_.at(i)), theme::kAccent);
}
footer(c, "KB free, 2 min, with the floors Tab: network");
}
void SystemApp::drawNetwork(Canvas& c) {
const auto& area = theme::kContent;
char line[72];
c.setFont(&fonts::body);
WifiService::Connection n = wifi_.connection();
c.setTextColor(n.connected ? theme::kText : theme::kWarning);
if (n.connected) std::snprintf(line, sizeof line, "%s, %d dBm", wifi_.ssid().c_str(), wifi_.rssi());
else std::snprintf(line, sizeof line, "Wi-Fi isn't connected");
c.drawString(line, 4, area.y + 2);
if (n.connected) {
c.setTextColor(theme::kMuted);
std::snprintf(line, sizeof line, "%s/%d %s, gw %s", n.address.c_str(), n.prefix, n.fixed ? "fixed" : "DHCP",
n.gateway.empty() ? "none" : n.gateway.c_str());
c.drawString(line, 4, area.y + 2 + theme::kLineHeight);
}
// Per service (Q121): totals since boot, and the last second.
int y = area.y + 32;
c.setFont(&fonts::small);
c.setTextColor(theme::kMuted);
c.drawString("service", 4, y);
c.setTextDatum(top_right);
c.drawString("in", 124, y);
c.drawString("out", 168, y);
c.drawString("now, /s", area.w - 4, y);
c.setFont(&fonts::body);
y += 10;
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.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.drawString(active ? net::formatTraffic(rateIn_[i] + rateOut_[i]).c_str() : "-", area.w - 4, y);
y += theme::kLineHeight;
}
c.setTextDatum(top_left);
footer(c, "bytes since boot Tab: system");
}
void SystemApp::drawSystem(Canvas& c) {
const auto& area = theme::kContent;
if (systemLines_.empty()) {
c.setFont(&fonts::body);
c.setTextColor(theme::kMuted);
c.drawString("Reading...", 4, area.y + 4);
return;
}
// The console's lines are longer than the screen: wrap them, continuation lines indented.
std::vector<std::string> wrapped;
auto measure = widgets::bodyMeasure(c);
for (const std::string& line : systemLines_) {
bool first = true;
for (const std::string& part : wrapText(line, area.w - 14, measure)) {
wrapped.push_back(first ? part : " " + part);
first = false;
}
}
wrappedLines_ = static_cast<int>(wrapped.size());
systemTop_ = std::clamp(systemTop_, 0, std::max(0, wrappedLines_ - 8));
widgets::textLines(c, wrapped, systemTop_, {area.x + 2, area.y + 2, area.w - 2, area.h - 12});
footer(c, "Tab: overview");
}
} // namespace roro
+67
View File
@@ -0,0 +1,67 @@
#pragma once
#include <string>
#include <vector>
#include "app.h"
#include "key_value_store.h"
#include "services/battery_service.h"
#include "services/gnss_service.h"
#include "services/radio_service.h"
#include "services/storage_service.h"
#include "services/wifi_service.h"
#include "task_stats.h"
#include "traffic.h"
namespace roro {
// The System App (docs/milestones/S1.md, Q117 to Q127): what the device is doing, live and
// read-only. Tab moves between Overview, Tasks, Memory, Network and System. It samples once a
// second and keeps two minutes of history, only while it's open (Q120).
class SystemApp : public App {
public:
SystemApp(WifiService& wifi, BatteryService& battery, StorageService& storage, RadioService& radio, GnssService& gnss,
KeyValueStore& store)
: wifi_(wifi), battery_(battery), storage_(storage), radio_(radio), gnss_(gnss), store_(store) {}
void onEnter() override;
void onExit() override;
bool onKey(const KeyEvent& e) override;
void update(uint32_t nowMs) override;
void draw(Canvas& c) override;
private:
enum class View : uint8_t { Overview, Tasks, Memory, Network, System, Count };
static constexpr size_t kHistory = 120; // seconds
static constexpr int kTaskRows = 7;
void sample(uint32_t nowMs);
void drawOverview(Canvas& c);
void drawTasks(Canvas& c);
void drawMemory(Canvas& c);
void drawNetwork(Canvas& c);
void drawSystem(Canvas& c);
void footer(Canvas& c, const char* keys);
WifiService& wifi_;
BatteryService& battery_;
StorageService& storage_;
RadioService& radio_;
GnssService& gnss_;
KeyValueStore& store_;
View view_ = View::Overview;
uint32_t sampledMs_ = 0;
std::vector<TaskSample> before_;
uint32_t beforeTotal_ = 0;
std::vector<TaskRow> rows_; // the last second, sorted
TaskSort sort_ = TaskSort::Share;
int taskTop_ = 0;
int load_[2] = {-1, -1};
History<uint8_t, kHistory> loadHistory_[2];
History<uint16_t, kHistory> heapHistory_; // free heap, KB
net::Traffic traffic_[static_cast<size_t>(net::User::Count)];
uint32_t rateIn_[static_cast<size_t>(net::User::Count)] = {}, rateOut_[static_cast<size_t>(net::User::Count)] = {};
std::vector<std::string> systemLines_;
int systemTop_ = 0, wrappedLines_ = 0;
};
} // namespace roro
+154 -4
View File
@@ -14,11 +14,13 @@
#include "apps/launcher_app.h" #include "apps/launcher_app.h"
#include "apps/lora_scanner_app.h" #include "apps/lora_scanner_app.h"
#include "apps/settings_app.h" #include "apps/settings_app.h"
#include "apps/system_app.h"
#include "apps/wifi_tools_app.h" #include "apps/wifi_tools_app.h"
#include "apps/setup_app.h" #include "apps/setup_app.h"
#include "event_bus.h" #include "event_bus.h"
#include "file_receiver.h" #include "file_receiver.h"
#include "ipv4.h" #include "ipv4.h"
#include "traffic.h"
#include "key_mapper.h" #include "key_mapper.h"
#include "platform/console.h" #include "platform/console.h"
#include "platform/crash_report.h" #include "platform/crash_report.h"
@@ -36,6 +38,7 @@
#include "services/gnss_service.h" #include "services/gnss_service.h"
#include "services/power_service.h" #include "services/power_service.h"
#include "services/lora_capture_service.h" #include "services/lora_capture_service.h"
#include "services/noise_test.h"
#include "services/radio_service.h" #include "services/radio_service.h"
#include "services/storage_service.h" #include "services/storage_service.h"
#include "services/update_service.h" #include "services/update_service.h"
@@ -64,6 +67,9 @@ static ClockService* clockService;
static GnssService* gnssService; static GnssService* gnssService;
static RadioService* radioService; static RadioService* radioService;
static LoraCaptureService* loraCapture; static LoraCaptureService* loraCapture;
#ifdef RORO_DEBUG
static NoiseTest* noiseTest;
#endif
static GeminiService* geminiService; static GeminiService* geminiService;
static SavedNetworks* savedNetworks; static SavedNetworks* savedNetworks;
static WifiService* wifi; static WifiService* wifi;
@@ -178,6 +184,9 @@ void setup() {
services.add(*gnssService); services.add(*gnssService);
services.add(*radioService); services.add(*radioService);
loraCapture = new LoraCaptureService(*radioService, *storageService, *clockService, bus); loraCapture = new LoraCaptureService(*radioService, *storageService, *clockService, bus);
#ifdef RORO_DEBUG
noiseTest = new NoiseTest(*radioService);
#endif
services.add(*loraCapture); services.add(*loraCapture);
services.add(*storageService); services.add(*storageService);
services.add(*wifi); services.add(*wifi);
@@ -195,6 +204,8 @@ void setup() {
apps->registerApp({"gnss", "GNSS", false, new GnssApp(*gnssService, settings)}); apps->registerApp({"gnss", "GNSS", false, new GnssApp(*gnssService, settings)});
apps->registerApp({"gemini", "Gemini", false, new GeminiApp(*geminiService)}); apps->registerApp({"gemini", "Gemini", false, new GeminiApp(*geminiService)});
apps->registerApp({"lora", "LoRa Scanner", false, new LoraScannerApp(*radioService, *loraCapture, settings, *clockService)}); apps->registerApp({"lora", "LoRa Scanner", false, new LoraScannerApp(*radioService, *loraCapture, settings, *clockService)});
apps->registerApp({"system", "System", false,
new SystemApp(*wifi, *battery, *storageService, *radioService, *gnssService, nvs)});
apps->registerApp({"settings", "Settings", false, apps->registerApp({"settings", "Settings", false,
new SettingsApp({settings, bus, *apps, *battery, *storageService, *clockService, *wifi, *savedNetworks, *update})}); new SettingsApp({settings, bus, *apps, *battery, *storageService, *clockService, *wifi, *savedNetworks, *update})});
apps->registerApp({"demo", "Widget demo", true, new DemoApp(bus)}); apps->registerApp({"demo", "Widget demo", true, new DemoApp(bus)});
@@ -381,9 +392,28 @@ static void ipTrialStep() {
} }
#endif #endif
// `tasks`: the first sample, and when to take the second and print.
static std::vector<TaskSample> tasksBefore;
static uint32_t tasksTotal = 0, tasksDueMs = 0;
static bool tasksPending = false;
static uint32_t loopPasses = 0; // counted in loop(), for `tasks` (issue #40)
#ifdef RORO_DEBUG
static bool loopSpin = false; // `loop spin on`: no rest between passes, to compare load and radio noise
#endif
static uint32_t tasksPasses = 0;
static void tasksStep() {
if (!tasksPending || static_cast<int32_t>(millis() - tasksDueMs) < 0) return;
tasksPending = false;
system_info::printTasks(console, tasksBefore, tasksTotal);
console.printf("loop: %lu passes in the last second, chip %.1f C\n", (unsigned long)(loopPasses - tasksPasses), temperatureRead());
std::vector<TaskSample>().swap(tasksBefore);
}
static const char* const kHelp = static const char* const kHelp =
"info firmware, uptime, memory, Wi-Fi, app slots\n" "info firmware, uptime, memory, Wi-Fi, app slots\n"
"tasks FreeRTOS tasks: state, priority, free stack, CPU\n" "tasks FreeRTOS tasks over the next second: state, priority, free stack, CPU share\n" "net bytes each network service has read and written since boot\n"
"reboot restart\n" "reboot restart\n"
"boot other restart into the other app slot (manual Rollback)\n" "boot other restart into the other app slot (manual Rollback)\n"
"log level <0-5> ESP-IDF log level (0 none ... 5 verbose)\n" "log level <0-5> ESP-IDF log level (0 none ... 5 verbose)\n"
@@ -391,6 +421,7 @@ static const char* const kHelp =
"lora capture start|stop a LoRa Capture to /captures/lora (pcap, LoRaTap)\n" "lora capture start|stop a LoRa Capture to /captures/lora (pcap, LoRaTap)\n"
"lora sweep on [from MHz] [to MHz] [step kHz] | off | dump RSSI across a band (863 870 100)\n" "lora sweep on [from MHz] [to MHz] [step kHz] | off | 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" "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"
"gnss status | gnss restart | gnss track start|stop | gnss nmea on|off | gnss send <sentence without $ and checksum>\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" "crash the last crash: firmware, reason, task, backtrace\n"
"coredump erase forget the core dump in flash\n" "coredump erase forget the core dump in flash\n"
@@ -405,6 +436,8 @@ static const char* const kHelp =
#ifdef RORO_DEBUG #ifdef RORO_DEBUG
"crash abort|wdt crash on purpose (to test crash reports and Safe Mode)\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" "wifi ip ... try <seconds> | wifi ip keep a trial IP setting: back to the previous one unless kept\n"
"loop spin on|off make the main loop spin without resting, to compare load and radio noise\n"
"lora noise test [gnss|quiet] | lora noise report Sweep under one changed condition at a time (Wi-Fi goes off for a moment)\n"
"lora inject <hex> [rssi] [snr] a packet into the LoRa Scanner as if received (nothing is sent)\n" "lora inject <hex> [rssi] [snr] a packet into the LoRa Scanner as if received (nothing is sent)\n"
"coredump get (Debug Console only) send the raw core dump: use scripts/rdbg.py coredump\n" "coredump get (Debug Console only) send the raw core dump: use scripts/rdbg.py coredump\n"
"reset (Debug Console only) restart at once, even if the main loop is stuck\n" "reset (Debug Console only) restart at once, even if the main loop is stuck\n"
@@ -415,7 +448,7 @@ static const char* const kHelp =
// Commands that only touch what Safe Mode starts. // Commands that only touch what Safe Mode starts.
static bool safeModeCommand(const String& line) { static bool safeModeCommand(const String& line) {
return line == "help" || line == "info" || line == "tasks" || line == "reboot" || line == "boot other" || return line == "help" || line == "info" || line == "tasks" || line == "net" || line == "reboot" || line == "boot other" ||
line.startsWith("log level ") || line.startsWith("crash") || line.startsWith("coredump") || line.startsWith("log level ") || line.startsWith("crash") || line.startsWith("coredump") ||
line == "wifi status" || line.startsWith("wifi add "); line == "wifi status" || line.startsWith("wifi add ");
} }
@@ -432,7 +465,25 @@ static void runCommand(String line) {
console.printf("update: %s\n", update->onProbation() ? "on probation" : "confirmed"); console.printf("update: %s\n", update->onProbation() ? "on probation" : "confirmed");
system_info::printSlots(console, nvs); system_info::printSlots(console, nvs);
} }
if (line == "tasks") system_info::printTasks(console); #ifdef RORO_DEBUG
if (line == "loop spin on" || line == "loop spin off") {
loopSpin = line.endsWith("on");
console.printf("loop: %s\n", loopSpin ? "spinning, no rest" : "resting between passes");
}
#endif
if (line == "tasks") { // sampled now, printed a second later by tasksStep(): the loop must run in between
tasksTotal = system_info::sampleTasks(tasksBefore);
tasksDueMs = millis() + 1000;
tasksPasses = loopPasses;
tasksPending = true;
}
if (line == "net") { // bytes each service has read and written since boot (S1, Q121)
for (int i = 0; i < static_cast<int>(net::User::Count); i++) {
net::Traffic t = net::traffic(static_cast<net::User>(i));
console.printf("net: %-14s in %10lu out %10lu\n", net::userName(static_cast<net::User>(i)), (unsigned long)t.in,
(unsigned long)t.out);
}
}
if (line == "reboot") { if (line == "reboot") {
console.println("restarting"); console.println("restarting");
delay(300); delay(300);
@@ -461,6 +512,72 @@ static void runCommand(String line) {
if (line == "lora probe" && radioService) radioService->probe(console); if (line == "lora probe" && radioService) radioService->probe(console);
if (line == "lora status" && radioService) radioService->printStatus(console); if (line == "lora status" && radioService) radioService->printStatus(console);
if ((line == "lora rx on" || line == "lora rx off") && radioService) radioService->setEcho(line.endsWith("on")); if ((line == "lora rx on" || line == "lora rx off") && radioService) radioService->setEcho(line.endsWith("on"));
#ifdef RORO_DEBUG
if (line == "lora noise report" && noiseTest) noiseTest->printReport(console);
if (line == "lora noise test" && noiseTest && !noiseTest->running()) {
// One thing changed at a time, each put back before the next (issue #20). Wi-Fi off cuts the
// Debug Console: the report prints when it's over, and `lora noise report` shows it again.
using C = NoiseTest::Condition;
auto radioOptions = [](bool ldo, bool boosted) { return [=]() { radioService->debugOptions(ldo, boosted); }; };
std::vector<C> conditions = {
{"as it is", nullptr, nullptr},
{"loop spinning", []() { loopSpin = true; }, []() { loopSpin = false; }},
{"GNSS in standby", []() { gnssService->send("PCAS12,30"); }, []() { gnssService->restart(millis()); }, 2500},
{"CPU at 160 MHz", []() { setCpuFrequencyMhz(160); }, []() { setCpuFrequencyMhz(240); }},
{"CPU at 80 MHz", []() { setCpuFrequencyMhz(80); }, []() { setCpuFrequencyMhz(240); }},
{"radio regulator: LDO", radioOptions(true, true), radioOptions(false, true)},
{"radio gain not boosted", radioOptions(false, false), radioOptions(false, true)},
{"as it is, again", nullptr, nullptr},
{"Wi-Fi off", []() { wifi->debugPause(true); }, []() { wifi->debugPause(false); }, 4000},
{"screen on", []() { power->onKey(millis()); }, nullptr, 1000},
{"as it is, at the end", nullptr, nullptr, 8000},
};
noiseTest->start(std::move(conditions));
}
if (line == "lora noise test quiet" && noiseTest && !noiseTest->running()) {
// The same conditions as the first test, with the GNSS receiver in standby throughout: with
// the loudest source out of the way, what else shows?
using C = NoiseTest::Condition;
auto radioOptions = [](bool ldo, bool boosted) { return [=]() { radioService->debugOptions(ldo, boosted); }; };
std::vector<C> conditions = {
{"GNSS on (reference)", nullptr, nullptr},
{"GNSS in standby", []() { gnssService->send("PCAS12,300"); }, nullptr, 2500},
{"+ loop spinning", []() { loopSpin = true; }, []() { loopSpin = false; }},
{"+ CPU at 160 MHz", []() { setCpuFrequencyMhz(160); }, []() { setCpuFrequencyMhz(240); }},
{"+ CPU at 80 MHz", []() { setCpuFrequencyMhz(80); }, []() { setCpuFrequencyMhz(240); }},
{"+ radio regulator: LDO", radioOptions(true, true), radioOptions(false, true)},
{"+ radio gain not boosted", radioOptions(false, false), radioOptions(false, true)},
{"GNSS in standby, again", nullptr, nullptr},
{"+ Wi-Fi off", []() { wifi->debugPause(true); }, []() { wifi->debugPause(false); }, 4000},
{"+ screen on", []() { power->onKey(millis()); }, nullptr, 1000},
{"+ antenna switched off", []() { radioService->debugAntenna(false); }, []() { radioService->debugAntenna(true); }},
{"+ antenna off, gain not boosted", []() { radioService->debugAntenna(false); radioService->debugOptions(false, false); },
[]() { radioService->debugAntenna(true); radioService->debugOptions(false, true); }},
{"GNSS in standby, at the end", nullptr, []() { gnssService->restart(millis()); }, 8000},
};
noiseTest->start(std::move(conditions));
}
if (line == "lora noise test gnss" && noiseTest && !noiseTest->running()) {
// The first test pointed at the GNSS receiver. Is it the receiver working, or its serial
// line (about 20 sentences a second, next to the antenna)? Standby stops both; one sentence
// a second quietens the line and leaves the receiver tracking. PCAS03 picks the sentences:
// GGA, GLL, GSA, GSV, RMC, VTG, ZDA, ANT; all eight are on by default.
using C = NoiseTest::Condition;
auto standby = []() { gnssService->send("PCAS12,30"); };
auto wake = []() { gnssService->restart(millis()); };
std::vector<C> conditions = {
{"as it is", nullptr, nullptr},
{"GNSS in standby", standby, wake, 2500},
{"GNSS on again", nullptr, nullptr, 5000},
{"GNSS: RMC only", []() { gnssService->send("PCAS03,0,0,0,0,1,0,0,0,0,0,,,0,0"); },
[]() { gnssService->send("PCAS03,1,1,1,1,1,1,1,1,0,0,,,0,0"); }, 2500},
{"GNSS: all sentences again", nullptr, nullptr, 3000},
{"GNSS in standby, again", standby, wake, 2500},
{"GNSS on again", nullptr, nullptr, 5000},
};
noiseTest->start(std::move(conditions));
}
#endif
if (line.startsWith("lora sweep") && radioService) { // on [from MHz] [to MHz] [step kHz] | off | dump if (line.startsWith("lora sweep") && radioService) { // on [from MHz] [to MHz] [step kHz] | off | dump
if (line == "lora sweep dump") radioService->printSweep(console); if (line == "lora sweep dump") radioService->printSweep(console);
else if (line == "lora sweep off") { else if (line == "lora sweep off") {
@@ -508,6 +625,10 @@ static void runCommand(String line) {
if (p) radioService->setPreset(*p); if (p) radioService->setPreset(*p);
console.printf("lora preset: %s\n", p ? p->name : "unknown (LongFast LongSlow MediumSlow MediumFast ShortSlow ShortFast LongMod)"); console.printf("lora preset: %s\n", p ? p->name : "unknown (LongFast LongSlow MediumSlow MediumFast ShortSlow ShortFast LongMod)");
} }
if (line == "gnss quiet on" || line == "gnss quiet off") { // Settings > 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 == "gnss status" && gnssService) gnssService->printStatus(console, millis()); 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 nmea on" || line == "gnss nmea off") && gnssService) gnssService->setEcho(line.endsWith("on"));
if (line == "gnss restart" && gnssService) gnssService->restart(millis()); if (line == "gnss restart" && gnssService) gnssService->restart(millis());
@@ -731,6 +852,7 @@ static void loopSafeMode() {
uint32_t now = millis(); uint32_t now = millis();
serialCommands(); serialCommands();
remoteCommands(); remoteCommands();
tasksStep();
services.tick(now); services.tick(now);
bus.dispatch(); bus.dispatch();
noteStableOnce(now); noteStableOnce(now);
@@ -750,8 +872,30 @@ static void loopSafeMode() {
delay(10); delay(10);
} }
// How long the main loop rests after a pass (issue #40). Spinning, it made 50,000 passes a
// second and kept core 1 100 % busy for nothing: keys are buffered by the keyboard controller,
// the consoles and the radio have their own tasks, and no Service asks for a tick more often than
// every 50 ms. Shorter with the screen on, so a key or a redraw never waits long.
constexpr uint32_t kLoopRestScreenOnMs = 5;
constexpr uint32_t kLoopRestScreenOffMs = 20;
static void loopPass();
void loop() { void loop() {
if (safeMode) return loopSafeMode(); loopPasses++;
if (safeMode) {
loopSafeMode();
delay(kLoopRestScreenOnMs);
return;
}
loopPass();
#ifdef RORO_DEBUG
if (loopSpin) return;
#endif
if (upload.active()) return; // a serial file transfer: every byte is read promptly
delay(power->screen() == ScreenState::Off ? kLoopRestScreenOffMs : kLoopRestScreenOnMs);
}
static void loopPass() {
#ifdef RORO_TEST_CRASH #ifdef RORO_TEST_CRASH
// Test builds only (never in a release): crash during Probation to exercise Rollback. // Test builds only (never in a release): crash during Probation to exercise Rollback.
if (millis() > 5000) abort(); if (millis() > 5000) abort();
@@ -762,8 +906,10 @@ void loop() {
serialCommands(); serialCommands();
remoteCommands(); remoteCommands();
tasksStep();
#ifdef RORO_DEBUG #ifdef RORO_DEBUG
ipTrialStep(); ipTrialStep();
if (noiseTest) noiseTest->step(now);
#endif #endif
noteStableOnce(now); noteStableOnce(now);
uploadStep(); uploadStep();
@@ -777,6 +923,10 @@ void loop() {
for (auto& e : events) apps->handleKey(e); for (auto& e : events) apps->handleKey(e);
} }
// Issue #20: the GNSS receiver costs the LoRa radio 8 dB while it runs. If the user chose so,
// it waits in standby while the radio listens or sweeps; never while a Track is recording.
gnssService->holdForLora(settings.getBool(Setting::GnssQuietForLora) && !gnssService->tracking() &&
(radioService->listening() || radioService->sweeping()));
services.tick(now); services.tick(now);
bus.dispatch(); bus.dispatch();
notifier->update(now); notifier->update(now);
+40
View File
@@ -0,0 +1,40 @@
#pragma once
#include <cstddef>
#include <cstdint>
#include "traffic.h"
namespace roro {
// A NetworkClient (or NetworkClientSecure) that adds what it reads and writes to its service's
// traffic counters (S1, Q121). Only the two buffer calls are overridden: the single-byte ones,
// print() and printf() all go through them, so every byte is counted once.
template <class Base>
class Counted : public Base {
public:
explicit Counted(net::User user) : user_(user) {}
Counted(const Base& accepted, net::User user) : Base(accepted), user_(user) {}
// Overriding the buffer calls hides the single-byte ones; these put them back. They end up in
// the buffer calls below, where the counting happens.
int read() override { return Base::read(); }
size_t write(uint8_t byte) override { return Base::write(byte); }
size_t write(const uint8_t* buf, size_t size) override {
size_t n = Base::write(buf, size);
net::sent(user_, n);
return n;
}
int read(uint8_t* buf, size_t size) override {
int n = Base::read(buf, size);
if (n > 0) net::received(user_, static_cast<size_t>(n));
return n;
}
private:
net::User user_;
};
} // namespace roro
+29 -7
View File
@@ -7,6 +7,8 @@
#include <freertos/FreeRTOS.h> #include <freertos/FreeRTOS.h>
#include <freertos/task.h> #include <freertos/task.h>
#include <algorithm>
#include <cstdio>
#include <string> #include <string>
#include <vector> #include <vector>
@@ -89,20 +91,40 @@ void printSlots(Print& out, KeyValueStore& store) {
} }
} }
void printTasks(Print& out) { uint32_t sampleTasks(std::vector<TaskSample>& out) {
UBaseType_t n = uxTaskGetNumberOfTasks(); UBaseType_t n = uxTaskGetNumberOfTasks();
std::vector<TaskStatus_t> tasks(n + 4); std::vector<TaskStatus_t> tasks(n + 4);
uint32_t total = 0; uint32_t total = 0;
n = uxTaskGetSystemState(tasks.data(), tasks.size(), &total); n = uxTaskGetSystemState(tasks.data(), tasks.size(), &total);
out.printf("%-16s %-4s %3s %6s %5s %s\n", "task", "st", "pri", "stack", "cpu%", "core"); out.clear();
static const char kStates[] = "RrBSD"; // running, ready, blocked, suspended, deleted out.reserve(n);
for (UBaseType_t i = 0; i < n; i++) { for (UBaseType_t i = 0; i < n; i++) {
const TaskStatus_t& t = tasks[i]; const TaskStatus_t& t = tasks[i];
unsigned cpu = total ? (unsigned)((uint64_t)t.ulRunTimeCounter * 100 / total) : 0; TaskSample s;
int core = t.xCoreID == tskNO_AFFINITY ? -1 : (int)t.xCoreID; s.id = t.xTaskNumber;
out.printf("%-16s %-4c %3u %6u %5u %d\n", t.pcTaskName, t.eCurrentState < 5 ? kStates[t.eCurrentState] : '?', std::snprintf(s.name, sizeof s.name, "%s", t.pcTaskName);
(unsigned)t.uxCurrentPriority, (unsigned)t.usStackHighWaterMark, cpu, core); s.runtime = t.ulRunTimeCounter;
s.stackFree = static_cast<uint16_t>(std::min<uint32_t>(t.usStackHighWaterMark, 0xFFFF));
s.core = t.xCoreID == tskNO_AFFINITY ? -1 : static_cast<int8_t>(t.xCoreID);
s.state = static_cast<uint8_t>(t.eCurrentState);
s.priority = static_cast<uint8_t>(t.uxCurrentPriority);
out.push_back(s);
} }
return total;
}
// Shares over the interval since `before`, not since boot: the counters wrap every 71 minutes.
void printTasks(Print& out, const std::vector<TaskSample>& before, uint32_t beforeTotal) {
std::vector<TaskSample> now;
uint32_t t1 = sampleTasks(now);
std::vector<TaskRow> rows = taskRows(before, beforeTotal, now, t1);
sortTasks(rows, TaskSort::Share);
out.printf("%-16s %-4s %3s %6s %6s %s\n", "task", "st", "pri", "stack", "cpu%", "core");
static const char kStates[] = "RrBSD"; // running, ready, blocked, suspended, deleted
for (const TaskRow& r : rows)
out.printf("%-16s %-4c %3u %6u %4u.%u %d%s\n", r.name.c_str(), r.state < 5 ? kStates[r.state] : '?', r.priority,
r.stackFree, r.permille / 10, r.permille % 10, r.core, r.lowStack ? " low stack" : "");
out.printf("load: core 0 %d %%, core 1 %d %%\n", coreLoad(rows, 0), coreLoad(rows, 1));
} }
const char* bootOtherSlot() { const char* bootOtherSlot() {
+9 -1
View File
@@ -3,7 +3,10 @@
#include <Print.h> #include <Print.h>
#include <esp_partition.h> #include <esp_partition.h>
#include <vector>
#include "key_value_store.h" #include "key_value_store.h"
#include "task_stats.h"
namespace roro::system_info { namespace roro::system_info {
@@ -20,7 +23,12 @@ void printSlots(Print& out, KeyValueStore& store);
// Remembers which version the running slot holds (call at boot), or the slot an update just wrote. // Remembers which version the running slot holds (call at boot), or the slot an update just wrote.
void recordSlotVersion(KeyValueStore& store, const esp_partition_t* slot, const char* version); void recordSlotVersion(KeyValueStore& store, const esp_partition_t* slot, const char* version);
// FreeRTOS tasks: state, priority, lowest free stack, CPU share since boot. // FreeRTOS tasks: state, priority, lowest free stack, CPU share since boot.
void printTasks(Print& out); // The tasks' shares since `before` was sampled (with its run-time clock). The caller lets the main
// loop run in between: sampling twice inside one command would show the loop asleep.
void printTasks(Print& out, const std::vector<TaskSample>& before, uint32_t beforeTotal);
// Every task as FreeRTOS reports it now; returns the run-time clock (microseconds, 32 bits), to
// pair with the samples. Two of these make the shares the System App and `tasks` show.
uint32_t sampleTasks(std::vector<TaskSample>& out);
// Boots the firmware in the other app slot if it holds a valid image (a manual Rollback). // Boots the firmware in the other app slot if it holds a valid image (a manual Rollback).
// Returns an error message; on success it restarts and doesn't return. // Returns an error message; on success it restarts and doesn't return.
+2 -1
View File
@@ -17,6 +17,7 @@
#include "file_receiver.h" #include "file_receiver.h"
#include "sha256.h" #include "sha256.h"
#include "platform/console.h" #include "platform/console.h"
#include "platform/counted_client.h"
#include "sd_fault.h" #include "sd_fault.h"
#include "version.h" #include "version.h"
@@ -110,7 +111,7 @@ void DebugConsole::listen() {
listening = false; listening = false;
} }
if (listening) { if (listening) {
NetworkClient client = server.accept(); Counted<NetworkClient> client(server.accept(), net::User::DebugConsole);
if (client) { if (client) {
client.setNoDelay(true); client.setNoDelay(true);
if (authenticate(client)) serve(client); if (authenticate(client)) serve(client);
+2 -1
View File
@@ -12,6 +12,7 @@
#include "gemtext.h" #include "gemtext.h"
#include "platform/console.h" #include "platform/console.h"
#include "sha256.h" #include "sha256.h"
#include "platform/counted_client.h"
#include "storage_paths.h" #include "storage_paths.h"
namespace roro { namespace roro {
@@ -544,7 +545,7 @@ void GeminiService::fetchOne(const std::string& url, GeminiPage& page, bool load
auto track = [this]() { lowest_ = std::min<size_t>(lowest_, esp_get_free_heap_size()); }; auto track = [this]() { lowest_ = std::min<size_t>(lowest_, esp_get_free_heap_size()); };
size_t freeBefore = esp_get_free_heap_size(); // what's left once the connection closes again size_t freeBefore = esp_get_free_heap_size(); // what's left once the connection closes again
NetworkClientSecure tls; Counted<NetworkClientSecure> tls(net::User::Gemini);
tls.setInsecure(); // trust on first use: the pinned fingerprint is what counts (Q71) tls.setInsecure(); // trust on first use: the pinned fingerprint is what counts (Q71)
tls.setTimeout(15); tls.setTimeout(15);
if (!tls.connect(u.host.c_str(), u.portOrDefault())) { if (!tls.connect(u.host.c_str(), u.portOrDefault())) {
+1 -1
View File
@@ -66,7 +66,7 @@ void GnssService::close() {
void GnssService::tick(uint32_t nowMs) { void GnssService::tick(uint32_t nowMs) {
if (!open_) open(nowMs); if (!open_) open(nowMs);
bool wanted = settings_.getBool(Setting::GnssEnabled); bool wanted = settings_.getBool(Setting::GnssEnabled) && !held_;
if (wanted && !active_) wake(nowMs); if (wanted && !active_) wake(nowMs);
if (!wanted && (active_ || !standbyMs_ || nowMs - standbyMs_ >= kStandbyRenewMs)) standby(nowMs); if (!wanted && (active_ || !standbyMs_ || nowMs - standbyMs_ >= kStandbyRenewMs)) standby(nowMs);
+5 -1
View File
@@ -35,6 +35,10 @@ class GnssService : public Service {
void tick(uint32_t nowMs) override; void tick(uint32_t nowMs) override;
bool on() const { return active_; } bool on() const { return active_; }
// Standby while the LoRa radio listens, when the user chose that (issue #20): the receiver
// raises the radio's noise floor by 8 dB while it runs. Never asked for during a Track.
void holdForLora(bool hold) { held_ = hold; }
bool heldForLora() const { return held_ && !active_; }
bool receiving(uint32_t nowMs) const { return active_ && lastLineMs_ && nowMs - lastLineMs_ < kSilentAfterMs; } bool receiving(uint32_t nowMs) const { return active_ && lastLineMs_ && nowMs - lastLineMs_ < kSilentAfterMs; }
const gnss::GnssState& state() const { return parser_.state(); } const gnss::GnssState& state() const { return parser_.state(); }
uint32_t onSinceMs() const { return openedMs_; } // when the receiver was last woken uint32_t onSinceMs() const { return openedMs_; } // when the receiver was last woken
@@ -71,7 +75,7 @@ class GnssService : public Service {
StorageService& storage_; StorageService& storage_;
EventBus& bus_; EventBus& bus_;
gnss::NmeaParser parser_; gnss::NmeaParser parser_;
bool open_ = false, active_ = false, echo_ = false; bool open_ = false, active_ = false, echo_ = false, held_ = false;
uint32_t bytes_ = 0, standbyMs_ = 0; uint32_t bytes_ = 0, standbyMs_ = 0;
uint32_t openedMs_ = 0, lastLineMs_ = 0, firstFixMs_ = 0, clockSetMs_ = 0; uint32_t openedMs_ = 0, lastLineMs_ = 0, firstFixMs_ = 0, clockSetMs_ = 0;
gnss::FixType lastFix_ = gnss::FixType::None; gnss::FixType lastFix_ = gnss::FixType::None;
+3 -2
View File
@@ -1,6 +1,7 @@
#pragma once #pragma once
#include <NetworkClientSecure.h> #include <NetworkClientSecure.h>
#include "platform/counted_client.h"
#include <freertos/FreeRTOS.h> #include <freertos/FreeRTOS.h>
#include <freertos/semphr.h> #include <freertos/semphr.h>
@@ -75,8 +76,8 @@ class IrcService : public Service {
std::unique_ptr<IrcSession> session_; std::unique_ptr<IrcSession> session_;
SemaphoreHandle_t lock_ = nullptr; SemaphoreHandle_t lock_ = nullptr;
TaskHandle_t task_ = nullptr; TaskHandle_t task_ = nullptr;
NetworkClientSecure tlsClient_; Counted<NetworkClientSecure> tlsClient_{net::User::Irc}; // counted for the System App (S1, Q121)
NetworkClient plainClient_; Counted<NetworkClient> plainClient_{net::User::Irc};
NetworkClient* conn_ = &tlsClient_; // whichever the config asks for NetworkClient* conn_ = &tlsClient_; // whichever the config asks for
ReconnectPolicy backoff_; ReconnectPolicy backoff_;
std::string partial_; std::string partial_;
+110
View File
@@ -0,0 +1,110 @@
#ifdef RORO_DEBUG
#include "services/noise_test.h"
#include <Arduino.h>
#include <algorithm>
#include <cstdio>
#include "platform/console.h"
#include "sweep_view.h"
namespace roro {
void NoiseTest::start(std::vector<Condition> conditions, int passes) {
if (running()) return;
conditions_ = std::move(conditions);
results_.clear();
report_.clear();
passes_ = passes;
index_ = 0;
console.printf("noise test: %u conditions, %d passes each\n", (unsigned)conditions_.size(), passes_);
begin(millis());
}
void NoiseTest::begin(uint32_t nowMs) {
const Condition& c = conditions_[index_];
if (c.apply) c.apply();
radio_.sweep(true); // sets the radio up again, with whatever the condition changed
std::fill(std::begin(lowest_), std::end(lowest_), 0);
std::fill(std::begin(counts_), std::end(counts_), 0);
seen_ = 0;
phase_ = Phase::Settle;
phaseMs_ = nowMs;
}
void NoiseTest::step(uint32_t nowMs) {
if (phase_ == Phase::Idle) return;
const Condition& c = conditions_[index_];
if (phase_ == Phase::Settle) {
if (nowMs - phaseMs_ < c.settleMs) return;
lastSeq_ = radio_.sweeps();
phase_ = Phase::Sweep;
phaseMs_ = nowMs;
return;
}
SweepFrame f;
if (radio_.sweeps() != lastSeq_ && radio_.sweepFrame(f)) {
lastSeq_ = f.seq;
fromHz_ = f.fromHz, stepHz_ = f.stepHz, steps_ = f.steps;
for (uint16_t i = 0; i < f.steps; i++) {
lowest_[i] = seen_ ? std::min(lowest_[i], f.dbm[i]) : f.dbm[i];
counts_[std::clamp<int>(-f.dbm[i], 0, 127)]++;
}
seen_++;
}
bool stuck = nowMs - phaseMs_ > 20000; // the radio never swept: don't hang the test
if (seen_ < passes_ && !stuck) return;
Result r;
r.name = c.name;
if (seen_) {
// The floor: the median of every reading. The top and the peaks: from the lowest reading
// at each step, so a burst in one pass doesn't count and a steady carrier does.
uint32_t total = 0, half = static_cast<uint32_t>(seen_) * steps_ / 2;
for (int level = 127; level >= 0; level--) {
total += counts_[level];
if (total > half) {
r.floor = -level;
break;
}
}
lora::SweepStats st = lora::summarize(lowest_, steps_, fromHz_, stepHz_);
r.top = st.top;
char p[32];
for (auto& peak : st.peaks) {
std::snprintf(p, sizeof p, "%s%.1f %d", r.peaks.empty() ? "" : ", ", peak.hz / 1e6, peak.dbm);
r.peaks += p;
}
} else {
r.name += " (no sweep)";
}
results_.push_back(r);
radio_.sweep(false);
if (c.restore) c.restore();
if (++index_ < conditions_.size()) begin(nowMs);
else finish();
}
void NoiseTest::finish() {
phase_ = Phase::Idle;
char line[160];
report_.push_back("noise test: floor = median of every reading; top and peaks = steady (lowest of the passes), dBm at 125 kHz");
for (auto& r : results_) {
std::snprintf(line, sizeof line, "noise test: %-26s floor %4d top %4d %s", r.name.c_str(), r.floor, r.top,
r.peaks.empty() ? "no steady peak" : r.peaks.c_str());
report_.push_back(line);
}
report_.push_back("noise test: done");
printReport(console);
}
void NoiseTest::printReport(Print& out) const {
if (report_.empty()) return (void)out.println(running() ? "noise test: still running" : "noise test: none run yet");
for (auto& l : report_) out.println(l.c_str());
}
} // namespace roro
#endif // RORO_DEBUG
+59
View File
@@ -0,0 +1,59 @@
#pragma once
#ifdef RORO_DEBUG
#include <Print.h>
#include <functional>
#include <string>
#include <vector>
#include "services/radio_service.h"
namespace roro {
// `lora noise test` (Debug Builds, issue #20): which part of the Cardputer raises the radio's
// noise floor? Applies one condition at a time, Sweeps the band a few passes, records the floor
// and the steady peaks, and puts things back. It runs from the main loop on its own, because one
// condition switches Wi-Fi off, and prints its report once the console can be reached again.
class NoiseTest {
public:
struct Condition {
std::string name;
std::function<void()> apply, restore; // either may be empty
uint32_t settleMs = 1500;
};
explicit NoiseTest(RadioService& radio) : radio_(radio) {}
void start(std::vector<Condition> conditions, int passes = 8);
void step(uint32_t nowMs); // from the main loop
bool running() const { return phase_ != Phase::Idle; }
void printReport(Print& out) const;
private:
enum class Phase { Idle, Settle, Sweep };
struct Result {
std::string name;
int floor = 0, top = 0;
std::string peaks; // steady ones: the lowest reading at each step over the passes
};
void begin(uint32_t nowMs);
void finish();
RadioService& radio_;
std::vector<Condition> conditions_;
std::vector<Result> results_;
size_t index_ = 0;
int passes_ = 8, seen_ = 0;
Phase phase_ = Phase::Idle;
uint32_t phaseMs_ = 0, lastSeq_ = 0;
int8_t lowest_[SweepFrame::kMaxSteps];
uint16_t counts_[128]; // how often each level (in -dBm) was read: for the median
uint32_t fromHz_ = 0, stepHz_ = 0;
uint16_t steps_ = 0;
std::vector<std::string> report_;
};
} // namespace roro
#endif // RORO_DEBUG
+9 -3
View File
@@ -71,19 +71,19 @@ bool RadioService::beginRadio(Print* report) {
Config c = config(); Config c = config();
float mhz = c.frequencyHz / 1e6f; float mhz = c.frequencyHz / 1e6f;
int16_t state = radio_->begin(mhz, c.bandwidthKHz, c.spreadingFactor, c.codingRate, c.syncWord, 0, c.preamble, int16_t state = radio_->begin(mhz, c.bandwidthKHz, c.spreadingFactor, c.codingRate, c.syncWord, 0, c.preamble,
tcxo_, false); tcxo_, ldo_);
if (state != RADIOLIB_ERR_NONE && tcxo_ > 0) { // Meshtastic's TCXO_OPTIONAL: fall back to the crystal if (state != RADIOLIB_ERR_NONE && tcxo_ > 0) { // Meshtastic's TCXO_OPTIONAL: fall back to the crystal
if (report) report->printf("lora probe: begin with TCXO %.1f V: error %d, trying the crystal\n", tcxo_, state); if (report) report->printf("lora probe: begin with TCXO %.1f V: error %d, trying the crystal\n", tcxo_, state);
tcxo_ = 0; tcxo_ = 0;
state = radio_->begin(mhz, c.bandwidthKHz, c.spreadingFactor, c.codingRate, c.syncWord, 0, c.preamble, tcxo_, state = radio_->begin(mhz, c.bandwidthKHz, c.spreadingFactor, c.codingRate, c.syncWord, 0, c.preamble, tcxo_,
false); ldo_);
} }
if (state != RADIOLIB_ERR_NONE) { if (state != RADIOLIB_ERR_NONE) {
if (report) report->printf("lora probe: error %d, no SX1262 found\n", state); if (report) report->printf("lora probe: error %d, no SX1262 found\n", state);
return false; return false;
} }
radio_->setDio2AsRfSwitch(true); // DIO2 selects TX or RX in the switch, as in Meshtastic radio_->setDio2AsRfSwitch(true); // DIO2 selects TX or RX in the switch, as in Meshtastic
radio_->setRxBoostedGainMode(true); // about 2 dB more sensitivity for about 2 mA radio_->setRxBoostedGainMode(boostedGain_); // about 2 dB more sensitivity for about 2 mA
return true; return true;
} }
@@ -191,6 +191,12 @@ void RadioService::store(RadioPacket& p) {
} }
#ifdef RORO_DEBUG #ifdef RORO_DEBUG
void RadioService::debugAntenna(bool on) {
auto& i2c = M5.In_I2C;
uint8_t out = i2c.readRegister8(kExpander, kOutput, kI2cFreq);
i2c.writeRegister8(kExpander, kOutput, on ? (out | 1) : (out & ~1), kI2cFreq);
}
void RadioService::inject(const uint8_t* data, size_t len, float rssi, float snr) { void RadioService::inject(const uint8_t* data, size_t len, float rssi, float snr) {
if (!listening_) return (void)console.println("lora inject: not listening"); if (!listening_) return (void)console.println("lora inject: not listening");
RadioPacket p; RadioPacket p;
+10
View File
@@ -100,6 +100,15 @@ class RadioService : public Service {
void setEcho(bool echo); void setEcho(bool echo);
void probe(Print& out); // `lora probe`: runs on the radio task void probe(Print& out); // `lora probe`: runs on the radio task
#ifdef RORO_DEBUG #ifdef RORO_DEBUG
// For the noise self-test (issue #20): the chip's regulator as an LDO instead of its DC-DC
// converter, and receive gain boosted or not. Used the next time the radio is set up.
void debugOptions(bool ldo, bool boostedGain) {
ldo_ = ldo;
boostedGain_ = boostedGain;
}
// The antenna switch (the Cap's expander, P0), for the reference "what the chip hears alone".
// From the main loop only, which owns the I2C bus.
void debugAntenna(bool on);
// `lora inject`: a packet into the ring as if received, to test the App and Captures with no // `lora inject`: a packet into the ring as if received, to test the App and Captures with no
// transmitter in range. Nothing goes on air. // transmitter in range. Nothing goes on air.
void inject(const uint8_t* data, size_t len, float rssi, float snr); void inject(const uint8_t* data, size_t len, float rssi, float snr);
@@ -132,6 +141,7 @@ class RadioService : public Service {
Config config_; Config config_;
bool present_ = false, expander_ = false; bool present_ = false, expander_ = false;
float tcxo_ = 1.8f; float tcxo_ = 1.8f;
std::atomic<bool> ldo_{false}, boostedGain_{true};
std::atomic<uint8_t> clients_{0}; std::atomic<uint8_t> clients_{0};
std::atomic<bool> listening_{false}, configChanged_{false}, probeWanted_{false}, echo_{false}; std::atomic<bool> listening_{false}, configChanged_{false}, probeWanted_{false}, echo_{false};
std::atomic<uint32_t> seq_{0}, packets_{0}, crcErrors_{0}, radioErrors_{0}, restarts_{0}; std::atomic<uint32_t> seq_{0}, packets_{0}, crcErrors_{0}, radioErrors_{0}, restarts_{0};
+2 -1
View File
@@ -1,4 +1,5 @@
#include "update_service.h" #include "update_service.h"
#include "platform/counted_client.h"
#include <SD.h> #include <SD.h>
#include <WiFi.h> #include <WiFi.h>
@@ -208,7 +209,7 @@ void UpdateService::listen() {
} }
} }
if (listening && phase_ == Phase::Idle) { if (listening && phase_ == Phase::Idle) {
NetworkClient client = server.accept(); Counted<NetworkClient> client(server.accept(), net::User::Updates);
if (client) { if (client) {
client.setNoDelay(true); client.setNoDelay(true);
NetSource src(client); NetSource src(client);
+1 -1
View File
@@ -247,7 +247,7 @@ void WifiService::tick(uint32_t nowMs) {
apply(controller_.disconnected(nowMs)); apply(controller_.disconnected(nowMs));
} }
apply(controller_.update(nowMs, settings_.getBool(Setting::WifiEnabled))); apply(controller_.update(nowMs, settings_.getBool(Setting::WifiEnabled) && !paused_));
if (controller_.state() == State::Connected && nowMs - serversCheckedMs_ >= kServersEveryMs) applyServers(Why::Check); if (controller_.state() == State::Connected && nowMs - serversCheckedMs_ >= kServersEveryMs) applyServers(Why::Check);
+6
View File
@@ -56,6 +56,11 @@ class WifiService : public Service {
void ipSettingChanged(const std::string& ssid); void ipSettingChanged(const std::string& ssid);
// The DNS or NTP settings changed: use them now. // The DNS or NTP settings changed: use them now.
void serversChanged() { applyServers(Why::SettingsChanged); } void serversChanged() { applyServers(Why::SettingsChanged); }
#ifdef RORO_DEBUG
// The noise self-test switches the radio off for a few seconds. Not saved anywhere: a restart
// during the test brings Wi-Fi back, which a changed setting wouldn't.
void debugPause(bool paused) { paused_ = paused; }
#endif
// A Saved Network was added: try it now rather than after the retry delay. // A Saved Network was added: try it now rather than after the retry delay.
void savedNetworksChanged() { controller_.retryNow(millis()); } void savedNetworksChanged() { controller_.retryNow(millis()); }
@@ -82,6 +87,7 @@ class WifiService : public Service {
uint32_t listScanSeq_ = 0; uint32_t listScanSeq_ = 0;
bool ntpWaiting_ = false; bool ntpWaiting_ = false;
bool radioInitialised_ = false; bool radioInitialised_ = false;
bool paused_ = false; // Debug Builds: off for a moment, whatever the setting says
bool fixed_ = false; // the network in use has a Fixed address bool fixed_ = false; // the network in use has a Fixed address
bool dnsFromSettings_ = false; bool dnsFromSettings_ = false;
std::string ntpNames_[2]; // lwIP keeps the pointers, so the names live here std::string ntpNames_[2]; // lwIP keeps the pointers, so the names live here
@@ -107,6 +107,19 @@ void test_names_are_text_rows_with_their_byte_limits() {
TEST_ASSERT_EQUAL_STRING("RORO", f.menu.value(shortName).c_str()); TEST_ASSERT_EQUAL_STRING("RORO", f.menu.value(shortName).c_str());
} }
// Issue #20: the GNSS receiver raises the LoRa radio's noise floor by 8 dB while it runs. Pausing
// it while the radio listens is offered, and off unless chosen (GNSS on by default: M2, Q58).
void test_pause_gnss_for_lora_is_off_by_default() {
Fixture f;
int quiet = f.row(SettingsMenu::Row::GnssQuiet);
TEST_ASSERT_EQUAL_STRING("Pause GNSS for LoRa", f.menu.label(quiet).c_str());
TEST_ASSERT_EQUAL_STRING("Off", f.menu.value(quiet).c_str());
f.menu.toggle(quiet);
TEST_ASSERT_TRUE(f.settings.getBool(Setting::GnssQuietForLora));
TEST_ASSERT_EQUAL_STRING("On", f.menu.value(quiet).c_str());
TEST_ASSERT_TRUE(f.settings.getBool(Setting::GnssEnabled)); // the GNSS switch itself is untouched
}
void test_gnss_and_coordinate_rows_toggle() { void test_gnss_and_coordinate_rows_toggle() {
Fixture f; Fixture f;
int gnss = f.row(SettingsMenu::Row::Gnss), coords = f.row(SettingsMenu::Row::Coordinates); int gnss = f.row(SettingsMenu::Row::Gnss), coords = f.row(SettingsMenu::Row::Coordinates);
@@ -131,6 +144,7 @@ int main() {
RUN_TEST(test_brightness_steps_with_left_right_within_bounds); RUN_TEST(test_brightness_steps_with_left_right_within_bounds);
RUN_TEST(test_wifi_is_a_page); RUN_TEST(test_wifi_is_a_page);
RUN_TEST(test_names_are_text_rows_with_their_byte_limits); RUN_TEST(test_names_are_text_rows_with_their_byte_limits);
RUN_TEST(test_pause_gnss_for_lora_is_off_by_default);
RUN_TEST(test_gnss_and_coordinate_rows_toggle); RUN_TEST(test_gnss_and_coordinate_rows_toggle);
return UNITY_END(); return UNITY_END();
} }
+160
View File
@@ -0,0 +1,160 @@
#include <unity.h>
#include <vector>
#include "task_stats.h"
using namespace roro;
void setUp() {}
void tearDown() {}
static TaskSample task(uint32_t id, const char* name, uint32_t runtime, uint16_t stackFree = 2000, int core = 1) {
TaskSample t;
t.id = id;
std::snprintf(t.name, sizeof t.name, "%s", name);
t.runtime = runtime;
t.stackFree = stackFree;
t.core = static_cast<int8_t>(core);
t.state = 2; // blocked, unless a test says it's the one running
return t;
}
static const TaskRow* find(const std::vector<TaskRow>& rows, const char* name) {
for (auto& r : rows)
if (r.name == name) return &r;
return nullptr;
}
// Q119: a task's share is its run time over the interval between two samples, in tenths of a percent.
void test_shares_over_the_interval() {
std::vector<TaskSample> before = {task(1, "loopTask", 5000000), task(2, "IDLE1", 1000000), task(3, "IDLE0", 4000000, 240, 0),
task(4, "wifi", 900000, 4000, 0)};
std::vector<TaskSample> now = {task(1, "loopTask", 5810000), task(2, "IDLE1", 1170000), task(3, "IDLE0", 4780000, 240, 0),
task(4, "wifi", 1090000, 4000, 0)};
auto rows = taskRows(before, 10000000, now, 11000000); // one second later
TEST_ASSERT_EQUAL_size_t(4, rows.size());
TEST_ASSERT_EQUAL_UINT16(810, find(rows, "loopTask")->permille);
TEST_ASSERT_EQUAL_UINT16(170, find(rows, "IDLE1")->permille);
TEST_ASSERT_EQUAL_UINT16(780, find(rows, "IDLE0")->permille);
TEST_ASSERT_EQUAL_UINT16(190, find(rows, "wifi")->permille);
// A core's load is what its idle task didn't use.
TEST_ASSERT_EQUAL_INT(22, coreLoad(rows, 0));
TEST_ASSERT_EQUAL_INT(83, coreLoad(rows, 1));
TEST_ASSERT_EQUAL_INT(-1, coreLoad(rows, 2));
}
// FreeRTOS adds to a task's run time when it's switched out. The task doing the sampling is
// running: if nothing else wanted its core, it was never switched out and its counter hardly
// moved. Its real share is what's left of its core.
void test_the_running_task_gets_what_is_left_of_its_core() {
auto running = [](TaskSample t) {
t.state = 0; // eRunning
return t;
};
std::vector<TaskSample> before = {running(task(1, "loopTask", 5000000)), task(2, "IDLE1", 1000000), task(3, "radio", 100),
task(4, "IDLE0", 4000000, 240, 0), task(5, "wifi", 900000, 4000, 0)};
std::vector<TaskSample> now = {running(task(1, "loopTask", 5020000)), task(2, "IDLE1", 1000000), task(3, "radio", 30100),
task(4, "IDLE0", 4980000, 240, 0), task(5, "wifi", 910000, 4000, 0)};
auto rows = taskRows(before, 0, now, 1000000);
TEST_ASSERT_EQUAL_UINT16(970, find(rows, "loopTask")->permille); // not the 2 % its counter says
TEST_ASSERT_EQUAL_UINT16(30, find(rows, "radio")->permille);
TEST_ASSERT_EQUAL_UINT16(10, find(rows, "wifi")->permille); // another core: untouched
TEST_ASSERT_EQUAL_INT(100, coreLoad(rows, 1));
TEST_ASSERT_EQUAL_INT(2, coreLoad(rows, 0));
}
// When its counter did keep up (it was switched out often), nothing is added.
void test_the_running_task_keeps_its_own_count_when_it_is_higher() {
std::vector<TaskSample> before = {task(1, "loopTask", 0), task(2, "IDLE1", 0)};
std::vector<TaskSample> now = {task(1, "loopTask", 600000), task(2, "IDLE1", 400000)};
now[0].state = before[0].state = 0;
auto rows = taskRows(before, 0, now, 1000000);
TEST_ASSERT_EQUAL_UINT16(600, find(rows, "loopTask")->permille);
}
// The counters are 32-bit microseconds: they wrap every 71 minutes.
void test_counters_wrap() {
std::vector<TaskSample> before = {task(1, "loopTask", 0xFFFFF000u)};
std::vector<TaskSample> now = {task(1, "loopTask", 0x0007A120u - 0x1000u)}; // 500 ms of run time later
auto rows = taskRows(before, 0xFFFF0000u, now, 0xFFFF0000u + 1000000u);
TEST_ASSERT_EQUAL_UINT16(500, rows[0].permille);
}
void test_tasks_come_and_go() {
std::vector<TaskSample> before = {task(1, "loopTask", 100), task(7, "gemini", 50000)};
std::vector<TaskSample> now = {task(1, "loopTask", 400100), task(9, "gemini", 30000)}; // a new gemini task: another id
auto rows = taskRows(before, 0, now, 1000000);
TEST_ASSERT_EQUAL_size_t(2, rows.size());
TEST_ASSERT_EQUAL_UINT16(400, find(rows, "loopTask")->permille);
TEST_ASSERT_EQUAL_UINT16(30, find(rows, "gemini")->permille); // all its run time is inside the interval
}
void test_no_time_passed() {
std::vector<TaskSample> one = {task(1, "loopTask", 100)};
auto rows = taskRows(one, 500, one, 500);
TEST_ASSERT_EQUAL_UINT16(0, rows[0].permille);
TEST_ASSERT_EQUAL_INT(-1, coreLoad(rows, 1)); // no idle task in the sample
}
// Q122: under 512 bytes of stack left is flagged.
void test_low_stack() {
std::vector<TaskSample> s = {task(1, "spk_task", 0, 264), task(2, "IDLE0", 0, 240, 0), task(3, "radio", 0, 2360),
task(4, "edge", 0, 512)};
auto rows = taskRows(s, 0, s, 1000);
TEST_ASSERT_TRUE(find(rows, "spk_task")->lowStack);
TEST_ASSERT_TRUE(find(rows, "IDLE0")->lowStack);
TEST_ASSERT_FALSE(find(rows, "radio")->lowStack);
TEST_ASSERT_FALSE(find(rows, "edge")->lowStack);
}
void test_sorting() {
std::vector<TaskSample> before = {task(1, "wifi", 0, 4000), task(2, "loopTask", 0, 2800), task(3, "IDLE0", 0, 240),
task(4, "irc", 0, 3600)};
std::vector<TaskSample> now = {task(1, "wifi", 190000, 4000), task(2, "loopTask", 810000, 2800), task(3, "IDLE0", 780000, 240),
task(4, "irc", 0, 3600)};
auto rows = taskRows(before, 0, now, 1000000);
sortTasks(rows, TaskSort::Share); // busiest first, idle tasks last: they're what's left over
TEST_ASSERT_EQUAL_STRING("loopTask", rows[0].name.c_str());
TEST_ASSERT_EQUAL_STRING("wifi", rows[1].name.c_str());
TEST_ASSERT_EQUAL_STRING("irc", rows[2].name.c_str());
TEST_ASSERT_EQUAL_STRING("IDLE0", rows[3].name.c_str());
sortTasks(rows, TaskSort::Stack); // least stack left first
TEST_ASSERT_EQUAL_STRING("IDLE0", rows[0].name.c_str());
TEST_ASSERT_EQUAL_STRING("loopTask", rows[1].name.c_str());
sortTasks(rows, TaskSort::Name); // letters only, whatever the case
TEST_ASSERT_EQUAL_STRING("IDLE0", rows[0].name.c_str());
TEST_ASSERT_EQUAL_STRING("irc", rows[1].name.c_str());
TEST_ASSERT_EQUAL_STRING("loopTask", rows[2].name.c_str());
TEST_ASSERT_EQUAL_STRING("wifi", rows[3].name.c_str());
}
// Q120: two minutes of history, the oldest sample dropped first.
void test_history() {
History<uint8_t, 4> h;
TEST_ASSERT_EQUAL_size_t(0, h.size());
for (uint8_t v : {10, 20, 30}) h.push(v);
TEST_ASSERT_EQUAL_size_t(3, h.size());
TEST_ASSERT_EQUAL_UINT8(10, h.at(0));
TEST_ASSERT_EQUAL_UINT8(30, h.at(2));
for (uint8_t v : {40, 50, 60}) h.push(v);
TEST_ASSERT_EQUAL_size_t(4, h.size());
TEST_ASSERT_EQUAL_UINT8(30, h.at(0)); // oldest kept
TEST_ASSERT_EQUAL_UINT8(60, h.at(3)); // newest
h.clear();
TEST_ASSERT_EQUAL_size_t(0, h.size());
}
int main() {
UNITY_BEGIN();
RUN_TEST(test_shares_over_the_interval);
RUN_TEST(test_the_running_task_gets_what_is_left_of_its_core);
RUN_TEST(test_the_running_task_keeps_its_own_count_when_it_is_higher);
RUN_TEST(test_counters_wrap);
RUN_TEST(test_tasks_come_and_go);
RUN_TEST(test_no_time_passed);
RUN_TEST(test_low_stack);
RUN_TEST(test_sorting);
RUN_TEST(test_history);
return UNITY_END();
}
+54
View File
@@ -0,0 +1,54 @@
#include <unity.h>
#include "traffic.h"
using namespace roro::net;
void setUp() { resetTraffic(); }
void tearDown() {}
void test_counts_per_service() {
received(User::Irc, 100);
received(User::Irc, 20);
sent(User::Irc, 7);
sent(User::Gemini, 40);
TEST_ASSERT_EQUAL_UINT32(120, traffic(User::Irc).in);
TEST_ASSERT_EQUAL_UINT32(7, traffic(User::Irc).out);
TEST_ASSERT_EQUAL_UINT32(0, traffic(User::Gemini).in);
TEST_ASSERT_EQUAL_UINT32(40, traffic(User::Gemini).out);
TEST_ASSERT_EQUAL_UINT32(0, traffic(User::Updates).in);
}
void test_names() {
TEST_ASSERT_EQUAL_STRING("IRC", userName(User::Irc));
TEST_ASSERT_EQUAL_STRING("Gemini", userName(User::Gemini));
TEST_ASSERT_EQUAL_STRING("Debug Console", userName(User::DebugConsole));
TEST_ASSERT_EQUAL_STRING("Updates", userName(User::Updates));
}
// Bytes a second between two readings; the counter wraps at 4 GB like any uint32.
void test_rate() {
TEST_ASSERT_EQUAL_UINT32(1000, bytesPerSecond(5000, 6000, 1000));
TEST_ASSERT_EQUAL_UINT32(500, bytesPerSecond(0, 1000, 2000));
TEST_ASSERT_EQUAL_UINT32(0, bytesPerSecond(7, 7, 1000));
TEST_ASSERT_EQUAL_UINT32(20, bytesPerSecond(0xFFFFFFF6u, 10, 1000));
TEST_ASSERT_EQUAL_UINT32(0, bytesPerSecond(1, 2, 0));
}
void test_sizes_for_humans() {
TEST_ASSERT_EQUAL_STRING("0 B", formatTraffic(0).c_str());
TEST_ASSERT_EQUAL_STRING("999 B", formatTraffic(999).c_str());
TEST_ASSERT_EQUAL_STRING("1.5 KB", formatTraffic(1536).c_str());
TEST_ASSERT_EQUAL_STRING("12 KB", formatTraffic(12 * 1024 + 100).c_str());
TEST_ASSERT_EQUAL_STRING("1.7 MB", formatTraffic(1774688).c_str());
TEST_ASSERT_EQUAL_STRING("48 MB", formatTraffic(48u * 1024 * 1024).c_str());
}
int main() {
UNITY_BEGIN();
RUN_TEST(test_counts_per_service);
RUN_TEST(test_names);
RUN_TEST(test_rate);
RUN_TEST(test_sizes_for_humans);
return UNITY_END();
}