diff --git a/README.md b/README.md index 3b63d029..0f9b0c40 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,172 @@ +## O tomto forku (meshcore-tth) + +*English version [below](#about-this-fork-meshcore-tth).* + +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 +meshi (869,432 MHz). Upstreamové větve `main` a `dev` se slučují automaticky +dvakrát denně; všechno níže je navíc nad nimi. Náš kód je ve zdrojácích +označený `CUSTOM (TeTeHacko)`. Nic z toho nemění protokol na rádiu. + +### Repeater: antispam (všechno vypínatelné, nic z toho není v upstreamu) + +* **FairnessLimiter** – token buckety na přeposílané floody podle 1bajtových + identifikátorů, které jsou v paketu stejně v čitelné podobě (hash kanálu, + hash odesílatele, původce advertu). Port návrhu Beanowa + [#1502](https://github.com/meshcore-dev/MeshCore/pull/1502), limity + přepočítané z 30 dní skutečného provozu CZ meshe. + `fairness [on|off|grid|cap|refill]`; přímo směrovaný provoz se neomezuje nikdy. +* **Okno na adverty podle původce** – flood advert každého uzlu se přepošle + nejvýš jednou za N hodin (`fairness advert |clear`), převzato + z AdvertLimiteru [DutchMeshCore](https://github.com/Dutch-MeshCore/MeshCore). + Míří na uzly, které advertují každou minutu. +* **Dry-run** – `fairness dryrun on` započítá každý verdikt, ale přepošle + i tak; `fairness air` ukáže ušetřený (nebo ušetřitelný) airtime podle důvodu. +* **Filtr kanálů** – na kanálech, jejichž klíč repeater zná (Public + a `#hashtag` kanály), přestane přeposílat zprávy uvedených jmen odesílatelů + (`filter add|del|list`). Jméno se dá podvrhnout: je to brzda na utrženého + bota, ne bezpečnost. +* **Blokace přeposílání podle hashe kanálu** – `filter hash add [s]`: + bez klíče, takže funguje i na soukromých kanálech; příjem se nemění, jen + přeposílání. S `s` se kanál neodřízne, ale přiškrtí (jeden paket za `s` + sekund). +* **Limit stáří zprávy** – `filter age |off` (volitelné, 1–10080 min): + nepřeposílá skupinové zprávy na dešifrovaných kanálech, jejichž čas od + odesílatele je starší; bez nastavených hodin repeateru neplatí. Posuzuje + hodiny odesílatele, takže zahodí i companiony bez synchronizace času – + nastavuj ho na dny. +* `filter dryrun on` započítá každý verdikt `filter`, ale přepošle i tak. + +### Repeater: diagnostika a provoz + +* Pasivní analyzátor v konzoli: `nodes` (slyšené repeatery a roomy, klíč pro + spojení více cest), `rxlog` (každý slyšený rámec: typ, cesta, SNR, RSSI), + `pktlog` (surové rámce pro feed observeru), velké stránkované odpovědi. +* Kanálový bot v analyzer buildu (`!link`, dotazy na cestu, cooldown na + odesílatele, ignore list) – odpovídá, aniž by přeposílal. +* `dfu [uf2|serial|ota]` (spolehlivý reboot do bootloaderu), `blink`, `txpwr` + s verdiktem RadioLibu, `i2c` sken sběrnice, čítače chyb vysílání ve stavové + odpovědi, důvod resetu vypsaný při startu. +* Textová konzole přes BLE vedle USB, `ble on|off` uložené přes reboot + (`RPT_BLE_DEFAULT_OFF`: startuje vypnuté), vlastní BLE PIN (`ble pin`), + uložený vysílací výkon spojení (`blepwr`), `bleconn`, neblokující BLE + vysílání a parametry spojení, které vydrží i na slabém linku. +* Build flag `RADIO_DIAG`: `radiostat` / `radiokick` na přijímač SX1262, který + přestal přijímat. +* Provoz bez DIO1 (`LORA_POLL_IRQ`) pro desku s mrtvou linkou přerušení. + +### Opravy jádra + +* TRACE už nepřipisuje cestu za konec payloadu; parsování TRACE/PATH + a `Packet::readFrom` hlídají meze. +* `markSeen` je zase idempotentní (odesílací cesta ujídala okno deduplikace). +* Záložní výpočet v `calcMaxPacketMillis` už nepodteče (uzel na tom ohluchl). +* Šířka path hashe se bere z nastavení uzlu na všech cestách vysílání včetně + `sendZeroHop`; výchozí jsou 2bajtové path hashe (`PATH_HASH_MODE_DEFAULT`). +* Nepovedené vysílání se zařadí znovu s odstupem, místo aby se zahodilo. +* RSSI každého paketu se zaznamená při příjmu; `ContactInfo` se před + částečným vyplněním vynuluje. + +### Napájení, hodiny, GPS + +* GPS duty cycle (`gps duty`), i na T1000-E, kde nebyl: přijímač běží jen + kolem synchronizace hodin (jednou denně, po neúspěšném okně znovu za 6 h). + Dotaz na polohu přijímač probudí pro příští dotaz. +* Uzel bez GPS startuje na čase sestavení firmwaru, ne v roce 2024; hodiny + a záznam o hardfaultu přežijí teplý reset (`.noinit`); `clkreboot`. +* Na solárních uzlech žádná blikající LED a pomalejší BLE advertising; stav + baterie jako ikona na konci advertovaného jména (volitelné). + +### Senzory a companiony + +* `simple_sensor`: telemetrie z externí stanice po UART + (`BudkaLinkSensorManager`, jeden LPP kanál na veličinu), `sensor read`. +* Companion: `gps duty` přežije reboot, export klíče a PIN jsou na + neověřeném USB spojení zamčené, kopie data sestavení má hlídanou délku. + KISS modem: oprava o jedna vedle při zkracování jména. + +### Veřejné buildy: výchozí nastavení pro český mesh + +Releasy z tohoto repozitáře (`pub-release`) jsou přednastavené pro český +mesh podle wiki [meshcore.cz](https://meshcore.cz/), takže čerstvě nahraný +uzel nepotřebuje obvyklé kolečko nastavování: + +* rádio 869,432 MHz / 62,5 kHz / SF7 / CR5 (všechny buildy); +* repeater a room server: zero-hop advert vypnutý, flood advert každých 25 h, + `af 9` (10% duty cycle); +* repeater: regiony `cz` a `cs` vedle `*` – vlastní `cz-` přidáš přes + `region put cz-xxx cz` + `region save`; +* 2bajtové path hashe (výchozí v tomto forku); +* repeater: filtr kanálů (`filter add `) je zabudovaný pro Public, + `#meshcore` a `#test`, s prázdným seznamem – nedělá nic, dokud do něj + nepřidáš jméno. + +Platí jen pro uzel bez uloženého nastavení (nový nebo po `erase`): nové +nahrání ponechá, co už uzel má, a regiony, které jsi smazal a uložil, +zůstanou smazané. Jméno a admin heslo si nastav sám. + +Varianty observer (`*_repeater-observer-*`) nRF52 repeaterů (XIAO, SenseCAP +Solar, RAK4631, T1000-E, Heltec T114) přidávají buffery `nodes` / `rxlog` / +`pktlog` a textovou konzoli přes BLE, aby šel repeater číst přes USB nebo BLE +([meshcore-repeater-observer](https://git.rfa.cz/tth-pub/meshcore-repeater-observer)). +BLE konzole je po nahrání **vypnutá** (`RPT_BLE_DEFAULT_OFF`). Nemá vlastní +přihlášení, jen BLE PIN, a PIN v buildu je veřejný zástupný `123456`. Nejdřív +si proto nastav vlastní – v USB konzoli, nebo jako admin přes mesh (vzdálené +CLI v aplikaci): `ble pin <6 číslic>` (uloží se a přežije reboot i nové +nahrání; zároveň smaže všechny bondy, takže spárovaná zařízení se párují +znovu). Teprve pak `ble on` – dokud je PIN zástupný, tyhle buildy ho odmítnou. +`ble` ukáže, jestli je PIN `own` nebo `build default`, samotný PIN nikdy. +Releasy do `tth-654d53f3` `ble pin` nemají: BLE tam nech vypnuté a používej USB. + +### Nahrání releasu + +Soubory jsou v [Releases](https://git.rfa.cz/tth-pub/meshcore-tth/releases), +jedna sada pro každou desku a roli (`_-`): `.zip` a `.uf2` +pro nRF52, `.bin` pro ESP32 (`-merged.bin` je celý obraz pro prázdnou desku, +obyčejný `.bin` aktualizace). Kontrolní součty jsou v `SHA256SUMS`. + +**nRF52 (XIAO, RAK4631, SenseCAP Solar, T1000-E, T114) přes +[webový flasher MeshCore](https://flasher.meshcore.io)** – Chrome, Edge nebo +Chromium na počítači (Web Serial; ne Firefox ani Safari): + +1. Připoj desku přes USB. +2. Klikni na **Custom Firmware** a vyber `.zip` pro svou desku. +3. Klikni na **Enter DFU mode** a vyber sériový port desky. Deska se + restartuje do bootloaderu a objeví se jako nový port. +4. Klikni na **Flash!** a vyber ten nový port. Zhruba 30 s, pak se deska + restartuje do nového firmwaru. +5. **Console** ve flasheru (nebo jakýkoli sériový terminál, 115200) ověří + výsledek: `ver` ukáže `v1.xx.x-tth`, sha odpovídá názvu souboru. + +**Neklikej na Erase Flash**, pokud nechceš nový uzel: smaže identitu (klíč +uzlu a všechno, co ho zná) i veškeré nastavení. Obyčejné nahrání je zachová. + +Vyzkoušeno na XIAO (repeater-observer, 3. 11. 2026). ESP32 `.bin` přes stejné +tlačítko Custom Firmware tu vyzkoušené není. + +Bez webového flasheru: na většině desek otevře dvojí stisk resetu bootloader +jako USB disk; zkopíruj na něj `.uf2`. Nebo +`adafruit-nrfutil dfu serial -pkg .zip -p -b 115200` s deskou +v bootloaderu. + +Nový uzel po nahrání nastav v konzoli: `set name `, +`password ` (nejvýš 15 znaků), vlastní region přes +`region put cz- cz` + `region save`. Repeater přeposílá od prvního +startu (výchozí v upstreamu) a tyhle buildy jsou na ostré CZ frekvenci: na +stole bez antény dej `set repeat off`, dokud není na místě. + +### Sestavení + +* Razítko verze v každém nRF52 envu (`v1.18.0-tth`, `+` = neuklizený + strom), základní verze z upstreamového tagu (`tools/build_version.py`). +* `hardware/cavity-box`: parametrická krabička pro dutinový filtr na stožár. + +--- + ## About this fork (meshcore-tth) +*Česká verze [výše](#o-tomto-forku-meshcore-tth).* + 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 @@ -63,8 +230,9 @@ twice a day; everything below is on top of that. Our code is marked ### Power, clock, GPS -* GPS duty cycle (`gps duty`), also on the T1000-E, which had none; a position - request warms the duty-cycled receiver for next time. +* GPS duty cycle (`gps duty`), also on the T1000-E, which had none: the + receiver runs only around a clock sync (once a day, after a window without + a fix again in 6 h). A position request warms it for the next request. * A node without GPS starts at its build epoch, not in 2024; the clock and a hardfault record survive a warm reset (`.noinit`); `clkreboot`. * No blinking LED and slower BLE advertising on solar nodes; battery level as