Public Access
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4744163683 | ||
|
|
b1de0f8804 | ||
|
|
2fce79aebd | ||
|
|
594748e99a | ||
|
|
30a827070b | ||
|
|
a0e3868934 | ||
|
|
3242475699 | ||
|
|
fed065a6f9 | ||
|
|
6485f277b5 | ||
|
|
0a2f46b428 | ||
|
|
dafbdaddf6 | ||
|
|
fe886e2c1d | ||
|
|
9ca9a16de8 | ||
|
|
fd306d5013 | ||
|
|
10f3ff7a4c | ||
|
|
7b8d9391a4 | ||
|
|
babb1d114e | ||
|
|
2d384f5cff | ||
|
|
dc9b0e14ce | ||
|
|
dc4b49755a | ||
|
|
fff28af961 | ||
|
|
4e439410cd | ||
|
|
db265fb757 | ||
|
|
578a39d3c1 | ||
|
|
d7952612dd | ||
|
|
463ed2dda8 | ||
|
|
d408bada07 | ||
|
|
988253ef02 | ||
|
|
c9b1ecb772 | ||
|
|
f812c62a3d | ||
|
|
9c30d47982 | ||
|
|
634a20c339 |
@@ -4,3 +4,8 @@
|
||||
|
||||
# Private signing keys never belong in the repository (ADR 0003)
|
||||
*key.pem
|
||||
|
||||
# Generated by pioarduino's hybrid compile from custom_sdkconfig (platformio.ini)
|
||||
.dummy/
|
||||
managed_components/
|
||||
sdkconfig.*
|
||||
|
||||
+26
-1
@@ -20,6 +20,10 @@ _Avoid_: daemon, task, driver
|
||||
The Service that keeps the device participating in a mesh network at all times: receiving, relaying, and sending on behalf of Apps.
|
||||
_Avoid_: radio, LoRa app
|
||||
|
||||
**Radio Service**:
|
||||
The Service that owns the LoRa radio on the Cap: it configures it, shares the SPI bus with the SD card, and receives in the background. The LoRa Scanner uses it directly; the Mesh Service sits on top of it.
|
||||
_Avoid_: LoRa driver, modem
|
||||
|
||||
**Mesh Protocol**:
|
||||
One on-air language the Mesh Service can speak (Meshtastic first; others may follow). The Mesh Service speaks Mesh Protocols; Apps don't.
|
||||
_Avoid_: stack, mode
|
||||
@@ -40,6 +44,26 @@ _Avoid_: DM (in docs), private message
|
||||
Rebroadcasting another Node's packet so it travels further across the mesh.
|
||||
_Avoid_: forwarding, repeating
|
||||
|
||||
**Capsule**:
|
||||
A Gemini site: everything served by one host on Geminispace.
|
||||
_Avoid_: site, server (when the content is meant)
|
||||
|
||||
**Saved Page**:
|
||||
A Gemini page kept on the SD card to read offline, with the URL it came from and when it was saved. Kept until the user deletes it; Storage Clean-up never offers it.
|
||||
_Avoid_: cache, download (a download is a non-text file saved from Gemini)
|
||||
|
||||
**GNSS Service**:
|
||||
The Service that owns the GNSS receiver on the Cap: it reads its NMEA sentences in the background and holds the current Fix, position, time and satellites.
|
||||
_Avoid_: GPS (GPS is one constellation among several)
|
||||
|
||||
**Fix**:
|
||||
What the receiver currently knows: none, 2D (position without altitude) or 3D (with altitude), from how many satellites, at what HDOP.
|
||||
_Avoid_: lock, signal
|
||||
|
||||
**Track**:
|
||||
A route recorded from GNSS positions to a GPX file on the SD card, started and stopped by the user.
|
||||
_Avoid_: trace, log (a Log is recorded on its own)
|
||||
|
||||
**Wi-Fi Service**:
|
||||
The Service that owns the Wi-Fi radio. It's always in exactly one mode: *Off*, *Connected* (joined to a Saved Network) or *Monitoring* (passively observing). When Wi-Fi is enabled in Settings, it stays Connected whenever a Saved Network is in range. It goes Monitoring only while Wi-Fi Tools needs it, then reconnects.
|
||||
_Avoid_: network manager
|
||||
@@ -49,7 +73,7 @@ A Wi-Fi network the device may join on its own (name, password). When several ar
|
||||
_Avoid_: profile, known network
|
||||
|
||||
**IRC Service**:
|
||||
The Service that keeps the IRC connection alive in the background once the IRC App has started it, until the user disconnects. It reconnects after drops, and pauses while the Wi-Fi Service is Monitoring. It does not start by itself after a reboot.
|
||||
The Service that keeps the IRC connection alive in the background once the IRC App has started it, until the user stops it (`/quit`, or `irc stop` on the console). Once stopped by hand, opening the App again doesn't reconnect; typing a line does. It reconnects after drops, and pauses while the Wi-Fi Service is Monitoring. It does not start by itself after a reboot.
|
||||
_Avoid_: IRC client (that's the App)
|
||||
|
||||
**Buffer**:
|
||||
@@ -139,6 +163,7 @@ _Avoid_: telnet, remote shell
|
||||
- The **Mesh Service** speaks one or more **Mesh Protocols** and tracks the known **Nodes**.
|
||||
- The **Wi-Fi Service** is either Connected or Monitoring, never both. Monitoring pauses the **IRC Service**, which reconnects and rejoins its **Buffers** afterwards.
|
||||
- **Services** raise **Notifications**; the **Status Bar** summarises **Service** state.
|
||||
- The **Radio Service** owns the radio; the **Mesh Service** and the LoRa Scanner use it.
|
||||
- A **Sweep** pauses the **Mesh Service**; a **Sniffer** does not.
|
||||
- Every transmission is bounded by the **Region** and its **Duty Cycle Budget**.
|
||||
- Past 90% SD usage, **Logs** stop being written; the remaining space is kept for **Captures**. Nothing is deleted without the user's confirmation.
|
||||
|
||||
@@ -18,6 +18,8 @@ scripts/ci.sh
|
||||
|
||||
This runs the host-side unit tests (`test/`, `native` environment), then builds the firmware. The output is `.pio/build/cardputer-adv/firmware.factory.bin`.
|
||||
|
||||
The framework is rebuilt with the TLS settings in `platformio.ini` (`custom_sdkconfig`, ADR 0006), so the first build after a fresh checkout takes about 4 minutes; later builds take under a minute.
|
||||
|
||||
## Flash
|
||||
|
||||
1. Connect the Cardputer by USB-C.
|
||||
@@ -52,6 +54,16 @@ To install from the SD card instead, copy the `.ota` file from `.pio/build/cardp
|
||||
|
||||
**The private key** lives in `~/.config/roro9stack/ota-key.pem` and must never be committed. If it's lost, generate a new pair and flash once over USB.
|
||||
|
||||
## 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.
|
||||
|
||||
On a page, `b` bookmarks it, `s` saves it to the SD card to read offline (a non-text file goes to `/gemini/downloads/`), `S` saves it with the pages it links to on the same capsule (up to 30). The start page lists bookmarks and Saved Pages; inside a Saved Page, `r` refreshes it and `d` deletes it. With a card, every page streams through `/gemini/cache/` so a large one arrives whole even with IRC connected; what doesn't fit in memory stays on the card.
|
||||
|
||||
## 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.
|
||||
|
||||
## Development aids
|
||||
|
||||
`scripts/serial_log.sh [seconds] [command…]` records the serial output, and can send commands to the firmware first. For example, `scripts/serial_log.sh 30 short sleep:12 burst` sets short screen timeouts, waits 12 s, then sends a burst of Toasts.
|
||||
@@ -67,6 +79,9 @@ To install from the SD card instead, copy the `.ota` file from `.pio/build/cardp
|
||||
| `sd list` | Lists the files of each Storage Clean-up category |
|
||||
| `cat <path>` | Prints the first ~1.2 KB of a file on the SD card |
|
||||
| `irc start` | Starts the IRC Service (normally done by opening the IRC App) |
|
||||
| `irc stop` | Stops it, as `/quit` does: QUIT if connected, no more retries, and the App stays disconnected until you type |
|
||||
| `gemini get <url>` | Fetches a Gemini page and prints its header, size, certificate fingerprint and heap use |
|
||||
| `gemini trust <host> <port> <sha256>` | Pins a certificate by hand (the Gemini App asks when one changes) |
|
||||
| `irc say <buffer> <text>` | Types into a Buffer, commands included (`irc say 0 /join #test`) |
|
||||
| `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 |
|
||||
@@ -76,6 +91,13 @@ To install from the SD card instead, copy the `.ota` file from `.pio/build/cardp
|
||||
| `log level <0-5>` | ESP-IDF log level |
|
||||
| `ls [folder]` / `rm <path>` | Lists a folder of the SD card, or deletes a file |
|
||||
| `install <path>` | Update from SD with that `.ota` file, as Settings → Firmware does |
|
||||
| `lora probe` | Finds the radio: chip, oscillator, antenna switch, DIO1 interrupt, noise floor |
|
||||
| `lora status` | Radio settings, who's listening, packet and error counters, noise floor, task stack |
|
||||
| `lora rx on` / `lora rx off` | Listens and prints each packet on the console |
|
||||
| `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 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 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) |
|
||||
| `coredump erase` | Forgets the core dump |
|
||||
| `crash abort` / `crash wdt` | Debug Builds: crash on purpose, or hang the main loop until the watchdog fires |
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
# Name, Type, SubType, Offset, Size, Flags
|
||||
nvs, data, nvs, 0x9000, 0x5000,
|
||||
otadata, data, ota, 0xe000, 0x2000,
|
||||
app0, app, ota_0, 0x10000, 0x330000,
|
||||
app1, app, ota_1, 0x340000,0x330000,
|
||||
spiffs, data, spiffs, 0x670000,0x180000,
|
||||
coredump, data, coredump,0x7F0000,0x10000,
|
||||
|
@@ -9,3 +9,7 @@ A fork would give full compatibility on day one, but its architecture is built a
|
||||
- We accept partial Meshtastic compatibility at first: text on channels, Direct Messages, node list, position and relaying.
|
||||
- The phone-app (BLE) API and PKI-encrypted Direct Messages are deferred, and we must re-implement protocol details ourselves.
|
||||
- Multi-boot with stock Meshtastic via a launcher was rejected: it gives none of our own UX.
|
||||
|
||||
## Note (2026-10-04, M2)
|
||||
|
||||
NMEA is parsed by our own small, host-tested parser instead of TinyGPSPlus: the GNSS App's Sky view needs the satellite list (GSV) across several constellations, which TinyGPSPlus doesn't track. See docs/milestones/M2.md, Q66.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# A Debug Console over Wi-Fi, in Debug Builds only
|
||||
|
||||
The goal of Firmware Updates is to manage the device without a cable, and that includes finding out what went wrong. So a **Debug Build** (`cardputer-adv-debug`, `-DRORO_DEBUG`, version suffix `+debug`) adds a **Debug Console** on TCP 2323: the serial console, over Wi-Fi. A client sends a token as its first line, then gets the last 6 KB of console output (boot messages included), every new line live, and runs the same commands as the serial port, plus a few that only make sense remotely. ESP-IDF's own log lines are teed into it.
|
||||
The goal of Firmware Updates is to manage the device without a cable, and that includes finding out what went wrong. So a **Debug Build** (`cardputer-adv-debug`, `-DRORO_DEBUG`, version suffix `+debug`) adds a **Debug Console** on TCP 2323: the serial console, over Wi-Fi. A client sends a token as its first line, then gets the last 4 KB of console output (boot messages included), every new line live, and runs the same commands as the serial port, plus a few that only make sense remotely. ESP-IDF's own log lines are teed into it.
|
||||
|
||||
It's compiled out of release builds entirely, rather than switched off by a setting. A console that runs commands is a remote control: in a release build, nothing listens.
|
||||
|
||||
@@ -9,7 +9,7 @@ It's compiled out of release builds entirely, rather than switched off by a sett
|
||||
- **Console, not Serial.** All human-readable output goes through `console`, which writes to the USB port and, in a Debug Build, to a ring buffer the Debug Console drains. Writes never wait for USB: a host that's attached but not reading used to stall the main loop for up to 2 s per line.
|
||||
- **Commands run on the main loop.** The socket lives on the Debug Console's own task, which only queues command lines. The main loop runs them, as it does serial commands, so they touch Apps and Services from the one task allowed to.
|
||||
- **The token** is 128 random bits in `~/.config/roro9stack/debug-token`, made by the first build and passed into the container. It's never committed; a Debug Build refuses to compile without one. Like the OTA key, it guards against the network, not against someone holding the device.
|
||||
- **One client at a time**, to keep memory flat (about 6 KB for the ring, 6 KB of task stack).
|
||||
- **One client at a time**, to keep memory flat (4 KB for the ring since M2, 6 KB of task stack).
|
||||
- **Binary commands are answered on the console's own task**, not queued: `get`/`put` (SD card files, run as one Storage Service job each so card access stays on the storage task, with TCP doing the flow control), `screenshot` (the 32 KB RGB332 frame the UI composes into, read as it stands, so it may tear), `coredump get` and `reset`. These keep working when the main loop is stuck. A failed `put` closes the connection, so the rest of the file is never read as commands.
|
||||
|
||||
## Keep a Debug Build in the fallback slot
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
# The framework is rebuilt with our own SDK settings, for smaller TLS buffers
|
||||
|
||||
Arduino-ESP32 ships its ESP-IDF libraries prebuilt, with one `sdkconfig` for every ESP32-S3 board. Its TLS settings give every connection a 16 KB receive buffer and a 16 KB send buffer for its whole life. On a device with no PSRAM and about 340 KB of RAM, an IRC connection over TLS left a 12.6 KB low in M2, against a 40 KB floor.
|
||||
|
||||
Those settings are compiled into the libraries, so changing them means rebuilding them. pioarduino supports this as a "hybrid compile": `custom_sdkconfig` in `platformio.ini` lists the settings, and the build regenerates the framework's libraries from ESP-IDF (the same 5.5.5 the prebuilt ones come from) before building the app. We set:
|
||||
|
||||
- `MBEDTLS_ASYMMETRIC_CONTENT_LEN`, with 16 KB to receive (servers send full TLS records) and **4 KB to send** (IRC lines are short): 12 KB less per connection.
|
||||
- `MBEDTLS_DYNAMIC_BUFFER`, `DYNAMIC_FREE_CONFIG_DATA`, `DYNAMIC_FREE_CA_CERT`: buffers allocated when needed, and handshake-only data (the CA chain) freed once connected.
|
||||
|
||||
The rebuild also follows the board definition instead of the generic one: PSRAM support is off (the Cardputer ADV has none) and the flash size is 8 MB.
|
||||
|
||||
## Consequences
|
||||
|
||||
- With IRC connected over TLS, a Debug Build has 78 KB free and a 59 KB low (it was 31 KB and 12.6 KB), and 46 KB at the lowest under the heaviest combined load measured (IRC, two refused installs, a 1.6 MB put and get).
|
||||
- The first build after a fresh checkout, or after changing `custom_sdkconfig`, takes about 4 minutes instead of 45 s: it downloads ESP-IDF into the PlatformIO volume and compiles it. Later builds reuse it.
|
||||
- Everything the firmware depends on was checked in the regenerated `sdkconfig`: app rollback, core dumps to flash (ELF), the 5 s task watchdog, FreeRTOS run-time stats, the certificate bundle.
|
||||
- The project now owns its partition table (`default_8MB.csv`, identical to the framework's), which the hybrid build requires. Changing it would break updates over the air: the app slots must stay where they are.
|
||||
- Generated files (`sdkconfig.*`, `managed_components/`, `.dummy/`) are ignored by git.
|
||||
- A TLS server that sends records over 16 KB would still fail, as before; one that needs us to send records over 4 KB would now fail. Neither happens with IRC.
|
||||
@@ -0,0 +1,61 @@
|
||||
# G1 — Gemini client
|
||||
|
||||
**Status:** done, tagged v0.5.0. Every step was checked on the device; reading Saved Pages with Wi-Fi off was checked by hand (2026-10-05).
|
||||
|
||||
**Goal:** browse Geminispace from the Cardputer: fetch and read gemtext over TLS, follow links, answer input prompts, keep bookmarks, and save pages to the SD card to read later, offline. A side milestone between M2 and M3, tagged v0.5.0 when done.
|
||||
|
||||
Gemini (geminiprotocol.net): one request per TLS connection on port 1965, the request is the URL and CRLF, the response a `<status> <meta>` header line, then the body. Most capsules use self-signed certificates: trust on first use is the norm.
|
||||
|
||||
## Decisions (design round 2026-10-05)
|
||||
|
||||
| # | Decision |
|
||||
|---|---|
|
||||
| Q70 | A milestone of its own, **G1**, before M3: plan, tests first, measured on the device, tagged v0.5.0. |
|
||||
| Q71 | **TOFU:** the first certificate seen for a host is pinned (SHA-256, in NVS). If it changes, the page isn't shown; a dialog shows both fingerprints and asks whether to trust the new one. Self-signed or expired certificates are fine; only a change counts. |
|
||||
| Q72 | Responses: 1x input (11 hidden, for passwords), 2x content, up to 5 redirects (3x), 4x/5x errors with the server's message. 6x (client certificates): "not supported". |
|
||||
| Q73 | `text/gemini` is rendered, other `text/*` shown as plain text. Anything else can be saved to `/gemini/downloads/`, not shown. |
|
||||
| Q74 | Up to **64 KB on screen**, larger pages truncated with a notice. Saving streams to the card, so a larger page is saved whole. |
|
||||
| Q75 | Gemtext rendering: text wrapped to the 40-column screen; `#`/`##`/`###` headings in bold and accent; `*` lists with bullets; `>` quotes indented and muted; preformatted blocks unwrapped, Left/Right to scroll; `=>` links with their label, numbered. |
|
||||
| Q76 | Up/Down scroll; Tab and Shift+Tab move between links; Enter follows; Backspace goes back; `g` opens the address line. Links to other protocols show their URL and aren't followed. |
|
||||
| Q77 | Back history of 20 URLs in RAM, with scroll positions; going back refetches (or reopens a Saved Page). **Bookmarks** in `/gemini/bookmarks.gmi` (a gemtext page, shown on the start page); `b` adds the current page. Without a card, a built-in start page. |
|
||||
| Q78 | Start page: bookmarks, then Saved Pages, then defaults: geminiprotocol.net, a search engine (kennedy.gemi.dev), an aggregator (Cosmos; Antenna was down when measured). |
|
||||
| Q79 | UTF-8 decoded; characters outside the Latin-1 fonts shown as `?`. |
|
||||
| Q80 | IRC and Gemini can run together: each fetch opens one connection, reads and closes it. If there isn't memory for a second TLS connection, the fetch fails with a clear message and IRC is untouched. Measured in step 1. |
|
||||
| Q81 | Debug aid: `gemini get <url>` prints the status, MIME type, size, certificate fingerprint and the first lines. URL resolution (RFC 3986), the response header and gemtext parsing are host-tested. |
|
||||
| Q82 | `s` saves the page on screen as a **Saved Page**: `/gemini/saved/<host>/<path>.gmi`, the gemtext as received plus a first line with its URL and save date. Saving again replaces it, and says so. |
|
||||
| Q83 | `S` saves the page and the pages it links to, one level deep: gemtext only, same host only, at most 30 pages, in the background with a progress Toast. |
|
||||
| Q84 | The start page lists Saved Pages, newest first, grouped by capsule; they open with no network. In a Saved Page, a link to another Saved Page opens the saved copy; other links fetch online if Wi-Fi is up, or say "not saved, offline". A Saved Page shows when it was saved; `r` refreshes it. |
|
||||
| Q86 | *Decided after step 1, revised after Q88.* **Two floors:** free heap stays above 40 KB in steady state; a fetch refuses to start below **55 KB** free ("not enough memory: stop IRC or retry"). The firmware's own allocations during a fetch (a page in RAM, a window) keep 20 KB free. With IRC connected, the TLS connection itself can briefly take the heap lower, depending on the server's record sizes: measured 24, 19.5, 15.5 and **13 KB**. *Accepted:* about 12 KB for a moment during a fetch with IRC up, rather than refusing most fetches (a 70 KB start floor) or dropping IRC's connection for each page. |
|
||||
| Q87 | *Decided in step 3.* **With a card, every page streams to `/gemini/cache/page.gmi`** in 1 KB pieces while its TLS connection is open; once the connection closes and its ~45 KB is back, the page is loaded into RAM as far as the 40 KB floor allows. The whole page stays on the card (Saved Pages copy it). Without a card, the page goes straight to RAM under the same two floors. Pages are held as lines in 4 KB chunks, never one large block (the largest free block with IRC connected is about 31 KB). |
|
||||
| Q88 | *Added after step 6.* **A page bigger than memory allows is read from the card as you scroll.** Opening it, one pass over its file counts the lines, records where every 64th starts (and whether it's inside a preformatted block), and loads the first window. Scrolling near either end of the window reads the next or previous one in the background, keeping the line on top of the screen where it is; the scrollbar follows the whole page. Display pages alternate between two cache files, so the one on screen is never overwritten by the next fetch; background jobs use a third. |
|
||||
| Q85 | Saved Pages are deleted from the App only (`d`, with confirmation), never by Storage Clean-up's age rules, like Notes. |
|
||||
|
||||
## Measured (step 1)
|
||||
|
||||
- `gemini://geminiprotocol.net/`: `20 text/gemini`, 1,184 bytes, TLS handshake 0.7–1.1 s, whole fetch 0.7–1.1 s; kennedy.gemi.dev 1.9 s. The fetch task's stack peaks at about 3.6 KB of 6.
|
||||
- **Heap, Debug Build, IRC connected over TLS:** about 68 KB free before a fetch. After the handshake the fetch holds about 32 KB (36–40 KB left); the handshake itself (certificate chain parsed with the 16 KB receive buffer allocated) dips to about **24 KB** for a second or two. Nothing leaks: the heap after matches the heap before.
|
||||
- **Step 3, Cosmos (31.6 KB) with IRC connected:** first stopped at 4.6 KB (RAM only, the transfer's 20 KB floor). Streamed to the card: the whole page on the card, 20 KB of it loaded, lowest free heap 19.5 KB during the transfer and 43 KB once loaded. Without IRC: the whole page in RAM. Redirects (Cosmos `31`), input (`10`), not found (`51`) and a changed certificate (refused, both fingerprints shown) all checked on the device.
|
||||
- **Steps 4–6 on the device:** Project Gemini and its relative links, Back with the scroll restored, a refused YouTube link; `b` bookmarks, `s` saves (and says when it replaced an older copy), `S` saved 6 of 6 pages, the start page lists both; a Saved Page opens from the card with its origin, its saved links open saved copies, `r` refreshes, `d` asks first; Kennedy's input prompt sent "cardputer" and got 87 results; emoji drawn as `?`.
|
||||
- **A bug found there:** refreshing first loaded the whole Saved Page into RAM just to read its origin, next to the App's copy and a TLS connection: the heap fell to 436 bytes. Now only the first line is read, and every fetch (pages, saves, refreshes) checks the 55 KB start floor. Lowest since boot afterwards: 53.8 KB.
|
||||
- **Windowed pages (Q88), Cosmos with IRC connected:** 226 of 419 lines in memory at first; paging down loaded lines 192–419 in one window, scrolling back up loaded 64 onwards, then 0 onwards. Window budgets count the memory the old window gives back.
|
||||
- **Heap during a fetch with IRC connected:** lowest 13–15.5 KB in later runs (24 and 19.5 KB earlier), the TLS receive buffers varying with the server's records. Accepted (Q86, revised).
|
||||
- Antenna (`warmedal.se`) doesn't answer, from the PC either; the default aggregator becomes Cosmos (`gemini://skyjake.fi/~Cosmos/`, which redirects to `cosmos.skyjake.fi`).
|
||||
|
||||
## Done when
|
||||
|
||||
- `gemini get gemini://geminiprotocol.net/` prints the header, size and fingerprint on the console.
|
||||
- The Gemini App opens the start page, follows links (relative ones included), goes back, and follows redirects.
|
||||
- An input prompt (e.g. a search) takes a query and shows the results.
|
||||
- A changed certificate stops the page and asks.
|
||||
- `s` saves a page, `S` a page and its links; with Wi-Fi off, Saved Pages open and their saved links work.
|
||||
- Bookmarks are added with `b` and listed on the start page.
|
||||
- With IRC connected over TLS, a fetch still works, and the free heap stays above 40 KB.
|
||||
|
||||
## Work breakdown
|
||||
|
||||
1. **Two TLS connections:** measure the heap with IRC connected while a Gemini fetch runs.
|
||||
2. **Parsers** (host-tested): URL parsing and relative resolution, the response header, gemtext lines.
|
||||
3. **Fetch** on its own task, with TOFU and `gemini get`.
|
||||
4. **Gemini App:** rendering, scrolling, links, history, the address line.
|
||||
5. **Input prompts, redirects, bookmarks, downloads.**
|
||||
6. **Saved Pages,** then saving with linked pages.
|
||||
@@ -0,0 +1,59 @@
|
||||
# M2 — GNSS
|
||||
|
||||
**Status:** done on the device (branch `m2`): every "Done when" item below is met.
|
||||
|
||||
## Measured
|
||||
|
||||
- **Cold start** (`$PCAS10,2`) to a 3D Fix, by a window: **73 s**, 5 satellites used of 8 in view. A restart of the ESP32 alone keeps the receiver's Fix (the Cap stays powered).
|
||||
- By a window: 3D Fix from GPS, GLONASS, Galileo and BeiDou, up to 14 of 17 satellites used, HDOP 1.0–1.3.
|
||||
- **Heap, Debug Build, GNSS on, IRC on TLS** (floor 40 KB; v0.2.1 had a 79 KB low):
|
||||
|
||||
| | Free | Lowest |
|
||||
|---|---|---|
|
||||
| Start of M2 | 31 KB | 12.6 KB |
|
||||
| Stacks and buffers trimmed by measurement | 46 KB | 18 KB |
|
||||
| mDNS removed | 54 KB | 34 KB |
|
||||
| Framework rebuilt with smaller TLS buffers (ADR 0006) | **78 KB** | **59 KB** |
|
||||
|
||||
Under the heaviest combined load measured (IRC, two refused installs, a 1.6 MB put and get), the low is 46 KB. The cost had come mostly from the OTA and Debug Build work, not GNSS. Stacks were set to measured peak plus about 2 KB (loop 6 KB, update 5, storage 6, irc 6); after a TLS handshake the irc task has 1.7 KB left. IRC can now be stopped by hand (`/quit` in any state, `irc stop`), which frees its TLS memory.
|
||||
|
||||
**Goal:** the device knows where it is and what time it is without a network: a GNSS Service in the background, a GNSS App with the position and a sky view of the satellites, the clock set from satellites when there's no NTP, and Tracks recorded to the SD card.
|
||||
|
||||
**Hardware:** the Cap LoRa-1262 carries an ATGM336H-6N (AT6668), multi-constellation (GPS, BeiDou, Galileo, GLONASS, QZSS), with a ceramic antenna. NMEA over UART, 115200 8N1. **Measured (step 1, `gnss probe`): RX GPIO 15, TX GPIO 13, 115200 8N1**, as in Meshtastic's board file; M5Stack's page names GPIO 8 and 9, which are the internal I2C bus the keyboard controller sits on. Output is NMEA 4.10 style: `GN` RMC, VTG and GGA, one GSA per constellation with the system ID (1 GPS, 2 GLONASS, 3 Galileo, 4 BeiDou, 5 QZSS) in its last field, and a GSV sequence per constellation and signal (`GP`, `GL`, `GA`, …) with the signal ID last. RMC carries a time even without a Fix (status `V`), so only a Fix makes it trustworthy.
|
||||
|
||||
## Decisions (design round 2026-10-04)
|
||||
|
||||
| # | Decision |
|
||||
|---|---|
|
||||
| Q58 | Settings has a GNSS On/Off switch, **On by default**. Off puts the receiver in standby. *Measured:* `$PCAS12,<seconds>` (CASIC) stops its output within a second, for up to at least 65535 s, and any command wakes it within a second; Off sends `PCAS12,65535` (renewed hourly), On sends a hot start, `PCAS10,0`. |
|
||||
| Q59 | The **GNSS App** has two views, switched with Tab. *Position*: latitude, longitude, altitude, speed, course, Fix (none / 2D / 3D), satellites used and in view, HDOP, UTC time. *Sky*: the satellites placed by azimuth and elevation, coloured by constellation, filled when used in the Fix. |
|
||||
| Q60 | "Radar" in M2 means the Sky view. A radar of other Nodes by distance and bearing needs the mesh: M4. |
|
||||
| Q61 | The **Status Bar** shows a GNSS mark: absent when off, muted while searching, normal with a 2D Fix, with the satellite count with a 3D Fix. |
|
||||
| Q62 | GNSS time **sets the clock once there's a Fix**, and refreshes it every 10 minutes. *Revised in step 3:* the clock's trust order from M0 (Mesh < NTP < GNSS) already ranks GNSS above NTP, which is right: GNSS time is at least as accurate. So GNSS also corrects a clock NTP set, not only an unset one. |
|
||||
| Q63 | A **Track** is started and stopped in the GNSS App. It's written as GPX to `/gnss/tracks/<YYYYMMDD-HHMMSS>.gpx`, a point every 5 s when the position moved more than 5 m. It keeps recording with the App closed, with a Toast on start and stop and a Status Bar mark, and gets its own Storage Clean-up category. |
|
||||
| Q64 | Coordinates in **decimal degrees plus the Maidenhead locator**; a Settings switch for degrees, minutes and seconds. Metric units only. |
|
||||
| Q65 | **The position never leaves the device in M2.** Sharing it over the mesh, and at what precision, is decided in M4. |
|
||||
| Q66 | **Our own NMEA parser**, host-tested: RMC, GGA, GSA and GSV, with each talker ID mapped to its constellation. TinyGPSPlus (named in ADR 0001) doesn't track the satellite list across constellations, which the Sky view needs. |
|
||||
| Q67 | The receiver keeps its **defaults** (all constellations, 1 Hz). No receiver settings. Time to first fix is measured and recorded here. |
|
||||
| Q68 | Debug aids: `gnss status`, and `gnss nmea on/off` to stream the raw sentences to the console (USB serial and Debug Console). Raw NMEA is never written to the card. |
|
||||
|
||||
**Lesson (step 3):** the first probe also tried the pins swapped, driving the receiver's output line from the ESP32 for about a second. The receiver then went silent until a full power cycle (an ESP32 restart doesn't cut the Cap's power). Never drive GPIO 15.
|
||||
|
||||
## Done when
|
||||
|
||||
- The GNSS Service reads NMEA in the background whatever App is on screen, and a 3D Fix appears outdoors.
|
||||
- The GNSS App shows the Position and Sky views, both live.
|
||||
- The Status Bar shows the GNSS mark per Q61.
|
||||
- With no Wi-Fi, the clock is set from GNSS after the first Fix.
|
||||
- A Track records while the App is closed, survives the screen turning off, and opens as valid GPX on the PC.
|
||||
- Settings → GNSS Off stops it (and the Status Bar mark goes away); On brings it back.
|
||||
- Free heap stays above about 40 KB with GNSS, Wi-Fi, IRC on TLS and the UI running.
|
||||
|
||||
## Work breakdown
|
||||
|
||||
1. **Hardware check:** a `gnss probe` command reads the candidate UART pins and reports which carries NMEA, at what baud rate, and which talker IDs. Then the standby command (Q58) and a first time to first fix.
|
||||
2. **NMEA parser** (host-tested): checksum, RMC, GGA, GSA, GSV across constellations, merged into one GNSS state (Fix, position, time, satellites).
|
||||
3. **GNSS Service:** UART on its own task, the parser, `gnss status` and `gnss nmea`, Settings On/Off.
|
||||
4. **Clock from GNSS** (Q62), and the Status Bar mark (Q61).
|
||||
5. **GNSS App:** Position view, Maidenhead and coordinate formats (host-tested), then the Sky view.
|
||||
6. **Tracks:** the 5 s / 5 m rule and GPX writing (host-tested), background recording, Clean-up category.
|
||||
@@ -0,0 +1,69 @@
|
||||
# M3 — Radio bring-up: the LoRa Scanner
|
||||
|
||||
**Status:** done, tagged v0.6.0. Everything was checked on the device except one "Done when" item: Sweep was never tried against a known transmitter (see below). The listening hour heard nothing, so by Q104 **a reference Meshtastic node is a requirement for M4**.
|
||||
|
||||
**Goal:** the LoRa radio on the Cap works, receive only: a Radio Service owns it and shares the SPI bus with the SD card safely, and a LoRa Scanner App shows what's on the air, either packets (Sniffer) or energy across the band (Sweep). Nothing in M3 can transmit. The mesh comes on top of this in M4 (receive) and M5 (transmit).
|
||||
|
||||
**Hardware:** the Cap LoRa-1262 carries an SX1262 (868–923 MHz, +22 dBm) with an RP-SMA antenna. Pins, as in Meshtastic's board file for the Cardputer ADV: **NSS 5, RST 3, DIO1 (IRQ) 4, BUSY 6**, on the SPI bus shared with the microSD card (SCK 40, MISO 39, MOSI 14; card CS 12). Meshtastic uses DIO2 as the RF switch and DIO3 for a 1.8 V TCXO, marked optional. M5Stack's page adds an FM8625H antenna switch enabled by P0 of a PI4IOE5V6408 I/O expander on the internal I2C bus, address not given; Meshtastic doesn't mention it. Step 1 measures which is true.
|
||||
|
||||
**No other LoRa device yet.** meshmap.net (2026-10-05) lists two Meshtastic nodes within 10 km of the desk and six within 30 km, with positions blurred by a few km; none is known to be in range. M3 needs none: it only receives.
|
||||
|
||||
## Measured
|
||||
|
||||
- **Internal I2C bus (8/9):** 0x18 (ES8311 codec), 0x34 (TCA8418 keyboard), **0x43 (PI4IOE5V6408, ID register 0xA2)**, 0x69 (BMI270 IMU).
|
||||
- **The SX1262 answers** on NSS 5, RST 3, DIO1 4, BUSY 6. Its version string reads `SX1261 V2D 2D02`, which SX1262 chips report too. **The 1.8 V TCXO works** on the first try; the radio is ready 38 ms after `begin`.
|
||||
- **The expander's P0 connects the antenna; it's required.** At power-on P0 is an input (direction 0x00, high-impedance 0xFF), and the receiver reads a flat **-111.9 dBm** at 869.525 MHz, BW 250 kHz: the chip's own floor, deaf. With P0 driven high, the noise floor is **-87 to -94 dBm**: the antenna hearing the room. So the Radio Service drives P0 high at boot (Q91).
|
||||
- **DIO2 doesn't change reception** (within ±2 dB over three runs, P0 high). It likely selects TX versus RX in the FM8625H; it stays the RF switch, as in Meshtastic.
|
||||
- **The noise floor at the desk is high** (-87 to -94 dBm, varying run to run), about 25 dB above thermal noise for 250 kHz. Something nearby is loud, possibly the Cardputer itself or the PC; Sweep (step 5) should show where it sits.
|
||||
- **Step 2:** presets, frequencies and the channel hash are checked against Meshtastic's source (`MeshRadio.h`, `RadioInterface.cpp`): LongFast and the default key give hash 8, MediumFast 31, as Meshtastic shows. Captures were checked with TShark 4.2.5: every LoRaTap field reads back. Wireshark ignores the spec's quarter-dB packet RSSI below 0 dB SNR, so packet RSSI is plain dBm.
|
||||
- **Step 3:** the DIO1 interrupt works (a 100 ms receive timeout wakes the task after 105 ms). While listening: four 1.7 MB uploads and Gemini pages to the card, no radio or card errors (the card refuses a write about once in five uploads with the radio asleep too; `put` now catches it, and issue #21 follows the cause). The ring takes 9.8 KB while listening; the radio task's stack peaks at 2.0 KB.
|
||||
- **No packets yet, and a loud desk.** Twenty minutes on LongFast and on LoRaWAN's three uplink frequencies (SF7, SF9, SF12): no packet and no header, valid or not. The noise floor reads -83 to -94 dBm, against -112 dBm with the antenna switched off: 20 to 30 dB lost to something nearby, not the screen and not the GNSS receiver. Preamble detections are false alarms at this noise level (more on an empty frequency, 869.0 MHz, than on LongFast).
|
||||
- **Step 4:** a Capture made on the device reads back in TShark field for field (time, frequency, SF, RSSI, SNR, payload). A Capture keeps the radio listening with the App closed; stopping it puts the radio back to sleep.
|
||||
- **Step 5:** a pass across 863–870 MHz (71 steps, the strongest of three RSSI readings at each, measured at 125 kHz) takes about 607 ms. At the desk the band is **flat at -100 to -102 dBm**, about 15 dB above the chip's own floor at 125 kHz, with a steady carrier at 863.2 MHz (-89 dBm at its strongest) and fainter lines elsewhere: broadband noise from nearby electronics rather than a transmitter. Sweep's waterfall takes 2.6 KB while shown; 91.9 KB free during a Sweep. The radio task's stack peaks at 1.9 KB.
|
||||
- **Outside, on battery (step 6).** The noise is no lower than at the desk: a Sweep floor of -96 to -99 dBm (median -97) with Wi-Fi on, -99 to -100 with Wi-Fi off, so Wi-Fi accounts for 2 or 3 dB. The same narrow peaks come back on every pass, at 863.2, 863.6, 864.4, 864.8, 865.9, 866.3, 867.8, 869.0 and 869.4 MHz (-88 to -91 dBm), several of them 400 kHz apart; 869.4 MHz is the lower edge of LongFast's channel. A source that follows the device outside and onto its battery is the device: **about 15 dB of the floor is the Cardputer's own** (issue #20). At SF11 that puts the weakest decodable packet near -114 dBm on LongFast, against about -130 dBm for a quiet receiver.
|
||||
- **The listening hour (step 6, Q104):** 20:33 to 21:34 on 2026-10-05, outside, on battery, LongFast, with a Capture running. **0 packets, 0 headers**, 0 radio errors; noise -85 to -87 dBm at 250 kHz throughout; 860 preamble detections, all false alarms. The Capture holds its 24-byte header and nothing else. No restart in 1 h 10 min.
|
||||
- **Floors (Q86):** with the radio listening, Wi-Fi and IRC connected over TLS, 52.6 KB free (lowest 22.7 KB during the TLS handshake, the dip accepted in G1). Without IRC, 93 KB.
|
||||
- **Receive only:** nothing in `src` or `lib` calls a transmit function.
|
||||
- **Cost:** RadioLib 7.8.1 and the probe add 23.6 KB of flash and 656 bytes of static RAM to the release firmware (1,679,843 bytes of 3,342,336). The whole milestone: 51.8 KB of flash (1,708,091 bytes), 365 tests (27 new).
|
||||
|
||||
## Decisions (design round 2026-10-05)
|
||||
|
||||
| # | Decision |
|
||||
|---|---|
|
||||
| Q89 | **M3 is the radio only:** Radio Service, Sniffer, Sweep. Notes and the File Browser (Q30) move out to issue #3 and a Notes issue, as a later side milestone. |
|
||||
| Q90 | **RadioLib**, pinned (ADR 0001). SX1262 on NSS 5, RST 3, DIO1 4, BUSY 6; DIO2 as RF switch; TCXO at 1.8 V tried first, falling back to the crystal (Meshtastic's `TCXO_OPTIONAL`). |
|
||||
| Q91 | Step 1 is `lora probe`: chip status and version, which oscillator setting worked, and an I2C scan of the internal bus for the PI4IOE5V6408. If present, its P0 is set high at boot (harmless) and DIO2 stays the switch. A wrong switch receives deaf, so compare noise floors. |
|
||||
| Q92 | A **Radio Service** owns the SX1262: driver, bus lock, IRQ task. The LoRa Scanner uses it in M3; the Mesh Service sits on top of it in M4. |
|
||||
| Q93 | Every radio transfer takes the shared bus lock (`SPI.beginTransaction`, as the card does). DIO1's interrupt only wakes the task; no SPI in the ISR. **Done when** a Gemini page streams to the card while the Sniffer receives, with no lost packets and no card errors (`lora status` counters). |
|
||||
| Q94 | **Receive only:** the Radio Service has no transmit function in M3. It doesn't exist, rather than being unused. |
|
||||
| Q95 | Sniffer defaults: **EU868 LongFast**, 869.525 MHz, BW 250 kHz, SF 11, CR 4/5, sync word 0x2B, preamble 16 (Q19). The other Meshtastic presets are offered, plus custom settings. |
|
||||
| Q96 | The Sniffer lists packets (time, RSSI, SNR, frequency error, length; hex dump on Enter) **and decodes the Meshtastic header**: the first 16 bytes are never encrypted (destination, sender, packet ID, hop limit and hop start, channel hash, next hop, relay node). Host-tested. Payload decryption is M4. |
|
||||
| Q97 | A Sniffer **Capture** is pcap with **LoRaTap** headers (link type 270), for Wireshark. Started by hand, Status Bar mark, its own Clean-up category, the 90% rule. |
|
||||
| Q98 | **Sweep** steps across the Region's band (863–870 MHz) in 100 kHz steps by default, reading instant RSSI: bars with peak hold, and a waterfall, Wi-Fi Tools style. Optionally CAD on the preset's frequency to tell LoRa traffic from noise. |
|
||||
| Q99 | Sweep takes the radio and pauses the Sniffer, visibly (Q18). From M4 it pauses the Mesh Service the same way. |
|
||||
| Q100 | The Sniffer runs while the App is open **or a Capture is recording**; otherwise the radio sleeps. From M4 the Mesh Service keeps it on. |
|
||||
| Q101 | **Status Bar:** a radio mark while receiving, flashing on each packet; muted during a Sweep. |
|
||||
| Q102 | Debug aids: `lora status` (settings, counters, last RSSI/SNR, noise floor), `lora probe`, `lora rx on/off` (packets on the consoles). Raw packets are never written to the card outside a Capture. |
|
||||
| Q103 | A ring of the **last 32 packets** in RAM (about 9 KB at full length); older ones are dropped unless capturing. IRQ task stack trimmed by measurement; RadioLib's flash and RAM measured in step 1 against the floors. |
|
||||
| Q104 | **Done when** (below) includes an hour of listening on LongFast by a window. Real packets heard become M4 test fixtures. If none are heard, M3 still closes, and a reference Meshtastic node (Q21) becomes a requirement for M4. |
|
||||
|
||||
## Done when
|
||||
|
||||
- `lora probe` reports the SX1262, its oscillator setting and the RF switch arrangement, and the result is written here.
|
||||
- The Sniffer receives on LongFast with the App open or a Capture running, and the radio sleeps otherwise.
|
||||
- Sweep shows the noise floor across 863–870 MHz, and a known signal (a remote key fob, a 868 MHz sensor, anything) stands out. *Half met: the floor and the device's own steady peaks show; no known transmitter was tried.*
|
||||
- The shared-bus test passes (Q93): a Gemini page to the card while the Sniffer receives, no lost packets, no card errors.
|
||||
- A Capture opens in Wireshark with LoRaTap fields.
|
||||
- The Status Bar mark follows Q101.
|
||||
- One hour of LongFast listening by a window has been run and its result recorded here. *Run outside, on battery.*
|
||||
- Free heap stays above the floors (Q86) with the Sniffer, Wi-Fi, IRC on TLS and the UI running.
|
||||
- Nothing in the firmware can transmit.
|
||||
|
||||
## Work breakdown
|
||||
|
||||
1. **Hardware check:** RadioLib in the build, `lora probe` (Q91), flash and RAM cost measured.
|
||||
2. **Meshtastic header and LoRaTap** (host-tested): header parsing, presets and their radio settings, pcap/LoRaTap writing.
|
||||
3. **Radio Service:** receive on its own task behind the bus lock, the packet ring, `lora status` and `lora rx`, the shared-bus test.
|
||||
4. **LoRa Scanner App, Sniffer:** the packet list, details, preset choice, Captures, Status Bar mark.
|
||||
5. **Sweep:** the RSSI sweep, bars and waterfall, pausing the Sniffer.
|
||||
6. **Listening hour** and the measurements above, recorded here.
|
||||
@@ -8,7 +8,7 @@
|
||||
|---|---|
|
||||
| Q52 | Two sources: **push over Wi-Fi** from the PC, and **from the SD card**. Pulling from Gitea releases is deferred. |
|
||||
| Q53 | **Signed Update Files** (ECDSA P-256 over SHA-256). The private key stays in `~/.config/roro9stack/`, and the firmware embeds the public key (ADR 0003). |
|
||||
| Q54 | The device **always listens** for pushes on the LAN while Wi-Fi is Connected, announced as `roro9stack-<id>.local`. |
|
||||
| Q54 | The device **always listens** for pushes on the LAN while Wi-Fi is Connected. *Revised in M2:* it was announced over mDNS as `roro9stack-<id>.local`; mDNS was removed to save RAM (it never crossed the dev box's routed network anyway). Pushes go to the IP shown in Settings → Firmware. |
|
||||
| Q55 | New firmware runs on **Probation**. It's confirmed once booted, UI drawn, Services started, 30 s without a crash, and Wi-Fi connected (if configured). Otherwise **Rollback**. A Toast reports either outcome. |
|
||||
| Q56 | **Downgrades are allowed**, with "older than the installed version" shown. |
|
||||
| Q57 | A valid push **installs right away**: progress screen, then reboot. The reboot waits for Text Entry to end, 60 s at most. |
|
||||
|
||||
@@ -20,6 +20,7 @@ const RowDef kRows[] = {
|
||||
{Row::Region, Kind::Choice, "Region"}, {Row::Timezone, Kind::Choice, "Timezone"},
|
||||
{Row::Brightness, Kind::Slider, "Brightness"}, {Row::DimTimeout, Kind::Choice, "Dim after"},
|
||||
{Row::OffTimeout, Kind::Choice, "Screen off after"}, {Row::Sound, Kind::Toggle, "Sound & LED"},
|
||||
{Row::Gnss, Kind::Toggle, "GNSS"}, {Row::Coordinates, Kind::Toggle, "Coordinates"},
|
||||
{Row::ProbeMacs, Kind::Toggle, "Probe MACs"}, {Row::Wifi, Kind::Page, "Wi-Fi"},
|
||||
{Row::Storage, Kind::Page, "Storage"},
|
||||
{Row::Firmware, Kind::Page, "Firmware"},
|
||||
@@ -79,6 +80,8 @@ std::string SettingsMenu::value(int i) const {
|
||||
case Row::DimTimeout: return formatSeconds(settings_.getInt(Setting::DimTimeoutS));
|
||||
case Row::OffTimeout: return formatSeconds(settings_.getInt(Setting::OffTimeoutS));
|
||||
case Row::Sound: return settings_.getBool(Setting::Sound) ? "On" : "Off";
|
||||
case Row::Gnss: return settings_.getBool(Setting::GnssEnabled) ? "On" : "Off";
|
||||
case Row::Coordinates: return settings_.getBool(Setting::CoordinatesDms) ? "Deg min sec" : "Decimal";
|
||||
case Row::ProbeMacs: return settings_.getBool(Setting::ProbeMacRaw) ? "Raw" : "Pseudonymised";
|
||||
case Row::Wifi: return settings_.getBool(Setting::WifiEnabled) ? "On" : "Off";
|
||||
default: return "";
|
||||
@@ -122,6 +125,8 @@ std::string SettingsMenu::choose(int i, int c) {
|
||||
|
||||
void SettingsMenu::toggle(int i) {
|
||||
if (row(i) == Row::Sound) settings_.setBool(Setting::Sound, !settings_.getBool(Setting::Sound));
|
||||
if (row(i) == Row::Gnss) settings_.setBool(Setting::GnssEnabled, !settings_.getBool(Setting::GnssEnabled));
|
||||
if (row(i) == Row::Coordinates) settings_.setBool(Setting::CoordinatesDms, !settings_.getBool(Setting::CoordinatesDms));
|
||||
if (row(i) == Row::ProbeMacs) settings_.setBool(Setting::ProbeMacRaw, !settings_.getBool(Setting::ProbeMacRaw));
|
||||
}
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ namespace roro {
|
||||
// values, choice lists and validation messages. Rendering and navigation live in the App.
|
||||
class SettingsMenu {
|
||||
public:
|
||||
enum class Row { LongName, ShortName, Region, Timezone, Brightness, DimTimeout, OffTimeout, Sound, ProbeMacs, Wifi, Storage, Firmware, About };
|
||||
enum class Row { LongName, ShortName, Region, Timezone, Brightness, DimTimeout, OffTimeout, Sound, Gnss, Coordinates, ProbeMacs, Wifi, Storage, Firmware, About };
|
||||
enum class Kind { Text, Choice, Toggle, Slider, Page };
|
||||
|
||||
explicit SettingsMenu(Settings& settings) : settings_(settings) {}
|
||||
|
||||
@@ -0,0 +1,59 @@
|
||||
#include "gemini_response.h"
|
||||
|
||||
#include <cctype>
|
||||
|
||||
namespace roro::gemini {
|
||||
|
||||
namespace {
|
||||
std::string trim(const std::string& s) {
|
||||
size_t a = s.find_first_not_of(" \t"), b = s.find_last_not_of(" \t");
|
||||
return a == std::string::npos ? "" : s.substr(a, b - a + 1);
|
||||
}
|
||||
std::string lower(std::string s) {
|
||||
for (auto& c : s) c = static_cast<char>(std::tolower(static_cast<unsigned char>(c)));
|
||||
return s;
|
||||
}
|
||||
} // namespace
|
||||
|
||||
bool parseHeader(const std::string& line, Header& out) {
|
||||
if (line.size() < 2 || !std::isdigit(static_cast<unsigned char>(line[0])) ||
|
||||
!std::isdigit(static_cast<unsigned char>(line[1])))
|
||||
return false;
|
||||
if (line.size() > 2 && line[2] != ' ') return false;
|
||||
std::string meta = line.size() > 3 ? line.substr(3) : "";
|
||||
if (meta.size() > 1024) return false;
|
||||
out.status = (line[0] - '0') * 10 + (line[1] - '0');
|
||||
out.meta = meta;
|
||||
return true;
|
||||
}
|
||||
|
||||
Category Header::category() const {
|
||||
switch (status / 10) {
|
||||
case 1: return Category::Input;
|
||||
case 2: return Category::Success;
|
||||
case 3: return Category::Redirect;
|
||||
case 4: return Category::TemporaryFailure;
|
||||
case 5: return Category::PermanentFailure;
|
||||
case 6: return Category::ClientCertificate;
|
||||
default: return Category::Unknown;
|
||||
}
|
||||
}
|
||||
|
||||
std::string Header::mimeType() const {
|
||||
std::string type = lower(trim(meta.substr(0, meta.find(';'))));
|
||||
return type.empty() ? "text/gemini" : type;
|
||||
}
|
||||
|
||||
std::string Header::parameter(const std::string& name) const {
|
||||
size_t pos = meta.find(';');
|
||||
while (pos != std::string::npos) {
|
||||
size_t next = meta.find(';', pos + 1);
|
||||
std::string item = trim(meta.substr(pos + 1, next == std::string::npos ? std::string::npos : next - pos - 1));
|
||||
size_t eq = item.find('=');
|
||||
if (eq != std::string::npos && lower(trim(item.substr(0, eq))) == lower(name)) return trim(item.substr(eq + 1));
|
||||
pos = next;
|
||||
}
|
||||
return "";
|
||||
}
|
||||
|
||||
} // namespace roro::gemini
|
||||
@@ -0,0 +1,23 @@
|
||||
#pragma once
|
||||
|
||||
#include <string>
|
||||
|
||||
namespace roro::gemini {
|
||||
|
||||
enum class Category { Input, Success, Redirect, TemporaryFailure, PermanentFailure, ClientCertificate, Unknown };
|
||||
|
||||
// The response header: "<two digits> <meta>", at most 1024 bytes of meta.
|
||||
struct Header {
|
||||
int status = 0;
|
||||
std::string meta;
|
||||
|
||||
Category category() const;
|
||||
bool sensitiveInput() const { return status == 11; }
|
||||
// 2x: the MIME type, lower-cased, without parameters ("text/gemini" when meta is empty).
|
||||
std::string mimeType() const;
|
||||
std::string parameter(const std::string& name) const; // e.g. "charset"
|
||||
};
|
||||
|
||||
bool parseHeader(const std::string& line, Header& out);
|
||||
|
||||
} // namespace roro::gemini
|
||||
@@ -0,0 +1,215 @@
|
||||
#include "gemini_url.h"
|
||||
|
||||
#include <cctype>
|
||||
#include <cstdio>
|
||||
#include <cstdlib>
|
||||
#include <vector>
|
||||
|
||||
#include "storage_paths.h"
|
||||
|
||||
namespace roro::gemini {
|
||||
|
||||
namespace {
|
||||
|
||||
// RFC 3986, appendix B: ^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?
|
||||
struct Parts {
|
||||
std::string scheme, authority, path, query, fragment;
|
||||
bool hasScheme = false, hasAuthority = false, hasQuery = false, hasFragment = false;
|
||||
};
|
||||
|
||||
Parts split(const std::string& s) {
|
||||
Parts p;
|
||||
size_t i = 0;
|
||||
size_t colon = s.find(':');
|
||||
size_t stop = s.find_first_of("/?#");
|
||||
if (colon != std::string::npos && colon > 0 && (stop == std::string::npos || colon < stop)) {
|
||||
p.scheme = s.substr(0, colon);
|
||||
p.hasScheme = true;
|
||||
i = colon + 1;
|
||||
}
|
||||
if (s.compare(i, 2, "//") == 0) {
|
||||
size_t end = s.find_first_of("/?#", i + 2);
|
||||
if (end == std::string::npos) end = s.size();
|
||||
p.authority = s.substr(i + 2, end - i - 2);
|
||||
p.hasAuthority = true;
|
||||
i = end;
|
||||
}
|
||||
size_t end = s.find_first_of("?#", i);
|
||||
if (end == std::string::npos) end = s.size();
|
||||
p.path = s.substr(i, end - i);
|
||||
i = end;
|
||||
if (i < s.size() && s[i] == '?') {
|
||||
end = s.find('#', i);
|
||||
if (end == std::string::npos) end = s.size();
|
||||
p.query = s.substr(i + 1, end - i - 1);
|
||||
p.hasQuery = true;
|
||||
i = end;
|
||||
}
|
||||
if (i < s.size() && s[i] == '#') {
|
||||
p.fragment = s.substr(i + 1);
|
||||
p.hasFragment = true;
|
||||
}
|
||||
return p;
|
||||
}
|
||||
|
||||
std::string lower(std::string s) {
|
||||
for (auto& c : s) c = static_cast<char>(std::tolower(static_cast<unsigned char>(c)));
|
||||
return s;
|
||||
}
|
||||
|
||||
// RFC 3986, section 5.2.4.
|
||||
std::string removeDotSegments(std::string in) {
|
||||
std::string out;
|
||||
while (!in.empty()) {
|
||||
if (in.compare(0, 3, "../") == 0) in.erase(0, 3);
|
||||
else if (in.compare(0, 2, "./") == 0) in.erase(0, 2);
|
||||
else if (in.compare(0, 3, "/./") == 0) in.replace(0, 3, "/");
|
||||
else if (in == "/.") in = "/";
|
||||
else if (in.compare(0, 4, "/../") == 0 || in == "/..") {
|
||||
in = in == "/.." ? "/" : in.substr(3);
|
||||
size_t slash = out.rfind('/');
|
||||
out.erase(slash == std::string::npos ? 0 : slash);
|
||||
} else if (in == "." || in == "..") in.clear();
|
||||
else {
|
||||
size_t next = in.find('/', in[0] == '/' ? 1 : 0);
|
||||
if (next == std::string::npos) next = in.size();
|
||||
out += in.substr(0, next);
|
||||
in.erase(0, next);
|
||||
}
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
// RFC 3986, section 5.2.3.
|
||||
std::string merge(const Parts& base, const std::string& refPath) {
|
||||
if (base.hasAuthority && base.path.empty()) return "/" + refPath;
|
||||
size_t slash = base.path.rfind('/');
|
||||
return slash == std::string::npos ? refPath : base.path.substr(0, slash + 1) + refPath;
|
||||
}
|
||||
|
||||
// RFC 3986, section 5.3.
|
||||
std::string recompose(const Parts& p) {
|
||||
std::string out;
|
||||
if (p.hasScheme) out += p.scheme + ":";
|
||||
if (p.hasAuthority) out += "//" + p.authority;
|
||||
out += p.path;
|
||||
if (p.hasQuery) out += "?" + p.query;
|
||||
if (p.hasFragment) out += "#" + p.fragment;
|
||||
return out;
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
bool parseUrl(const std::string& text, Url& out) {
|
||||
Parts p = split(text);
|
||||
if (!p.hasScheme || !p.hasAuthority) return false;
|
||||
out = Url();
|
||||
out.scheme = lower(p.scheme);
|
||||
out.authority = p.authority;
|
||||
std::string hostPort = p.authority.substr(p.authority.find('@') == std::string::npos ? 0 : p.authority.find('@') + 1);
|
||||
size_t colon = hostPort.rfind(':');
|
||||
if (colon != std::string::npos && hostPort.find(']', colon) == std::string::npos) {
|
||||
out.port = std::atoi(hostPort.c_str() + colon + 1);
|
||||
hostPort = hostPort.substr(0, colon);
|
||||
}
|
||||
out.host = lower(hostPort);
|
||||
if (out.host.empty()) return false;
|
||||
out.path = p.path;
|
||||
out.query = p.query;
|
||||
out.fragment = p.fragment;
|
||||
out.hasAuthority = true;
|
||||
out.hasQuery = p.hasQuery;
|
||||
out.hasFragment = p.hasFragment;
|
||||
return true;
|
||||
}
|
||||
|
||||
bool isGemini(const std::string& url) {
|
||||
Parts p = split(url);
|
||||
return p.hasScheme && lower(p.scheme) == "gemini";
|
||||
}
|
||||
|
||||
std::string resolve(const std::string& baseText, const std::string& refText) {
|
||||
Parts base = split(baseText), r = split(refText), t;
|
||||
if (r.hasScheme) {
|
||||
t = r;
|
||||
t.path = removeDotSegments(r.path);
|
||||
} else {
|
||||
if (r.hasAuthority) {
|
||||
t.authority = r.authority;
|
||||
t.hasAuthority = true;
|
||||
t.path = removeDotSegments(r.path);
|
||||
t.query = r.query;
|
||||
t.hasQuery = r.hasQuery;
|
||||
} else {
|
||||
if (r.path.empty()) {
|
||||
t.path = base.path;
|
||||
t.query = r.hasQuery ? r.query : base.query;
|
||||
t.hasQuery = r.hasQuery || base.hasQuery;
|
||||
} else {
|
||||
t.path = removeDotSegments(r.path[0] == '/' ? r.path : merge(base, r.path));
|
||||
t.query = r.query;
|
||||
t.hasQuery = r.hasQuery;
|
||||
}
|
||||
t.authority = base.authority;
|
||||
t.hasAuthority = base.hasAuthority;
|
||||
}
|
||||
t.scheme = base.scheme;
|
||||
t.hasScheme = base.hasScheme;
|
||||
}
|
||||
t.fragment = r.fragment;
|
||||
t.hasFragment = r.hasFragment;
|
||||
return recompose(t);
|
||||
}
|
||||
|
||||
std::string requestUrl(const std::string& url) {
|
||||
Url u;
|
||||
if (!parseUrl(url, u)) return url;
|
||||
std::string out = u.scheme + "://" + u.host;
|
||||
if (u.port > 0 && u.port != 1965) out += ":" + std::to_string(u.port);
|
||||
out += u.path.empty() ? "/" : u.path;
|
||||
if (u.hasQuery) out += "?" + u.query;
|
||||
return out;
|
||||
}
|
||||
|
||||
std::string encodeQuery(const std::string& text) {
|
||||
std::string out;
|
||||
for (unsigned char c : text) {
|
||||
if (std::isalnum(c) || c == '-' || c == '_' || c == '.' || c == '~') out += static_cast<char>(c);
|
||||
else {
|
||||
char buf[4];
|
||||
std::snprintf(buf, sizeof buf, "%%%02X", c);
|
||||
out += buf;
|
||||
}
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
std::string savedPath(const std::string& url) {
|
||||
Url u;
|
||||
if (!parseUrl(url, u)) return "/gemini/saved/unknown.gmi";
|
||||
std::string out = "/gemini/saved/" + storage::sanitize(u.host + (u.port > 0 && u.port != 1965 ? "_" + std::to_string(u.port) : ""));
|
||||
std::string path = u.path.empty() ? "/" : u.path;
|
||||
std::vector<std::string> parts;
|
||||
size_t start = 1;
|
||||
while (start <= path.size()) {
|
||||
size_t slash = path.find('/', start);
|
||||
if (slash == std::string::npos) slash = path.size();
|
||||
parts.push_back(path.substr(start, slash - start));
|
||||
start = slash + 1;
|
||||
}
|
||||
if (parts.empty() || parts.back().empty()) {
|
||||
if (!parts.empty()) parts.pop_back();
|
||||
parts.push_back("index");
|
||||
}
|
||||
for (size_t i = 0; i < parts.size(); i++) {
|
||||
std::string name = parts[i];
|
||||
if (i + 1 == parts.size()) {
|
||||
if (u.hasQuery) name += "~" + u.query;
|
||||
if (name.size() < 4 || name.compare(name.size() - 4, 4, ".gmi") != 0) name += ".gmi";
|
||||
}
|
||||
out += "/" + storage::sanitize(name);
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
} // namespace roro::gemini
|
||||
@@ -0,0 +1,28 @@
|
||||
#pragma once
|
||||
|
||||
#include <string>
|
||||
|
||||
namespace roro::gemini {
|
||||
|
||||
// A URL split per RFC 3986 (appendix B). For Gemini, the host is lower-cased and the port
|
||||
// defaults to 1965.
|
||||
struct Url {
|
||||
std::string scheme, authority, host, path, query, fragment;
|
||||
int port = -1;
|
||||
bool hasAuthority = false, hasQuery = false, hasFragment = false;
|
||||
int portOrDefault() const { return port > 0 ? port : 1965; }
|
||||
};
|
||||
|
||||
// False unless it has a scheme and a host: only absolute URLs are fetched.
|
||||
bool parseUrl(const std::string& text, Url& out);
|
||||
bool isGemini(const std::string& url);
|
||||
// `ref` against `base`, per RFC 3986 section 5.2 (dot segments included).
|
||||
std::string resolve(const std::string& base, const std::string& ref);
|
||||
// What goes on the wire: no fragment, lower-case host, never an empty path.
|
||||
std::string requestUrl(const std::string& url);
|
||||
// For input prompts: everything but unreserved characters percent-encoded (UTF-8 bytes).
|
||||
std::string encodeQuery(const std::string& text);
|
||||
// Where a Saved Page lives (Q82): /gemini/saved/<host>[_<port>]/<path>[~<query>].gmi
|
||||
std::string savedPath(const std::string& url);
|
||||
|
||||
} // namespace roro::gemini
|
||||
@@ -0,0 +1,100 @@
|
||||
#include "gemtext.h"
|
||||
|
||||
#include <cstdint>
|
||||
|
||||
namespace roro::gemini {
|
||||
|
||||
namespace {
|
||||
std::string trim(const std::string& s) {
|
||||
size_t a = s.find_first_not_of(" \t"), b = s.find_last_not_of(" \t");
|
||||
return a == std::string::npos ? "" : s.substr(a, b - a + 1);
|
||||
}
|
||||
} // namespace
|
||||
|
||||
GemLine parseGemLine(const std::string& line, bool& pre) {
|
||||
GemLine g;
|
||||
if (line.compare(0, 3, "```") == 0) {
|
||||
g.type = LineType::PreToggle;
|
||||
g.text = trim(line.substr(3));
|
||||
pre = !pre;
|
||||
} else if (pre) {
|
||||
g.type = LineType::Preformatted;
|
||||
g.text = line;
|
||||
} else if (line.compare(0, 2, "=>") == 0) {
|
||||
g.type = LineType::Link;
|
||||
std::string rest = trim(line.substr(2));
|
||||
size_t gap = rest.find_first_of(" \t");
|
||||
g.url = rest.substr(0, gap);
|
||||
g.text = gap == std::string::npos ? "" : trim(rest.substr(gap));
|
||||
if (g.text.empty()) g.text = g.url;
|
||||
} else if (line.compare(0, 3, "###") == 0) {
|
||||
g.type = LineType::Heading3;
|
||||
g.text = trim(line.substr(3));
|
||||
} else if (line.compare(0, 2, "##") == 0) {
|
||||
g.type = LineType::Heading2;
|
||||
g.text = trim(line.substr(2));
|
||||
} else if (line.compare(0, 1, "#") == 0) {
|
||||
g.type = LineType::Heading1;
|
||||
g.text = trim(line.substr(1));
|
||||
} else if (line.compare(0, 2, "* ") == 0) {
|
||||
g.type = LineType::ListItem;
|
||||
g.text = trim(line.substr(2));
|
||||
} else if (line.compare(0, 1, ">") == 0) {
|
||||
g.type = LineType::Quote;
|
||||
g.text = trim(line.substr(1));
|
||||
} else {
|
||||
g.text = line;
|
||||
}
|
||||
return g;
|
||||
}
|
||||
|
||||
std::vector<GemLine> parseGemtext(const std::string& document) {
|
||||
std::vector<GemLine> lines;
|
||||
bool pre = false;
|
||||
size_t start = 0;
|
||||
while (start < document.size()) {
|
||||
size_t end = document.find('\n', start);
|
||||
if (end == std::string::npos) end = document.size();
|
||||
std::string line = document.substr(start, end - start);
|
||||
if (!line.empty() && line.back() == '\r') line.pop_back();
|
||||
start = end + 1;
|
||||
lines.push_back(parseGemLine(line, pre));
|
||||
}
|
||||
return lines;
|
||||
}
|
||||
|
||||
std::string displayText(const std::string& s) {
|
||||
std::string out;
|
||||
size_t column = 0;
|
||||
for (size_t i = 0; i < s.size();) {
|
||||
unsigned char c = static_cast<unsigned char>(s[i]);
|
||||
if (c == '\t') {
|
||||
do out += ' ';
|
||||
while (++column % 4);
|
||||
i++;
|
||||
continue;
|
||||
}
|
||||
if (c < 0x80) {
|
||||
out += static_cast<char>(c);
|
||||
i++;
|
||||
} else {
|
||||
int len = (c & 0xE0) == 0xC0 ? 2 : (c & 0xF0) == 0xE0 ? 3 : (c & 0xF8) == 0xF0 ? 4 : 0;
|
||||
bool valid = len > 0 && i + len <= s.size();
|
||||
for (int k = 1; valid && k < len; k++) valid = (static_cast<unsigned char>(s[i + k]) & 0xC0) == 0x80;
|
||||
if (!valid) {
|
||||
out += '?';
|
||||
i++;
|
||||
} else {
|
||||
uint32_t cp = len == 2 ? (c & 0x1F) : len == 3 ? (c & 0x0F) : (c & 0x07);
|
||||
for (int k = 1; k < len; k++) cp = (cp << 6) | (static_cast<unsigned char>(s[i + k]) & 0x3F);
|
||||
if (cp <= 0xFF) out.append(s, i, len); // Latin-1: the fonts have it
|
||||
else out += '?';
|
||||
i += len;
|
||||
}
|
||||
}
|
||||
column++;
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
} // namespace roro::gemini
|
||||
@@ -0,0 +1,25 @@
|
||||
#pragma once
|
||||
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
namespace roro::gemini {
|
||||
|
||||
enum class LineType { Text, Link, Heading1, Heading2, Heading3, ListItem, Quote, PreToggle, Preformatted };
|
||||
|
||||
// One gemtext line. Link: `url` and its label in `text` (the URL itself without a label).
|
||||
// PreToggle: the ``` line, with its alt text. Preformatted: kept exactly.
|
||||
struct GemLine {
|
||||
LineType type = LineType::Text;
|
||||
std::string text, url;
|
||||
};
|
||||
|
||||
// One line; `preformatted` carries the ``` state from line to line (start with false).
|
||||
GemLine parseGemLine(const std::string& line, bool& preformatted);
|
||||
std::vector<GemLine> parseGemtext(const std::string& document);
|
||||
|
||||
// For the Latin-1 fonts (Q79): valid UTF-8 up to U+00FF kept, anything else '?', and tabs
|
||||
// expanded to 4-column stops.
|
||||
std::string displayText(const std::string& utf8);
|
||||
|
||||
} // namespace roro::gemini
|
||||
@@ -0,0 +1,47 @@
|
||||
#include "text_buffer.h"
|
||||
|
||||
#include <algorithm>
|
||||
|
||||
namespace roro::gemini {
|
||||
|
||||
void TextBuffer::append(const char* data, size_t len) {
|
||||
bytes_ += len;
|
||||
for (size_t i = 0; i < len; i++) {
|
||||
if (data[i] == '\n') endLine();
|
||||
else partial_ += data[i];
|
||||
}
|
||||
}
|
||||
|
||||
void TextBuffer::finish() {
|
||||
if (!partial_.empty()) endLine();
|
||||
}
|
||||
|
||||
void TextBuffer::endLine() {
|
||||
if (!partial_.empty() && partial_.back() == '\r') partial_.pop_back();
|
||||
size_t len = std::min<size_t>(partial_.size(), 0xFFFF);
|
||||
// A line never spans two chunks: a new chunk when it doesn't fit (bigger if the line is).
|
||||
if (chunks_.empty() || chunks_.back().size() + len > chunks_.back().capacity()) {
|
||||
chunks_.emplace_back();
|
||||
chunks_.back().reserve(std::max(kChunk, len));
|
||||
}
|
||||
std::string& chunk = chunks_.back();
|
||||
lines_.push_back({static_cast<uint16_t>(chunks_.size() - 1), static_cast<uint16_t>(chunk.size()),
|
||||
static_cast<uint16_t>(len)});
|
||||
chunk.append(partial_, 0, len);
|
||||
partial_.clear();
|
||||
}
|
||||
|
||||
std::string TextBuffer::line(size_t i) const {
|
||||
if (i >= lines_.size()) return "";
|
||||
const Ref& r = lines_[i];
|
||||
return chunks_[r.chunk].substr(r.offset, r.length);
|
||||
}
|
||||
|
||||
void TextBuffer::clear() {
|
||||
chunks_.clear();
|
||||
lines_.clear();
|
||||
partial_.clear();
|
||||
bytes_ = 0;
|
||||
}
|
||||
|
||||
} // namespace roro::gemini
|
||||
@@ -0,0 +1,38 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstddef>
|
||||
#include <cstdint>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
namespace roro::gemini {
|
||||
|
||||
// A page's text, kept as lines in 4 KB chunks: no large contiguous block (with IRC connected the
|
||||
// largest free block is about 31 KB) and no copy when it grows. About 4 bytes per line on top of
|
||||
// the text itself. Bytes are fed as they arrive; lines end at LF, a CR before it is dropped.
|
||||
class TextBuffer {
|
||||
public:
|
||||
static constexpr size_t kChunk = 4096;
|
||||
|
||||
void append(const char* data, size_t len);
|
||||
void finish(); // the last line, if it has no line end
|
||||
size_t lineCount() const { return lines_.size(); }
|
||||
std::string line(size_t i) const;
|
||||
size_t bytes() const { return bytes_; }
|
||||
void clear();
|
||||
|
||||
private:
|
||||
struct Ref {
|
||||
uint16_t chunk;
|
||||
uint16_t offset;
|
||||
uint16_t length;
|
||||
};
|
||||
void endLine();
|
||||
|
||||
std::vector<std::string> chunks_;
|
||||
std::vector<Ref> lines_;
|
||||
std::string partial_; // the line being received
|
||||
size_t bytes_ = 0;
|
||||
};
|
||||
|
||||
} // namespace roro::gemini
|
||||
@@ -0,0 +1,50 @@
|
||||
#include "geo_format.h"
|
||||
|
||||
#include <cmath>
|
||||
#include <cstdio>
|
||||
|
||||
namespace roro::gnss {
|
||||
|
||||
namespace {
|
||||
const char* hemisphere(double degrees, bool latitude) {
|
||||
return latitude ? (degrees < 0 ? "S" : "N") : (degrees < 0 ? "W" : "E");
|
||||
}
|
||||
} // namespace
|
||||
|
||||
std::string formatDecimal(double degrees, bool latitude) {
|
||||
char buf[32];
|
||||
std::snprintf(buf, sizeof buf, "%.5f\xC2\xB0 %s", std::fabs(degrees), hemisphere(degrees, latitude));
|
||||
return buf;
|
||||
}
|
||||
|
||||
std::string formatDms(double degrees, bool latitude) {
|
||||
// Work in tenths of a second, so rounding carries into minutes and degrees.
|
||||
long tenths = std::lround(std::fabs(degrees) * 36000.0);
|
||||
long d = tenths / 36000, m = tenths / 600 % 60, s10 = tenths % 600;
|
||||
char buf[40];
|
||||
std::snprintf(buf, sizeof buf, "%ld\xC2\xB0 %02ld' %02ld.%ld\" %s", d, m, s10 / 10, s10 % 10,
|
||||
hemisphere(degrees, latitude));
|
||||
return buf;
|
||||
}
|
||||
|
||||
std::string maidenhead(double latitude, double longitude) {
|
||||
double lon = std::fmin(std::fmax(longitude + 180.0, 0.0), 359.999999);
|
||||
double lat = std::fmin(std::fmax(latitude + 90.0, 0.0), 179.999999);
|
||||
std::string out;
|
||||
out += static_cast<char>('A' + static_cast<int>(lon / 20));
|
||||
out += static_cast<char>('A' + static_cast<int>(lat / 10));
|
||||
out += static_cast<char>('0' + static_cast<int>(std::fmod(lon, 20) / 2));
|
||||
out += static_cast<char>('0' + static_cast<int>(std::fmod(lat, 10)));
|
||||
out += static_cast<char>('a' + static_cast<int>(std::fmod(lon, 2) * 12));
|
||||
out += static_cast<char>('a' + static_cast<int>(std::fmod(lat, 1) * 24));
|
||||
return out;
|
||||
}
|
||||
|
||||
SkyPoint skyPosition(int azimuthDeg, int elevationDeg, int cx, int cy, int radius) {
|
||||
int elevation = elevationDeg < 0 ? 0 : elevationDeg > 90 ? 90 : elevationDeg;
|
||||
double r = radius * (90 - elevation) / 90.0;
|
||||
double az = azimuthDeg * M_PI / 180.0;
|
||||
return {cx + static_cast<int>(std::lround(r * std::sin(az))), cy - static_cast<int>(std::lround(r * std::cos(az)))};
|
||||
}
|
||||
|
||||
} // namespace roro::gnss
|
||||
@@ -0,0 +1,21 @@
|
||||
#pragma once
|
||||
|
||||
#include <string>
|
||||
|
||||
namespace roro::gnss {
|
||||
|
||||
// "50.86920° N": five decimals, about a metre.
|
||||
std::string formatDecimal(double degrees, bool latitude);
|
||||
// "50° 52' 09.1\" N" (Settings → Coordinates, Q64).
|
||||
std::string formatDms(double degrees, bool latitude);
|
||||
// The 6-character Maidenhead locator ("JO20ef"), as radio amateurs give their square.
|
||||
std::string maidenhead(double latitude, double longitude);
|
||||
|
||||
// Where a satellite goes on the Sky view: the zenith in the centre, the horizon on the circle,
|
||||
// north up and east right (as seen looking at the sky from above, like a map).
|
||||
struct SkyPoint {
|
||||
int x, y;
|
||||
};
|
||||
SkyPoint skyPosition(int azimuthDeg, int elevationDeg, int cx, int cy, int radius);
|
||||
|
||||
} // namespace roro::gnss
|
||||
@@ -0,0 +1,234 @@
|
||||
#include "nmea_parser.h"
|
||||
|
||||
#include <cstdlib>
|
||||
|
||||
namespace roro::gnss {
|
||||
|
||||
namespace {
|
||||
|
||||
constexpr double kKmhPerKnot = 1.852;
|
||||
|
||||
int hexValue(char c) {
|
||||
if (c >= '0' && c <= '9') return c - '0';
|
||||
if (c >= 'A' && c <= 'F') return c - 'A' + 10;
|
||||
if (c >= 'a' && c <= 'f') return c - 'a' + 10;
|
||||
return -1;
|
||||
}
|
||||
|
||||
Constellation fromTalker(const std::string& t) {
|
||||
if (t == "GP") return Constellation::Gps;
|
||||
if (t == "GL") return Constellation::Glonass;
|
||||
if (t == "GA") return Constellation::Galileo;
|
||||
if (t == "GB" || t == "BD") return Constellation::BeiDou;
|
||||
if (t == "GQ" || t == "QZ") return Constellation::Qzss;
|
||||
if (t == "GI") return Constellation::Navic;
|
||||
return Constellation::Unknown; // GN: combined
|
||||
}
|
||||
|
||||
// GSA's system ID field (NMEA 4.10).
|
||||
Constellation fromSystemId(int id) {
|
||||
switch (id) {
|
||||
case 1: return Constellation::Gps;
|
||||
case 2: return Constellation::Glonass;
|
||||
case 3: return Constellation::Galileo;
|
||||
case 4: return Constellation::BeiDou;
|
||||
case 5: return Constellation::Qzss;
|
||||
case 6: return Constellation::Navic;
|
||||
default: return Constellation::Unknown;
|
||||
}
|
||||
}
|
||||
|
||||
bool number(const std::string& s, double& out) {
|
||||
if (s.empty()) return false;
|
||||
char* end;
|
||||
out = std::strtod(s.c_str(), &end);
|
||||
return *end == '\0';
|
||||
}
|
||||
|
||||
int integer(const std::string& s, int fallback = 0) {
|
||||
double v;
|
||||
return number(s, v) ? static_cast<int>(v) : fallback;
|
||||
}
|
||||
|
||||
// "ddmm.mmmm" / "dddmm.mmmm" with its hemisphere letter.
|
||||
bool coordinate(const std::string& value, const std::string& hemisphere, double& out) {
|
||||
double raw;
|
||||
if (!number(value, raw) || hemisphere.empty()) return false;
|
||||
int degrees = static_cast<int>(raw / 100);
|
||||
out = degrees + (raw - degrees * 100) / 60.0;
|
||||
if (hemisphere == "S" || hemisphere == "W") out = -out;
|
||||
return true;
|
||||
}
|
||||
|
||||
// Days since 1970-01-01 for a civil date (Howard Hinnant's algorithm).
|
||||
int64_t daysFromCivil(int y, int m, int d) {
|
||||
y -= m <= 2;
|
||||
const int64_t era = (y >= 0 ? y : y - 399) / 400;
|
||||
const unsigned yoe = static_cast<unsigned>(y - era * 400);
|
||||
const unsigned doy = (153 * (m + (m > 2 ? -3 : 9)) + 2) / 5 + d - 1;
|
||||
const unsigned doe = yoe * 365 + yoe / 4 - yoe / 100 + doy;
|
||||
return era * 146097 + static_cast<int64_t>(doe) - 719468;
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
const char* constellationName(Constellation c) {
|
||||
switch (c) {
|
||||
case Constellation::Gps: return "GPS";
|
||||
case Constellation::Glonass: return "GLONASS";
|
||||
case Constellation::Galileo: return "Galileo";
|
||||
case Constellation::BeiDou: return "BeiDou";
|
||||
case Constellation::Qzss: return "QZSS";
|
||||
case Constellation::Navic: return "NavIC";
|
||||
default: return "?";
|
||||
}
|
||||
}
|
||||
|
||||
int64_t GnssState::utcSeconds() const {
|
||||
return daysFromCivil(year, month, day) * 86400 + hour * 3600 + minute * 60 + second;
|
||||
}
|
||||
|
||||
void NmeaParser::feed(const char* data, size_t len) {
|
||||
for (size_t i = 0; i < len; i++) {
|
||||
char c = data[i];
|
||||
if (c == '\n') {
|
||||
if (!overflow_ && !line_.empty()) {
|
||||
if (onLine) onLine(line_);
|
||||
sentence(line_);
|
||||
}
|
||||
line_.clear();
|
||||
overflow_ = false;
|
||||
} else if (c != '\r') {
|
||||
if (line_.size() >= kMaxLine) overflow_ = true;
|
||||
else line_ += c;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
bool NmeaParser::sentence(const std::string& line) {
|
||||
size_t star = line.rfind('*');
|
||||
if (line.size() < 7 || line[0] != '$' || star == std::string::npos || star + 3 != line.size()) {
|
||||
bad_++;
|
||||
return false;
|
||||
}
|
||||
uint8_t sum = 0;
|
||||
for (size_t i = 1; i < star; i++) sum ^= static_cast<uint8_t>(line[i]);
|
||||
int hi = hexValue(line[star + 1]), lo = hexValue(line[star + 2]);
|
||||
if (hi < 0 || lo < 0 || sum != (hi << 4 | lo)) {
|
||||
bad_++;
|
||||
return false;
|
||||
}
|
||||
good_++;
|
||||
|
||||
Fields f;
|
||||
size_t start = 1;
|
||||
for (size_t i = 1; i <= star; i++)
|
||||
if (i == star || line[i] == ',') {
|
||||
f.push_back(line.substr(start, i - start));
|
||||
start = i + 1;
|
||||
}
|
||||
if (f[0].size() < 5) return true;
|
||||
std::string talker = f[0].substr(0, 2), type = f[0].substr(f[0].size() - 3);
|
||||
if (type == "RMC") rmc(f);
|
||||
else if (type == "GGA") gga(f);
|
||||
else if (type == "GSA") gsa(f, fromTalker(talker));
|
||||
else if (type == "GSV") gsv(f, fromTalker(talker));
|
||||
return true;
|
||||
}
|
||||
|
||||
void NmeaParser::rmc(const Fields& f) {
|
||||
if (f.size() < 10) return;
|
||||
bool active = f[2] == "A";
|
||||
double lat, lon;
|
||||
state_.positionValid = active && coordinate(f[3], f[4], lat) && coordinate(f[5], f[6], lon);
|
||||
if (state_.positionValid) {
|
||||
state_.latitude = lat;
|
||||
state_.longitude = lon;
|
||||
}
|
||||
double knots, course;
|
||||
state_.speedKmh = active && number(f[7], knots) ? static_cast<float>(knots * kKmhPerKnot) : 0;
|
||||
state_.courseValid = active && number(f[8], course);
|
||||
if (state_.courseValid) state_.courseDeg = static_cast<float>(course);
|
||||
|
||||
const std::string &t = f[1], &d = f[9];
|
||||
state_.timeValid = active && t.size() >= 6 && d.size() == 6;
|
||||
if (state_.timeValid) {
|
||||
state_.hour = integer(t.substr(0, 2));
|
||||
state_.minute = integer(t.substr(2, 2));
|
||||
state_.second = integer(t.substr(4, 2));
|
||||
state_.day = integer(d.substr(0, 2));
|
||||
state_.month = integer(d.substr(2, 2));
|
||||
state_.year = 2000 + integer(d.substr(4, 2));
|
||||
}
|
||||
}
|
||||
|
||||
void NmeaParser::gga(const Fields& f) {
|
||||
if (f.size() < 10) return;
|
||||
int quality = integer(f[6]);
|
||||
double lat, lon, hdop, alt;
|
||||
state_.positionValid = quality > 0 && coordinate(f[2], f[3], lat) && coordinate(f[4], f[5], lon);
|
||||
if (state_.positionValid) {
|
||||
state_.latitude = lat;
|
||||
state_.longitude = lon;
|
||||
}
|
||||
state_.satellitesUsed = integer(f[7]);
|
||||
if (number(f[8], hdop)) state_.hdop = static_cast<float>(hdop);
|
||||
state_.altitudeValid = quality > 0 && number(f[9], alt);
|
||||
if (state_.altitudeValid) state_.altitudeM = static_cast<float>(alt);
|
||||
}
|
||||
|
||||
void NmeaParser::gsa(const Fields& f, Constellation talker) {
|
||||
if (f.size() < 18) return;
|
||||
int mode = integer(f[2], 1);
|
||||
state_.fix = mode == 3 ? FixType::ThreeD : mode == 2 ? FixType::TwoD : FixType::None;
|
||||
Constellation system = f.size() > 18 ? fromSystemId(integer(f[18])) : talker;
|
||||
if (system == Constellation::Unknown) return; // can't tell whose satellites these are
|
||||
std::set<int>& used = used_[static_cast<int>(system)];
|
||||
used.clear();
|
||||
for (size_t i = 3; i <= 14; i++)
|
||||
if (!f[i].empty()) used.insert(integer(f[i]));
|
||||
rebuildSatellites();
|
||||
}
|
||||
|
||||
void NmeaParser::gsv(const Fields& f, Constellation talker) {
|
||||
if (f.size() < 4 || talker == Constellation::Unknown) return;
|
||||
int total = integer(f[1]), number = integer(f[2]);
|
||||
size_t extra = f.size() - 4;
|
||||
int signal = extra % 4 == 1 ? integer(f.back()) : 0; // NMEA 4.10 signal ID, last
|
||||
auto key = std::make_pair(static_cast<int>(talker), signal);
|
||||
std::vector<Satellite>& pending = pending_[key];
|
||||
if (number == 1) pending.clear();
|
||||
for (size_t i = 4; i + 3 < f.size(); i += 4) {
|
||||
Satellite s;
|
||||
s.system = talker;
|
||||
s.prn = integer(f[i]);
|
||||
s.elevation = integer(f[i + 1]);
|
||||
s.azimuth = integer(f[i + 2]);
|
||||
s.snr = integer(f[i + 3], -1);
|
||||
if (s.prn > 0) pending.push_back(s);
|
||||
}
|
||||
if (number == total) {
|
||||
inView_[key] = pending;
|
||||
pending.clear();
|
||||
rebuildSatellites();
|
||||
}
|
||||
}
|
||||
|
||||
void NmeaParser::rebuildSatellites() {
|
||||
std::vector<Satellite> merged;
|
||||
for (auto& [key, list] : inView_)
|
||||
for (const Satellite& s : list) {
|
||||
Satellite* same = nullptr;
|
||||
for (auto& m : merged)
|
||||
if (m.system == s.system && m.prn == s.prn) same = &m;
|
||||
if (!same) merged.push_back(s);
|
||||
else if (s.snr > same->snr) same->snr = s.snr;
|
||||
}
|
||||
for (auto& s : merged) {
|
||||
auto it = used_.find(static_cast<int>(s.system));
|
||||
s.used = it != used_.end() && it->second.count(s.prn) > 0;
|
||||
}
|
||||
state_.satellites = std::move(merged);
|
||||
}
|
||||
|
||||
} // namespace roro::gnss
|
||||
@@ -0,0 +1,82 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstddef>
|
||||
#include <cstdint>
|
||||
#include <functional>
|
||||
#include <map>
|
||||
#include <set>
|
||||
#include <string>
|
||||
#include <utility>
|
||||
#include <vector>
|
||||
|
||||
namespace roro::gnss {
|
||||
|
||||
enum class Constellation : uint8_t { Unknown, Gps, Glonass, Galileo, BeiDou, Qzss, Navic };
|
||||
const char* constellationName(Constellation c);
|
||||
|
||||
enum class FixType : uint8_t { None, TwoD, ThreeD };
|
||||
|
||||
struct Satellite {
|
||||
Constellation system = Constellation::Unknown;
|
||||
int prn = 0;
|
||||
int elevation = 0; // degrees above the horizon
|
||||
int azimuth = 0; // degrees from north, clockwise
|
||||
int snr = -1; // dB-Hz; -1 when not tracked
|
||||
bool used = false; // part of the current Fix
|
||||
};
|
||||
|
||||
// Everything the receiver has said, as of the last sentence (see CONTEXT.md: Fix).
|
||||
struct GnssState {
|
||||
FixType fix = FixType::None;
|
||||
bool positionValid = false;
|
||||
double latitude = 0, longitude = 0; // degrees, south and west negative
|
||||
bool altitudeValid = false;
|
||||
float altitudeM = 0; // above mean sea level
|
||||
float speedKmh = 0;
|
||||
bool courseValid = false;
|
||||
float courseDeg = 0;
|
||||
int satellitesUsed = 0;
|
||||
float hdop = 99.9f;
|
||||
// UTC, trusted only with a Fix: the receiver reports a time without one, from its own clock.
|
||||
bool timeValid = false;
|
||||
int year = 0, month = 0, day = 0, hour = 0, minute = 0, second = 0;
|
||||
std::vector<Satellite> satellites; // in view, all constellations, one entry per satellite
|
||||
|
||||
int64_t utcSeconds() const; // seconds since 1970-01-01 UTC; meaningful when timeValid
|
||||
};
|
||||
|
||||
// NMEA 0183 (4.10 style, as the Cap's AT6668 sends it): RMC, GGA, GSA and GSV, with the
|
||||
// constellation taken from the talker ID or GSA's system ID field. Host-tested; no hardware here.
|
||||
class NmeaParser {
|
||||
public:
|
||||
// Raw bytes from the UART, in any chunks.
|
||||
void feed(const char* data, size_t len);
|
||||
// One sentence without its line end. False if malformed or its checksum is wrong.
|
||||
bool sentence(const std::string& line);
|
||||
|
||||
// Called with every complete line fed in, valid or not (`gnss nmea on` echoes them).
|
||||
std::function<void(const std::string&)> onLine;
|
||||
|
||||
const GnssState& state() const { return state_; }
|
||||
uint32_t goodSentences() const { return good_; }
|
||||
uint32_t badSentences() const { return bad_; }
|
||||
|
||||
private:
|
||||
using Fields = std::vector<std::string>;
|
||||
void rmc(const Fields& f);
|
||||
void gga(const Fields& f);
|
||||
void gsa(const Fields& f, Constellation talker);
|
||||
void gsv(const Fields& f, Constellation talker);
|
||||
void rebuildSatellites();
|
||||
|
||||
static constexpr size_t kMaxLine = 120;
|
||||
std::string line_;
|
||||
bool overflow_ = false;
|
||||
uint32_t good_ = 0, bad_ = 0;
|
||||
GnssState state_;
|
||||
// GSV sequences per (constellation, signal): pending until their last message.
|
||||
std::map<std::pair<int, int>, std::vector<Satellite>> pending_, inView_;
|
||||
std::map<int, std::set<int>> used_; // per constellation, from GSA
|
||||
};
|
||||
|
||||
} // namespace roro::gnss
|
||||
@@ -0,0 +1,76 @@
|
||||
#include "track.h"
|
||||
|
||||
#include <cmath>
|
||||
#include <cstdio>
|
||||
#include <ctime>
|
||||
|
||||
namespace roro::gnss {
|
||||
|
||||
namespace {
|
||||
|
||||
constexpr double kEarthRadiusM = 6371000.0;
|
||||
|
||||
double radians(double degrees) { return degrees * M_PI / 180.0; }
|
||||
|
||||
// UTC fields from seconds since 1970 (gmtime_r works on the device and the PC alike).
|
||||
struct tm utc(int64_t seconds) {
|
||||
time_t t = static_cast<time_t>(seconds);
|
||||
struct tm out;
|
||||
gmtime_r(&t, &out);
|
||||
return out;
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
double distanceMeters(double lat1, double lon1, double lat2, double lon2) {
|
||||
double dLat = radians(lat2 - lat1), dLon = radians(lon2 - lon1);
|
||||
double h = std::sin(dLat / 2) * std::sin(dLat / 2) +
|
||||
std::cos(radians(lat1)) * std::cos(radians(lat2)) * std::sin(dLon / 2) * std::sin(dLon / 2);
|
||||
return 2 * kEarthRadiusM * std::asin(std::sqrt(h));
|
||||
}
|
||||
|
||||
bool TrackRule::due(uint32_t nowMs, double lat, double lon) {
|
||||
if (any_ && (nowMs - lastMs_ < kEveryMs || distanceMeters(lat_, lon_, lat, lon) < kMinMeters)) return false;
|
||||
any_ = true;
|
||||
lastMs_ = nowMs;
|
||||
lat_ = lat;
|
||||
lon_ = lon;
|
||||
return true;
|
||||
}
|
||||
|
||||
std::string trackPath(int64_t utcSeconds) {
|
||||
struct tm t = utc(utcSeconds);
|
||||
char buf[48];
|
||||
std::snprintf(buf, sizeof buf, "/gnss/tracks/%04d%02d%02d-%02d%02d%02d.gpx", t.tm_year + 1900, t.tm_mon + 1,
|
||||
t.tm_mday, t.tm_hour, t.tm_min, t.tm_sec);
|
||||
return buf;
|
||||
}
|
||||
|
||||
namespace gpx {
|
||||
|
||||
std::string header(const std::string& name) {
|
||||
return "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
|
||||
"<gpx version=\"1.1\" creator=\"roro9stack\" xmlns=\"http://www.topografix.com/GPX/1/1\">\n"
|
||||
"<trk><name>" + name + "</name><trkseg>";
|
||||
}
|
||||
|
||||
std::string point(double lat, double lon, bool hasElevation, float elevationM, int64_t utcSeconds) {
|
||||
struct tm t = utc(utcSeconds);
|
||||
char buf[160], ele[32] = "";
|
||||
if (hasElevation) std::snprintf(ele, sizeof ele, "<ele>%.1f</ele>", elevationM);
|
||||
std::snprintf(buf, sizeof buf,
|
||||
"<trkpt lat=\"%.7f\" lon=\"%.7f\">%s<time>%04d-%02d-%02dT%02d:%02d:%02dZ</time></trkpt>", lat, lon,
|
||||
ele, t.tm_year + 1900, t.tm_mon + 1, t.tm_mday, t.tm_hour, t.tm_min, t.tm_sec);
|
||||
return buf;
|
||||
}
|
||||
|
||||
std::string footer() { return "</trkseg></trk></gpx>"; }
|
||||
|
||||
bool finished(const std::string& tail) {
|
||||
size_t end = tail.find_last_not_of(" \r\n\t");
|
||||
return end != std::string::npos && end + 1 >= 6 && tail.compare(end + 1 - 6, 6, "</gpx>") == 0;
|
||||
}
|
||||
|
||||
} // namespace gpx
|
||||
|
||||
} // namespace roro::gnss
|
||||
@@ -0,0 +1,40 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
#include <string>
|
||||
|
||||
namespace roro::gnss {
|
||||
|
||||
// Great-circle distance in metres (haversine, mean Earth radius).
|
||||
double distanceMeters(double lat1, double lon1, double lat2, double lon2);
|
||||
|
||||
// When a Track takes its next point (Q63): the first one always, then at least every 5 s and only
|
||||
// after moving at least 5 m, so standing still doesn't fill the card.
|
||||
class TrackRule {
|
||||
public:
|
||||
static constexpr uint32_t kEveryMs = 5000;
|
||||
static constexpr double kMinMeters = 5.0;
|
||||
|
||||
// True if this position should be recorded (and is then remembered as the last point).
|
||||
bool due(uint32_t nowMs, double lat, double lon);
|
||||
void reset() { any_ = false; }
|
||||
|
||||
private:
|
||||
bool any_ = false;
|
||||
uint32_t lastMs_ = 0;
|
||||
double lat_ = 0, lon_ = 0;
|
||||
};
|
||||
|
||||
// "/gnss/tracks/YYYYMMDD-HHMMSS.gpx", from the UTC start time (Storage Clean-up reads its date).
|
||||
std::string trackPath(int64_t utcSeconds);
|
||||
|
||||
// GPX 1.1, written a line at a time: the header when a Track starts, a point per line, the footer
|
||||
// when it stops. A file whose footer never came (power lost) is closed at the next boot.
|
||||
namespace gpx {
|
||||
std::string header(const std::string& name);
|
||||
std::string point(double lat, double lon, bool hasElevation, float elevationM, int64_t utcSeconds);
|
||||
std::string footer();
|
||||
bool finished(const std::string& tail); // the end of a file: does it close the GPX?
|
||||
} // namespace gpx
|
||||
|
||||
} // namespace roro::gnss
|
||||
@@ -0,0 +1,64 @@
|
||||
#include "loratap.h"
|
||||
|
||||
#include <algorithm>
|
||||
#include <cmath>
|
||||
#include <cstdio>
|
||||
#include <ctime>
|
||||
|
||||
namespace roro::lora {
|
||||
|
||||
static void le16(std::vector<uint8_t>& o, uint16_t v) { o.insert(o.end(), {uint8_t(v), uint8_t(v >> 8)}); }
|
||||
static void le32(std::vector<uint8_t>& o, uint32_t v) {
|
||||
o.insert(o.end(), {uint8_t(v), uint8_t(v >> 8), uint8_t(v >> 16), uint8_t(v >> 24)});
|
||||
}
|
||||
|
||||
// LoRaTap's dBm encoding: -139 dBm plus the byte, clamped to what a byte holds.
|
||||
static uint8_t dbmByte(float dbm) {
|
||||
long v = std::lround(dbm + 139);
|
||||
return static_cast<uint8_t>(std::clamp(v, 0L, 255L));
|
||||
}
|
||||
|
||||
std::string capturePath(int64_t utcSeconds) {
|
||||
time_t t = static_cast<time_t>(utcSeconds);
|
||||
struct tm u;
|
||||
gmtime_r(&t, &u);
|
||||
char buf[48];
|
||||
std::snprintf(buf, sizeof buf, "/captures/lora/%04d%02d%02d-%02d%02d%02d.pcap", u.tm_year + 1900, u.tm_mon + 1,
|
||||
u.tm_mday, u.tm_hour, u.tm_min, u.tm_sec);
|
||||
return buf;
|
||||
}
|
||||
|
||||
void appendPcapHeader(std::vector<uint8_t>& out) {
|
||||
le32(out, 0xA1B2C3D4);
|
||||
le16(out, 2);
|
||||
le16(out, 4);
|
||||
le32(out, 0); // time zone
|
||||
le32(out, 0); // timestamp accuracy
|
||||
le32(out, 65535); // snap length
|
||||
le32(out, 270); // LINKTYPE_LORATAP
|
||||
}
|
||||
|
||||
void appendRecord(std::vector<uint8_t>& out, uint32_t seconds, uint32_t micros, const RxInfo& rx, const uint8_t* data,
|
||||
size_t len) {
|
||||
uint32_t captured = static_cast<uint32_t>(kLoraTapSize + len);
|
||||
le32(out, seconds);
|
||||
le32(out, micros);
|
||||
le32(out, captured);
|
||||
le32(out, captured);
|
||||
|
||||
uint32_t f = rx.frequencyHz;
|
||||
// The spec puts packet RSSI in quarter dB below 0 dB SNR (an SX127x formula), but Wireshark
|
||||
// reads it as -139 dBm plus the byte either way, and the SX1262 already gives dBm.
|
||||
uint8_t packetRssi = dbmByte(rx.rssi);
|
||||
long snr = std::clamp(std::lround(rx.snr * 4), -128L, 127L);
|
||||
out.insert(out.end(), {
|
||||
0, 0, 0, uint8_t(kLoraTapSize), // version 0, padding, length
|
||||
uint8_t(f >> 24), uint8_t(f >> 16), uint8_t(f >> 8), uint8_t(f),
|
||||
uint8_t(std::lround(rx.bandwidthKHz / 125)), rx.spreadingFactor,
|
||||
packetRssi, dbmByte(rx.rssi), dbmByte(rx.noiseFloor),
|
||||
static_cast<uint8_t>(static_cast<int8_t>(snr)), rx.syncWord,
|
||||
});
|
||||
if (len) out.insert(out.end(), data, data + len);
|
||||
}
|
||||
|
||||
} // namespace roro::lora
|
||||
@@ -0,0 +1,33 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstddef>
|
||||
#include <cstdint>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
namespace roro::lora {
|
||||
|
||||
// What the radio knew about one received packet.
|
||||
struct RxInfo {
|
||||
uint32_t frequencyHz = 0;
|
||||
float bandwidthKHz = 0;
|
||||
uint8_t spreadingFactor = 0;
|
||||
float rssi = 0; // dBm
|
||||
float snr = 0; // dB
|
||||
float noiseFloor = 0; // dBm, instantaneous RSSI just before the packet, when known
|
||||
uint8_t syncWord = 0;
|
||||
};
|
||||
|
||||
// A Capture file (M3, Q97): pcap with LoRaTap v0 headers (LINKTYPE_LORATAP, 270), which Wireshark
|
||||
// reads. pcap fields are little-endian, LoRaTap fields big-endian.
|
||||
void appendPcapHeader(std::vector<uint8_t>& out);
|
||||
void appendRecord(std::vector<uint8_t>& out, uint32_t seconds, uint32_t micros, const RxInfo& rx, const uint8_t* data,
|
||||
size_t len);
|
||||
|
||||
// "/captures/lora/YYYYMMDD-HHMMSS.pcap" in UTC, dated like Tracks so Storage Clean-up can age it.
|
||||
std::string capturePath(int64_t utcSeconds);
|
||||
|
||||
constexpr size_t kLoraTapSize = 15;
|
||||
constexpr size_t kRecordOverhead = 16 + kLoraTapSize;
|
||||
|
||||
} // namespace roro::lora
|
||||
@@ -0,0 +1,83 @@
|
||||
#include "packet_view.h"
|
||||
|
||||
#include <cmath>
|
||||
#include <cstdio>
|
||||
|
||||
#include "meshtastic_header.h"
|
||||
#include "meshtastic_presets.h"
|
||||
|
||||
namespace roro::lora {
|
||||
|
||||
using namespace meshtastic;
|
||||
|
||||
std::string row(const PacketSummary& p, const std::string& time) {
|
||||
char s[64];
|
||||
int n = std::snprintf(s, sizeof s, "%s %ld %.1f ", time.c_str(), std::lround(p.rssi), p.snr);
|
||||
std::string out(s, n);
|
||||
PacketHeader h;
|
||||
if (!p.crcOk) return out + "bad CRC, " + std::to_string(p.len) + " B";
|
||||
if (!p.meshtastic || !parseHeader(p.data, p.len, h)) return out + std::to_string(p.len) + " B";
|
||||
auto shortId = [](uint32_t node) {
|
||||
if (node == kBroadcast) return std::string("all");
|
||||
char id[8];
|
||||
std::snprintf(id, sizeof id, "%04x", static_cast<unsigned>(node & 0xFFFF));
|
||||
return std::string(id);
|
||||
};
|
||||
out += shortId(h.from) + ">" + shortId(h.to);
|
||||
if (h.hopsAway() >= 0) out += " " + std::to_string(h.hopsAway()) + "/" + std::to_string(h.hopStart());
|
||||
return out;
|
||||
}
|
||||
|
||||
std::vector<std::string> hexDump(const uint8_t* data, size_t len) {
|
||||
std::vector<std::string> lines;
|
||||
for (size_t at = 0; at < len; at += 8) {
|
||||
char s[48];
|
||||
int n = std::snprintf(s, sizeof s, "%04x", static_cast<unsigned>(at));
|
||||
std::string text;
|
||||
for (size_t i = 0; i < 8; ++i) {
|
||||
if (at + i < len) {
|
||||
n += std::snprintf(s + n, sizeof s - n, " %02x", data[at + i]);
|
||||
uint8_t b = data[at + i];
|
||||
text += b >= 0x20 && b < 0x7F ? static_cast<char>(b) : '.';
|
||||
} else {
|
||||
n += std::snprintf(s + n, sizeof s - n, " ");
|
||||
}
|
||||
}
|
||||
lines.push_back(std::string(s, n) + " " + text);
|
||||
}
|
||||
return lines;
|
||||
}
|
||||
|
||||
std::vector<std::string> headerLines(const uint8_t* data, size_t len) {
|
||||
PacketHeader h;
|
||||
if (!parseHeader(data, len, h)) return {};
|
||||
char s[64];
|
||||
std::vector<std::string> lines;
|
||||
lines.push_back("From " + nodeId(h.from) + " to " + nodeId(h.to));
|
||||
std::snprintf(s, sizeof s, "Packet %08x%s%s", static_cast<unsigned>(h.id), h.wantAck() ? ", wants an ack" : "",
|
||||
h.viaMqtt() ? ", via MQTT" : "");
|
||||
lines.push_back(s);
|
||||
if (h.hopsAway() >= 0)
|
||||
std::snprintf(s, sizeof s, "Hops %d of %u, limit %u left", h.hopsAway(), h.hopStart(), h.hopLimit());
|
||||
else
|
||||
std::snprintf(s, sizeof s, "Hop limit %u left (old firmware)", h.hopLimit());
|
||||
lines.push_back(s);
|
||||
// Which preset's default Channel (named after it, with the public key) has this hash.
|
||||
std::string channel;
|
||||
for (size_t i = 0; i < kEu868PresetCount && channel.empty(); ++i)
|
||||
if (channelHash(kEu868Presets[i].name, kDefaultKey, sizeof kDefaultKey) == h.channelHash)
|
||||
channel = std::string(" (") + kEu868Presets[i].name + ", default key)";
|
||||
std::snprintf(s, sizeof s, "Channel 0x%02x%s", h.channelHash, channel.c_str());
|
||||
lines.push_back(s);
|
||||
if (h.relayNode) {
|
||||
std::snprintf(s, sizeof s, "Relayed by ..%02x", h.relayNode);
|
||||
lines.push_back(s);
|
||||
}
|
||||
if (h.nextHop) {
|
||||
std::snprintf(s, sizeof s, "Next hop ..%02x", h.nextHop);
|
||||
lines.push_back(s);
|
||||
}
|
||||
return lines;
|
||||
}
|
||||
|
||||
} // namespace roro::lora
|
||||
@@ -0,0 +1,29 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstddef>
|
||||
#include <cstdint>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
namespace roro::lora {
|
||||
|
||||
// What the LoRa Scanner shows of one packet (M3, Q96).
|
||||
struct PacketSummary {
|
||||
const uint8_t* data;
|
||||
size_t len;
|
||||
float rssi, snr;
|
||||
bool crcOk;
|
||||
bool meshtastic; // received on Meshtastic settings (sync word 0x2B): read its clear header
|
||||
};
|
||||
|
||||
// One list row, at most about 36 characters: "21:45:07 -97 6.2 5678>all 1/3". Nodes by their default
|
||||
// short name (the last 4 hex digits); headerLines() has the full numbers.
|
||||
std::string row(const PacketSummary& p, const std::string& time);
|
||||
|
||||
// Eight bytes a line, with the printable ones: "0000 ff ff ff ff 78 56 34 12 ....xV4.".
|
||||
std::vector<std::string> hexDump(const uint8_t* data, size_t len);
|
||||
|
||||
// The Meshtastic header, one field a line; empty when the packet is too short to have one.
|
||||
std::vector<std::string> headerLines(const uint8_t* data, size_t len);
|
||||
|
||||
} // namespace roro::lora
|
||||
@@ -0,0 +1,48 @@
|
||||
#include "sweep_view.h"
|
||||
|
||||
#include <algorithm>
|
||||
|
||||
namespace roro::lora {
|
||||
|
||||
namespace {
|
||||
constexpr int kPeakAboveFloorDb = 10;
|
||||
constexpr size_t kMaxPeaks = 3;
|
||||
} // namespace
|
||||
|
||||
SweepStats summarize(const int8_t* dbm, size_t steps, uint32_t fromHz, uint32_t stepHz) {
|
||||
SweepStats s;
|
||||
if (!steps) return s;
|
||||
std::vector<int8_t> sorted(dbm, dbm + steps);
|
||||
std::nth_element(sorted.begin(), sorted.begin() + steps / 2, sorted.end());
|
||||
s.floor = sorted[steps / 2];
|
||||
s.top = *std::max_element(dbm, dbm + steps);
|
||||
for (size_t i = 0; i < steps; ++i) {
|
||||
int v = dbm[i];
|
||||
bool localMax = (i == 0 || v >= dbm[i - 1]) && (i + 1 == steps || v > dbm[i + 1]);
|
||||
if (localMax && v >= s.floor + kPeakAboveFloorDb) s.peaks.push_back({fromHz + static_cast<uint32_t>(i) * stepHz, v});
|
||||
}
|
||||
std::stable_sort(s.peaks.begin(), s.peaks.end(), [](const SweepPeak& a, const SweepPeak& b) { return a.dbm > b.dbm; });
|
||||
if (s.peaks.size() > kMaxPeaks) s.peaks.resize(kMaxPeaks);
|
||||
return s;
|
||||
}
|
||||
|
||||
uint8_t heatLevel(int dbm, int low, int high) {
|
||||
if (dbm <= low) return 0;
|
||||
if (dbm >= high) return 255;
|
||||
return static_cast<uint8_t>((dbm - low) * 255 / (high - low) + ((dbm - low) * 255 % (high - low) ? 1 : 0));
|
||||
}
|
||||
|
||||
uint16_t heatColor(uint8_t level) {
|
||||
// Five segments of 51 steps each.
|
||||
auto rgb = [](int r, int g, int b) { return static_cast<uint16_t>((r >> 3) << 11 | (g >> 2) << 5 | (b >> 3)); };
|
||||
int seg = std::min(level / 51, 4), t = (level - seg * 51) * 255 / 51;
|
||||
switch (seg) {
|
||||
case 0: return rgb(0, 0, t); // black to blue
|
||||
case 1: return rgb(0, t, 255); // blue to cyan
|
||||
case 2: return rgb(0, 255, 255 - t); // cyan to green
|
||||
case 3: return rgb(t, 255, 0); // green to yellow
|
||||
default: return rgb(255, 255 - t, 0); // yellow to red
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace roro::lora
|
||||
@@ -0,0 +1,27 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstddef>
|
||||
#include <cstdint>
|
||||
#include <vector>
|
||||
|
||||
namespace roro::lora {
|
||||
|
||||
// What a Sweep pass says about the band (M3, Q98): one RSSI reading (dBm) per step.
|
||||
struct SweepPeak {
|
||||
uint32_t hz;
|
||||
int dbm;
|
||||
};
|
||||
struct SweepStats {
|
||||
int floor = 0; // the median: the band's noise floor, whatever a few signals do
|
||||
int top = 0; // the strongest reading
|
||||
std::vector<SweepPeak> peaks; // at most 3, strongest first, each a local maximum >= 10 dB above the floor
|
||||
};
|
||||
|
||||
SweepStats summarize(const int8_t* dbm, size_t steps, uint32_t fromHz, uint32_t stepHz);
|
||||
|
||||
// The waterfall's colours: a reading between `low` and `high` dBm as 0..255, then RGB565 along
|
||||
// black, blue, cyan, green, yellow, red.
|
||||
uint8_t heatLevel(int dbm, int low, int high);
|
||||
uint16_t heatColor(uint8_t level);
|
||||
|
||||
} // namespace roro::lora
|
||||
@@ -0,0 +1,28 @@
|
||||
#include "meshtastic_header.h"
|
||||
|
||||
#include <cstdio>
|
||||
|
||||
namespace roro::meshtastic {
|
||||
|
||||
static uint32_t le32(const uint8_t* p) { return p[0] | p[1] << 8 | p[2] << 16 | static_cast<uint32_t>(p[3]) << 24; }
|
||||
|
||||
bool parseHeader(const uint8_t* data, size_t len, PacketHeader& out) {
|
||||
if (!data || len < kHeaderSize) return false;
|
||||
out.to = le32(data);
|
||||
out.from = le32(data + 4);
|
||||
out.id = le32(data + 8);
|
||||
out.flags = data[12];
|
||||
out.channelHash = data[13];
|
||||
out.nextHop = data[14];
|
||||
out.relayNode = data[15];
|
||||
return true;
|
||||
}
|
||||
|
||||
std::string nodeId(uint32_t node) {
|
||||
if (node == kBroadcast) return "all";
|
||||
char s[10];
|
||||
std::snprintf(s, sizeof s, "!%08x", static_cast<unsigned>(node));
|
||||
return s;
|
||||
}
|
||||
|
||||
} // namespace roro::meshtastic
|
||||
@@ -0,0 +1,36 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstddef>
|
||||
#include <cstdint>
|
||||
#include <string>
|
||||
|
||||
namespace roro::meshtastic {
|
||||
|
||||
constexpr uint32_t kBroadcast = 0xFFFFFFFF;
|
||||
|
||||
// The 16 bytes every Meshtastic packet starts with, sent in clear (little-endian). The payload
|
||||
// after it is encrypted with the Channel's key.
|
||||
struct PacketHeader {
|
||||
uint32_t to = 0, from = 0, id = 0;
|
||||
uint8_t flags = 0;
|
||||
uint8_t channelHash = 0; // the Channel's name and key folded into a byte (see channelHash())
|
||||
uint8_t nextHop = 0; // last byte of the Node meant to relay it next; 0 when flooding
|
||||
uint8_t relayNode = 0; // last byte of the Node that relayed it to us
|
||||
|
||||
uint8_t hopLimit() const { return flags & 0x07; }
|
||||
bool wantAck() const { return flags & 0x08; }
|
||||
bool viaMqtt() const { return flags & 0x10; }
|
||||
uint8_t hopStart() const { return flags >> 5; }
|
||||
bool broadcast() const { return to == kBroadcast; }
|
||||
// How many times it was relayed before we heard it; -1 when the sender didn't say (hop start 0).
|
||||
int hopsAway() const { return hopStart() == 0 ? -1 : hopStart() - hopLimit(); }
|
||||
};
|
||||
|
||||
constexpr size_t kHeaderSize = 16;
|
||||
|
||||
bool parseHeader(const uint8_t* data, size_t len, PacketHeader& out);
|
||||
|
||||
// "!12345678", as Meshtastic writes node numbers; "all" for broadcast.
|
||||
std::string nodeId(uint32_t node);
|
||||
|
||||
} // namespace roro::meshtastic
|
||||
@@ -0,0 +1,47 @@
|
||||
#include "meshtastic_presets.h"
|
||||
|
||||
#include <cmath>
|
||||
#include <cstring>
|
||||
|
||||
namespace roro::meshtastic {
|
||||
|
||||
const uint8_t kDefaultKey[16] = {0xd4, 0xf1, 0xbb, 0x3a, 0x20, 0x29, 0x07, 0x59,
|
||||
0xf0, 0xbc, 0xff, 0xab, 0xcf, 0x4e, 0x69, 0x01};
|
||||
|
||||
// firmware src/mesh/MeshRadio.h (modemPresetToParams) and RadioInterface.cpp (PRESETS_EU_868).
|
||||
const Preset kEu868Presets[] = {
|
||||
{"LongFast", 250, 11, 5}, {"LongSlow", 125, 12, 8}, {"MediumSlow", 250, 10, 5}, {"MediumFast", 250, 9, 5},
|
||||
{"ShortSlow", 250, 8, 5}, {"ShortFast", 250, 7, 5}, {"LongMod", 125, 11, 8},
|
||||
};
|
||||
const size_t kEu868PresetCount = sizeof kEu868Presets / sizeof kEu868Presets[0];
|
||||
|
||||
const Preset* findPreset(const char* name) {
|
||||
for (const Preset& p : kEu868Presets)
|
||||
if (std::strcmp(p.name, name) == 0) return &p;
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
uint32_t djb2(const char* s) {
|
||||
uint32_t h = 5381;
|
||||
for (; *s; ++s) h = (h << 5) + h + static_cast<unsigned char>(*s);
|
||||
return h;
|
||||
}
|
||||
|
||||
uint8_t channelHash(const char* name, const uint8_t* key, size_t keyLen) {
|
||||
uint8_t h = 0;
|
||||
for (; *name; ++name) h ^= static_cast<uint8_t>(*name);
|
||||
for (size_t i = 0; i < keyLen; ++i) h ^= key[i];
|
||||
return h;
|
||||
}
|
||||
|
||||
uint32_t eu868FrequencyHz(const Preset& preset, const char* channelName) {
|
||||
constexpr double kStartMHz = 869.4, kEndMHz = 869.65;
|
||||
double slotMHz = preset.bwKHz / 1000.0;
|
||||
uint32_t slots = static_cast<uint32_t>(std::lround((kEndMHz - kStartMHz) / slotMHz));
|
||||
const char* name = channelName && *channelName ? channelName : preset.name;
|
||||
uint32_t slot = slots ? djb2(name) % slots : 0;
|
||||
double mhz = kStartMHz + slotMHz / 2 + slot * slotMHz;
|
||||
return static_cast<uint32_t>(std::lround(mhz * 1e6));
|
||||
}
|
||||
|
||||
} // namespace roro::meshtastic
|
||||
@@ -0,0 +1,38 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstddef>
|
||||
#include <cstdint>
|
||||
|
||||
namespace roro::meshtastic {
|
||||
|
||||
// Radio settings shared by every Meshtastic preset (firmware src/mesh/RadioInterface.h).
|
||||
constexpr uint8_t kSyncWord = 0x2B;
|
||||
constexpr uint16_t kPreambleLength = 16;
|
||||
|
||||
// The default Channel key ("AQ==", expanded): public, so the default Channel is readable by anyone.
|
||||
extern const uint8_t kDefaultKey[16];
|
||||
|
||||
// A modem preset: bandwidth, spreading factor and coding rate (4/cr). Named as Meshtastic shows them.
|
||||
struct Preset {
|
||||
const char* name;
|
||||
float bwKHz;
|
||||
uint8_t sf;
|
||||
uint8_t cr;
|
||||
};
|
||||
|
||||
// The presets Meshtastic allows in EU_868, its order, LongFast (the default) first.
|
||||
extern const Preset kEu868Presets[];
|
||||
extern const size_t kEu868PresetCount;
|
||||
const Preset* findPreset(const char* name); // nullptr when EU_868 doesn't allow it
|
||||
|
||||
// djb2, as Meshtastic hashes a Channel's name to pick a frequency slot.
|
||||
uint32_t djb2(const char* s);
|
||||
|
||||
// The byte in every packet header naming its Channel: the name's bytes XORed with the key's.
|
||||
uint8_t channelHash(const char* name, const uint8_t* key, size_t keyLen);
|
||||
|
||||
// EU_868 is 869.4 to 869.65 MHz: the slot comes from the Channel's name (the preset's name for
|
||||
// an unnamed Channel, which is the default).
|
||||
uint32_t eu868FrequencyHz(const Preset& preset, const char* channelName = nullptr);
|
||||
|
||||
} // namespace roro::meshtastic
|
||||
@@ -94,6 +94,11 @@ void FileReceiver::chunkWritten(bool ok, uint32_t nowMs) {
|
||||
state_ = received_ == size_ ? State::Finishing : State::Receiving;
|
||||
}
|
||||
|
||||
void FileReceiver::cardChecked(const uint8_t digest[32]) {
|
||||
if (state_ != State::Finishing) return;
|
||||
if (std::memcmp(digest, expected_, sizeof expected_) != 0) fail("the copy on the card differs");
|
||||
}
|
||||
|
||||
void FileReceiver::finished(bool ok) {
|
||||
if (state_ != State::Finishing) return;
|
||||
if (!ok) return fail("rename failed");
|
||||
|
||||
@@ -34,6 +34,9 @@ class FileReceiver {
|
||||
// Takes bytes for the current chunk; returns how many were used (none while a chunk waits).
|
||||
size_t feed(const uint8_t* data, size_t len, uint32_t nowMs);
|
||||
void chunkWritten(bool ok, uint32_t nowMs);
|
||||
// While Finishing: the SHA-256 of the file as read back from the card. The checksum on the
|
||||
// received bytes doesn't prove the card kept them (a failed write can lose buffered data).
|
||||
void cardChecked(const uint8_t digest[32]);
|
||||
void finished(bool ok);
|
||||
void tick(uint32_t nowMs);
|
||||
void reset() { *this = FileReceiver(); }
|
||||
|
||||
@@ -29,6 +29,9 @@ const Definition kDefinitions[] = {
|
||||
{"sound", Kind::Bool, 1, nullptr, 0, 1},
|
||||
{"probe_mac_raw", Kind::Bool, 1, nullptr, 0, 1},
|
||||
{"wifi_on", Kind::Bool, 1, nullptr, 0, 1},
|
||||
{"gnss_on", Kind::Bool, 1, nullptr, 0, 1},
|
||||
{"coord_dms", Kind::Bool, 0, nullptr, 0, 1},
|
||||
{"lora_preset", Kind::Int, 0, nullptr, 0, 6}, // LongFast first
|
||||
};
|
||||
static_assert(sizeof(kDefinitions) / sizeof(kDefinitions[0]) == static_cast<size_t>(Setting::Count),
|
||||
"every Setting needs a definition");
|
||||
|
||||
@@ -21,6 +21,9 @@ enum class Setting : uint8_t {
|
||||
Sound, // bool
|
||||
ProbeMacRaw, // bool: probe-request Logs keep raw MAC addresses
|
||||
WifiEnabled, // bool: the Wi-Fi Service stays Connected when a Saved Network is in range
|
||||
GnssEnabled, // bool: the GNSS Service reads the receiver (M2, Q58)
|
||||
CoordinatesDms, // bool: show degrees, minutes and seconds instead of decimal degrees (Q64)
|
||||
LoraPreset, // int: the LoRa Scanner's Meshtastic preset, an index into the EU868 list (M3, Q95)
|
||||
Count
|
||||
};
|
||||
|
||||
|
||||
@@ -20,6 +20,8 @@ inline const CleanupCategory kCleanupCategories[] = {
|
||||
{"IRC logs", "/irc"},
|
||||
{"Wi-Fi scan logs", "/wifi/scans"},
|
||||
{"Wi-Fi captures", "/captures/wifi"},
|
||||
{"LoRa captures", "/captures/lora"},
|
||||
{"GNSS tracks", "/gnss/tracks"},
|
||||
};
|
||||
|
||||
enum class CleanupAge { OneMonth, ThreeMonths, SixMonths, OneYear, Everything };
|
||||
|
||||
@@ -19,7 +19,18 @@ build_flags =
|
||||
-DARDUINO_USB_MODE=1
|
||||
lib_deps =
|
||||
m5stack/M5Cardputer @ 1.1.1
|
||||
jgromes/RadioLib @ 7.8.1
|
||||
test_ignore = *
|
||||
; Smaller TLS buffers (M2): the framework is rebuilt with these settings (pioarduino "hybrid
|
||||
; compile"). Receive stays 16 KB (servers send full TLS records); send drops to 4 KB (IRC lines are
|
||||
; short); buffers are allocated as needed and handshake-only data is freed once connected.
|
||||
custom_sdkconfig =
|
||||
CONFIG_MBEDTLS_ASYMMETRIC_CONTENT_LEN=y
|
||||
CONFIG_MBEDTLS_SSL_IN_CONTENT_LEN=16384
|
||||
CONFIG_MBEDTLS_SSL_OUT_CONTENT_LEN=4096
|
||||
CONFIG_MBEDTLS_DYNAMIC_BUFFER=y
|
||||
CONFIG_MBEDTLS_DYNAMIC_FREE_CONFIG_DATA=y
|
||||
CONFIG_MBEDTLS_DYNAMIC_FREE_CA_CERT=y
|
||||
|
||||
; Debug Build: the same firmware plus the Debug Console on TCP 2323 (see ADR 0004). The token comes
|
||||
; from ~/.config/roro9stack/debug-token, passed in by scripts/_docker.sh; it's never committed.
|
||||
|
||||
+1
-1
@@ -2,7 +2,7 @@
|
||||
"""Pushes a signed Update File to a Cardputer over Wi-Fi (TCP 3232) and reports the result.
|
||||
|
||||
Usage: scripts/ota_push.py <file.ota> <host>
|
||||
<host> is the device's IP (shown in Settings > About), or its name when mDNS works on your network.
|
||||
<host> is the device's IP (shown in Settings > Firmware).
|
||||
"""
|
||||
import socket
|
||||
import sys
|
||||
|
||||
@@ -78,7 +78,6 @@ void FirmwarePage::draw(Canvas& c) {
|
||||
case kVersion: return "Version";
|
||||
case kStatus: return "Status";
|
||||
case kAddress: return "Push to";
|
||||
case kName: return "Name";
|
||||
case kSdHeader: return listed ? (found.empty() ? "No .ota files in /updates" : "On the SD card:") : "Looking on the SD card...";
|
||||
default: return " " + found[i - kFixed].substr(std::string(kUpdatesFolder).size() + 1);
|
||||
}
|
||||
@@ -88,7 +87,6 @@ void FirmwarePage::draw(Canvas& c) {
|
||||
case kVersion: return versionString();
|
||||
case kStatus: return update_.onProbation() ? "on probation" : "confirmed";
|
||||
case kAddress: return ip.empty() ? "Wi-Fi not connected" : ip + ":" + std::to_string(UpdateService::kPort);
|
||||
case kName: return update_.hostname() + ".local";
|
||||
case kSdHeader: return "";
|
||||
default: return "install >";
|
||||
}
|
||||
|
||||
@@ -28,7 +28,7 @@ class FirmwarePage {
|
||||
void draw(Canvas& c);
|
||||
|
||||
private:
|
||||
enum Row { kVersion, kStatus, kAddress, kName, kSdHeader, kFixed };
|
||||
enum Row { kVersion, kStatus, kAddress, kSdHeader, kFixed };
|
||||
|
||||
std::vector<std::string> files();
|
||||
|
||||
|
||||
@@ -0,0 +1,531 @@
|
||||
#include "gemini_app.h"
|
||||
|
||||
#include <Arduino.h>
|
||||
|
||||
#include <algorithm>
|
||||
|
||||
#include "gemini_url.h"
|
||||
#include "text_wrap.h"
|
||||
#include "ui/fonts.h"
|
||||
#include "ui/theme.h"
|
||||
#include "ui/widgets.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
using namespace gemini;
|
||||
|
||||
namespace {
|
||||
|
||||
constexpr int kUrlBar = 10; // the small line with the URL at the top
|
||||
constexpr int kMargin = 3;
|
||||
constexpr const char* kStartUrl = GeminiService::kStartUrl;
|
||||
constexpr size_t kMaxHistory = 20; // Q77
|
||||
|
||||
// How each line type looks: its prefix, the indent of its wrapped rows, font and colour.
|
||||
struct Style {
|
||||
const char* prefix;
|
||||
int indent; // characters
|
||||
const lgfx::U8g2font* font;
|
||||
uint16_t color;
|
||||
};
|
||||
|
||||
Style styleOf(LineType t) {
|
||||
switch (t) {
|
||||
case LineType::Heading1: return {"", 0, &fonts::bold, theme::kAccent};
|
||||
case LineType::Heading2: return {"", 0, &fonts::bold, theme::kText};
|
||||
case LineType::Heading3: return {"", 0, &fonts::bold, theme::kMuted};
|
||||
case LineType::ListItem: return {"\xC2\xB7 ", 2, &fonts::body, theme::kText}; // ·
|
||||
case LineType::Quote: return {"> ", 2, &fonts::body, theme::kMuted};
|
||||
case LineType::Link: return {"\xC2\xBB ", 2, &fonts::body, theme::kAccent}; // »
|
||||
case LineType::Preformatted: return {"", 0, &fonts::body, theme::kText};
|
||||
default: return {"", 0, &fonts::body, theme::kText};
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
void GeminiApp::onEnter() {
|
||||
if (page_.url.empty() && !loading_) navigate(kStartUrl, false);
|
||||
requestRedraw();
|
||||
}
|
||||
|
||||
// The page's first heading, for a bookmark's label.
|
||||
std::string GeminiApp::titleOf() const {
|
||||
for (size_t i = 0; i < page_.text.lineCount() && i < 40; i++)
|
||||
if (static_cast<LineType>(types_[i]) == LineType::Heading1) return lineAt(i).text;
|
||||
return "";
|
||||
}
|
||||
|
||||
void GeminiApp::follow(const std::string& link) {
|
||||
std::string url = resolve(page_.base(), link);
|
||||
navigate(url, true, isSaved()); // inside a Saved Page, its saved links open offline (Q84)
|
||||
}
|
||||
|
||||
void GeminiApp::showMessage(const std::string& url, const std::string& gemtext) {
|
||||
GeminiPage p;
|
||||
p.outcome = GeminiPage::Outcome::Ok;
|
||||
p.url = url;
|
||||
p.header.status = 20;
|
||||
p.text.append(gemtext.data(), gemtext.size());
|
||||
p.text.finish();
|
||||
show(std::move(p));
|
||||
}
|
||||
|
||||
void GeminiApp::navigate(const std::string& target, bool remember, bool preferSaved) {
|
||||
bool local = target == kStartUrl || target.rfind("file://", 0) == 0;
|
||||
if (!isGemini(target) && !local) {
|
||||
status_ = "Not Gemini: " + target;
|
||||
statusMs_ = millis();
|
||||
requestRedraw();
|
||||
return;
|
||||
}
|
||||
if (!gemini_.fetch(target, preferSaved)) {
|
||||
status_ = "Busy: try again in a moment";
|
||||
statusMs_ = millis();
|
||||
return;
|
||||
}
|
||||
if (remember && !page_.url.empty()) {
|
||||
history_.push_back({page_.url, topRow_});
|
||||
if (history_.size() > kMaxHistory) history_.erase(history_.begin());
|
||||
}
|
||||
loading_ = true;
|
||||
loadingUrl_ = target;
|
||||
status_.clear();
|
||||
requestRedraw();
|
||||
}
|
||||
|
||||
void GeminiApp::show(GeminiPage&& page) {
|
||||
page_ = std::move(page);
|
||||
windowLoading_ = false;
|
||||
analyse();
|
||||
topRow_ = hscroll_ = 0;
|
||||
selected_ = -1;
|
||||
}
|
||||
|
||||
void GeminiApp::analyse() {
|
||||
// Sized exactly: the Service budgeted these bytes per line (kBytesPerLine), growth by
|
||||
// doubling would take up to twice that.
|
||||
std::vector<uint8_t>().swap(types_);
|
||||
std::vector<uint32_t>().swap(links_);
|
||||
types_.reserve(page_.text.lineCount());
|
||||
// A window may start inside a preformatted block: the index says (bit 31).
|
||||
size_t entry = page_.windowStart / GeminiService::kIndexEvery;
|
||||
bool pre = page_.windowed && entry < page_.lineIndex.size() && (page_.lineIndex[entry] & 0x80000000u);
|
||||
for (size_t i = 0; i < page_.text.lineCount(); i++) {
|
||||
LineType t = parseGemLine(page_.text.line(i), pre).type;
|
||||
if (page_.header.mimeType() != "text/gemini") t = LineType::Preformatted; // other text/*: as is
|
||||
types_.push_back(static_cast<uint8_t>(t));
|
||||
if (t == LineType::Link) links_.push_back(i);
|
||||
}
|
||||
links_.shrink_to_fit();
|
||||
layoutDirty_ = true;
|
||||
requestRedraw();
|
||||
}
|
||||
|
||||
size_t GeminiApp::topLine() const {
|
||||
if (firstRow_.size() < 2) return page_.windowStart;
|
||||
size_t i = std::upper_bound(firstRow_.begin(), firstRow_.end() - 1, static_cast<uint32_t>(topRow_)) - firstRow_.begin();
|
||||
return page_.windowStart + (i > 0 ? i - 1 : 0);
|
||||
}
|
||||
|
||||
void GeminiApp::requestWindow(size_t firstLine) {
|
||||
if (windowLoading_ || !gemini_.loadWindow(page_, firstLine)) return;
|
||||
windowLoading_ = true;
|
||||
keepLine_ = static_cast<long>(topLine());
|
||||
status_ = "Reading from the card...";
|
||||
statusMs_ = millis();
|
||||
}
|
||||
|
||||
// A new window of the same page: same URL, history and position, other lines.
|
||||
void GeminiApp::applyWindow(GeminiPage&& window) {
|
||||
windowLoading_ = false;
|
||||
status_.clear();
|
||||
page_.text = std::move(window.text);
|
||||
page_.windowStart = window.windowStart;
|
||||
page_.lineIndex = std::move(window.lineIndex);
|
||||
selected_ = -1;
|
||||
analyse();
|
||||
}
|
||||
|
||||
void GeminiApp::update(uint32_t nowMs) {
|
||||
GeminiPage result;
|
||||
bool got = gemini_.takeResult(result);
|
||||
if (got && !result.windowOf.empty()) {
|
||||
windowLoading_ = false;
|
||||
if (result.windowOf == page_.backing) applyWindow(std::move(result)); // else: we've moved on
|
||||
} else if (got) {
|
||||
loading_ = false;
|
||||
std::string url = result.url;
|
||||
switch (result.outcome) {
|
||||
case GeminiPage::Outcome::CertificateChanged:
|
||||
pendingCert_ = std::move(result);
|
||||
certDialog_.reset(new DialogModel({"Cancel", "Trust it"}));
|
||||
break;
|
||||
case GeminiPage::Outcome::Failed:
|
||||
showMessage(url, "# Can't open this page\n" + result.error + "\n=> " + url + " Try again\n");
|
||||
break;
|
||||
case GeminiPage::Outcome::Ok:
|
||||
switch (result.header.category()) {
|
||||
case Category::Success:
|
||||
if (result.header.mimeType().rfind("text/", 0) == 0) show(std::move(result));
|
||||
else {
|
||||
std::string mime = result.header.mimeType();
|
||||
showMessage(url, "# Not a text page\nThis is " + mime +
|
||||
", which the Cardputer can't show. s saves it to the card, in "
|
||||
"/gemini/downloads.\n");
|
||||
page_.header.meta = mime; // so s knows to download it
|
||||
}
|
||||
break;
|
||||
case Category::Input:
|
||||
// Q72: ask, then request the same URL with the answer as its query.
|
||||
inputOpen_ = true;
|
||||
inputSensitive_ = result.header.sensitiveInput();
|
||||
inputPrompt_ = result.header.meta;
|
||||
inputUrl_ = url;
|
||||
input_.setText("");
|
||||
break;
|
||||
default:
|
||||
showMessage(url, "# " + std::to_string(result.header.status) + " " + result.header.meta +
|
||||
"\nThe server refused this page.\n=> " + url + " Try again\n");
|
||||
break;
|
||||
}
|
||||
break;
|
||||
}
|
||||
requestRedraw();
|
||||
}
|
||||
// Signed: statusMs_ may be a few ms ahead of this pass's nowMs (set by a key handled after it).
|
||||
std::string message;
|
||||
if (gemini_.takeMessage(message)) {
|
||||
status_ = message;
|
||||
statusMs_ = millis();
|
||||
if (!reopen_.empty()) { // a refreshed Saved Page: show the new copy
|
||||
navigate(reopen_, false);
|
||||
reopen_.clear();
|
||||
} else if (message == "Deleted") navigate(kStartUrl, false);
|
||||
requestRedraw();
|
||||
}
|
||||
if (!status_.empty() && static_cast<int32_t>(nowMs - statusMs_) > 4000) {
|
||||
status_.clear();
|
||||
requestRedraw();
|
||||
}
|
||||
}
|
||||
|
||||
int GeminiApp::rowsOnScreen() const { return (theme::kContent.h - kUrlBar) / theme::kLineHeight; }
|
||||
|
||||
LineType typeOf(const std::vector<uint8_t>& types, size_t i) { return static_cast<LineType>(types[i]); }
|
||||
|
||||
GemLine GeminiApp::lineAt(size_t i) const {
|
||||
bool pre = typeOf(types_, i) == LineType::Preformatted;
|
||||
GemLine g = parseGemLine(page_.text.line(i), pre);
|
||||
if (typeOf(types_, i) == LineType::Preformatted) {
|
||||
g.type = LineType::Preformatted;
|
||||
g.text = page_.text.line(i);
|
||||
}
|
||||
return g;
|
||||
}
|
||||
|
||||
// A line's rows, as drawn: prefix on the first, indent on the rest; preformatted lines don't wrap.
|
||||
std::vector<std::string> GeminiApp::rowsOf(Canvas& c, size_t i) const {
|
||||
GemLine g = lineAt(i);
|
||||
if (g.type == LineType::PreToggle) return {};
|
||||
if (g.type == LineType::Preformatted) return {displayText(g.text)};
|
||||
Style st = styleOf(g.type);
|
||||
c.setFont(st.font);
|
||||
MeasureText measure = [&c](const std::string& s) { return static_cast<int>(c.textWidth(s.c_str())); };
|
||||
int width = theme::kWidth - 2 * kMargin;
|
||||
std::string indent(st.indent, ' ');
|
||||
std::vector<std::string> rows = wrapText(st.prefix + displayText(g.text), width, measure);
|
||||
if (rows.empty()) rows.push_back("");
|
||||
// Rows after the first: the exact rest of the text (wrapText keeps every space but the one it
|
||||
// breaks at), wrapped again, narrower, behind the indent.
|
||||
if (rows.size() > 1 && st.indent > 0) {
|
||||
std::string full = st.prefix + displayText(g.text);
|
||||
std::string rest = full.substr(rows[0].size());
|
||||
if (!rest.empty() && rest[0] == ' ') rest.erase(0, 1);
|
||||
std::vector<std::string> more = wrapText(rest, width - measure(indent), measure);
|
||||
rows.resize(1);
|
||||
for (auto& m : more) rows.push_back(indent + m);
|
||||
}
|
||||
return rows;
|
||||
}
|
||||
|
||||
void GeminiApp::layout(Canvas& c) {
|
||||
firstRow_.assign(page_.text.lineCount() + 1, 0);
|
||||
uint32_t row = 0;
|
||||
for (size_t i = 0; i < page_.text.lineCount(); i++) {
|
||||
firstRow_[i] = row;
|
||||
row += rowsOf(c, i).size();
|
||||
}
|
||||
firstRow_.back() = row;
|
||||
layoutDirty_ = false;
|
||||
}
|
||||
|
||||
void GeminiApp::scrollTo(int row) {
|
||||
int total = firstRow_.empty() ? 0 : static_cast<int>(firstRow_.back());
|
||||
// A windowed page: near either end of the window, read the next part from the card. The new
|
||||
// window starts a block before the line on top, so what's on screen stays.
|
||||
const size_t block = GeminiService::kIndexEvery;
|
||||
if (row + rowsOnScreen() > total - 2 && moreBelow()) {
|
||||
size_t line = topLine();
|
||||
requestWindow(line >= block ? line - line % block : 0);
|
||||
} else if (row < 0 && moreAbove()) {
|
||||
size_t line = topLine();
|
||||
size_t back = page_.text.lineCount() / 2; // about half a window above
|
||||
requestWindow(line > back ? line - back : 0);
|
||||
}
|
||||
topRow_ = std::max(0, std::min(row, std::max(0, total - rowsOnScreen())));
|
||||
requestRedraw();
|
||||
}
|
||||
|
||||
void GeminiApp::selectLink(int direction) {
|
||||
// A windowed page: past the window's last (or first) link, page on instead of wrapping.
|
||||
int last = static_cast<int>(links_.size()) - 1;
|
||||
if ((direction > 0 && moreBelow() && (links_.empty() || selected_ == last)) ||
|
||||
(direction < 0 && moreAbove() && (links_.empty() || selected_ == 0))) {
|
||||
selected_ = -1;
|
||||
scrollTo(topRow_ + direction * (rowsOnScreen() - 1));
|
||||
return;
|
||||
}
|
||||
if (links_.empty()) return;
|
||||
int count = static_cast<int>(links_.size());
|
||||
if (selected_ < 0) {
|
||||
// The first link on screen, or after it when going forward.
|
||||
selected_ = direction > 0 ? 0 : count - 1;
|
||||
for (int k = 0; k < count; k++)
|
||||
if (static_cast<int>(firstRow_[links_[k]]) >= topRow_) {
|
||||
selected_ = direction > 0 ? k : std::max(0, k - 1);
|
||||
break;
|
||||
}
|
||||
} else selected_ = (selected_ + direction + count) % count;
|
||||
int row = firstRow_[links_[selected_]];
|
||||
if (row < topRow_ || row >= topRow_ + rowsOnScreen()) scrollTo(row - 1);
|
||||
requestRedraw();
|
||||
}
|
||||
|
||||
bool GeminiApp::onKey(const KeyEvent& e) {
|
||||
requestRedraw();
|
||||
if (certDialog_) {
|
||||
certDialog_->onKey(e);
|
||||
if (certDialog_->result() == DialogModel::kPending) return true;
|
||||
if (certDialog_->result() == 1) {
|
||||
gemini_.trust(pendingCert_.host, pendingCert_.port, pendingCert_.presented);
|
||||
navigate(pendingCert_.requested, false);
|
||||
}
|
||||
certDialog_.reset();
|
||||
return true;
|
||||
}
|
||||
if (deleteDialog_) {
|
||||
deleteDialog_->onKey(e);
|
||||
if (deleteDialog_->result() == DialogModel::kPending) return true;
|
||||
if (deleteDialog_->result() == 1) gemini_.deleteSaved(savedPathOf());
|
||||
deleteDialog_.reset();
|
||||
return true;
|
||||
}
|
||||
if (inputOpen_) {
|
||||
switch (e.key) {
|
||||
case Key::Char: input_.insert(e.ch); break;
|
||||
case Key::Delete: input_.backspace(); break;
|
||||
case Key::Left: input_.left(); break;
|
||||
case Key::Right: input_.right(); break;
|
||||
case Key::Back: inputOpen_ = false; break;
|
||||
case Key::Select:
|
||||
inputOpen_ = false;
|
||||
navigate(resolve(inputUrl_, "?" + encodeQuery(input_.text())));
|
||||
break;
|
||||
default: break;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
if (addressOpen_) {
|
||||
switch (e.key) {
|
||||
case Key::Char: address_.insert(e.ch); break;
|
||||
case Key::Delete: address_.backspace(); break;
|
||||
case Key::Left: address_.left(); break;
|
||||
case Key::Right: address_.right(); break;
|
||||
case Key::Back: addressOpen_ = false; break;
|
||||
case Key::Select: {
|
||||
std::string url = address_.text();
|
||||
if (url.find("://") == std::string::npos) url = "gemini://" + url;
|
||||
addressOpen_ = false;
|
||||
navigate(url);
|
||||
break;
|
||||
}
|
||||
default: break;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
switch (e.key) {
|
||||
case Key::Up: scrollTo(topRow_ - 1); return true;
|
||||
case Key::Down: scrollTo(topRow_ + 1); return true;
|
||||
case Key::Left: hscroll_ = std::max(0, hscroll_ - 8); return true;
|
||||
case Key::Right: hscroll_ += 8; return true;
|
||||
case Key::Tab: selectLink(e.shift ? -1 : 1); return true;
|
||||
case Key::Select:
|
||||
if (selected_ >= 0) follow(lineAt(links_[selected_]).url);
|
||||
return true;
|
||||
case Key::Back:
|
||||
case Key::Delete:
|
||||
if (loading_) {
|
||||
gemini_.cancel();
|
||||
return true;
|
||||
}
|
||||
if (history_.empty()) return e.key == Key::Delete; // Back leaves the App
|
||||
{
|
||||
Visit v = history_.back();
|
||||
history_.pop_back();
|
||||
navigate(v.url, false);
|
||||
restoreRow_ = v.topRow;
|
||||
}
|
||||
return true;
|
||||
case Key::Char:
|
||||
switch (e.ch) {
|
||||
case ' ': scrollTo(topRow_ + rowsOnScreen() - 1); break;
|
||||
case 'g':
|
||||
address_.setText(page_.url == kStartUrl || isSaved() ? "" : page_.url);
|
||||
addressOpen_ = true;
|
||||
break;
|
||||
case 'b': // Q77
|
||||
if (isGemini(page_.base())) gemini_.addBookmark(page_.base(), titleOf());
|
||||
break;
|
||||
case 's': // Q82, Q73
|
||||
if (isSaved()) status_ = "Already saved; r refreshes it";
|
||||
else if (!isGemini(page_.url)) status_ = "Only Gemini pages can be saved";
|
||||
else if (page_.header.mimeType().rfind("text/", 0) == 0) gemini_.save(page_.url);
|
||||
else gemini_.download(page_.url);
|
||||
statusMs_ = millis();
|
||||
break;
|
||||
case 'S': { // Q83: this page and the gemtext it links to on the same capsule
|
||||
Url here;
|
||||
if (isSaved() || !parseUrl(page_.url, here)) break;
|
||||
std::vector<std::string> links;
|
||||
for (uint32_t i : links_) {
|
||||
std::string target = resolve(page_.url, lineAt(i).url);
|
||||
Url u;
|
||||
if (isGemini(target) && parseUrl(target, u) && u.host == here.host && target != page_.url &&
|
||||
std::find(links.begin(), links.end(), target) == links.end())
|
||||
links.push_back(target);
|
||||
if (static_cast<int>(links.size()) >= GeminiService::kMaxLinkedPages - 1) break;
|
||||
}
|
||||
gemini_.saveWithLinks(page_.url, links);
|
||||
break;
|
||||
}
|
||||
case 'r': // Q84: a fresh copy of a Saved Page
|
||||
if (isSaved() && gemini_.refresh(savedPathOf())) reopen_ = page_.url;
|
||||
break;
|
||||
case 'd': // Q85
|
||||
if (isSaved()) deleteDialog_.reset(new DialogModel({"Keep", "Delete"}));
|
||||
break;
|
||||
default: break;
|
||||
}
|
||||
return true;
|
||||
default: return false;
|
||||
}
|
||||
}
|
||||
|
||||
void GeminiApp::draw(Canvas& c) {
|
||||
const auto& area = theme::kContent;
|
||||
if (layoutDirty_) {
|
||||
layout(c);
|
||||
if (restoreRow_ >= 0 && !loading_) {
|
||||
scrollTo(restoreRow_);
|
||||
restoreRow_ = -1;
|
||||
}
|
||||
if (keepLine_ >= 0 && !windowLoading_) { // a new window: back to the line that was on top
|
||||
long local = keepLine_ - static_cast<long>(page_.windowStart);
|
||||
if (local >= 0 && local < static_cast<long>(page_.text.lineCount())) topRow_ = firstRow_[local];
|
||||
keepLine_ = -1;
|
||||
}
|
||||
}
|
||||
|
||||
// The URL bar: what's shown, or what's loading, or a passing message.
|
||||
c.setFont(&fonts::small);
|
||||
c.setTextDatum(top_left);
|
||||
std::string bar = loading_ ? "Loading " + loadingUrl_
|
||||
: !status_.empty() ? status_
|
||||
: isSaved() ? "saved " + page_.savedOn + ": " + page_.savedFrom
|
||||
: page_.url;
|
||||
c.setTextColor(loading_ || !status_.empty() ? theme::kWarning : theme::kMuted);
|
||||
c.drawString(displayText(bar).substr(0, 47).c_str(), kMargin, area.y + 1);
|
||||
|
||||
int rows = rowsOnScreen(), y0 = area.y + kUrlBar;
|
||||
// The first source line on screen: the last whose first row is at or above topRow_.
|
||||
size_t i = std::upper_bound(firstRow_.begin(), firstRow_.end() - 1, static_cast<uint32_t>(topRow_)) -
|
||||
firstRow_.begin();
|
||||
i = i > 0 ? i - 1 : 0;
|
||||
int row = topRow_;
|
||||
while (i < page_.text.lineCount() && row < topRow_ + rows) {
|
||||
int skip = row - static_cast<int>(firstRow_[i]);
|
||||
int lineRows = static_cast<int>(firstRow_[i + 1] - firstRow_[i]);
|
||||
if (lineRows > 0) {
|
||||
drawLine(c, i, skip, y0 + (row - topRow_) * theme::kLineHeight, topRow_ + rows - row);
|
||||
row += lineRows - skip;
|
||||
}
|
||||
i++;
|
||||
}
|
||||
if (page_.truncated && row < topRow_ + rows) {
|
||||
c.setFont(&fonts::small);
|
||||
c.setTextColor(theme::kWarning);
|
||||
c.drawString(("Cut short: " + page_.truncatedWhy).substr(0, 47).c_str(), kMargin,
|
||||
y0 + (row - topRow_) * theme::kLineHeight + 2);
|
||||
}
|
||||
// Scroll position, on the right edge: over the whole page, also when only a window is in memory.
|
||||
int total = static_cast<int>(firstRow_.back());
|
||||
int h = area.h - kUrlBar;
|
||||
if (page_.windowed && page_.totalLines > 0) {
|
||||
int barH = std::max(6, static_cast<int>(h * page_.text.lineCount() / page_.totalLines / 3));
|
||||
int y = static_cast<int>((h - barH) * topLine() / std::max<size_t>(1, page_.totalLines - 1));
|
||||
c.fillRect(area.w - 2, y0 + y, 2, barH, theme::kMuted);
|
||||
} else if (total > rows) {
|
||||
int barH = std::max(6, h * rows / total);
|
||||
c.fillRect(area.w - 2, y0 + (h - barH) * topRow_ / std::max(1, total - rows), 2, barH, theme::kMuted);
|
||||
}
|
||||
|
||||
if (addressOpen_) {
|
||||
theme::Rect box{2, area.y + area.h / 2 - 12, area.w - 4, theme::kLineHeight + 4};
|
||||
c.fillRect(box.x - 2, box.y - 12, box.w + 4, box.h + 14, theme::kBackground);
|
||||
c.setFont(&fonts::small);
|
||||
c.setTextColor(theme::kMuted);
|
||||
c.drawString("Go to (Enter, or ` to cancel)", box.x, box.y - 10);
|
||||
widgets::lineEditor(c, address_, box);
|
||||
}
|
||||
if (inputOpen_) {
|
||||
theme::Rect box{2, area.y + area.h / 2 - 4, area.w - 4, theme::kLineHeight + 4};
|
||||
c.fillRect(0, box.y - 26, area.w, box.h + 28, theme::kBackground);
|
||||
c.setFont(&fonts::body);
|
||||
c.setTextColor(theme::kText);
|
||||
c.drawString(displayText(inputPrompt_).substr(0, 39).c_str(), box.x, box.y - 22);
|
||||
c.setFont(&fonts::small);
|
||||
c.setTextColor(theme::kMuted);
|
||||
c.drawString(inputSensitive_ ? "(hidden) Enter sends, ` cancels" : "Enter sends, ` cancels", box.x, box.y - 9);
|
||||
if (inputSensitive_) {
|
||||
LineEditor masked(1024);
|
||||
masked.setText(std::string(input_.text().size(), '*'));
|
||||
widgets::lineEditor(c, masked, box);
|
||||
} else widgets::lineEditor(c, input_, box);
|
||||
}
|
||||
if (deleteDialog_) widgets::dialog(c, "Delete this Saved Page?", page_.savedFrom, *deleteDialog_);
|
||||
if (certDialog_)
|
||||
widgets::dialog(c, "Certificate changed",
|
||||
pendingCert_.host + " now shows a different certificate. Was " + pendingCert_.pinned.substr(0, 16) +
|
||||
"..., now " + pendingCert_.presented.substr(0, 16) + "...",
|
||||
*certDialog_);
|
||||
}
|
||||
|
||||
void GeminiApp::drawLine(Canvas& c, size_t i, int firstRow, int y, int rowsLeft) {
|
||||
GemLine g = lineAt(i);
|
||||
Style st = styleOf(g.type);
|
||||
bool isSelected = selected_ >= 0 && links_[selected_] == i;
|
||||
std::vector<std::string> rows = rowsOf(c, i);
|
||||
c.setFont(st.font);
|
||||
c.setTextDatum(top_left);
|
||||
for (int r = firstRow; r < static_cast<int>(rows.size()) && r - firstRow < rowsLeft; r++) {
|
||||
int ry = y + (r - firstRow) * theme::kLineHeight;
|
||||
if (isSelected) c.fillRect(0, ry, theme::kWidth - 3, theme::kLineHeight, theme::kSelection);
|
||||
c.setTextColor(isSelected ? theme::kText : st.color);
|
||||
std::string text = rows[r];
|
||||
if (g.type == LineType::Preformatted) text = hscroll_ < static_cast<int>(text.size()) ? text.substr(hscroll_) : "";
|
||||
c.drawString(text.c_str(), kMargin, ry + 1);
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -0,0 +1,81 @@
|
||||
#pragma once
|
||||
|
||||
#include <memory>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include "app.h"
|
||||
#include "dialog_model.h"
|
||||
#include "gemtext.h"
|
||||
#include "line_editor.h"
|
||||
#include "services/gemini_service.h"
|
||||
#include "ui/canvas.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
// Geminispace on the Cardputer (docs/milestones/G1.md). Pages come from the GeminiService as
|
||||
// lines; the App wraps them once (keeping only each line's first row), then wraps just the lines
|
||||
// on screen when it draws, so a long page costs 4 bytes a line on top of its text.
|
||||
class GeminiApp : public App {
|
||||
public:
|
||||
explicit GeminiApp(GeminiService& gemini) : gemini_(gemini) {}
|
||||
void onEnter() override;
|
||||
bool onKey(const KeyEvent& e) override;
|
||||
bool textEntryActive() const override { return addressOpen_ || inputOpen_; }
|
||||
void update(uint32_t nowMs) override;
|
||||
void draw(Canvas& c) override;
|
||||
|
||||
private:
|
||||
struct Visit {
|
||||
std::string url;
|
||||
int topRow;
|
||||
};
|
||||
|
||||
void navigate(const std::string& url, bool remember = true, bool preferSaved = false);
|
||||
void follow(const std::string& link);
|
||||
std::string titleOf() const;
|
||||
bool isSaved() const { return !page_.savedFrom.empty(); }
|
||||
std::string savedPathOf() const { return page_.url.substr(7); } // file://…
|
||||
void show(GeminiPage&& page);
|
||||
void analyse(); // types and links of the lines in memory
|
||||
void applyWindow(GeminiPage&& window);
|
||||
void requestWindow(size_t firstLine);
|
||||
size_t topLine() const; // the source line (in the whole page) at the top of the screen
|
||||
bool moreBelow() const { return page_.windowed && page_.windowStart + page_.text.lineCount() < page_.totalLines; }
|
||||
bool moreAbove() const { return page_.windowed && page_.windowStart > 0; }
|
||||
void showMessage(const std::string& url, const std::string& gemtext);
|
||||
void layout(Canvas& c);
|
||||
void drawLine(Canvas& c, size_t index, int firstRow, int y, int rows);
|
||||
std::vector<std::string> rowsOf(Canvas& c, size_t index) const;
|
||||
gemini::GemLine lineAt(size_t index) const;
|
||||
int rowsOnScreen() const;
|
||||
void selectLink(int direction);
|
||||
void scrollTo(int row);
|
||||
|
||||
GeminiService& gemini_;
|
||||
GeminiPage page_;
|
||||
std::vector<uint8_t> types_; // per source line: gemini::LineType
|
||||
std::vector<uint32_t> firstRow_; // per source line, plus the total at the end
|
||||
std::vector<uint32_t> links_; // source lines that are links
|
||||
bool layoutDirty_ = true;
|
||||
int topRow_ = 0, hscroll_ = 0;
|
||||
int selected_ = -1; // into links_
|
||||
int restoreRow_ = -1; // going back: where that page was scrolled to, applied after layout
|
||||
bool windowLoading_ = false;
|
||||
long keepLine_ = -1; // a new window: the source line to keep at the top, applied after layout
|
||||
std::vector<Visit> history_;
|
||||
bool loading_ = false;
|
||||
std::string loadingUrl_, status_;
|
||||
uint32_t statusMs_ = 0;
|
||||
bool addressOpen_ = false;
|
||||
LineEditor address_{1024};
|
||||
std::unique_ptr<DialogModel> certDialog_;
|
||||
GeminiPage pendingCert_;
|
||||
std::unique_ptr<DialogModel> deleteDialog_;
|
||||
bool inputOpen_ = false, inputSensitive_ = false;
|
||||
std::string inputPrompt_, inputUrl_;
|
||||
LineEditor input_{1024};
|
||||
std::string reopen_; // after a refresh: the Saved Page to show again
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -0,0 +1,212 @@
|
||||
#include "gnss_app.h"
|
||||
|
||||
#include <Arduino.h>
|
||||
|
||||
#include <cmath>
|
||||
#include <cstdio>
|
||||
|
||||
#include "geo_format.h"
|
||||
#include "ui/canvas.h"
|
||||
#include "ui/fonts.h"
|
||||
#include "ui/theme.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
using namespace gnss;
|
||||
|
||||
namespace {
|
||||
|
||||
// One colour per constellation, readable in the 8-bit frame buffer.
|
||||
uint16_t colorOf(Constellation c) {
|
||||
switch (c) {
|
||||
case Constellation::Gps: return theme::kAccent;
|
||||
case Constellation::Glonass: return 0xF8C8; // red
|
||||
case Constellation::Galileo: return theme::kMessage;
|
||||
case Constellation::BeiDou: return 0xFEA0; // yellow
|
||||
case Constellation::Qzss: return 0xC99F; // violet
|
||||
default: return theme::kText;
|
||||
}
|
||||
}
|
||||
|
||||
const char* fixLabel(FixType f) { return f == FixType::ThreeD ? "3D Fix" : f == FixType::TwoD ? "2D Fix" : "No Fix"; }
|
||||
|
||||
std::string duration(uint32_t ms) {
|
||||
uint32_t s = ms / 1000;
|
||||
char buf[24];
|
||||
if (s < 60) std::snprintf(buf, sizeof buf, "%lu s", (unsigned long)s);
|
||||
else std::snprintf(buf, sizeof buf, "%lu min %02lu s", (unsigned long)(s / 60), (unsigned long)(s % 60));
|
||||
return buf;
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
bool GnssApp::onKey(const KeyEvent& e) {
|
||||
if (e.key == Key::Tab) {
|
||||
sky_ = !sky_;
|
||||
requestRedraw();
|
||||
return true;
|
||||
}
|
||||
if (e.key == Key::Char && (e.ch == 'r' || e.ch == 'R')) { // record a Track, or stop it
|
||||
if (gnss_.tracking()) gnss_.stopTrack();
|
||||
else {
|
||||
refusal_ = gnss_.startTrack(millis());
|
||||
refusalMs_ = millis();
|
||||
}
|
||||
requestRedraw();
|
||||
return true;
|
||||
}
|
||||
return false; // Back leaves the App
|
||||
}
|
||||
|
||||
void GnssApp::update(uint32_t nowMs) {
|
||||
if (nowMs - lastDrawMs_ >= 1000) { // the receiver reports once a second
|
||||
lastDrawMs_ = nowMs;
|
||||
requestRedraw();
|
||||
}
|
||||
}
|
||||
|
||||
void GnssApp::draw(Canvas& c) {
|
||||
c.setTextDatum(top_left);
|
||||
const auto& area = theme::kContent;
|
||||
if (!gnss_.on()) {
|
||||
c.setFont(&fonts::bold);
|
||||
c.setTextColor(theme::kText);
|
||||
c.drawString("GNSS is off", 4, area.y + 4);
|
||||
c.setFont(&fonts::body);
|
||||
c.setTextColor(theme::kMuted);
|
||||
c.drawString("Settings > GNSS turns it on.", 4, area.y + 22);
|
||||
return;
|
||||
}
|
||||
sky_ ? drawSky(c) : drawPosition(c);
|
||||
c.setFont(&fonts::small);
|
||||
c.setTextColor(theme::kMuted);
|
||||
c.setTextDatum(top_right);
|
||||
c.drawString(sky_ ? "Tab: position" : "Tab: sky", area.w - 3, area.y + area.h - 9);
|
||||
c.setTextDatum(top_left);
|
||||
}
|
||||
|
||||
void GnssApp::drawPosition(Canvas& c) {
|
||||
const auto& area = theme::kContent;
|
||||
const GnssState& s = gnss_.state();
|
||||
uint32_t now = millis();
|
||||
int used = 0;
|
||||
for (auto& sat : s.satellites) used += sat.used;
|
||||
char line[64];
|
||||
|
||||
c.setFont(&fonts::bold);
|
||||
c.setTextColor(s.fix == FixType::None ? theme::kWarning : theme::kMessage);
|
||||
if (!gnss_.receiving(now)) std::snprintf(line, sizeof line, "No data from the receiver");
|
||||
else if (s.fix == FixType::None)
|
||||
std::snprintf(line, sizeof line, "Searching: %u in view, %s", (unsigned)s.satellites.size(),
|
||||
duration(now - gnss_.onSinceMs()).c_str());
|
||||
else std::snprintf(line, sizeof line, "%s, %d of %u satellites", fixLabel(s.fix), s.satellitesUsed,
|
||||
(unsigned)s.satellites.size());
|
||||
c.drawString(line, 4, area.y + 2);
|
||||
|
||||
c.setFont(&fonts::body);
|
||||
int y = area.y + 19;
|
||||
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(), 64, y);
|
||||
y += theme::kLineHeight;
|
||||
};
|
||||
bool dms = settings_.getBool(Setting::CoordinatesDms);
|
||||
if (s.positionValid) {
|
||||
row("Lat", dms ? formatDms(s.latitude, true) : formatDecimal(s.latitude, true));
|
||||
row("Lon", dms ? formatDms(s.longitude, false) : formatDecimal(s.longitude, false));
|
||||
row("Locator", maidenhead(s.latitude, s.longitude));
|
||||
std::snprintf(line, sizeof line, s.altitudeValid ? "%.0f m" : "-", s.altitudeM);
|
||||
row("Altitude", line);
|
||||
if (s.courseValid && s.speedKmh >= 1.0f)
|
||||
std::snprintf(line, sizeof line, "%.1f km/h, %.0f\xC2\xB0", s.speedKmh, s.courseDeg);
|
||||
else std::snprintf(line, sizeof line, "%.1f km/h", s.speedKmh);
|
||||
row("Speed", line);
|
||||
} else {
|
||||
row("Lat", "-");
|
||||
row("Lon", "-");
|
||||
y += theme::kLineHeight * 3;
|
||||
}
|
||||
std::snprintf(line, sizeof line, "%.1f", s.hdop);
|
||||
row("HDOP", s.fix == FixType::None ? "-" : line);
|
||||
if (s.timeValid) std::snprintf(line, sizeof line, "%02d:%02d:%02d UTC", s.hour, s.minute, s.second);
|
||||
row("Time", s.timeValid ? line : "-");
|
||||
|
||||
// The Track line, at the bottom left.
|
||||
c.setFont(&fonts::small);
|
||||
if (gnss_.tracking()) {
|
||||
c.setTextColor(theme::kWarning);
|
||||
std::snprintf(line, sizeof line, "REC %d point%s, %s r: stop", gnss_.trackPoints(),
|
||||
gnss_.trackPoints() == 1 ? "" : "s", duration(now - gnss_.trackStartMs()).c_str());
|
||||
} else if (!refusal_.empty() && now - refusalMs_ < 4000) {
|
||||
c.setTextColor(theme::kWarning);
|
||||
std::snprintf(line, sizeof line, "%s", refusal_.c_str());
|
||||
} else {
|
||||
c.setTextColor(theme::kMuted);
|
||||
std::snprintf(line, sizeof line, "r: record a Track");
|
||||
}
|
||||
c.drawString(line, 4, area.y + area.h - 9);
|
||||
}
|
||||
|
||||
void GnssApp::drawSky(Canvas& c) {
|
||||
const auto& area = theme::kContent;
|
||||
const GnssState& s = gnss_.state();
|
||||
const int radius = (area.h - 6) / 2, cx = 4 + radius, cy = area.y + area.h / 2;
|
||||
|
||||
// The sky from above: horizon, 30° and 60° elevation rings, north up.
|
||||
c.drawCircle(cx, cy, radius, theme::kMuted);
|
||||
c.drawCircle(cx, cy, radius * 2 / 3, 0x4208);
|
||||
c.drawCircle(cx, cy, radius / 3, 0x4208);
|
||||
c.drawFastHLine(cx - radius, cy, 2 * radius, 0x4208);
|
||||
c.drawFastVLine(cx, cy - radius, 2 * radius, 0x4208);
|
||||
c.setFont(&fonts::small);
|
||||
c.setTextColor(theme::kMuted);
|
||||
c.setTextDatum(middle_center);
|
||||
auto compass = [&](const char* letter, int x, int y) {
|
||||
c.fillRect(x - 3, y - 4, 7, 9, theme::kBackground); // off the lines, so it reads
|
||||
c.drawString(letter, x, y);
|
||||
};
|
||||
compass("N", cx, cy - radius + 5);
|
||||
compass("S", cx, cy + radius - 4);
|
||||
compass("E", cx + radius - 4, cy);
|
||||
compass("W", cx - radius + 4, cy);
|
||||
c.setTextDatum(top_left);
|
||||
|
||||
int inView[8] = {}, usedBy[8] = {};
|
||||
for (auto& sat : s.satellites) {
|
||||
int k = static_cast<int>(sat.system);
|
||||
inView[k]++;
|
||||
usedBy[k] += sat.used;
|
||||
SkyPoint p = skyPosition(sat.azimuth, sat.elevation, cx, cy, radius - 3);
|
||||
uint16_t color = colorOf(sat.system);
|
||||
if (sat.used) c.fillCircle(p.x, p.y, 3, color);
|
||||
else c.drawCircle(p.x, p.y, 3, sat.snr < 0 ? theme::kMuted : color);
|
||||
}
|
||||
|
||||
// Legend: used / in view per constellation, then the Fix.
|
||||
int x = cx + radius + 12, y = area.y + 4;
|
||||
c.setFont(&fonts::body);
|
||||
for (int k = 1; k < 7; k++) {
|
||||
if (!inView[k]) continue;
|
||||
auto system = static_cast<Constellation>(k);
|
||||
c.fillCircle(x + 3, y + 6, 3, colorOf(system));
|
||||
char line[32];
|
||||
std::snprintf(line, sizeof line, "%-8s%d/%d", constellationName(system), usedBy[k], inView[k]);
|
||||
c.setTextColor(theme::kText);
|
||||
c.drawString(line, x + 10, y);
|
||||
y += theme::kLineHeight;
|
||||
}
|
||||
if (s.satellites.empty()) {
|
||||
c.setTextColor(theme::kMuted);
|
||||
c.drawString("No satellites", x, y);
|
||||
y += theme::kLineHeight;
|
||||
}
|
||||
c.setTextColor(s.fix == FixType::None ? theme::kWarning : theme::kMessage);
|
||||
c.drawString(fixLabel(s.fix), x, y + 4);
|
||||
c.setFont(&fonts::small);
|
||||
c.setTextColor(theme::kMuted);
|
||||
c.drawString("filled: in use", x, area.y + area.h - 20);
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -0,0 +1,33 @@
|
||||
#pragma once
|
||||
|
||||
#include <string>
|
||||
|
||||
#include "app.h"
|
||||
#include "services/gnss_service.h"
|
||||
#include "settings.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
// GNSS (see docs/milestones/M2.md, Q59): the Position view, and the Sky view with every satellite
|
||||
// in view placed by direction and elevation. Tab switches between them.
|
||||
class GnssApp : public App {
|
||||
public:
|
||||
GnssApp(GnssService& gnss, const Settings& settings) : gnss_(gnss), settings_(settings) {}
|
||||
void onEnter() override { requestRedraw(); }
|
||||
bool onKey(const KeyEvent& e) override;
|
||||
void update(uint32_t nowMs) override;
|
||||
void draw(Canvas& c) override;
|
||||
|
||||
private:
|
||||
void drawPosition(Canvas& c);
|
||||
void drawSky(Canvas& c);
|
||||
|
||||
GnssService& gnss_;
|
||||
const Settings& settings_;
|
||||
bool sky_ = false;
|
||||
uint32_t lastDrawMs_ = 0;
|
||||
std::string refusal_; // why a Track couldn't start, shown for a few seconds
|
||||
uint32_t refusalMs_ = 0;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -42,7 +42,7 @@ std::string lowered(std::string s) {
|
||||
void IrcApp::onEnter() {
|
||||
page_ = Page::Chat;
|
||||
editing_ = false;
|
||||
irc_.connect();
|
||||
if (!irc_.stoppedByUser()) irc_.connect(); // stopped by hand: stay stopped, typing reconnects
|
||||
view(current_);
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,340 @@
|
||||
#include "lora_scanner_app.h"
|
||||
|
||||
#include <Arduino.h>
|
||||
|
||||
#include <algorithm>
|
||||
#include <cstdio>
|
||||
#include <ctime>
|
||||
|
||||
#include "meshtastic_presets.h"
|
||||
#include "packet_view.h"
|
||||
#include "sweep_view.h"
|
||||
#include "ui/canvas.h"
|
||||
#include "ui/fonts.h"
|
||||
#include "ui/widgets.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
namespace {
|
||||
constexpr uint32_t kMessageMs = 4000;
|
||||
}
|
||||
|
||||
void LoraScannerApp::onEnter() {
|
||||
int i = std::clamp<int>(settings_.getInt(Setting::LoraPreset), 0, meshtastic::kEu868PresetCount - 1);
|
||||
const meshtastic::Preset& p = meshtastic::kEu868Presets[i];
|
||||
if (std::string(radio_.config().name) != p.name) radio_.setPreset(p);
|
||||
radio_.listen(RadioService::App, true);
|
||||
view_ = View::Packets;
|
||||
selectedSeq_ = 0;
|
||||
followNewest_ = true;
|
||||
shownSeq_ = 0;
|
||||
requestRedraw();
|
||||
}
|
||||
|
||||
void LoraScannerApp::onExit() {
|
||||
showSweep(false);
|
||||
radio_.listen(RadioService::App, false);
|
||||
}
|
||||
|
||||
void LoraScannerApp::showSweep(bool on) {
|
||||
if (on == (view_ == View::Sweep)) return;
|
||||
radio_.sweep(on);
|
||||
view_ = on ? View::Sweep : View::Packets;
|
||||
peak_.clear();
|
||||
std::vector<int8_t>().swap(waterfall_); // its memory only while shown
|
||||
sweepSteps_ = 0;
|
||||
shownSweep_ = radio_.sweeps();
|
||||
requestRedraw();
|
||||
}
|
||||
|
||||
bool LoraScannerApp::meshtasticSettings() const { return radio_.config().syncWord == meshtastic::kSyncWord; }
|
||||
|
||||
void LoraScannerApp::say(const std::string& text) {
|
||||
message_ = text;
|
||||
messageMs_ = millis();
|
||||
requestRedraw();
|
||||
}
|
||||
|
||||
bool LoraScannerApp::onKey(const KeyEvent& e) {
|
||||
if (e.key == Key::Tab && (view_ == View::Packets || view_ == View::Sweep)) {
|
||||
showSweep(view_ == View::Packets);
|
||||
return true;
|
||||
}
|
||||
if (view_ == View::Sweep) {
|
||||
if (e.key == Key::Back) {
|
||||
showSweep(false);
|
||||
return true;
|
||||
}
|
||||
return e.key != Key::Home; // everything else stays here
|
||||
}
|
||||
if (view_ == View::Details) {
|
||||
int last = std::max<int>(0, static_cast<int>(details_.size()) - 8);
|
||||
if (e.key == Key::Up) detailsTop_ = std::max(0, detailsTop_ - 1);
|
||||
else if (e.key == Key::Down) detailsTop_ = std::min(last, detailsTop_ + 1);
|
||||
else if (e.key == Key::Back || e.key == Key::Select) view_ = View::Packets;
|
||||
else return true;
|
||||
requestRedraw();
|
||||
return true;
|
||||
}
|
||||
if (view_ == View::Presets) {
|
||||
if (e.key == Key::Up) presets_.up();
|
||||
else if (e.key == Key::Down) presets_.down();
|
||||
else if (e.key == Key::Select) {
|
||||
int i = presets_.selected();
|
||||
settings_.setInt(Setting::LoraPreset, i);
|
||||
radio_.setPreset(meshtastic::kEu868Presets[i]);
|
||||
say(std::string("Listening on ") + meshtastic::kEu868Presets[i].name);
|
||||
view_ = View::Packets;
|
||||
} else if (e.key == Key::Back) view_ = View::Packets;
|
||||
else return true;
|
||||
requestRedraw();
|
||||
return true;
|
||||
}
|
||||
// The packet list.
|
||||
if (e.key == Key::Up || e.key == Key::Down) {
|
||||
e.key == Key::Up ? packets_.up() : packets_.down();
|
||||
selectedSeq_ = packets_.selected() >= 0 ? radio_.received() - packets_.selected() : 0;
|
||||
followNewest_ = packets_.selected() <= 0;
|
||||
requestRedraw();
|
||||
return true;
|
||||
}
|
||||
if (e.key == Key::Select) {
|
||||
openDetails();
|
||||
return true;
|
||||
}
|
||||
if (e.key == Key::Char && (e.ch == 'p' || e.ch == 'P')) {
|
||||
presets_.setCount(meshtastic::kEu868PresetCount);
|
||||
presets_.select(settings_.getInt(Setting::LoraPreset));
|
||||
view_ = View::Presets;
|
||||
requestRedraw();
|
||||
return true;
|
||||
}
|
||||
if (e.key == Key::Char && (e.ch == 'c' || e.ch == 'C')) {
|
||||
if (capture_.capturing()) capture_.stop();
|
||||
else {
|
||||
std::string why = capture_.start(millis());
|
||||
if (!why.empty()) say(why);
|
||||
}
|
||||
requestRedraw();
|
||||
return true;
|
||||
}
|
||||
return false; // Back leaves the App
|
||||
}
|
||||
|
||||
void LoraScannerApp::openDetails() {
|
||||
RadioPacket p;
|
||||
if (!selectedSeq_ || !radio_.packet(selectedSeq_, p)) return say("That packet has left the list");
|
||||
details_.clear();
|
||||
char line[64];
|
||||
std::snprintf(line, sizeof line, "%s, %u bytes%s", timeOf(p).c_str(), p.len, p.crcOk ? "" : ", bad CRC");
|
||||
details_.push_back(line);
|
||||
std::snprintf(line, sizeof line, "%.0f dBm, SNR %.1f dB, noise %.0f", p.rx.rssi, p.rx.snr, p.rx.noiseFloor);
|
||||
details_.push_back(line);
|
||||
std::snprintf(line, sizeof line, "%.4f MHz, off by %.0f Hz", p.rx.frequencyHz / 1e6, p.frequencyError);
|
||||
details_.push_back(line);
|
||||
if (meshtasticSettings())
|
||||
for (auto& l : lora::headerLines(p.data, p.len)) details_.push_back(l);
|
||||
for (auto& l : lora::hexDump(p.data, p.len)) details_.push_back(l);
|
||||
detailsTop_ = 0;
|
||||
view_ = View::Details;
|
||||
requestRedraw();
|
||||
}
|
||||
|
||||
std::string LoraScannerApp::timeOf(const RadioPacket& p) const {
|
||||
int64_t now = clock_.utcNow();
|
||||
if (now < 0) { // no Clock yet: how long ago
|
||||
char ago[16];
|
||||
std::snprintf(ago, sizeof ago, "-%lus", (unsigned long)((millis() - p.ms) / 1000));
|
||||
return ago;
|
||||
}
|
||||
time_t t = static_cast<time_t>(now - static_cast<int64_t>((millis() - p.ms) / 1000));
|
||||
struct tm local;
|
||||
localtime_r(&t, &local);
|
||||
char buf[12];
|
||||
std::snprintf(buf, sizeof buf, "%02d:%02d:%02d", local.tm_hour, local.tm_min, local.tm_sec);
|
||||
return buf;
|
||||
}
|
||||
|
||||
void LoraScannerApp::update(uint32_t nowMs) {
|
||||
if (view_ == View::Sweep) {
|
||||
if (radio_.sweeps() != shownSweep_) requestRedraw();
|
||||
return;
|
||||
}
|
||||
if (radio_.received() != shownSeq_ || nowMs - lastDrawMs_ >= 1000 ||
|
||||
(!message_.empty() && nowMs - messageMs_ >= kMessageMs))
|
||||
requestRedraw();
|
||||
}
|
||||
|
||||
void LoraScannerApp::draw(Canvas& c) {
|
||||
lastDrawMs_ = millis();
|
||||
c.setTextDatum(top_left);
|
||||
if (!radio_.present()) {
|
||||
c.setFont(&fonts::bold);
|
||||
c.setTextColor(theme::kWarning);
|
||||
c.drawString("No LoRa radio found", 4, theme::kContent.y + 4);
|
||||
c.setFont(&fonts::body);
|
||||
c.setTextColor(theme::kMuted);
|
||||
c.drawString("Is the Cap LoRa-1262 attached?", 4, theme::kContent.y + 22);
|
||||
return;
|
||||
}
|
||||
switch (view_) {
|
||||
case View::Packets: drawPackets(c); break;
|
||||
case View::Details: drawDetails(c); break;
|
||||
case View::Presets: drawPresets(c); break;
|
||||
case View::Sweep: drawSweep(c); break;
|
||||
}
|
||||
}
|
||||
|
||||
void LoraScannerApp::drawPackets(Canvas& c) {
|
||||
const auto& area = theme::kContent;
|
||||
RadioService::Config cfg = radio_.config();
|
||||
uint32_t newest = radio_.received();
|
||||
shownSeq_ = newest;
|
||||
|
||||
// What it's listening to, and the noise floor.
|
||||
char head[64];
|
||||
std::snprintf(head, sizeof head, "%s %.3f MHz, noise %.0f", cfg.name, cfg.frequencyHz / 1e6, radio_.noiseFloor());
|
||||
c.setFont(&fonts::small);
|
||||
c.setTextColor(radio_.listening() ? theme::kMuted : theme::kWarning);
|
||||
c.drawString(radio_.listening() ? head : "Starting the radio...", 4, area.y + 2);
|
||||
if (capture_.capturing()) {
|
||||
c.setTextDatum(top_right);
|
||||
c.setTextColor(theme::kWarning);
|
||||
c.drawString(("CAP " + std::to_string(capture_.packets())).c_str(), area.w - 3, area.y + 2);
|
||||
c.setTextDatum(top_left);
|
||||
}
|
||||
|
||||
// The list, newest first; the selection stays on its packet as new ones arrive.
|
||||
int count = static_cast<int>(radio_.available());
|
||||
packets_.setCount(count);
|
||||
if (!followNewest_ && selectedSeq_ && newest >= selectedSeq_ && newest - selectedSeq_ < static_cast<uint32_t>(count))
|
||||
packets_.select(static_cast<int>(newest - selectedSeq_));
|
||||
else if (count > 0) {
|
||||
followNewest_ = true;
|
||||
packets_.select(0);
|
||||
selectedSeq_ = newest;
|
||||
}
|
||||
theme::Rect list{area.x, area.y + 12, area.w, kListRows * theme::kLineHeight};
|
||||
if (count == 0) {
|
||||
c.setFont(&fonts::body);
|
||||
c.setTextColor(theme::kMuted);
|
||||
c.drawString("No packets yet.", 4, list.y + 4);
|
||||
c.drawString(meshtasticSettings() ? "Meshtastic nodes in range show here." : "Custom settings.", 4,
|
||||
list.y + 4 + theme::kLineHeight);
|
||||
} else {
|
||||
bool mesh = meshtasticSettings();
|
||||
widgets::list(c, packets_, list, [&](int i) {
|
||||
RadioPacket p;
|
||||
if (!radio_.packet(newest - i, p)) return std::string("(gone)");
|
||||
return lora::row({p.data, p.len, p.rx.rssi, p.rx.snr, p.crcOk, mesh}, timeOf(p));
|
||||
});
|
||||
}
|
||||
|
||||
// Footer: a message for a few seconds, or the keys.
|
||||
c.setFont(&fonts::small);
|
||||
bool showMessage = !message_.empty() && millis() - messageMs_ < kMessageMs;
|
||||
c.setTextColor(showMessage ? theme::kWarning : theme::kMuted);
|
||||
std::string keys = std::string("Enter: details p: preset Tab: sweep c: ") + (capture_.capturing() ? "stop" : "capture");
|
||||
c.drawString(showMessage ? message_.c_str() : keys.c_str(), 4, area.y + area.h - 9);
|
||||
}
|
||||
|
||||
void LoraScannerApp::drawDetails(Canvas& c) {
|
||||
const auto& area = theme::kContent;
|
||||
widgets::textLines(c, details_, detailsTop_, {area.x + 2, area.y + 2, area.w - 2, area.h - 2});
|
||||
}
|
||||
|
||||
void LoraScannerApp::drawPresets(Canvas& c) {
|
||||
const auto& area = theme::kContent;
|
||||
c.setFont(&fonts::small);
|
||||
c.setTextColor(theme::kMuted);
|
||||
c.drawString("Meshtastic presets allowed in EU868", 4, area.y + 2);
|
||||
widgets::list(
|
||||
c, presets_, {area.x, area.y + 12, area.w, (kListRows + 1) * theme::kLineHeight},
|
||||
[](int i) { return std::string(meshtastic::kEu868Presets[i].name); },
|
||||
[](int i) {
|
||||
char v[24];
|
||||
const auto& p = meshtastic::kEu868Presets[i];
|
||||
std::snprintf(v, sizeof v, "SF%u %.0fk %.3f", p.sf, p.bwKHz, meshtastic::eu868FrequencyHz(p) / 1e6);
|
||||
return std::string(v);
|
||||
});
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
|
||||
namespace roro {
|
||||
|
||||
// Sweep (Q98): bars of the latest pass with peak hold, the waterfall underneath (newest at the
|
||||
// top), and where the Sniffer's preset sits in the band.
|
||||
void LoraScannerApp::drawSweep(Canvas& c) {
|
||||
const auto& area = theme::kContent;
|
||||
constexpr int kLow = -120, kHigh = -60; // the scale, dBm: about the chip's floor to a near signal
|
||||
SweepFrame f;
|
||||
bool have = radio_.sweepFrame(f) && f.seq != 0;
|
||||
c.setFont(&fonts::small);
|
||||
c.setTextColor(theme::kMuted);
|
||||
c.drawString("Sweep, the Sniffer is paused", 4, area.y + 2);
|
||||
if (!have) {
|
||||
c.drawString("Measuring...", 4, area.y + 20);
|
||||
return;
|
||||
}
|
||||
// Keep peak hold and the waterfall for this band.
|
||||
if (f.steps != sweepSteps_) {
|
||||
sweepSteps_ = f.steps;
|
||||
peak_.assign(f.steps, -127);
|
||||
waterfall_.assign(static_cast<size_t>(kWaterfallRows) * f.steps, -127);
|
||||
}
|
||||
if (f.seq != shownSweep_) {
|
||||
shownSweep_ = f.seq;
|
||||
for (uint16_t i = 0; i < f.steps; ++i) peak_[i] = std::max(peak_[i], f.dbm[i]);
|
||||
std::copy_backward(waterfall_.begin(), waterfall_.end() - f.steps, waterfall_.end());
|
||||
std::copy(f.dbm, f.dbm + f.steps, waterfall_.begin());
|
||||
}
|
||||
|
||||
// Layout: up to 3 px a step, left-aligned after the scale.
|
||||
int x0 = 26, cell = std::max(1, std::min(3, (area.w - x0 - 2) / std::max<int>(1, f.steps)));
|
||||
int barTop = area.y + 12, barH = 46, barBottom = barTop + barH;
|
||||
auto height = [&](int dbm) { return std::clamp((dbm - kLow) * barH / (kHigh - kLow), 0, barH); };
|
||||
c.setTextColor(theme::kMuted);
|
||||
c.drawString("-60", 2, barTop - 1);
|
||||
c.drawString("-120", 0, barBottom - 7);
|
||||
for (uint16_t i = 0; i < f.steps; ++i) {
|
||||
int x = x0 + i * cell, h = height(f.dbm[i]);
|
||||
if (h > 0) c.fillRect(x, barBottom - h, std::max(1, cell - 1), h, theme::kAccent);
|
||||
int ph = height(peak_[i]);
|
||||
if (ph > 0) c.drawFastHLine(x, barBottom - ph, std::max(1, cell - 1), theme::kText);
|
||||
}
|
||||
// The Sniffer's frequency, when it's in the band.
|
||||
uint32_t hz = radio_.config().frequencyHz;
|
||||
if (hz >= f.fromHz && hz <= f.fromHz + (f.steps - 1) * f.stepHz) {
|
||||
int x = x0 + static_cast<int>((hz - f.fromHz) / f.stepHz) * cell + cell / 2;
|
||||
for (int y = barTop; y < barBottom; y += 3) c.drawPixel(x, y, theme::kMessage);
|
||||
}
|
||||
|
||||
// The waterfall.
|
||||
int wfTop = barBottom + 2;
|
||||
for (int r = 0; r < kWaterfallRows; ++r)
|
||||
for (uint16_t i = 0; i < f.steps; ++i) {
|
||||
int8_t v = waterfall_[static_cast<size_t>(r) * f.steps + i];
|
||||
if (v > -127) c.fillRect(x0 + i * cell, wfTop + r, cell, 1, lora::heatColor(lora::heatLevel(v, kLow, kHigh)));
|
||||
}
|
||||
|
||||
// The band's edges, its floor and its strongest signal.
|
||||
lora::SweepStats st = lora::summarize(f.dbm, f.steps, f.fromHz, f.stepHz);
|
||||
char line[64];
|
||||
int y = area.y + area.h - 9;
|
||||
std::snprintf(line, sizeof line, "%.1f", f.fromHz / 1e6);
|
||||
c.drawString(line, x0, wfTop + kWaterfallRows + 1);
|
||||
std::snprintf(line, sizeof line, "%.1f MHz", (f.fromHz + (f.steps - 1) * f.stepHz) / 1e6);
|
||||
c.setTextDatum(top_right);
|
||||
c.drawString(line, x0 + f.steps * cell, wfTop + kWaterfallRows + 1);
|
||||
c.setTextDatum(top_left);
|
||||
if (st.peaks.empty())
|
||||
std::snprintf(line, sizeof line, "floor %d dBm, nothing above it Tab: sniffer", st.floor);
|
||||
else
|
||||
std::snprintf(line, sizeof line, "floor %d, %.1f MHz at %d dBm Tab: sniffer", st.floor, st.peaks[0].hz / 1e6,
|
||||
st.peaks[0].dbm);
|
||||
c.setTextColor(theme::kMuted);
|
||||
c.drawString(line, 4, y);
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -0,0 +1,67 @@
|
||||
#pragma once
|
||||
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include "app.h"
|
||||
#include "list_model.h"
|
||||
#include "services/clock_service.h"
|
||||
#include "services/lora_capture_service.h"
|
||||
#include "services/radio_service.h"
|
||||
#include "settings.h"
|
||||
#include "ui/theme.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
// The LoRa Scanner (docs/milestones/M3.md). Sniffer: the packets the radio hears, newest first,
|
||||
// with the Meshtastic header read (Q96) and a hex dump on Enter; p picks the preset (Q95), c starts
|
||||
// or stops a Capture (Q97). The radio listens while the App is open (Q100). Tab: Sweep, the band's
|
||||
// RSSI as bars with peak hold and a waterfall (Q98); it pauses the Sniffer while shown (Q99).
|
||||
class LoraScannerApp : public App {
|
||||
public:
|
||||
LoraScannerApp(RadioService& radio, LoraCaptureService& capture, Settings& settings, ClockService& clock)
|
||||
: radio_(radio), capture_(capture), settings_(settings), clock_(clock) {}
|
||||
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 { Packets, Details, Presets, Sweep };
|
||||
static constexpr int kListRows = 7;
|
||||
|
||||
void drawPackets(Canvas& c);
|
||||
void drawDetails(Canvas& c);
|
||||
void drawPresets(Canvas& c);
|
||||
void drawSweep(Canvas& c);
|
||||
void showSweep(bool on);
|
||||
void openDetails();
|
||||
std::string timeOf(const RadioPacket& p) const;
|
||||
bool meshtasticSettings() const;
|
||||
void say(const std::string& text); // a line in the footer for a few seconds
|
||||
|
||||
RadioService& radio_;
|
||||
LoraCaptureService& capture_;
|
||||
Settings& settings_;
|
||||
ClockService& clock_;
|
||||
View view_ = View::Packets;
|
||||
ListModel packets_{kListRows};
|
||||
ListModel presets_{kListRows + 1};
|
||||
uint32_t shownSeq_ = 0; // the newest packet at the last redraw
|
||||
uint32_t selectedSeq_ = 0; // what the selection points at, kept as packets arrive
|
||||
bool followNewest_ = true; // until the user moves the selection off the top
|
||||
std::vector<std::string> details_;
|
||||
int detailsTop_ = 0;
|
||||
uint32_t lastDrawMs_ = 0;
|
||||
std::string message_;
|
||||
uint32_t messageMs_ = 0;
|
||||
// Sweep, only while shown: peak hold per step, and the waterfall, newest row first.
|
||||
static constexpr int kWaterfallRows = 36;
|
||||
uint32_t shownSweep_ = 0;
|
||||
std::vector<int8_t> peak_;
|
||||
std::vector<int8_t> waterfall_; // kWaterfallRows x steps
|
||||
uint16_t sweepSteps_ = 0;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
+124
-6
@@ -2,13 +2,17 @@
|
||||
#include <M5Cardputer.h>
|
||||
#include <SD.h>
|
||||
|
||||
|
||||
#include <atomic>
|
||||
#include <memory>
|
||||
|
||||
#include "app_manager.h"
|
||||
#include "apps/demo_app.h"
|
||||
#include "apps/gemini_app.h"
|
||||
#include "apps/gnss_app.h"
|
||||
#include "apps/irc_app.h"
|
||||
#include "apps/launcher_app.h"
|
||||
#include "apps/lora_scanner_app.h"
|
||||
#include "apps/settings_app.h"
|
||||
#include "apps/wifi_tools_app.h"
|
||||
#include "apps/setup_app.h"
|
||||
@@ -25,7 +29,11 @@
|
||||
#include "services/irc_service.h"
|
||||
#include "services/clock_service.h"
|
||||
#include "services/debug_console.h"
|
||||
#include "services/gemini_service.h"
|
||||
#include "services/gnss_service.h"
|
||||
#include "services/power_service.h"
|
||||
#include "services/lora_capture_service.h"
|
||||
#include "services/radio_service.h"
|
||||
#include "services/storage_service.h"
|
||||
#include "services/update_service.h"
|
||||
#include "services/wifi_service.h"
|
||||
@@ -50,6 +58,10 @@ static BatteryService* battery;
|
||||
static StorageService* storageService;
|
||||
static PowerService* power;
|
||||
static ClockService* clockService;
|
||||
static GnssService* gnssService;
|
||||
static RadioService* radioService;
|
||||
static LoraCaptureService* loraCapture;
|
||||
static GeminiService* geminiService;
|
||||
static SavedNetworks* savedNetworks;
|
||||
static WifiService* wifi;
|
||||
static IrcService* irc;
|
||||
@@ -88,6 +100,21 @@ static StatusInfo currentStatus() {
|
||||
s.sdLevel = storageState.level;
|
||||
s.compose = keyMapper.pendingCompose();
|
||||
s.unread = irc->totalUnread();
|
||||
if (gnssService && gnssService->on()) {
|
||||
const auto& g = gnssService->state();
|
||||
bool fresh = gnssService->receiving(millis());
|
||||
s.gnss = !fresh || g.fix == gnss::FixType::None ? StatusInfo::Gnss::Searching
|
||||
: g.fix == gnss::FixType::TwoD ? StatusInfo::Gnss::TwoD
|
||||
: StatusInfo::Gnss::ThreeD;
|
||||
s.gnssSatellites = g.satellitesUsed;
|
||||
s.tracking = gnssService->tracking();
|
||||
}
|
||||
if (radioService && radioService->sweeping()) s.radio = StatusInfo::Radio::Sweep;
|
||||
else if (radioService && radioService->listening()) {
|
||||
uint32_t last = radioService->lastPacketMs();
|
||||
s.radio = last && millis() - last < 400 ? StatusInfo::Radio::Packet : StatusInfo::Radio::Listening;
|
||||
}
|
||||
s.capturing = loraCapture && loraCapture->capturing();
|
||||
using WifiState = WifiController::State;
|
||||
switch (wifi->state()) {
|
||||
case WifiState::Connected: {
|
||||
@@ -107,6 +134,9 @@ static StatusInfo currentStatus() {
|
||||
// (UpdateService::tick) decides instead, and an unconfirmed image stays PENDING_VERIFY.
|
||||
extern "C" bool verifyRollbackLater() { return true; } // C linkage, or the weak default wins
|
||||
|
||||
// The main loop's stack: Arduino's default is 8 KB; the measured peak is 3 KB (M2).
|
||||
size_t getArduinoLoopTaskStackSize() { return 6144; }
|
||||
|
||||
static void setupSafeMode(int crashes);
|
||||
|
||||
void setup() {
|
||||
@@ -115,7 +145,7 @@ void setup() {
|
||||
int crashes = crash_report::noteBoot(nvs);
|
||||
safeMode = SafeMode::active(crashes);
|
||||
Serial.setRxBufferSize(2 * FileReceiver::kChunk); // before the port opens; sd put sends 1 chunk at a time
|
||||
Serial.setTxBufferSize(2048); // the console skips Serial when it's full: room for a burst like `tasks`
|
||||
Serial.setTxBufferSize(1024); // the console skips Serial when it's full: room for a burst like `tasks`
|
||||
|
||||
auto cfg = M5.config();
|
||||
M5Cardputer.begin(cfg, true);
|
||||
@@ -129,6 +159,9 @@ void setup() {
|
||||
storageService = new StorageService(bus);
|
||||
power = new PowerService(settings);
|
||||
clockService = new ClockService(settings, bus);
|
||||
geminiService = new GeminiService(nvs, *storageService, *clockService, bus);
|
||||
gnssService = new GnssService(settings, *clockService, *storageService, bus);
|
||||
radioService = new RadioService();
|
||||
savedNetworks = new SavedNetworks(nvs);
|
||||
savedNetworks->load();
|
||||
wifi = new WifiService(settings, *savedNetworks, *clockService);
|
||||
@@ -139,6 +172,10 @@ void setup() {
|
||||
services.add(*power);
|
||||
services.add(*clockService);
|
||||
services.add(*battery);
|
||||
services.add(*gnssService);
|
||||
services.add(*radioService);
|
||||
loraCapture = new LoraCaptureService(*radioService, *storageService, *clockService, bus);
|
||||
services.add(*loraCapture);
|
||||
services.add(*storageService);
|
||||
services.add(*wifi);
|
||||
services.add(*irc);
|
||||
@@ -152,6 +189,9 @@ void setup() {
|
||||
launcher.setManager(*apps);
|
||||
apps->registerApp({"irc", "IRC", false, new IrcApp(*irc, *clockService, bus)});
|
||||
apps->registerApp({"wifi-tools", "Wi-Fi Tools", false, new WifiToolsApp(*wifi, *storageService, *clockService)});
|
||||
apps->registerApp({"gnss", "GNSS", false, new GnssApp(*gnssService, settings)});
|
||||
apps->registerApp({"gemini", "Gemini", false, new GeminiApp(*geminiService)});
|
||||
apps->registerApp({"lora", "LoRa Scanner", false, new LoraScannerApp(*radioService, *loraCapture, settings, *clockService)});
|
||||
apps->registerApp({"settings", "Settings", false,
|
||||
new SettingsApp({settings, bus, *apps, *battery, *storageService, *clockService, *wifi, *savedNetworks, *update})});
|
||||
apps->registerApp({"demo", "Widget demo", true, new DemoApp(bus)});
|
||||
@@ -323,15 +363,22 @@ static const char* const kHelp =
|
||||
"reboot restart\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"
|
||||
"lora probe | lora status | lora rx on|off | lora preset <name> the LoRa radio, receive only\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 custom <MHz> <BW kHz> <SF> <CR 5-8> <sync hex> [preamble] e.g. 868.1 125 7 5 34 8 (LoRaWAN)\n"
|
||||
"gnss status | gnss restart | gnss track start|stop | gnss nmea on|off | gnss send <sentence without $ and checksum>\n"
|
||||
"crash the last crash: firmware, reason, task, backtrace\n"
|
||||
"coredump erase forget the core dump in flash\n"
|
||||
"key <name|char> press a key: up down left right select back home, or one character\n"
|
||||
"key <name|char> press a key: up down left right select back home del tab space, or one character\n"
|
||||
"wifi status | wifi add <ssid><TAB><password>\n"
|
||||
"irc start | irc dump | irc say <buffer> <text>\n"
|
||||
"gemini get <url> fetch a Gemini page and report header, size, certificate, heap\n"
|
||||
"irc start | irc stop | irc dump | irc say <buffer> <text>\n"
|
||||
"ls [folder] | rm <path> | install <path.ota> (Update from SD)\n"
|
||||
"sd list | cat <path> | log <text> | burst | sound on|off | short | normal\n"
|
||||
#ifdef RORO_DEBUG
|
||||
"crash abort|wdt crash on purpose (to test crash reports and Safe Mode)\n"
|
||||
"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"
|
||||
"reset (Debug Console only) restart at once, even if the main loop is stuck\n"
|
||||
"get <path> | put <path> <size> <sha256> | screenshot (Debug Console only) binary, see rdbg.py\n"
|
||||
@@ -384,6 +431,66 @@ static void runCommand(String line) {
|
||||
});
|
||||
}
|
||||
if (line.startsWith("install ")) update->installFromSd(line.substring(8).c_str()); // Update from SD
|
||||
if (line == "lora probe" && radioService) radioService->probe(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.startsWith("lora sweep") && radioService) { // on [from MHz] [to MHz] [step kHz] | off | dump
|
||||
if (line == "lora sweep dump") radioService->printSweep(console);
|
||||
else if (line == "lora sweep off") {
|
||||
radioService->setSweepEcho(false);
|
||||
radioService->sweep(false);
|
||||
} else if (line.startsWith("lora sweep on")) {
|
||||
double from = 863, to = 870, step = 100;
|
||||
sscanf(line.c_str() + 13, "%lf %lf %lf", &from, &to, &step);
|
||||
radioService->setSweepEcho(true);
|
||||
radioService->sweep(true, from * 1e6 + 0.5, to * 1e6 + 0.5, step * 1e3 + 0.5);
|
||||
}
|
||||
}
|
||||
if (line == "lora capture start" && loraCapture) {
|
||||
std::string why = loraCapture->start(millis());
|
||||
console.printf("lora capture: %s\n", why.empty() ? loraCapture->path().c_str() : why.c_str());
|
||||
}
|
||||
if (line == "lora capture stop" && loraCapture) loraCapture->stop();
|
||||
#ifdef RORO_DEBUG
|
||||
if (line.startsWith("lora inject ") && radioService) { // <hex> [rssi] [snr]: as if received
|
||||
String hex = line.substring(12);
|
||||
int space = hex.indexOf(' ');
|
||||
float rssi = -100, snr = 5;
|
||||
if (space > 0) sscanf(hex.c_str() + space + 1, "%f %f", &rssi, &snr), hex = hex.substring(0, space);
|
||||
uint8_t data[255];
|
||||
size_t n = 0;
|
||||
for (size_t i = 0; i + 1 < hex.length() && n < sizeof data; i += 2) data[n++] = strtoul(hex.substring(i, i + 2).c_str(), nullptr, 16);
|
||||
radioService->inject(data, n, rssi, snr);
|
||||
}
|
||||
#endif
|
||||
if (line.startsWith("lora custom ") && radioService) {
|
||||
double mhz = 0, bw = 0;
|
||||
unsigned sf = 0, cr = 0, sync = 0, preamble = 8;
|
||||
int n = sscanf(line.c_str() + 12, "%lf %lf %u %u %x %u", &mhz, &bw, &sf, &cr, &sync, &preamble);
|
||||
// Inside what the Cap's SX1262 tunes (868 to 923 MHz) and LoRa's own limits.
|
||||
if (n < 5 || mhz < 863 || mhz > 928 || bw < 7 || bw > 500 || sf < 5 || sf > 12 || cr < 5 || cr > 8 || sync > 0xFF)
|
||||
console.println("lora custom: usage: lora custom <MHz> <BW kHz> <SF 5-12> <CR 5-8> <sync hex> [preamble]");
|
||||
else {
|
||||
radioService->setConfig({static_cast<uint32_t>(mhz * 1e6 + 0.5), static_cast<float>(bw), static_cast<uint8_t>(sf),
|
||||
static_cast<uint8_t>(cr), static_cast<uint8_t>(sync), static_cast<uint16_t>(preamble), "Custom"});
|
||||
console.printf("lora custom: %.3f MHz, BW %.1f kHz, SF %u, CR 4/%u, sync 0x%02X, preamble %u\n", mhz, bw, sf, cr, sync, preamble);
|
||||
}
|
||||
}
|
||||
if (line.startsWith("lora preset ") && radioService) {
|
||||
const meshtastic::Preset* p = meshtastic::findPreset(line.substring(12).c_str());
|
||||
if (p) radioService->setPreset(*p);
|
||||
console.printf("lora preset: %s\n", p ? p->name : "unknown (LongFast LongSlow MediumSlow MediumFast ShortSlow ShortFast LongMod)");
|
||||
}
|
||||
if (line == "gnss status" && gnssService) gnssService->printStatus(console, millis());
|
||||
if ((line == "gnss nmea on" || line == "gnss nmea off") && gnssService) gnssService->setEcho(line.endsWith("on"));
|
||||
if (line == "gnss restart" && gnssService) gnssService->restart(millis());
|
||||
if (line == "gnss track start" && gnssService) {
|
||||
std::string why = gnssService->startTrack(millis());
|
||||
console.printf("gnss track: %s\n", why.empty() ? "recording" : why.c_str());
|
||||
}
|
||||
if (line == "gnss track stop" && gnssService) gnssService->stopTrack();
|
||||
if (line.startsWith("gnss send ") && gnssService) // the checksum is added
|
||||
console.println(gnssService->send(line.substring(10).c_str()) ? "gnss: sent" : "gnss: off");
|
||||
if (line == "crash") crash_report::print(console, nvs);
|
||||
if (line == "coredump erase") console.println(crash_report::erase() ? "coredump: erased" : "coredump: nothing to erase");
|
||||
#ifdef RORO_DEBUG
|
||||
@@ -394,11 +501,14 @@ static void runCommand(String line) {
|
||||
if (line == "burst")
|
||||
for (int i = 1; i <= 5; i++)
|
||||
bus.publish(Event::withText(EventType::Notification, ("Burst " + String(i)).c_str(), 0));
|
||||
if (line.startsWith("key ")) { // key up|down|left|right|select|back|home
|
||||
if (line.startsWith("key ")) { // key up|down|left|right|select|back|home|del|tab
|
||||
String k = line.substring(4);
|
||||
Key key = k == "up" ? Key::Up : k == "down" ? Key::Down : k == "left" ? Key::Left
|
||||
: k == "right" ? Key::Right : k == "back" ? Key::Back : k == "home" ? Key::Home : Key::Select;
|
||||
KeyEvent ev = k.length() == 1 && k[0] > ' ' ? KeyEvent::character((unsigned char)k[0]) : KeyEvent::of(key);
|
||||
: k == "right" ? Key::Right : k == "back" ? Key::Back : k == "home" ? Key::Home
|
||||
: k == "del" ? Key::Delete : k == "tab" ? Key::Tab : Key::Select;
|
||||
KeyEvent ev = k == "space" ? KeyEvent::character(' ')
|
||||
: k.length() == 1 && k[0] > ' ' ? KeyEvent::character((unsigned char)k[0])
|
||||
: KeyEvent::of(key);
|
||||
if (!power->onKey(millis())) apps->handleKey(ev);
|
||||
}
|
||||
if (line.startsWith("wifi add ")) { // wifi add <ssid>\t<password>: credentials never touch the repo
|
||||
@@ -431,7 +541,15 @@ static void runCommand(String line) {
|
||||
storageService->requestListing();
|
||||
listingWanted = true;
|
||||
}
|
||||
if (line.startsWith("gemini trust ")) { // gemini trust <host> <port> <sha256>: accept a changed certificate
|
||||
char host[96] = "", fp[80] = "";
|
||||
int port = 1965;
|
||||
if (geminiService && sscanf(line.substring(13).c_str(), "%95s %d %79s", host, &port, fp) == 3) geminiService->trust(host, port, fp);
|
||||
}
|
||||
if (line.startsWith("gemini get "))
|
||||
if (!geminiService || !geminiService->fetchToConsole(line.substring(11).c_str())) console.println("gemini: busy, or unavailable in Safe Mode");
|
||||
if (line == "irc start") irc->connect();
|
||||
if (line == "irc stop") irc->disconnect();
|
||||
if (line.startsWith("irc say ")) { // irc say <buffer index> <text>
|
||||
String rest = line.substring(8);
|
||||
int space = rest.indexOf(' ');
|
||||
|
||||
@@ -17,7 +17,7 @@ class Console : public Print {
|
||||
using Print::write;
|
||||
|
||||
#ifdef RORO_DEBUG
|
||||
static constexpr size_t kRingBytes = 6144;
|
||||
static constexpr size_t kRingBytes = 4096;
|
||||
|
||||
// Also copies ESP-IDF's own log lines into the ring (they still reach the serial port).
|
||||
void captureEspLogs();
|
||||
|
||||
@@ -14,4 +14,9 @@ constexpr int kSpiMosi = 14;
|
||||
constexpr int kSdCs = 12;
|
||||
constexpr int kLoraCs = 5;
|
||||
|
||||
// The SX1262 on the Cap (as in Meshtastic's board file for the Cardputer ADV).
|
||||
constexpr int kLoraReset = 3;
|
||||
constexpr int kLoraIrq = 4; // DIO1
|
||||
constexpr int kLoraBusy = 6;
|
||||
|
||||
} // namespace roro::pins
|
||||
|
||||
@@ -15,6 +15,7 @@
|
||||
#include <memory>
|
||||
|
||||
#include "file_receiver.h"
|
||||
#include "sha256.h"
|
||||
#include "platform/console.h"
|
||||
#include "version.h"
|
||||
|
||||
@@ -187,29 +188,7 @@ bool DebugConsole::binaryCommand(NetworkClient& client, const std::string& line)
|
||||
return true;
|
||||
}
|
||||
|
||||
bool DebugConsole::onStorage(std::function<void()> job) {
|
||||
// Shared with the job, which outlives this wait if the card is missing and it never starts.
|
||||
// Exactly one side wins the state change: the job (Queued -> Running) or the wait giving up
|
||||
// (Queued -> Abandoned), so an abandoned job can never touch this stack frame.
|
||||
enum : int { Queued, Running, Abandoned };
|
||||
struct Run {
|
||||
std::atomic<int> state{Queued};
|
||||
SemaphoreHandle_t done = xSemaphoreCreateBinary();
|
||||
~Run() { vSemaphoreDelete(done); }
|
||||
};
|
||||
auto run = std::make_shared<Run>();
|
||||
storage_.runJob([run, job]() {
|
||||
int expected = Queued;
|
||||
if (!run->state.compare_exchange_strong(expected, Running)) return;
|
||||
job();
|
||||
xSemaphoreGive(run->done);
|
||||
});
|
||||
for (int waited = 0; xSemaphoreTake(run->done, pdMS_TO_TICKS(500)) != pdTRUE; waited += 500) {
|
||||
int expected = Queued;
|
||||
if (waited >= 5000 && run->state.compare_exchange_strong(expected, Abandoned)) return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
bool DebugConsole::onStorage(std::function<void()> job) { return storage_.runAndWait(std::move(job)); }
|
||||
|
||||
void DebugConsole::get(NetworkClient& client, const std::string& path) {
|
||||
bool ran = onStorage([&]() {
|
||||
@@ -255,11 +234,20 @@ void DebugConsole::put(NetworkClient& client, const std::string& args) {
|
||||
const auto& c = r.chunk();
|
||||
bool ok = f.write(c.data(), c.size()) == c.size();
|
||||
// A card can fail one write and take the next. FATFS keeps a failed file in error,
|
||||
// so: close, cut back to the last good byte, reopen, try again.
|
||||
// so: close, cut back to the last good byte, reopen, try again. Earlier chunks may
|
||||
// have been lost with the write buffer (M3: 3 KB came back as zeros): never extend
|
||||
// the file to cover them; give up instead, as the sender can't resend them.
|
||||
for (int retry = 1; !ok && retry <= 3; retry++) {
|
||||
console.printf("put: write failed at %u, retry %d\n", (unsigned)r.received(), retry);
|
||||
f.close();
|
||||
delay(50 * retry);
|
||||
f = SD.open(part.c_str(), FILE_READ);
|
||||
size_t onCard = f ? f.size() : 0;
|
||||
if (f) f.close();
|
||||
if (onCard < r.received()) {
|
||||
console.printf("put: the card lost %u B written before\n", (unsigned)(r.received() - onCard));
|
||||
break;
|
||||
}
|
||||
truncate(("/sd" + part).c_str(), r.received());
|
||||
f = SD.open(part.c_str(), FILE_APPEND);
|
||||
ok = f && f.size() == r.received() && f.write(c.data(), c.size()) == c.size();
|
||||
@@ -276,6 +264,15 @@ void DebugConsole::put(NetworkClient& client, const std::string& args) {
|
||||
}
|
||||
}
|
||||
f.close();
|
||||
if (r.state() == S::Finishing) { // read it back: the received checksum doesn't cover the card
|
||||
Sha256 sha;
|
||||
f = SD.open(part.c_str(), FILE_READ);
|
||||
for (int n; f && (n = f.read(buf, sizeof buf)) > 0;) sha.update(buf, n);
|
||||
if (f) f.close();
|
||||
uint8_t digest[32];
|
||||
sha.finish(digest);
|
||||
r.cardChecked(digest);
|
||||
}
|
||||
if (r.state() == S::Finishing) {
|
||||
if (SD.exists(r.path().c_str())) SD.remove(r.path().c_str());
|
||||
r.finished(SD.rename(part.c_str(), r.path().c_str()));
|
||||
|
||||
@@ -0,0 +1,803 @@
|
||||
#include "services/gemini_service.h"
|
||||
|
||||
#include <NetworkClientSecure.h>
|
||||
#include <SD.h>
|
||||
#include <WiFi.h>
|
||||
#include <esp_heap_caps.h>
|
||||
|
||||
#include <algorithm>
|
||||
#include <map>
|
||||
|
||||
#include "gemini_url.h"
|
||||
#include "gemtext.h"
|
||||
#include "platform/console.h"
|
||||
#include "sha256.h"
|
||||
#include "storage_paths.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
using gemini::TextBuffer;
|
||||
|
||||
namespace {
|
||||
|
||||
constexpr uint32_t kIdleTimeoutMs = 15000;
|
||||
constexpr const char* kSavedRoot = "/gemini/saved";
|
||||
constexpr const char* kSavedMark = "> Saved from "; // first line of a Saved Page (Q82)
|
||||
constexpr const char* kDefaults =
|
||||
"## Start here\n"
|
||||
"=> gemini://geminiprotocol.net/ Project Gemini\n"
|
||||
"=> gemini://kennedy.gemi.dev/ Kennedy: search Geminispace\n"
|
||||
"=> gemini://skyjake.fi/~Cosmos/ Cosmos: what's new on Geminispace\n"
|
||||
"=> gemini://bbs.geminispace.org/ Bubble: a bulletin board\n";
|
||||
|
||||
std::string hex(const uint8_t* data, size_t len) {
|
||||
static const char* digits = "0123456789abcdef";
|
||||
std::string out;
|
||||
for (size_t i = 0; i < len; i++) {
|
||||
out += digits[data[i] >> 4];
|
||||
out += digits[data[i] & 15];
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
// Folders for a file path, one at a time (SD.mkdir makes one level).
|
||||
void makeParents(const std::string& path) {
|
||||
for (size_t slash = path.find('/', 1); slash != std::string::npos; slash = path.find('/', slash + 1)) {
|
||||
std::string dir = path.substr(0, slash);
|
||||
if (!SD.exists(dir.c_str())) SD.mkdir(dir.c_str());
|
||||
}
|
||||
}
|
||||
|
||||
// Copies `from` to `to`, optionally after a first line. On the storage task.
|
||||
bool copyFile(const char* from, const std::string& to, const std::string& firstLine) {
|
||||
File in = SD.open(from);
|
||||
if (!in) return false;
|
||||
makeParents(to);
|
||||
File out = SD.open(to.c_str(), FILE_WRITE);
|
||||
if (!out) return false;
|
||||
bool ok = firstLine.empty() || out.print((firstLine + "\n").c_str()) > 0;
|
||||
uint8_t buf[512];
|
||||
int n;
|
||||
while (ok && (n = in.read(buf, sizeof buf)) > 0) ok = out.write(buf, n) == static_cast<size_t>(n);
|
||||
out.close();
|
||||
in.close();
|
||||
if (!ok) SD.remove(to.c_str());
|
||||
return ok;
|
||||
}
|
||||
|
||||
struct SavedEntry {
|
||||
std::string path; // /gemini/saved/host/…/name.gmi
|
||||
time_t when;
|
||||
};
|
||||
|
||||
void listSaved(const std::string& dir, std::vector<SavedEntry>& out) {
|
||||
File d = SD.open(dir.c_str());
|
||||
if (!d || !d.isDirectory()) return;
|
||||
for (File f = d.openNextFile(); f && out.size() < 200; f = d.openNextFile()) {
|
||||
std::string path = dir + "/" + f.name();
|
||||
if (f.isDirectory()) listSaved(path, out);
|
||||
else out.push_back({path, f.getLastWrite()});
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
const char* GeminiService::slotPath(int slot) {
|
||||
static const char* const kPaths[] = {"/gemini/cache/page0.gmi", "/gemini/cache/page1.gmi", "/gemini/cache/work.gmi"};
|
||||
return kPaths[slot];
|
||||
}
|
||||
|
||||
const char* GeminiService::cacheOf(const std::string& url) const {
|
||||
for (int s = 0; s < 3; s++)
|
||||
if (!url.empty() && slotUrl_[s] == url) return slotPath(s);
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
GeminiService::GeminiService(KeyValueStore& store, StorageService& storage, ClockService& clock, EventBus& bus)
|
||||
: store_(store), storage_(storage), clock_(clock), bus_(bus), lock_(xSemaphoreCreateMutex()) {}
|
||||
|
||||
// NVS keys are 15 characters at most: "gm" and 12 hex digits of SHA-256("host:port").
|
||||
std::string GeminiService::pinKey(const std::string& host, int port) const {
|
||||
std::string id = host + ":" + std::to_string(port);
|
||||
uint8_t digest[32];
|
||||
Sha256::hash(reinterpret_cast<const uint8_t*>(id.data()), id.size(), digest);
|
||||
return "gm" + hex(digest, 6);
|
||||
}
|
||||
|
||||
void GeminiService::trust(const std::string& host, int port, const std::string& fingerprint) {
|
||||
store_.putString(pinKey(host, port).c_str(), fingerprint);
|
||||
}
|
||||
|
||||
std::string GeminiService::now() const {
|
||||
int64_t t = clock_.utcNow();
|
||||
return t < 0 ? "an unknown date" : ClockModel::formatLocalDate(t) + " " + ClockModel::formatLocalTime(t);
|
||||
}
|
||||
|
||||
void GeminiService::notify(const std::string& text) {
|
||||
bus_.publish(Event::withText(EventType::Notification, text.c_str(), static_cast<int32_t>(NotificationLevel::Info)));
|
||||
}
|
||||
|
||||
bool GeminiService::start(Job job) {
|
||||
if (busy_) return false;
|
||||
busy_ = true;
|
||||
ready_ = messageReady_ = cancel_ = false;
|
||||
job_ = job;
|
||||
if (xTaskCreate(taskEntry, "gemini", 6144, this, 1, nullptr) != pdPASS) { // peak 3.6 KB (step 1)
|
||||
busy_ = false;
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
bool GeminiService::fetch(const std::string& url, bool preferSaved) {
|
||||
if (busy_) return false;
|
||||
arg_ = url;
|
||||
preferSaved_ = preferSaved;
|
||||
return start(Job::Fetch);
|
||||
}
|
||||
|
||||
bool GeminiService::fetchToConsole(const std::string& url) {
|
||||
if (busy_) return false;
|
||||
toConsole_ = true;
|
||||
if (!fetch(url)) {
|
||||
toConsole_ = false;
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
bool GeminiService::save(const std::string& url) {
|
||||
if (busy_) return false;
|
||||
arg_ = url;
|
||||
return start(Job::Save);
|
||||
}
|
||||
|
||||
bool GeminiService::saveWithLinks(const std::string& url, std::vector<std::string> links) {
|
||||
if (busy_) return false;
|
||||
arg_ = url;
|
||||
links_ = std::move(links);
|
||||
return start(Job::SaveWithLinks);
|
||||
}
|
||||
|
||||
bool GeminiService::refresh(const std::string& savedPath) {
|
||||
if (busy_) return false;
|
||||
arg_ = savedPath;
|
||||
return start(Job::Refresh);
|
||||
}
|
||||
|
||||
bool GeminiService::deleteSaved(const std::string& savedPath) {
|
||||
if (busy_) return false;
|
||||
arg_ = savedPath;
|
||||
return start(Job::Delete);
|
||||
}
|
||||
|
||||
bool GeminiService::addBookmark(const std::string& url, const std::string& title) {
|
||||
if (busy_) return false;
|
||||
arg_ = url;
|
||||
arg2_ = title;
|
||||
return start(Job::Bookmark);
|
||||
}
|
||||
|
||||
bool GeminiService::download(const std::string& url) {
|
||||
if (busy_) return false;
|
||||
arg_ = url;
|
||||
return start(Job::Download);
|
||||
}
|
||||
|
||||
bool GeminiService::loadWindow(const GeminiPage& page, size_t firstLine) {
|
||||
if (busy_ || page.backing.empty()) return false;
|
||||
windowPage_ = GeminiPage();
|
||||
windowPage_.backing = page.backing;
|
||||
windowPage_.totalLines = page.totalLines;
|
||||
windowPage_.lineIndex = page.lineIndex;
|
||||
windowLine_ = firstLine;
|
||||
// The App drops its current window once the new one is in: count that memory as coming back.
|
||||
windowReleasing_ = page.text.bytes() + page.text.lineCount() * kBytesPerLine;
|
||||
return start(Job::Window);
|
||||
}
|
||||
|
||||
bool GeminiService::takeResult(GeminiPage& out) {
|
||||
if (!ready_) return false;
|
||||
xSemaphoreTake(lock_, portMAX_DELAY);
|
||||
out = std::move(result_);
|
||||
result_ = GeminiPage();
|
||||
ready_ = false;
|
||||
xSemaphoreGive(lock_);
|
||||
return true;
|
||||
}
|
||||
|
||||
bool GeminiService::takeMessage(std::string& out) {
|
||||
if (!messageReady_) return false;
|
||||
xSemaphoreTake(lock_, portMAX_DELAY);
|
||||
out = std::move(message_);
|
||||
messageReady_ = false;
|
||||
xSemaphoreGive(lock_);
|
||||
return true;
|
||||
}
|
||||
|
||||
void GeminiService::finishWithMessage(const std::string& text) {
|
||||
xSemaphoreTake(lock_, portMAX_DELAY);
|
||||
message_ = text;
|
||||
messageReady_ = true;
|
||||
xSemaphoreGive(lock_);
|
||||
}
|
||||
|
||||
void GeminiService::taskEntry(void* self) {
|
||||
static_cast<GeminiService*>(self)->run();
|
||||
vTaskDelete(nullptr);
|
||||
}
|
||||
|
||||
void GeminiService::run() {
|
||||
switch (job_) {
|
||||
case Job::Fetch: {
|
||||
GeminiPage page;
|
||||
runFetch(page);
|
||||
if (!toConsole_) {
|
||||
xSemaphoreTake(lock_, portMAX_DELAY);
|
||||
result_ = std::move(page);
|
||||
ready_ = true;
|
||||
xSemaphoreGive(lock_);
|
||||
}
|
||||
toConsole_ = false;
|
||||
break;
|
||||
}
|
||||
case Job::Save: {
|
||||
std::string why = saveCached(arg_);
|
||||
finishWithMessage(!why.empty() ? why : replaced_ ? "Saved again (replaced the older copy)" : "Saved for offline reading");
|
||||
break;
|
||||
}
|
||||
case Job::SaveWithLinks: {
|
||||
std::string why = saveCached(arg_);
|
||||
if (!why.empty()) {
|
||||
finishWithMessage(why);
|
||||
break;
|
||||
}
|
||||
int saved = 1, failed = 0, total = static_cast<int>(links_.size()) + 1;
|
||||
notify("Saving " + std::to_string(total) + " pages for offline reading");
|
||||
for (const std::string& link : links_) {
|
||||
if (cancel_) break;
|
||||
GeminiPage page;
|
||||
fetchFollowing(link, page, false, kWorkSlot);
|
||||
bool text = page.outcome == GeminiPage::Outcome::Ok &&
|
||||
page.header.category() == gemini::Category::Success && page.header.mimeType() == "text/gemini";
|
||||
if (text && saveCached(link).empty()) saved++;
|
||||
else failed++;
|
||||
if ((saved + failed) % 5 == 0) notify("Saved " + std::to_string(saved) + " of " + std::to_string(total));
|
||||
}
|
||||
std::string done = "Saved " + std::to_string(saved) + " of " + std::to_string(total) + " pages" +
|
||||
(failed ? " (" + std::to_string(failed) + " not gemtext or failed)" : "");
|
||||
notify(done);
|
||||
finishWithMessage(done);
|
||||
break;
|
||||
}
|
||||
case Job::Refresh: {
|
||||
// Only the first line: where it came from. (Loading the whole page here, next to the
|
||||
// App's copy and a TLS connection, once took the heap down to 436 bytes.)
|
||||
std::string from = savedFrom(arg_);
|
||||
if (from.empty()) {
|
||||
finishWithMessage("Not a Saved Page");
|
||||
break;
|
||||
}
|
||||
GeminiPage page;
|
||||
fetchFollowing(from, page, false, kWorkSlot);
|
||||
std::string why = page.outcome != GeminiPage::Outcome::Ok ? page.error
|
||||
: page.header.category() != gemini::Category::Success ? page.header.meta
|
||||
: saveCached(from);
|
||||
finishWithMessage(why.empty() ? "Refreshed" : "Not refreshed: " + why);
|
||||
break;
|
||||
}
|
||||
case Job::Window: {
|
||||
// Q86 both ways: old and new together above the transient floor for a moment, and the
|
||||
// new one alone (once the old is dropped) leaving the steady floor.
|
||||
size_t free = esp_get_free_heap_size();
|
||||
size_t transient = free > kTransientFloor + TextBuffer::kChunk ? free - kTransientFloor - TextBuffer::kChunk : 0;
|
||||
size_t steady = free + windowReleasing_ > kSteadyFloor + TextBuffer::kChunk
|
||||
? free + windowReleasing_ - kSteadyFloor - TextBuffer::kChunk
|
||||
: 0;
|
||||
size_t budget = std::min(transient, steady);
|
||||
GeminiPage page = std::move(windowPage_);
|
||||
page.windowStart = windowLine_ - windowLine_ % kIndexEvery;
|
||||
page.windowed = true;
|
||||
page.windowOf = page.backing;
|
||||
page.outcome = GeminiPage::Outcome::Ok;
|
||||
readWindow(page, page.windowStart, std::min(budget, kMaxBody));
|
||||
console.printf("gemini: window from line %u: %u lines\n", (unsigned)page.windowStart,
|
||||
(unsigned)page.text.lineCount());
|
||||
xSemaphoreTake(lock_, portMAX_DELAY);
|
||||
result_ = std::move(page);
|
||||
ready_ = true;
|
||||
xSemaphoreGive(lock_);
|
||||
break;
|
||||
}
|
||||
case Job::Delete: {
|
||||
bool removed = false;
|
||||
bool ran = storage_.runAndWait([&]() { removed = SD.remove(arg_.c_str()); });
|
||||
finishWithMessage(!ran ? "No SD card" : removed ? "Deleted" : "Not deleted");
|
||||
break;
|
||||
}
|
||||
case Job::Bookmark: {
|
||||
std::string line = "=> " + arg_ + (arg2_.empty() ? "" : " " + arg2_), already;
|
||||
bool ran = storage_.runAndWait([&]() {
|
||||
File f = SD.open(kBookmarks);
|
||||
while (f && f.available()) {
|
||||
String l = f.readStringUntil('\n');
|
||||
if (l.startsWith(("=> " + arg_ + " ").c_str()) || l == ("=> " + arg_).c_str()) already = "yes";
|
||||
}
|
||||
if (f) f.close();
|
||||
if (!already.empty()) return;
|
||||
makeParents(kBookmarks);
|
||||
File out = SD.open(kBookmarks, FILE_APPEND);
|
||||
if (out) {
|
||||
out.print((line + "\n").c_str());
|
||||
out.close();
|
||||
}
|
||||
});
|
||||
finishWithMessage(!ran ? "No SD card" : !already.empty() ? "Already bookmarked" : "Bookmarked");
|
||||
break;
|
||||
}
|
||||
case Job::Download: {
|
||||
gemini::Url u;
|
||||
std::string name = gemini::parseUrl(arg_, u) ? u.path.substr(u.path.rfind('/') + 1) : "";
|
||||
if (name.empty()) name = "download";
|
||||
std::string to = "/gemini/downloads/" + storage::sanitize(name);
|
||||
bool copied = false;
|
||||
if (const char* from = cacheOf(arg_)) storage_.runAndWait([&]() { copied = copyFile(from, to, ""); });
|
||||
finishWithMessage(copied ? "Saved to " + to : "Not saved (no card, or the page is gone)");
|
||||
break;
|
||||
}
|
||||
}
|
||||
busy_ = false;
|
||||
}
|
||||
|
||||
void GeminiService::runFetch(GeminiPage& page) {
|
||||
page.requested = arg_;
|
||||
size_t before = esp_get_free_heap_size();
|
||||
lowest_ = before;
|
||||
uint32_t started = millis();
|
||||
const std::string& url = arg_;
|
||||
if (url == kStartUrl) composeStart(page);
|
||||
else if (url.rfind("file://", 0) == 0) openSaved(url.substr(7), page);
|
||||
else {
|
||||
// Inside a Saved Page, a link to another Saved Page opens the saved copy (Q84).
|
||||
bool savedCopy = false;
|
||||
if (preferSaved_) {
|
||||
std::string path = gemini::savedPath(url);
|
||||
storage_.runAndWait([&]() { savedCopy = SD.exists(path.c_str()); });
|
||||
if (savedCopy) openSaved(path, page);
|
||||
}
|
||||
if (!savedCopy) {
|
||||
if (preferSaved_ && !WiFi.isConnected()) {
|
||||
page.url = url;
|
||||
page.error = "Not saved, and offline";
|
||||
} else
|
||||
{
|
||||
int slot = nextDisplay_;
|
||||
fetchFollowing(url, page, true, slot);
|
||||
if (page.outcome == GeminiPage::Outcome::Ok && !page.cachePath.empty())
|
||||
nextDisplay_ = 1 - slot; // keep this one: it backs the page on screen
|
||||
}
|
||||
}
|
||||
}
|
||||
page.ms = millis() - started;
|
||||
if (toConsole_) report(page, before, lowest_);
|
||||
}
|
||||
|
||||
// One request, following up to kMaxRedirects redirects.
|
||||
void GeminiService::fetchFollowing(const std::string& first, GeminiPage& page, bool loadIntoRam, int slot) {
|
||||
std::string url = first;
|
||||
size_t free = esp_get_free_heap_size();
|
||||
if (free < kStartFloor) { // Q86, for every fetch: pages, saves, refreshes
|
||||
page.url = url;
|
||||
page.outcome = GeminiPage::Outcome::Failed;
|
||||
page.error = "Not enough memory (" + std::to_string(free / 1024) + " KB free): stop IRC or retry";
|
||||
return;
|
||||
}
|
||||
for (int hop = 0;; hop++) {
|
||||
fetchOne(url, page, loadIntoRam, slot);
|
||||
if (page.outcome != GeminiPage::Outcome::Ok || page.header.category() != gemini::Category::Redirect) break;
|
||||
std::string next = gemini::resolve(url, page.header.meta);
|
||||
if (!gemini::isGemini(next)) {
|
||||
page.outcome = GeminiPage::Outcome::Failed;
|
||||
page.error = "Redirect to another protocol: " + next;
|
||||
break;
|
||||
}
|
||||
if (hop + 1 > kMaxRedirects) {
|
||||
page.outcome = GeminiPage::Outcome::Failed;
|
||||
page.error = "Too many redirects";
|
||||
break;
|
||||
}
|
||||
url = next;
|
||||
}
|
||||
page.url = url;
|
||||
}
|
||||
|
||||
// A Saved Page's first line: "> Saved from <url> on <date>" (Q82). Empty if it isn't one.
|
||||
std::string GeminiService::savedFirstLine(const std::string& path) {
|
||||
std::string first;
|
||||
storage_.runAndWait([&]() {
|
||||
File f = SD.open(path.c_str());
|
||||
if (!f) return;
|
||||
char buf[600];
|
||||
size_t n = f.readBytesUntil('\n', buf, sizeof buf - 1);
|
||||
buf[n] = 0;
|
||||
first = buf;
|
||||
f.close();
|
||||
});
|
||||
if (!first.empty() && first.back() == '\r') first.pop_back();
|
||||
return first.rfind(kSavedMark, 0) == 0 ? first : "";
|
||||
}
|
||||
|
||||
std::string GeminiService::savedFrom(const std::string& path) {
|
||||
std::string first = savedFirstLine(path);
|
||||
if (first.empty()) return "";
|
||||
std::string rest = first.substr(strlen(kSavedMark));
|
||||
return rest.substr(0, rest.find(" on "));
|
||||
}
|
||||
|
||||
// A Saved Page from the card, as far as memory allows; its first line says where it came from.
|
||||
void GeminiService::openSaved(const std::string& path, GeminiPage& page) {
|
||||
page.url = "file://" + path;
|
||||
page.header.status = 20;
|
||||
page.header.meta = "text/gemini";
|
||||
bool found = false;
|
||||
storage_.runAndWait([&]() { found = SD.exists(path.c_str()); });
|
||||
std::string first = found ? savedFirstLine(path) : "";
|
||||
if (!found) {
|
||||
page.error = "This Saved Page is gone";
|
||||
return;
|
||||
}
|
||||
if (first.rfind(kSavedMark, 0) == 0) {
|
||||
std::string rest = first.substr(strlen(kSavedMark));
|
||||
size_t on = rest.find(" on ");
|
||||
page.savedFrom = rest.substr(0, on);
|
||||
page.savedOn = on == std::string::npos ? "" : rest.substr(on + 4);
|
||||
}
|
||||
loadFromCard(page, esp_get_free_heap_size(), path);
|
||||
page.outcome = GeminiPage::Outcome::Ok;
|
||||
}
|
||||
|
||||
// about:start (Q78, Q84): bookmarks, then Saved Pages by capsule, newest first, then defaults.
|
||||
void GeminiService::composeStart(GeminiPage& page) {
|
||||
std::string doc = "# Gemini\nTab picks a link, Enter follows it, Back returns, g types an address. "
|
||||
"On a page: b bookmarks it, s saves it to read offline, S with the pages it links to.\n";
|
||||
std::string bookmarks;
|
||||
std::vector<SavedEntry> saved;
|
||||
bool card = storage_.runAndWait([&]() {
|
||||
File f = SD.open(kBookmarks);
|
||||
while (f && f.available() && bookmarks.size() < 8192) {
|
||||
String l = f.readStringUntil('\n');
|
||||
if (l.startsWith("=>")) bookmarks += std::string(l.c_str()) + "\n";
|
||||
}
|
||||
if (f) f.close();
|
||||
listSaved(kSavedRoot, saved);
|
||||
});
|
||||
doc += "## Bookmarks\n";
|
||||
doc += !card ? "No SD card: bookmarks and Saved Pages live on it.\n"
|
||||
: bookmarks.empty() ? "None yet: b on a page adds it here.\n" : bookmarks;
|
||||
if (!saved.empty()) {
|
||||
// Capsules ordered by their newest Saved Page, pages newest first within each.
|
||||
std::sort(saved.begin(), saved.end(), [](const SavedEntry& a, const SavedEntry& b) { return a.when > b.when; });
|
||||
std::vector<std::string> order;
|
||||
std::map<std::string, std::string> byHost;
|
||||
size_t root = strlen(kSavedRoot) + 1;
|
||||
for (auto& e : saved) {
|
||||
std::string rel = e.path.substr(root);
|
||||
std::string host = rel.substr(0, rel.find('/'));
|
||||
if (!byHost.count(host)) order.push_back(host);
|
||||
std::string label = rel.substr(host.size() + 1);
|
||||
if (label.size() > 4 && label.compare(label.size() - 4, 4, ".gmi") == 0) label.resize(label.size() - 4);
|
||||
char day[24] = "";
|
||||
if (e.when > 1000000000) {
|
||||
struct tm t;
|
||||
localtime_r(&e.when, &t);
|
||||
strftime(day, sizeof day, " (%d %b)", &t);
|
||||
}
|
||||
byHost[host] += "=> file://" + e.path + " " + label + day + "\n";
|
||||
}
|
||||
doc += "## Saved pages\n";
|
||||
for (auto& host : order) doc += "### " + host + "\n" + byHost[host];
|
||||
}
|
||||
doc += kDefaults;
|
||||
page.url = kStartUrl;
|
||||
page.header.status = 20;
|
||||
page.header.meta = "text/gemini";
|
||||
page.text.append(doc.data(), doc.size());
|
||||
page.text.finish();
|
||||
page.outcome = GeminiPage::Outcome::Ok;
|
||||
}
|
||||
|
||||
// The cached body of `url` (fetched again if the cache holds something else) to its Saved Page.
|
||||
std::string GeminiService::saveCached(const std::string& url) {
|
||||
if (!gemini::isGemini(url)) return "Only Gemini pages can be saved";
|
||||
if (!storage_.state().present) return "No SD card";
|
||||
const char* from = cacheOf(url);
|
||||
if (!from) {
|
||||
GeminiPage page;
|
||||
fetchFollowing(url, page, false, kWorkSlot);
|
||||
if (page.outcome != GeminiPage::Outcome::Ok) return page.error;
|
||||
if (page.header.category() != gemini::Category::Success) return page.header.meta;
|
||||
from = cacheOf(page.url);
|
||||
if (!from) return "Not saved";
|
||||
}
|
||||
std::string to = gemini::savedPath(url);
|
||||
bool existed = false, ok = false;
|
||||
replaced_ = false;
|
||||
std::string header = std::string(kSavedMark) + url + " on " + now();
|
||||
storage_.runAndWait([&]() {
|
||||
existed = SD.exists(to.c_str());
|
||||
ok = copyFile(from, to, header);
|
||||
});
|
||||
if (!ok) return "Writing to the SD card failed";
|
||||
replaced_ = existed; // Q82: saving again replaces it, and says so
|
||||
return "";
|
||||
}
|
||||
|
||||
void GeminiService::fetchOne(const std::string& url, GeminiPage& page, bool loadIntoRam, int slot) {
|
||||
page.outcome = GeminiPage::Outcome::Failed;
|
||||
page.text.clear();
|
||||
page.truncated = false;
|
||||
gemini::Url u;
|
||||
if (!gemini::parseUrl(url, u) || u.scheme != "gemini") {
|
||||
page.error = "Not a Gemini URL: " + url;
|
||||
return;
|
||||
}
|
||||
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
|
||||
NetworkClientSecure tls;
|
||||
tls.setInsecure(); // trust on first use: the pinned fingerprint is what counts (Q71)
|
||||
tls.setTimeout(15);
|
||||
if (!tls.connect(u.host.c_str(), u.portOrDefault())) {
|
||||
page.error = "Cannot connect to " + u.host;
|
||||
return;
|
||||
}
|
||||
track();
|
||||
uint8_t sha[32];
|
||||
if (!tls.getFingerprintSHA256(sha)) {
|
||||
page.error = "No certificate from " + u.host;
|
||||
return;
|
||||
}
|
||||
std::string presented = hex(sha, sizeof sha), pinned;
|
||||
std::string key = pinKey(u.host, u.portOrDefault());
|
||||
if (!store_.getString(key.c_str(), pinned)) store_.putString(key.c_str(), presented); // first use
|
||||
else if (pinned != presented) {
|
||||
page.outcome = GeminiPage::Outcome::CertificateChanged;
|
||||
page.host = u.host;
|
||||
page.port = u.portOrDefault();
|
||||
page.pinned = pinned;
|
||||
page.presented = presented;
|
||||
page.error = "The certificate of " + u.host + " changed";
|
||||
return;
|
||||
}
|
||||
|
||||
tls.print((gemini::requestUrl(url) + "\r\n").c_str());
|
||||
std::string header;
|
||||
bool inBody = false;
|
||||
uint32_t last = millis();
|
||||
char buf[512];
|
||||
while (!cancel_) {
|
||||
int n = tls.available() ? tls.read(reinterpret_cast<uint8_t*>(buf), sizeof buf) : 0;
|
||||
if (n <= 0) {
|
||||
if (!tls.connected()) break;
|
||||
if (millis() - last > kIdleTimeoutMs) {
|
||||
page.error = "Timed out";
|
||||
return;
|
||||
}
|
||||
delay(5);
|
||||
continue;
|
||||
}
|
||||
last = millis();
|
||||
int i = 0;
|
||||
while (!inBody && i < n) {
|
||||
char c = buf[i++];
|
||||
if (c == '\n') inBody = true;
|
||||
else if (c != '\r') header += c;
|
||||
if (header.size() > 1100) {
|
||||
page.error = "Malformed response header";
|
||||
return;
|
||||
}
|
||||
}
|
||||
if (!inBody) continue;
|
||||
if (!gemini::parseHeader(header, page.header)) {
|
||||
page.error = "Malformed response header";
|
||||
return;
|
||||
}
|
||||
if (page.header.category() != gemini::Category::Success) break; // no body to read
|
||||
// With a card, the body goes there while the connection is open (only 4 KB in RAM),
|
||||
// and comes back into RAM once the connection's memory is free again.
|
||||
if (storage_.state().present) {
|
||||
slotUrl_[slot].clear();
|
||||
if (!receiveToCard(tls, buf + i, n - i, page, slot)) return;
|
||||
tls.stop();
|
||||
slotUrl_[slot] = url;
|
||||
if (loadIntoRam) loadFromCard(page, freeBefore, slotPath(slot));
|
||||
page.outcome = GeminiPage::Outcome::Ok;
|
||||
return;
|
||||
}
|
||||
// Q86, two floors: once the connection closes, its ~50 KB comes back, so the page may use
|
||||
// what was free before minus the steady floor; meanwhile the heap must stay above the
|
||||
// transient floor. Both counted with the next 4 KB chunk and the line index.
|
||||
size_t take = std::min<size_t>(n - i, kMaxBody - page.text.bytes());
|
||||
size_t pageCost = page.text.bytes() + page.text.lineCount() * kBytesPerLine + TextBuffer::kChunk + take;
|
||||
if (take < static_cast<size_t>(n - i)) page.truncatedWhy = "longer than 64 KB";
|
||||
else if (freeBefore < kSteadyFloor + pageCost) page.truncatedWhy = "not enough memory to keep it";
|
||||
else if (esp_get_free_heap_size() < kTransientFloor + TextBuffer::kChunk + take)
|
||||
page.truncatedWhy = "not enough memory while receiving";
|
||||
if (!page.truncatedWhy.empty()) {
|
||||
page.truncated = true;
|
||||
break;
|
||||
}
|
||||
page.text.append(buf + i, take);
|
||||
track();
|
||||
}
|
||||
if (cancel_) {
|
||||
page.error = "Cancelled";
|
||||
return;
|
||||
}
|
||||
if (!inBody && !gemini::parseHeader(header, page.header)) { // a header with no line end
|
||||
page.error = header.empty() ? "Empty response" : "Malformed response header";
|
||||
return;
|
||||
}
|
||||
page.text.finish();
|
||||
page.outcome = GeminiPage::Outcome::Ok;
|
||||
}
|
||||
|
||||
// Streams the rest of the body to a cache file in 1 KB pieces, each written by the storage task:
|
||||
// with IRC's TLS connection and this one both open, every KB of RAM counts (Q86).
|
||||
|
||||
bool GeminiService::receiveToCard(NetworkClientSecure& tls, const char* first, size_t len, GeminiPage& page, int slot) {
|
||||
struct Cache {
|
||||
File file;
|
||||
};
|
||||
auto cache = std::make_shared<Cache>();
|
||||
bool opened = storage_.runAndWait([cache, slot]() {
|
||||
SD.mkdir("/gemini");
|
||||
SD.mkdir("/gemini/cache");
|
||||
cache->file = SD.open(slotPath(slot), FILE_WRITE);
|
||||
});
|
||||
if (!opened || !cache->file) {
|
||||
page.error = "Can't write to the SD card";
|
||||
return false;
|
||||
}
|
||||
std::string pending(first, len);
|
||||
constexpr size_t kPiece = 1024;
|
||||
pending.reserve(kPiece + 512);
|
||||
bool ok = true;
|
||||
auto flush = [&]() {
|
||||
if (pending.empty() || !ok) return;
|
||||
ok = storage_.runAndWait([cache, &pending, &ok]() {
|
||||
ok = cache->file.write(reinterpret_cast<const uint8_t*>(pending.data()), pending.size()) == pending.size();
|
||||
}) && ok;
|
||||
page.receivedBytes += pending.size();
|
||||
pending.clear();
|
||||
};
|
||||
uint32_t last = millis();
|
||||
char buf[512];
|
||||
while (!cancel_ && ok) {
|
||||
if (pending.size() >= kPiece) flush();
|
||||
if (page.receivedBytes + pending.size() >= kMaxOnCard) {
|
||||
page.truncated = true;
|
||||
page.truncatedWhy = "longer than 1 MB";
|
||||
break;
|
||||
}
|
||||
int n = tls.available() ? tls.read(reinterpret_cast<uint8_t*>(buf), sizeof buf) : 0;
|
||||
if (n <= 0) {
|
||||
if (!tls.connected()) break;
|
||||
if (millis() - last > kIdleTimeoutMs) break; // keep what came
|
||||
delay(5);
|
||||
continue;
|
||||
}
|
||||
last = millis();
|
||||
pending.append(buf, n);
|
||||
lowest_ = std::min<size_t>(lowest_, esp_get_free_heap_size());
|
||||
}
|
||||
flush();
|
||||
storage_.runAndWait([cache]() { cache->file.close(); });
|
||||
if (cancel_) page.error = "Cancelled";
|
||||
else if (!ok) page.error = "Writing to the SD card failed";
|
||||
else page.cachePath = slotPath(slot);
|
||||
return !cancel_ && ok;
|
||||
}
|
||||
|
||||
// Back into RAM, now that the connection's memory is free again: one pass over the file counts
|
||||
// its lines and indexes every kIndexEvery-th, and loads lines while the steady floor allows (Q86).
|
||||
// If they don't all fit, the page is windowed: the App asks for other windows as you scroll.
|
||||
void GeminiService::loadFromCard(GeminiPage& page, size_t freeBefore, const std::string& path) {
|
||||
size_t budget = freeBefore > kSteadyFloor + TextBuffer::kChunk ? freeBefore - kSteadyFloor - TextBuffer::kChunk : 0;
|
||||
budget = std::min(budget, kMaxBody);
|
||||
page.backing = path;
|
||||
page.lineIndex.clear();
|
||||
page.totalLines = 0;
|
||||
page.windowStart = 0;
|
||||
bool loading = true;
|
||||
storage_.runAndWait([&]() {
|
||||
File f = SD.open(path.c_str());
|
||||
if (!f) return;
|
||||
std::string line;
|
||||
uint32_t offset = 0, lineStart = 0;
|
||||
bool pre = false;
|
||||
auto endLine = [&]() {
|
||||
if (page.totalLines % kIndexEvery == 0) page.lineIndex.push_back(lineStart | (pre ? 0x80000000u : 0));
|
||||
if (line.compare(0, 3, "```") == 0) pre = !pre;
|
||||
if (loading) {
|
||||
if (page.text.bytes() + page.text.lineCount() * kBytesPerLine + line.size() + 1 > budget) loading = false;
|
||||
else {
|
||||
line += '\n';
|
||||
page.text.append(line.data(), line.size());
|
||||
}
|
||||
}
|
||||
page.totalLines++;
|
||||
line.clear();
|
||||
};
|
||||
char buf[512];
|
||||
int n;
|
||||
while ((n = f.read(reinterpret_cast<uint8_t*>(buf), sizeof buf)) > 0) {
|
||||
for (int i = 0; i < n; i++, offset++) {
|
||||
if (buf[i] == '\n') {
|
||||
endLine();
|
||||
lineStart = offset + 1;
|
||||
} else if (line.size() < kMaxLineBytes) line += buf[i];
|
||||
}
|
||||
}
|
||||
if (!line.empty()) endLine();
|
||||
f.close();
|
||||
});
|
||||
page.text.finish();
|
||||
page.windowed = !loading;
|
||||
if (page.windowed)
|
||||
console.printf("gemini: %s is windowed: %u of %u lines in memory\n", path.c_str(),
|
||||
(unsigned)page.text.lineCount(), (unsigned)page.totalLines);
|
||||
}
|
||||
|
||||
// Lines from `firstLine` on, from the page's file, as many as `budget` allows.
|
||||
void GeminiService::readWindow(GeminiPage& page, size_t firstLine, size_t budget) {
|
||||
size_t entry = firstLine / kIndexEvery;
|
||||
if (entry >= page.lineIndex.size()) return;
|
||||
storage_.runAndWait([&]() {
|
||||
File f = SD.open(page.backing.c_str());
|
||||
if (!f || !f.seek(page.lineIndex[entry] & 0x7FFFFFFFu)) return;
|
||||
size_t lineNo = entry * kIndexEvery;
|
||||
std::string line;
|
||||
char buf[512];
|
||||
int n;
|
||||
bool done = false;
|
||||
while (!done && (n = f.read(reinterpret_cast<uint8_t*>(buf), sizeof buf)) > 0) {
|
||||
for (int i = 0; i < n && !done; i++) {
|
||||
if (buf[i] != '\n') {
|
||||
if (line.size() < kMaxLineBytes) line += buf[i];
|
||||
continue;
|
||||
}
|
||||
if (lineNo >= firstLine) {
|
||||
if (page.text.bytes() + page.text.lineCount() * kBytesPerLine + line.size() + 1 > budget) done = true;
|
||||
else {
|
||||
line += '\n';
|
||||
page.text.append(line.data(), line.size());
|
||||
}
|
||||
}
|
||||
lineNo++;
|
||||
line.clear();
|
||||
}
|
||||
}
|
||||
if (!done && !line.empty() && lineNo >= firstLine) page.text.append(line.data(), line.size());
|
||||
f.close();
|
||||
});
|
||||
page.text.finish();
|
||||
}
|
||||
|
||||
void GeminiService::report(const GeminiPage& page, size_t heapBefore, size_t heapLowest) {
|
||||
console.printf("gemini: %s -> %s, %lu ms\n", page.requested.c_str(), page.url.c_str(), (unsigned long)page.ms);
|
||||
if (page.outcome != GeminiPage::Outcome::Ok) console.printf("gemini: %s\n", page.error.c_str());
|
||||
else console.printf("gemini: %d %s, %u bytes, %u lines%s\n", page.header.status, page.header.meta.c_str(),
|
||||
(unsigned)page.text.bytes(), (unsigned)page.text.lineCount(),
|
||||
page.truncated ? (" (truncated: " + page.truncatedWhy + ")").c_str() : "");
|
||||
if (page.outcome == GeminiPage::Outcome::CertificateChanged)
|
||||
console.printf("gemini: pinned %s\ngemini: now %s\n", page.pinned.c_str(), page.presented.c_str());
|
||||
for (size_t i = 0; i < page.text.lineCount() && i < 6; i++) console.printf(" %s\n", page.text.line(i).substr(0, 100).c_str());
|
||||
if (!page.cachePath.empty())
|
||||
console.printf("gemini: %u bytes on the card in %s\n", (unsigned)page.receivedBytes, page.cachePath.c_str());
|
||||
console.printf("gemini: heap %u before, %u lowest seen, %u after\n", (unsigned)heapBefore, (unsigned)heapLowest,
|
||||
(unsigned)esp_get_free_heap_size());
|
||||
}
|
||||
|
||||
|
||||
} // namespace roro
|
||||
@@ -0,0 +1,147 @@
|
||||
#pragma once
|
||||
|
||||
#include <freertos/FreeRTOS.h>
|
||||
#include <freertos/semphr.h>
|
||||
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include "event_bus.h"
|
||||
#include "gemini_response.h"
|
||||
#include "key_value_store.h"
|
||||
#include "services/clock_service.h"
|
||||
#include "services/storage_service.h"
|
||||
#include "text_buffer.h"
|
||||
|
||||
class NetworkClientSecure;
|
||||
|
||||
namespace roro {
|
||||
|
||||
// What a fetch came back with.
|
||||
struct GeminiPage {
|
||||
enum class Outcome { Ok, Failed, CertificateChanged };
|
||||
Outcome outcome = Outcome::Failed;
|
||||
std::string requested; // what was asked for
|
||||
std::string url; // where it ended up, after redirects (file://… for a Saved Page)
|
||||
gemini::Header header; // the final response's header
|
||||
gemini::TextBuffer text; // 2x only: the body as lines, up to kMaxBody
|
||||
bool truncated = false; // the body was cut: see truncatedWhy
|
||||
std::string truncatedWhy;
|
||||
std::string error; // Failed: why, for a human
|
||||
std::string host; // CertificateChanged: whose, and both fingerprints
|
||||
int port = 1965;
|
||||
std::string pinned, presented;
|
||||
std::string cachePath; // with a card: the whole body as received (Saved Pages copy it)
|
||||
size_t receivedBytes = 0; // the whole body, which may be more than `text` holds
|
||||
std::string savedFrom; // a Saved Page: the URL it was saved from (links resolve against it)
|
||||
std::string savedOn; // and when, "2026-10-05 01:20"
|
||||
uint32_t ms = 0;
|
||||
// A page bigger than memory allows is read from its file as you scroll: `text` then holds
|
||||
// lines [windowStart, windowStart + text.lineCount()) of totalLines. lineIndex has where every
|
||||
// 64th line starts in the file (bit 31: inside a preformatted block there).
|
||||
std::string backing; // the file the page is in (a cache file or a Saved Page)
|
||||
bool windowed = false;
|
||||
size_t totalLines = 0, windowStart = 0;
|
||||
std::vector<uint32_t> lineIndex;
|
||||
std::string windowOf; // a window result: the backing file it belongs to
|
||||
|
||||
// What relative links resolve against.
|
||||
const std::string& base() const { return savedFrom.empty() ? url : savedFrom; }
|
||||
};
|
||||
|
||||
// Gemini (docs/milestones/G1.md). Everything that touches the network or the SD card runs as one
|
||||
// job at a time on a short-lived task of its own: a TLS handshake or a missing card can block for
|
||||
// seconds, which the main loop's watchdog wouldn't allow, and an idle client should cost no stack.
|
||||
// Certificates are trusted on first use, per host and port (Q71).
|
||||
class GeminiService {
|
||||
public:
|
||||
static constexpr size_t kMaxBody = 64 * 1024; // Q74
|
||||
static constexpr size_t kStartFloor = 55 * 1024; // Q86: no fetch below this
|
||||
static constexpr size_t kSteadyFloor = 40 * 1024; // Q86: what must be left once the page is in
|
||||
static constexpr size_t kTransientFloor = 20 * 1024; // Q86: while the TLS connection is open
|
||||
static constexpr int kMaxRedirects = 5; // Q72
|
||||
static constexpr size_t kMaxOnCard = 1024 * 1024; // a text page larger than this is cut
|
||||
static constexpr int kMaxLinkedPages = 30; // Q83
|
||||
static constexpr size_t kIndexEvery = 64; // lines between lineIndex entries
|
||||
static constexpr size_t kMaxLineBytes = 8192; // longer lines are cut
|
||||
// What a page costs per line on top of its text: TextBuffer's index (8) and the App's tables
|
||||
// (type, first row, links: about 8). Counting only the first left the steady floor 1.5 to 3 KB
|
||||
// short on a windowed page (found in M3).
|
||||
static constexpr size_t kBytesPerLine = 16;
|
||||
static constexpr const char* kBookmarks = "/gemini/bookmarks.gmi";
|
||||
static constexpr const char* kStartUrl = "about:start";
|
||||
|
||||
GeminiService(KeyValueStore& store, StorageService& storage, ClockService& clock, EventBus& bus);
|
||||
|
||||
// Pages: gemini://…, about:start (bookmarks, Saved Pages, defaults) or file:///gemini/saved/….
|
||||
// `preferSaved`: open the Saved Page of that URL if there is one (inside a Saved Page, Q84).
|
||||
bool fetch(const std::string& url, bool preferSaved = false);
|
||||
// Actions; each reports one line through takeMessage().
|
||||
bool save(const std::string& url); // s (Q82)
|
||||
bool saveWithLinks(const std::string& url, std::vector<std::string> links); // S (Q83)
|
||||
bool refresh(const std::string& savedPath); // r on a Saved Page
|
||||
bool deleteSaved(const std::string& savedPath); // d on a Saved Page (Q85)
|
||||
bool addBookmark(const std::string& url, const std::string& title); // b (Q77)
|
||||
bool download(const std::string& url); // s on a non-text page (Q73)
|
||||
// The window of a big page starting at `firstLine` (a multiple of kIndexEvery), from its file.
|
||||
bool loadWindow(const GeminiPage& page, size_t firstLine);
|
||||
|
||||
bool busy() const { return busy_; }
|
||||
bool takeResult(GeminiPage& out);
|
||||
bool takeMessage(std::string& out);
|
||||
void cancel() { cancel_ = true; }
|
||||
// After the user accepts a changed certificate.
|
||||
void trust(const std::string& host, int port, const std::string& fingerprint);
|
||||
|
||||
// `gemini get <url>`: the same fetch, reported on the console instead of to the App.
|
||||
bool fetchToConsole(const std::string& url);
|
||||
|
||||
private:
|
||||
enum class Job { Fetch, Save, SaveWithLinks, Refresh, Delete, Bookmark, Download, Window };
|
||||
// Cache files: two take turns for pages on screen (the one shown is never overwritten by the
|
||||
// next), one for jobs (saving linked pages, refreshing).
|
||||
static constexpr int kWorkSlot = 2;
|
||||
static const char* slotPath(int slot);
|
||||
|
||||
bool start(Job job);
|
||||
static void taskEntry(void* self);
|
||||
void run();
|
||||
void runFetch(GeminiPage& page);
|
||||
void fetchFollowing(const std::string& url, GeminiPage& page, bool loadIntoRam, int slot);
|
||||
void fetchOne(const std::string& url, GeminiPage& page, bool loadIntoRam, int slot);
|
||||
bool receiveToCard(::NetworkClientSecure& tls, const char* first, size_t len, GeminiPage& page, int slot);
|
||||
void loadFromCard(GeminiPage& page, size_t freeBefore, const std::string& path);
|
||||
void readWindow(GeminiPage& page, size_t firstLine, size_t budget);
|
||||
void openSaved(const std::string& path, GeminiPage& page);
|
||||
std::string savedFirstLine(const std::string& path);
|
||||
std::string savedFrom(const std::string& path);
|
||||
void composeStart(GeminiPage& page);
|
||||
std::string saveCached(const std::string& url); // "" or what went wrong
|
||||
const char* cacheOf(const std::string& url) const; // the cache file holding url's body, or nullptr
|
||||
void finishWithMessage(const std::string& text);
|
||||
void notify(const std::string& text);
|
||||
void report(const GeminiPage& page, size_t heapBefore, size_t heapLowest);
|
||||
std::string pinKey(const std::string& host, int port) const;
|
||||
std::string now() const;
|
||||
|
||||
KeyValueStore& store_;
|
||||
StorageService& storage_;
|
||||
ClockService& clock_;
|
||||
EventBus& bus_;
|
||||
SemaphoreHandle_t lock_;
|
||||
Job job_ = Job::Fetch;
|
||||
std::string arg_, arg2_;
|
||||
std::vector<std::string> links_;
|
||||
bool preferSaved_ = false;
|
||||
GeminiPage result_;
|
||||
std::string message_;
|
||||
std::string slotUrl_[3]; // the URL whose body each cache file holds
|
||||
int nextDisplay_ = 0;
|
||||
size_t windowLine_ = 0, windowReleasing_ = 0;
|
||||
GeminiPage windowPage_;
|
||||
bool replaced_ = false; // the last save replaced an older copy
|
||||
volatile bool busy_ = false, ready_ = false, messageReady_ = false, cancel_ = false, toConsole_ = false;
|
||||
size_t lowest_ = 0;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -0,0 +1,203 @@
|
||||
#include "services/gnss_service.h"
|
||||
|
||||
#include <Arduino.h>
|
||||
#include <SD.h>
|
||||
|
||||
#include <algorithm>
|
||||
#include <cstdio>
|
||||
|
||||
#include "platform/console.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
namespace {
|
||||
const char* fixName(gnss::FixType f) {
|
||||
return f == gnss::FixType::ThreeD ? "3D" : f == gnss::FixType::TwoD ? "2D" : "none";
|
||||
}
|
||||
} // namespace
|
||||
|
||||
GnssService::GnssService(const Settings& settings, ClockService& clock, StorageService& storage, EventBus& bus)
|
||||
: settings_(settings), clock_(clock), storage_(storage), bus_(bus) {
|
||||
parser_.onLine = [this](const std::string& line) {
|
||||
lastLineMs_ = millis();
|
||||
if (echo_) console.printf("nmea: %s\n", line.c_str());
|
||||
};
|
||||
}
|
||||
|
||||
void GnssService::start() {
|
||||
open(millis());
|
||||
storage_.runJob([this]() { closeUnfinishedTracks(); });
|
||||
}
|
||||
|
||||
void GnssService::stop() { close(); }
|
||||
|
||||
void GnssService::open(uint32_t nowMs) {
|
||||
Serial1.setRxBufferSize(512); // before begin(): over a second of NMEA, read every 50 ms
|
||||
Serial1.begin(kBaud, SERIAL_8N1, kRxPin, kTxPin);
|
||||
open_ = true;
|
||||
active_ = false; // tick() wakes it or puts it to sleep, per the setting
|
||||
standbyMs_ = 0;
|
||||
}
|
||||
|
||||
void GnssService::wake(uint32_t nowMs) {
|
||||
send("PCAS10,0"); // hot start: ends a standby, keeps what the receiver knows
|
||||
active_ = true;
|
||||
openedMs_ = nowMs;
|
||||
firstFixMs_ = 0;
|
||||
lastLineMs_ = 0;
|
||||
lastFix_ = gnss::FixType::None;
|
||||
console.println("gnss: on");
|
||||
}
|
||||
|
||||
void GnssService::standby(uint32_t nowMs) {
|
||||
if (tracking()) stopTrack();
|
||||
send("PCAS12,65535");
|
||||
if (active_) console.println("gnss: off (receiver in standby)");
|
||||
active_ = false;
|
||||
standbyMs_ = nowMs;
|
||||
}
|
||||
|
||||
void GnssService::close() {
|
||||
if (!open_) return;
|
||||
Serial1.end();
|
||||
open_ = active_ = false;
|
||||
lastLineMs_ = 0;
|
||||
}
|
||||
|
||||
void GnssService::tick(uint32_t nowMs) {
|
||||
if (!open_) open(nowMs);
|
||||
bool wanted = settings_.getBool(Setting::GnssEnabled);
|
||||
if (wanted && !active_) wake(nowMs);
|
||||
if (!wanted && (active_ || !standbyMs_ || nowMs - standbyMs_ >= kStandbyRenewMs)) standby(nowMs);
|
||||
|
||||
char buf[128];
|
||||
for (int avail; (avail = Serial1.available()) > 0;) {
|
||||
size_t n = Serial1.read(reinterpret_cast<uint8_t*>(buf), std::min<size_t>(avail, sizeof buf));
|
||||
if (n == 0) break;
|
||||
bytes_ += n;
|
||||
if (active_) parser_.feed(buf, n); // in standby: the last lines before it, discarded
|
||||
}
|
||||
|
||||
if (!active_) return;
|
||||
const gnss::GnssState& s = parser_.state();
|
||||
if (s.fix != lastFix_) {
|
||||
if (s.fix != gnss::FixType::None && !firstFixMs_) {
|
||||
firstFixMs_ = nowMs - openedMs_;
|
||||
console.printf("gnss: first Fix after %lu s\n", (unsigned long)(firstFixMs_ / 1000));
|
||||
}
|
||||
console.printf("gnss: Fix %s, %d satellites used\n", fixName(s.fix), s.satellitesUsed);
|
||||
lastFix_ = s.fix;
|
||||
}
|
||||
recordPoint(nowMs);
|
||||
// GNSS time is the most trusted source (ClockModel): set it with a Fix, then now and then.
|
||||
if (s.timeValid && s.fix != gnss::FixType::None && (!clockSetMs_ || nowMs - clockSetMs_ >= kClockEveryMs)) {
|
||||
if (clock_.set(s.utcSeconds(), TimeSource::Gnss) && !clockSetMs_) console.println("gnss: clock set");
|
||||
clockSetMs_ = nowMs;
|
||||
}
|
||||
}
|
||||
|
||||
void GnssService::notify(const std::string& text) {
|
||||
bus_.publish(Event::withText(EventType::Notification, text.c_str(), static_cast<int32_t>(NotificationLevel::Info)));
|
||||
}
|
||||
|
||||
std::string GnssService::startTrack(uint32_t nowMs) {
|
||||
if (tracking()) return "";
|
||||
if (!active_) return "GNSS is off";
|
||||
if (!storage_.state().present) return "No SD card";
|
||||
int64_t now = clock_.utcNow();
|
||||
if (now < 0) return "Waiting for the time (a Fix or Wi-Fi)";
|
||||
trackPath_ = gnss::trackPath(now);
|
||||
std::string name = trackPath_.substr(trackPath_.rfind('/') + 1);
|
||||
name = name.substr(0, name.size() - 4); // without ".gpx"
|
||||
storage_.appendLine(trackPath_, gnss::gpx::header(name), true);
|
||||
trackPoints_ = 0;
|
||||
trackStartMs_ = nowMs;
|
||||
trackRule_.reset();
|
||||
console.printf("gnss: Track %s started\n", trackPath_.c_str());
|
||||
notify("Track started");
|
||||
return "";
|
||||
}
|
||||
|
||||
void GnssService::stopTrack() {
|
||||
if (!tracking()) return;
|
||||
storage_.appendLine(trackPath_, gnss::gpx::footer(), true);
|
||||
console.printf("gnss: Track %s saved, %d points\n", trackPath_.c_str(), trackPoints_);
|
||||
notify("Track saved: " + std::to_string(trackPoints_) + (trackPoints_ == 1 ? " point" : " points"));
|
||||
trackPath_.clear();
|
||||
}
|
||||
|
||||
void GnssService::recordPoint(uint32_t nowMs) {
|
||||
const gnss::GnssState& s = parser_.state();
|
||||
if (!tracking() || !s.positionValid || !s.timeValid) return;
|
||||
if (!trackRule_.due(nowMs, s.latitude, s.longitude)) return;
|
||||
storage_.appendLine(trackPath_,
|
||||
gnss::gpx::point(s.latitude, s.longitude, s.altitudeValid, s.altitudeM, s.utcSeconds()), true);
|
||||
trackPoints_++;
|
||||
}
|
||||
|
||||
// A Track cut short by a power loss or a crash has no footer: GPX readers refuse it. Close it.
|
||||
void GnssService::closeUnfinishedTracks() {
|
||||
File dir = SD.open("/gnss/tracks");
|
||||
if (!dir || !dir.isDirectory()) return;
|
||||
int closed = 0;
|
||||
for (File f = dir.openNextFile(); f; f = dir.openNextFile()) {
|
||||
std::string name = f.name();
|
||||
if (f.isDirectory() || name.size() < 4 || name.compare(name.size() - 4, 4, ".gpx") != 0) continue;
|
||||
char tail[32] = {};
|
||||
size_t size = f.size();
|
||||
f.seek(size > sizeof tail - 1 ? size - (sizeof tail - 1) : 0);
|
||||
f.read(reinterpret_cast<uint8_t*>(tail), sizeof tail - 1);
|
||||
f.close();
|
||||
if (gnss::gpx::finished(tail)) continue;
|
||||
File out = SD.open(("/gnss/tracks/" + name).c_str(), FILE_APPEND);
|
||||
if (out) {
|
||||
out.print(("\n" + gnss::gpx::footer() + "\n").c_str());
|
||||
out.close();
|
||||
closed++;
|
||||
}
|
||||
}
|
||||
if (closed) console.printf("gnss: closed %d unfinished Track(s)\n", closed);
|
||||
}
|
||||
|
||||
bool GnssService::send(const std::string& body) {
|
||||
if (!open_) return false;
|
||||
uint8_t sum = 0;
|
||||
for (char c : body) sum ^= static_cast<uint8_t>(c);
|
||||
char tail[8];
|
||||
std::snprintf(tail, sizeof tail, "*%02X\r\n", sum);
|
||||
std::string line = "$" + body + tail;
|
||||
Serial1.write(reinterpret_cast<const uint8_t*>(line.data()), line.size());
|
||||
return true;
|
||||
}
|
||||
|
||||
void GnssService::printStatus(Print& out, uint32_t nowMs) const {
|
||||
if (!active_) return (void)out.println("gnss: off (receiver in standby)");
|
||||
const gnss::GnssState& s = parser_.state();
|
||||
out.printf("gnss: %s, Fix %s, %d used, %u in view, HDOP %.1f\n",
|
||||
receiving(nowMs) ? "receiving" : "silent", fixName(s.fix), s.satellitesUsed,
|
||||
(unsigned)s.satellites.size(), s.hdop);
|
||||
if (s.positionValid)
|
||||
out.printf("gnss: %.6f %.6f, %s%.0f m, %.1f km/h\n", s.latitude, s.longitude,
|
||||
s.altitudeValid ? "" : "altitude unknown ", s.altitudeM, s.speedKmh);
|
||||
if (s.timeValid)
|
||||
out.printf("gnss: %04d-%02d-%02d %02d:%02d:%02d UTC\n", s.year, s.month, s.day, s.hour, s.minute, s.second);
|
||||
int perSystem[8] = {}, usedPerSystem[8] = {};
|
||||
for (auto& sat : s.satellites) {
|
||||
perSystem[static_cast<int>(sat.system)]++;
|
||||
if (sat.used) usedPerSystem[static_cast<int>(sat.system)]++;
|
||||
}
|
||||
out.print("gnss: in view (used)");
|
||||
for (int c = 1; c < 7; c++)
|
||||
if (perSystem[c])
|
||||
out.printf(" %s %d (%d)", gnss::constellationName(static_cast<gnss::Constellation>(c)), perSystem[c],
|
||||
usedPerSystem[c]);
|
||||
out.println();
|
||||
if (tracking())
|
||||
out.printf("gnss: recording %s, %d points, %lu s\n", trackPath_.c_str(), trackPoints_,
|
||||
(unsigned long)((nowMs - trackStartMs_) / 1000));
|
||||
out.printf("gnss: up %lu s, first Fix %s, %lu bytes, %lu sentences, %lu bad\n", (unsigned long)((nowMs - openedMs_) / 1000),
|
||||
firstFixMs_ ? (std::to_string(firstFixMs_ / 1000) + " s").c_str() : "not yet", (unsigned long)bytes_,
|
||||
(unsigned long)parser_.goodSentences(), (unsigned long)parser_.badSentences());
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -0,0 +1,84 @@
|
||||
#pragma once
|
||||
|
||||
#include <Print.h>
|
||||
|
||||
#include <string>
|
||||
|
||||
#include "event_bus.h"
|
||||
#include "nmea_parser.h"
|
||||
#include "service.h"
|
||||
#include "services/clock_service.h"
|
||||
#include "services/storage_service.h"
|
||||
#include "settings.h"
|
||||
#include "track.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
// The GNSS receiver on the Cap LoRa-1262 (see CONTEXT.md and docs/milestones/M2.md): reads its
|
||||
// NMEA from the main loop's tick (about 450 bytes/s, so a 512-byte UART buffer covers a second),
|
||||
// holds the current Fix, and sets the clock from it. Settings → GNSS switches it on and off.
|
||||
class GnssService : public Service {
|
||||
public:
|
||||
static constexpr int kRxPin = 15, kTxPin = 13; // measured: M2 step 1
|
||||
static constexpr uint32_t kBaud = 115200;
|
||||
static constexpr uint32_t kSilentAfterMs = 3000; // no sentence for this long: receiver silent
|
||||
static constexpr uint32_t kClockEveryMs = 600000; // refresh the clock from the Fix this often
|
||||
// Off (Q58, measured): "$PCAS12,<s>" puts the receiver in standby for that long, and any
|
||||
// command wakes it. Standby is renewed while off, in case the duration is clamped.
|
||||
static constexpr uint32_t kStandbyRenewMs = 3600000;
|
||||
|
||||
GnssService(const Settings& settings, ClockService& clock, StorageService& storage, EventBus& bus);
|
||||
const char* name() const override { return "gnss"; }
|
||||
uint32_t tickIntervalMs() const override { return 50; }
|
||||
void start() override;
|
||||
void stop() override;
|
||||
void tick(uint32_t nowMs) override;
|
||||
|
||||
bool on() const { return active_; }
|
||||
bool receiving(uint32_t nowMs) const { return active_ && lastLineMs_ && nowMs - lastLineMs_ < kSilentAfterMs; }
|
||||
const gnss::GnssState& state() const { return parser_.state(); }
|
||||
uint32_t onSinceMs() const { return openedMs_; } // when the receiver was last woken
|
||||
|
||||
// Debug aids (Q68): raw sentences to the console, a status report, and sending a command
|
||||
// ("PCAS10,0" becomes "$PCAS10,0*1C\r\n").
|
||||
void setEcho(bool echo) { echo_ = echo; }
|
||||
void printStatus(Print& out, uint32_t nowMs) const;
|
||||
bool send(const std::string& body);
|
||||
// Tracks (Q63): GPX on the SD card, a point every 5 s once moved 5 m, recorded in the
|
||||
// background whatever App is open. startTrack() returns why it can't, or "".
|
||||
std::string startTrack(uint32_t nowMs);
|
||||
void stopTrack();
|
||||
bool tracking() const { return !trackPath_.empty(); }
|
||||
int trackPoints() const { return trackPoints_; }
|
||||
uint32_t trackStartMs() const { return trackStartMs_; }
|
||||
|
||||
void restart(uint32_t nowMs) {
|
||||
close();
|
||||
open(nowMs);
|
||||
}
|
||||
|
||||
private:
|
||||
void open(uint32_t nowMs); // the UART; the receiver's state follows the setting in tick()
|
||||
void close();
|
||||
void wake(uint32_t nowMs);
|
||||
void recordPoint(uint32_t nowMs);
|
||||
void closeUnfinishedTracks(); // on the storage task
|
||||
void notify(const std::string& text);
|
||||
void standby(uint32_t nowMs);
|
||||
|
||||
const Settings& settings_;
|
||||
ClockService& clock_;
|
||||
StorageService& storage_;
|
||||
EventBus& bus_;
|
||||
gnss::NmeaParser parser_;
|
||||
bool open_ = false, active_ = false, echo_ = false;
|
||||
uint32_t bytes_ = 0, standbyMs_ = 0;
|
||||
uint32_t openedMs_ = 0, lastLineMs_ = 0, firstFixMs_ = 0, clockSetMs_ = 0;
|
||||
gnss::FixType lastFix_ = gnss::FixType::None;
|
||||
std::string trackPath_;
|
||||
int trackPoints_ = 0;
|
||||
uint32_t trackStartMs_ = 0;
|
||||
gnss::TrackRule trackRule_;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -33,16 +33,23 @@ IrcService::IrcService(KeyValueStore& store, const std::string& defaultNick, Wif
|
||||
void IrcService::start() {
|
||||
if (task_) return;
|
||||
lock_ = xSemaphoreCreateMutex();
|
||||
xTaskCreate(taskEntry, "irc", 8192, this, 1, &task_);
|
||||
xTaskCreate(taskEntry, "irc", 6144, this, 1, &task_); // peak 4.0 KB (TLS handshake, M2)
|
||||
}
|
||||
|
||||
void IrcService::connect() {
|
||||
stoppedByUser_ = false;
|
||||
if (wanted_) return;
|
||||
retryAtMs_ = millis();
|
||||
backoff_.reset();
|
||||
wanted_ = true;
|
||||
}
|
||||
|
||||
void IrcService::disconnect() {
|
||||
stoppedByUser_ = true;
|
||||
stopRequested_ = true; // the IRC task says QUIT and closes; nothing to do if it never started
|
||||
if (!task_) wanted_ = false;
|
||||
}
|
||||
|
||||
int IrcService::totalUnread() {
|
||||
Lock l(lock_);
|
||||
return session_->totalUnread();
|
||||
@@ -176,13 +183,10 @@ void IrcService::flushEffects() {
|
||||
status_ = Status::Online;
|
||||
backoff_.reset();
|
||||
}
|
||||
if (quit && open_) {
|
||||
delay(300); // let QUIT reach the server
|
||||
close("");
|
||||
wanted_ = false;
|
||||
status_ = Status::Stopped;
|
||||
Lock l(lock_);
|
||||
session_->disconnected(clock_.utcNow(), "disconnected");
|
||||
if (quit) { // /quit: QUIT is already on its way if connected; stop in any state
|
||||
stoppedByUser_ = true;
|
||||
stopRequested_ = true;
|
||||
quitSent_ = true;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -192,6 +196,19 @@ void IrcService::loop() {
|
||||
bool wifiUp = wifi_.state() == WifiController::State::Connected;
|
||||
bool monitoring = wifi_.state() == WifiController::State::Monitoring;
|
||||
|
||||
if (stopRequested_) {
|
||||
stopRequested_ = false;
|
||||
if (open_) {
|
||||
if (!quitSent_) conn_->print("QUIT :roro9stack\r\n");
|
||||
vTaskDelay(pdMS_TO_TICKS(300)); // let QUIT reach the server
|
||||
close("");
|
||||
}
|
||||
quitSent_ = false;
|
||||
wanted_ = false;
|
||||
status_ = Status::Stopped;
|
||||
Lock l(lock_);
|
||||
session_->disconnected(clock_.utcNow(), "disconnected (Enter reconnects)");
|
||||
}
|
||||
if (restart_) {
|
||||
restart_ = false;
|
||||
if (open_) {
|
||||
|
||||
@@ -31,9 +31,12 @@ class IrcService : public Service {
|
||||
const char* name() const override { return "irc"; }
|
||||
void start() override;
|
||||
|
||||
// Starts the session (the IRC App does this when opened); /quit stops it.
|
||||
// Starts the session (the IRC App does this when opened, unless you stopped it).
|
||||
void connect();
|
||||
// Stops it, from any state: says QUIT if connected, and stops retrying. /quit, `irc stop`.
|
||||
void disconnect();
|
||||
bool running() const { return wanted_; }
|
||||
bool stoppedByUser() const { return stoppedByUser_; }
|
||||
Status status() const { return status_; }
|
||||
|
||||
// Read or act on the session while holding its lock: withSession([](IrcSession& s) { ... }).
|
||||
@@ -78,6 +81,9 @@ class IrcService : public Service {
|
||||
ReconnectPolicy backoff_;
|
||||
std::string partial_;
|
||||
volatile bool wanted_ = false;
|
||||
volatile bool stoppedByUser_ = false; // a manual stop: opening the App doesn't reconnect
|
||||
volatile bool stopRequested_ = false;
|
||||
bool quitSent_ = false; // /quit already queued its QUIT
|
||||
volatile bool restart_ = false;
|
||||
volatile Status status_ = Status::Stopped;
|
||||
bool open_ = false;
|
||||
|
||||
@@ -0,0 +1,62 @@
|
||||
#include "services/lora_capture_service.h"
|
||||
|
||||
#include <vector>
|
||||
|
||||
#include "loratap.h"
|
||||
#include "platform/console.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
std::string LoraCaptureService::start(uint32_t nowMs) {
|
||||
if (capturing()) return "";
|
||||
if (!radio_.present()) return "No LoRa radio";
|
||||
StorageState card = storage_.state();
|
||||
if (!card.present) return "No SD card";
|
||||
if (!card.capturesAllowed) return "The SD card is full";
|
||||
int64_t now = clock_.utcNow();
|
||||
if (now < 0) return "Waiting for the time (GNSS or Wi-Fi)";
|
||||
path_ = lora::capturePath(now);
|
||||
std::vector<uint8_t> header;
|
||||
lora::appendPcapHeader(header);
|
||||
storage_.appendBytes(path_, std::string(header.begin(), header.end()), true);
|
||||
startUtc_ = now;
|
||||
startMs_ = nowMs;
|
||||
written_ = radio_.received(); // from now on
|
||||
packets_ = 0;
|
||||
radio_.listen(RadioService::Capture, true);
|
||||
console.printf("lora: Capture %s started\n", path_.c_str());
|
||||
notify("LoRa Capture started");
|
||||
return "";
|
||||
}
|
||||
|
||||
void LoraCaptureService::stop() {
|
||||
if (!capturing()) return;
|
||||
radio_.listen(RadioService::Capture, false);
|
||||
console.printf("lora: Capture %s stopped, %lu packets\n", path_.c_str(), (unsigned long)packets_);
|
||||
notify("LoRa Capture stopped: " + std::to_string(packets_) + " packets");
|
||||
path_.clear();
|
||||
}
|
||||
|
||||
void LoraCaptureService::tick(uint32_t nowMs) {
|
||||
(void)nowMs;
|
||||
if (!capturing()) return;
|
||||
uint32_t newest = radio_.received();
|
||||
for (uint32_t seq = written_ + 1; seq <= newest; ++seq) {
|
||||
RadioPacket p;
|
||||
if (!radio_.packet(seq, p)) continue; // already left the ring: too many at once
|
||||
uint32_t sinceStart = p.ms - startMs_;
|
||||
std::vector<uint8_t> record;
|
||||
record.reserve(lora::kRecordOverhead + p.len);
|
||||
lora::appendRecord(record, static_cast<uint32_t>(startUtc_ + sinceStart / 1000), (sinceStart % 1000) * 1000,
|
||||
p.rx, p.data, p.len);
|
||||
storage_.appendBytes(path_, std::string(record.begin(), record.end()), true);
|
||||
++packets_;
|
||||
}
|
||||
written_ = newest;
|
||||
}
|
||||
|
||||
void LoraCaptureService::notify(const std::string& text) {
|
||||
bus_.publish(Event::withText(EventType::Notification, text.c_str(), static_cast<int32_t>(NotificationLevel::Info)));
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -0,0 +1,44 @@
|
||||
#pragma once
|
||||
|
||||
#include <string>
|
||||
|
||||
#include "event_bus.h"
|
||||
#include "service.h"
|
||||
#include "services/clock_service.h"
|
||||
#include "services/radio_service.h"
|
||||
#include "services/storage_service.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
// A LoRa Sniffer Capture (CONTEXT.md: Capture; M3, Q97): every packet the radio receives, as pcap
|
||||
// with LoRaTap headers, in /captures/lora/. Started and stopped by hand; keeps the radio listening
|
||||
// and keeps recording whatever App is open (Q100).
|
||||
class LoraCaptureService : public Service {
|
||||
public:
|
||||
LoraCaptureService(RadioService& radio, StorageService& storage, ClockService& clock, EventBus& bus)
|
||||
: radio_(radio), storage_(storage), clock_(clock), bus_(bus) {}
|
||||
const char* name() const override { return "lora-capture"; }
|
||||
uint32_t tickIntervalMs() const override { return 200; }
|
||||
void tick(uint32_t nowMs) override;
|
||||
|
||||
std::string start(uint32_t nowMs); // why it can't, or ""
|
||||
void stop();
|
||||
bool capturing() const { return !path_.empty(); }
|
||||
const std::string& path() const { return path_; }
|
||||
uint32_t packets() const { return packets_; }
|
||||
|
||||
private:
|
||||
void notify(const std::string& text);
|
||||
|
||||
RadioService& radio_;
|
||||
StorageService& storage_;
|
||||
ClockService& clock_;
|
||||
EventBus& bus_;
|
||||
std::string path_;
|
||||
uint32_t written_ = 0; // the radio's seq last written
|
||||
uint32_t packets_ = 0;
|
||||
int64_t startUtc_ = 0; // the Clock and millis() when it started: packet times follow from both
|
||||
uint32_t startMs_ = 0;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -0,0 +1,476 @@
|
||||
#include "services/radio_service.h"
|
||||
|
||||
#include <M5Cardputer.h>
|
||||
#include <RadioLib.h>
|
||||
|
||||
#include <algorithm>
|
||||
#include <new>
|
||||
|
||||
#include "meshtastic_header.h"
|
||||
#include "sweep_view.h"
|
||||
#include "platform/console.h"
|
||||
#include "platform/pins.h"
|
||||
#include "platform/shared_spi.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
namespace {
|
||||
|
||||
// The Cap's PI4IOE5V6408: its P0 connects the antenna; at power-on it's an input and the receiver
|
||||
// is deaf (M3 step 1, measured). Only touched from the main loop, which owns the I2C bus.
|
||||
constexpr uint8_t kExpander = 0x43;
|
||||
constexpr uint32_t kI2cFreq = 400000;
|
||||
enum ExpanderReg : uint8_t { kId = 0x01, kDirection = 0x03, kOutput = 0x05, kHighZ = 0x07, kInput = 0x0F };
|
||||
|
||||
bool antennaOn() {
|
||||
auto& i2c = M5.In_I2C;
|
||||
if (!i2c.scanID(kExpander, kI2cFreq)) return false;
|
||||
i2c.writeRegister8(kExpander, kOutput, i2c.readRegister8(kExpander, kOutput, kI2cFreq) | 1, kI2cFreq);
|
||||
i2c.writeRegister8(kExpander, kHighZ, i2c.readRegister8(kExpander, kHighZ, kI2cFreq) & ~1, kI2cFreq);
|
||||
i2c.writeRegister8(kExpander, kDirection, i2c.readRegister8(kExpander, kDirection, kI2cFreq) | 1, kI2cFreq);
|
||||
return true;
|
||||
}
|
||||
|
||||
// Below this the receiver hears only itself: the antenna path is open (step 1: -111.9 dBm).
|
||||
constexpr float kDeafBelow = -108.0f;
|
||||
|
||||
} // namespace
|
||||
|
||||
RadioService* RadioService::instance_ = nullptr;
|
||||
|
||||
RadioService::RadioService() : lock_(xSemaphoreCreateMutex()) {
|
||||
const meshtastic::Preset& p = meshtastic::kEu868Presets[0]; // LongFast (Q95)
|
||||
config_ = {meshtastic::eu868FrequencyHz(p), p.bwKHz, p.sf, p.cr, meshtastic::kSyncWord, meshtastic::kPreambleLength,
|
||||
p.name};
|
||||
}
|
||||
|
||||
void RadioService::start() {
|
||||
instance_ = this;
|
||||
expander_ = antennaOn();
|
||||
// SPI transactions take the bus lock the SD card uses; the HAL doesn't re-begin the bus.
|
||||
hal_.reset(new ArduinoHal(sharedSpi(), SPISettings(8000000, MSBFIRST, SPI_MODE0)));
|
||||
module_.reset(new Module(hal_.get(), pins::kLoraCs, pins::kLoraIrq, pins::kLoraReset, pins::kLoraBusy));
|
||||
radio_.reset(new SX1262(module_.get()));
|
||||
// Above the main loop and the other Services' tasks, so a packet is read before the next.
|
||||
xTaskCreatePinnedToCore(taskEntry, "radio", 4096, this, 2, &task_, 1); // peak 2.0 KB (M3 step 3)
|
||||
}
|
||||
|
||||
void RadioService::taskEntry(void* self) { static_cast<RadioService*>(self)->run(); }
|
||||
|
||||
void IRAM_ATTR RadioService::onDio1() {
|
||||
BaseType_t woken = pdFALSE;
|
||||
if (instance_ && instance_->task_) xTaskNotifyFromISR(instance_->task_, kIrq, eSetBits, &woken);
|
||||
portYIELD_FROM_ISR(woken);
|
||||
}
|
||||
|
||||
void RadioService::wake(Notify why) {
|
||||
if (task_) xTaskNotify(task_, why, eSetBits);
|
||||
}
|
||||
|
||||
bool RadioService::beginRadio(Print* report) {
|
||||
Config c = config();
|
||||
float mhz = c.frequencyHz / 1e6f;
|
||||
int16_t state = radio_->begin(mhz, c.bandwidthKHz, c.spreadingFactor, c.codingRate, c.syncWord, 0, c.preamble,
|
||||
tcxo_, false);
|
||||
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);
|
||||
tcxo_ = 0;
|
||||
state = radio_->begin(mhz, c.bandwidthKHz, c.spreadingFactor, c.codingRate, c.syncWord, 0, c.preamble, tcxo_,
|
||||
false);
|
||||
}
|
||||
if (state != RADIOLIB_ERR_NONE) {
|
||||
if (report) report->printf("lora probe: error %d, no SX1262 found\n", state);
|
||||
return false;
|
||||
}
|
||||
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
|
||||
return true;
|
||||
}
|
||||
|
||||
void RadioService::run() {
|
||||
present_ = beginRadio(nullptr);
|
||||
if (present_) radio_->sleep();
|
||||
console.printf("radio: %s\n", present_ ? (tcxo_ > 0 ? "SX1262 ready (TCXO), asleep" : "SX1262 ready (crystal), asleep")
|
||||
: "no radio found");
|
||||
for (;;) {
|
||||
uint32_t bits = 0;
|
||||
xTaskNotifyWait(0, UINT32_MAX, &bits,
|
||||
sweepWanted_ ? pdMS_TO_TICKS(20) : listening_ ? pdMS_TO_TICKS(kNoiseEveryMs) : portMAX_DELAY);
|
||||
if (probeWanted_.exchange(false)) runProbe();
|
||||
if (!present_) continue;
|
||||
if (sweepWanted_) { // a Sweep has the radio: the Sniffer waits, its packets kept (Q99)
|
||||
sweepPass();
|
||||
continue;
|
||||
}
|
||||
if (sweeping_) endSweep();
|
||||
bool want = clients_ != 0;
|
||||
if (want && !listening_) startListening();
|
||||
else if (!want && listening_) stopListening();
|
||||
if (listening_ && configChanged_.exchange(false)) startListening(); // again, with the new settings
|
||||
if (listening_ && (bits & kIrq)) readPacket();
|
||||
if (listening_ && millis() - lastNoiseMs_ >= kNoiseEveryMs) sampleNoise();
|
||||
}
|
||||
}
|
||||
|
||||
void RadioService::startListening() {
|
||||
if (!ring_) {
|
||||
ring_.reset(new (std::nothrow) RadioPacket[kRing]);
|
||||
ringFirst_ = seq_ + 1;
|
||||
if (!ring_) {
|
||||
console.println("radio: not enough memory to listen");
|
||||
clients_ = 0;
|
||||
return;
|
||||
}
|
||||
}
|
||||
// A full begin (with a reset) each time: the chip comes back from sleep with nothing assumed.
|
||||
if (!beginRadio(nullptr)) {
|
||||
++radioErrors_;
|
||||
return;
|
||||
}
|
||||
radio_->setPacketReceivedAction(onDio1);
|
||||
int16_t state = receive();
|
||||
if (state != RADIOLIB_ERR_NONE) {
|
||||
++radioErrors_;
|
||||
console.printf("radio: can't receive (error %d)\n", state);
|
||||
return;
|
||||
}
|
||||
if (!listening_) console.printf("radio: listening, %s\n", config().name);
|
||||
listening_ = true;
|
||||
lastNoiseMs_ = 0;
|
||||
}
|
||||
|
||||
void RadioService::stopListening() {
|
||||
radio_->clearPacketReceivedAction();
|
||||
radio_->sleep();
|
||||
listening_ = false;
|
||||
noise_ = 0;
|
||||
xSemaphoreTake(lock_, portMAX_DELAY);
|
||||
ring_.reset(); // listening again starts a fresh list; idle costs nothing (Q100, Q103)
|
||||
xSemaphoreGive(lock_);
|
||||
console.println("radio: asleep");
|
||||
}
|
||||
|
||||
void RadioService::readPacket() {
|
||||
RadioPacket p;
|
||||
size_t len = std::min<size_t>(radio_->getPacketLength(), sizeof p.data);
|
||||
int16_t state = radio_->readData(p.data, len);
|
||||
if (state == RADIOLIB_ERR_CRC_MISMATCH) {
|
||||
p.crcOk = false;
|
||||
++crcErrors_;
|
||||
} else if (state != RADIOLIB_ERR_NONE) { // a header error or a timeout: nothing to keep
|
||||
++radioErrors_;
|
||||
if (receive() != RADIOLIB_ERR_NONE) ++radioErrors_;
|
||||
++restarts_;
|
||||
return;
|
||||
}
|
||||
Config c = config();
|
||||
p.ms = millis();
|
||||
p.len = static_cast<uint8_t>(len);
|
||||
p.rx.frequencyHz = c.frequencyHz;
|
||||
p.rx.bandwidthKHz = c.bandwidthKHz;
|
||||
p.rx.spreadingFactor = c.spreadingFactor;
|
||||
p.rx.syncWord = c.syncWord;
|
||||
p.rx.rssi = radio_->getRSSI();
|
||||
p.rx.snr = radio_->getSNR();
|
||||
p.rx.noiseFloor = noise_;
|
||||
p.frequencyError = radio_->getFrequencyError();
|
||||
if (receive() != RADIOLIB_ERR_NONE) ++radioErrors_;
|
||||
++restarts_;
|
||||
|
||||
store(p);
|
||||
}
|
||||
|
||||
void RadioService::store(RadioPacket& p) {
|
||||
xSemaphoreTake(lock_, portMAX_DELAY);
|
||||
p.seq = seq_ + 1;
|
||||
if (ring_) ring_[p.seq % kRing] = p;
|
||||
seq_ = p.seq;
|
||||
xSemaphoreGive(lock_);
|
||||
++packets_;
|
||||
lastPacketMs_ = p.ms;
|
||||
}
|
||||
|
||||
#ifdef RORO_DEBUG
|
||||
void RadioService::inject(const uint8_t* data, size_t len, float rssi, float snr) {
|
||||
if (!listening_) return (void)console.println("lora inject: not listening");
|
||||
RadioPacket p;
|
||||
Config c = config();
|
||||
p.ms = millis();
|
||||
p.len = static_cast<uint8_t>(std::min(len, sizeof p.data));
|
||||
std::copy(data, data + p.len, p.data);
|
||||
p.rx = {c.frequencyHz, c.bandwidthKHz, c.spreadingFactor, rssi, snr, noise_, c.syncWord};
|
||||
store(p);
|
||||
console.printf("lora inject: #%lu, %u B\n", (unsigned long)p.seq, p.len);
|
||||
}
|
||||
#endif
|
||||
|
||||
// Continuous receive. Only RX done raises DIO1; preambles and headers are only recorded in the
|
||||
// IRQ status, which sampleNoise() reads.
|
||||
int16_t RadioService::receive() {
|
||||
return radio_->startReceive(RADIOLIB_SX126X_RX_TIMEOUT_INF,
|
||||
RADIOLIB_IRQ_RX_DEFAULT_FLAGS | (1UL << RADIOLIB_IRQ_PREAMBLE_DETECTED),
|
||||
RADIOLIB_IRQ_RX_DEFAULT_MASK, 0);
|
||||
}
|
||||
|
||||
void RadioService::sampleNoise() {
|
||||
lastNoiseMs_ = millis();
|
||||
noise_ = radio_->getRSSI(false);
|
||||
constexpr uint16_t kSeen =
|
||||
RADIOLIB_SX126X_IRQ_PREAMBLE_DETECTED | RADIOLIB_SX126X_IRQ_HEADER_VALID | RADIOLIB_SX126X_IRQ_HEADER_ERR;
|
||||
uint32_t flags = radio_->getIrqFlags();
|
||||
if (flags & RADIOLIB_SX126X_IRQ_PREAMBLE_DETECTED) ++preambles_;
|
||||
if (flags & RADIOLIB_SX126X_IRQ_HEADER_VALID) ++headers_;
|
||||
if (flags & RADIOLIB_SX126X_IRQ_HEADER_ERR) ++headerErrors_;
|
||||
if (flags & kSeen) radio_->clearIrqFlags(kSeen); // never RX done: that one is the task's
|
||||
}
|
||||
|
||||
bool RadioService::packet(uint32_t seq, RadioPacket& out) const {
|
||||
if (seq == 0 || seq > seq_ || seq_ - seq >= kRing) return false;
|
||||
xSemaphoreTake(lock_, portMAX_DELAY);
|
||||
bool ok = ring_ && ring_[seq % kRing].seq == seq;
|
||||
if (ok) out = ring_[seq % kRing];
|
||||
xSemaphoreGive(lock_);
|
||||
return ok;
|
||||
}
|
||||
|
||||
void RadioService::sweep(bool on, uint32_t fromHz, uint32_t toHz, uint32_t stepHz) {
|
||||
if (on) {
|
||||
stepHz = std::max<uint32_t>(stepHz, 10000);
|
||||
toHz = std::max(toHz, fromHz);
|
||||
toHz = std::min<uint32_t>(toHz, fromHz + stepHz * (SweepFrame::kMaxSteps - 1));
|
||||
sweepFrom_ = fromHz, sweepTo_ = toHz, sweepStep_ = stepHz;
|
||||
}
|
||||
sweepWanted_ = on;
|
||||
wake(kRequest);
|
||||
}
|
||||
|
||||
bool RadioService::sweepFrame(SweepFrame& out) const {
|
||||
if (!sweepSeq_) return false;
|
||||
xSemaphoreTake(lock_, portMAX_DELAY);
|
||||
out = frame_;
|
||||
xSemaphoreGive(lock_);
|
||||
return true;
|
||||
}
|
||||
|
||||
// One pass across the band. The first one sets the radio up: the Sniffer is paused, not stopped.
|
||||
void RadioService::sweepPass() {
|
||||
if (!sweeping_) {
|
||||
if (listening_) {
|
||||
radio_->clearPacketReceivedAction();
|
||||
listening_ = false; // paused; startListening() resumes on the same ring
|
||||
}
|
||||
if (!beginRadio(nullptr)) {
|
||||
++radioErrors_;
|
||||
sweepWanted_ = false;
|
||||
return;
|
||||
}
|
||||
radio_->setBandwidth(125);
|
||||
radio_->setSpreadingFactor(7);
|
||||
sweeping_ = true;
|
||||
console.println("radio: sweeping, the Sniffer is paused");
|
||||
}
|
||||
uint32_t from = sweepFrom_, to = sweepTo_, step = sweepStep_;
|
||||
uint16_t steps = static_cast<uint16_t>((to - from) / step + 1);
|
||||
int8_t dbm[SweepFrame::kMaxSteps];
|
||||
uint32_t t0 = millis();
|
||||
for (uint16_t i = 0; i < steps && sweepWanted_; ++i) {
|
||||
radio_->standby();
|
||||
// Image calibration is per band and slow; one calibration covers EU868, so skip it per step.
|
||||
radio_->setFrequency((from + i * step) / 1e6f, i != 0);
|
||||
radio_->startReceive();
|
||||
delayMicroseconds(1500); // RSSI settles
|
||||
float best = -200;
|
||||
for (int k = 0; k < 3; ++k) {
|
||||
best = std::max(best, radio_->getRSSI(false));
|
||||
delayMicroseconds(300);
|
||||
}
|
||||
dbm[i] = static_cast<int8_t>(std::clamp(best, -127.0f, 0.0f));
|
||||
}
|
||||
radio_->standby();
|
||||
if (!sweepWanted_) return;
|
||||
xSemaphoreTake(lock_, portMAX_DELAY);
|
||||
frame_.seq = sweepSeq_ + 1;
|
||||
frame_.fromHz = from;
|
||||
frame_.stepHz = step;
|
||||
frame_.steps = steps;
|
||||
frame_.passMs = static_cast<uint16_t>(millis() - t0);
|
||||
std::copy(dbm, dbm + steps, frame_.dbm);
|
||||
xSemaphoreGive(lock_);
|
||||
sweepSeq_ = frame_.seq;
|
||||
}
|
||||
|
||||
void RadioService::endSweep() {
|
||||
sweeping_ = false;
|
||||
console.println("radio: sweep stopped");
|
||||
if (clients_) startListening(); // the Sniffer again, with its settings and its packets
|
||||
else {
|
||||
radio_->sleep();
|
||||
xSemaphoreTake(lock_, portMAX_DELAY);
|
||||
ring_.reset();
|
||||
xSemaphoreGive(lock_);
|
||||
}
|
||||
}
|
||||
|
||||
uint32_t RadioService::available() const {
|
||||
uint32_t newest = seq_, first = ringFirst_;
|
||||
if (!listening_ || newest < first) return 0;
|
||||
return std::min<uint32_t>(newest - first + 1, kRing);
|
||||
}
|
||||
|
||||
void RadioService::listen(Client client, bool on) {
|
||||
if (on) clients_ |= client;
|
||||
else clients_ &= ~client;
|
||||
wake(kRequest);
|
||||
}
|
||||
|
||||
RadioService::Config RadioService::config() const {
|
||||
xSemaphoreTake(lock_, portMAX_DELAY);
|
||||
Config c = config_;
|
||||
xSemaphoreGive(lock_);
|
||||
return c;
|
||||
}
|
||||
|
||||
void RadioService::setPreset(const meshtastic::Preset& p) {
|
||||
xSemaphoreTake(lock_, portMAX_DELAY);
|
||||
config_ = {meshtastic::eu868FrequencyHz(p), p.bwKHz, p.sf, p.cr, meshtastic::kSyncWord, meshtastic::kPreambleLength,
|
||||
p.name};
|
||||
xSemaphoreGive(lock_);
|
||||
configChanged_ = true;
|
||||
wake(kRequest);
|
||||
}
|
||||
|
||||
void RadioService::setConfig(const Config& c) {
|
||||
xSemaphoreTake(lock_, portMAX_DELAY);
|
||||
config_ = c;
|
||||
config_.name = "Custom";
|
||||
xSemaphoreGive(lock_);
|
||||
configChanged_ = true;
|
||||
wake(kRequest);
|
||||
}
|
||||
|
||||
void RadioService::setEcho(bool echo) {
|
||||
echo_ = echo;
|
||||
echoed_ = seq_;
|
||||
listen(Console, echo);
|
||||
}
|
||||
|
||||
void RadioService::tick(uint32_t nowMs) {
|
||||
SweepFrame f;
|
||||
if (sweepEcho_ && sweeping_ && nowMs - sweepEchoMs_ >= 2000 && sweepFrame(f)) {
|
||||
sweepEchoMs_ = nowMs;
|
||||
lora::SweepStats st = lora::summarize(f.dbm, f.steps, f.fromHz, f.stepHz);
|
||||
console.printf("sweep: #%lu floor %d, top %d dBm", (unsigned long)f.seq, st.floor, st.top);
|
||||
for (auto& p : st.peaks) console.printf(", %.1f MHz %d", p.hz / 1e6, p.dbm);
|
||||
console.printf(" (%u ms a pass)\n", f.passMs);
|
||||
}
|
||||
if (!echo_) return;
|
||||
for (uint32_t s = std::max(echoed_ + 1, seq_ > kRing ? seq_ - kRing + 1 : 1u); s <= seq_; ++s) {
|
||||
RadioPacket p;
|
||||
if (!packet(s, p)) continue;
|
||||
console.printf("lora: #%lu %u B %.1f dBm SNR %.1f dB%s", (unsigned long)p.seq, p.len, p.rx.rssi, p.rx.snr,
|
||||
p.crcOk ? "" : " (bad CRC)");
|
||||
meshtastic::PacketHeader h;
|
||||
if (meshtastic::parseHeader(p.data, p.len, h))
|
||||
console.printf(" | %s > %s, ch 0x%02X, hops %d/%u%s", meshtastic::nodeId(h.from).c_str(),
|
||||
meshtastic::nodeId(h.to).c_str(), h.channelHash, h.hopsAway(), h.hopStart(),
|
||||
h.viaMqtt() ? ", via MQTT" : "");
|
||||
console.println();
|
||||
}
|
||||
echoed_ = seq_;
|
||||
}
|
||||
|
||||
void RadioService::printSweep(Print& out) const {
|
||||
SweepFrame f;
|
||||
if (!sweepFrame(f)) return (void)out.println("sweep: none yet (lora sweep on)");
|
||||
out.printf("sweep: #%lu, %u steps of %lu kHz from %.3f MHz, %u ms\n", (unsigned long)f.seq, f.steps,
|
||||
(unsigned long)(f.stepHz / 1000), f.fromHz / 1e6, f.passMs);
|
||||
for (uint16_t i = 0; i < f.steps; i += 8) {
|
||||
out.printf("%8.3f", (f.fromHz + i * f.stepHz) / 1e6);
|
||||
for (uint16_t k = i; k < f.steps && k < i + 8; ++k) out.printf(" %4d", f.dbm[k]);
|
||||
out.println();
|
||||
}
|
||||
}
|
||||
|
||||
void RadioService::printStatus(Print& out) const {
|
||||
Config c = config();
|
||||
Counters n = counters();
|
||||
out.printf("radio: %s, %s, antenna switch %s\n", present_ ? "SX1262" : "no radio",
|
||||
tcxo_ > 0 ? "TCXO 1.8 V" : "crystal", expander_ ? "on (expander 0x43 P0)" : "expander missing");
|
||||
out.printf("radio: %s, %s %.3f MHz, BW %.0f kHz, SF %u, CR 4/%u, sync 0x%02X, preamble %u\n",
|
||||
sweeping_ ? "sweeping" : listening_ ? "listening" : "asleep", c.name, c.frequencyHz / 1e6, c.bandwidthKHz, c.spreadingFactor,
|
||||
c.codingRate, c.syncWord, c.preamble);
|
||||
out.printf("radio: clients%s%s%s%s\n", clients_ ? "" : " none", clients_ & App ? " App" : "",
|
||||
clients_ & Capture ? " Capture" : "", clients_ & Console ? " Console" : "");
|
||||
out.printf("radio: %lu packets, %lu bad CRC, %lu radio errors, %lu receive restarts\n", (unsigned long)n.packets,
|
||||
(unsigned long)n.crcErrors, (unsigned long)n.radioErrors, (unsigned long)n.restarts);
|
||||
out.printf("radio: activity (500 ms samples): %lu preambles, %lu headers, %lu bad headers\n",
|
||||
(unsigned long)n.preambles, (unsigned long)n.headers, (unsigned long)n.headerErrors);
|
||||
if (listening_)
|
||||
out.printf("radio: noise floor %.1f dBm%s\n", noise_.load(),
|
||||
noise_ < kDeafBelow ? " (deaf? the antenna path looks open)" : "");
|
||||
if (task_) out.printf("radio: task stack %u B free\n", (unsigned)uxTaskGetStackHighWaterMark(task_));
|
||||
}
|
||||
|
||||
void RadioService::probe(Print& out) {
|
||||
// The I2C part here, on the main loop; the radio part on the radio task.
|
||||
bool found[120] = {};
|
||||
M5.In_I2C.scanID(found, kI2cFreq);
|
||||
out.print("lora probe: i2c (internal bus, 8/9):");
|
||||
for (int a = 8; a < 120; ++a)
|
||||
if (found[a]) out.printf(" 0x%02X", a);
|
||||
out.println();
|
||||
if (found[kExpander]) {
|
||||
auto r = [](uint8_t reg) { return M5.In_I2C.readRegister8(kExpander, reg, kI2cFreq); };
|
||||
out.printf("lora probe: expander 0x43 dir %02X out %02X highz %02X in %02X: antenna %s\n", r(kDirection),
|
||||
r(kOutput), r(kHighZ), r(kInput), r(kOutput) & 1 && r(kDirection) & 1 ? "on" : "OFF");
|
||||
} else {
|
||||
out.println("lora probe: no expander at 0x43: the antenna switch can't be enabled");
|
||||
}
|
||||
probeOut_ = &out;
|
||||
probeWanted_ = true;
|
||||
wake(kRequest);
|
||||
}
|
||||
|
||||
void RadioService::runProbe() {
|
||||
Print& out = *probeOut_;
|
||||
uint32_t t0 = millis();
|
||||
if (!beginRadio(&out)) return;
|
||||
char version[17] = {};
|
||||
module_->SPIreadRegisterBurst(RADIOLIB_SX126X_REG_VERSION_STRING, 16, reinterpret_cast<uint8_t*>(version));
|
||||
out.printf("lora probe: %s, %s, ready in %u ms\n", version, tcxo_ > 0 ? "TCXO 1.8 V" : "crystal (no TCXO)",
|
||||
(unsigned)(millis() - t0));
|
||||
// DIO1 to the task, with no transmitter needed: a 100 ms receive timeout, routed to DIO1.
|
||||
radio_->setPacketReceivedAction(onDio1);
|
||||
uint32_t bits = 0;
|
||||
xTaskNotifyWait(0, UINT32_MAX, &bits, 0); // drop anything pending
|
||||
uint32_t sent = millis();
|
||||
radio_->startReceive(6400, RADIOLIB_IRQ_RX_DEFAULT_FLAGS,
|
||||
(1UL << RADIOLIB_IRQ_RX_DONE) | (1UL << RADIOLIB_IRQ_TIMEOUT), 0); // 6400 x 15.625 us
|
||||
bits = 0;
|
||||
xTaskNotifyWait(0, UINT32_MAX, &bits, pdMS_TO_TICKS(500));
|
||||
uint32_t flags = radio_->getIrqFlags();
|
||||
if (bits & kIrq)
|
||||
out.printf("lora probe: DIO1 interrupt works (receive timeout after %u ms)\n", (unsigned)(millis() - sent));
|
||||
else
|
||||
out.printf("lora probe: DIO1 interrupt never came (IRQ status 0x%04X)\n", (unsigned)flags);
|
||||
radio_->standby();
|
||||
radio_->clearIrqFlags(RADIOLIB_SX126X_IRQ_ALL);
|
||||
if (!listening_) radio_->clearPacketReceivedAction();
|
||||
receive();
|
||||
delay(20);
|
||||
float sum = 0, low = 0, high = -200;
|
||||
for (int i = 0; i < 64; ++i) {
|
||||
float r = radio_->getRSSI(false);
|
||||
sum += r, low = std::min(low, r), high = std::max(high, r);
|
||||
delay(3);
|
||||
}
|
||||
float mean = sum / 64;
|
||||
out.printf("lora probe: noise %.1f dBm (%.1f to %.1f) at %.3f MHz: %s\n", mean, low, high, config().frequencyHz / 1e6,
|
||||
mean < kDeafBelow ? "deaf, the antenna path looks open" : "the antenna is connected");
|
||||
// Back to what it was doing.
|
||||
if (listening_) startListening();
|
||||
else radio_->sleep();
|
||||
out.println("lora probe: done");
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -0,0 +1,151 @@
|
||||
#pragma once
|
||||
|
||||
#include <Print.h>
|
||||
#include <freertos/FreeRTOS.h>
|
||||
#include <freertos/semphr.h>
|
||||
#include <freertos/task.h>
|
||||
|
||||
#include <atomic>
|
||||
#include <cstdint>
|
||||
#include <memory>
|
||||
|
||||
#include "loratap.h"
|
||||
#include "meshtastic_presets.h"
|
||||
#include "service.h"
|
||||
|
||||
class SX1262;
|
||||
class Module;
|
||||
class ArduinoHal;
|
||||
|
||||
namespace roro {
|
||||
|
||||
// One received packet, as the Radio Service keeps it.
|
||||
struct RadioPacket {
|
||||
uint32_t seq = 0; // 1, 2, 3… since boot
|
||||
uint32_t ms = 0; // millis() when it was read (the Clock is read on the main loop, not here)
|
||||
lora::RxInfo rx;
|
||||
float frequencyError = 0; // Hz
|
||||
bool crcOk = true;
|
||||
uint8_t len = 0;
|
||||
uint8_t data[255];
|
||||
};
|
||||
|
||||
// One Sweep pass (M3, Q98): the strongest of three instantaneous RSSI readings at each step.
|
||||
struct SweepFrame {
|
||||
static constexpr size_t kMaxSteps = 160;
|
||||
uint32_t seq = 0; // 1, 2, 3… per pass
|
||||
uint32_t fromHz = 0, stepHz = 0;
|
||||
uint16_t steps = 0;
|
||||
uint16_t passMs = 0; // how long the pass took
|
||||
int8_t dbm[kMaxSteps];
|
||||
};
|
||||
|
||||
// The LoRa radio on the Cap (CONTEXT.md: Radio Service; docs/milestones/M3.md). One task owns the
|
||||
// SX1262 and does all its SPI traffic, behind the bus lock the SD card uses (Q93); the main loop
|
||||
// only posts requests, and DIO1's interrupt only wakes the task. **Receive only (Q94): there is
|
||||
// no way to transmit.** The radio listens while someone asks it to (Q100) and sleeps otherwise.
|
||||
class RadioService : public Service {
|
||||
public:
|
||||
enum Client : uint8_t { App = 1, Capture = 2, Console = 4 };
|
||||
static constexpr size_t kRing = 32; // Q103
|
||||
static constexpr uint32_t kNoiseEveryMs = 500; // instantaneous RSSI while listening
|
||||
|
||||
struct Config {
|
||||
uint32_t frequencyHz;
|
||||
float bandwidthKHz;
|
||||
uint8_t spreadingFactor, codingRate, syncWord;
|
||||
uint16_t preamble;
|
||||
const char* name; // the preset's, or "Custom"
|
||||
};
|
||||
struct Counters {
|
||||
uint32_t packets, crcErrors, radioErrors, restarts;
|
||||
// Seen in the IRQ status at each noise sample (every 500 ms). Preamble detections include
|
||||
// false alarms in noise (M3: more on an empty frequency than on LongFast); headers don't.
|
||||
uint32_t preambles, headers, headerErrors;
|
||||
};
|
||||
|
||||
RadioService();
|
||||
const char* name() const override { return "radio"; }
|
||||
uint32_t tickIntervalMs() const override { return 100; }
|
||||
void start() override;
|
||||
void tick(uint32_t nowMs) override;
|
||||
|
||||
bool present() const { return present_; }
|
||||
bool listening() const { return listening_; }
|
||||
void listen(Client client, bool on);
|
||||
Config config() const;
|
||||
void setPreset(const meshtastic::Preset& preset);
|
||||
void setConfig(const Config& config); // custom settings (Q95), named "Custom"
|
||||
|
||||
uint32_t received() const { return seq_; } // seq of the newest packet
|
||||
uint32_t lastPacketMs() const { return lastPacketMs_; } // millis(), 0 before the first
|
||||
bool packet(uint32_t seq, RadioPacket& out) const; // false once it has left the ring
|
||||
uint32_t available() const; // packets in the ring: seqs received()-available()+1 to received()
|
||||
float noiseFloor() const { return noise_; }
|
||||
Counters counters() const {
|
||||
return {packets_, crcErrors_, radioErrors_, restarts_, preambles_, headers_, headerErrors_};
|
||||
}
|
||||
|
||||
// Sweep (Q98, Q99): takes the radio across a band, pausing the Sniffer (its packets are kept)
|
||||
// until stopped. EU868 by default: 863 to 870 MHz in 100 kHz steps, measured at 125 kHz.
|
||||
void sweep(bool on, uint32_t fromHz = 863000000, uint32_t toHz = 870000000, uint32_t stepHz = 100000);
|
||||
bool sweeping() const { return sweeping_; }
|
||||
bool sweepFrame(SweepFrame& out) const; // the latest pass; false before the first
|
||||
uint32_t sweeps() const { return sweepSeq_; }
|
||||
void setSweepEcho(bool echo) { sweepEcho_ = echo; } // a summary on the console every 2 s
|
||||
void printSweep(Print& out) const; // `lora sweep dump`: the latest pass
|
||||
|
||||
// Debug aids (Q102).
|
||||
void printStatus(Print& out) const;
|
||||
void setEcho(bool echo);
|
||||
void probe(Print& out); // `lora probe`: runs on the radio task
|
||||
#ifdef RORO_DEBUG
|
||||
// `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.
|
||||
void inject(const uint8_t* data, size_t len, float rssi, float snr);
|
||||
#endif
|
||||
|
||||
private:
|
||||
enum Notify : uint32_t { kIrq = 1, kRequest = 2 };
|
||||
static void taskEntry(void* self);
|
||||
static void onDio1();
|
||||
void run();
|
||||
bool beginRadio(Print* report);
|
||||
void applyConfig();
|
||||
void startListening();
|
||||
void stopListening();
|
||||
int16_t receive();
|
||||
void readPacket();
|
||||
void store(RadioPacket& p);
|
||||
void sampleNoise();
|
||||
void runProbe();
|
||||
void sweepPass();
|
||||
void endSweep();
|
||||
void wake(Notify why);
|
||||
|
||||
std::unique_ptr<ArduinoHal> hal_;
|
||||
std::unique_ptr<Module> module_;
|
||||
std::unique_ptr<SX1262> radio_;
|
||||
TaskHandle_t task_ = nullptr;
|
||||
mutable SemaphoreHandle_t lock_; // the ring and the config
|
||||
std::unique_ptr<RadioPacket[]> ring_;
|
||||
Config config_;
|
||||
bool present_ = false, expander_ = false;
|
||||
float tcxo_ = 1.8f;
|
||||
std::atomic<uint8_t> clients_{0};
|
||||
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> preambles_{0}, headers_{0}, headerErrors_{0};
|
||||
std::atomic<uint32_t> lastPacketMs_{0};
|
||||
std::atomic<uint32_t> ringFirst_{1}; // the first seq the current ring can hold
|
||||
std::atomic<bool> sweepWanted_{false}, sweeping_{false};
|
||||
std::atomic<uint32_t> sweepFrom_{863000000}, sweepTo_{870000000}, sweepStep_{100000}, sweepSeq_{0};
|
||||
SweepFrame frame_; // under lock_
|
||||
std::atomic<float> noise_{0};
|
||||
uint32_t lastNoiseMs_ = 0, echoed_ = 0, sweepEchoMs_ = 0;
|
||||
bool sweepEcho_ = false;
|
||||
Print* probeOut_ = nullptr;
|
||||
static RadioService* instance_;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
@@ -5,6 +5,7 @@
|
||||
#include <sd_diskio.h>
|
||||
|
||||
#include <algorithm>
|
||||
#include <atomic>
|
||||
#include <memory>
|
||||
|
||||
#include "platform/pins.h"
|
||||
@@ -14,7 +15,7 @@ namespace roro {
|
||||
|
||||
void StorageService::start() {
|
||||
if (task_) return;
|
||||
xTaskCreate(taskEntry, "storage", 10240, this, 1, &task_); // room for a signature check
|
||||
xTaskCreate(taskEntry, "storage", 6144, this, 1, &task_); // peak 3.9 KB (SD install with its signature check, M2)
|
||||
}
|
||||
|
||||
void StorageService::stop() {
|
||||
@@ -32,12 +33,21 @@ StorageState StorageService::state() const {
|
||||
return copy;
|
||||
}
|
||||
|
||||
void StorageService::appendLine(const std::string& path, const std::string& line) {
|
||||
void StorageService::appendLine(const std::string& path, const std::string& line, bool capture) {
|
||||
append(path, line, capture, true);
|
||||
}
|
||||
|
||||
void StorageService::appendBytes(const std::string& path, const std::string& bytes, bool capture) {
|
||||
append(path, bytes, capture, false);
|
||||
}
|
||||
|
||||
void StorageService::append(const std::string& path, const std::string& data, bool capture, bool newline) {
|
||||
lock();
|
||||
size_t bytes = path.size() + line.size();
|
||||
bool accept = monitor_.state().logsAllowed && pendingBytes_ + bytes <= kMaxPendingBytes;
|
||||
size_t bytes = path.size() + data.size();
|
||||
bool allowed = capture ? monitor_.state().capturesAllowed : monitor_.state().logsAllowed;
|
||||
bool accept = allowed && pendingBytes_ + bytes <= kMaxPendingBytes;
|
||||
if (accept) {
|
||||
pending_.emplace_back(path, line);
|
||||
pending_.push_back({path, data, newline});
|
||||
pendingBytes_ += bytes;
|
||||
} else {
|
||||
dropped_++;
|
||||
@@ -81,6 +91,30 @@ void StorageService::runJob(std::function<void()> job) {
|
||||
if (task_) xTaskNotifyGive(task_);
|
||||
}
|
||||
|
||||
bool StorageService::runAndWait(std::function<void()> job) {
|
||||
// Shared with the job, which outlives this wait if the card is missing and it never starts.
|
||||
// Exactly one side wins the state change: the job (Queued -> Running) or the wait giving up
|
||||
// (Queued -> Abandoned), so an abandoned job can never touch this stack frame.
|
||||
enum : int { Queued, Running, Abandoned };
|
||||
struct Run {
|
||||
std::atomic<int> state{Queued};
|
||||
SemaphoreHandle_t done = xSemaphoreCreateBinary();
|
||||
~Run() { vSemaphoreDelete(done); }
|
||||
};
|
||||
auto run = std::make_shared<Run>();
|
||||
runJob([run, job]() {
|
||||
int expected = Queued;
|
||||
if (!run->state.compare_exchange_strong(expected, Running)) return;
|
||||
job();
|
||||
xSemaphoreGive(run->done);
|
||||
});
|
||||
for (int waited = 0; xSemaphoreTake(run->done, pdMS_TO_TICKS(500)) != pdTRUE; waited += 500) {
|
||||
int expected = Queued;
|
||||
if (waited >= 5000 && run->state.compare_exchange_strong(expected, Abandoned)) return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
bool StorageService::requestFormat() {
|
||||
if (formatRequested_ || !task_) return false;
|
||||
formatRequested_ = true;
|
||||
@@ -173,25 +207,25 @@ void StorageService::poll() {
|
||||
|
||||
void StorageService::writePending() {
|
||||
lock();
|
||||
std::deque<std::pair<std::string, std::string>> batch;
|
||||
std::deque<Pending> batch;
|
||||
batch.swap(pending_);
|
||||
pendingBytes_ = 0;
|
||||
unlock();
|
||||
if (batch.empty() || !mounted_) return;
|
||||
|
||||
// Keep each file's lines in order while opening each file once.
|
||||
std::stable_sort(batch.begin(), batch.end(), [](const auto& a, const auto& b) { return a.first < b.first; });
|
||||
std::stable_sort(batch.begin(), batch.end(), [](const auto& a, const auto& b) { return a.path < b.path; });
|
||||
File file;
|
||||
std::string openPath;
|
||||
for (auto& [path, line] : batch) {
|
||||
if (path != openPath) {
|
||||
for (auto& p : batch) {
|
||||
if (p.path != openPath) {
|
||||
if (file) file.close();
|
||||
file = SD.open(path.c_str(), FILE_APPEND, true); // true: create missing folders
|
||||
openPath = path;
|
||||
file = SD.open(p.path.c_str(), FILE_APPEND, true); // true: create missing folders
|
||||
openPath = p.path;
|
||||
}
|
||||
if (file) {
|
||||
file.write(reinterpret_cast<const uint8_t*>(line.data()), line.size());
|
||||
file.write('\n');
|
||||
file.write(reinterpret_cast<const uint8_t*>(p.data.data()), p.data.size());
|
||||
if (p.newline) file.write('\n');
|
||||
}
|
||||
}
|
||||
if (file) file.close();
|
||||
|
||||
@@ -29,8 +29,11 @@ class StorageService : public Service {
|
||||
StorageState state() const;
|
||||
|
||||
// Queues one line for a Log file (created with its folders as needed). Dropped while Logs are
|
||||
// paused (over 90 % full, or no card) or if too much is already waiting.
|
||||
void appendLine(const std::string& path, const std::string& line);
|
||||
// paused (over 90 % full, or no card) or if too much is already waiting. A Capture (or a Track,
|
||||
// something the user started) keeps going past 90 %, until the card is full.
|
||||
void appendLine(const std::string& path, const std::string& line, bool capture = false);
|
||||
// The same, for binary files (a pcap Capture): the bytes as they are, no newline.
|
||||
void appendBytes(const std::string& path, const std::string& bytes, bool capture = false);
|
||||
uint32_t droppedLines() const { return dropped_; }
|
||||
|
||||
// Storage Clean-up: list every file of every category, then delete a selection.
|
||||
@@ -41,6 +44,9 @@ class StorageService : public Service {
|
||||
|
||||
// Runs `job` on the storage task, where card access is safe (e.g. reading an Update File).
|
||||
void runJob(std::function<void()> job);
|
||||
// The same, and waits for it (from another task, never the storage task itself). False if it
|
||||
// never started within 5 s: no card mounted, and then it never will run.
|
||||
bool runAndWait(std::function<void()> job);
|
||||
|
||||
// Erases the whole card: one partition spanning the card, formatted FAT32.
|
||||
bool requestFormat();
|
||||
@@ -69,7 +75,12 @@ class StorageService : public Service {
|
||||
mutable SemaphoreHandle_t lock_ = nullptr;
|
||||
|
||||
// Shared with other tasks, guarded by lock_.
|
||||
std::deque<std::pair<std::string, std::string>> pending_;
|
||||
struct Pending {
|
||||
std::string path, data;
|
||||
bool newline;
|
||||
};
|
||||
std::deque<Pending> pending_;
|
||||
void append(const std::string& path, const std::string& data, bool capture, bool newline);
|
||||
size_t pendingBytes_ = 0;
|
||||
uint32_t dropped_ = 0;
|
||||
bool listingRequested_ = false;
|
||||
|
||||
@@ -1,13 +1,11 @@
|
||||
#include "update_service.h"
|
||||
|
||||
#include <ESPmDNS.h>
|
||||
#include <SD.h>
|
||||
#include <WiFi.h>
|
||||
#include <esp_ota_ops.h>
|
||||
|
||||
#include <memory>
|
||||
|
||||
#include "platform/identity.h"
|
||||
#include "platform/ota_device.h"
|
||||
#include "platform/system_info.h"
|
||||
#include "probation.h"
|
||||
@@ -66,7 +64,6 @@ class FileSource : public UpdateSource {
|
||||
UpdateService::UpdateService(KeyValueStore& store, WifiService& wifi, SavedNetworks& saved, StorageService& storage,
|
||||
EventBus& bus, const Settings& settings)
|
||||
: store_(store), wifi_(wifi), saved_(saved), storage_(storage), bus_(bus), settings_(settings) {
|
||||
hostname_ = "roro9stack-" + identity::defaultShortName();
|
||||
}
|
||||
|
||||
void UpdateService::notify(const std::string& text, NotificationLevel level) {
|
||||
@@ -90,7 +87,7 @@ void UpdateService::start() {
|
||||
store_.putString("ota_pending", "");
|
||||
}
|
||||
|
||||
if (!task_) xTaskCreate(taskEntry, "update", 8192, this, 1, &task_);
|
||||
if (!task_) xTaskCreate(taskEntry, "update", 5120, this, 1, &task_); // peak 3.4 KB (ECDSA check, M2)
|
||||
}
|
||||
|
||||
void UpdateService::bootGuard(KeyValueStore& store) {
|
||||
@@ -196,11 +193,9 @@ void UpdateService::listen() {
|
||||
bool connected = wifi_.state() == WifiController::State::Connected;
|
||||
if (connected && !listening) {
|
||||
server.begin();
|
||||
if (MDNS.begin(hostname_.c_str())) MDNS.addService("roro9stack", "tcp", kPort);
|
||||
listening = true;
|
||||
} else if (!connected && listening) {
|
||||
server.end();
|
||||
MDNS.end();
|
||||
listening = false;
|
||||
}
|
||||
// The main loop restarts into an installed update when it's safe. If it never does (stuck,
|
||||
|
||||
@@ -35,7 +35,6 @@ class UpdateService : public Service {
|
||||
int percent() const { return percent_; }
|
||||
std::string incomingVersion() const;
|
||||
bool onProbation() const { return probation_; }
|
||||
const std::string& hostname() const { return hostname_; }
|
||||
|
||||
// Installs an Update File from the SD card (runs on the storage task).
|
||||
void installFromSd(const std::string& path);
|
||||
@@ -58,7 +57,6 @@ class UpdateService : public Service {
|
||||
EventBus& bus_;
|
||||
const Settings& settings_;
|
||||
TaskHandle_t task_ = nullptr;
|
||||
std::string hostname_;
|
||||
volatile Phase phase_ = Phase::Idle;
|
||||
volatile int percent_ = 0;
|
||||
std::string incoming_;
|
||||
|
||||
@@ -48,6 +48,20 @@ void statusBar(Canvas& c, const StatusInfo& info) {
|
||||
case StatusInfo::Wifi::Monitoring: right("MON", kAccent); break;
|
||||
case StatusInfo::Wifi::None: break;
|
||||
}
|
||||
if (info.tracking) right("REC", kWarning);
|
||||
if (info.capturing) right("CAP", kWarning);
|
||||
switch (info.radio) { // Q101: muted while listening, bright for a moment on each packet
|
||||
case StatusInfo::Radio::Listening: right("L", kMuted); break;
|
||||
case StatusInfo::Radio::Packet: right("L", kAccent); break;
|
||||
case StatusInfo::Radio::Sweep: right("SW", kMuted); break; // the Sniffer is paused
|
||||
case StatusInfo::Radio::None: break;
|
||||
}
|
||||
switch (info.gnss) { // Q61: muted while searching, normal with a Fix, the count with a 3D Fix
|
||||
case StatusInfo::Gnss::Searching: right("G", kMuted); break;
|
||||
case StatusInfo::Gnss::TwoD: right("G", kText); break;
|
||||
case StatusInfo::Gnss::ThreeD: right("G" + std::to_string(info.gnssSatellites), kText); break;
|
||||
case StatusInfo::Gnss::None: break;
|
||||
}
|
||||
if (info.compose) right(std::string("opt ") + (info.compose == '*' ? "" : std::string(1, info.compose)), kAccent);
|
||||
c.setTextDatum(top_left);
|
||||
}
|
||||
|
||||
+7
-1
@@ -24,11 +24,17 @@ struct StatusInfo {
|
||||
enum class Wifi { None, Searching, Connected, Monitoring } wifi = Wifi::None;
|
||||
int wifiBars = 0; // 0..3 when Connected
|
||||
int unread = 0; // unread messages across Services
|
||||
enum class Gnss { None, Searching, TwoD, ThreeD } gnss = Gnss::None; // None: GNSS off (Q61)
|
||||
int gnssSatellites = 0; // used in the Fix
|
||||
bool tracking = false; // a Track is recording (Q63)
|
||||
enum class Radio { None, Listening, Packet, Sweep } radio = Radio::None; // M3, Q101: Packet flashes
|
||||
bool capturing = false; // a LoRa Capture is recording (Q97)
|
||||
|
||||
bool operator==(const StatusInfo& o) const {
|
||||
return title == o.title && batteryPercent == o.batteryPercent && clock == o.clock &&
|
||||
sdPresent == o.sdPresent && sdLevel == o.sdLevel && compose == o.compose && wifi == o.wifi &&
|
||||
wifiBars == o.wifiBars && unread == o.unread;
|
||||
wifiBars == o.wifiBars && unread == o.unread && gnss == o.gnss && gnssSatellites == o.gnssSatellites &&
|
||||
tracking == o.tracking && radio == o.radio && capturing == o.capturing;
|
||||
}
|
||||
bool operator!=(const StatusInfo& o) const { return !(*this == o); }
|
||||
};
|
||||
|
||||
@@ -184,6 +184,34 @@ void test_reset_returns_to_idle() {
|
||||
TEST_ASSERT_FALSE(r.active());
|
||||
}
|
||||
|
||||
// The received bytes can be right and the card's copy wrong: read back, it must hash the same.
|
||||
void test_card_check() {
|
||||
auto data = bytes(10);
|
||||
FileReceiver r;
|
||||
r.begin(args("/a.bin", data), 0);
|
||||
r.feed(data.data(), data.size(), 0);
|
||||
r.chunkWritten(true, 0);
|
||||
TEST_ASSERT_TRUE(r.state() == FileReceiver::State::Finishing);
|
||||
uint8_t good[32];
|
||||
Sha256::hash(data.data(), data.size(), good);
|
||||
r.cardChecked(good);
|
||||
TEST_ASSERT_TRUE(r.state() == FileReceiver::State::Finishing);
|
||||
r.finished(true);
|
||||
TEST_ASSERT_TRUE(r.state() == FileReceiver::State::Done);
|
||||
|
||||
FileReceiver bad;
|
||||
bad.begin(args("/a.bin", data), 0);
|
||||
bad.feed(data.data(), data.size(), 0);
|
||||
bad.chunkWritten(true, 0);
|
||||
auto zeroed = data;
|
||||
zeroed[4] = 0;
|
||||
uint8_t wrong[32];
|
||||
Sha256::hash(zeroed.data(), zeroed.size(), wrong);
|
||||
bad.cardChecked(wrong);
|
||||
TEST_ASSERT_TRUE(bad.state() == FileReceiver::State::Failed);
|
||||
TEST_ASSERT_EQUAL_STRING("the copy on the card differs", bad.error().c_str());
|
||||
}
|
||||
|
||||
int main() {
|
||||
UNITY_BEGIN();
|
||||
RUN_TEST(test_begin_accepts_path_size_and_checksum);
|
||||
@@ -198,5 +226,6 @@ int main() {
|
||||
RUN_TEST(test_wanted_counts_down_within_a_chunk);
|
||||
RUN_TEST(test_a_rename_that_never_completes_times_out);
|
||||
RUN_TEST(test_reset_returns_to_idle);
|
||||
RUN_TEST(test_card_check);
|
||||
return UNITY_END();
|
||||
}
|
||||
|
||||
@@ -0,0 +1,223 @@
|
||||
#include <unity.h>
|
||||
|
||||
#include <string>
|
||||
|
||||
#include "gemini_response.h"
|
||||
#include "gemini_url.h"
|
||||
#include "gemtext.h"
|
||||
#include "text_buffer.h"
|
||||
|
||||
using namespace roro::gemini;
|
||||
|
||||
void setUp() {}
|
||||
void tearDown() {}
|
||||
|
||||
static void resolvesTo(const char* ref, const char* expected) {
|
||||
TEST_ASSERT_EQUAL_STRING_MESSAGE(expected, resolve("gemini://a/b/c/d;p?q", ref).c_str(), ref);
|
||||
}
|
||||
|
||||
// RFC 3986, section 5.4.1, with gemini:// for http://.
|
||||
void test_rfc3986_normal_examples() {
|
||||
resolvesTo("g:h", "g:h");
|
||||
resolvesTo("g", "gemini://a/b/c/g");
|
||||
resolvesTo("./g", "gemini://a/b/c/g");
|
||||
resolvesTo("g/", "gemini://a/b/c/g/");
|
||||
resolvesTo("/g", "gemini://a/g");
|
||||
resolvesTo("//g", "gemini://g");
|
||||
resolvesTo("?y", "gemini://a/b/c/d;p?y");
|
||||
resolvesTo("g?y", "gemini://a/b/c/g?y");
|
||||
resolvesTo("#s", "gemini://a/b/c/d;p?q#s");
|
||||
resolvesTo("g#s", "gemini://a/b/c/g#s");
|
||||
resolvesTo("g?y#s", "gemini://a/b/c/g?y#s");
|
||||
resolvesTo(";x", "gemini://a/b/c/;x");
|
||||
resolvesTo("", "gemini://a/b/c/d;p?q");
|
||||
resolvesTo(".", "gemini://a/b/c/");
|
||||
resolvesTo("./", "gemini://a/b/c/");
|
||||
resolvesTo("..", "gemini://a/b/");
|
||||
resolvesTo("../", "gemini://a/b/");
|
||||
resolvesTo("../g", "gemini://a/b/g");
|
||||
resolvesTo("../..", "gemini://a/");
|
||||
resolvesTo("../../", "gemini://a/");
|
||||
resolvesTo("../../g", "gemini://a/g");
|
||||
}
|
||||
|
||||
// Section 5.4.2.
|
||||
void test_rfc3986_abnormal_examples() {
|
||||
resolvesTo("../../../g", "gemini://a/g");
|
||||
resolvesTo("../../../../g", "gemini://a/g");
|
||||
resolvesTo("/./g", "gemini://a/g");
|
||||
resolvesTo("/../g", "gemini://a/g");
|
||||
resolvesTo("g.", "gemini://a/b/c/g.");
|
||||
resolvesTo(".g", "gemini://a/b/c/.g");
|
||||
resolvesTo("./../g", "gemini://a/b/g");
|
||||
resolvesTo("g/./h", "gemini://a/b/c/g/h");
|
||||
resolvesTo("g/../h", "gemini://a/b/c/h");
|
||||
resolvesTo("g;x=1/./y", "gemini://a/b/c/g;x=1/y");
|
||||
resolvesTo("g;x=1/../y", "gemini://a/b/c/y");
|
||||
}
|
||||
|
||||
void test_parse_a_gemini_url() {
|
||||
Url u;
|
||||
TEST_ASSERT_TRUE(parseUrl("gemini://Example.ORG:1966/a/b?c=d#e", u));
|
||||
TEST_ASSERT_EQUAL_STRING("gemini", u.scheme.c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("example.org", u.host.c_str()); // hosts are case-insensitive
|
||||
TEST_ASSERT_EQUAL(1966, u.port);
|
||||
TEST_ASSERT_EQUAL_STRING("/a/b", u.path.c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("c=d", u.query.c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("e", u.fragment.c_str());
|
||||
TEST_ASSERT_TRUE(parseUrl("gemini://example.org", u));
|
||||
TEST_ASSERT_EQUAL(1965, u.portOrDefault());
|
||||
TEST_ASSERT_FALSE(parseUrl("not a url", u));
|
||||
}
|
||||
|
||||
void test_the_request_drops_the_fragment_and_never_has_an_empty_path() {
|
||||
TEST_ASSERT_EQUAL_STRING("gemini://example.org/", requestUrl("gemini://example.org").c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("gemini://example.org/a?b", requestUrl("gemini://example.org/a?b#frag").c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("gemini://example.org:1966/", requestUrl("gemini://EXAMPLE.org:1966").c_str());
|
||||
}
|
||||
|
||||
void test_other_schemes_are_recognised() {
|
||||
TEST_ASSERT_TRUE(isGemini("gemini://a/"));
|
||||
TEST_ASSERT_FALSE(isGemini("https://a/"));
|
||||
TEST_ASSERT_FALSE(isGemini("gopher://a/"));
|
||||
TEST_ASSERT_FALSE(isGemini("mailto:someone@example.org"));
|
||||
}
|
||||
|
||||
void test_query_encoding() {
|
||||
TEST_ASSERT_EQUAL_STRING("hello%20world", encodeQuery("hello world").c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("caf%C3%A9%3F%26", encodeQuery("caf\xC3\xA9?&").c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("a-b_c.d~e", encodeQuery("a-b_c.d~e").c_str());
|
||||
}
|
||||
|
||||
void test_response_header() {
|
||||
Header h;
|
||||
TEST_ASSERT_TRUE(parseHeader("20 text/gemini; charset=utf-8; lang=en", h));
|
||||
TEST_ASSERT_EQUAL(20, h.status);
|
||||
TEST_ASSERT_EQUAL_STRING("text/gemini", h.mimeType().c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("utf-8", h.parameter("charset").c_str());
|
||||
TEST_ASSERT_TRUE(h.category() == Category::Success);
|
||||
TEST_ASSERT_TRUE(parseHeader("20", h)); // no MIME type: text/gemini by default
|
||||
TEST_ASSERT_EQUAL_STRING("text/gemini", h.mimeType().c_str());
|
||||
TEST_ASSERT_TRUE(parseHeader("31 gemini://cosmos.skyjake.fi/", h));
|
||||
TEST_ASSERT_TRUE(h.category() == Category::Redirect);
|
||||
TEST_ASSERT_EQUAL_STRING("gemini://cosmos.skyjake.fi/", h.meta.c_str());
|
||||
TEST_ASSERT_TRUE(parseHeader("11 Password", h));
|
||||
TEST_ASSERT_TRUE(h.category() == Category::Input);
|
||||
TEST_ASSERT_TRUE(h.sensitiveInput());
|
||||
TEST_ASSERT_TRUE(parseHeader("51 Not found", h));
|
||||
TEST_ASSERT_TRUE(h.category() == Category::PermanentFailure);
|
||||
TEST_ASSERT_TRUE(parseHeader("60 Certificate required", h));
|
||||
TEST_ASSERT_TRUE(h.category() == Category::ClientCertificate);
|
||||
}
|
||||
|
||||
void test_malformed_headers_are_refused() {
|
||||
Header h;
|
||||
TEST_ASSERT_FALSE(parseHeader("", h));
|
||||
TEST_ASSERT_FALSE(parseHeader("2 text/gemini", h));
|
||||
TEST_ASSERT_FALSE(parseHeader("ab text/gemini", h));
|
||||
TEST_ASSERT_FALSE(parseHeader("20text/gemini", h));
|
||||
TEST_ASSERT_FALSE(parseHeader("20 " + std::string(1025, 'x'), h));
|
||||
}
|
||||
|
||||
void test_gemtext_line_types() {
|
||||
auto lines = parseGemtext(
|
||||
"# Title\n## Sub\n### Subsub\nPlain text\n* item\n> quoted\n=> gemini://a/b Label here\n=>/rel\n"
|
||||
"```ascii art\n# not a heading\n=> not a link\n```\nafter\n");
|
||||
TEST_ASSERT_EQUAL(13, static_cast<int>(lines.size()));
|
||||
TEST_ASSERT_TRUE(lines[0].type == LineType::Heading1);
|
||||
TEST_ASSERT_EQUAL_STRING("Title", lines[0].text.c_str());
|
||||
TEST_ASSERT_TRUE(lines[1].type == LineType::Heading2);
|
||||
TEST_ASSERT_TRUE(lines[2].type == LineType::Heading3);
|
||||
TEST_ASSERT_TRUE(lines[3].type == LineType::Text);
|
||||
TEST_ASSERT_TRUE(lines[4].type == LineType::ListItem);
|
||||
TEST_ASSERT_EQUAL_STRING("item", lines[4].text.c_str());
|
||||
TEST_ASSERT_TRUE(lines[5].type == LineType::Quote);
|
||||
TEST_ASSERT_EQUAL_STRING("quoted", lines[5].text.c_str());
|
||||
TEST_ASSERT_TRUE(lines[6].type == LineType::Link);
|
||||
TEST_ASSERT_EQUAL_STRING("gemini://a/b", lines[6].url.c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("Label here", lines[6].text.c_str());
|
||||
TEST_ASSERT_TRUE(lines[7].type == LineType::Link);
|
||||
TEST_ASSERT_EQUAL_STRING("/rel", lines[7].url.c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("/rel", lines[7].text.c_str()); // no label: the URL is the label
|
||||
TEST_ASSERT_TRUE(lines[8].type == LineType::PreToggle);
|
||||
TEST_ASSERT_EQUAL_STRING("ascii art", lines[8].text.c_str());
|
||||
TEST_ASSERT_TRUE(lines[9].type == LineType::Preformatted);
|
||||
TEST_ASSERT_EQUAL_STRING("# not a heading", lines[9].text.c_str());
|
||||
TEST_ASSERT_TRUE(lines[10].type == LineType::Preformatted);
|
||||
TEST_ASSERT_TRUE(lines[11].type == LineType::PreToggle);
|
||||
TEST_ASSERT_TRUE(lines[12].type == LineType::Text);
|
||||
}
|
||||
|
||||
void test_gemtext_handles_crlf_and_a_missing_last_newline() {
|
||||
auto lines = parseGemtext("one\r\n=>\tgemini://x/\t spaced label \r\ntwo");
|
||||
TEST_ASSERT_EQUAL(3, static_cast<int>(lines.size()));
|
||||
TEST_ASSERT_EQUAL_STRING("one", lines[0].text.c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("gemini://x/", lines[1].url.c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("spaced label", lines[1].text.c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("two", lines[2].text.c_str());
|
||||
}
|
||||
|
||||
void test_display_text_keeps_latin1_and_replaces_the_rest() {
|
||||
TEST_ASSERT_EQUAL_STRING("caf\xC3\xA9", displayText("caf\xC3\xA9").c_str()); // é stays
|
||||
TEST_ASSERT_EQUAL_STRING("? and ?", displayText("\xE2\x9C\x93 and \xF0\x9F\x99\x82").c_str()); // ✓ and 🙂
|
||||
TEST_ASSERT_EQUAL_STRING("bad ? byte", displayText("bad \xFF byte").c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("a b", displayText("a\tb").c_str()); // tab: three spaces here
|
||||
}
|
||||
|
||||
void test_saved_page_paths() {
|
||||
TEST_ASSERT_EQUAL_STRING("/gemini/saved/example.org/index.gmi", savedPath("gemini://example.org/").c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("/gemini/saved/example.org/index.gmi", savedPath("gemini://example.org").c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("/gemini/saved/example.org/log/2026/post.gmi",
|
||||
savedPath("gemini://example.org/log/2026/post.gmi").c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("/gemini/saved/example.org/log/index.gmi", savedPath("gemini://example.org/log/").c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("/gemini/saved/example.org/about.gmi", savedPath("gemini://example.org/about").c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("/gemini/saved/example.org_1966/a~q_x.gmi",
|
||||
savedPath("gemini://example.org:1966/a?q:x#frag").c_str());
|
||||
}
|
||||
|
||||
void test_text_buffer_keeps_lines_across_any_feed() {
|
||||
TextBuffer b;
|
||||
std::string doc = "# Title\r\nline two\n\nlast without end";
|
||||
for (size_t i = 0; i < doc.size(); i += 3) b.append(doc.data() + i, std::min<size_t>(3, doc.size() - i));
|
||||
b.finish();
|
||||
TEST_ASSERT_EQUAL(4, static_cast<int>(b.lineCount()));
|
||||
TEST_ASSERT_EQUAL_STRING("# Title", b.line(0).c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("line two", b.line(1).c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("", b.line(2).c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("last without end", b.line(3).c_str());
|
||||
TEST_ASSERT_EQUAL(doc.size(), b.bytes());
|
||||
}
|
||||
|
||||
void test_text_buffer_spreads_over_chunks_without_splitting_lines() {
|
||||
TextBuffer b;
|
||||
std::string line(1000, 'x');
|
||||
for (int i = 0; i < 20; i++) {
|
||||
std::string l = std::to_string(i) + line + "\n";
|
||||
b.append(l.data(), l.size());
|
||||
}
|
||||
std::string big(6000, 'y'); // longer than a chunk
|
||||
big += "\n";
|
||||
b.append(big.data(), big.size());
|
||||
TEST_ASSERT_EQUAL(21, static_cast<int>(b.lineCount()));
|
||||
for (int i = 0; i < 20; i++) TEST_ASSERT_EQUAL_STRING((std::to_string(i) + line).c_str(), b.line(i).c_str());
|
||||
TEST_ASSERT_EQUAL(6000, static_cast<int>(b.line(20).size()));
|
||||
}
|
||||
|
||||
int main() {
|
||||
UNITY_BEGIN();
|
||||
RUN_TEST(test_rfc3986_normal_examples);
|
||||
RUN_TEST(test_rfc3986_abnormal_examples);
|
||||
RUN_TEST(test_parse_a_gemini_url);
|
||||
RUN_TEST(test_the_request_drops_the_fragment_and_never_has_an_empty_path);
|
||||
RUN_TEST(test_other_schemes_are_recognised);
|
||||
RUN_TEST(test_query_encoding);
|
||||
RUN_TEST(test_response_header);
|
||||
RUN_TEST(test_malformed_headers_are_refused);
|
||||
RUN_TEST(test_gemtext_line_types);
|
||||
RUN_TEST(test_gemtext_handles_crlf_and_a_missing_last_newline);
|
||||
RUN_TEST(test_display_text_keeps_latin1_and_replaces_the_rest);
|
||||
RUN_TEST(test_saved_page_paths);
|
||||
RUN_TEST(test_text_buffer_keeps_lines_across_any_feed);
|
||||
RUN_TEST(test_text_buffer_spreads_over_chunks_without_splitting_lines);
|
||||
return UNITY_END();
|
||||
}
|
||||
@@ -0,0 +1,64 @@
|
||||
#include <unity.h>
|
||||
|
||||
#include "geo_format.h"
|
||||
|
||||
using namespace roro::gnss;
|
||||
|
||||
void setUp() {}
|
||||
void tearDown() {}
|
||||
|
||||
void test_decimal_degrees_with_hemisphere() {
|
||||
TEST_ASSERT_EQUAL_STRING("50.86920° N", formatDecimal(50.8692034, true).c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("33.50000° S", formatDecimal(-33.5, true).c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("4.25350° E", formatDecimal(4.2535, false).c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("151.21000° W", formatDecimal(-151.21, false).c_str());
|
||||
}
|
||||
|
||||
void test_degrees_minutes_seconds() {
|
||||
TEST_ASSERT_EQUAL_STRING("50° 52' 09.1\" N", formatDms(50.8692034, true).c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("4° 15' 12.6\" E", formatDms(4.2535, false).c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("33° 30' 00.0\" S", formatDms(-33.5, true).c_str());
|
||||
}
|
||||
|
||||
void test_seconds_that_round_up_carry_over() {
|
||||
TEST_ASSERT_EQUAL_STRING("11° 00' 00.0\" N", formatDms(10.9999999, true).c_str());
|
||||
}
|
||||
|
||||
void test_maidenhead_matches_known_locators() {
|
||||
TEST_ASSERT_EQUAL_STRING("FN31pr", maidenhead(41.714775, -72.727260).c_str()); // W1AW
|
||||
TEST_ASSERT_EQUAL_STRING("JN58td", maidenhead(48.14666, 11.60833).c_str()); // Munich
|
||||
TEST_ASSERT_EQUAL_STRING("JJ00aa", maidenhead(0, 0).c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("AA00aa", maidenhead(-90, -180).c_str());
|
||||
}
|
||||
|
||||
void test_maidenhead_stays_in_range_at_the_edges() {
|
||||
TEST_ASSERT_EQUAL_STRING("RR99xx", maidenhead(90, 180).c_str());
|
||||
}
|
||||
|
||||
void test_sky_projection() {
|
||||
SkyPoint zenith = skyPosition(123, 90, 50, 60, 40);
|
||||
TEST_ASSERT_EQUAL(50, zenith.x);
|
||||
TEST_ASSERT_EQUAL(60, zenith.y);
|
||||
SkyPoint north = skyPosition(0, 0, 50, 60, 40);
|
||||
TEST_ASSERT_EQUAL(50, north.x);
|
||||
TEST_ASSERT_EQUAL(20, north.y); // up
|
||||
SkyPoint east = skyPosition(90, 0, 50, 60, 40);
|
||||
TEST_ASSERT_EQUAL(90, east.x);
|
||||
TEST_ASSERT_EQUAL(60, east.y);
|
||||
SkyPoint south45 = skyPosition(180, 45, 50, 60, 40);
|
||||
TEST_ASSERT_EQUAL(50, south45.x);
|
||||
TEST_ASSERT_EQUAL(80, south45.y);
|
||||
SkyPoint below = skyPosition(270, -5, 50, 60, 40); // just below the horizon: on the edge
|
||||
TEST_ASSERT_EQUAL(10, below.x);
|
||||
}
|
||||
|
||||
int main() {
|
||||
UNITY_BEGIN();
|
||||
RUN_TEST(test_decimal_degrees_with_hemisphere);
|
||||
RUN_TEST(test_degrees_minutes_seconds);
|
||||
RUN_TEST(test_seconds_that_round_up_carry_over);
|
||||
RUN_TEST(test_maidenhead_matches_known_locators);
|
||||
RUN_TEST(test_maidenhead_stays_in_range_at_the_edges);
|
||||
RUN_TEST(test_sky_projection);
|
||||
return UNITY_END();
|
||||
}
|
||||
@@ -0,0 +1,98 @@
|
||||
#include <unity.h>
|
||||
|
||||
#include <vector>
|
||||
|
||||
#include "loratap.h"
|
||||
|
||||
using namespace roro::lora;
|
||||
|
||||
void setUp() {}
|
||||
void tearDown() {}
|
||||
|
||||
static uint32_t le32(const std::vector<uint8_t>& b, size_t at) {
|
||||
return b[at] | b[at + 1] << 8 | b[at + 2] << 16 | (uint32_t)b[at + 3] << 24;
|
||||
}
|
||||
|
||||
void test_pcap_global_header() {
|
||||
std::vector<uint8_t> out;
|
||||
appendPcapHeader(out);
|
||||
TEST_ASSERT_EQUAL_size_t(24, out.size());
|
||||
TEST_ASSERT_EQUAL_HEX32(0xA1B2C3D4, le32(out, 0)); // microsecond timestamps, little-endian file
|
||||
TEST_ASSERT_EQUAL_UINT8(2, out[4]); // version 2.4
|
||||
TEST_ASSERT_EQUAL_UINT8(4, out[6]);
|
||||
TEST_ASSERT_EQUAL_UINT32(65535, le32(out, 16)); // snap length
|
||||
TEST_ASSERT_EQUAL_UINT32(270, le32(out, 20)); // LINKTYPE_LORATAP
|
||||
}
|
||||
|
||||
void test_record_with_loratap_v0() {
|
||||
RxInfo rx;
|
||||
rx.frequencyHz = 869525000;
|
||||
rx.bandwidthKHz = 250;
|
||||
rx.spreadingFactor = 11;
|
||||
rx.rssi = -97.0f;
|
||||
rx.snr = 6.25f;
|
||||
rx.noiseFloor = -110.0f;
|
||||
rx.syncWord = 0x2B;
|
||||
const uint8_t payload[] = {1, 2, 3};
|
||||
std::vector<uint8_t> out;
|
||||
appendRecord(out, 1791230400u, 250000u, rx, payload, sizeof payload);
|
||||
|
||||
TEST_ASSERT_EQUAL_size_t(16 + 15 + 3, out.size());
|
||||
TEST_ASSERT_EQUAL_UINT32(1791230400u, le32(out, 0));
|
||||
TEST_ASSERT_EQUAL_UINT32(250000u, le32(out, 4));
|
||||
TEST_ASSERT_EQUAL_UINT32(18, le32(out, 8)); // captured: LoRaTap header + payload
|
||||
TEST_ASSERT_EQUAL_UINT32(18, le32(out, 12));
|
||||
|
||||
const uint8_t* t = out.data() + 16; // LoRaTap v0, big-endian
|
||||
TEST_ASSERT_EQUAL_UINT8(0, t[0]); // version
|
||||
TEST_ASSERT_EQUAL_UINT8(0, t[1]); // padding
|
||||
TEST_ASSERT_EQUAL_UINT16(15, t[2] << 8 | t[3]);
|
||||
TEST_ASSERT_EQUAL_UINT32(869525000u, (uint32_t)t[4] << 24 | t[5] << 16 | t[6] << 8 | t[7]);
|
||||
TEST_ASSERT_EQUAL_UINT8(2, t[8]); // bandwidth in 125 kHz steps
|
||||
TEST_ASSERT_EQUAL_UINT8(11, t[9]);
|
||||
TEST_ASSERT_EQUAL_UINT8(42, t[10]); // packet RSSI: -139 + 42 = -97 dBm (SNR >= 0)
|
||||
TEST_ASSERT_EQUAL_UINT8(42, t[11]); // max RSSI: the packet's
|
||||
TEST_ASSERT_EQUAL_UINT8(29, t[12]); // current RSSI: the noise floor, -139 + 29 = -110 dBm
|
||||
TEST_ASSERT_EQUAL_UINT8(25, t[13]); // SNR in quarter dB
|
||||
TEST_ASSERT_EQUAL_HEX8(0x2B, t[14]);
|
||||
TEST_ASSERT_EQUAL_UINT8(3, t[17]);
|
||||
}
|
||||
|
||||
// Below 0 dB SNR the spec says quarter dB, but Wireshark (checked with tshark 4.2) reads plain dBm.
|
||||
void test_negative_snr() {
|
||||
RxInfo rx;
|
||||
rx.bandwidthKHz = 125;
|
||||
rx.rssi = -120.5f;
|
||||
rx.snr = -7.5f;
|
||||
std::vector<uint8_t> out;
|
||||
appendRecord(out, 0, 0, rx, nullptr, 0);
|
||||
const uint8_t* t = out.data() + 16;
|
||||
TEST_ASSERT_EQUAL_UINT8(1, t[8]);
|
||||
TEST_ASSERT_EQUAL_UINT8(19, t[10]); // -139 + 19 = -120 dBm (rounded half away)
|
||||
TEST_ASSERT_EQUAL_INT8(-30, static_cast<int8_t>(t[13])); // -7.5 dB
|
||||
}
|
||||
|
||||
void test_rssi_clamped() {
|
||||
RxInfo rx;
|
||||
rx.rssi = -150.0f; // below what LoRaTap can say
|
||||
rx.snr = 1.0f;
|
||||
rx.noiseFloor = 20.0f;
|
||||
std::vector<uint8_t> out;
|
||||
appendRecord(out, 0, 0, rx, nullptr, 0);
|
||||
TEST_ASSERT_EQUAL_UINT8(0, out[16 + 10]);
|
||||
TEST_ASSERT_EQUAL_UINT8(159, out[16 + 12]);
|
||||
}
|
||||
|
||||
void test_capture_path() {
|
||||
TEST_ASSERT_EQUAL_STRING("/captures/lora/20261005-200000.pcap", capturePath(1791230400).c_str());
|
||||
}
|
||||
|
||||
int main() {
|
||||
UNITY_BEGIN();
|
||||
RUN_TEST(test_pcap_global_header);
|
||||
RUN_TEST(test_record_with_loratap_v0);
|
||||
RUN_TEST(test_negative_snr);
|
||||
RUN_TEST(test_rssi_clamped);
|
||||
RUN_TEST(test_capture_path);
|
||||
return UNITY_END();
|
||||
}
|
||||
@@ -0,0 +1,132 @@
|
||||
#include <unity.h>
|
||||
|
||||
#include <cstring>
|
||||
#include <string>
|
||||
|
||||
#include "meshtastic_header.h"
|
||||
#include "meshtastic_presets.h"
|
||||
|
||||
using namespace roro::meshtastic;
|
||||
|
||||
void setUp() {}
|
||||
void tearDown() {}
|
||||
|
||||
// The 16 bytes every Meshtastic packet starts with, little-endian, never encrypted.
|
||||
static const uint8_t kHeader[] = {
|
||||
0xFF, 0xFF, 0xFF, 0xFF, // to: broadcast
|
||||
0x78, 0x56, 0x34, 0x12, // from: !12345678
|
||||
0xEF, 0xBE, 0xAD, 0xDE, // id
|
||||
0x6B, // flags: hop start 3, want ack, hop limit 3
|
||||
0x08, // channel hash: LongFast with the default key
|
||||
0x00, // next hop: none
|
||||
0x42, // relay node: last byte of the Node that relayed it
|
||||
};
|
||||
|
||||
void test_header_fields() {
|
||||
PacketHeader h;
|
||||
TEST_ASSERT_TRUE(parseHeader(kHeader, sizeof kHeader, h));
|
||||
TEST_ASSERT_EQUAL_HEX32(0xFFFFFFFF, h.to);
|
||||
TEST_ASSERT_EQUAL_HEX32(0x12345678, h.from);
|
||||
TEST_ASSERT_EQUAL_HEX32(0xDEADBEEF, h.id);
|
||||
TEST_ASSERT_EQUAL_UINT8(0x08, h.channelHash);
|
||||
TEST_ASSERT_EQUAL_UINT8(0x00, h.nextHop);
|
||||
TEST_ASSERT_EQUAL_UINT8(0x42, h.relayNode);
|
||||
TEST_ASSERT_TRUE(h.broadcast());
|
||||
}
|
||||
|
||||
void test_header_flags() {
|
||||
PacketHeader h;
|
||||
parseHeader(kHeader, sizeof kHeader, h);
|
||||
TEST_ASSERT_EQUAL_UINT8(3, h.hopLimit());
|
||||
TEST_ASSERT_EQUAL_UINT8(3, h.hopStart());
|
||||
TEST_ASSERT_TRUE(h.wantAck());
|
||||
TEST_ASSERT_FALSE(h.viaMqtt());
|
||||
TEST_ASSERT_EQUAL_INT(0, h.hopsAway());
|
||||
|
||||
uint8_t relayed[16];
|
||||
std::memcpy(relayed, kHeader, 16);
|
||||
relayed[12] = 0xF1 | 0x10; // hop start 7, via MQTT, hop limit 1
|
||||
parseHeader(relayed, 16, h);
|
||||
TEST_ASSERT_EQUAL_UINT8(1, h.hopLimit());
|
||||
TEST_ASSERT_EQUAL_UINT8(7, h.hopStart());
|
||||
TEST_ASSERT_TRUE(h.viaMqtt());
|
||||
TEST_ASSERT_FALSE(h.wantAck());
|
||||
TEST_ASSERT_EQUAL_INT(6, h.hopsAway());
|
||||
}
|
||||
|
||||
void test_header_from_old_firmware_has_no_hop_start() {
|
||||
uint8_t old[16];
|
||||
std::memcpy(old, kHeader, 16);
|
||||
old[12] = 0x02; // hop limit 2, hop start 0: firmware before 2.3 didn't set it
|
||||
PacketHeader h;
|
||||
parseHeader(old, 16, h);
|
||||
TEST_ASSERT_EQUAL_INT(-1, h.hopsAway()); // unknown, not "2 hops below zero"
|
||||
}
|
||||
|
||||
void test_header_too_short() {
|
||||
PacketHeader h;
|
||||
TEST_ASSERT_FALSE(parseHeader(kHeader, 15, h));
|
||||
TEST_ASSERT_FALSE(parseHeader(nullptr, 0, h));
|
||||
}
|
||||
|
||||
void test_node_ids() {
|
||||
TEST_ASSERT_EQUAL_STRING("!12345678", nodeId(0x12345678).c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("!0000abcd", nodeId(0xABCD).c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("all", nodeId(kBroadcast).c_str());
|
||||
}
|
||||
|
||||
// Meshtastic shows these hashes for the default key ("AQ==").
|
||||
void test_channel_hash_with_default_key() {
|
||||
TEST_ASSERT_EQUAL_UINT8(8, channelHash("LongFast", kDefaultKey, sizeof kDefaultKey));
|
||||
TEST_ASSERT_EQUAL_UINT8(31, channelHash("MediumFast", kDefaultKey, sizeof kDefaultKey));
|
||||
}
|
||||
|
||||
void test_djb2() {
|
||||
TEST_ASSERT_EQUAL_UINT32(5381, djb2(""));
|
||||
TEST_ASSERT_EQUAL_UINT32(130429955u, djb2("LongFast"));
|
||||
}
|
||||
|
||||
void test_eu868_presets() {
|
||||
TEST_ASSERT_EQUAL_size_t(7, kEu868PresetCount);
|
||||
const Preset& lf = kEu868Presets[0]; // the default comes first
|
||||
TEST_ASSERT_EQUAL_STRING("LongFast", lf.name);
|
||||
TEST_ASSERT_EQUAL_FLOAT(250.0f, lf.bwKHz);
|
||||
TEST_ASSERT_EQUAL_UINT8(11, lf.sf);
|
||||
TEST_ASSERT_EQUAL_UINT8(5, lf.cr);
|
||||
const Preset* ls = findPreset("LongSlow");
|
||||
TEST_ASSERT_NOT_NULL(ls);
|
||||
TEST_ASSERT_EQUAL_FLOAT(125.0f, ls->bwKHz);
|
||||
TEST_ASSERT_EQUAL_UINT8(12, ls->sf);
|
||||
TEST_ASSERT_EQUAL_UINT8(8, ls->cr);
|
||||
TEST_ASSERT_NULL(findPreset("ShortTurbo")); // 500 kHz doesn't fit the 250 kHz sub-band
|
||||
}
|
||||
|
||||
// The frequency slot comes from the channel name's hash; an unnamed channel uses the preset's name.
|
||||
void test_eu868_frequencies() {
|
||||
TEST_ASSERT_EQUAL_UINT32(869525000u, eu868FrequencyHz(*findPreset("LongFast")));
|
||||
TEST_ASSERT_EQUAL_UINT32(869525000u, eu868FrequencyHz(*findPreset("MediumFast")));
|
||||
TEST_ASSERT_EQUAL_UINT32(869462500u, eu868FrequencyHz(*findPreset("LongSlow")));
|
||||
TEST_ASSERT_EQUAL_UINT32(869587500u, eu868FrequencyHz(*findPreset("LongMod")));
|
||||
// A 250 kHz preset has one slot, whatever the channel's name.
|
||||
TEST_ASSERT_EQUAL_UINT32(869525000u, eu868FrequencyHz(*findPreset("LongFast"), "Belgium"));
|
||||
}
|
||||
|
||||
void test_radio_constants() {
|
||||
TEST_ASSERT_EQUAL_HEX8(0x2B, kSyncWord);
|
||||
TEST_ASSERT_EQUAL_UINT16(16, kPreambleLength);
|
||||
}
|
||||
|
||||
int main() {
|
||||
UNITY_BEGIN();
|
||||
RUN_TEST(test_header_fields);
|
||||
RUN_TEST(test_header_flags);
|
||||
RUN_TEST(test_header_from_old_firmware_has_no_hop_start);
|
||||
RUN_TEST(test_header_too_short);
|
||||
RUN_TEST(test_node_ids);
|
||||
RUN_TEST(test_channel_hash_with_default_key);
|
||||
RUN_TEST(test_djb2);
|
||||
RUN_TEST(test_eu868_presets);
|
||||
RUN_TEST(test_eu868_frequencies);
|
||||
RUN_TEST(test_radio_constants);
|
||||
return UNITY_END();
|
||||
}
|
||||
@@ -0,0 +1,236 @@
|
||||
#include <unity.h>
|
||||
|
||||
#include <cstdio>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include "nmea_parser.h"
|
||||
|
||||
using namespace roro;
|
||||
using namespace roro::gnss;
|
||||
|
||||
void setUp() {}
|
||||
void tearDown() {}
|
||||
|
||||
// "$<body>*<checksum>": the checksum is computed here, so scenarios stay readable.
|
||||
static std::string nmea(const std::string& body) {
|
||||
uint8_t sum = 0;
|
||||
for (char c : body) sum ^= static_cast<uint8_t>(c);
|
||||
char tail[4];
|
||||
std::snprintf(tail, sizeof tail, "*%02X", sum);
|
||||
return "$" + body + tail;
|
||||
}
|
||||
|
||||
static void feedLine(NmeaParser& p, const std::string& line) {
|
||||
std::string withEnd = line + "\r\n";
|
||||
p.feed(withEnd.data(), withEnd.size());
|
||||
}
|
||||
|
||||
void test_checksum_is_verified() {
|
||||
NmeaParser p;
|
||||
TEST_ASSERT_TRUE(p.sentence("$GNVTG,,,,,,,,,N*2E")); // captured from the device
|
||||
TEST_ASSERT_FALSE(p.sentence("$GNVTG,,,,,,,,,N*2F"));
|
||||
TEST_ASSERT_FALSE(p.sentence("$GNVTG,,,,,,,,,N"));
|
||||
TEST_ASSERT_FALSE(p.sentence("GNVTG,,,,,,,,,N*2E"));
|
||||
TEST_ASSERT_EQUAL_UINT32(3, p.badSentences());
|
||||
TEST_ASSERT_EQUAL_UINT32(1, p.goodSentences());
|
||||
}
|
||||
|
||||
void test_no_fix_as_captured_indoors() {
|
||||
NmeaParser p;
|
||||
feedLine(p, "$GNRMC,200231.00,V,,,,,,,041026,,,N,V*1A");
|
||||
feedLine(p, "$GNGGA,200231.00,,,,,0,00,25.5,,,,,,*48");
|
||||
feedLine(p, "$GNGSA,A,1,,,,,,,,,,,,,25.5,25.5,25.5,1*01");
|
||||
feedLine(p, "$GPGSV,1,1,01,25,41,108,17,1*58");
|
||||
feedLine(p, "$GLGSV,1,1,00,1*78");
|
||||
const GnssState& s = p.state();
|
||||
TEST_ASSERT_TRUE(s.fix == FixType::None);
|
||||
TEST_ASSERT_FALSE(s.positionValid);
|
||||
TEST_ASSERT_FALSE(s.timeValid); // a time without a Fix isn't trusted
|
||||
TEST_ASSERT_EQUAL(1, static_cast<int>(s.satellites.size()));
|
||||
TEST_ASSERT_TRUE(s.satellites[0].system == Constellation::Gps);
|
||||
TEST_ASSERT_EQUAL(25, s.satellites[0].prn);
|
||||
TEST_ASSERT_EQUAL(41, s.satellites[0].elevation);
|
||||
TEST_ASSERT_EQUAL(108, s.satellites[0].azimuth);
|
||||
TEST_ASSERT_EQUAL(17, s.satellites[0].snr);
|
||||
TEST_ASSERT_FALSE(s.satellites[0].used);
|
||||
}
|
||||
|
||||
void test_rmc_with_a_fix_gives_position_time_speed_course() {
|
||||
NmeaParser p;
|
||||
feedLine(p, nmea("GNRMC,123519.00,A,5050.8136,N,00421.1532,E,10.0,84.4,041026,,,A,V"));
|
||||
const GnssState& s = p.state();
|
||||
TEST_ASSERT_TRUE(s.positionValid);
|
||||
TEST_ASSERT_FLOAT_WITHIN(1e-6, 50.0 + 50.8136 / 60.0, s.latitude);
|
||||
TEST_ASSERT_FLOAT_WITHIN(1e-6, 4.0 + 21.1532 / 60.0, s.longitude);
|
||||
TEST_ASSERT_TRUE(s.timeValid);
|
||||
TEST_ASSERT_EQUAL(2026, s.year);
|
||||
TEST_ASSERT_EQUAL(10, s.month);
|
||||
TEST_ASSERT_EQUAL(4, s.day);
|
||||
TEST_ASSERT_EQUAL(12, s.hour);
|
||||
TEST_ASSERT_EQUAL(35, s.minute);
|
||||
TEST_ASSERT_EQUAL(19, s.second);
|
||||
TEST_ASSERT_FLOAT_WITHIN(0.01, 18.52, s.speedKmh); // 10 knots
|
||||
TEST_ASSERT_TRUE(s.courseValid);
|
||||
TEST_ASSERT_FLOAT_WITHIN(0.01, 84.4, s.courseDeg);
|
||||
}
|
||||
|
||||
void test_southern_and_western_hemispheres_are_negative() {
|
||||
NmeaParser p;
|
||||
feedLine(p, nmea("GNRMC,000000.00,A,3352.0000,S,15112.6000,W,0.0,,010126,,,A,V"));
|
||||
TEST_ASSERT_FLOAT_WITHIN(1e-6, -(33.0 + 52.0 / 60.0), p.state().latitude);
|
||||
TEST_ASSERT_FLOAT_WITHIN(1e-6, -(151.0 + 12.6 / 60.0), p.state().longitude);
|
||||
TEST_ASSERT_FALSE(p.state().courseValid); // empty course field
|
||||
}
|
||||
|
||||
void test_utc_seconds_from_the_fix_time() {
|
||||
NmeaParser p;
|
||||
feedLine(p, nmea("GNRMC,123519.00,A,5050.8136,N,00421.1532,E,0.0,,041026,,,A,V"));
|
||||
TEST_ASSERT_EQUAL_INT64(1791117319LL, p.state().utcSeconds()); // 2026-10-04 12:35:19 UTC
|
||||
}
|
||||
|
||||
void test_gga_gives_fix_quality_altitude_satellites_and_hdop() {
|
||||
NmeaParser p;
|
||||
feedLine(p, nmea("GNGGA,123519.00,5050.8136,N,00421.1532,E,1,09,0.9,61.4,M,46.9,M,,"));
|
||||
feedLine(p, nmea("GNGSA,A,3,05,13,15,18,23,,,,,,,,1.6,0.9,1.3,1"));
|
||||
const GnssState& s = p.state();
|
||||
TEST_ASSERT_TRUE(s.positionValid);
|
||||
TEST_ASSERT_EQUAL(9, s.satellitesUsed);
|
||||
TEST_ASSERT_FLOAT_WITHIN(0.01, 0.9, s.hdop);
|
||||
TEST_ASSERT_TRUE(s.altitudeValid);
|
||||
TEST_ASSERT_FLOAT_WITHIN(0.01, 61.4, s.altitudeM);
|
||||
TEST_ASSERT_TRUE(s.fix == FixType::ThreeD);
|
||||
}
|
||||
|
||||
void test_fix_type_comes_from_gsa_mode() {
|
||||
NmeaParser p;
|
||||
feedLine(p, nmea("GNGSA,A,2,05,13,15,,,,,,,,,,2.1,1.9,1.0,1"));
|
||||
TEST_ASSERT_TRUE(p.state().fix == FixType::TwoD);
|
||||
feedLine(p, nmea("GNGSA,A,1,,,,,,,,,,,,,25.5,25.5,25.5,1"));
|
||||
TEST_ASSERT_TRUE(p.state().fix == FixType::None);
|
||||
}
|
||||
|
||||
void test_losing_the_fix_drops_the_position() {
|
||||
NmeaParser p;
|
||||
feedLine(p, nmea("GNRMC,123519.00,A,5050.8136,N,00421.1532,E,0.0,,041026,,,A,V"));
|
||||
TEST_ASSERT_TRUE(p.state().positionValid);
|
||||
feedLine(p, nmea("GNRMC,123520.00,V,,,,,,,041026,,,N,V"));
|
||||
TEST_ASSERT_FALSE(p.state().positionValid);
|
||||
TEST_ASSERT_FALSE(p.state().timeValid);
|
||||
}
|
||||
|
||||
void test_gsv_sequence_spans_several_messages() {
|
||||
NmeaParser p;
|
||||
feedLine(p, nmea("GPGSV,2,1,05,05,60,120,40,13,45,200,35,15,30,300,30,18,20,050,25,1"));
|
||||
TEST_ASSERT_EQUAL(0, static_cast<int>(p.state().satellites.size())); // committed at the last message
|
||||
feedLine(p, nmea("GPGSV,2,2,05,23,10,010,,1"));
|
||||
const auto& sats = p.state().satellites;
|
||||
TEST_ASSERT_EQUAL(5, static_cast<int>(sats.size()));
|
||||
TEST_ASSERT_EQUAL(-1, sats[4].snr); // not tracked: empty SNR
|
||||
}
|
||||
|
||||
void test_each_constellation_keeps_its_own_satellites() {
|
||||
NmeaParser p;
|
||||
feedLine(p, nmea("GPGSV,1,1,01,05,60,120,40,1"));
|
||||
feedLine(p, nmea("GLGSV,1,1,01,70,30,90,33,1"));
|
||||
feedLine(p, nmea("GAGSV,1,1,01,11,20,45,28,7"));
|
||||
feedLine(p, nmea("GBGSV,1,1,01,24,50,270,36,1"));
|
||||
feedLine(p, nmea("GQGSV,1,1,01,02,70,180,41,1"));
|
||||
const auto& sats = p.state().satellites;
|
||||
TEST_ASSERT_EQUAL(5, static_cast<int>(sats.size()));
|
||||
int seen[8] = {};
|
||||
for (auto& s : sats) seen[static_cast<int>(s.system)]++;
|
||||
TEST_ASSERT_EQUAL(1, seen[static_cast<int>(Constellation::Gps)]);
|
||||
TEST_ASSERT_EQUAL(1, seen[static_cast<int>(Constellation::Glonass)]);
|
||||
TEST_ASSERT_EQUAL(1, seen[static_cast<int>(Constellation::Galileo)]);
|
||||
TEST_ASSERT_EQUAL(1, seen[static_cast<int>(Constellation::BeiDou)]);
|
||||
TEST_ASSERT_EQUAL(1, seen[static_cast<int>(Constellation::Qzss)]);
|
||||
}
|
||||
|
||||
void test_a_satellite_on_two_bands_counts_once_with_the_stronger_signal() {
|
||||
NmeaParser p;
|
||||
feedLine(p, nmea("GPGSV,1,1,01,05,60,120,30,1")); // L1
|
||||
feedLine(p, nmea("GPGSV,1,1,01,05,60,120,42,8")); // L5
|
||||
const auto& sats = p.state().satellites;
|
||||
TEST_ASSERT_EQUAL(1, static_cast<int>(sats.size()));
|
||||
TEST_ASSERT_EQUAL(42, sats[0].snr);
|
||||
}
|
||||
|
||||
void test_an_empty_gsv_clears_that_constellation() {
|
||||
NmeaParser p;
|
||||
feedLine(p, nmea("GLGSV,1,1,01,70,30,90,33,1"));
|
||||
TEST_ASSERT_EQUAL(1, static_cast<int>(p.state().satellites.size()));
|
||||
feedLine(p, "$GLGSV,1,1,00,1*78"); // captured
|
||||
TEST_ASSERT_EQUAL(0, static_cast<int>(p.state().satellites.size()));
|
||||
}
|
||||
|
||||
void test_gsa_marks_the_satellites_used_per_system() {
|
||||
NmeaParser p;
|
||||
feedLine(p, nmea("GPGSV,1,1,02,05,60,120,40,13,45,200,35,1"));
|
||||
feedLine(p, nmea("GBGSV,1,1,01,05,50,270,36,1")); // BeiDou 5, not GPS 5
|
||||
feedLine(p, nmea("GNGSA,A,3,05,,,,,,,,,,,,1.6,0.9,1.3,1")); // GPS: 5 used
|
||||
feedLine(p, nmea("GNGSA,A,3,,,,,,,,,,,,,1.6,0.9,1.3,4")); // BeiDou: none
|
||||
for (auto& s : p.state().satellites) {
|
||||
bool expected = s.system == Constellation::Gps && s.prn == 5;
|
||||
TEST_ASSERT_EQUAL(expected, s.used);
|
||||
}
|
||||
}
|
||||
|
||||
void test_split_feeds_and_noise_are_handled() {
|
||||
NmeaParser p;
|
||||
std::string a = "garbage\r\n" + nmea("GNGGA,123519.00,5050.8136,N,00421.1532,E,1,09,0.9,61.4,M,46.9,M,,");
|
||||
std::string b = "\r\n";
|
||||
p.feed(a.data(), 20);
|
||||
p.feed(a.data() + 20, a.size() - 20);
|
||||
TEST_ASSERT_FALSE(p.state().positionValid); // no line end yet
|
||||
p.feed(b.data(), b.size());
|
||||
TEST_ASSERT_TRUE(p.state().positionValid);
|
||||
}
|
||||
|
||||
void test_an_overlong_line_is_dropped() {
|
||||
NmeaParser p;
|
||||
std::string junk(300, 'x');
|
||||
junk += "\r\n";
|
||||
p.feed(junk.data(), junk.size());
|
||||
feedLine(p, nmea("GNGGA,123519.00,5050.8136,N,00421.1532,E,1,09,0.9,61.4,M,46.9,M,,"));
|
||||
TEST_ASSERT_TRUE(p.state().positionValid);
|
||||
}
|
||||
|
||||
void test_every_complete_line_reaches_the_echo() {
|
||||
NmeaParser p;
|
||||
std::vector<std::string> seen;
|
||||
p.onLine = [&](const std::string& l) { seen.push_back(l); };
|
||||
std::string data = "$GNVTG,,,,,,,,,N*2E\r\nbroken\r\n$GN";
|
||||
p.feed(data.data(), data.size());
|
||||
TEST_ASSERT_EQUAL(2, static_cast<int>(seen.size()));
|
||||
TEST_ASSERT_EQUAL_STRING("$GNVTG,,,,,,,,,N*2E", seen[0].c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("broken", seen[1].c_str());
|
||||
}
|
||||
|
||||
void test_constellation_names() {
|
||||
TEST_ASSERT_EQUAL_STRING("GPS", constellationName(Constellation::Gps));
|
||||
TEST_ASSERT_EQUAL_STRING("Galileo", constellationName(Constellation::Galileo));
|
||||
TEST_ASSERT_EQUAL_STRING("BeiDou", constellationName(Constellation::BeiDou));
|
||||
}
|
||||
|
||||
int main() {
|
||||
UNITY_BEGIN();
|
||||
RUN_TEST(test_checksum_is_verified);
|
||||
RUN_TEST(test_no_fix_as_captured_indoors);
|
||||
RUN_TEST(test_rmc_with_a_fix_gives_position_time_speed_course);
|
||||
RUN_TEST(test_southern_and_western_hemispheres_are_negative);
|
||||
RUN_TEST(test_utc_seconds_from_the_fix_time);
|
||||
RUN_TEST(test_gga_gives_fix_quality_altitude_satellites_and_hdop);
|
||||
RUN_TEST(test_fix_type_comes_from_gsa_mode);
|
||||
RUN_TEST(test_losing_the_fix_drops_the_position);
|
||||
RUN_TEST(test_gsv_sequence_spans_several_messages);
|
||||
RUN_TEST(test_each_constellation_keeps_its_own_satellites);
|
||||
RUN_TEST(test_a_satellite_on_two_bands_counts_once_with_the_stronger_signal);
|
||||
RUN_TEST(test_an_empty_gsv_clears_that_constellation);
|
||||
RUN_TEST(test_gsa_marks_the_satellites_used_per_system);
|
||||
RUN_TEST(test_split_feeds_and_noise_are_handled);
|
||||
RUN_TEST(test_an_overlong_line_is_dropped);
|
||||
RUN_TEST(test_every_complete_line_reaches_the_echo);
|
||||
RUN_TEST(test_constellation_names);
|
||||
return UNITY_END();
|
||||
}
|
||||
@@ -0,0 +1,75 @@
|
||||
#include <unity.h>
|
||||
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include "packet_view.h"
|
||||
|
||||
using namespace roro::lora;
|
||||
|
||||
void setUp() {}
|
||||
void tearDown() {}
|
||||
|
||||
static const uint8_t kMeshtastic[] = {
|
||||
0xFF, 0xFF, 0xFF, 0xFF, 0x78, 0x56, 0x34, 0x12, 0xEF, 0xBE, 0xAD, 0xDE,
|
||||
0x62, // hop start 3, hop limit 2: relayed once
|
||||
0x08, 0x00, 0x42, 0x01, 0x02, 0x03,
|
||||
};
|
||||
|
||||
void test_row_for_a_meshtastic_packet() {
|
||||
PacketSummary p{kMeshtastic, sizeof kMeshtastic, -97.4f, 6.25f, true, true};
|
||||
// Time, RSSI, SNR, then who sent it to whom (by default short name: the last 4 hex digits,
|
||||
// as Meshtastic names a Node) and how far it came. Fits 40 columns with two node numbers.
|
||||
TEST_ASSERT_EQUAL_STRING("21:45:07 -97 6.2 5678>all 1/3", row(p, "21:45:07").c_str());
|
||||
const uint8_t direct[] = {0x0a, 0x0b, 0x0c, 0x0d, 0xc4, 0xd3, 0xb2, 0xa1, 1, 2, 3, 4, 0x6a, 8, 0, 0xaa};
|
||||
PacketSummary d{direct, sizeof direct, -117.0f, -9.25f, true, true};
|
||||
TEST_ASSERT_EQUAL_STRING("21:45:07 -117 -9.2 d3c4>0b0a 1/3", row(d, "21:45:07").c_str());
|
||||
TEST_ASSERT_TRUE(row(d, "21:45:07").size() <= 38);
|
||||
}
|
||||
|
||||
void test_row_for_something_else() {
|
||||
const uint8_t data[] = {0x40, 0x01, 0x02};
|
||||
PacketSummary p{data, sizeof data, -120.6f, -7.5f, true, false};
|
||||
TEST_ASSERT_EQUAL_STRING("21:45:07 -121 -7.5 3 B", row(p, "21:45:07").c_str());
|
||||
}
|
||||
|
||||
// Not on Meshtastic settings (LoRaWAN, say): the same bytes aren't read as a Meshtastic header.
|
||||
void test_row_not_meshtastic() {
|
||||
PacketSummary p{kMeshtastic, sizeof kMeshtastic, -97.0f, 6.0f, true, false};
|
||||
TEST_ASSERT_EQUAL_STRING("21:45:07 -97 6.0 19 B", row(p, "21:45:07").c_str());
|
||||
}
|
||||
|
||||
void test_row_with_a_bad_crc() {
|
||||
PacketSummary p{kMeshtastic, sizeof kMeshtastic, -97.0f, 6.0f, false, true};
|
||||
TEST_ASSERT_EQUAL_STRING("21:45:07 -97 6.0 bad CRC, 19 B", row(p, "21:45:07").c_str());
|
||||
}
|
||||
|
||||
void test_hex_dump() {
|
||||
auto lines = hexDump(kMeshtastic, sizeof kMeshtastic);
|
||||
TEST_ASSERT_EQUAL_size_t(3, lines.size());
|
||||
TEST_ASSERT_EQUAL_STRING("0000 ff ff ff ff 78 56 34 12 ....xV4.", lines[0].c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("0008 ef be ad de 62 08 00 42 ....b..B", lines[1].c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("0010 01 02 03 ...", lines[2].c_str());
|
||||
}
|
||||
|
||||
void test_header_lines() {
|
||||
auto lines = headerLines(kMeshtastic, sizeof kMeshtastic);
|
||||
TEST_ASSERT_EQUAL_size_t(5, lines.size());
|
||||
TEST_ASSERT_EQUAL_STRING("From !12345678 to all", lines[0].c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("Packet deadbeef", lines[1].c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("Hops 1 of 3, limit 2 left", lines[2].c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("Channel 0x08 (LongFast, default key)", lines[3].c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("Relayed by ..42", lines[4].c_str());
|
||||
TEST_ASSERT_EQUAL_size_t(0, headerLines(kMeshtastic, 12).size()); // too short to be Meshtastic
|
||||
}
|
||||
|
||||
int main() {
|
||||
UNITY_BEGIN();
|
||||
RUN_TEST(test_row_for_a_meshtastic_packet);
|
||||
RUN_TEST(test_row_for_something_else);
|
||||
RUN_TEST(test_row_not_meshtastic);
|
||||
RUN_TEST(test_row_with_a_bad_crc);
|
||||
RUN_TEST(test_hex_dump);
|
||||
RUN_TEST(test_header_lines);
|
||||
return UNITY_END();
|
||||
}
|
||||
@@ -26,6 +26,10 @@ void test_defaults_when_store_is_empty() {
|
||||
TEST_ASSERT_TRUE(s.getBool(Setting::Sound));
|
||||
TEST_ASSERT_TRUE(s.getBool(Setting::ProbeMacRaw));
|
||||
TEST_ASSERT_TRUE(s.getBool(Setting::WifiEnabled));
|
||||
TEST_ASSERT_TRUE(s.getBool(Setting::GnssEnabled)); // Q58: on by default
|
||||
TEST_ASSERT_FALSE(s.getBool(Setting::CoordinatesDms)); // Q64: decimal degrees
|
||||
TEST_ASSERT_EQUAL_INT32(0, s.getInt(Setting::LoraPreset)); // Q95: LongFast
|
||||
TEST_ASSERT_FALSE(s.setInt(Setting::LoraPreset, 7)); // seven EU868 presets
|
||||
TEST_ASSERT_EQUAL_STRING("EU868", s.getString(Setting::Region).c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("CET-1CEST,M3.5.0,M10.5.0/3", s.getString(Setting::Timezone).c_str());
|
||||
}
|
||||
|
||||
@@ -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());
|
||||
}
|
||||
|
||||
void test_gnss_and_coordinate_rows_toggle() {
|
||||
Fixture f;
|
||||
int gnss = f.row(SettingsMenu::Row::Gnss), coords = f.row(SettingsMenu::Row::Coordinates);
|
||||
TEST_ASSERT_EQUAL_STRING("On", f.menu.value(gnss).c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("Decimal", f.menu.value(coords).c_str());
|
||||
f.menu.toggle(gnss);
|
||||
f.menu.toggle(coords);
|
||||
TEST_ASSERT_FALSE(f.settings.getBool(Setting::GnssEnabled));
|
||||
TEST_ASSERT_TRUE(f.settings.getBool(Setting::CoordinatesDms));
|
||||
TEST_ASSERT_EQUAL_STRING("Off", f.menu.value(gnss).c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("Deg min sec", f.menu.value(coords).c_str());
|
||||
}
|
||||
|
||||
int main() {
|
||||
UNITY_BEGIN();
|
||||
RUN_TEST(test_every_row_has_a_label);
|
||||
@@ -118,5 +131,6 @@ int main() {
|
||||
RUN_TEST(test_brightness_steps_with_left_right_within_bounds);
|
||||
RUN_TEST(test_wifi_is_a_page);
|
||||
RUN_TEST(test_names_are_text_rows_with_their_byte_limits);
|
||||
RUN_TEST(test_gnss_and_coordinate_rows_toggle);
|
||||
return UNITY_END();
|
||||
}
|
||||
|
||||
@@ -0,0 +1,74 @@
|
||||
#include <unity.h>
|
||||
|
||||
#include <vector>
|
||||
|
||||
#include "sweep_view.h"
|
||||
|
||||
using namespace roro::lora;
|
||||
|
||||
void setUp() {}
|
||||
void tearDown() {}
|
||||
|
||||
// 863.0 to 870.0 MHz in 100 kHz steps: 71 readings.
|
||||
static std::vector<int8_t> band(int8_t floor) { return std::vector<int8_t>(71, floor); }
|
||||
|
||||
void test_floor_is_the_median() {
|
||||
auto b = band(-95);
|
||||
b[10] = -60; // a few strong steps don't move the median
|
||||
b[11] = -62;
|
||||
b[50] = -70;
|
||||
SweepStats s = summarize(b.data(), b.size(), 863000000, 100000);
|
||||
TEST_ASSERT_EQUAL_INT(-95, s.floor);
|
||||
TEST_ASSERT_EQUAL_INT(-60, s.top);
|
||||
}
|
||||
|
||||
void test_peaks_strongest_first_and_merged() {
|
||||
auto b = band(-95);
|
||||
b[11] = -70; // 864.1 MHz, with shoulders: one peak, not three
|
||||
b[10] = -75;
|
||||
b[12] = -78;
|
||||
b[65] = -55; // 869.5 MHz
|
||||
b[30] = -90; // only 5 dB above the floor: not a peak
|
||||
SweepStats s = summarize(b.data(), b.size(), 863000000, 100000);
|
||||
TEST_ASSERT_EQUAL_size_t(2, s.peaks.size());
|
||||
TEST_ASSERT_EQUAL_UINT32(869500000u, s.peaks[0].hz);
|
||||
TEST_ASSERT_EQUAL_INT(-55, s.peaks[0].dbm);
|
||||
TEST_ASSERT_EQUAL_UINT32(864100000u, s.peaks[1].hz);
|
||||
}
|
||||
|
||||
void test_at_most_three_peaks() {
|
||||
auto b = band(-100);
|
||||
for (int i = 5; i < 70; i += 10) b[i] = static_cast<int8_t>(-80 + i / 10);
|
||||
SweepStats s = summarize(b.data(), b.size(), 863000000, 100000);
|
||||
TEST_ASSERT_EQUAL_size_t(3, s.peaks.size());
|
||||
TEST_ASSERT_EQUAL_INT(-74, s.peaks[0].dbm); // the strongest three
|
||||
}
|
||||
|
||||
void test_flat_band_has_no_peaks() {
|
||||
auto b = band(-88);
|
||||
SweepStats s = summarize(b.data(), b.size(), 863000000, 100000);
|
||||
TEST_ASSERT_EQUAL_size_t(0, s.peaks.size());
|
||||
TEST_ASSERT_EQUAL_INT(-88, s.floor);
|
||||
}
|
||||
|
||||
// The waterfall's scale: dark at the bottom, through blue and green to red at the top.
|
||||
void test_heat_scale() {
|
||||
TEST_ASSERT_EQUAL_UINT8(0, heatLevel(-130, -120, -60));
|
||||
TEST_ASSERT_EQUAL_UINT8(0, heatLevel(-120, -120, -60));
|
||||
TEST_ASSERT_EQUAL_UINT8(255, heatLevel(-60, -120, -60));
|
||||
TEST_ASSERT_EQUAL_UINT8(255, heatLevel(-20, -120, -60));
|
||||
TEST_ASSERT_EQUAL_UINT8(128, heatLevel(-90, -120, -60));
|
||||
TEST_ASSERT_TRUE(heatColor(0) != heatColor(255));
|
||||
TEST_ASSERT_EQUAL_HEX16(0x0000, heatColor(0)); // black
|
||||
TEST_ASSERT_EQUAL_HEX16(0xF800, heatColor(255)); // red
|
||||
}
|
||||
|
||||
int main() {
|
||||
UNITY_BEGIN();
|
||||
RUN_TEST(test_floor_is_the_median);
|
||||
RUN_TEST(test_peaks_strongest_first_and_merged);
|
||||
RUN_TEST(test_at_most_three_peaks);
|
||||
RUN_TEST(test_flat_band_has_no_peaks);
|
||||
RUN_TEST(test_heat_scale);
|
||||
return UNITY_END();
|
||||
}
|
||||
@@ -0,0 +1,78 @@
|
||||
#include <unity.h>
|
||||
|
||||
#include <string>
|
||||
|
||||
#include "track.h"
|
||||
|
||||
using namespace roro::gnss;
|
||||
|
||||
void setUp() {}
|
||||
void tearDown() {}
|
||||
|
||||
void test_distance_is_haversine() {
|
||||
// One minute of latitude is one nautical mile.
|
||||
TEST_ASSERT_FLOAT_WITHIN(2.0, 1852.0, distanceMeters(50.0, 4.0, 50.0 + 1.0 / 60, 4.0));
|
||||
TEST_ASSERT_FLOAT_WITHIN(0.01, 0.0, distanceMeters(50.0, 4.0, 50.0, 4.0));
|
||||
// A degree of longitude shrinks with latitude: cos(60°) = 0.5.
|
||||
TEST_ASSERT_FLOAT_WITHIN(60.0, 55597.0, distanceMeters(60.0, 0.0, 60.0, 1.0));
|
||||
}
|
||||
|
||||
void test_first_point_is_always_recorded() {
|
||||
TrackRule rule;
|
||||
TEST_ASSERT_TRUE(rule.due(1000, 50.0, 4.0));
|
||||
}
|
||||
|
||||
void test_a_point_needs_5_seconds_and_5_metres() {
|
||||
TrackRule rule;
|
||||
rule.due(0, 50.0, 4.0);
|
||||
double tenMetres = 10.0 / 111195.0; // degrees of latitude
|
||||
TEST_ASSERT_FALSE(rule.due(4999, 50.0 + tenMetres, 4.0)); // too soon
|
||||
TEST_ASSERT_FALSE(rule.due(5000, 50.0 + 1e-6, 4.0)); // too close (standing still)
|
||||
TEST_ASSERT_TRUE(rule.due(5000, 50.0 + tenMetres, 4.0));
|
||||
TEST_ASSERT_FALSE(rule.due(6000, 50.0 + 3 * tenMetres, 4.0)); // 5 s from the last point
|
||||
TEST_ASSERT_TRUE(rule.due(10000, 50.0 + 3 * tenMetres, 4.0));
|
||||
}
|
||||
|
||||
void test_reset_starts_over() {
|
||||
TrackRule rule;
|
||||
rule.due(0, 50.0, 4.0);
|
||||
rule.reset();
|
||||
TEST_ASSERT_TRUE(rule.due(100, 50.0, 4.0));
|
||||
}
|
||||
|
||||
void test_file_name_from_utc() {
|
||||
TEST_ASSERT_EQUAL_STRING("/gnss/tracks/20261004-203447.gpx", trackPath(1791146087LL).c_str()); // 20:34:47 UTC
|
||||
}
|
||||
|
||||
void test_gpx_header_point_and_footer() {
|
||||
std::string h = gpx::header("20261004-203447");
|
||||
TEST_ASSERT_TRUE(h.find("<?xml version=\"1.0\" encoding=\"UTF-8\"?>") == 0);
|
||||
TEST_ASSERT_TRUE(h.find("<gpx version=\"1.1\" creator=\"roro9stack\"") != std::string::npos);
|
||||
TEST_ASSERT_TRUE(h.find("<name>20261004-203447</name>") != std::string::npos);
|
||||
TEST_ASSERT_TRUE(h.find("<trkseg>") != std::string::npos);
|
||||
TEST_ASSERT_EQUAL_STRING(
|
||||
"<trkpt lat=\"50.8692030\" lon=\"-4.2535070\"><ele>42.5</ele><time>2026-10-04T20:34:47Z</time></trkpt>",
|
||||
gpx::point(50.869203, -4.253507, true, 42.5f, 1791146087LL).c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("<trkpt lat=\"50.8692030\" lon=\"4.2535070\"><time>2026-10-04T20:34:47Z</time></trkpt>",
|
||||
gpx::point(50.869203, 4.253507, false, 0, 1791146087LL).c_str());
|
||||
TEST_ASSERT_EQUAL_STRING("</trkseg></trk></gpx>", gpx::footer().c_str());
|
||||
}
|
||||
|
||||
void test_an_unfinished_file_is_recognised() {
|
||||
TEST_ASSERT_TRUE(gpx::finished("...<time>x</time></trkpt>\n</trkseg></trk></gpx>\n"));
|
||||
TEST_ASSERT_TRUE(gpx::finished("</trkseg></trk></gpx>"));
|
||||
TEST_ASSERT_FALSE(gpx::finished("...<time>x</time></trkpt>\n"));
|
||||
TEST_ASSERT_FALSE(gpx::finished(""));
|
||||
}
|
||||
|
||||
int main() {
|
||||
UNITY_BEGIN();
|
||||
RUN_TEST(test_distance_is_haversine);
|
||||
RUN_TEST(test_first_point_is_always_recorded);
|
||||
RUN_TEST(test_a_point_needs_5_seconds_and_5_metres);
|
||||
RUN_TEST(test_reset_starts_over);
|
||||
RUN_TEST(test_file_name_from_utc);
|
||||
RUN_TEST(test_gpx_header_point_and_footer);
|
||||
RUN_TEST(test_an_unfinished_file_is_recognised);
|
||||
return UNITY_END();
|
||||
}
|
||||
Reference in New Issue
Block a user