Jean-Pierre MartineauandClaude Opus 5.5
5d0bf52717
A new page, docs/connecting.md, collects every connection failure MeshTerm reports, with its cause and remedy: who pairs a Bluetooth companion on each system (MeshTerm on Windows and Linux, macOS's own dialog there, where --ble-pin does nothing), the terminal's Bluetooth permission on macOS and its refusal over SSH, reading a screenless companion's PIN over USB, forgetting a pairing on each system, and the dialout group and ModemManager for USB on Linux. The README, the docs index, hardware.md, and the CLI manual's failure section link to it, and --ble-pin says it has no effect on macOS. The CLI manual's no-radio example shows today's message. The changelog covers the Linux Bluetooth pairing and link fixes and the per-step failure messages. configuration.md shows db_path, and a few lists gain their Oxford comma, WiFi becomes Wi-Fi, and "never-before-seen" becomes "heard for the first time". Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
3.1 KiB
3.1 KiB
MeshTerm documentation
Everything that didn't belong on the front page. The README is the front door — what MeshTerm is, how to install it, and enough to get a first session running. This folder is the rest.
Using MeshTerm
| Read | For |
|---|---|
| What MeshTerm does | Every screen the menu offers, grouped the way the menu groups them, with the command that does the same job without it. |
| The command line | The manual. Every subcommand and option, what each prints on the plain and JSON faces, the exit statuses, and recipes built on jq. |
| The CLI cookbook | Common one-liners by task, for when you want the shape of a command rather than its specification. |
| Configuring MeshTerm | Preferences versus config, device profiles, and everything kept under ~/.meshterm. |
| When a companion won't connect | Bluetooth pairing on each system, finding the PIN, and every connection error MeshTerm reports, with what to do about it. |
| Terminals, icons, and the Windows console | Why the icons and charts draw on some terminals and not others, and what MeshTerm does about it on Windows. |
Putting it on hardware
Only if you want MeshTerm running on a handheld's own screen. A MeshCore companion on USB, Bluetooth, or Wi-Fi needs none of this.
| Read | For |
|---|---|
| MeshTerm on hardware | Start here — which of the two manuals below is yours, and what the device-side scripts do. |
| MeshTerm on the PicoCalc | A stock ClockworkPi PicoCalc to a Linux handheld with a LoRa radio soldered inside: the shopping list, the Lyra swap, Calculinux, and the radio. |
| MeshTerm on the uConsole | A uConsole with the hackergadgets AIO LoRa board, whose SX1262 sits on the host's own SPI bus — MeshTerm drives it directly with --spi, or a small bridge fronts it as a companion for an always-on node. |
Reading the code
| Read | For |
|---|---|
| How the code is laid out | The layering, and where a new feature goes. |
| CLAUDE.md | The actual style guide — terminology, UX standards, and the reusable building blocks. Written for AI assistants, and the house rules for everyone. |
| CONTRIBUTING.md | The dev install, the three gates a change has to pass, and what happens to your contribution's licensing. |
Historical record
A survey of the code, kept because a project that writes down its own problems is easier to trust than one that doesn't — but it is a snapshot of a date, not a to-do list. Some of what it describes has been fixed since, and it does not mark which.
| Read | For |
|---|---|
| UI consistency survey | Everything else in the CLAUDE.md UX standard — six sweeps found nothing, which is the useful part. |
Also here
screenshots/ holds the captures the README shows and the ones
meshterm.net builds its landing page from, so a file in there is
referenced from more than one place.