From 4b2da2924fd96966e066f4101e21aa98cc012101 Mon Sep 17 00:00:00 2001 From: TeTeHacko Date: Tue, 17 Nov 2026 01:56:56 +0100 Subject: [PATCH] README: experimental firmware, not meant for regular users -- said first Co-Authored-By: Claude Opus 5.5 --- README.md | 57 ++++++++++++++++++++++++++++++++++++++++++------- docs/ota.md | 4 ++++ tools/README.md | 4 +++- 3 files changed, 56 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 769e1594..2e672877 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,16 @@ ## O tomto forku (meshcore-tth) -*English version [below](#about-this-fork-meshcore-tth).* +*English version [below](#about-this-fork-meshcore-tth) -- experimental +firmware, not meant for regular users.* + +> [!WARNING] +> **Experimentální firmware – není určený pro běžné uživatele.** Tenhle fork +> i všechny jeho releasy jsou osobní vývojová větev pro uzly jedné malé sítě: +> rolling release nad upstreamovou větví `dev`, sestavovaný automaticky +> zhruba dvakrát denně, bez stabilního kanálu, bez podpory a vyzkoušený jen +> na našich deskách. Může obsahovat chyby, které uzel vyřadí z provozu, +> a vrátit ho pak jde jen s USB nebo BLE v ruce. Pro běžný provoz nahrajte +> oficiální MeshCore ([flasher.meshcore.io](https://flasher.meshcore.io)). Fork projektu [meshcore-dev/MeshCore](https://github.com/meshcore-dev/MeshCore), na kterém běží repeatery, senzory a testovací desky malé české sítě na CZ @@ -136,6 +146,10 @@ Releasy do `tth-654d53f3` `ble pin` nemají: BLE tam nech vypnuté a používej ### Nahrání releasu +Každý release je automatický build nad upstreamovým `dev` (viz upozornění +nahoře), ne stabilní verze. Nahrávejte ho jen na uzly, na které dosáhnete, +a nový release vždy nejdřív na jeden z nich. + Soubory jsou v [Releases](https://git.rfa.cz/tth-pub/meshcore-tth/releases). Release se jmenuje podle upstreamové verze a data, např. `v1.18.0+tth.20261112` (druhý téhož dne `.2`), a v popisu má změny od @@ -211,9 +225,14 @@ zůstane v bootloaderu a vrátí se přes USB/BLE DFU. aplikace [meshcore-open](https://git.rfa.cz/tth-pub/meshcore-open), správa repeateru → Firmware update (OTA), deltu si najde v releasu sám. Postup a čísla: [docs/ota.md](docs/ota.md). -* **Experimentální**: vyzkoušeno na XIAO na lavici přes USB i přes mesh - (1 hop). Vadný nový firmware nemá kam se vrátit (není druhá banka) – nový - release nejdřív na jednom uzlu na dosah. Stojí ~10 kB RAM navíc. +* **Experimentální i v rámci tohoto forku**: obrazy přicházejí s každým + releasem (viz upozornění nahoře) a nemají druhou banku ani automatický + návrat. Vadný firmware, který nabootuje, běží, dokud nepošlete další; + takový, který nenabootuje, chce USB/BLE DFU v ruce. Vyzkoušeno na lavici + (XIAO, USB, mesh, vedlejší kanál) a od 13. 11. 2026 na dvou našich + stožárech. Proti obrazu, který nabootuje s mrtvým rádiem, jsou watchdogy + `set radio.silence` / `set radio.txstall` (výchozí vypnuté, + [docs/ota.md](docs/ota.md)). Stojí ~10 kB RAM navíc. ### Sestavení @@ -230,6 +249,15 @@ zůstane v bootloaderu a vrátí se přes USB/BLE DFU. *Česká verze [výše](#o-tomto-forku-meshcore-tth).* +> [!WARNING] +> **Experimental firmware -- not meant for regular users.** This fork and all +> its releases are a personal development branch for the nodes of one small +> network: a rolling release on upstream `dev`, built automatically about +> twice a day, with no stable channel, no support, and tried only on our own +> boards. It may carry bugs that take a node out of service, and getting one +> back then needs USB or BLE in hand. For everyday use flash the official +> MeshCore ([flasher.meshcore.io](https://flasher.meshcore.io)). + A fork of [meshcore-dev/MeshCore](https://github.com/meshcore-dev/MeshCore) that runs the repeaters, sensors and bench boards of a small Czech network on the CZ mesh (869.432 MHz). Upstream `main` and `dev` are merged automatically @@ -360,6 +388,10 @@ up to `tth-654d53f3` do not have `ble pin`: keep BLE off there and use USB. ### Flashing a release +Every release is an automatic build on upstream `dev` (see the warning +above), not a stable version. Flash it only on nodes you can reach, and each +new release on one of them first. + Files are in [Releases](https://git.rfa.cz/tth-pub/meshcore-tth/releases). A release is named after the upstream version and the date, e.g. `v1.18.0+tth.20261112` (a second one that day `.2`), and its notes list the @@ -437,10 +469,14 @@ cut during the rewrite leaves it in the bootloader, back via USB/BLE DFU. fork, repeater management → Firmware update (OTA), which finds the delta in the release by itself. How it works and bench numbers: [docs/ota.md](docs/ota.md). -* **Experimental**: tried on XIAO boards on the bench over USB and over the - mesh (1 hop). A bad new firmware has nothing to fall back to (no second - bank) -- try a new release on one node within reach first. Costs ~10 kB of - RAM. +* **Experimental even within this fork**: the images come with every + release (see the warning above) and have no second bank and no automatic + rollback. A bad firmware that boots keeps running until you push the next + one; one that does not boot needs USB/BLE DFU in hand. Tried on the bench + (XIAO, USB, mesh, side channel) and on two of our masts since 13. 11. 2026. + The watchdogs `set radio.silence` / `set radio.txstall` (off by default, + [docs/ota.md](docs/ota.md)) catch an image that boots with a dead radio. + Costs ~10 kB of RAM. ### Build @@ -453,6 +489,11 @@ cut during the rewrite leaves it in the bootloader, back via USB/BLE DFU. --- +*Níže je README upstreamového MeshCore. Jeho flasher, klienti a návody se +týkají oficiálního firmwaru, ne releasů tohoto forku. / Below is upstream +MeshCore's README: its flasher, clients and guides refer to the official +firmware, not to this fork's releases.* + ## About MeshCore MeshCore is a lightweight, portable C++ library that enables multi-hop packet routing for embedded projects using LoRa and other packet radios. It is designed for developers who want to create resilient, decentralized communication networks that work without the internet. diff --git a/docs/ota.md b/docs/ota.md index 39946f85..a0fe49b5 100644 --- a/docs/ota.md +++ b/docs/ota.md @@ -1,5 +1,9 @@ # Admin-pushed firmware update (experimental `-ota` images) +> [!WARNING] +> Part of an experimental fork, not meant for regular users: its releases +> are a rolling release on MeshCore `dev` (see the [README](../README.md)). + The `*-ota` and `*-observer-ota` images of this fork's releases can take a new firmware from their admin -- over the USB or BLE console, or **over the mesh, as remote admin CLI**. Nothing changes in the bootloader and there is no second diff --git a/tools/README.md b/tools/README.md index 9c00bbaf..d4691313 100644 --- a/tools/README.md +++ b/tools/README.md @@ -3,7 +3,9 @@ Host-side tools for MeshCore nodes of this fork: consoles, flashing, bench tests and diagnostics. Every script answers `--help` without touching a port, -a node or the network. +a node or the network. They serve an experimental fork that is not meant for +regular users (see the [README](../README.md)); several of them transmit or +reflash a node. ## Your boards: the local config