From 68360157ecee382e6221d593724e473dd47cede5 Mon Sep 17 00:00:00 2001 From: OhYou-0 Date: Fri, 24 Apr 2026 10:16:19 -0700 Subject: [PATCH 01/59] Add LilyGo T-ETH Elite board support --- variants/lilygo_teth_elite/TETHEliteBoard.h | 10 +++ variants/lilygo_teth_elite/platformio.ini | 99 +++++++++++++++++++++ variants/lilygo_teth_elite/target.cpp | 43 +++++++++ variants/lilygo_teth_elite/target.h | 20 +++++ 4 files changed, 172 insertions(+) create mode 100644 variants/lilygo_teth_elite/TETHEliteBoard.h create mode 100644 variants/lilygo_teth_elite/platformio.ini create mode 100644 variants/lilygo_teth_elite/target.cpp create mode 100644 variants/lilygo_teth_elite/target.h diff --git a/variants/lilygo_teth_elite/TETHEliteBoard.h b/variants/lilygo_teth_elite/TETHEliteBoard.h new file mode 100644 index 00000000..15eb9533 --- /dev/null +++ b/variants/lilygo_teth_elite/TETHEliteBoard.h @@ -0,0 +1,10 @@ +#pragma once + +#include + +class TETHEliteBoard : public ESP32Board { +public: + const char* getManufacturerName() const override { + return "LilyGO T-ETH Elite"; + } +}; diff --git a/variants/lilygo_teth_elite/platformio.ini b/variants/lilygo_teth_elite/platformio.ini new file mode 100644 index 00000000..97728f8b --- /dev/null +++ b/variants/lilygo_teth_elite/platformio.ini @@ -0,0 +1,99 @@ +[LilyGo_TETH_Elite_sx1262] +extends = esp32_base +board = esp32s3box +board_build.partitions = default_16MB.csv +board_upload.flash_size = 16MB +build_flags = + ${esp32_base.build_flags} + -I variants/lilygo_teth_elite + -D BOARD_HAS_PSRAM + -D LILYGO_TETH_ELITE + -D LILYGO_T_ETH_ELITE_ESP32S3 + -D ARDUINO_USB_CDC_ON_BOOT=1 + -D P_LORA_DIO_1=8 + -D P_LORA_NSS=40 + -D P_LORA_RESET=46 + -D P_LORA_BUSY=16 + -D P_LORA_SCLK=10 + -D P_LORA_MISO=9 + -D P_LORA_MOSI=11 + -D P_LORA_TX_LED=38 + -D SX126X_DIO2_AS_RF_SWITCH=true + -D SX126X_DIO3_TCXO_VOLTAGE=1.8 + -D SX126X_CURRENT_LIMIT=140 + -D USE_SX1262 + -D RADIO_CLASS=CustomSX1262 + -D WRAPPER_CLASS=CustomSX1262Wrapper + -D LORA_TX_POWER=8 + -D SX126X_RX_BOOSTED_GAIN=1 +build_src_filter = ${esp32_base.build_src_filter} + +<../variants/lilygo_teth_elite> +lib_deps = + ${esp32_base.lib_deps} + +[env:LilyGo_TETH_Elite_sx1262_repeater] +extends = LilyGo_TETH_Elite_sx1262 +build_flags = + ${LilyGo_TETH_Elite_sx1262.build_flags} + -D ADVERT_NAME='"T-ETH Elite Repeater"' + -D ADVERT_LAT=0.0 + -D ADVERT_LON=0.0 + -D ADMIN_PASSWORD='"password"' + -D MAX_NEIGHBOURS=50 +; -D MESH_PACKET_LOGGING=1 +; -D MESH_DEBUG=1 +build_src_filter = ${LilyGo_TETH_Elite_sx1262.build_src_filter} + +<../examples/simple_repeater> +lib_deps = + ${LilyGo_TETH_Elite_sx1262.lib_deps} + ${esp32_ota.lib_deps} + +[env:LilyGo_TETH_Elite_sx1262_room_server] +extends = LilyGo_TETH_Elite_sx1262 +build_flags = + ${LilyGo_TETH_Elite_sx1262.build_flags} + -D ADVERT_NAME='"T-ETH Elite Room"' + -D ADVERT_LAT=0.0 + -D ADVERT_LON=0.0 + -D ADMIN_PASSWORD='"password"' + -D ROOM_PASSWORD='"hello"' +; -D MESH_PACKET_LOGGING=1 +; -D MESH_DEBUG=1 +build_src_filter = ${LilyGo_TETH_Elite_sx1262.build_src_filter} + +<../examples/simple_room_server> +lib_deps = + ${LilyGo_TETH_Elite_sx1262.lib_deps} + ${esp32_ota.lib_deps} + +[env:LilyGo_TETH_Elite_sx1262_companion_radio_usb] +extends = LilyGo_TETH_Elite_sx1262 +build_flags = + ${LilyGo_TETH_Elite_sx1262.build_flags} + -D MAX_CONTACTS=350 + -D MAX_GROUP_CHANNELS=40 + -D OFFLINE_QUEUE_SIZE=256 +; -D MESH_PACKET_LOGGING=1 +; -D MESH_DEBUG=1 +build_src_filter = ${LilyGo_TETH_Elite_sx1262.build_src_filter} + +<../examples/companion_radio/*.cpp> +lib_deps = + ${LilyGo_TETH_Elite_sx1262.lib_deps} + densaugeo/base64 @ ~1.4.0 + +[env:LilyGo_TETH_Elite_sx1262_companion_radio_ble] +extends = LilyGo_TETH_Elite_sx1262 +build_flags = + ${LilyGo_TETH_Elite_sx1262.build_flags} + -D MAX_CONTACTS=350 + -D MAX_GROUP_CHANNELS=40 + -D BLE_PIN_CODE=123456 + -D BLE_DEBUG_LOGGING=1 + -D OFFLINE_QUEUE_SIZE=256 +; -D MESH_PACKET_LOGGING=1 +; -D MESH_DEBUG=1 +build_src_filter = ${LilyGo_TETH_Elite_sx1262.build_src_filter} + + + +<../examples/companion_radio/*.cpp> +lib_deps = + ${LilyGo_TETH_Elite_sx1262.lib_deps} + densaugeo/base64 @ ~1.4.0 diff --git a/variants/lilygo_teth_elite/target.cpp b/variants/lilygo_teth_elite/target.cpp new file mode 100644 index 00000000..4dc377d6 --- /dev/null +++ b/variants/lilygo_teth_elite/target.cpp @@ -0,0 +1,43 @@ +#include +#include "target.h" + +TETHEliteBoard board; + +static SPIClass spi(HSPI); +RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_1, P_LORA_RESET, P_LORA_BUSY, spi); +WRAPPER_CLASS radio_driver(radio, board); + +ESP32RTCClock fallback_clock; +AutoDiscoverRTCClock rtc_clock(fallback_clock); +SensorManager sensors; + +#ifndef LORA_CR + #define LORA_CR 5 +#endif + +bool radio_init() { + fallback_clock.begin(); + rtc_clock.begin(Wire); + + return radio.std_init(&spi); +} + +uint32_t radio_get_rng_seed() { + return radio.random(0x7FFFFFFF); +} + +void radio_set_params(float freq, float bw, uint8_t sf, uint8_t cr) { + radio.setFrequency(freq); + radio.setSpreadingFactor(sf); + radio.setBandwidth(bw); + radio.setCodingRate(cr); +} + +void radio_set_tx_power(int8_t dbm) { + radio.setOutputPower(dbm); +} + +mesh::LocalIdentity radio_new_identity() { + RadioNoiseListener rng(radio); + return mesh::LocalIdentity(&rng); +} diff --git a/variants/lilygo_teth_elite/target.h b/variants/lilygo_teth_elite/target.h new file mode 100644 index 00000000..a842186c --- /dev/null +++ b/variants/lilygo_teth_elite/target.h @@ -0,0 +1,20 @@ +#pragma once + +#define RADIOLIB_STATIC_ONLY 1 +#include +#include +#include +#include +#include +#include "TETHEliteBoard.h" + +extern TETHEliteBoard board; +extern WRAPPER_CLASS radio_driver; +extern AutoDiscoverRTCClock rtc_clock; +extern SensorManager sensors; + +bool radio_init(); +uint32_t radio_get_rng_seed(); +void radio_set_params(float freq, float bw, uint8_t sf, uint8_t cr); +void radio_set_tx_power(int8_t dbm); +mesh::LocalIdentity radio_new_identity(); From 528bf3f61e8909c4b16601e9835afb2df8feb94a Mon Sep 17 00:00:00 2001 From: Liam Cottle Date: Sun, 26 Apr 2026 00:24:40 +1200 Subject: [PATCH 02/59] add FUNDING.yml --- .github/FUNDING.yml | 1 + 1 file changed, 1 insertion(+) create mode 100644 .github/FUNDING.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 00000000..262a9ee4 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +github: meshcore-dev From 34db93150a4be32dd5780b1f59da8a2104a0bbb7 Mon Sep 17 00:00:00 2001 From: uncle lit <43320854+LitBomb@users.noreply.github.com> Date: Sun, 26 Apr 2026 18:35:02 -0700 Subject: [PATCH 03/59] Removed links to outdated resources and links Removed links to outdated resources and links --- docs/faq.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index 3edc0a69..c5866fb5 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -111,7 +111,6 @@ Anyone is able to build anything they like on top of MeshCore without paying any - MeshCore Firmware on GitHub: [https://github.com/meshcore-dev/MeshCore](https://github.com/meshcore-dev/MeshCore) - MeshCore Companion Web App: [https://app.meshcore.nz](https://app.meshcore.nz) - MeshCore Map: [https://map.meshcore.io](https://map.meshcore.io) -- Andy Kirby's [MeshCore Intro Video](https://www.youtube.com/watch?v=t1qne8uJBAc) - Liam Cottle's [MeshCore Technical Presentation](https://www.youtube.com/watch?v=OwmkVkZQTf4) You need LoRa hardware devices to run MeshCore firmware as clients or server (repeater and room server). @@ -404,9 +403,6 @@ Another way to download map tiles is to use this Python script to get the tiles There is also a modified script that adds additional error handling and parallel downloads: -UK map tiles are available separately from Andy Kirby on his discord server: - - ### 4.8. Q: Where do the map tiles go? Once you have the tiles downloaded, copy the `\tiles` folder to the root of your T-Deck's SD card. @@ -563,10 +559,6 @@ pio run -e RAK_4631_Repeater ``` then you'll find `firmware.zip` in `.pio/build/RAK_4631_Repeater` -Andy also has a video on how to build using VS Code: -*How to build and flash Meshcore repeater firmware | Heltec V3* - *(Link referenced in the Discord post)* - ### 5.10. Q: Are there other MeshCore related open source projects? **A:** [Liam Cottle](https://liamcottle.net)'s MeshCore web client and MeshCore Javascript library are open source under MIT license. From b948369d71c6b83ff01f3207cd6437b1b2ba8003 Mon Sep 17 00:00:00 2001 From: Keith Tweed Date: Sun, 26 Apr 2026 19:51:33 -0600 Subject: [PATCH 04/59] Update script link in FAQ 4.7 --- docs/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/faq.md b/docs/faq.md index 3edc0a69..18f7ce35 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -402,7 +402,7 @@ Another way to download map tiles is to use this Python script to get the tiles There is also a modified script that adds additional error handling and parallel downloads: - + UK map tiles are available separately from Andy Kirby on his discord server: From c4137e78d00a51d0425e9a33352fca184bf85457 Mon Sep 17 00:00:00 2001 From: Nick Le Mouton Date: Sat, 2 May 2026 17:12:03 +1200 Subject: [PATCH 05/59] Add stddef.h --- src/MeshCore.h | 1 + 1 file changed, 1 insertion(+) diff --git a/src/MeshCore.h b/src/MeshCore.h index 2db1d4c3..2a786f22 100644 --- a/src/MeshCore.h +++ b/src/MeshCore.h @@ -1,6 +1,7 @@ #pragma once #include +#include #include #define MAX_HASH_SIZE 8 From 09a27a259177c76e62f128f10ca96108c7442a0a Mon Sep 17 00:00:00 2001 From: Stephen Waits Date: Mon, 11 May 2026 17:24:09 -0600 Subject: [PATCH 06/59] fix(mesh): widen TRACE offset to uint16 to avoid narrowing --- src/Mesh.cpp | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/Mesh.cpp b/src/Mesh.cpp index 57fee140..0c96e14d 100644 --- a/src/Mesh.cpp +++ b/src/Mesh.cpp @@ -50,7 +50,9 @@ DispatcherAction Mesh::onRecvPacket(Packet* pkt) { uint8_t path_sz = flags & 0x03; // NEW v1.11+: lower 2 bits is path hash size uint8_t len = pkt->payload_len - i; - uint8_t offset = pkt->path_len << path_sz; + // path_len*entry_size can exceed 255 (path_len up to 63, entry_size up to 8); + // a uint8_t offset would wrap and steer the isHashMatch() read to the wrong place. + uint16_t offset = (uint16_t)pkt->path_len << path_sz; if (offset >= len) { // TRACE has reached end of given path onTraceRecv(pkt, trace_tag, auth_code, flags, pkt->path, &pkt->payload[i], len); } else if (self_id.isHashMatch(&pkt->payload[i + offset], 1 << path_sz) && allowPacketForward(pkt) && !_tables->hasSeen(pkt)) { From 16cb6d518f7639d755cf4aea22d7f741b25ff81f Mon Sep 17 00:00:00 2001 From: AI7NC <77077873+AI7NC@users.noreply.github.com> Date: Tue, 12 May 2026 12:42:33 -0700 Subject: [PATCH 07/59] Update cli_commands.md to include 'ver' Include the 'ver' command for retrieving the firmware version --- docs/cli_commands.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/cli_commands.md b/docs/cli_commands.md index fb698228..99dced36 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md @@ -405,6 +405,11 @@ This document provides an overview of CLI commands that can be sent to MeshCore --- +#### View this node's firmware version +**Usage:** `ver` + +--- + #### View this node's configured role **Usage:** `get role` From d4c99dec65331b95ee3fe628112153cf1af75701 Mon Sep 17 00:00:00 2001 From: Rastislav Vysoky Date: Fri, 15 May 2026 16:42:29 +0200 Subject: [PATCH 08/59] Change MeshCore intro video link to The Comms Channel's MC intro playlist --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f8b9e5e0..d5f2a16f 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ MeshCore provides the ability to create wireless mesh networks, similar to Mesht ## 🚀 How to Get Started -- Watch the [MeshCore Intro Video](https://www.youtube.com/watch?v=t1qne8uJBAc) by Andy Kirby. +- Watch the [MeshCore QuickStart Playlist](https://www.youtube.com/watch?v=iaFltojJrAc&list=PLshzThxhw4O4WU_iZo3NmNZOv6KMrUuF9) by The Comms Channel - Watch the [MeshCore Technical Presentation](https://www.youtube.com/watch?v=OwmkVkZQTf4) by Liam Cottle. - Read through our [Frequently Asked Questions](./docs/faq.md) and [Documentation](https://docs.meshcore.io). - Flash the MeshCore firmware on a supported device. From 62f1b11d5b3c80e9c74e8262d681fbb739db6eba Mon Sep 17 00:00:00 2001 From: Wessel Nieboer Date: Sat, 14 Mar 2026 02:47:03 +0100 Subject: [PATCH 09/59] Increase MAX_FRAME_SIZE by 4 bytes It's the safest fix for now to fix region scoped messages from being dropped early --- src/helpers/BaseSerialInterface.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/helpers/BaseSerialInterface.h b/src/helpers/BaseSerialInterface.h index e6092765..e9a3f2ab 100644 --- a/src/helpers/BaseSerialInterface.h +++ b/src/helpers/BaseSerialInterface.h @@ -2,7 +2,7 @@ #include -#define MAX_FRAME_SIZE 172 +#define MAX_FRAME_SIZE 176 // +4 for transport codes (region scoping) class BaseSerialInterface { protected: From a3d20d62097a29568aab03cd5abd6adc51e34540 Mon Sep 17 00:00:00 2001 From: Kevin Le Date: Fri, 13 Feb 2026 23:05:44 +0700 Subject: [PATCH 10/59] Let ESP32-based repeaters to sleep immediately receiving and process a LoRa packet --- examples/simple_repeater/main.cpp | 20 ++++++-------------- 1 file changed, 6 insertions(+), 14 deletions(-) diff --git a/examples/simple_repeater/main.cpp b/examples/simple_repeater/main.cpp index 297337ab..7946809e 100644 --- a/examples/simple_repeater/main.cpp +++ b/examples/simple_repeater/main.cpp @@ -20,8 +20,7 @@ void halt() { static char command[160]; // For power saving -unsigned long lastActive = 0; // mark last active time -unsigned long nextSleepinSecs = 120; // next sleep in seconds. The first sleep (if enabled) is after 2 minutes from boot +unsigned long POWERSAVING_FIRSTSLEEP_SECS = 120; // The first sleep (if enabled) from boot #if defined(PIN_USER_BTN) && defined(_SEEED_SENSECAP_SOLAR_H_) static unsigned long userBtnDownAt = 0; @@ -40,9 +39,6 @@ void setup() { delay(5000); #endif - // For power saving - lastActive = millis(); // mark last active time since boot - #ifdef DISPLAY_CLASS if (display.begin()) { display.startFrame(); @@ -157,16 +153,12 @@ void loop() { rtc_clock.tick(); if (the_mesh.getNodePrefs()->powersaving_enabled && !the_mesh.hasPendingWork()) { - #if defined(NRF52_PLATFORM) +#if defined(NRF52_PLATFORM) board.sleep(1800); // nrf ignores seconds param, sleeps whenever possible - #else - if (the_mesh.millisHasNowPassed(lastActive + nextSleepinSecs * 1000)) { // To check if it is time to sleep - board.sleep(1800); // To sleep. Wake up after 30 minutes or when receiving a LoRa packet - lastActive = millis(); - nextSleepinSecs = 5; // Default: To work for 5s and sleep again - } else { - nextSleepinSecs += 5; // When there is pending work, to work another 5s +#else + if (the_mesh.millisHasNowPassed(POWERSAVING_FIRSTSLEEP_SECS * 1000)) { // To check if it is time to sleep + board.sleep(1800); // Sleep. Wake up after 30 minutes or when receiving a LoRa packet } - #endif +#endif } } From 3621038b7b4b9b8a387cfb063598253b549bfba8 Mon Sep 17 00:00:00 2001 From: Kevin Le Date: Fri, 13 Feb 2026 23:08:18 +0700 Subject: [PATCH 11/59] Added detailed response for powersaving CLI --- src/helpers/CommonCLI.cpp | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/src/helpers/CommonCLI.cpp b/src/helpers/CommonCLI.cpp index cae8bfd8..2547b4c8 100644 --- a/src/helpers/CommonCLI.cpp +++ b/src/helpers/CommonCLI.cpp @@ -428,18 +428,28 @@ void CommonCLI::handleCommand(uint32_t sender_timestamp, char* command, char* re } #endif } else if (memcmp(command, "powersaving on", 14) == 0) { +#if defined(NRF52_PLATFORM) _prefs->powersaving_enabled = 1; savePrefs(); - strcpy(reply, "ok"); // TODO: to return Not supported if required + strcpy(reply, "On - Immediate effect"); +#elif defined(ESP32) && !defined(WITH_BRIDGE) + _prefs->powersaving_enabled = 1; + savePrefs(); + strcpy(reply, "On - After 2 minutes"); +#elif defined(WITH_BRIDGE) + strcpy(reply, "Bridge not supported"); +#else + strcpy(reply, "Board not supported"); +#endif } else if (memcmp(command, "powersaving off", 15) == 0) { _prefs->powersaving_enabled = 0; savePrefs(); - strcpy(reply, "ok"); + strcpy(reply, "Off"); } else if (memcmp(command, "powersaving", 11) == 0) { if (_prefs->powersaving_enabled) { - strcpy(reply, "on"); + strcpy(reply, "On"); } else { - strcpy(reply, "off"); + strcpy(reply, "Off"); } } else if (memcmp(command, "log start", 9) == 0) { _callbacks->setLoggingOn(true); From 570ff775697d578c304e5cfcaf94c76d669a083c Mon Sep 17 00:00:00 2001 From: Kevin Le Date: Fri, 13 Feb 2026 23:09:28 +0700 Subject: [PATCH 12/59] Supported sleep for all ESP32-based repeaters --- src/helpers/ESP32Board.h | 60 ++++++++++++++++++++++++++++++---------- 1 file changed, 46 insertions(+), 14 deletions(-) diff --git a/src/helpers/ESP32Board.h b/src/helpers/ESP32Board.h index c2d78ae0..914a4589 100644 --- a/src/helpers/ESP32Board.h +++ b/src/helpers/ESP32Board.h @@ -12,7 +12,8 @@ #include #include #include -#include "driver/rtc_io.h" +#include "soc/rtc.h" +#include "esp_system.h" class ESP32Board : public mesh::MainBoard { protected: @@ -60,25 +61,56 @@ public: return raw / 4; } - void enterLightSleep(uint32_t secs) { -#if defined(CONFIG_IDF_TARGET_ESP32S3) && defined(P_LORA_DIO_1) // Supported ESP32 variants - if (rtc_gpio_is_valid_gpio((gpio_num_t)P_LORA_DIO_1)) { // Only enter sleep mode if P_LORA_DIO_1 is RTC pin - esp_sleep_pd_config(ESP_PD_DOMAIN_RTC_PERIPH, ESP_PD_OPTION_ON); - esp_sleep_enable_ext1_wakeup((1L << P_LORA_DIO_1), ESP_EXT1_WAKEUP_ANY_HIGH); // To wake up when receiving a LoRa packet + uint32_t getIRQGpio() { + return P_LORA_DIO_1; // default for SX1262 + } + + void sleep(uint32_t secs) override { + // Skip if not allow to sleep + if (inhibit_sleep) { + return; + } - if (secs > 0) { - esp_sleep_enable_timer_wakeup(secs * 1000000); // To wake up every hour to do periodically jobs - } + // Use more accurate clock in sleep +#if SOC_RTC_SLOW_CLK_SUPPORT_RC_FAST_D256 + if (rtc_clk_slow_src_get() != SOC_RTC_SLOW_CLK_SRC_RC_FAST) { - esp_light_sleep_start(); // CPU enters light sleep + // Switch slow clock source to RC_FAST / 256 (~31.25 kHz) + rtc_clk_slow_src_set(SOC_RTC_SLOW_CLK_SRC_RC_FAST); + + // Calibrate slow clock + esp_clk_slow_boot_cal(1024); } #endif - } - void sleep(uint32_t secs) override { - if (!inhibit_sleep) { - enterLightSleep(secs); // To wake up after "secs" seconds or when receiving a LoRa packet + // Configure GPIO wakeup + gpio_num_t wakeupPin = (gpio_num_t)getIRQGpio(); + esp_sleep_enable_gpio_wakeup(); + gpio_wakeup_enable((gpio_num_t)wakeupPin, GPIO_INTR_HIGH_LEVEL); // Wake up when receiving a LoRa packet + + // Configure timer wakeup + if (secs > 0) { + esp_sleep_enable_timer_wakeup(secs * 1000000ULL); // Wake up periodically to do scheduled jobs + } + + // Disable CPU interrupt servicing + noInterrupts(); + + // Skip sleep if there is a LoRa packet + if (digitalRead(wakeupPin) == HIGH) { + interrupts(); + return; } + + // MCU enters light sleep + esp_light_sleep_start(); + + // Avoid ISR flood during wakeup due to HIGH LEVEL interrupt + gpio_wakeup_disable(wakeupPin); + gpio_set_intr_type(wakeupPin, GPIO_INTR_POSEDGE); + + // Enable CPU interrupt servicing + interrupts(); } uint8_t getStartupReason() const override { return startup_reason; } From 8e09984ca33f38f24c7f92984168dbd759d8b60e Mon Sep 17 00:00:00 2001 From: Kevin Le Date: Fri, 13 Feb 2026 23:11:16 +0700 Subject: [PATCH 13/59] Added getIRQGpio to return DIO1 (SX1262) and DIO0 (SX127x) --- src/MeshCore.h | 1 + 1 file changed, 1 insertion(+) diff --git a/src/MeshCore.h b/src/MeshCore.h index b4c57faf..cd0c843a 100644 --- a/src/MeshCore.h +++ b/src/MeshCore.h @@ -56,6 +56,7 @@ public: // Boards may override to stop a boot-indicator LED sequence or similar. // Default no-op: boards that don't care need not implement anything. virtual void onBootComplete() { /* no op */ } + virtual uint32_t getIRQGpio() { return -1; } // not supported. Returns DIO1 (SX1262) and DIO0 (SX127x) virtual void sleep(uint32_t secs) { /* no op */ } virtual uint32_t getGpio() { return 0; } virtual void setGpio(uint32_t values) {} From cd964cd9c7514baf5b5a1fa697df1315a139b514 Mon Sep 17 00:00:00 2001 From: Kevin Le Date: Fri, 13 Feb 2026 23:13:46 +0700 Subject: [PATCH 14/59] Fixed DIO0, DIO1 and RESET for Heltec v2 --- variants/heltec_v2/HeltecV2Board.h | 16 ++++++++++------ variants/heltec_v2/platformio.ini | 6 +++--- variants/heltec_v2/target.cpp | 4 ++-- 3 files changed, 15 insertions(+), 11 deletions(-) diff --git a/variants/heltec_v2/HeltecV2Board.h b/variants/heltec_v2/HeltecV2Board.h index a6221036..fe800890 100644 --- a/variants/heltec_v2/HeltecV2Board.h +++ b/variants/heltec_v2/HeltecV2Board.h @@ -17,12 +17,12 @@ public: esp_reset_reason_t reason = esp_reset_reason(); if (reason == ESP_RST_DEEPSLEEP) { long wakeup_source = esp_sleep_get_ext1_wakeup_status(); - if (wakeup_source & (1 << P_LORA_DIO_1)) { // received a LoRa packet (while in deep sleep) + if (wakeup_source & (1 << P_LORA_DIO_0)) { // received a LoRa packet (while in deep sleep) startup_reason = BD_STARTUP_RX_PACKET; } rtc_gpio_hold_dis((gpio_num_t)P_LORA_NSS); - rtc_gpio_deinit((gpio_num_t)P_LORA_DIO_1); + rtc_gpio_deinit((gpio_num_t)P_LORA_DIO_0); } } @@ -30,15 +30,15 @@ public: esp_sleep_pd_config(ESP_PD_DOMAIN_RTC_PERIPH, ESP_PD_OPTION_ON); // Make sure the DIO1 and NSS GPIOs are hold on required levels during deep sleep - rtc_gpio_set_direction((gpio_num_t)P_LORA_DIO_1, RTC_GPIO_MODE_INPUT_ONLY); - rtc_gpio_pulldown_en((gpio_num_t)P_LORA_DIO_1); + rtc_gpio_set_direction((gpio_num_t)P_LORA_DIO_0, RTC_GPIO_MODE_INPUT_ONLY); + rtc_gpio_pulldown_en((gpio_num_t)P_LORA_DIO_0); rtc_gpio_hold_en((gpio_num_t)P_LORA_NSS); if (pin_wake_btn < 0) { - esp_sleep_enable_ext1_wakeup( (1L << P_LORA_DIO_1), ESP_EXT1_WAKEUP_ANY_HIGH); // wake up on: recv LoRa packet + esp_sleep_enable_ext1_wakeup( (1L << P_LORA_DIO_0), ESP_EXT1_WAKEUP_ANY_HIGH); // wake up on: recv LoRa packet } else { - esp_sleep_enable_ext1_wakeup( (1L << P_LORA_DIO_1) | (1L << pin_wake_btn), ESP_EXT1_WAKEUP_ANY_HIGH); // wake up on: recv LoRa packet OR wake btn + esp_sleep_enable_ext1_wakeup( (1L << P_LORA_DIO_0) | (1L << pin_wake_btn), ESP_EXT1_WAKEUP_ANY_HIGH); // wake up on: recv LoRa packet OR wake btn } if (secs > 0) { @@ -64,4 +64,8 @@ public: const char* getManufacturerName() const override { return "Heltec V2"; } + + uint32_t getIRQGpio() override { + return P_LORA_DIO_0; // default for SX1276 + } }; diff --git a/variants/heltec_v2/platformio.ini b/variants/heltec_v2/platformio.ini index e5beec23..ba4f8694 100644 --- a/variants/heltec_v2/platformio.ini +++ b/variants/heltec_v2/platformio.ini @@ -7,10 +7,10 @@ build_flags = -D HELTEC_LORA_V2 -D RADIO_CLASS=CustomSX1276 -D WRAPPER_CLASS=CustomSX1276Wrapper - -D P_LORA_DIO_1=26 + -D P_LORA_DIO_0=26 + -D P_LORA_DIO_1=35 -D P_LORA_NSS=18 - -D P_LORA_RESET=RADIOLIB_NC - -D P_LORA_BUSY=RADIOLIB_NC + -D P_LORA_RESET=14 -D P_LORA_SCLK=5 -D P_LORA_MISO=19 -D P_LORA_MOSI=27 diff --git a/variants/heltec_v2/target.cpp b/variants/heltec_v2/target.cpp index 2bc57b8c..585b0a37 100644 --- a/variants/heltec_v2/target.cpp +++ b/variants/heltec_v2/target.cpp @@ -5,9 +5,9 @@ HeltecV2Board board; #if defined(P_LORA_SCLK) static SPIClass spi; - RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_1, P_LORA_RESET, P_LORA_BUSY, spi); + RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_0, P_LORA_RESET, P_LORA_DIO_1, spi); #else - RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_1, P_LORA_RESET, P_LORA_BUSY); + RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_0, P_LORA_RESET, P_LORA_DIO_1); #endif WRAPPER_CLASS radio_driver(radio, board); From f576767d28b8869d856d06d3a6ab7c379c3a8a57 Mon Sep 17 00:00:00 2001 From: Kevin Le Date: Fri, 13 Feb 2026 23:15:36 +0700 Subject: [PATCH 15/59] Added getIRQGpio to return DIO0 for Lilygo T3S3 SX1276 --- variants/lilygo_t3s3_sx1276/LilygoT3S3SX1276Board.h | 10 ++++++++++ variants/lilygo_t3s3_sx1276/target.cpp | 2 +- variants/lilygo_t3s3_sx1276/target.h | 4 ++-- 3 files changed, 13 insertions(+), 3 deletions(-) create mode 100644 variants/lilygo_t3s3_sx1276/LilygoT3S3SX1276Board.h diff --git a/variants/lilygo_t3s3_sx1276/LilygoT3S3SX1276Board.h b/variants/lilygo_t3s3_sx1276/LilygoT3S3SX1276Board.h new file mode 100644 index 00000000..7da620fd --- /dev/null +++ b/variants/lilygo_t3s3_sx1276/LilygoT3S3SX1276Board.h @@ -0,0 +1,10 @@ +#pragma once + +#include + +class LilygoT3S3SX1276Board : public ESP32Board { +public: + uint32_t getIRQGpio() override { + return P_LORA_DIO_0; // default for SX1276 + } +}; \ No newline at end of file diff --git a/variants/lilygo_t3s3_sx1276/target.cpp b/variants/lilygo_t3s3_sx1276/target.cpp index 020ef54a..770db4a7 100644 --- a/variants/lilygo_t3s3_sx1276/target.cpp +++ b/variants/lilygo_t3s3_sx1276/target.cpp @@ -1,7 +1,7 @@ #include #include "target.h" -ESP32Board board; +LilygoT3S3SX1276Board board; #if defined(P_LORA_SCLK) static SPIClass spi; diff --git a/variants/lilygo_t3s3_sx1276/target.h b/variants/lilygo_t3s3_sx1276/target.h index 460b7ac1..c5fbff62 100644 --- a/variants/lilygo_t3s3_sx1276/target.h +++ b/variants/lilygo_t3s3_sx1276/target.h @@ -3,7 +3,7 @@ #define RADIOLIB_STATIC_ONLY 1 #include #include -#include +#include #include #include #include @@ -12,7 +12,7 @@ #include #endif -extern ESP32Board board; +extern LilygoT3S3SX1276Board board; extern WRAPPER_CLASS radio_driver; extern AutoDiscoverRTCClock rtc_clock; extern SensorManager sensors; From 71e044ff60f3af144ff38eacc8bf3c073968559d Mon Sep 17 00:00:00 2001 From: Kevin Le Date: Fri, 13 Feb 2026 23:23:39 +0700 Subject: [PATCH 16/59] Added getIRQGpio to return DIO0 for Lilygo TLoRa SX1276 --- variants/lilygo_tlora_v2_1/LilyGoTLoraBoard.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/variants/lilygo_tlora_v2_1/LilyGoTLoraBoard.h b/variants/lilygo_tlora_v2_1/LilyGoTLoraBoard.h index 545219b2..f126f006 100644 --- a/variants/lilygo_tlora_v2_1/LilyGoTLoraBoard.h +++ b/variants/lilygo_tlora_v2_1/LilyGoTLoraBoard.h @@ -21,4 +21,8 @@ public: return (2 * raw); } + + uint32_t getIRQGpio() override { + return P_LORA_DIO_0; // default for SX1276 + } }; \ No newline at end of file From daaeaafca16478fbe15e2bbcccd1bec3c9f48245 Mon Sep 17 00:00:00 2001 From: Kevin Le Date: Sat, 14 Feb 2026 20:49:07 +0700 Subject: [PATCH 17/59] Moved LoRa GPIOs to platformio.ini for TBeam boards --- src/helpers/esp32/TBeamBoard.h | 14 +++++++------- variants/lilygo_tbeam_SX1262/platformio.ini | 7 +++++++ .../lilygo_tbeam_SX1276/LilygoTBeamSX1276Board.h | 10 ++++++++++ variants/lilygo_tbeam_SX1276/platformio.ini | 7 +++++++ variants/lilygo_tbeam_SX1276/target.cpp | 2 +- variants/lilygo_tbeam_SX1276/target.h | 4 ++-- .../lilygo_tbeam_supreme_SX1262/platformio.ini | 7 +++++++ 7 files changed, 41 insertions(+), 10 deletions(-) create mode 100644 variants/lilygo_tbeam_SX1276/LilygoTBeamSX1276Board.h diff --git a/src/helpers/esp32/TBeamBoard.h b/src/helpers/esp32/TBeamBoard.h index 4ff95551..98bd16bf 100644 --- a/src/helpers/esp32/TBeamBoard.h +++ b/src/helpers/esp32/TBeamBoard.h @@ -59,13 +59,13 @@ // uint32_t P_LORA_BUSY = 0; //shared, so define at run // uint32_t P_LORA_DIO_2 = 0; //SX1276 only, so define at run - #define P_LORA_DIO_0 26 - #define P_LORA_DIO_1 33 - #define P_LORA_NSS 18 - #define P_LORA_RESET 23 - #define P_LORA_SCLK 5 - #define P_LORA_MISO 19 - #define P_LORA_MOSI 27 + // #define P_LORA_DIO_0 26 + // #define P_LORA_DIO_1 33 + // #define P_LORA_NSS 18 + // #define P_LORA_RESET 23 + // #define P_LORA_SCLK 5 + // #define P_LORA_MISO 19 + // #define P_LORA_MOSI 27 // #define PIN_GPS_RX 34 // #define PIN_GPS_TX 12 diff --git a/variants/lilygo_tbeam_SX1262/platformio.ini b/variants/lilygo_tbeam_SX1262/platformio.ini index 3099f3ab..62ac09f8 100644 --- a/variants/lilygo_tbeam_SX1262/platformio.ini +++ b/variants/lilygo_tbeam_SX1262/platformio.ini @@ -5,6 +5,13 @@ build_flags = ${esp32_base.build_flags} -I variants/lilygo_tbeam_SX1262 -D TBEAM_SX1262 + -D P_LORA_DIO_0=26 + -D P_LORA_DIO_1=33 + -D P_LORA_NSS=18 + -D P_LORA_RESET=23 + -D P_LORA_SCLK=5 + -D P_LORA_MISO=19 + -D P_LORA_MOSI=27 -D SX126X_DIO2_AS_RF_SWITCH=true -D SX126X_DIO3_TCXO_VOLTAGE=1.8 -D SX126X_CURRENT_LIMIT=140 diff --git a/variants/lilygo_tbeam_SX1276/LilygoTBeamSX1276Board.h b/variants/lilygo_tbeam_SX1276/LilygoTBeamSX1276Board.h new file mode 100644 index 00000000..afe106d0 --- /dev/null +++ b/variants/lilygo_tbeam_SX1276/LilygoTBeamSX1276Board.h @@ -0,0 +1,10 @@ +#pragma once + +#include + +class LilygoTBeamSX1276Board : public TBeamBoard { +public: + uint32_t getIRQGpio() override { + return P_LORA_DIO_0; // default for SX1276 + } +}; \ No newline at end of file diff --git a/variants/lilygo_tbeam_SX1276/platformio.ini b/variants/lilygo_tbeam_SX1276/platformio.ini index f1576232..cb25903c 100644 --- a/variants/lilygo_tbeam_SX1276/platformio.ini +++ b/variants/lilygo_tbeam_SX1276/platformio.ini @@ -5,6 +5,13 @@ build_flags = ${esp32_base.build_flags} -I variants/lilygo_tbeam_SX1276 -D TBEAM_SX1276 + -D P_LORA_DIO_0=26 + -D P_LORA_DIO_1=33 + -D P_LORA_NSS=18 + -D P_LORA_RESET=23 + -D P_LORA_SCLK=5 + -D P_LORA_MISO=19 + -D P_LORA_MOSI=27 -D SX127X_CURRENT_LIMIT=120 -D RADIO_CLASS=CustomSX1276 -D WRAPPER_CLASS=CustomSX1276Wrapper diff --git a/variants/lilygo_tbeam_SX1276/target.cpp b/variants/lilygo_tbeam_SX1276/target.cpp index 94cc3d6d..30f23dab 100644 --- a/variants/lilygo_tbeam_SX1276/target.cpp +++ b/variants/lilygo_tbeam_SX1276/target.cpp @@ -1,7 +1,7 @@ #include #include "target.h" -TBeamBoard board; +LilygoTBeamSX1276Board board; #if defined(P_LORA_SCLK) static SPIClass spi; diff --git a/variants/lilygo_tbeam_SX1276/target.h b/variants/lilygo_tbeam_SX1276/target.h index 1c709905..0d56f88f 100644 --- a/variants/lilygo_tbeam_SX1276/target.h +++ b/variants/lilygo_tbeam_SX1276/target.h @@ -3,7 +3,7 @@ #define RADIOLIB_STATIC_ONLY 1 //#include #include -#include +#include #include #include #include @@ -12,7 +12,7 @@ #include #endif -extern TBeamBoard board; +extern LilygoTBeamSX1276Board board; extern WRAPPER_CLASS radio_driver; extern AutoDiscoverRTCClock rtc_clock; extern EnvironmentSensorManager sensors; diff --git a/variants/lilygo_tbeam_supreme_SX1262/platformio.ini b/variants/lilygo_tbeam_supreme_SX1262/platformio.ini index 845dd415..02946156 100644 --- a/variants/lilygo_tbeam_supreme_SX1262/platformio.ini +++ b/variants/lilygo_tbeam_supreme_SX1262/platformio.ini @@ -5,6 +5,13 @@ build_flags = ${esp32_base.build_flags} -I variants/lilygo_tbeam_supreme_SX1262 -D TBEAM_SUPREME_SX1262 + -D P_LORA_DIO_0=26 + -D P_LORA_DIO_1=33 + -D P_LORA_NSS=18 + -D P_LORA_RESET=23 + -D P_LORA_SCLK=5 + -D P_LORA_MISO=19 + -D P_LORA_MOSI=27 -D SX126X_CURRENT_LIMIT=140 -D SX126X_RX_BOOSTED_GAIN=1 -D USE_SX1262 From 21455e62967a94ca77a4ec6abb2e8df2cb54041f Mon Sep 17 00:00:00 2001 From: Kevin Le Date: Sat, 14 Feb 2026 22:23:06 +0700 Subject: [PATCH 18/59] Gave MCU to OTA to run in inhibit_sleep --- src/helpers/ESP32Board.h | 1 + 1 file changed, 1 insertion(+) diff --git a/src/helpers/ESP32Board.h b/src/helpers/ESP32Board.h index 914a4589..43b3ad25 100644 --- a/src/helpers/ESP32Board.h +++ b/src/helpers/ESP32Board.h @@ -68,6 +68,7 @@ public: void sleep(uint32_t secs) override { // Skip if not allow to sleep if (inhibit_sleep) { + delay(1); // Give MCU to OTA to run return; } From f4c43f7eb7c524ceaecf195ee78d29707b07104d Mon Sep 17 00:00:00 2001 From: Kevin Le Date: Wed, 8 Apr 2026 21:43:35 +0700 Subject: [PATCH 19/59] Fixed Interrupt WDT Reset --- src/helpers/ESP32Board.h | 34 +++++++++++++++++++--------------- 1 file changed, 19 insertions(+), 15 deletions(-) diff --git a/src/helpers/ESP32Board.h b/src/helpers/ESP32Board.h index 43b3ad25..36e34976 100644 --- a/src/helpers/ESP32Board.h +++ b/src/helpers/ESP32Board.h @@ -19,11 +19,12 @@ class ESP32Board : public mesh::MainBoard { protected: uint8_t startup_reason; bool inhibit_sleep = false; + static inline portMUX_TYPE sleepMux = portMUX_INITIALIZER_UNLOCKED; public: void begin() { // for future use, sub-classes SHOULD call this from their begin() - startup_reason = BD_STARTUP_NORMAL; + startup_reason = BD_STARTUP_NORMAL; #ifdef ESP32_CPU_FREQ setCpuFrequencyMhz(ESP32_CPU_FREQ); @@ -46,7 +47,7 @@ public: #endif #else Wire.begin(); - #endif + #endif } // Temperature from ESP32 MCU @@ -84,10 +85,8 @@ public: } #endif - // Configure GPIO wakeup - gpio_num_t wakeupPin = (gpio_num_t)getIRQGpio(); - esp_sleep_enable_gpio_wakeup(); - gpio_wakeup_enable((gpio_num_t)wakeupPin, GPIO_INTR_HIGH_LEVEL); // Wake up when receiving a LoRa packet + // Set GPIO wakeup + gpio_num_t wakeupPin = (gpio_num_t)getIRQGpio(); // Configure timer wakeup if (secs > 0) { @@ -95,14 +94,19 @@ public: } // Disable CPU interrupt servicing - noInterrupts(); + portENTER_CRITICAL(&sleepMux); // Skip sleep if there is a LoRa packet - if (digitalRead(wakeupPin) == HIGH) { - interrupts(); + if (gpio_get_level(wakeupPin) == HIGH) { + portEXIT_CRITICAL(&sleepMux); + delay(1); return; } + // Configure GPIO wakeup + esp_sleep_enable_gpio_wakeup(); + gpio_wakeup_enable((gpio_num_t)wakeupPin, GPIO_INTR_HIGH_LEVEL); // Wake up when receiving a LoRa packet + // MCU enters light sleep esp_light_sleep_start(); @@ -111,7 +115,7 @@ public: gpio_set_intr_type(wakeupPin, GPIO_INTR_POSEDGE); // Enable CPU interrupt servicing - interrupts(); + portEXIT_CRITICAL(&sleepMux); } uint8_t getStartupReason() const override { return startup_reason; } @@ -135,7 +139,7 @@ public: #endif uint16_t getBattMilliVolts() override { - #ifdef PIN_VBAT_READ + #ifdef PIN_VBAT_READ analogReadResolution(12); uint32_t raw = 0; @@ -174,16 +178,16 @@ public: // start with some date/time in the recent past struct timeval tv; tv.tv_sec = 1715770351; // 15 May 2024, 8:50pm - tv.tv_usec = 0; - settimeofday(&tv, NULL); - } + tv.tv_usec = 0; + settimeofday(&tv, NULL); + } } uint32_t getCurrentTime() override { time_t _now; time(&_now); return _now; } - void setCurrentTime(uint32_t time) override { + void setCurrentTime(uint32_t time) override { struct timeval tv; tv.tv_sec = time; tv.tv_usec = 0; From 36a44de11991d12254fe486ec1f61f8810457f92 Mon Sep 17 00:00:00 2001 From: Kevin Le Date: Wed, 6 May 2026 13:16:54 +0700 Subject: [PATCH 20/59] Reduced time drift from 60s/day to 7s/day for ESP32-based repeaters with power saving. --- examples/simple_repeater/main.cpp | 4 ++-- src/helpers/ESP32Board.h | 12 ------------ 2 files changed, 2 insertions(+), 14 deletions(-) diff --git a/examples/simple_repeater/main.cpp b/examples/simple_repeater/main.cpp index 7946809e..2ce056f5 100644 --- a/examples/simple_repeater/main.cpp +++ b/examples/simple_repeater/main.cpp @@ -154,10 +154,10 @@ void loop() { if (the_mesh.getNodePrefs()->powersaving_enabled && !the_mesh.hasPendingWork()) { #if defined(NRF52_PLATFORM) - board.sleep(1800); // nrf ignores seconds param, sleeps whenever possible + board.sleep(0); // nrf ignores seconds param, sleeps whenever possible #else if (the_mesh.millisHasNowPassed(POWERSAVING_FIRSTSLEEP_SECS * 1000)) { // To check if it is time to sleep - board.sleep(1800); // Sleep. Wake up after 30 minutes or when receiving a LoRa packet + board.sleep(30); // Sleep. Wake up after a while or when receiving a LoRa packet } #endif } diff --git a/src/helpers/ESP32Board.h b/src/helpers/ESP32Board.h index 36e34976..73c58e2f 100644 --- a/src/helpers/ESP32Board.h +++ b/src/helpers/ESP32Board.h @@ -73,18 +73,6 @@ public: return; } - // Use more accurate clock in sleep -#if SOC_RTC_SLOW_CLK_SUPPORT_RC_FAST_D256 - if (rtc_clk_slow_src_get() != SOC_RTC_SLOW_CLK_SRC_RC_FAST) { - - // Switch slow clock source to RC_FAST / 256 (~31.25 kHz) - rtc_clk_slow_src_set(SOC_RTC_SLOW_CLK_SRC_RC_FAST); - - // Calibrate slow clock - esp_clk_slow_boot_cal(1024); - } -#endif - // Set GPIO wakeup gpio_num_t wakeupPin = (gpio_num_t)getIRQGpio(); From bbd37f53a858e3daefeafde13b54941bdde12c07 Mon Sep 17 00:00:00 2001 From: Sefinek Date: Thu, 28 May 2026 16:01:59 +0200 Subject: [PATCH 21/59] ci: update GitHub Actions and Python version, fix ruby-version typo --- .github/actions/setup-build-environment/action.yml | 6 +++--- .github/workflows/build-companion-firmwares.yml | 6 +++--- .github/workflows/build-repeater-firmwares.yml | 6 +++--- .github/workflows/build-room-server-firmwares.yml | 6 +++--- .github/workflows/github-pages.yml | 8 ++++---- .github/workflows/pr-build-check.yml | 2 +- 6 files changed, 17 insertions(+), 17 deletions(-) diff --git a/.github/actions/setup-build-environment/action.yml b/.github/actions/setup-build-environment/action.yml index 2ba7617e..02aaf424 100644 --- a/.github/actions/setup-build-environment/action.yml +++ b/.github/actions/setup-build-environment/action.yml @@ -4,7 +4,7 @@ runs: steps: - name: Init Cache - uses: actions/cache@v4 + uses: actions/cache@v5 with: path: | ~/.cache/pip @@ -12,9 +12,9 @@ runs: key: ${{ runner.os }}-pio - name: Install Python - uses: actions/setup-python@v5 + uses: actions/setup-python@v6 with: - python-version: '3.11' + python-version: '3.13' - name: Install PlatformIO shell: bash diff --git a/.github/workflows/build-companion-firmwares.yml b/.github/workflows/build-companion-firmwares.yml index 721076a1..771fa6d5 100644 --- a/.github/workflows/build-companion-firmwares.yml +++ b/.github/workflows/build-companion-firmwares.yml @@ -16,7 +16,7 @@ jobs: steps: - name: Clone Repo - uses: actions/checkout@v4 + uses: actions/checkout@v6 - name: Setup Build Environment uses: ./.github/actions/setup-build-environment @@ -27,13 +27,13 @@ jobs: run: /usr/bin/env bash build.sh build-companion-firmwares - name: Upload Workflow Artifacts - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v7 with: name: companion-firmwares path: out - name: Create Release - uses: softprops/action-gh-release@v2 + uses: softprops/action-gh-release@v3 if: startsWith(github.ref, 'refs/tags/') with: name: Companion Firmware ${{ env.GIT_TAG_VERSION }} diff --git a/.github/workflows/build-repeater-firmwares.yml b/.github/workflows/build-repeater-firmwares.yml index f12bd829..3185d4b2 100644 --- a/.github/workflows/build-repeater-firmwares.yml +++ b/.github/workflows/build-repeater-firmwares.yml @@ -16,7 +16,7 @@ jobs: steps: - name: Clone Repo - uses: actions/checkout@v4 + uses: actions/checkout@v6 - name: Setup Build Environment uses: ./.github/actions/setup-build-environment @@ -27,13 +27,13 @@ jobs: run: /usr/bin/env bash build.sh build-repeater-firmwares - name: Upload Workflow Artifacts - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v7 with: name: repeater-firmwares path: out - name: Create Release - uses: softprops/action-gh-release@v2 + uses: softprops/action-gh-release@v3 if: startsWith(github.ref, 'refs/tags/') with: name: Repeater Firmware ${{ env.GIT_TAG_VERSION }} diff --git a/.github/workflows/build-room-server-firmwares.yml b/.github/workflows/build-room-server-firmwares.yml index a488af6a..127095a8 100644 --- a/.github/workflows/build-room-server-firmwares.yml +++ b/.github/workflows/build-room-server-firmwares.yml @@ -16,7 +16,7 @@ jobs: steps: - name: Clone Repo - uses: actions/checkout@v4 + uses: actions/checkout@v6 - name: Setup Build Environment uses: ./.github/actions/setup-build-environment @@ -27,13 +27,13 @@ jobs: run: /usr/bin/env bash build.sh build-room-server-firmwares - name: Upload Workflow Artifacts - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v7 with: name: room-server-firmwares path: out - name: Create Release - uses: softprops/action-gh-release@v2 + uses: softprops/action-gh-release@v3 if: startsWith(github.ref, 'refs/tags/') with: name: Room Server Firmware ${{ env.GIT_TAG_VERSION }} diff --git a/.github/workflows/github-pages.yml b/.github/workflows/github-pages.yml index 5fd2734b..9aa5fc0b 100644 --- a/.github/workflows/github-pages.yml +++ b/.github/workflows/github-pages.yml @@ -15,12 +15,12 @@ jobs: steps: - name: Checkout Repo - uses: actions/checkout@v4 + uses: actions/checkout@v6 - name: Setup Python - uses: actions/setup-python@v5 + uses: actions/setup-python@v6 with: - ruby-version: 3.x + python-version: '3.13' - name: Build run: | @@ -28,7 +28,7 @@ jobs: mkdocs build - name: Deploy to GitHub Pages - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} cname: docs.meshcore.io diff --git a/.github/workflows/pr-build-check.yml b/.github/workflows/pr-build-check.yml index 37f3701b..3f85faab 100644 --- a/.github/workflows/pr-build-check.yml +++ b/.github/workflows/pr-build-check.yml @@ -42,7 +42,7 @@ jobs: steps: - name: Clone Repo - uses: actions/checkout@v4 + uses: actions/checkout@v6 - name: Setup Build Environment uses: ./.github/actions/setup-build-environment From c67548347cafbc734049b65e5050084192f609f1 Mon Sep 17 00:00:00 2001 From: Sefinek Date: Thu, 28 May 2026 16:10:46 +0200 Subject: [PATCH 22/59] ci: pin peaceiris/actions-gh-pages to v4.1.0 for Node.js 24 support --- .github/workflows/github-pages.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/github-pages.yml b/.github/workflows/github-pages.yml index 9aa5fc0b..b01ddc93 100644 --- a/.github/workflows/github-pages.yml +++ b/.github/workflows/github-pages.yml @@ -28,7 +28,7 @@ jobs: mkdocs build - name: Deploy to GitHub Pages - uses: peaceiris/actions-gh-pages@v4 + uses: peaceiris/actions-gh-pages@v4.1.0 with: github_token: ${{ secrets.GITHUB_TOKEN }} cname: docs.meshcore.io From d9df8307ca3291cdc51e88a799ec90b7bb8b8d15 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Mon, 1 Jun 2026 16:49:31 +1000 Subject: [PATCH 23/59] * first draft --- examples/companion_radio/DataStore.cpp | 6 +++++- examples/companion_radio/DataStore.h | 2 +- examples/companion_radio/MyMesh.cpp | 19 ++++++++++++++++++- examples/companion_radio/MyMesh.h | 4 ++-- src/helpers/BaseChatMesh.cpp | 21 +++++++++++---------- src/helpers/BaseChatMesh.h | 6 ++++-- 6 files changed, 41 insertions(+), 17 deletions(-) diff --git a/examples/companion_radio/DataStore.cpp b/examples/companion_radio/DataStore.cpp index c7988bb3..bf2f36c3 100644 --- a/examples/companion_radio/DataStore.cpp +++ b/examples/companion_radio/DataStore.cpp @@ -309,7 +309,7 @@ File file = openRead(_getContactsChannelsFS(), "/contacts3"); } } -void DataStore::saveContacts(DataStoreHost* host) { +void DataStore::saveContacts(DataStoreHost* host, bool (*filter)(const ContactInfo& c)) { File file = openWrite(_getContactsChannelsFS(), "/contacts3"); if (file) { uint32_t idx = 0; @@ -317,6 +317,10 @@ void DataStore::saveContacts(DataStoreHost* host) { uint8_t unused = 0; while (host->getContactForSave(idx, c)) { + if (filter && !filter(c)) { + idx++; // advance to next contact + continue; + } bool success = (file.write(c.id.pub_key, 32) == 32); success = success && (file.write((uint8_t *)&c.name, 32) == 32); success = success && (file.write(&c.type, 1) == 1); diff --git a/examples/companion_radio/DataStore.h b/examples/companion_radio/DataStore.h index 58b4d5d2..af5ee7af 100644 --- a/examples/companion_radio/DataStore.h +++ b/examples/companion_radio/DataStore.h @@ -36,7 +36,7 @@ public: void loadPrefs(NodePrefs& prefs, double& node_lat, double& node_lon); void savePrefs(const NodePrefs& prefs, double node_lat, double node_lon); void loadContacts(DataStoreHost* host); - void saveContacts(DataStoreHost* host); + void saveContacts(DataStoreHost* host, bool (*filter)(const ContactInfo& c) = NULL); void loadChannels(DataStoreHost* host); void saveChannels(DataStoreHost* host); void migrateToSecondaryFS(); diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp index f1804219..d75d6776 100644 --- a/examples/companion_radio/MyMesh.cpp +++ b/examples/companion_radio/MyMesh.cpp @@ -1536,6 +1536,15 @@ void MyMesh::handleCmdFrame(size_t len) { } else if (cmd_frame[0] == CMD_SEND_ANON_REQ && len > 1 + PUB_KEY_SIZE) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); + ContactInfo anon; + if (recipient == NULL) { // FIRMWARE_VER_CODE 13+, allow non-contact requests + memset(&anon, 0, sizeof(anon)); + memcpy(anon.id.pub_key, pub_key, PUB_KEY_SIZE); + anon.out_path_len = OUT_PATH_UNKNOWN; + anon.type = ADV_TYPE_NONE; // unknown + + if (addContact(anon)) recipient = &anon; + } uint8_t *data = &cmd_frame[1 + PUB_KEY_SIZE]; if (recipient) { uint32_t tag, est_timeout; @@ -1552,7 +1561,7 @@ void MyMesh::handleCmdFrame(size_t len) { _serial->writeFrame(out_frame, 10); } } else { - writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found + writeErrFrame(ERR_CODE_TABLE_FULL); // contacts full } } else if (cmd_frame[0] == CMD_SEND_STATUS_REQ && len >= 1 + PUB_KEY_SIZE) { uint8_t *pub_key = &cmd_frame[1]; @@ -1983,6 +1992,14 @@ void MyMesh::handleCmdFrame(size_t len) { } } +static bool save_filter(const ContactInfo& c) { + return c.type != ADV_TYPE_NONE; // don't save the transient/anon entries +} + +void MyMesh::saveContacts() { + _store->saveContacts(this, save_filter); +} + void MyMesh::enterCLIRescue() { _cli_rescue = true; cli_command[0] = 0; diff --git a/examples/companion_radio/MyMesh.h b/examples/companion_radio/MyMesh.h index f189a2c5..bbb0d4cb 100644 --- a/examples/companion_radio/MyMesh.h +++ b/examples/companion_radio/MyMesh.h @@ -5,7 +5,7 @@ #include "AbstractUITask.h" /*------------ Frame Protocol --------------*/ -#define FIRMWARE_VER_CODE 12 +#define FIRMWARE_VER_CODE 13 #ifndef FIRMWARE_BUILD_DATE #define FIRMWARE_BUILD_DATE "19 Apr 2026" @@ -201,7 +201,7 @@ private: // helpers, short-cuts void saveChannels() { _store->saveChannels(this); } - void saveContacts() { _store->saveContacts(this); } + void saveContacts(); DataStore* _store; NodePrefs _prefs; diff --git a/src/helpers/BaseChatMesh.cpp b/src/helpers/BaseChatMesh.cpp index e2b116b4..5a720c83 100644 --- a/src/helpers/BaseChatMesh.cpp +++ b/src/helpers/BaseChatMesh.cpp @@ -76,7 +76,7 @@ ContactInfo* BaseChatMesh::allocateContactSlot() { uint32_t oldest_lastmod = 0xFFFFFFFF; for (int i = 0; i < num_contacts; i++) { bool is_favourite = (contacts[i].flags & 0x01) != 0; - if (!is_favourite && contacts[i].lastmod < oldest_lastmod) { + if (!is_favourite && contacts[i].lastmod < oldest_lastmod && contacts[i].type != ADV_TYPE_NONE) { oldest_lastmod = contacts[i].lastmod; oldest_idx = i; } @@ -164,16 +164,17 @@ void BaseChatMesh::onAdvertRecv(mesh::Packet* packet, const mesh::Identity& id, from->sync_since = 0; from->shared_secret_valid = false; } + // update - putBlobByKey(id.pub_key, PUB_KEY_SIZE, temp_buf, plen); - StrHelper::strncpy(from->name, parser.getName(), sizeof(from->name)); - from->type = parser.getType(); - if (parser.hasLatLon()) { - from->gps_lat = parser.getIntLat(); - from->gps_lon = parser.getIntLon(); - } - from->last_advert_timestamp = timestamp; - from->lastmod = getRTCClock()->getCurrentTime(); + putBlobByKey(id.pub_key, PUB_KEY_SIZE, temp_buf, plen); + StrHelper::strncpy(from->name, parser.getName(), sizeof(from->name)); + from->type = parser.getType(); + if (parser.hasLatLon()) { + from->gps_lat = parser.getIntLat(); + from->gps_lon = parser.getIntLon(); + } + from->last_advert_timestamp = timestamp; + from->lastmod = getRTCClock()->getCurrentTime(); onDiscoveredContact(*from, is_new, packet->path_len, packet->path); // let UI know } diff --git a/src/helpers/BaseChatMesh.h b/src/helpers/BaseChatMesh.h index 88af3c7a..bd92d9d8 100644 --- a/src/helpers/BaseChatMesh.h +++ b/src/helpers/BaseChatMesh.h @@ -37,6 +37,8 @@ public: #define MAX_CONTACTS 32 #endif +#define MAX_ANON_CONTACTS 8 + #ifndef MAX_CONNECTIONS #define MAX_CONNECTIONS 16 #endif @@ -58,9 +60,9 @@ class BaseChatMesh : public mesh::Mesh { friend class ContactsIterator; - ContactInfo contacts[MAX_CONTACTS]; + ContactInfo contacts[MAX_CONTACTS+MAX_ANON_CONTACTS]; int num_contacts; - int sort_array[MAX_CONTACTS]; + int sort_array[MAX_CONTACTS+MAX_ANON_CONTACTS]; int matching_peer_indexes[MAX_SEARCH_RESULTS]; unsigned long txt_send_timeout; #ifdef MAX_GROUP_CHANNELS From bc5d648204c06aadd6370a474050a949f431dca8 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Mon, 1 Jun 2026 19:04:42 +1000 Subject: [PATCH 24/59] * contacts sync fix * fix for reusing transient/anon contacts only --- examples/companion_radio/MyMesh.cpp | 10 +++++++++- src/helpers/BaseChatMesh.cpp | 21 ++++++++++++++------- src/helpers/BaseChatMesh.h | 2 +- 3 files changed, 24 insertions(+), 9 deletions(-) diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp index d75d6776..bff571e0 100644 --- a/examples/companion_radio/MyMesh.cpp +++ b/examples/companion_radio/MyMesh.cpp @@ -2186,7 +2186,15 @@ void MyMesh::checkSerialInterface() { && !_serial->isWriteBusy() // don't spam the Serial Interface too quickly! ) { ContactInfo contact; - if (_iter.hasNext(this, contact)) { + bool found = false; + while (_iter.hasNext(this, contact)) { + if (contact.type != ADV_TYPE_NONE) { + found = true; + break; + } + } + + if (found) { if (contact.lastmod > _iter_filter_since) { // apply the 'since' filter writeContactRespFrame(RESP_CODE_CONTACT, contact); if (contact.lastmod > _most_recent_lastmod) { diff --git a/src/helpers/BaseChatMesh.cpp b/src/helpers/BaseChatMesh.cpp index 5a720c83..d3ef034e 100644 --- a/src/helpers/BaseChatMesh.cpp +++ b/src/helpers/BaseChatMesh.cpp @@ -67,18 +67,25 @@ void BaseChatMesh::bootstrapRTCfromContacts() { } } -ContactInfo* BaseChatMesh::allocateContactSlot() { +ContactInfo* BaseChatMesh::allocateContactSlot(bool transient_only) { if (num_contacts < MAX_CONTACTS) { return &contacts[num_contacts++]; - } else if (shouldOverwriteWhenFull()) { + } else if (transient_only || shouldOverwriteWhenFull()) { // Find oldest non-favourite contact by oldest lastmod timestamp int oldest_idx = -1; uint32_t oldest_lastmod = 0xFFFFFFFF; for (int i = 0; i < num_contacts; i++) { - bool is_favourite = (contacts[i].flags & 0x01) != 0; - if (!is_favourite && contacts[i].lastmod < oldest_lastmod && contacts[i].type != ADV_TYPE_NONE) { - oldest_lastmod = contacts[i].lastmod; - oldest_idx = i; + if (transient_only) { + if (contacts[i].type == ADV_TYPE_NONE && contacts[i].lastmod < oldest_lastmod) { + oldest_lastmod = contacts[i].lastmod; + oldest_idx = i; + } + } else { + bool is_favourite = (contacts[i].flags & 0x01) != 0; + if (!is_favourite && contacts[i].lastmod < oldest_lastmod && contacts[i].type != ADV_TYPE_NONE) { + oldest_lastmod = contacts[i].lastmod; + oldest_idx = i; + } } } if (oldest_idx >= 0) { @@ -830,7 +837,7 @@ ContactInfo* BaseChatMesh::lookupContactByPubKey(const uint8_t* pub_key, int pre } bool BaseChatMesh::addContact(const ContactInfo& contact) { - ContactInfo* dest = allocateContactSlot(); + ContactInfo* dest = allocateContactSlot(contact.type == ADV_TYPE_NONE); if (dest) { *dest = contact; dest->shared_secret_valid = false; // mark shared_secret as needing calculation diff --git a/src/helpers/BaseChatMesh.h b/src/helpers/BaseChatMesh.h index bd92d9d8..c04bfda3 100644 --- a/src/helpers/BaseChatMesh.h +++ b/src/helpers/BaseChatMesh.h @@ -93,7 +93,7 @@ protected: void bootstrapRTCfromContacts(); void resetContacts() { num_contacts = 0; } void populateContactFromAdvert(ContactInfo& ci, const mesh::Identity& id, const AdvertDataParser& parser, uint32_t timestamp); - ContactInfo* allocateContactSlot(); // helper to find slot for new contact + ContactInfo* allocateContactSlot(bool transient_only=false); // helper to find slot for new contact // 'UI' concepts, for sub-classes to implement virtual bool isAutoAddEnabled() const { return true; } From f701b58b4bc5cac5cea5053093e8f757b5a9dfc7 Mon Sep 17 00:00:00 2001 From: taco Date: Tue, 2 Jun 2026 00:53:00 +1000 Subject: [PATCH 25/59] NRF52Board: ungate isExternalPowered() --- src/helpers/NRF52Board.cpp | 28 ++++++++++++++-------------- src/helpers/NRF52Board.h | 2 +- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/src/helpers/NRF52Board.cpp b/src/helpers/NRF52Board.cpp index 2c8753d4..17265f04 100644 --- a/src/helpers/NRF52Board.cpp +++ b/src/helpers/NRF52Board.cpp @@ -66,20 +66,6 @@ void NRF52Board::initPowerMgr() { } } -bool NRF52Board::isExternalPowered() { - // Check if SoftDevice is enabled before using its API - uint8_t sd_enabled = 0; - sd_softdevice_is_enabled(&sd_enabled); - - if (sd_enabled) { - uint32_t usb_status; - sd_power_usbregstatus_get(&usb_status); - return (usb_status & POWER_USBREGSTATUS_VBUSDETECT_Msk) != 0; - } else { - return (NRF_POWER->USBREGSTATUS & POWER_USBREGSTATUS_VBUSDETECT_Msk) != 0; - } -} - const char* NRF52Board::getResetReasonString(uint32_t reason) { if (reason & POWER_RESETREAS_RESETPIN_Msk) return "Reset Pin"; if (reason & POWER_RESETREAS_DOG_Msk) return "Watchdog"; @@ -251,6 +237,20 @@ void NRF52BoardDCDC::begin() { } } +bool NRF52Board::isExternalPowered() { + // Check if SoftDevice is enabled before using its API + uint8_t sd_enabled = 0; + sd_softdevice_is_enabled(&sd_enabled); + + if (sd_enabled) { + uint32_t usb_status; + sd_power_usbregstatus_get(&usb_status); + return (usb_status & POWER_USBREGSTATUS_VBUSDETECT_Msk) != 0; + } else { + return (NRF_POWER->USBREGSTATUS & POWER_USBREGSTATUS_VBUSDETECT_Msk) != 0; + } +} + void NRF52Board::sleep(uint32_t secs) { // Clear FPU interrupt flags to avoid insomnia // see errata 87 for details https://docs.nordicsemi.com/bundle/errata_nRF52840_Rev3/page/ERR/nRF52840/Rev3/latest/anomaly_840_87.html diff --git a/src/helpers/NRF52Board.h b/src/helpers/NRF52Board.h index c9f1e071..17065cf4 100644 --- a/src/helpers/NRF52Board.h +++ b/src/helpers/NRF52Board.h @@ -53,9 +53,9 @@ public: virtual bool getBootloaderVersion(char* version, size_t max_len) override; virtual bool startOTAUpdate(const char *id, char reply[]) override; virtual void sleep(uint32_t secs) override; + bool isExternalPowered() override; #ifdef NRF52_POWER_MANAGEMENT - bool isExternalPowered() override; uint16_t getBootVoltage() override { return boot_voltage_mv; } virtual uint32_t getResetReason() const override { return reset_reason; } uint8_t getShutdownReason() const override { return shutdown_reason; } From 3ce1cf404ed66bbdfdd8687605b46cd429f7c0bd Mon Sep 17 00:00:00 2001 From: taco Date: Tue, 2 Jun 2026 00:55:25 +1000 Subject: [PATCH 26/59] NRF52: disable autoshutdown if powered, add auto-shutdown warning for oled --- examples/companion_radio/ui-new/UITask.cpp | 28 ++++++++++----------- examples/companion_radio/ui-tiny/UITask.cpp | 17 ++++++++++--- 2 files changed, 26 insertions(+), 19 deletions(-) diff --git a/examples/companion_radio/ui-new/UITask.cpp b/examples/companion_radio/ui-new/UITask.cpp index ee12ca74..0cebc100 100644 --- a/examples/companion_radio/ui-new/UITask.cpp +++ b/examples/companion_radio/ui-new/UITask.cpp @@ -832,22 +832,20 @@ void UITask::loop() { if (millis() > next_batt_chck) { uint16_t milliVolts = getBattMilliVolts(); if (milliVolts > 0 && milliVolts < AUTO_SHUTDOWN_MILLIVOLTS) { - - // show low battery shutdown alert - // we should only do this for eink displays, which will persist after power loss - #if defined(THINKNODE_M1) || defined(LILYGO_TECHO) - if (_display != NULL) { - _display->startFrame(); - _display->setTextSize(2); - _display->setColor(DisplayDriver::RED); - _display->drawTextCentered(_display->width() / 2, 20, "Low Battery."); - _display->drawTextCentered(_display->width() / 2, 40, "Shutting Down!"); - _display->endFrame(); + if(!board.isExternalPowered()) { + if (_display != NULL) { + _display->startFrame(); + _display->setTextSize(2); + _display->setColor(DisplayDriver::RED); + _display->drawTextCentered(_display->width() / 2, 20, "Low Battery."); + _display->drawTextCentered(_display->width() / 2, 40, "Shutting Down!"); + _display->endFrame(); + #if !defined(THINKNODE_M1) && !defined(LILYGO_TECHO) // TODO: refactor eink variants to use EINK_DISPLAY macros to gate this properly + delay(3000); + #endif + } + shutdown(); } - #endif - - shutdown(); - } next_batt_chck = millis() + 8000; } diff --git a/examples/companion_radio/ui-tiny/UITask.cpp b/examples/companion_radio/ui-tiny/UITask.cpp index 45a07a02..125c4f7b 100644 --- a/examples/companion_radio/ui-tiny/UITask.cpp +++ b/examples/companion_radio/ui-tiny/UITask.cpp @@ -727,14 +727,23 @@ void UITask::loop() { if (millis() > next_batt_chck) { _cached_batt_mv = getBattMilliVolts(); if (_cached_batt_mv > 0 && _cached_batt_mv < AUTO_SHUTDOWN_MILLIVOLTS) { - - shutdown(); - + if(!board.isExternalPowered()) { + if (_display != NULL) { + _display->startFrame(); + _display->setTextSize(2); + _display->drawTextCentered(_display->width() / 2, 6, "Low battery!"); + _display->setTextSize(1); + _display->drawTextCentered(_display->width() / 2, 18, "Shutting down!"); + _display->endFrame(); + delay(3000); // TODO: refactor eink variants to use EINK_DISPLAY macros to gate this properly + } + shutdown(); + } } next_batt_chck = millis() + 8000; } #else - if (_display != NULL && _display->isOn() && millis >= next_batt_chck) { + if (_display != NULL && _display->isOn() && millis() >= next_batt_chck) { _cached_batt_mv = getBattMilliVolts(); next_batt_chck = millis() + 8000; } From 83ad3a6dc0924a3ac5ef94c28548e41097768e5a Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Tue, 2 Jun 2026 15:32:28 +1000 Subject: [PATCH 27/59] * direct/zero hop by default --- examples/companion_radio/MyMesh.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp index bff571e0..12f66512 100644 --- a/examples/companion_radio/MyMesh.cpp +++ b/examples/companion_radio/MyMesh.cpp @@ -1540,7 +1540,7 @@ void MyMesh::handleCmdFrame(size_t len) { if (recipient == NULL) { // FIRMWARE_VER_CODE 13+, allow non-contact requests memset(&anon, 0, sizeof(anon)); memcpy(anon.id.pub_key, pub_key, PUB_KEY_SIZE); - anon.out_path_len = OUT_PATH_UNKNOWN; + anon.out_path_len = 0; // default to zero-hop direct anon.type = ADV_TYPE_NONE; // unknown if (addContact(anon)) recipient = &anon; From 12f069b51360e7f4d860ea2206a886d996b5fba0 Mon Sep 17 00:00:00 2001 From: entr0p1 <1475255+entr0p1@users.noreply.github.com> Date: Tue, 2 Jun 2026 16:17:08 +1000 Subject: [PATCH 28/59] Rak WisMesh Tag fixes - Remove debug flag - Correct lib_deps from rak4631 to rak_wismesh_tag - Correct extends from rak4631 to rak_wismesh_tag --- variants/rak_wismesh_tag/platformio.ini | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/variants/rak_wismesh_tag/platformio.ini b/variants/rak_wismesh_tag/platformio.ini index 29124daf..e9cddb74 100644 --- a/variants/rak_wismesh_tag/platformio.ini +++ b/variants/rak_wismesh_tag/platformio.ini @@ -96,28 +96,28 @@ build_flags = -D OFFLINE_QUEUE_SIZE=256 -D PIN_GPS_EN=34 ; -D MESH_PACKET_LOGGING=1 - -D MESH_DEBUG=1 +; -D MESH_DEBUG=1 build_src_filter = ${rak_wismesh_tag.build_src_filter} + + +<../examples/companion_radio/*.cpp> +<../examples/companion_radio/ui-orig/*.cpp> lib_deps = - ${rak4631.lib_deps} + ${rak_wismesh_tag.lib_deps} densaugeo/base64 @ ~1.4.0 end2endzone/NonBlockingRTTTL@^1.3.0 [env:RAK_WisMesh_Tag_sensor] -extends = rak4631 +extends = rak_wismesh_tag build_flags = - ${rak4631.build_flags} + ${rak_wismesh_tag.build_flags} -D ADVERT_NAME='"RAK WM Sensor"' -D ADVERT_LAT=0.0 -D ADVERT_LON=0.0 -D ADMIN_PASSWORD='"password"' ; -D MESH_PACKET_LOGGING=1 - -D MESH_DEBUG=1 -build_src_filter = ${rak4631.build_src_filter} +; -D MESH_DEBUG=1 +build_src_filter = ${rak_wismesh_tag.build_src_filter} +<../examples/simple_sensor> [env:RAK_WisMesh_Tag_kiss_modem] From 5e3edd0bbc0c8d1b49a544eb858f8d061d83fe12 Mon Sep 17 00:00:00 2001 From: taco Date: Tue, 2 Jun 2026 18:36:07 +1000 Subject: [PATCH 29/59] add bool isEink() for eink display drivers --- src/helpers/ui/DisplayDriver.h | 1 + src/helpers/ui/E213Display.h | 1 + src/helpers/ui/E290Display.h | 1 + src/helpers/ui/GxEPDDisplay.h | 3 ++- 4 files changed, 5 insertions(+), 1 deletion(-) diff --git a/src/helpers/ui/DisplayDriver.h b/src/helpers/ui/DisplayDriver.h index ec63c191..dcc5fe03 100644 --- a/src/helpers/ui/DisplayDriver.h +++ b/src/helpers/ui/DisplayDriver.h @@ -14,6 +14,7 @@ public: int height() const { return _h; } virtual bool isOn() = 0; + virtual bool isEink() { return false; } // default to non-eink, override in eink drivers virtual void turnOn() = 0; virtual void turnOff() = 0; virtual void clear() = 0; diff --git a/src/helpers/ui/E213Display.h b/src/helpers/ui/E213Display.h index 420792c8..add8f11b 100644 --- a/src/helpers/ui/E213Display.h +++ b/src/helpers/ui/E213Display.h @@ -26,6 +26,7 @@ public: } bool begin(); bool isOn() override { return _isOn; } + bool isEink() override { return true; } void turnOn() override; void turnOff() override; void clear() override; diff --git a/src/helpers/ui/E290Display.h b/src/helpers/ui/E290Display.h index 2ca50225..88bf34ff 100644 --- a/src/helpers/ui/E290Display.h +++ b/src/helpers/ui/E290Display.h @@ -22,6 +22,7 @@ public: bool begin(); bool isOn() override { return _isOn; } + bool isEink() override { return true; } void turnOn() override; void turnOff() override; void clear() override; diff --git a/src/helpers/ui/GxEPDDisplay.h b/src/helpers/ui/GxEPDDisplay.h index 1a04cc24..219b6076 100644 --- a/src/helpers/ui/GxEPDDisplay.h +++ b/src/helpers/ui/GxEPDDisplay.h @@ -46,7 +46,8 @@ public: bool begin(); - bool isOn() override {return _isOn;}; + bool isOn() override { return _isOn; } + bool isEink() override { return true; } void turnOn() override; void turnOff() override; void clear() override; From e449af1723c2daf502223f4f13d4b4ba8fb23f6c Mon Sep 17 00:00:00 2001 From: taco Date: Tue, 2 Jun 2026 18:37:18 +1000 Subject: [PATCH 30/59] bypass auto-shutdown delay for e-ink devices --- examples/companion_radio/ui-new/UITask.cpp | 4 +--- examples/companion_radio/ui-tiny/UITask.cpp | 2 +- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/examples/companion_radio/ui-new/UITask.cpp b/examples/companion_radio/ui-new/UITask.cpp index 0cebc100..7821af3e 100644 --- a/examples/companion_radio/ui-new/UITask.cpp +++ b/examples/companion_radio/ui-new/UITask.cpp @@ -840,9 +840,7 @@ void UITask::loop() { _display->drawTextCentered(_display->width() / 2, 20, "Low Battery."); _display->drawTextCentered(_display->width() / 2, 40, "Shutting Down!"); _display->endFrame(); - #if !defined(THINKNODE_M1) && !defined(LILYGO_TECHO) // TODO: refactor eink variants to use EINK_DISPLAY macros to gate this properly - delay(3000); - #endif + if (_display->isEink() == false) { delay(3000); } } shutdown(); } diff --git a/examples/companion_radio/ui-tiny/UITask.cpp b/examples/companion_radio/ui-tiny/UITask.cpp index 125c4f7b..bfaddf1d 100644 --- a/examples/companion_radio/ui-tiny/UITask.cpp +++ b/examples/companion_radio/ui-tiny/UITask.cpp @@ -735,7 +735,7 @@ void UITask::loop() { _display->setTextSize(1); _display->drawTextCentered(_display->width() / 2, 18, "Shutting down!"); _display->endFrame(); - delay(3000); // TODO: refactor eink variants to use EINK_DISPLAY macros to gate this properly + if (_display->isEink() == false) { delay(3000); } } shutdown(); } From 82560ede55b614c290abfd035e9000c6d96a3559 Mon Sep 17 00:00:00 2001 From: Sefinek Date: Tue, 2 Jun 2026 15:34:00 +0200 Subject: [PATCH 31/59] chore: normalize board JSON line endings --- boards/esp32-s3-zero.json | 80 +++++++++++----------- boards/minewsemi_me25ls01.json | 118 ++++++++++++++++----------------- 2 files changed, 99 insertions(+), 99 deletions(-) diff --git a/boards/esp32-s3-zero.json b/boards/esp32-s3-zero.json index 7a9dbc53..bf7aec12 100644 --- a/boards/esp32-s3-zero.json +++ b/boards/esp32-s3-zero.json @@ -1,40 +1,40 @@ -{ - "build": { - "arduino": { - "ldscript": "esp32s3_out.ld" - }, - "core": "esp32", - "extra_flags": [ - "-D ARDUINO_USB_CDC_ON_BOOT=1", - "-D ARDUINO_USB_MSC_ON_BOOT=0", - "-D ARDUINO_USB_DFU_ON_BOOT=0", - "-D ARDUINO_USB_MODE=1", - "-D ARDUINO_RUNNING_CORE=1", - "-D ARDUINO_EVENT_RUNNING_CORE=1" - ], - "f_cpu": "240000000L", - "f_flash": "80000000L", - "flash_mode": "qio", - "hwids": [["0x303A", "0x1001"]], - "mcu": "esp32s3", - "variant": "esp32s3" - }, - "connectivity": ["wifi", "bluetooth"], - "debug": { - "default_tool": "esp-builtin", - "onboard_tools": ["esp-builtin"], - "openocd_target": "esp32s3.cfg" - }, - "frameworks": ["arduino", "espidf"], - "name": "ESP32-S3-Zero", - "upload": { - "flash_size": "4MB", - "maximum_ram_size": 327680, - "maximum_size": 4194304, - "require_upload_port": true, - "speed": 921600 - }, - "url": "https://www.espressif.com", - "vendor": "Espressif" -} - +{ + "build": { + "arduino": { + "ldscript": "esp32s3_out.ld" + }, + "core": "esp32", + "extra_flags": [ + "-D ARDUINO_USB_CDC_ON_BOOT=1", + "-D ARDUINO_USB_MSC_ON_BOOT=0", + "-D ARDUINO_USB_DFU_ON_BOOT=0", + "-D ARDUINO_USB_MODE=1", + "-D ARDUINO_RUNNING_CORE=1", + "-D ARDUINO_EVENT_RUNNING_CORE=1" + ], + "f_cpu": "240000000L", + "f_flash": "80000000L", + "flash_mode": "qio", + "hwids": [["0x303A", "0x1001"]], + "mcu": "esp32s3", + "variant": "esp32s3" + }, + "connectivity": ["wifi", "bluetooth"], + "debug": { + "default_tool": "esp-builtin", + "onboard_tools": ["esp-builtin"], + "openocd_target": "esp32s3.cfg" + }, + "frameworks": ["arduino", "espidf"], + "name": "ESP32-S3-Zero", + "upload": { + "flash_size": "4MB", + "maximum_ram_size": 327680, + "maximum_size": 4194304, + "require_upload_port": true, + "speed": 921600 + }, + "url": "https://www.espressif.com", + "vendor": "Espressif" +} + diff --git a/boards/minewsemi_me25ls01.json b/boards/minewsemi_me25ls01.json index 928acb0e..26b92d43 100644 --- a/boards/minewsemi_me25ls01.json +++ b/boards/minewsemi_me25ls01.json @@ -1,59 +1,59 @@ -{ - "build": { - "arduino": { - "ldscript": "nrf52840_s140_v7.ld" - }, - "core": "nRF5", - "cpu": "cortex-m4", - "extra_flags": "-DARDUINO_WIO_WM1110 -DNRF52840_XXAA", - "f_cpu": "64000000L", - "hwids": [ - ["0x239A", "0x8029"], - ["0x239A", "0x0029"], - ["0x239A", "0x002A"], - ["0x239A", "0x802A"] - ], - "usb_product": "me25ls01-BOOT", - "mcu": "nrf52840", - "variant": "minewsemi_me25ls01", - "bsp": { - "name": "adafruit" - }, - "softdevice": { - "sd_flags": "-DS140", - "sd_name": "s140", - "sd_version": "7.3.0", - "sd_fwid": "0x0123" - }, - "bootloader": { - "settings_addr": "0xFF000" - } - }, - "connectivity": ["bluetooth"], - "debug": { - "jlink_device": "nRF52840_xxAA", - "svd_path": "nrf52840.svd", - "openocd_target": "nrf52.cfg" - }, - "frameworks": ["arduino"], - "name": "Minewsemi ME25LS01", - "upload": { - "maximum_ram_size": 235520, - "maximum_size": 811008, - "speed": 115200, - "protocol": "nrfutil", - "protocols": [ - "jlink", - "nrfjprog", - "nrfutil", - "stlink", - "cmsis-dap", - "blackmagic" - ], - "use_1200bps_touch": true, - "require_upload_port": true, - "wait_for_upload_port": true - }, - "url": "https://en.minewsemi.com/lora-module/lr1110-nrf52840-me25LS01", - "vendor": "MINEWSEMI" -} +{ + "build": { + "arduino": { + "ldscript": "nrf52840_s140_v7.ld" + }, + "core": "nRF5", + "cpu": "cortex-m4", + "extra_flags": "-DARDUINO_WIO_WM1110 -DNRF52840_XXAA", + "f_cpu": "64000000L", + "hwids": [ + ["0x239A", "0x8029"], + ["0x239A", "0x0029"], + ["0x239A", "0x002A"], + ["0x239A", "0x802A"] + ], + "usb_product": "me25ls01-BOOT", + "mcu": "nrf52840", + "variant": "minewsemi_me25ls01", + "bsp": { + "name": "adafruit" + }, + "softdevice": { + "sd_flags": "-DS140", + "sd_name": "s140", + "sd_version": "7.3.0", + "sd_fwid": "0x0123" + }, + "bootloader": { + "settings_addr": "0xFF000" + } + }, + "connectivity": ["bluetooth"], + "debug": { + "jlink_device": "nRF52840_xxAA", + "svd_path": "nrf52840.svd", + "openocd_target": "nrf52.cfg" + }, + "frameworks": ["arduino"], + "name": "Minewsemi ME25LS01", + "upload": { + "maximum_ram_size": 235520, + "maximum_size": 811008, + "speed": 115200, + "protocol": "nrfutil", + "protocols": [ + "jlink", + "nrfjprog", + "nrfutil", + "stlink", + "cmsis-dap", + "blackmagic" + ], + "use_1200bps_touch": true, + "require_upload_port": true, + "wait_for_upload_port": true + }, + "url": "https://en.minewsemi.com/lora-module/lr1110-nrf52840-me25LS01", + "vendor": "MINEWSEMI" +} From cc05ae555ab90c6fb1bebf15514ec540e47d9230 Mon Sep 17 00:00:00 2001 From: Sefinek Date: Tue, 2 Jun 2026 22:12:18 +0200 Subject: [PATCH 32/59] docs: fix typos, grammar, and formatting in FAQ and code comments --- README.md | 4 +- docs/faq.md | 375 +++++++++--------- examples/companion_radio/MyMesh.cpp | 2 +- examples/companion_radio/ui-new/UITask.cpp | 2 +- examples/companion_radio/ui-tiny/UITask.cpp | 6 +- examples/simple_room_server/MyMesh.cpp | 2 +- src/Mesh.h | 10 +- src/helpers/sensors/RAK12035_SoilMoisture.cpp | 10 +- src/helpers/ui/OLEDDisplay.cpp | 4 +- src/helpers/ui/buzzer.h | 2 +- 10 files changed, 208 insertions(+), 209 deletions(-) diff --git a/README.md b/README.md index 3647ec38..b14aff34 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ The companion firmware can be connected to via BLE, USB or Wi-Fi depending on th **Repeater and Room Server Firmware** -The repeater and room server firmwares can be setup via USB in the web config tool. +The repeater and room server firmware can be set up via USB in the web config tool. - https://config.meshcore.io @@ -89,7 +89,7 @@ MeshCore is open-source software released under the MIT License. You are free to ## Contributing Please submit PR's using 'dev' as the base branch! -For minor changes just submit your PR and we'll try to review it, but for anything more 'impactful' please open an Issue first and start a discussion. Is better to sound out what it is you want to achieve first, and try to come to a consensus on what the best approach is, especially when it impacts the structure or architecture of this codebase. +For minor changes just submit your PR and we'll try to review it, but for anything more 'impactful' please open an Issue first and start a discussion. It is better to sound out what it is you want to achieve first, and try to come to a consensus on what the best approach is, especially when it impacts the structure or architecture of this codebase. Here are some general principles you should try to adhere to: * Keep it simple. Please, don't think like a high-level lang programmer. Think embedded, and keep code concise, without any unnecessary layers. diff --git a/docs/faq.md b/docs/faq.md index c3317246..d1aa7a10 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -3,103 +3,103 @@ A list of frequently-asked questions and answers for MeshCore - [Frequently Asked Questions](#frequently-asked-questions) - - [1. Introduction](#1-introduction) - - [1.1. Q: What is MeshCore?](#11-q-what-is-meshcore) - - [1.2. Q: What do you need to start using MeshCore?](#12-q-what-do-you-need-to-start-using-meshcore) - - [1.2.1. Hardware](#121-hardware) - - [1.2.2. Firmware](#122-firmware) - - [1.2.3. Companion Radio Firmware](#123-companion-radio-firmware) - - [1.2.4. Repeater](#124-repeater) - - [1.2.5. Room Server](#125-room-server) - - [2. Initial Setup](#2-initial-setup) - - [2.1. Q: How many devices do I need to start using MeshCore?](#21-q-how-many-devices-do-i-need-to-start-using-meshcore) - - [2.2. Q: Does MeshCore cost any money?](#22-q-does-meshcore-cost-any-money) - - [2.3. Q: What frequencies are supported by MeshCore?](#23-q-what-frequencies-are-supported-by-meshcore) - - [2.4. Q: What is an "advert" in MeshCore?](#24-q-what-is-an-advert-in-meshcore) - - [2.5. Q: Is there a hop limit?](#25-q-is-there-a-hop-limit) - - [3. Server Administration](#3-server-administration) - - [3.1. Q: How do you configure a repeater or a room server?](#31-q-how-do-you-configure-a-repeater-or-a-room-server) - - [3.2. Q: Do I need to set the location for a repeater?](#32-q-do-i-need-to-set-the-location-for-a-repeater) - - [3.3. Q: What is the password to administer a repeater or a room server?](#33-q-what-is-the-password-to-administer-a-repeater-or-a-room-server) - - [3.4. Q: What is the password to join a room server?](#34-q-what-is-the-password-to-join-a-room-server) - - [3.5. Q: Can I retrieve a repeater's private key or set a repeater's private key?](#35-q-can-i-retrieve-a-repeaters-private-key-or-set-a-repeaters-private-key) - - [3.6. Q: The first byte of my repeater's public key collides with an existing repeater on the mesh. How do I get a new private key with a matching public key that has its first byte of my choosing?](#36-q-the-first-byte-of-my-repeaters-public-key-collides-with-an-existing-repeater-on-the-mesh--how-do-i-get-a-new-private-key-with-a-matching-public-key-that-has-its-first-byte-of-my-choosing) - - [3.7. Q: My repeater may be suffering from deafness due to high power interference near my mesh's frequency, it is not hearing other in-range MeshCore radios. What can I do?](#37-q-my-repeater-may-be-suffering-from-deafness-due-to-high-power-interference-near-my-meshs-frequency-it-is-not-hearing-other-in-range-meshcore-radios--what-can-i-do) - - [3.8. Q: How do I make my repeater an observer on the mesh?](#38-q-how-do-i-make-my-repeater-an-observer-on-the-mesh) - - [3.9. Q: What is multi-byte support? What do 1-byte, 2-byte, 3-byte adverts and messages mean?](#39-q-what-is-multi-byte-support--what-do-1-byte-2-byte-3-byte-adverts-and-messages-mean) - - [3.9.1. Q: **What path hash sizes will my repeater forward?**](#391-q-what-path-hash-sizes-will-my-repeater-forward) - - [3.9.2. Q: **What determines a packet's path hash size?**](#392-q-what-determines-a-packets-path-hash-size) - - [3.9.3. Q: **How do I change my companion's path hash size?**](#393-q-how-do-i-change-my-companions-path-hash-size) - - [3.9.4. Q: **What does the CLI command `path.hash.mode` do on a repeater?**](#394-q-what-does-the-cli-command-pathhashmode-do-on-a-repeater) - - [3.9.5. Q: **Why use 2- or 3-byte path hash for adverts?**](#395-q-why-use-2--or-3-byte-path-hash-for-adverts) - - [3.9.6. Q: **When can we move away from 1-byte path hash for channel and direct messages?**](#396-q-when-can-we-move-away-from-1-byte-path-hash-for-channel-and-direct-messages) - - [4. T-Deck Related](#4-t-deck-related) - - [4.1. Q: Is there a user guide for T-Deck, T-Pager, T-Watch, or T-Display Pro?](#41-q-is-there-a-user-guide-for-t-deck-t-pager-t-watch-or-t-display-pro) - - [4.2. Q: What are the steps to get a T-Deck into DFU (Device Firmware Update) mode?](#42-q-what-are-the-steps-to-get-a-t-deck-into-dfu-device-firmware-update-mode) - - [4.3. Q: Why is my T-Deck Plus not getting any satellite lock?](#43-q-why-is-my-t-deck-plus-not-getting-any-satellite-lock) - - [4.4. Q: Why is my OG (non-Plus) T-Deck not getting any satellite lock?](#44-q-why-is-my-og-non-plus-t-deck-not-getting-any-satellite-lock) - - [4.5. Q: What size of SD card does the T-Deck support?](#45-q-what-size-of-sd-card-does-the-t-deck-support) - - [4.6. Q: What is the public key for the default public channel?](#46-q-what-is-the-public-key-for-the-default-public-channel) - - [4.7. Q: How do I get maps on T-Deck?](#47-q-how-do-i-get-maps-on-t-deck) - - [4.8. Q: Where do the map tiles go?](#48-q-where-do-the-map-tiles-go) - - [4.9. Q: How to unlock deeper map zoom and server management features on T-Deck?](#49-q-how-to-unlock-deeper-map-zoom-and-server-management-features-on-t-deck) - - [4.10. Q: How to decipher the diagnostics screen on T-Deck?](#410-q-how-to-decipher-the-diagnostics-screen-on-t-deck) - - [4.11. Q: The T-Deck sound is too loud?](#411-q-the-t-deck-sound-is-too-loud) - - [4.12. Q: Can you customize the sound?](#412-q-can-you-customize-the-sound) - - [4.13. Q: What is the 'Import from Clipboard' feature on the t-deck and is there a way to manually add nodes without having to receive adverts?](#413-q-what-is-the-import-from-clipboard-feature-on-the-t-deck-and-is-there-a-way-to-manually-add-nodes-without-having-to-receive-adverts) - - [4.14. Q: How to capture a screenshot on T-Deck?](#414-q-how-to-capture-a-screenshot-on-t-deck) - - [5. General](#5-general) - - [5.1. Q: What are BW, SF, and CR?](#51-q-what-are-bw-sf-and-cr) - - [5.2. Q: Do MeshCore clients repeat?](#52-q-do-meshcore-clients-repeat) - - [5.3. Q: What happens when a node learns a route via a mobile repeater, and that repeater is gone?](#53-q-what-happens-when-a-node-learns-a-route-via-a-mobile-repeater-and-that-repeater-is-gone) - - [5.4. Q: How does a node discover a path to its destination and then use it to send messages in the future, instead of flooding every message it sends like Meshtastic?](#54-q-how-does-a-node-discover-a-path-to-its-destination-and-then-use-it-to-send-messages-in-the-future-instead-of-flooding-every-message-it-sends-like-meshtastic) - - [5.5. Q: Do public channels always flood? Do private channels always flood?](#55-q-do-public-channels-always-flood-do-private-channels-always-flood) - - [5.6. Q: What is the public key for the default public channel?](#56-q-what-is-the-public-key-for-the-default-public-channel) - - [5.7. Q: Is MeshCore open source?](#57-q-is-meshcore-open-source) - - [5.8. Q: How can I support MeshCore?](#58-q-how-can-i-support-meshcore) - - [5.9. Q: How do I build MeshCore firmware from source?](#59-q-how-do-i-build-meshcore-firmware-from-source) - - [5.10. Q: Are there other MeshCore related open source projects?](#510-q-are-there-other-meshcore-related-open-source-projects) - - [5.11. Q: Does MeshCore support ATAK](#511-q-does-meshcore-support-atak) - - [5.12. Q: How do I add a node to the MeshCore Map](#512-q-how-do-i-add-a-node-to-the-meshcore-map) - - [5.13. Q: Can I use a Raspberry Pi to update a MeshCore radio?](#513-q-can-i-use-a-raspberry-pi-to-update-a-meshcore-radio) - - [5.14. Q: Are there projects built around MeshCore?](#514-q-are-there-projects-built-around-meshcore) - - [5.15. Q: Are there client applications for Windows or Mac?](#515-q-are-there-client-applications-for-windows-or-mac) - - [5.16. Q: Are there any resources that compare MeshCore to other LoRa systems?](#516-q-are-there-any-resources-that-compare-meshcore-to-other-lora-systems) - - [6. Troubleshooting](#6-troubleshooting) - - [6.1. Q: My client says another client or a repeater or a room server was last seen many, many days ago.](#61-q-my-client-says-another-client-or-a-repeater-or-a-room-server-was-last-seen-many-many-days-ago) - - [6.2. Q: A repeater or a client or a room server I expect to see on my discover list (on T-Deck) or contact list (on a smart device client) are not listed.](#62-q-a-repeater-or-a-client-or-a-room-server-i-expect-to-see-on-my-discover-list-on-t-deck-or-contact-list-on-a-smart-device-client-are-not-listed) - - [6.3. Q: How to connect to a repeater via BLE (Bluetooth)?](#63-q-how-to-connect-to-a-repeater-via-ble-bluetooth) - - [6.4. Q: My companion isn't showing up over Bluetooth?](#64-q-my-companion-isnt-showing-up-over-bluetooth) - - [6.5. Q: I can't connect via Bluetooth, what is the Bluetooth pairing code?](#65-q-i-cant-connect-via-bluetooth-what-is-the-bluetooth-pairing-code) - - [6.6. Q: My Heltec V3 keeps disconnecting from my smartphone. It can't hold a solid Bluetooth connection.](#66-q-my-heltec-v3-keeps-disconnecting-from-my-smartphone--it-cant-hold-a-solid-bluetooth-connection) - - [6.7. Q: My RAK/T1000-E/xiao\_nRF52 device seems to be corrupted, how do I wipe it clean to start fresh?](#67-q-my-rakt1000-exiao_nrf52-device-seems-to-be-corrupted-how-do-i-wipe-it-clean-to-start-fresh) - - [6.8. Q: WebFlasher fails on Linux with failed to open](#68-q-webflasher-fails-on-linux-with-failed-to-open) - - [7. Other Questions:](#7-other-questions) - - [7.1. Q: How to update nRF (RAK, T114, Seed XIAO) repeater and room server firmware over the air using the new simpler DFU app?](#71-q-how-to-update-nrf-rak-t114-seed-xiao-repeater-and-room-server-firmware-over-the-air-using-the-new-simpler-dfu-app) - - [7.1.1 Q: Can I update Seeed Studio Wio Tracker L1 Pro using OTA?](#711-q-can-i-update-seeed-studio-wio-tracker-l1-pro-using-ota) - - [7.2. Q: How to update ESP32-based devices over the air?](#72-q-how-to-update-esp32-based-devices-over-the-air) - - [7.3. Q: Is there a way to lower the chance of a failed OTA device firmware update (DFU)?](#73-q-is-there-a-way-to-lower-the-chance-of-a-failed-ota-device-firmware-update-dfu) - - [7.4. Q: are the MeshCore logo and font available?](#74-q-are-the-meshcore-logo-and-font-available) - - [7.5. Q: What is the format of a contact or channel QR code?](#75-q-what-is-the-format-of-a-contact-or-channel-qr-code) - - [7.6. Q: How do I connect to the companion via Wi-Fi, e.g. using a heltec v3?](#76-q-how-do-i-connect-to-the-companion-via-wi-fi-eg-using-a-heltec-v3) - - [7.7. Q: I have a Station G2, or a Heltec V4, or an Ikoka Stick, or a radio with a EByte E22-900M30S or a E22-900M33S module, what should their transmit power be set to?](#77-q-i-have-a-station-g2-or-a-heltec-v4-or-an-ikoka-stick-or-a-radio-with-a-ebyte-e22-900m30s-or-a-e22-900m33s-module-what-should-their-transmit-power-be-set-to) + - [1. Introduction](#1-introduction) + - [1.1. Q: What is MeshCore?](#11-q-what-is-meshcore) + - [1.2. Q: What do you need to start using MeshCore?](#12-q-what-do-you-need-to-start-using-meshcore) + - [1.2.1. Hardware](#121-hardware) + - [1.2.2. Firmware](#122-firmware) + - [1.2.3. Companion Radio Firmware](#123-companion-radio-firmware) + - [1.2.4. Repeater](#124-repeater) + - [1.2.5. Room Server](#125-room-server) + - [2. Initial Setup](#2-initial-setup) + - [2.1. Q: How many devices do I need to start using MeshCore?](#21-q-how-many-devices-do-i-need-to-start-using-meshcore) + - [2.2. Q: Does MeshCore cost any money?](#22-q-does-meshcore-cost-any-money) + - [2.3. Q: What frequencies are supported by MeshCore?](#23-q-what-frequencies-are-supported-by-meshcore) + - [2.4. Q: What is an "advert" in MeshCore?](#24-q-what-is-an-advert-in-meshcore) + - [2.5. Q: Is there a hop limit?](#25-q-is-there-a-hop-limit) + - [3. Server Administration](#3-server-administration) + - [3.1. Q: How do you configure a repeater or a room server?](#31-q-how-do-you-configure-a-repeater-or-a-room-server) + - [3.2. Q: Do I need to set the location for a repeater?](#32-q-do-i-need-to-set-the-location-for-a-repeater) + - [3.3. Q: What is the password to administer a repeater or a room server?](#33-q-what-is-the-password-to-administer-a-repeater-or-a-room-server) + - [3.4. Q: What is the password to join a room server?](#34-q-what-is-the-password-to-join-a-room-server) + - [3.5. Q: Can I retrieve a repeater's private key or set a repeater's private key?](#35-q-can-i-retrieve-a-repeaters-private-key-or-set-a-repeaters-private-key) + - [3.6. Q: The first byte of my repeater's public key collides with an existing repeater on the mesh. How do I get a new private key with a matching public key that has its first byte of my choosing?](#36-q-the-first-byte-of-my-repeaters-public-key-collides-with-an-existing-repeater-on-the-mesh-how-do-i-get-a-new-private-key-with-a-matching-public-key-that-has-its-first-byte-of-my-choosing) + - [3.7. Q: My repeater may be suffering from deafness due to high power interference near my mesh's frequency, it is not hearing other in-range MeshCore radios. What can I do?](#37-q-my-repeater-may-be-suffering-from-deafness-due-to-high-power-interference-near-my-meshs-frequency-it-is-not-hearing-other-in-range-meshcore-radios-what-can-i-do) + - [3.8. Q: How do I make my repeater an observer on the mesh?](#38-q-how-do-i-make-my-repeater-an-observer-on-the-mesh) + - [3.9. Q: What is multibyte support? What do 1-byte, 2-byte, 3-byte adverts and messages mean?](#39-q-what-is-multibyte-support-what-do-1-byte-2-byte-3-byte-adverts-and-messages-mean) + - [3.9.1. Q: **What path hash sizes will my repeater forward?**](#391-q-what-path-hash-sizes-will-my-repeater-forward) + - [3.9.2. Q: **What determines a packet's path hash size?**](#392-q-what-determines-a-packets-path-hash-size) + - [3.9.3. Q: **How do I change my companion's path hash size?**](#393-q-how-do-i-change-my-companions-path-hash-size) + - [3.9.4. Q: **What does the CLI command `path.hash.mode` do on a repeater?**](#394-q-what-does-the-cli-command-pathhashmode-do-on-a-repeater) + - [3.9.5. Q: **Why use 2- or 3-byte path hash for adverts?**](#395-q-why-use-2--or-3-byte-path-hash-for-adverts) + - [3.9.6. Q: **When can we move away from 1-byte path hash for channel and direct messages?**](#396-q-when-can-we-move-away-from-1-byte-path-hash-for-channel-and-direct-messages) + - [4. T-Deck Related](#4-t-deck-related) + - [4.1. Q: Is there a user guide for T-Deck, T-Pager, T-Watch, or T-Display Pro?](#41-q-is-there-a-user-guide-for-t-deck-t-pager-t-watch-or-t-display-pro) + - [4.2. Q: What are the steps to get a T-Deck into DFU (Device Firmware Update) mode?](#42-q-what-are-the-steps-to-get-a-t-deck-into-dfu-device-firmware-update-mode) + - [4.3. Q: Why is my T-Deck Plus not getting any satellite lock?](#43-q-why-is-my-t-deck-plus-not-getting-any-satellite-lock) + - [4.4. Q: Why is my OG (non-Plus) T-Deck not getting any satellite lock?](#44-q-why-is-my-og-non-plus-t-deck-not-getting-any-satellite-lock) + - [4.5. Q: What size of SD card does the T-Deck support?](#45-q-what-size-of-sd-card-does-the-t-deck-support) + - [4.6. Q: What is the public key for the default public channel?](#46-q-what-is-the-public-key-for-the-default-public-channel) + - [4.7. Q: How do I get maps on T-Deck?](#47-q-how-do-i-get-maps-on-t-deck) + - [4.8. Q: Where do the map tiles go?](#48-q-where-do-the-map-tiles-go) + - [4.9. Q: How to unlock deeper map zoom and server management features on T-Deck?](#49-q-how-to-unlock-deeper-map-zoom-and-server-management-features-on-t-deck) + - [4.10. Q: How to decipher the diagnostics screen on T-Deck?](#410-q-how-to-decipher-the-diagnostics-screen-on-t-deck) + - [4.11. Q: The T-Deck sound is too loud?](#411-q-the-t-deck-sound-is-too-loud) + - [4.12. Q: Can you customize the sound?](#412-q-can-you-customize-the-sound) + - [4.13. Q: What is the 'Import from Clipboard' feature on the t-deck and is there a way to manually add nodes without having to receive adverts?](#413-q-what-is-the-import-from-clipboard-feature-on-the-t-deck-and-is-there-a-way-to-manually-add-nodes-without-having-to-receive-adverts) + - [4.14. Q: How to capture a screenshot on T-Deck?](#414-q-how-to-capture-a-screenshot-on-t-deck) + - [5. General](#5-general) + - [5.1. Q: What are BW, SF, and CR?](#51-q-what-are-bw-sf-and-cr) + - [5.2. Q: Do MeshCore clients repeat?](#52-q-do-meshcore-clients-repeat) + - [5.3. Q: What happens when a node learns a route via a mobile repeater, and that repeater is gone?](#53-q-what-happens-when-a-node-learns-a-route-via-a-mobile-repeater-and-that-repeater-is-gone) + - [5.4. Q: How does a node discover a path to its destination and then use it to send messages in the future, instead of flooding every message it sends like Meshtastic?](#54-q-how-does-a-node-discover-a-path-to-its-destination-and-then-use-it-to-send-messages-in-the-future-instead-of-flooding-every-message-it-sends-like-meshtastic) + - [5.5. Q: Do public channels always flood? Do private channels always flood?](#55-q-do-public-channels-always-flood-do-private-channels-always-flood) + - [5.6. Q: What is the public key for the default public channel?](#56-q-what-is-the-public-key-for-the-default-public-channel) + - [5.7. Q: Is MeshCore open source?](#57-q-is-meshcore-open-source) + - [5.8. Q: How can I support MeshCore?](#58-q-how-can-i-support-meshcore) + - [5.9. Q: How do I build MeshCore firmware from source?](#59-q-how-do-i-build-meshcore-firmware-from-source) + - [5.10. Q: Are there other MeshCore related open source projects?](#510-q-are-there-other-meshcore-related-open-source-projects) + - [5.11. Q: Does MeshCore support ATAK](#511-q-does-meshcore-support-atak) + - [5.12. Q: How do I add a node to the MeshCore Map](#512-q-how-do-i-add-a-node-to-the-meshcore-map) + - [5.13. Q: Can I use a Raspberry Pi to update a MeshCore radio?](#513-q-can-i-use-a-raspberry-pi-to-update-a-meshcore-radio) + - [5.14. Q: Are there projects built around MeshCore?](#514-q-are-there-projects-built-around-meshcore) + - [5.15. Q: Are there client applications for Windows or Mac?](#515-q-are-there-client-applications-for-windows-or-mac) + - [5.16. Q: Are there any resources that compare MeshCore to other LoRa systems?](#516-q-are-there-any-resources-that-compare-meshcore-to-other-lora-systems) + - [6. Troubleshooting](#6-troubleshooting) + - [6.1. Q: My client says another client or a repeater or a room server was last seen many, many days ago.](#61-q-my-client-says-another-client-or-a-repeater-or-a-room-server-was-last-seen-many-many-days-ago) + - [6.2. Q: A repeater or a client or a room server I expect to see on my discover list (on T-Deck) or contact list (on a smart device client) are not listed.](#62-q-a-repeater-or-a-client-or-a-room-server-i-expect-to-see-on-my-discover-list-on-t-deck-or-contact-list-on-a-smart-device-client-are-not-listed) + - [6.3. Q: How to connect to a repeater via BLE (Bluetooth)?](#63-q-how-to-connect-to-a-repeater-via-ble-bluetooth) + - [6.4. Q: My companion isn't showing up over Bluetooth?](#64-q-my-companion-isnt-showing-up-over-bluetooth) + - [6.5. Q: I can't connect via Bluetooth, what is the Bluetooth pairing code?](#65-q-i-cant-connect-via-bluetooth-what-is-the-bluetooth-pairing-code) + - [6.6. Q: My Heltec V3 keeps disconnecting from my smartphone. It can't hold a solid Bluetooth connection.](#66-q-my-heltec-v3-keeps-disconnecting-from-my-smartphone-it-cant-hold-a-solid-bluetooth-connection) + - [6.7. Q: My RAK/T1000-E/xiao\_nRF52 device seems to be corrupted, how do I wipe it clean to start fresh?](#67-q-my-rakt1000-exiao_nrf52-device-seems-to-be-corrupted-how-do-i-wipe-it-clean-to-start-fresh) + - [6.8. Q: WebFlasher fails on Linux with failed to open](#68-q-webflasher-fails-on-linux-with-failed-to-open) + - [7. Other Questions:](#7-other-questions) + - [7.1. Q: How to update nRF (RAK, T114, Seeed XIAO) companion, repeater and room server firmware over the air using the new simpler DFU app?](#71-q-how-to-update-nrf-rak-t114-seeed-xiao-companion-repeater-and-room-server-firmware-over-the-air-using-the-new-simpler-dfu-app) + - [7.1.1 Q: Can I update Seeed Studio Wio Tracker L1 Pro using OTA?](#711-q-can-i-update-seeed-studio-wio-tracker-l1-pro-using-ota) + - [7.2. Q: How to update ESP32-based devices over the air?](#72-q-how-to-update-esp32-based-devices-over-the-air) + - [7.3. Q: Is there a way to lower the chance of a failed OTA device firmware update (DFU)?](#73-q-is-there-a-way-to-lower-the-chance-of-a-failed-ota-device-firmware-update-dfu) + - [7.4. Q: are the MeshCore logo and font available?](#74-q-are-the-meshcore-logo-and-font-available) + - [7.5. Q: What is the format of a contact or channel QR code?](#75-q-what-is-the-format-of-a-contact-or-channel-qr-code) + - [7.6. Q: How do I connect to the companion via Wi-Fi, e.g. using a Heltec V3?](#76-q-how-do-i-connect-to-the-companion-via-wi-fi-eg-using-a-heltec-v3) + - [7.7. Q: I have a Station G2, or a Heltec V4, or an Ikoka Stick, or a radio with an EByte E22-900M30S or an EByte E22-900M33S module, what should their transmit power be set to?](#77-q-i-have-a-station-g2-or-a-heltec-v4-or-an-ikoka-stick-or-a-radio-with-an-ebyte-e22-900m30s-or-an-ebyte-e22-900m33s-module-what-should-their-transmit-power-be-set-to) ## 1. Introduction ### 1.1. Q: What is MeshCore? -**A:** MeshCore is a multi platform system for enabling secure text based communications utilising LoRa radio hardware. It can be used for Off-Grid Communication, Emergency Response & Disaster Recovery, Outdoor Activities, Tactical Security including law enforcement and private security and also IoT sensor networks. ([source](https://meshcore.io/)) +**A:** MeshCore is a multi-platform system for enabling secure text-based communications utilizing LoRa radio hardware. It can be used for Off-Grid Communication, Emergency Response & Disaster Recovery, Outdoor Activities, Tactical Security including law enforcement and private security and also IoT sensor networks. ([source](https://meshcore.io/)) MeshCore is free and open source: -* MeshCore is the routing and firmware etc, available on GitHub under MIT license +* MeshCore is the routing and firmware etc., available on GitHub under MIT license * There are clients made by the community, such as the web clients, these are free to use, and some are open source too -* The cross platform mobile app developed by [Liam Cottle](https://liamcottle.net) for Android/iOS/PC etc is free to download and use +* The cross-platform mobile app developed by [Liam Cottle](https://liamcottle.net) for Android/iOS/PC etc. is free to download and use * The T-Deck firmware is developed by Scott at Ripple Radios, the creator of MeshCore, is also free to flash on your devices and use -Some more advanced, but optional features are available on T-Deck if you register your device for a key to unlock. On the MeshCore smartphone clients for Android and iOS/iPadOS, you can unlock the wait timer for repeater and room server remote management over RF feature. +Some more advanced, but optional features are available on T-Deck if you register your device for a key to unlock. On the MeshCore smartphone clients for Android and iOS/iPadOS, you can unlock the wait timer for repeater and room server remote management over RF feature. -These features are completely optional and aren't needed for the core messaging experience. They're like super bonus features and to help the developers continue to work on these amazing features, they may charge a small fee for an unlock code to utilise the advanced features. +These features are completely optional and aren't needed for the core messaging experience. They're like super bonus features and to help the developers continue to work on these amazing features, they may charge a small fee for an unlock code to utilize the advanced features. Anyone is able to build anything they like on top of MeshCore without paying anything. @@ -121,7 +121,7 @@ MeshCore is available on a variety of 433MHz, 868MHz and 915MHz LoRa devices. Fo For an up-to-date list of supported devices, please go to https://flasher.meshcore.io -To use MeshCore without using a phone as the client interface, you can run MeshCore on a LiLygo's T-Deck, T-Deck Plus, T-Pager, T-Watch, or T-Display Pro. MeshCore Ultra firmware running on these devices are a complete off-grid secure communication solution. +To use MeshCore without using a phone as the client interface, you can run MeshCore on a LilyGo T-Deck, T-Deck Plus, T-Pager, T-Watch, or T-Display Pro. MeshCore Ultra firmware running on these devices is a complete off-grid secure communication solution. #### 1.2.2. Firmware MeshCore has four firmware types that are not available on other LoRa systems. MeshCore has the following: @@ -145,13 +145,13 @@ A repeater can be remotely administered using a T-Deck running the MeshCore firm #### 1.2.5. Room Server A room server is a simple BBS server for sharing posts. T-Deck devices running MeshCore firmware or a BLE Companion client connected to a smartphone running the MeshCore app can connect to a room server. -Room servers store message history on them and push the stored messages to users. Room servers allow roaming users to come back later and retrieve message history. With channels, messages are either received when it's sent, or not received and missed if the channel user is out of range. Room servers are different and more like email servers where you can come back later and get your emails from your mail server. +Room servers store message history on them and push the stored messages to users. Room servers allow roaming users to come back later and retrieve message history. With channels, messages are either received when it's sent, or not received and missed if the channel user is out of range. Room servers are different and more like email servers where you can come back later and get your emails from your mail server. A room server can be remotely administered using a T-Deck running the MeshCore firmware with remote administration features unlocked, or from a BLE Companion client connected to a smartphone running the MeshCore app. When a client logs into a room server, the client will receive the previously 32 unseen messages. -Although room server can also repeat with the command line command `set repeat on`, it is not recommended nor encouraged. A room server with repeat set to `on` lacks the full set of repeater and remote administration features that are only available in the repeater firmware. +Although room server can also repeat with the command line command `set repeat on`, it is not recommended nor encouraged. A room server with repeat set to `on` lacks the full set of repeater and remote administration features that are only available in the repeater firmware. The recommendation is to run repeater and room server on separate devices for the best experience. @@ -162,27 +162,27 @@ The recommendation is to run repeater and room server on separate devices for th ## 2. Initial Setup ### 2.1. Q: How many devices do I need to start using MeshCore? -**A:** If you have one supported device, flash the BLE Companion firmware and use your device as a client. You can connect to the device using the Android or iOS client via Bluetooth. You can start communicating with other MeshCore users near you. +**A:** If you have one supported device, flash the BLE Companion firmware and use your device as a client. You can connect to the device using the Android or iOS client via Bluetooth. You can start communicating with other MeshCore users near you. -If you have two supported devices, and there are not many MeshCore users near you, flash both to BLE Companion firmware so you can use your devices to communicate with your near-by friends and family. +If you have two supported devices, and there are not many MeshCore users near you, flash both to BLE Companion firmware so you can use your devices to communicate with your nearby friends and family. -If you have two supported devices, and there are other MeshCore users nearby, you can flash one of your devices with BLE Companion firmware and flash another supported device to repeater firmware. Place the repeater high above ground to extend your MeshCore network's reach. +If you have two supported devices, and there are other MeshCore users nearby, you can flash one of your devices with BLE Companion firmware and flash another supported device to repeater firmware. Place the repeater high above ground to extend your MeshCore network's reach. After you flashed the latest firmware onto your repeater device, keep the device connected to your computer via USB serial, use the console feature on the web flasher and set the frequency for your region or country, so your client can remote administer the repeater or room server over RF: `set freq {frequency}` -The repeater and room server CLI reference is here: https://github.com/meshcore-dev/MeshCore/wiki/Repeater-&-Room-Server-CLI-Reference +The repeater and room server CLI reference is here: https://docs.meshcore.io/cli_commands If you have more supported devices, you can use your additional devices with the room server firmware. ### 2.2. Q: Does MeshCore cost any money? -**A:** All radio firmware versions (e.g. for Heltec V3, RAK, T-1000E, etc) are free and open source developed by Scott at Ripple Radios. +**A:** All radio firmware versions (e.g. for Heltec V3, RAK, T-1000E, etc.) are free and open source developed by Scott at Ripple Radios. -The native Android and iOS client uses the freemium model and is developed by Liam Cottle, developer of meshtastic map at [meshtastic.liamcottle.net](https://meshtastic.liamcottle.net) on [GitHub](https://github.com/liamcottle/meshtastic-map) and [reticulum-meshchat on github](https://github.com/liamcottle/reticulum-meshchat). +The native Android and iOS client uses the freemium model and is developed by Liam Cottle, developer of meshtastic map at [meshtastic.liamcottle.net](https://meshtastic.liamcottle.net) on [GitHub](https://github.com/liamcottle/meshtastic-map) and [reticulum-meshchat on GitHub](https://github.com/liamcottle/reticulum-meshchat). -The T-Deck firmware is free to download and most features are available without cost. To support the firmware developer, you can pay for a registration key to unlock your T-Deck for deeper map zoom and remote server administration over RF using the T-Deck. You do not need to pay for the registration to use your T-Deck for direct messaging and connecting to repeaters and room servers. +The T-Deck firmware is free to download and most features are available without cost. To support the firmware developer, you can pay for a registration key to unlock your T-Deck for deeper map zoom and remote server administration over RF using the T-Deck. You do not need to pay for the registration to use your T-Deck for direct messaging and connecting to repeaters and room servers. ### 2.3. Q: What frequencies are supported by MeshCore? @@ -190,9 +190,9 @@ The T-Deck firmware is free to download and most features are available without Use the smartphone client or the repeater setup feature on the web flasher to set your radios' RF settings by choosing the preset for your regions. -Recently, as of October 2025, many regions have moved to the "narrow" setting, aka using BW62.5 and a lower SF number (instead of the original SF11). For example, USA/Canada (Recommended) preset is 910.525MHz, SF7, BW62.5, CR5. +Recently, as of October 2025, many regions have moved to the "narrow" setting, aka using BW62.5 and a lower SF number (instead of the original SF11). For example, USA/Canada (Recommended) preset is 910.525MHz, SF7, BW62.5, CR5. -After extensive testing, many regions have switched or about to switch over to BW62.5 and SF7, 8, or 9. Narrower bandwidth setting and lower SF setting allow MeshCore's radio signals to fit between interference in the ISM band, provide for a lower noise floor, better SNR, and faster transmissions. +After extensive testing, many regions have switched or about to switch over to BW62.5 and SF7, 8, or 9. Narrower bandwidth setting and lower SF setting allow MeshCore's radio signals to fit between interference in the ISM band, provide for a lower noise floor, better SNR, and faster transmissions. If you have consensus from your community in your region to update your region's preset recommendation, please post your update request on the [#meshcore-app](https://discord.com/channels/1343693475589263471/1391681655911088241) channel on the [MeshCore Discord server ](https://meshcore.gg) to let Liam Cottle know. @@ -202,10 +202,10 @@ If you have consensus from your community in your region to update your region's **A:** Advert means to advertise yourself on the network. In Reticulum terms it would be to announce. In Meshtastic terms it would be the node sending its node info. -MeshCore allows you to manually broadcast your name, position and public encryption key, which is also signed to prevent spoofing. When you click the advert button, it broadcasts that data over LoRa. MeshCore calls that an Advert. There's two ways to advert, "zero hop" and "flood". +MeshCore allows you to manually broadcast your name, position and public encryption key, which is also signed to prevent spoofing. When you click the advert button, it broadcasts that data over LoRa. MeshCore calls that an Advert. There's two ways to advert, "zero hop" and "flood". -* Zero hop means your advert is broadcasted out to anyone that can hear it, and that's it. -* Flooded means it's broadcasted out and then repeated by all the repeaters that hear it. +* Zero hop means your advert is broadcast to anyone that can hear it, and that's it. +* Flooded means it's broadcast and then repeated by all the repeaters that hear it. MeshCore clients only advertise themselves when the user initiates it. A repeater sends a flood advert once every 12 hours by default. This interval can be configured using the following command: @@ -215,7 +215,7 @@ The separate `set advert.interval {minutes}` command controls the local zero-hop ### 2.5. Q: Is there a hop limit? -**A:** Internally the firmware has maximum limit of 64 hops. In real world settings it will be difficult to get close to the limit due to the environments and timing as packets travel further and further. We want to hear how far your MeshCore conversations go. +**A:** Internally the firmware has maximum limit of 64 hops. In real world settings it will be difficult to get close to the limit due to the environments and timing as packets travel further and further. We want to hear how far your MeshCore conversations go. --- @@ -225,17 +225,17 @@ The separate `set advert.interval {minutes}` command controls the local zero-hop ### 3.1. Q: How do you configure a repeater or a room server? -**A:** - When MeshCore is flashed onto a LoRa device is for the first time, it is necessary to set the server device's frequency to make it utilize the frequency that is legal in your country or region. +**A:** - When MeshCore is flashed onto a LoRa device for the first time, it is necessary to set the server device's frequency to make it utilize the frequency that is legal in your country or region. Repeater or room server can be administered with one of the options below: -- After a repeater or room server firmware is flashed on to a LoRa device, go to and use the web user interface to connect to the LoRa device via USB serial. From there you can set the name of the server, its frequency and other related settings, location, passwords etc. +- After a repeater or room server firmware is flashed onto a LoRa device, go to and use the web user interface to connect to the LoRa device via USB serial. From there you can set the name of the server, its frequency and other related settings, location, passwords etc. ![image](https://github.com/user-attachments/assets/2a9d9894-e34d-4dbe-b57c-fc3c250a2d34) - Connect the server device using a USB cable to a computer running Chrome on https://flasher.meshcore.io, then use the `console` feature to connect to the device -- Use a MeshCore smartphone clients to remotely administer servers via LoRa. +- Use a MeshCore smartphone client to remotely administer servers via LoRa. - A T-Deck running unlocked/registered MeshCore firmware. Remote server administration is enabled through registering your T-Deck with Ripple Radios. It is one of the ways to support MeshCore development. You can register your T-Deck at: @@ -272,7 +272,7 @@ You can get the latitude and longitude from Google Maps by right-clicking the lo Reboot the repeater after `set prv.key ` command for the new private key to take effect. -### 3.6. Q: The first byte of my repeater's public key collides with an existing repeater on the mesh. How do I get a new private key with a matching public key that has its first byte of my choosing? +### 3.6. Q: The first byte of my repeater's public key collides with an existing repeater on the mesh. How do I get a new private key with a matching public key that has its first byte of my choosing? **A:** You can generate a new private key and specify the first byte of its public key here: https://gessaman.com/mc-keygen/ @@ -281,29 +281,29 @@ Having multiple repeaters with the same first byte ID does not negatively affect Best practice is when you set up a new repeater, choose a public key that is not in use. If it is not possible to find a unique first byte for your repeater's public key, choose one that is unique within about 10 miles (16 km) to minimize collision with nearby repeaters. -### 3.7. Q: My repeater may be suffering from deafness due to high power interference near my mesh's frequency, it is not hearing other in-range MeshCore radios. What can I do? +### 3.7. Q: My repeater may be suffering from deafness due to high power interference near my mesh's frequency, it is not hearing other in-range MeshCore radios. What can I do? -**A:** This may be due to the SX1262 radio's auto gain control feature. You can use this command to periodically reset its AGC. +**A:** This may be due to the SX1262 radio's auto gain control feature. You can use this command to periodically reset its AGC. `set agc.reset.interval ` -The `` unit is in seconds and is incremented by 4. `set agc.reset.interval 4` works well to cure deafness. +The `` unit is in seconds and is incremented by 4. `set agc.reset.interval 4` works well to cure deafness. -This is a very low cost operation. AGC reset is done by simply setting `state = STATE_IDLE;` in function `RadioLibWrapper::resetAGC()` in `RadioLibWrappers.cpp` +This is a very low-cost operation. AGC reset is done by simply setting `state = STATE_IDLE;` in function `RadioLibWrapper::resetAGC()` in `RadioLibWrappers.cpp` ### 3.8. Q: How do I make my repeater an observer on the mesh? **A:** The observer instruction is available here: https://analyzer.letsmesh.net/observer/onboard -### 3.9. Q: What is multi-byte support? What do 1-byte, 2-byte, 3-byte adverts and messages mean? +### 3.9. Q: What is multibyte support? What do 1-byte, 2-byte, 3-byte adverts and messages mean? **A:** -The original MeshCore protocol design uses the first byte of a repeater's public key to denote the repeater in a path. And with 1 byte for each repeater in the path, MeshCore packets can travel as many as 64 hops. +The original MeshCore protocol design uses the first byte of a repeater's public key to denote the repeater in a path. And with 1 byte for each repeater in the path, MeshCore packets can travel as many as 64 hops. -However, with 1 byte, there are only 254 unique IDs (exclude 00 and FF which are reserved). Many meshes group have multiple repeaters with the same first byte in their public keys. Packets continue to pass through repeaters and the mesh is not harmed in any way. It does make it harder for tools to analyze paths with duplicated repeater IDs. +However, with 1 byte, there are only 254 unique IDs (exclude 00 and FF which are reserved). Many meshes group have multiple repeaters with the same first byte in their public keys. Packets continue to pass through repeaters and the mesh is not harmed in any way. It does make it harder for tools to analyze paths with duplicated repeater IDs. -Firmware version 1.14 and newer introduces the ability for repeaters to advert with 1-, 2-, or 3-byte adverts. Companions can also send out channel and direct messages with 1-, 2-, or 3-byte path. Adverts and messages sent in 1-byte path is compatible with repeater firmware older or newer than 1.14. They will travel up to 64 hops. 2-byte adverts and messages will travel up to 32 hops. 3-byte adverts and messages will travel up to 21 hops. +Firmware version 1.14 and newer introduces the ability for repeaters to advert with 1-, 2-, or 3-byte adverts. Companions can also send out channel and direct messages with 1-, 2-, or 3-byte path. Adverts and messages sent in 1-byte path is compatible with repeater firmware older or newer than 1.14. They will travel up to 64 hops. 2-byte adverts and messages will travel up to 32 hops. 3-byte adverts and messages will travel up to 21 hops. ### 3.9.1. Q: **What path hash sizes will my repeater forward?** @@ -315,7 +315,7 @@ The original packet sender determines the path hash size. The most common origin ### 3.9.3. Q: **How do I change my companion's path hash size?** -As of firmware version 1.14 and MeshCore app version 1.41.0, in the MeshCore app, you can set your companion's message path hash size in `Settings (gear icon)`, `Experimental Settings`. +As of firmware version 1.14 and MeshCore app version 1.41.0, in the MeshCore app, you can set your companion's message path hash size in `Settings (gear icon)`, `Experimental Settings`. Until your regional mesh has the vast majority of the repeaters updated to 1.14+ firmware, it is recommended to keep your companion at the default 1-byte because pre-1.14 repeaters will silently drop messages with larger path hashes. @@ -341,11 +341,11 @@ It is safe to set your 1.14+ repeaters to mode 1 or 2. ### 3.9.5. Q: **Why use 2- or 3-byte path hash for adverts?** -A longer path hash helps tools like the LetsMesh.net Analyzer and MeshMapper disambiguate repeaters more reliably. With only 1 byte, the chance of different repeaters having the same first byte in their public key is high, making it harder to tell them apart in mesh network analysis. Since this only affects adverts, there's no downside. 2- and 3-byte adverts don't travel as far as 1-byte adverts, but it is not important for MeshCore nodes to hear a repeater's advert that are 21 or 32 hops away. +A longer path hash helps tools like the LetsMesh.net Analyzer and MeshMapper disambiguate repeaters more reliably. With only 1 byte, the chance of different repeaters having the same first byte in their public key is high, making it harder to tell them apart in mesh network analysis. Since this only affects adverts, there's no downside. 2- and 3-byte adverts don't travel as far as 1-byte adverts, but it is not important for MeshCore nodes to hear a repeater's advert that is 21 or 32 hops away. ### 3.9.6. Q: **When can we move away from 1-byte path hash for channel and direct messages?** -You should move to send 2-byte or 3-byte channel and direct messages when the vast majority of the repeaters in your regional mesh are updated to firmware version 1.14 or newer. Setting your repeater's `path.hash.mode` to 1 (for 2-byte path hash) or 2 (for 3-byte path hash) now helps the community gauge to how many repeaters have updated to 1.14+. Please work with your MeshCore community together to decide when to switch to 2-byte path or 3-byte path for channel and direct messages. +You should move to send 2-byte or 3-byte channel and direct messages when the vast majority of the repeaters in your regional mesh are updated to firmware version 1.14 or newer. Setting your repeater's `path.hash.mode` to 1 (for 2-byte path hash) or 2 (for 3-byte path hash) now helps the community gauge to how many repeaters have updated to 1.14+. Please work with your MeshCore community together to decide when to switch to 2-byte path or 3-byte path for channel and direct messages. --- @@ -370,7 +370,7 @@ You should move to send 2-byte or 3-byte channel and direct messages when the va ### 4.3. Q: Why is my T-Deck Plus not getting any satellite lock? **A:** For T-Deck Plus, the GPS baud rate should be set to **38400**. Also, some T-Deck Plus devices were found to have the GPS module installed upside down, with the GPS antenna facing down instead of up. If your T-Deck Plus still doesn't get any satellite lock after setting the baud rate to 38400, you might need to open the device to check the GPS orientation. -GPS on T-Deck is always enabled. You can skip the "GPS clock sync" and the T-Deck will continue to try to get a GPS lock. You can go to the `GPS Info` screen; you should see the `Sentences:` counter increasing if the baud rate is correct. +GPS on T-Deck is always enabled. You can skip the "GPS clock sync" and the T-Deck will continue to try to get a GPS lock. You can go to the `GPS Info` screen; you should see the `Sentences:` counter increasing if the baud rate is correct. [Source](https://discord.com/channels/826570251612323860/1330643963501351004/1356609240302616689) @@ -385,11 +385,11 @@ GPS on T-Deck is always enabled. You can skip the "GPS clock sync" and the T-De T-Deck uses the same key the smartphone apps use but in base64 `izOH6cXN6mrJ5e26oRXNcg==` -There is no `=` key on the T-Deck's hardware keyboard. You can use the on-screen software keyboard to enter `=`. Tap the text box to enable the on-screen software keyboard. +There is no `=` key on the T-Deck's hardware keyboard. You can use the on-screen software keyboard to enter `=`. Tap the text box to enable the on-screen software keyboard. The third character is the capital letter `O` (Oh), not zero `0` The smartphone app key is in hex: -` 8b3387e9c5cdea6ac9e5edbaa115cd72` +`8b3387e9c5cdea6ac9e5edbaa115cd72` [Source](https://discord.com/channels/826570251612323860/1330643963501351004/1354194409213792388) @@ -416,21 +416,22 @@ Unlock page: ### 4.10. Q: How to decipher the diagnostics screen on T-Deck? -**A:** Space is tight on T-Deck's screen, so the information is a bit cryptic. The format is : +**A:** Space is tight on T-Deck's screen, so the information is a bit cryptic. The format is : `{hops} l:{packet-length}({payload-len}) t:{packet-type} snr:{n} rssi:{n}` See here for packet-type: https://github.com/meshcore-dev/MeshCore/blob/main/src/Packet.h#L19 - - #define PAYLOAD_TYPE_REQ 0x00 // request (prefixed with dest/src hashes, MAC) (enc data: timestamp, blob) - #define PAYLOAD_TYPE_RESPONSE 0x01 // response to REQ or ANON_REQ (prefixed with dest/src hashes, MAC) (enc data: timestamp, blob) - #define PAYLOAD_TYPE_TXT_MSG 0x02 // a plain text message (prefixed with dest/src hashes, MAC) (enc data: timestamp, text) - #define PAYLOAD_TYPE_ACK 0x03 // a simple ack #define PAYLOAD_TYPE_ADVERT 0x04 // a node advertising its Identity - #define PAYLOAD_TYPE_GRP_TXT 0x05 // an (unverified) group text message (prefixed with channel hash, MAC) (enc data: timestamp, "name: msg") - #define PAYLOAD_TYPE_GRP_DATA 0x06 // an (unverified) group datagram (prefixed with channel hash, MAC) (enc data: data_type, data_len, blob) - #define PAYLOAD_TYPE_ANON_REQ 0x07 // generic request (prefixed with dest_hash, ephemeral pub_key, MAC) (enc data: ...) - #define PAYLOAD_TYPE_PATH 0x08 // returned path (prefixed with dest/src hashes, MAC) (enc data: path, extra) +``` +#define PAYLOAD_TYPE_REQ 0x00 // request (prefixed with dest/src hashes, MAC) (enc data: timestamp, blob) +#define PAYLOAD_TYPE_RESPONSE 0x01 // response to REQ or ANON_REQ (prefixed with dest/src hashes, MAC) (enc data: timestamp, blob) +#define PAYLOAD_TYPE_TXT_MSG 0x02 // a plain text message (prefixed with dest/src hashes, MAC) (enc data: timestamp, text) +#define PAYLOAD_TYPE_ACK 0x03 // a simple ack #define PAYLOAD_TYPE_ADVERT 0x04 // a node advertising its Identity +#define PAYLOAD_TYPE_GRP_TXT 0x05 // an (unverified) group text message (prefixed with channel hash, MAC) (enc data: timestamp, "name: msg") +#define PAYLOAD_TYPE_GRP_DATA 0x06 // an (unverified) group datagram (prefixed with channel hash, MAC) (enc data: data_type, data_len, blob) +#define PAYLOAD_TYPE_ANON_REQ 0x07 // generic request (prefixed with dest_hash, ephemeral pub_key, MAC) (enc data: ...) +#define PAYLOAD_TYPE_PATH 0x08 // returned path (prefixed with dest/src hashes, MAC) (enc data: path, extra) +``` [Source](https://discord.com/channels/1343693475589263471/1343693475589263474/1350611321040932966) @@ -451,7 +452,7 @@ https://github.com/meshcore-dev/MeshCore/blob/main/src/Packet.h#L19 ### 4.14. Q: How to capture a screenshot on T-Deck? -**A:** To capture a screenshot on a T-Deck, long press the top-left corner of the screen. The screenshot is saved to the microSD card, if one is inserted into the device. +**A:** To capture a screenshot on a T-Deck, long press the top-left corner of the screen. The screenshot is saved to the microSD card, if one is inserted into the device. --- @@ -467,7 +468,7 @@ https://github.com/meshcore-dev/MeshCore/blob/main/src/Packet.h#L19 **CR is coding rate** - from: https://www.thethingsnetwork.org/docs/lorawan/fec-and-code-rate/ -TL;DR: default CR to 5 for good stable links. If it is not a solid link and is intermittent, change CR to 7 or 8. +TL;DR: default CR to 5 for good stable links. If it is not a solid link and is intermittent, change CR to 7 or 8. Forward Error Correction is a process of adding redundant bits to the data to be transmitted. During the transmission, data may get corrupted by interference (changes from 0 to 1 / 1 to 0). These error correction bits are used at the receivers for restoring corrupted bits. @@ -484,30 +485,30 @@ For example, if the code rate is 5/7, for every 5 bits of useful information, th Making the bandwidth 2x wider (from BW125 to BW250) allows you to send 2x more bytes in the same time. Making the spreading factor 1 step lower (from SF10 to SF9) allows you to send 2x more bytes in the same time. -Lowering the spreading factor makes it more difficult for the gateway to receive a transmission, as it will be more sensitive to noise. You could compare this to two people taking in a noisy place (a bar for example). If you’re far from each other, you have to talk slow (SF10), but if you’re close, you can talk faster (SF7) +Lowering the spreading factor makes it more difficult for the gateway to receive a transmission, as it will be more sensitive to noise. You could compare this to two people talking in a noisy place (a bar for example). If you’re far from each other, you have to talk slow (SF10), but if you’re close, you can talk faster (SF7) -So, it's balancing act between speed of the transmission and resistance to noise. -things network is mainly focused on LoRaWAN, but the LoRa low-level stuff still checks out for any LoRa project +So, it's a balancing act between speed of the transmission and resistance to noise. +The Things Network is mainly focused on LoRaWAN, but the LoRa low-level stuff still checks out for any LoRa project ### 5.2. Q: Do MeshCore clients repeat? -**A:** No, MeshCore clients do not repeat. This is the core of MeshCore's messaging-first design. This is to avoid devices flooding the airwaves and create endless collisions, so messages sent aren't received. -In MeshCore, only repeaters and room server with `set repeat on` repeat. +**A:** No, MeshCore clients do not repeat. This is the core of MeshCore's messaging-first design. This is to avoid devices flooding the airwaves and create endless collisions, so messages sent aren't received. +In MeshCore, only repeaters and room servers with `set repeat on` repeat. ### 5.3. Q: What happens when a node learns a route via a mobile repeater, and that repeater is gone? -**A:** If you used to reach a node through a repeater and the repeater is no longer reachable, the client will send the message using the existing (but now broken) known path, the message will fail after 3 retries, and the app will reset the path and send the message as flood on the last retry by default. This can be turned off in settings. If the destination is reachable directly or through another repeater, the new path will be used going forward. Or you can set the path manually if you know a specific repeater to use to reach that destination. +**A:** If you used to reach a node through a repeater and the repeater is no longer reachable, the client will send the message using the existing (but now broken) known path, the message will fail after 3 retries, and the app will reset the path and send the message as flood on the last retry by default. This can be turned off in settings. If the destination is reachable directly or through another repeater, the new path will be used going forward. Or you can set the path manually if you know a specific repeater to use to reach that destination. In the case if users are moving around frequently, and the paths are breaking, they just see the phone client retries and revert to flood to attempt to re-establish a path. ### 5.4. Q: How does a node discover a path to its destination and then use it to send messages in the future, instead of flooding every message it sends like Meshtastic? -Routes are stored in sender's contact list. When you send a message the first time, the message first gets to your destination by flood routing. When your destination node gets the message, it will send back a delivery report to the sender with all repeaters that the original message went through. This delivery report is flood-routed back to you the sender and is a basis for future direct path. When you send the next message, the path will get embedded into the packet and be evaluated by repeaters. If the hop and address of the repeater matches, it will retransmit the message, otherwise it will not retransmit, hence minimizing utilization. +Routes are stored in sender's contact list. When you send a message the first time, the message first gets to your destination by flood routing. When your destination node gets the message, it will send back a delivery report to the sender with all repeaters that the original message went through. This delivery report is flood-routed back to you the sender and is a basis for future direct path. When you send the next message, the path will get embedded into the packet and be evaluated by repeaters. If the hop and address of the repeater matches, it will retransmit the message, otherwise it will not retransmit, hence minimizing utilization. [Source](https://discord.com/channels/826570251612323860/1330643963501351004/1351279141630119996) ### 5.5. Q: Do public channels always flood? Do private channels always flood? -**A:** Yes, group channels are A to B, so there is no defined path. They have to flood. Repeaters can however deny flood traffic up to some hop limit, with the `set flood.max` CLI command. Administrators of repeaters get to set the rules of their repeaters. +**A:** Yes, group channels are A to B, so there is no defined path. They have to flood. Repeaters can however deny flood traffic up to some hop limit, with the `set flood.max` CLI command. Administrators of repeaters get to set the rules of their repeaters. [Source](https://discord.com/channels/1343693475589263471/1343693475589263474/1350023009527664672) @@ -530,7 +531,7 @@ The third character is the capital letter 'O', not zero `0` Support Liam Cottle's smartphone client development by unlocking the server administration wait gate with in-app purchase -Support Rastislav Vysoky (recrof)'s flasher web site and the map web site development through [PayPal](https://www.paypal.com/donate/?business=DREHF5HM265ES&no_recurring=0&item_name=If+you+enjoy+my+work%2C+you+can+support+me+here%3A¤cy_code=EUR) or [Revolut](https://revolut.me/recrof) +Support Rastislav Vysoky (recrof)'s flasher website and the map website development through [PayPal](https://www.paypal.com/donate/?business=DREHF5HM265ES&no_recurring=0&item_name=If+you+enjoy+my+work%2C+you+can+support+me+here%3A¤cy_code=EUR) or [Revolut](https://revolut.me/recrof) ### 5.9. Q: How do I build MeshCore firmware from source? **A:** See instructions here: @@ -564,12 +565,12 @@ pio run -e RAK_4631_Repeater then you'll find `firmware.zip` in `.pio/build/RAK_4631_Repeater` Andy also has a video on how to build using VS Code: -*How to build and flash Meshcore repeater firmware | Heltec V3* +*How to build and flash MeshCore repeater firmware | Heltec V3* *(Link referenced in the Discord post)* ### 5.10. Q: Are there other MeshCore related open source projects? -**A:** [Liam Cottle](https://liamcottle.net)'s MeshCore web client and MeshCore Javascript library are open source under MIT license. +**A:** [Liam Cottle](https://liamcottle.net)'s MeshCore web client and MeshCore JavaScript library are open source under MIT license. Web client: https://github.com/liamcottle/meshcore-web Javascript: https://github.com/liamcottle/meshcore.js @@ -589,7 +590,7 @@ This could change in the future if MeshCore develops a client firmware that repe ### 5.12. Q: How do I add a node to the [MeshCore Map](https://map.meshcore.io) **A:** -To add a BLE Companion radio, connect to the BLE Companion radio from the MeshCore smartphone app. In the app, tap the `3 dot` menu icon at the top right corner, then tap `Internet Map`. Tap the `3 dot` menu icon again and choose `Add me to the Map` +To add a BLE Companion radio, connect to the BLE Companion radio from the MeshCore smartphone app. In the app, tap the `3 dot` menu icon at the top right corner, then tap `Internet Map`. Tap the `3 dot` menu icon again and choose `Add me to the Map` To add a Repeater or Room Server to the map, go to the Contact List, tap the `3 dot` next to the Repeater or Room Server you want to add to the Internet Map, tap `Share`, then tap `Upload to Internet Map`. @@ -604,13 +605,13 @@ Below are the instructions to flash firmware onto a supported LoRa device using For ESP-based devices (e.g. Heltec V3) you need: - Download firmware file from https://flasher.meshcore.io - - Go to the web site on a browser, find the section that has the firmware you need - - Click the Download button, right click on the file you need, for example, + - Go to the website on a browser, find the section that has the firmware you need + - Click the Download button, right-click on the file you need, for example, - `Heltec_V3_companion_radio_ble-v1.7.1-165fb33.bin` - Non-merged bin keeps the existing Bluetooth pairing database - `Heltec_v3_companion_radio_usb-v1.7.1-165fb33-merged.bin` - Merged bin overwrites everything including the bootloader, existing Bluetooth pairing database, but keeps configurations. - - Right click on the file name and copy the link and note it for later use here is an example: `https://flasher.meshcore.io/releases/download/companion-v1.7.1/Heltec_v3_companion_radio_ble-v1.7.1-165fb33.bin` + - Right-click on the file name and copy the link and note it for later use here is an example: `https://flasher.meshcore.io/releases/download/companion-v1.7.1/Heltec_v3_companion_radio_ble-v1.7.1-165fb33.bin` - Run: - `wget https://flasher.meshcore.io/releases/download/companion-v1.7.1/Heltec_v3_companion_radio_ble-v1.7.1-165fb33.bin` to download the firmware file for your device type. or the version you need - USB, BLE, Repeater, Room Server, merged bin or non-merged bin - If the above wget command only downloads a very small file (10K bytes instead of more than 100K byte, use this command instead: @@ -632,11 +633,11 @@ For ESP-based devices (e.g. Heltec V3) you need: For nRF devices (e.g. RAK, Heltec T114) you need the following: - Download firmware file from https://flasher.meshcore.io - - Go to the web site on a browser, find the section that has the firmware you need + - Go to the website on a browser, find the section that has the firmware you need - You need the ZIP version for the adafruit flash tool (below) - - Click the Download button, right click on the ZIP file, for example: + - Click the Download button, right-click on the ZIP file, for example: - `RAK_4631_companion_radio_ble-v1.7.1-165fb33.zip` - - Right click on the file name and copy the link and note it for later use here is an example: `https://flasher.meshcore.io/releases/download/companion-v1.7.1/RAK_4631_companion_radio_ble-v1.7.1-165fb33.zip` + - Right-click on the file name and copy the link and note it for later use here is an example: `https://flasher.meshcore.io/releases/download/companion-v1.7.1/RAK_4631_companion_radio_ble-v1.7.1-165fb33.zip` - Run: - `wget https://flasher.meshcore.io/releases/download/companion-v1.7.1/RAK_4631_companion_radio_ble-v1.7.1-165fb33.zip` to download the firmware file for your device type. or the version you need - USB, BLE, Repeater, Room Server, ZIP file only - Confirm the `ttyXXXX` device path on your Raspberry Pi: @@ -648,25 +649,25 @@ For nRF devices (e.g. RAK, Heltec T114) you need the following: - `adafruit-nrfutil --verbose dfu serial --package RAK_4631_companion_radio_usb-v1.7.1-165fb33.zip -p /dev/ttyACM0 -b 115200 --singlebank --touch 1200` -To manage a repeater or room server connected to a Pi over USB serial using shell commands, you need to install `picocom`. To install `picocom`, run the following command: +To manage a repeater or room server connected to a Pi over USB serial using shell commands, you need to install `picocom`. To install `picocom`, run the following command: - `sudo apt install picocom` To start managing your USB serial-connected device using picocom, use the following command: - - `picocom -b 115200 /dev/ttyUSB0 --imap lfcrlf` +- `picocom -b 115200 /dev/ttyUSB0 --imap lfcrlf` -From here, reference repeater and room server command line commands on MeshCore github wiki here: - - https://github.com/meshcore-dev/MeshCore/wiki/Repeater-&-Room-Server-CLI-Reference +From here, reference repeater and room server command line commands in the MeshCore docs here: +- https://docs.meshcore.io/cli_commands ### 5.14. Q: Are there projects built around MeshCore? -**A:** Yes, there are many. MeshCore's protocol is open source using the MIT license. The MIT license and the open source protocol makes it very easy for the MeshCore community to build new firmware for radios, applications on mobile devices, map tools, and analysis tools, and integration with other projects like Home Assistant. +**A:** Yes, there are many. MeshCore's protocol is open source using the MIT license. The MIT license and the open source protocol makes it very easy for the MeshCore community to build new firmware for radios, applications on mobile devices, map tools, and analysis tools, and integration with other projects like Home Assistant. -As new MeshCore community projects become available on a weekly basis, we have stopped tracking them here in this FAQ. [samuk](https://github.com/samuk) maintains a very exhaustive list of MeshCore community project at https://github.com/samuk/awesome-meshcore/blob/main/README.md. samuk accepts PRs and merges them regularly. +As new MeshCore community projects become available on a weekly basis, we have stopped tracking them here in this FAQ. [samuk](https://github.com/samuk) maintains a very exhaustive list of MeshCore community project at https://github.com/samuk/awesome-meshcore/blob/main/README.md. samuk accepts PRs and merges them regularly. ### 5.15. Q: Are there client applications for Windows or Mac? -**A:** Yes, the same iOS and Android client is also available for Windows and Mac. You can find them together with the Android APK here: +**A:** Yes, the same iOS and Android client is also available for Windows and Mac. You can find them together with the Android APK here: https://files.liamcottle.net/MeshCore Both the Windows and Mac versions of the client app are fully unlocked and are free to use. @@ -678,8 +679,8 @@ The Comms Channel on YouTube: https://www.youtube.com/watch?v=guDoKGs02Us MeshCore Advantages by MCarper: https://github.com/mikecarper/meshfirmware/blob/main/MeshCoreAdvantages.md -Meshcore vs Meshtastic by austinmesh.org -https://www.austinmesh.org/learn/meshcore-vs-meshtastic/ +MeshCore vs Meshtastic by austinmesh.org +https://www.austinmesh.org/learn/meshcore-vs-meshtastic --- @@ -695,7 +696,7 @@ https://www.austinmesh.org/learn/meshcore-vs-meshtastic/ You can get the epoch time on and use it to set your T-Deck clock. For a repeater and room server, the admin can use a T-Deck to remotely set their clock (clock sync), or use the `time` command in the USB serial console with the server device connected. ### 6.3. Q: How to connect to a repeater via BLE (Bluetooth)? -**A:** You can't connect to a device running repeater firmware via Bluetooth. Devices running the BLE companion firmware you can connect to it via Bluetooth using the android app +**A:** You can't connect to a device running repeater firmware via Bluetooth. You can connect to devices running the BLE companion firmware via Bluetooth using the Android app. ### 6.4. Q: My companion isn't showing up over Bluetooth? @@ -705,9 +706,9 @@ You can get the epoch time on and use it to se **A:** the default Bluetooth pairing code is `123456` -### 6.6. Q: My Heltec V3 keeps disconnecting from my smartphone. It can't hold a solid Bluetooth connection. +### 6.6. Q: My Heltec V3 keeps disconnecting from my smartphone. It can't hold a solid Bluetooth connection. -**A:** Heltec V3 has a very small coil antenna on its PCB for Wi-Fi and Bluetooth connectivity. It has a very short range, only a few feet. It is possible to remove the coil antenna and replace it with a 31mm wire. The BT range is much improved with the modification. +**A:** Heltec V3 has a very small coil antenna on its PCB for Wi-Fi and Bluetooth connectivity. It has a very short range, only a few feet. It is possible to remove the coil antenna and replace it with a 31mm wire. The BT range is much improved with the modification. ### 6.7. Q: My RAK/T1000-E/xiao_nRF52 device seems to be corrupted, how do I wipe it clean to start fresh? @@ -716,18 +717,18 @@ You can get the epoch time on and use it to se - For RAK, click the reset button **TWICE** - For T1000-e, quickly disconnect and reconnect the magnetic side of the cable from the device **TWICE** - For Heltec T114, click the reset button **TWICE** (the bottom button) - - For Xiao nRF52, click the reset button once. If that doesn't work, quickly double click the reset button twice. If that doesn't work, disconnect the board from your PC and reconnect again ([seeed studio wiki](https://wiki.seeedstudio.com/XIAO_BLE/#access-the-swd-pins-for-debugging-and-reflashing-bootloader)) + - For Xiao nRF52, click the reset button once. If that doesn't work, quickly double-click the reset button twice. If that doesn't work, disconnect the board from your PC and reconnect again ([seeed studio wiki](https://wiki.seeedstudio.com/XIAO_BLE/#access-the-swd-pins-for-debugging-and-reflashing-bootloader)) 2. A new folder will appear on your computer's desktop 3. Download the `flash_erase*.uf2` file for your device on https://flasher.meshcore.io - RAK WisBlock and Heltec T114: `Flash_erase-nRF32_softdevice_v6.uf2` - Seeed Studio Xiao nRF52 WIO: `Flash_erase-nRF52_softdevice_v7.uf2` 4. drag and drop the uf2 file for your device to the root of the new folder -5. Wait for the copy to complete. You might get an error dialog, you can ignore it +5. Wait for the copy to complete. You might get an error dialog, you can ignore it 6. Go to https://flasher.meshcore.io, click `Console` and select the serial port for your connected device -7. In the console, press enter. Your flash should now be erased +7. In the console, press enter. Your flash should now be erased 8. You may now flash the latest MeshCore firmware onto your device -Separately, starting in firmware version 1.7.0, there is a CLI Rescue mode. If your device has a user button (e.g. some RAK, T114), you can activate the rescue mode by hold down the user button of the device within 8 seconds of boot. Then you can use the 'Console' on https://flasher.meshcore.io +Separately, starting in firmware version 1.7.0, there is a CLI Rescue mode. If your device has a user button (e.g. some RAK, T114), you can activate the rescue mode by holding down the user button of the device within 8 seconds of boot. Then you can use the 'Console' on https://flasher.meshcore.io ### 6.8. Q: WebFlasher fails on Linux with failed to open @@ -740,26 +741,26 @@ Allow the browser user on it: --- ## 7. Other Questions: -### 7.1. Q: How to update nRF (RAK, T114, Seed XIAO) companion, repeater and room server firmware over the air using the new simpler DFU app? +### 7.1. Q: How to update nRF (RAK, T114, Seeed XIAO) companion, repeater and room server firmware over the air using the new simpler DFU app? **A:** The steps below work on both Android and iOS as nRF has made both apps' user interface the same on both platforms: 1. Download nRF's DFU app from iOS App Store or Android's Play Store, you can find the app by searching for `nrf dfu`, the app's full name is `nRF Device Firmware Update` 2. On https://flasher.meshcore.io, download the **ZIP** version of the firmware for your nRF device (e.g. RAK or Heltec T114 or Seeed Studio's Xiao) -3. From the MeshCore app, login remotely to the repeater you want to update with admin privilege +3. From the MeshCore app, log in remotely to the repeater you want to update with admin privileges 4. Go to the Command Line tab, type `start ota` and hit enter. -5. you should see `OK` to confirm the repeater device is now in OTA mode -6. Run the DFU app,tab `Settings` on the top right corner -7. Enable `Packets receipt notifications`, and change `Number of Packets` to 10 for RAK, 8 for T114. 8 also works for RAK. +5. You should see `OK` to confirm the repeater device is now in OTA mode +6. Run the DFU app, tap `Settings` on the top right corner +7. Enable `Packet receipt notifications`, and change `Number of Packets` to 10 for RAK, 8 for T114. 8 also works for RAK. 8. Select the firmware zip file you downloaded -9. Select the device you want to update. If the device you want to update is not on the list, try enabling`OTA` on the device again +9. Select the device you want to update. If the device you want to update is not on the list, try enabling `OTA` on the device again 10. If the device is not found, enable `Force Scanning` in the DFU app -11. Tab the `Upload` to begin OTA update -12. If it fails, try turning off and on Bluetooth on your phone. If that doesn't work, try rebooting your phone. If you keep getting failures at the "Enabling Bootloader" step, try forgetting the NRF board in your iOS or Android device's bluetooth settings and re-pair it through the DFU app. -13. Wait for the update to complete. It can take a few minutes. -14. It is strongly recommended that you install and use the OTAFIX bootloader at https://github.com/oltaco/Adafruit_nRF52_Bootloader_OTAFIX. -15. To update a companion node over OTA, it must be running companion firmware v1.15 or greater. -16. Please see the MeshCore Blog for additional information on OTA firmware flashing: +11. Tap `Upload` to begin OTA update +12. If it fails, try toggling Bluetooth on your phone. If that doesn't work, try rebooting your phone. If you keep getting failures at the "Enabling Bootloader" step, try forgetting the nRF board in your iOS or Android device's Bluetooth settings and re-pair it through the DFU app. +13. Wait for the update to complete. It can take a few minutes. +14. It is strongly recommended that you install and use the OTAFIX bootloader at https://github.com/oltaco/Adafruit_nRF52_Bootloader_OTAFIX. +15. To update a companion node over OTA, it must be running companion firmware v1.15 or greater. +16. Please see the MeshCore Blog for additional information on OTA firmware flashing: - https://blog.meshcore.io/2026/04/06/otafix-bootloader - https://blog.meshcore.io/2026/04/02/nrf-ota-update @@ -768,14 +769,14 @@ Allow the browser user on it: **A:** You can flash this safer bootloader to the Wio Tracker L1 Pro https://github.com/oltaco/Adafruit_nRF52_Bootloader_OTAFIX -After this bootloader is flashed onto the device, you can trigger over the air update using bluetooth by holding the button next to the D-Pad and then click the reset button. The follow the same OTA update instructions above. You can skip pass the `start ota` instruction and start the update using the DFU app. +After this bootloader is flashed onto the device, you can trigger an over-the-air update using Bluetooth by holding the button next to the D-Pad and then clicking the reset button. Then follow the same OTA update instructions above. You can skip the `start ota` instruction and start the update using the DFU app. ### 7.2. Q: How to update ESP32-based devices over the air? **A:** For ESP32-based devices (e.g. Heltec V3): 1. On https://flasher.meshcore.io, download the **non-merged** version of the firmware for your ESP32 device (e.g. `Heltec_v3_repeater-v1.6.2-4449fd3.bin`, no `"merged"` in the file name) -2. From the MeshCore app, login remotely to the repeater you want to update with admin privilege +2. From the MeshCore app, log in remotely to the repeater you want to update with admin privileges 3. Go to the Command Line tab, type `start ota` and hit enter. 4. you should see `OK` to confirm the repeater device is now in OTA mode 5. The command `start ota` on an ESP32-based device starts a Wi-Fi hotspot named `MeshCore OTA` @@ -785,7 +786,7 @@ After this bootloader is flashed onto the device, you can trigger over the air u ### 7.3. Q: Is there a way to lower the chance of a failed OTA device firmware update (DFU)? -**A:** Yes, developer `che aporeps` has an enhanced OTA DFU bootloader for nRF52 based devices. With this bootloader, if it detects that the application firmware is invalid, it falls back to OTA DFU mode so you can attempt to flash again to recover. This bootloader has other changes to make the OTA DFU process more fault tolerant. +**A:** Yes, developer `che aporeps` has an enhanced OTA DFU bootloader for nRF52 based devices. With this bootloader, if it detects that the application firmware is invalid, it falls back to OTA DFU mode so you can attempt to flash again to recover. This bootloader has other changes to make the OTA DFU process more fault tolerant. Refer to https://github.com/oltaco/Adafruit_nRF52_Bootloader_OTAFIX for the latest information. @@ -796,12 +797,12 @@ Currently, the following boards are supported: - Seeed Studio Wio Tracker L1 - Seeed Studio XIAO nRF52840 BLE - Seeed Studio XIAO nRF52840 BLE SENSE -- RAK 4631 +- RAK 4631 - RAK WisMesh Tag (new 28/11/2025) ### 7.4. Q: are the MeshCore logo and font available? -**A:** Yes, it is on the MeshCore github repo here: +**A:** Yes, it is on the MeshCore GitHub repo here: https://github.com/meshcore-dev/MeshCore/tree/main/logo ### 7.5. Q: What is the format of a contact or channel QR code? @@ -819,14 +820,14 @@ where `&type` is: `room = 3` `sensor = 4` -### 7.6. Q: How do I connect to the companion via Wi-Fi, e.g. using a heltec v3? +### 7.6. Q: How do I connect to the companion via Wi-Fi, e.g. using a Heltec V3? **A:** -Wi-Fi firmware requires you to compile it yourself, as you need to set the Wi-Fi ssid and password. +Wi-Fi firmware requires you to compile it yourself, as you need to set the Wi-Fi SSID and password. Edit WIFI_SSID and WIFI_PWD in `./variants/heltec_v3/platformio.ini` and then flash it to your device. -### 7.7. Q: I have a Station G2, or a Heltec V4, or an Ikoka Stick, or a radio with a EByte E22-900M30S or a E22-900M33S module, what should their transmit power be set to? +### 7.7. Q: I have a Station G2, or a Heltec V4, or an Ikoka Stick, or a radio with an EByte E22-900M30S or an EByte E22-900M33S module, what should their transmit power be set to? **A:** -For companion radios, you can set these radios' transmit power in the smartphone app. For repeater and room server radios, you can set their transmit power using the command line command `set tx`. You can get their current value using command line command `get tx` +For companion radios, you can set these radios' transmit power in the smartphone app. For repeater and room server radios, you can set their transmit power using the command line command `set tx`. You can get their current value using command line command `get tx` ⚠️ **WARNING: Set these values at your own risk. Incorrect power settings can permanently damage your radio hardware.** @@ -842,5 +843,3 @@ For companion radios, you can set these radios' transmit power in the smartphone | **Ikoka Stick E22-900M33S** | 2W Model | 9 dBm | 2W | **DO NOT EXCEED** (Risk of burn out) [data sheet](https://www.cdebyte.com/pdf-down.aspx?id=4216) Refer to your local government's requirements | | **Heltec V4** | Standard Output | 10 dBm | 22 dBm (~0.15W) | | | | High Output | 22 dBm | 28 dBm (~0.5W to 0.6W) | | - ---- diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp index 400cbca8..2354be90 100644 --- a/examples/companion_radio/MyMesh.cpp +++ b/examples/companion_radio/MyMesh.cpp @@ -1112,7 +1112,7 @@ void MyMesh::handleCmdFrame(size_t len) { } else { writeErrFrame(recipient == NULL ? ERR_CODE_NOT_FOUND - : ERR_CODE_UNSUPPORTED_CMD); // unknown recipient, or unsuported TXT_TYPE_* + : ERR_CODE_UNSUPPORTED_CMD); // unknown recipient, or unsupported TXT_TYPE_* } } else if (cmd_frame[0] == CMD_SEND_CHANNEL_TXT_MSG) { // send GroupChannel text msg int i = 1; diff --git a/examples/companion_radio/ui-new/UITask.cpp b/examples/companion_radio/ui-new/UITask.cpp index ee12ca74..c84f8880 100644 --- a/examples/companion_radio/ui-new/UITask.cpp +++ b/examples/companion_radio/ui-new/UITask.cpp @@ -875,7 +875,7 @@ char UITask::handleLongPress(char c) { } char UITask::handleDoubleClick(char c) { - MESH_DEBUG_PRINTLN("UITask: double click triggered"); + MESH_DEBUG_PRINTLN("UITask: double-click triggered"); checkDisplayOn(c); return c; } diff --git a/examples/companion_radio/ui-tiny/UITask.cpp b/examples/companion_radio/ui-tiny/UITask.cpp index 45a07a02..81b2c354 100644 --- a/examples/companion_radio/ui-tiny/UITask.cpp +++ b/examples/companion_radio/ui-tiny/UITask.cpp @@ -699,8 +699,8 @@ void UITask::loop() { _display->drawRect(p, y, _display->width() - p*2, y); _display->drawTextCentered(_display->width() / 2, y + p*3, _alert); _next_refresh = _alert_expiry; // will need refresh when alert is dismissed - } - + } + _display->endFrame(); } #if AUTO_OFF_MILLIS > 0 @@ -762,7 +762,7 @@ char UITask::handleLongPress(char c) { } char UITask::handleDoubleClick(char c) { - MESH_DEBUG_PRINTLN("UITask: double click triggered"); + MESH_DEBUG_PRINTLN("UITask: double-click triggered"); checkDisplayOn(c); return c; } diff --git a/examples/simple_room_server/MyMesh.cpp b/examples/simple_room_server/MyMesh.cpp index 71a3c93a..e3710d27 100644 --- a/examples/simple_room_server/MyMesh.cpp +++ b/examples/simple_room_server/MyMesh.cpp @@ -982,7 +982,7 @@ void MyMesh::loop() { if (did_push) { next_push = futureMillis(SYNC_PUSH_INTERVAL); } else { - // were no unsynced posts for curr client, so proccess next client much quicker! (in next loop()) + // were no unsynced posts for curr client, so process next client much quicker! (in next loop()) next_push = futureMillis(SYNC_PUSH_INTERVAL / 8); } } diff --git a/src/Mesh.h b/src/Mesh.h index d53d6d25..2302d6b5 100644 --- a/src/Mesh.h +++ b/src/Mesh.h @@ -45,7 +45,7 @@ protected: /** * \brief Called _before_ the packet is dispatched to the on..Recv() methods. - * \returns true, if given packet should be NOT be processed. + * \returns true, if given packet should NOT be processed. */ virtual bool filterRecvFloodPacket(Packet* packet) { return false; } @@ -107,7 +107,7 @@ protected: /** * \brief A path TO peer (sender_idx) has been received. (also with optional 'extra' data encoded) - * NOTE: these can be received multiple times (per sender), via differen routes + * NOTE: these can be received multiple times (per sender), via different routes * \param sender_idx index of peer, [0..n) where n is what searchPeersByHash() returned * \param secret the pre-calculated shared-secret (handy for sending response packet) * \returns true, if path was accepted and that reciprocal path should be sent @@ -130,7 +130,7 @@ protected: /** * \brief A path TO 'sender' has been received. (also with optional 'extra' data encoded) - * NOTE: these can be received multiple times (per sender), via differen routes + * NOTE: these can be received multiple times (per sender), via different routes */ virtual void onPathRecv(Packet* packet, Identity& sender, uint8_t* path, uint8_t path_len, uint8_t extra_type, uint8_t* extra, uint8_t extra_len) { } @@ -212,12 +212,12 @@ public: void sendDirect(Packet* packet, const uint8_t* path, uint8_t path_len, uint32_t delay_millis=0); /** - * \brief send a locally-generated Packet to just neigbor nodes (zero hops) + * \brief send a locally-generated Packet to just neighbor nodes (zero hops) */ void sendZeroHop(Packet* packet, uint32_t delay_millis=0); /** - * \brief send a locally-generated Packet to just neigbor nodes (zero hops), with specific transort codes + * \brief send a locally-generated Packet to just neighbor nodes (zero hops), with specific transport codes * \param transport_codes array of 2 codes to attach to packet */ void sendZeroHop(Packet* packet, uint16_t* transport_codes, uint32_t delay_millis=0); diff --git a/src/helpers/sensors/RAK12035_SoilMoisture.cpp b/src/helpers/sensors/RAK12035_SoilMoisture.cpp index cc3aed55..8b291306 100644 --- a/src/helpers/sensors/RAK12035_SoilMoisture.cpp +++ b/src/helpers/sensors/RAK12035_SoilMoisture.cpp @@ -69,7 +69,7 @@ void RAK12035_SoilMoisture::setup(TwoWire &i2c) // // *** This code does not support three sensors *** // The RAK12023 has three connectors, but each of the sensors attached must -// all have a different I2C addresses. +// all have different I2C addresses. // This code has a function to set the I2C address of a sensor // and currently only supports one address 0x20 (the default). // To support three sensors, EnvironmentSensorManager would need to be modified @@ -242,7 +242,7 @@ bool RAK12035_SoilMoisture::sensor_sleep() //Command 06 // Optional: turn off sensor power AFTER successful sleep command // This has been commented out due to a pin name conflict with the Heltec v3 -// This will need to be resolved if this funstion is to be utilized in the future +// This will need to be resolved if this function is to be utilized in the future /* digitalWrite(WB_IO2, LOW); */ @@ -376,7 +376,7 @@ uint16_t RAK12035_SoilMoisture::get_humidity_zero() //Command 0B * getEvent() - High-level function to read both moisture and temperature in one call. * *------------------------------------------------------------------------------------------* * This function reads the moisture percentage and temperature from the sensor and returns * - * them via output parameters. This may be used for the telemerty delivery in the MeshCore * + * them via output parameters. This may be used for the telemetry delivery in the MeshCore * * firmware, with a single function to get all sensor data. * * * * The function returns true if both readings were successfully obtained, or false if any * @@ -417,7 +417,7 @@ bool RAK12035_SoilMoisture::sensor_on() { uint8_t data; // This has been commented out due to a pin name conflict with the Heltec v3 - // This will need to be resolved if this funstion is to be utilized in the future + // This will need to be resolved if this function is to be utilized in the future /* pinMode(WB_IO2, OUTPUT); @@ -460,7 +460,7 @@ bool RAK12035_SoilMoisture::reset() // But might be needed if power is ever switched off. Here is tested code. // This has been commented out due to a pin name conflict with the Heltec v3 -// This will need to be resolved if this funstion is to be utilized in the future +// This will need to be resolved if this function is to be utilized in the future /* pinMode(WB_IO4, OUTPUT); //Set IO4 Pin to Output (connected to *reset on sensor) diff --git a/src/helpers/ui/OLEDDisplay.cpp b/src/helpers/ui/OLEDDisplay.cpp index 19101344..a5d647a7 100644 --- a/src/helpers/ui/OLEDDisplay.cpp +++ b/src/helpers/ui/OLEDDisplay.cpp @@ -842,7 +842,7 @@ void OLEDDisplay::drawLogBuffer(uint16_t xMove, uint16_t yMove) { uint16_t lastPos = 0; for (uint16_t i=0;ilogBufferFilled;i++){ - // Everytime we have a \n print + // Every time we have a \n print if (this->logBuffer[i] == 10) { length++; // Draw string on line `line` from lastPos to length @@ -1155,7 +1155,7 @@ void OLEDDisplay::setFontTableLookupFunction(FontTableLookupFunction function) { char DefaultFontTableLookup(const uint8_t ch) { // UTF-8 to font table index converter - // Code form http://playground.arduino.cc/Main/Utf8ascii + // Code from http://playground.arduino.cc/Main/Utf8ascii static uint8_t LASTCHAR; if (ch < 128) { // Standard ASCII-set 0..0x7F handling diff --git a/src/helpers/ui/buzzer.h b/src/helpers/ui/buzzer.h index 0a500552..53edda85 100644 --- a/src/helpers/ui/buzzer.h +++ b/src/helpers/ui/buzzer.h @@ -5,7 +5,7 @@ /* class abstracts underlying RTTTL library - Just a simple imlementation to start. At the moment use same + Just a simple implementation to start. At the moment use same melody for message and discovery Suggest enum type for different sounds - on message From bf39919f15a588159a272fc8c25f99ca4a87e9a8 Mon Sep 17 00:00:00 2001 From: Sefinek Date: Tue, 2 Jun 2026 22:28:15 +0200 Subject: [PATCH 33/59] docs: remove extra FAQ TOC indentation --- docs/faq.md | 160 ++++++++++++++++++++++++++-------------------------- 1 file changed, 80 insertions(+), 80 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index d1aa7a10..6da77f9a 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -3,86 +3,86 @@ A list of frequently-asked questions and answers for MeshCore - [Frequently Asked Questions](#frequently-asked-questions) - - [1. Introduction](#1-introduction) - - [1.1. Q: What is MeshCore?](#11-q-what-is-meshcore) - - [1.2. Q: What do you need to start using MeshCore?](#12-q-what-do-you-need-to-start-using-meshcore) - - [1.2.1. Hardware](#121-hardware) - - [1.2.2. Firmware](#122-firmware) - - [1.2.3. Companion Radio Firmware](#123-companion-radio-firmware) - - [1.2.4. Repeater](#124-repeater) - - [1.2.5. Room Server](#125-room-server) - - [2. Initial Setup](#2-initial-setup) - - [2.1. Q: How many devices do I need to start using MeshCore?](#21-q-how-many-devices-do-i-need-to-start-using-meshcore) - - [2.2. Q: Does MeshCore cost any money?](#22-q-does-meshcore-cost-any-money) - - [2.3. Q: What frequencies are supported by MeshCore?](#23-q-what-frequencies-are-supported-by-meshcore) - - [2.4. Q: What is an "advert" in MeshCore?](#24-q-what-is-an-advert-in-meshcore) - - [2.5. Q: Is there a hop limit?](#25-q-is-there-a-hop-limit) - - [3. Server Administration](#3-server-administration) - - [3.1. Q: How do you configure a repeater or a room server?](#31-q-how-do-you-configure-a-repeater-or-a-room-server) - - [3.2. Q: Do I need to set the location for a repeater?](#32-q-do-i-need-to-set-the-location-for-a-repeater) - - [3.3. Q: What is the password to administer a repeater or a room server?](#33-q-what-is-the-password-to-administer-a-repeater-or-a-room-server) - - [3.4. Q: What is the password to join a room server?](#34-q-what-is-the-password-to-join-a-room-server) - - [3.5. Q: Can I retrieve a repeater's private key or set a repeater's private key?](#35-q-can-i-retrieve-a-repeaters-private-key-or-set-a-repeaters-private-key) - - [3.6. Q: The first byte of my repeater's public key collides with an existing repeater on the mesh. How do I get a new private key with a matching public key that has its first byte of my choosing?](#36-q-the-first-byte-of-my-repeaters-public-key-collides-with-an-existing-repeater-on-the-mesh-how-do-i-get-a-new-private-key-with-a-matching-public-key-that-has-its-first-byte-of-my-choosing) - - [3.7. Q: My repeater may be suffering from deafness due to high power interference near my mesh's frequency, it is not hearing other in-range MeshCore radios. What can I do?](#37-q-my-repeater-may-be-suffering-from-deafness-due-to-high-power-interference-near-my-meshs-frequency-it-is-not-hearing-other-in-range-meshcore-radios-what-can-i-do) - - [3.8. Q: How do I make my repeater an observer on the mesh?](#38-q-how-do-i-make-my-repeater-an-observer-on-the-mesh) - - [3.9. Q: What is multibyte support? What do 1-byte, 2-byte, 3-byte adverts and messages mean?](#39-q-what-is-multibyte-support-what-do-1-byte-2-byte-3-byte-adverts-and-messages-mean) - - [3.9.1. Q: **What path hash sizes will my repeater forward?**](#391-q-what-path-hash-sizes-will-my-repeater-forward) - - [3.9.2. Q: **What determines a packet's path hash size?**](#392-q-what-determines-a-packets-path-hash-size) - - [3.9.3. Q: **How do I change my companion's path hash size?**](#393-q-how-do-i-change-my-companions-path-hash-size) - - [3.9.4. Q: **What does the CLI command `path.hash.mode` do on a repeater?**](#394-q-what-does-the-cli-command-pathhashmode-do-on-a-repeater) - - [3.9.5. Q: **Why use 2- or 3-byte path hash for adverts?**](#395-q-why-use-2--or-3-byte-path-hash-for-adverts) - - [3.9.6. Q: **When can we move away from 1-byte path hash for channel and direct messages?**](#396-q-when-can-we-move-away-from-1-byte-path-hash-for-channel-and-direct-messages) - - [4. T-Deck Related](#4-t-deck-related) - - [4.1. Q: Is there a user guide for T-Deck, T-Pager, T-Watch, or T-Display Pro?](#41-q-is-there-a-user-guide-for-t-deck-t-pager-t-watch-or-t-display-pro) - - [4.2. Q: What are the steps to get a T-Deck into DFU (Device Firmware Update) mode?](#42-q-what-are-the-steps-to-get-a-t-deck-into-dfu-device-firmware-update-mode) - - [4.3. Q: Why is my T-Deck Plus not getting any satellite lock?](#43-q-why-is-my-t-deck-plus-not-getting-any-satellite-lock) - - [4.4. Q: Why is my OG (non-Plus) T-Deck not getting any satellite lock?](#44-q-why-is-my-og-non-plus-t-deck-not-getting-any-satellite-lock) - - [4.5. Q: What size of SD card does the T-Deck support?](#45-q-what-size-of-sd-card-does-the-t-deck-support) - - [4.6. Q: What is the public key for the default public channel?](#46-q-what-is-the-public-key-for-the-default-public-channel) - - [4.7. Q: How do I get maps on T-Deck?](#47-q-how-do-i-get-maps-on-t-deck) - - [4.8. Q: Where do the map tiles go?](#48-q-where-do-the-map-tiles-go) - - [4.9. Q: How to unlock deeper map zoom and server management features on T-Deck?](#49-q-how-to-unlock-deeper-map-zoom-and-server-management-features-on-t-deck) - - [4.10. Q: How to decipher the diagnostics screen on T-Deck?](#410-q-how-to-decipher-the-diagnostics-screen-on-t-deck) - - [4.11. Q: The T-Deck sound is too loud?](#411-q-the-t-deck-sound-is-too-loud) - - [4.12. Q: Can you customize the sound?](#412-q-can-you-customize-the-sound) - - [4.13. Q: What is the 'Import from Clipboard' feature on the t-deck and is there a way to manually add nodes without having to receive adverts?](#413-q-what-is-the-import-from-clipboard-feature-on-the-t-deck-and-is-there-a-way-to-manually-add-nodes-without-having-to-receive-adverts) - - [4.14. Q: How to capture a screenshot on T-Deck?](#414-q-how-to-capture-a-screenshot-on-t-deck) - - [5. General](#5-general) - - [5.1. Q: What are BW, SF, and CR?](#51-q-what-are-bw-sf-and-cr) - - [5.2. Q: Do MeshCore clients repeat?](#52-q-do-meshcore-clients-repeat) - - [5.3. Q: What happens when a node learns a route via a mobile repeater, and that repeater is gone?](#53-q-what-happens-when-a-node-learns-a-route-via-a-mobile-repeater-and-that-repeater-is-gone) - - [5.4. Q: How does a node discover a path to its destination and then use it to send messages in the future, instead of flooding every message it sends like Meshtastic?](#54-q-how-does-a-node-discover-a-path-to-its-destination-and-then-use-it-to-send-messages-in-the-future-instead-of-flooding-every-message-it-sends-like-meshtastic) - - [5.5. Q: Do public channels always flood? Do private channels always flood?](#55-q-do-public-channels-always-flood-do-private-channels-always-flood) - - [5.6. Q: What is the public key for the default public channel?](#56-q-what-is-the-public-key-for-the-default-public-channel) - - [5.7. Q: Is MeshCore open source?](#57-q-is-meshcore-open-source) - - [5.8. Q: How can I support MeshCore?](#58-q-how-can-i-support-meshcore) - - [5.9. Q: How do I build MeshCore firmware from source?](#59-q-how-do-i-build-meshcore-firmware-from-source) - - [5.10. Q: Are there other MeshCore related open source projects?](#510-q-are-there-other-meshcore-related-open-source-projects) - - [5.11. Q: Does MeshCore support ATAK](#511-q-does-meshcore-support-atak) - - [5.12. Q: How do I add a node to the MeshCore Map](#512-q-how-do-i-add-a-node-to-the-meshcore-map) - - [5.13. Q: Can I use a Raspberry Pi to update a MeshCore radio?](#513-q-can-i-use-a-raspberry-pi-to-update-a-meshcore-radio) - - [5.14. Q: Are there projects built around MeshCore?](#514-q-are-there-projects-built-around-meshcore) - - [5.15. Q: Are there client applications for Windows or Mac?](#515-q-are-there-client-applications-for-windows-or-mac) - - [5.16. Q: Are there any resources that compare MeshCore to other LoRa systems?](#516-q-are-there-any-resources-that-compare-meshcore-to-other-lora-systems) - - [6. Troubleshooting](#6-troubleshooting) - - [6.1. Q: My client says another client or a repeater or a room server was last seen many, many days ago.](#61-q-my-client-says-another-client-or-a-repeater-or-a-room-server-was-last-seen-many-many-days-ago) - - [6.2. Q: A repeater or a client or a room server I expect to see on my discover list (on T-Deck) or contact list (on a smart device client) are not listed.](#62-q-a-repeater-or-a-client-or-a-room-server-i-expect-to-see-on-my-discover-list-on-t-deck-or-contact-list-on-a-smart-device-client-are-not-listed) - - [6.3. Q: How to connect to a repeater via BLE (Bluetooth)?](#63-q-how-to-connect-to-a-repeater-via-ble-bluetooth) - - [6.4. Q: My companion isn't showing up over Bluetooth?](#64-q-my-companion-isnt-showing-up-over-bluetooth) - - [6.5. Q: I can't connect via Bluetooth, what is the Bluetooth pairing code?](#65-q-i-cant-connect-via-bluetooth-what-is-the-bluetooth-pairing-code) - - [6.6. Q: My Heltec V3 keeps disconnecting from my smartphone. It can't hold a solid Bluetooth connection.](#66-q-my-heltec-v3-keeps-disconnecting-from-my-smartphone-it-cant-hold-a-solid-bluetooth-connection) - - [6.7. Q: My RAK/T1000-E/xiao\_nRF52 device seems to be corrupted, how do I wipe it clean to start fresh?](#67-q-my-rakt1000-exiao_nrf52-device-seems-to-be-corrupted-how-do-i-wipe-it-clean-to-start-fresh) - - [6.8. Q: WebFlasher fails on Linux with failed to open](#68-q-webflasher-fails-on-linux-with-failed-to-open) - - [7. Other Questions:](#7-other-questions) - - [7.1. Q: How to update nRF (RAK, T114, Seeed XIAO) companion, repeater and room server firmware over the air using the new simpler DFU app?](#71-q-how-to-update-nrf-rak-t114-seeed-xiao-companion-repeater-and-room-server-firmware-over-the-air-using-the-new-simpler-dfu-app) - - [7.1.1 Q: Can I update Seeed Studio Wio Tracker L1 Pro using OTA?](#711-q-can-i-update-seeed-studio-wio-tracker-l1-pro-using-ota) - - [7.2. Q: How to update ESP32-based devices over the air?](#72-q-how-to-update-esp32-based-devices-over-the-air) - - [7.3. Q: Is there a way to lower the chance of a failed OTA device firmware update (DFU)?](#73-q-is-there-a-way-to-lower-the-chance-of-a-failed-ota-device-firmware-update-dfu) - - [7.4. Q: are the MeshCore logo and font available?](#74-q-are-the-meshcore-logo-and-font-available) - - [7.5. Q: What is the format of a contact or channel QR code?](#75-q-what-is-the-format-of-a-contact-or-channel-qr-code) - - [7.6. Q: How do I connect to the companion via Wi-Fi, e.g. using a Heltec V3?](#76-q-how-do-i-connect-to-the-companion-via-wi-fi-eg-using-a-heltec-v3) - - [7.7. Q: I have a Station G2, or a Heltec V4, or an Ikoka Stick, or a radio with an EByte E22-900M30S or an EByte E22-900M33S module, what should their transmit power be set to?](#77-q-i-have-a-station-g2-or-a-heltec-v4-or-an-ikoka-stick-or-a-radio-with-an-ebyte-e22-900m30s-or-an-ebyte-e22-900m33s-module-what-should-their-transmit-power-be-set-to) +- [1. Introduction](#1-introduction) + - [1.1. Q: What is MeshCore?](#11-q-what-is-meshcore) + - [1.2. Q: What do you need to start using MeshCore?](#12-q-what-do-you-need-to-start-using-meshcore) + - [1.2.1. Hardware](#121-hardware) + - [1.2.2. Firmware](#122-firmware) + - [1.2.3. Companion Radio Firmware](#123-companion-radio-firmware) + - [1.2.4. Repeater](#124-repeater) + - [1.2.5. Room Server](#125-room-server) +- [2. Initial Setup](#2-initial-setup) + - [2.1. Q: How many devices do I need to start using MeshCore?](#21-q-how-many-devices-do-i-need-to-start-using-meshcore) + - [2.2. Q: Does MeshCore cost any money?](#22-q-does-meshcore-cost-any-money) + - [2.3. Q: What frequencies are supported by MeshCore?](#23-q-what-frequencies-are-supported-by-meshcore) + - [2.4. Q: What is an "advert" in MeshCore?](#24-q-what-is-an-advert-in-meshcore) + - [2.5. Q: Is there a hop limit?](#25-q-is-there-a-hop-limit) +- [3. Server Administration](#3-server-administration) + - [3.1. Q: How do you configure a repeater or a room server?](#31-q-how-do-you-configure-a-repeater-or-a-room-server) + - [3.2. Q: Do I need to set the location for a repeater?](#32-q-do-i-need-to-set-the-location-for-a-repeater) + - [3.3. Q: What is the password to administer a repeater or a room server?](#33-q-what-is-the-password-to-administer-a-repeater-or-a-room-server) + - [3.4. Q: What is the password to join a room server?](#34-q-what-is-the-password-to-join-a-room-server) + - [3.5. Q: Can I retrieve a repeater's private key or set a repeater's private key?](#35-q-can-i-retrieve-a-repeaters-private-key-or-set-a-repeaters-private-key) + - [3.6. Q: The first byte of my repeater's public key collides with an existing repeater on the mesh. How do I get a new private key with a matching public key that has its first byte of my choosing?](#36-q-the-first-byte-of-my-repeaters-public-key-collides-with-an-existing-repeater-on-the-mesh-how-do-i-get-a-new-private-key-with-a-matching-public-key-that-has-its-first-byte-of-my-choosing) + - [3.7. Q: My repeater may be suffering from deafness due to high power interference near my mesh's frequency, it is not hearing other in-range MeshCore radios. What can I do?](#37-q-my-repeater-may-be-suffering-from-deafness-due-to-high-power-interference-near-my-meshs-frequency-it-is-not-hearing-other-in-range-meshcore-radios-what-can-i-do) + - [3.8. Q: How do I make my repeater an observer on the mesh?](#38-q-how-do-i-make-my-repeater-an-observer-on-the-mesh) + - [3.9. Q: What is multibyte support? What do 1-byte, 2-byte, 3-byte adverts and messages mean?](#39-q-what-is-multibyte-support-what-do-1-byte-2-byte-3-byte-adverts-and-messages-mean) + - [3.9.1. Q: **What path hash sizes will my repeater forward?**](#391-q-what-path-hash-sizes-will-my-repeater-forward) + - [3.9.2. Q: **What determines a packet's path hash size?**](#392-q-what-determines-a-packets-path-hash-size) + - [3.9.3. Q: **How do I change my companion's path hash size?**](#393-q-how-do-i-change-my-companions-path-hash-size) + - [3.9.4. Q: **What does the CLI command `path.hash.mode` do on a repeater?**](#394-q-what-does-the-cli-command-pathhashmode-do-on-a-repeater) + - [3.9.5. Q: **Why use 2- or 3-byte path hash for adverts?**](#395-q-why-use-2--or-3-byte-path-hash-for-adverts) + - [3.9.6. Q: **When can we move away from 1-byte path hash for channel and direct messages?**](#396-q-when-can-we-move-away-from-1-byte-path-hash-for-channel-and-direct-messages) +- [4. T-Deck Related](#4-t-deck-related) + - [4.1. Q: Is there a user guide for T-Deck, T-Pager, T-Watch, or T-Display Pro?](#41-q-is-there-a-user-guide-for-t-deck-t-pager-t-watch-or-t-display-pro) + - [4.2. Q: What are the steps to get a T-Deck into DFU (Device Firmware Update) mode?](#42-q-what-are-the-steps-to-get-a-t-deck-into-dfu-device-firmware-update-mode) + - [4.3. Q: Why is my T-Deck Plus not getting any satellite lock?](#43-q-why-is-my-t-deck-plus-not-getting-any-satellite-lock) + - [4.4. Q: Why is my OG (non-Plus) T-Deck not getting any satellite lock?](#44-q-why-is-my-og-non-plus-t-deck-not-getting-any-satellite-lock) + - [4.5. Q: What size of SD card does the T-Deck support?](#45-q-what-size-of-sd-card-does-the-t-deck-support) + - [4.6. Q: What is the public key for the default public channel?](#46-q-what-is-the-public-key-for-the-default-public-channel) + - [4.7. Q: How do I get maps on T-Deck?](#47-q-how-do-i-get-maps-on-t-deck) + - [4.8. Q: Where do the map tiles go?](#48-q-where-do-the-map-tiles-go) + - [4.9. Q: How to unlock deeper map zoom and server management features on T-Deck?](#49-q-how-to-unlock-deeper-map-zoom-and-server-management-features-on-t-deck) + - [4.10. Q: How to decipher the diagnostics screen on T-Deck?](#410-q-how-to-decipher-the-diagnostics-screen-on-t-deck) + - [4.11. Q: The T-Deck sound is too loud?](#411-q-the-t-deck-sound-is-too-loud) + - [4.12. Q: Can you customize the sound?](#412-q-can-you-customize-the-sound) + - [4.13. Q: What is the 'Import from Clipboard' feature on the t-deck and is there a way to manually add nodes without having to receive adverts?](#413-q-what-is-the-import-from-clipboard-feature-on-the-t-deck-and-is-there-a-way-to-manually-add-nodes-without-having-to-receive-adverts) + - [4.14. Q: How to capture a screenshot on T-Deck?](#414-q-how-to-capture-a-screenshot-on-t-deck) +- [5. General](#5-general) + - [5.1. Q: What are BW, SF, and CR?](#51-q-what-are-bw-sf-and-cr) + - [5.2. Q: Do MeshCore clients repeat?](#52-q-do-meshcore-clients-repeat) + - [5.3. Q: What happens when a node learns a route via a mobile repeater, and that repeater is gone?](#53-q-what-happens-when-a-node-learns-a-route-via-a-mobile-repeater-and-that-repeater-is-gone) + - [5.4. Q: How does a node discover a path to its destination and then use it to send messages in the future, instead of flooding every message it sends like Meshtastic?](#54-q-how-does-a-node-discover-a-path-to-its-destination-and-then-use-it-to-send-messages-in-the-future-instead-of-flooding-every-message-it-sends-like-meshtastic) + - [5.5. Q: Do public channels always flood? Do private channels always flood?](#55-q-do-public-channels-always-flood-do-private-channels-always-flood) + - [5.6. Q: What is the public key for the default public channel?](#56-q-what-is-the-public-key-for-the-default-public-channel) + - [5.7. Q: Is MeshCore open source?](#57-q-is-meshcore-open-source) + - [5.8. Q: How can I support MeshCore?](#58-q-how-can-i-support-meshcore) + - [5.9. Q: How do I build MeshCore firmware from source?](#59-q-how-do-i-build-meshcore-firmware-from-source) + - [5.10. Q: Are there other MeshCore related open source projects?](#510-q-are-there-other-meshcore-related-open-source-projects) + - [5.11. Q: Does MeshCore support ATAK](#511-q-does-meshcore-support-atak) + - [5.12. Q: How do I add a node to the MeshCore Map](#512-q-how-do-i-add-a-node-to-the-meshcore-map) + - [5.13. Q: Can I use a Raspberry Pi to update a MeshCore radio?](#513-q-can-i-use-a-raspberry-pi-to-update-a-meshcore-radio) + - [5.14. Q: Are there projects built around MeshCore?](#514-q-are-there-projects-built-around-meshcore) + - [5.15. Q: Are there client applications for Windows or Mac?](#515-q-are-there-client-applications-for-windows-or-mac) + - [5.16. Q: Are there any resources that compare MeshCore to other LoRa systems?](#516-q-are-there-any-resources-that-compare-meshcore-to-other-lora-systems) +- [6. Troubleshooting](#6-troubleshooting) + - [6.1. Q: My client says another client or a repeater or a room server was last seen many, many days ago.](#61-q-my-client-says-another-client-or-a-repeater-or-a-room-server-was-last-seen-many-many-days-ago) + - [6.2. Q: A repeater or a client or a room server I expect to see on my discover list (on T-Deck) or contact list (on a smart device client) are not listed.](#62-q-a-repeater-or-a-client-or-a-room-server-i-expect-to-see-on-my-discover-list-on-t-deck-or-contact-list-on-a-smart-device-client-are-not-listed) + - [6.3. Q: How to connect to a repeater via BLE (Bluetooth)?](#63-q-how-to-connect-to-a-repeater-via-ble-bluetooth) + - [6.4. Q: My companion isn't showing up over Bluetooth?](#64-q-my-companion-isnt-showing-up-over-bluetooth) + - [6.5. Q: I can't connect via Bluetooth, what is the Bluetooth pairing code?](#65-q-i-cant-connect-via-bluetooth-what-is-the-bluetooth-pairing-code) + - [6.6. Q: My Heltec V3 keeps disconnecting from my smartphone. It can't hold a solid Bluetooth connection.](#66-q-my-heltec-v3-keeps-disconnecting-from-my-smartphone-it-cant-hold-a-solid-bluetooth-connection) + - [6.7. Q: My RAK/T1000-E/xiao\_nRF52 device seems to be corrupted, how do I wipe it clean to start fresh?](#67-q-my-rakt1000-exiao_nrf52-device-seems-to-be-corrupted-how-do-i-wipe-it-clean-to-start-fresh) + - [6.8. Q: WebFlasher fails on Linux with failed to open](#68-q-webflasher-fails-on-linux-with-failed-to-open) +- [7. Other Questions:](#7-other-questions) + - [7.1. Q: How to update nRF (RAK, T114, Seeed XIAO) companion, repeater and room server firmware over the air using the new simpler DFU app?](#71-q-how-to-update-nrf-rak-t114-seeed-xiao-companion-repeater-and-room-server-firmware-over-the-air-using-the-new-simpler-dfu-app) + - [7.1.1 Q: Can I update Seeed Studio Wio Tracker L1 Pro using OTA?](#711-q-can-i-update-seeed-studio-wio-tracker-l1-pro-using-ota) + - [7.2. Q: How to update ESP32-based devices over the air?](#72-q-how-to-update-esp32-based-devices-over-the-air) + - [7.3. Q: Is there a way to lower the chance of a failed OTA device firmware update (DFU)?](#73-q-is-there-a-way-to-lower-the-chance-of-a-failed-ota-device-firmware-update-dfu) + - [7.4. Q: are the MeshCore logo and font available?](#74-q-are-the-meshcore-logo-and-font-available) + - [7.5. Q: What is the format of a contact or channel QR code?](#75-q-what-is-the-format-of-a-contact-or-channel-qr-code) + - [7.6. Q: How do I connect to the companion via Wi-Fi, e.g. using a Heltec V3?](#76-q-how-do-i-connect-to-the-companion-via-wi-fi-eg-using-a-heltec-v3) + - [7.7. Q: I have a Station G2, or a Heltec V4, or an Ikoka Stick, or a radio with an EByte E22-900M30S or an EByte E22-900M33S module, what should their transmit power be set to?](#77-q-i-have-a-station-g2-or-a-heltec-v4-or-an-ikoka-stick-or-a-radio-with-an-ebyte-e22-900m30s-or-an-ebyte-e22-900m33s-module-what-should-their-transmit-power-be-set-to) ## 1. Introduction From 4749a61bb432fc59a204a707a016105e6078bfc1 Mon Sep 17 00:00:00 2001 From: Sefinek Date: Tue, 2 Jun 2026 22:30:42 +0200 Subject: [PATCH 34/59] docs: fix FAQ bullet list rendering --- docs/faq.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index 6da77f9a..c3edc6de 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -91,10 +91,10 @@ A list of frequently-asked questions and answers for MeshCore **A:** MeshCore is a multi-platform system for enabling secure text-based communications utilizing LoRa radio hardware. It can be used for Off-Grid Communication, Emergency Response & Disaster Recovery, Outdoor Activities, Tactical Security including law enforcement and private security and also IoT sensor networks. ([source](https://meshcore.io/)) MeshCore is free and open source: -* MeshCore is the routing and firmware etc., available on GitHub under MIT license -* There are clients made by the community, such as the web clients, these are free to use, and some are open source too -* The cross-platform mobile app developed by [Liam Cottle](https://liamcottle.net) for Android/iOS/PC etc. is free to download and use -* The T-Deck firmware is developed by Scott at Ripple Radios, the creator of MeshCore, is also free to flash on your devices and use +- MeshCore is the routing and firmware etc., available on GitHub under MIT license +- There are clients made by the community, such as the web clients, these are free to use, and some are open source too +- The cross-platform mobile app developed by [Liam Cottle](https://liamcottle.net) for Android/iOS/PC etc. is free to download and use +- The T-Deck firmware is developed by Scott at Ripple Radios, the creator of MeshCore, is also free to flash on your devices and use Some more advanced, but optional features are available on T-Deck if you register your device for a key to unlock. On the MeshCore smartphone clients for Android and iOS/iPadOS, you can unlock the wait timer for repeater and room server remote management over RF feature. From e0a6fd12b54b1749e498a0ad83a5826c54b64d4e Mon Sep 17 00:00:00 2001 From: Sefinek Date: Tue, 2 Jun 2026 22:34:38 +0200 Subject: [PATCH 35/59] docs: fix FAQ bullet list rendering --- docs/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/faq.md b/docs/faq.md index c3edc6de..4793f379 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -87,10 +87,10 @@ A list of frequently-asked questions and answers for MeshCore ## 1. Introduction ### 1.1. Q: What is MeshCore? - **A:** MeshCore is a multi-platform system for enabling secure text-based communications utilizing LoRa radio hardware. It can be used for Off-Grid Communication, Emergency Response & Disaster Recovery, Outdoor Activities, Tactical Security including law enforcement and private security and also IoT sensor networks. ([source](https://meshcore.io/)) MeshCore is free and open source: + - MeshCore is the routing and firmware etc., available on GitHub under MIT license - There are clients made by the community, such as the web clients, these are free to use, and some are open source too - The cross-platform mobile app developed by [Liam Cottle](https://liamcottle.net) for Android/iOS/PC etc. is free to download and use From f9a0f215c4397a2c46d2f12adc26ce1e6f10e927 Mon Sep 17 00:00:00 2001 From: Sefinek Date: Tue, 2 Jun 2026 23:31:25 +0200 Subject: [PATCH 36/59] docs: fix FAQ resource link rendering --- docs/faq.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index 4793f379..e56f685f 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -274,7 +274,7 @@ Reboot the repeater after `set prv.key ` command for the new private key to ### 3.6. Q: The first byte of my repeater's public key collides with an existing repeater on the mesh. How do I get a new private key with a matching public key that has its first byte of my choosing? -**A:** You can generate a new private key and specify the first byte of its public key here: https://gessaman.com/mc-keygen/ +**A:** You can generate a new private key and specify the first byte of its public key here: Having multiple repeaters with the same first byte ID does not negatively affect the mesh or its functionality. Flood and pathed packets will still reach their destinations. First byte ID collision makes traceroute and path analysis harder because these tools don't know exactly which of the two (or more) colliding repeaters is the one in the path. @@ -466,7 +466,7 @@ https://github.com/meshcore-dev/MeshCore/blob/main/src/Packet.h#L19 **SF is spreading factor** - how much should the communication spread in time -**CR is coding rate** - from: https://www.thethingsnetwork.org/docs/lorawan/fec-and-code-rate/ +**CR is coding rate** - from: TL;DR: default CR to 5 for good stable links. If it is not a solid link and is intermittent, change CR to 7 or 8. @@ -675,12 +675,9 @@ Both the Windows and Mac versions of the client app are fully unlocked and are f ### 5.16. Q: Are there any resources that compare MeshCore to other LoRa systems? **A:** Here is a list of MeshCore comparison resources: -The Comms Channel on YouTube: -https://www.youtube.com/watch?v=guDoKGs02Us -MeshCore Advantages by MCarper: -https://github.com/mikecarper/meshfirmware/blob/main/MeshCoreAdvantages.md -MeshCore vs Meshtastic by austinmesh.org -https://www.austinmesh.org/learn/meshcore-vs-meshtastic +- The Comms Channel on YouTube: https://www.youtube.com/watch?v=guDoKGs02Us +- MeshCore Advantages by MCarper: https://github.com/mikecarper/meshfirmware/blob/main/MeshCoreAdvantages.md +- MeshCore vs Meshtastic by austinmesh.org: https://www.austinmesh.org/learn/meshcore-vs-meshtastic --- From 1422f02cd305c30ebd23a54d220abe6355a9ba8d Mon Sep 17 00:00:00 2001 From: Sefinek Date: Tue, 2 Jun 2026 23:35:02 +0200 Subject: [PATCH 37/59] docs: fix FAQ rendering --- docs/faq.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/faq.md b/docs/faq.md index e56f685f..da36d089 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -675,6 +675,7 @@ Both the Windows and Mac versions of the client app are fully unlocked and are f ### 5.16. Q: Are there any resources that compare MeshCore to other LoRa systems? **A:** Here is a list of MeshCore comparison resources: + - The Comms Channel on YouTube: https://www.youtube.com/watch?v=guDoKGs02Us - MeshCore Advantages by MCarper: https://github.com/mikecarper/meshfirmware/blob/main/MeshCoreAdvantages.md - MeshCore vs Meshtastic by austinmesh.org: https://www.austinmesh.org/learn/meshcore-vs-meshtastic From 6b5cf1a9d71c4cd3c1115354cb8d747c7cbb5a5b Mon Sep 17 00:00:00 2001 From: Sefinek Date: Tue, 2 Jun 2026 23:48:28 +0200 Subject: [PATCH 38/59] docs: fix FAQ link rendering --- docs/faq.md | 92 ++++++++++++++++++++++++++++++----------------------- 1 file changed, 52 insertions(+), 40 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index da36d089..902bd94e 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -119,7 +119,7 @@ You need LoRa hardware devices to run MeshCore firmware as clients or server (re #### 1.2.1. Hardware MeshCore is available on a variety of 433MHz, 868MHz and 915MHz LoRa devices. For example, Lilygo T-Deck, T-Pager, RAK Wireless WisBlock RAK4631 devices (e.g. 19003, 19007, 19026), Heltec V3, Xiao S3 WIO, Xiao C3, Heltec T114, Station G2, Nano G2 Ultra, Seeed Studio T1000-E. More devices are being added regularly. -For an up-to-date list of supported devices, please go to https://flasher.meshcore.io +For an up-to-date list of supported devices, please go to To use MeshCore without using a phone as the client interface, you can run MeshCore on a LilyGo T-Deck, T-Deck Plus, T-Pager, T-Watch, or T-Display Pro. MeshCore Ultra firmware running on these devices is a complete off-grid secure communication solution. @@ -131,11 +131,11 @@ Companion radios are for connecting to the Android app or web app as a messenger 1. **BLE Companion** BLE Companion firmware runs on a supported LoRa device and connects to a smart device running the Android or iOS MeshCore client over BLE - + 2. **USB Serial Companion** USB Serial Companion firmware runs on a supported LoRa device and connects to a smart device or a computer over USB Serial running the MeshCore web client - + #### 1.2.4. Repeater Repeaters are used to extend the range of a MeshCore network. Repeater firmware runs on the same devices that run client firmware. A repeater's job is to forward MeshCore packets to the destination device. It does **not** forward or retransmit every packet it receives, unlike other LoRa mesh systems. @@ -172,7 +172,7 @@ After you flashed the latest firmware onto your repeater device, keep the device `set freq {frequency}` -The repeater and room server CLI reference is here: https://docs.meshcore.io/cli_commands +The repeater and room server CLI reference is here: If you have more supported devices, you can use your additional devices with the room server firmware. @@ -233,7 +233,7 @@ Repeater or room server can be administered with one of the options below: ![image](https://github.com/user-attachments/assets/2a9d9894-e34d-4dbe-b57c-fc3c250a2d34) -- Connect the server device using a USB cable to a computer running Chrome on https://flasher.meshcore.io, then use the `console` feature to connect to the device +- Connect the server device using a USB cable to a computer running Chrome on , then use the `console` feature to connect to the device - Use a MeshCore smartphone client to remotely administer servers via LoRa. @@ -294,7 +294,7 @@ This is a very low-cost operation. AGC reset is done by simply setting `state = ### 3.8. Q: How do I make my repeater an observer on the mesh? -**A:** The observer instruction is available here: https://analyzer.letsmesh.net/observer/onboard +**A:** The observer instruction is available here: ### 3.9. Q: What is multibyte support? What do 1-byte, 2-byte, 3-byte adverts and messages mean? @@ -354,7 +354,7 @@ You should move to send 2-byte or 3-byte channel and direct messages when the va ### 4.1. Q: Is there a user guide for T-Deck, T-Pager, T-Watch, or T-Display Pro? -**A:** Yes, it is available on https://buymeacoffee.com/ripplebiz/ultra-v7-7-guide-meshcore-users +**A:** Yes, it is available on ### 4.2. Q: What are the steps to get a T-Deck into DFU (Device Firmware Update) mode? **A:** @@ -420,7 +420,7 @@ Unlock page: `{hops} l:{packet-length}({payload-len}) t:{packet-type} snr:{n} rssi:{n}` See here for packet-type: -https://github.com/meshcore-dev/MeshCore/blob/main/src/Packet.h#L19 + ``` #define PAYLOAD_TYPE_REQ 0x00 // request (prefixed with dest/src hashes, MAC) (enc data: timestamp, blob) @@ -438,7 +438,7 @@ https://github.com/meshcore-dev/MeshCore/blob/main/src/Packet.h#L19 ### 4.11. Q: The T-Deck sound is too loud? ### 4.12. Q: Can you customize the sound? -**A:** You can customise the sounds on the T-Deck, by placing `.mp3` files onto the `root` dir of the SD card. The files are: +**A:** You can customize the sounds on the T-Deck, by placing `.mp3` files onto the `root` dir of the SD card. The files are: * `startup.mp3` * `error.mp3` @@ -491,6 +491,7 @@ So, it's a balancing act between speed of the transmission and resistance to noi The Things Network is mainly focused on LoRaWAN, but the LoRa low-level stuff still checks out for any LoRa project ### 5.2. Q: Do MeshCore clients repeat? + **A:** No, MeshCore clients do not repeat. This is the core of MeshCore's messaging-first design. This is to avoid devices flooding the airwaves and create endless collisions, so messages sent aren't received. In MeshCore, only repeaters and room servers with `set repeat on` repeat. @@ -514,17 +515,25 @@ Routes are stored in sender's contact list. When you send a message the first ti ### 5.6. Q: What is the public key for the default public channel? + **A:** The smartphone app key is in hex: -` 8b3387e9c5cdea6ac9e5edbaa115cd72` -T-Deck uses the same key but in base64 +`8b3387e9c5cdea6ac9e5edbaa115cd72` + +T-Deck uses the same key but in base64: + `izOH6cXN6mrJ5e26oRXNcg==` -The third character is the capital letter 'O', not zero `0` + +The third character is the capital letter `O`, not zero `0`. + [Source](https://discord.com/channels/826570251612323860/1330643963501351004/1354194409213792388) + ### 5.7. Q: Is MeshCore open source? + **A:** Most of the firmware is freely available. Everything is open source except the T-Deck firmware and Liam's native mobile apps. -- Firmware repo: https://github.com/meshcore-dev/MeshCore + +Firmware repo: ### 5.8. Q: How can I support MeshCore? **A:** Provide your honest feedback on GitHub and on [MeshCore Discord server](https://meshcore.gg). Spread the word of MeshCore to your friends and communities; help them get started with MeshCore. Support Scott's MeshCore development at . @@ -535,11 +544,11 @@ Support Rastislav Vysoky (recrof)'s flasher website and the map website developm ### 5.9. Q: How do I build MeshCore firmware from source? **A:** See instructions here: -https://discord.com/channels/826570251612323860/1330643963501351004/1341826372120608769 + Build instructions for MeshCore: -For Windows, first install WSL and Python+pip via: https://plainenglish.io/blog/setting-up-python-on-windows-subsystem-for-linux-wsl-26510f1b2d80 +For Windows, first install WSL and Python+pip via: (Linux, Windows+WSL) In the terminal/shell: ``` @@ -565,15 +574,15 @@ pio run -e RAK_4631_Repeater then you'll find `firmware.zip` in `.pio/build/RAK_4631_Repeater` Andy also has a video on how to build using VS Code: -*How to build and flash MeshCore repeater firmware | Heltec V3* +*How to build and flash Meshcore repeater firmware | Heltec V3* *(Link referenced in the Discord post)* ### 5.10. Q: Are there other MeshCore related open source projects? **A:** [Liam Cottle](https://liamcottle.net)'s MeshCore web client and MeshCore JavaScript library are open source under MIT license. -Web client: https://github.com/liamcottle/meshcore-web -Javascript: https://github.com/liamcottle/meshcore.js +Web client: +Javascript: ### 5.11. Q: Does MeshCore support ATAK **A:** ATAK is not currently on MeshCore's roadmap. @@ -604,7 +613,8 @@ Below are the instructions to flash firmware onto a supported LoRa device using > Instructions for nRF devices like RAK, T1000-E, T114 are immediately after the ESP instructions For ESP-based devices (e.g. Heltec V3) you need: -- Download firmware file from https://flasher.meshcore.io + +- Download firmware file from - Go to the website on a browser, find the section that has the firmware you need - Click the Download button, right-click on the file you need, for example, - `Heltec_V3_companion_radio_ble-v1.7.1-165fb33.bin` @@ -632,7 +642,7 @@ For ESP-based devices (e.g. Heltec V3) you need: **Instructions for nRF devices:** For nRF devices (e.g. RAK, Heltec T114) you need the following: -- Download firmware file from https://flasher.meshcore.io +- Download firmware file from - Go to the website on a browser, find the section that has the firmware you need - You need the ZIP version for the adafruit flash tool (below) - Click the Download button, right-click on the ZIP file, for example: @@ -656,19 +666,19 @@ To start managing your USB serial-connected device using picocom, use the follow - `picocom -b 115200 /dev/ttyUSB0 --imap lfcrlf` From here, reference repeater and room server command line commands in the MeshCore docs here: -- https://docs.meshcore.io/cli_commands +- ### 5.14. Q: Are there projects built around MeshCore? **A:** Yes, there are many. MeshCore's protocol is open source using the MIT license. The MIT license and the open source protocol makes it very easy for the MeshCore community to build new firmware for radios, applications on mobile devices, map tools, and analysis tools, and integration with other projects like Home Assistant. -As new MeshCore community projects become available on a weekly basis, we have stopped tracking them here in this FAQ. [samuk](https://github.com/samuk) maintains a very exhaustive list of MeshCore community project at https://github.com/samuk/awesome-meshcore/blob/main/README.md. samuk accepts PRs and merges them regularly. +As new MeshCore community projects become available on a weekly basis, we have stopped tracking them here in this FAQ. [samuk](https://github.com/samuk) maintains a very exhaustive list of MeshCore community project at . samuk accepts PRs and merges them regularly. ### 5.15. Q: Are there client applications for Windows or Mac? **A:** Yes, the same iOS and Android client is also available for Windows and Mac. You can find them together with the Android APK here: -https://files.liamcottle.net/MeshCore + Both the Windows and Mac versions of the client app are fully unlocked and are free to use. @@ -676,9 +686,9 @@ Both the Windows and Mac versions of the client app are fully unlocked and are f **A:** Here is a list of MeshCore comparison resources: -- The Comms Channel on YouTube: https://www.youtube.com/watch?v=guDoKGs02Us -- MeshCore Advantages by MCarper: https://github.com/mikecarper/meshfirmware/blob/main/MeshCoreAdvantages.md -- MeshCore vs Meshtastic by austinmesh.org: https://www.austinmesh.org/learn/meshcore-vs-meshtastic +- The Comms Channel on YouTube: +- MeshCore Advantages by MCarper: +- MeshCore vs Meshtastic by austinmesh.org: --- @@ -691,7 +701,7 @@ Both the Windows and Mac versions of the client app are fully unlocked and are f - If your client is a T-Deck, it may not have its time set (no GPS installed, no GPS lock, or wrong GPS baud rate). - If you are using the Android or iOS client, the other client, repeater, or room server may have the wrong time. -You can get the epoch time on and use it to set your T-Deck clock. For a repeater and room server, the admin can use a T-Deck to remotely set their clock (clock sync), or use the `time` command in the USB serial console with the server device connected. +You can get the epoch time on and use it to set your T-Deck clock. For a repeater and room server, the admin can use a T-Deck to remotely set their clock (clock sync), or use the `time` command in the USB serial console with the server device connected. ### 6.3. Q: How to connect to a repeater via BLE (Bluetooth)? **A:** You can't connect to a device running repeater firmware via Bluetooth. You can connect to devices running the BLE companion firmware via Bluetooth using the Android app. @@ -711,22 +721,23 @@ You can get the epoch time on and use it to se ### 6.7. Q: My RAK/T1000-E/xiao_nRF52 device seems to be corrupted, how do I wipe it clean to start fresh? **A:** + 1. Connect USB-C cable to your device, per your device's instruction, get it to flash mode: - For RAK, click the reset button **TWICE** - For T1000-e, quickly disconnect and reconnect the magnetic side of the cable from the device **TWICE** - For Heltec T114, click the reset button **TWICE** (the bottom button) - For Xiao nRF52, click the reset button once. If that doesn't work, quickly double-click the reset button twice. If that doesn't work, disconnect the board from your PC and reconnect again ([seeed studio wiki](https://wiki.seeedstudio.com/XIAO_BLE/#access-the-swd-pins-for-debugging-and-reflashing-bootloader)) 2. A new folder will appear on your computer's desktop -3. Download the `flash_erase*.uf2` file for your device on https://flasher.meshcore.io +3. Download the `flash_erase*.uf2` file for your device on - RAK WisBlock and Heltec T114: `Flash_erase-nRF32_softdevice_v6.uf2` - Seeed Studio Xiao nRF52 WIO: `Flash_erase-nRF52_softdevice_v7.uf2` 4. drag and drop the uf2 file for your device to the root of the new folder 5. Wait for the copy to complete. You might get an error dialog, you can ignore it -6. Go to https://flasher.meshcore.io, click `Console` and select the serial port for your connected device +6. Go to , click `Console` and select the serial port for your connected device 7. In the console, press enter. Your flash should now be erased 8. You may now flash the latest MeshCore firmware onto your device -Separately, starting in firmware version 1.7.0, there is a CLI Rescue mode. If your device has a user button (e.g. some RAK, T114), you can activate the rescue mode by holding down the user button of the device within 8 seconds of boot. Then you can use the 'Console' on https://flasher.meshcore.io +Separately, starting in firmware version 1.7.0, there is a CLI Rescue mode. If your device has a user button (e.g. some RAK, T114), you can activate the rescue mode by holding down the user button of the device within 8 seconds of boot. Then you can use the 'Console' on ### 6.8. Q: WebFlasher fails on Linux with failed to open @@ -737,6 +748,7 @@ Allow the browser user on it: `# setfacl -m u:YOUR_USER_HERE:rw /dev/ttyUSB0` --- + ## 7. Other Questions: ### 7.1. Q: How to update nRF (RAK, T114, Seeed XIAO) companion, repeater and room server firmware over the air using the new simpler DFU app? @@ -744,11 +756,11 @@ Allow the browser user on it: **A:** The steps below work on both Android and iOS as nRF has made both apps' user interface the same on both platforms: 1. Download nRF's DFU app from iOS App Store or Android's Play Store, you can find the app by searching for `nrf dfu`, the app's full name is `nRF Device Firmware Update` -2. On https://flasher.meshcore.io, download the **ZIP** version of the firmware for your nRF device (e.g. RAK or Heltec T114 or Seeed Studio's Xiao) +2. On , download the **ZIP** version of the firmware for your nRF device (e.g. RAK or Heltec T114 or Seeed Studio's Xiao) 3. From the MeshCore app, log in remotely to the repeater you want to update with admin privileges 4. Go to the Command Line tab, type `start ota` and hit enter. 5. You should see `OK` to confirm the repeater device is now in OTA mode -6. Run the DFU app, tap `Settings` on the top right corner +6. Run the DFU app, then tap `Settings` in the top-right corner 7. Enable `Packet receipt notifications`, and change `Number of Packets` to 10 for RAK, 8 for T114. 8 also works for RAK. 8. Select the firmware zip file you downloaded 9. Select the device you want to update. If the device you want to update is not on the list, try enabling `OTA` on the device again @@ -756,16 +768,16 @@ Allow the browser user on it: 11. Tap `Upload` to begin OTA update 12. If it fails, try toggling Bluetooth on your phone. If that doesn't work, try rebooting your phone. If you keep getting failures at the "Enabling Bootloader" step, try forgetting the nRF board in your iOS or Android device's Bluetooth settings and re-pair it through the DFU app. 13. Wait for the update to complete. It can take a few minutes. -14. It is strongly recommended that you install and use the OTAFIX bootloader at https://github.com/oltaco/Adafruit_nRF52_Bootloader_OTAFIX. +14. It is strongly recommended that you install and use the OTAFIX bootloader at . 15. To update a companion node over OTA, it must be running companion firmware v1.15 or greater. 16. Please see the MeshCore Blog for additional information on OTA firmware flashing: - - https://blog.meshcore.io/2026/04/06/otafix-bootloader - - https://blog.meshcore.io/2026/04/02/nrf-ota-update + - + - #### 7.1.1 Q: Can I update Seeed Studio Wio Tracker L1 Pro using OTA? **A:** You can flash this safer bootloader to the Wio Tracker L1 Pro -https://github.com/oltaco/Adafruit_nRF52_Bootloader_OTAFIX + After this bootloader is flashed onto the device, you can trigger an over-the-air update using Bluetooth by holding the button next to the D-Pad and then clicking the reset button. Then follow the same OTA update instructions above. You can skip the `start ota` instruction and start the update using the DFU app. @@ -773,20 +785,20 @@ After this bootloader is flashed onto the device, you can trigger an over-the-ai ### 7.2. Q: How to update ESP32-based devices over the air? **A:** For ESP32-based devices (e.g. Heltec V3): -1. On https://flasher.meshcore.io, download the **non-merged** version of the firmware for your ESP32 device (e.g. `Heltec_v3_repeater-v1.6.2-4449fd3.bin`, no `"merged"` in the file name) +1. On , download the **non-merged** version of the firmware for your ESP32 device (e.g. `Heltec_v3_repeater-v1.6.2-4449fd3.bin`, no `"merged"` in the file name) 2. From the MeshCore app, log in remotely to the repeater you want to update with admin privileges 3. Go to the Command Line tab, type `start ota` and hit enter. 4. you should see `OK` to confirm the repeater device is now in OTA mode 5. The command `start ota` on an ESP32-based device starts a Wi-Fi hotspot named `MeshCore OTA` 6. From your phone or computer connect to the 'MeshCore OTA' hotspot -7. From a browser, go to http://192.168.4.1/update and upload the non-merged bin from the flasher +7. From a browser, go to and upload the non-merged bin from the flasher ### 7.3. Q: Is there a way to lower the chance of a failed OTA device firmware update (DFU)? **A:** Yes, developer `che aporeps` has an enhanced OTA DFU bootloader for nRF52 based devices. With this bootloader, if it detects that the application firmware is invalid, it falls back to OTA DFU mode so you can attempt to flash again to recover. This bootloader has other changes to make the OTA DFU process more fault tolerant. -Refer to https://github.com/oltaco/Adafruit_nRF52_Bootloader_OTAFIX for the latest information. +Refer to for the latest information. Currently, the following boards are supported: - Heltec Automation Mesh Node T114 / HT-nRF5262 @@ -801,7 +813,7 @@ Currently, the following boards are supported: ### 7.4. Q: are the MeshCore logo and font available? **A:** Yes, it is on the MeshCore GitHub repo here: -https://github.com/meshcore-dev/MeshCore/tree/main/logo + ### 7.5. Q: What is the format of a contact or channel QR code? From 3daa6adc83dda985140d65f519e684707fc69dbf Mon Sep 17 00:00:00 2001 From: Sefinek Date: Tue, 2 Jun 2026 23:57:50 +0200 Subject: [PATCH 39/59] docs: fix FAQ heading capitalization --- docs/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/faq.md b/docs/faq.md index 902bd94e..e8ef21a9 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -810,7 +810,7 @@ Currently, the following boards are supported: - RAK 4631 - RAK WisMesh Tag (new 28/11/2025) -### 7.4. Q: are the MeshCore logo and font available? +### 7.4. Q: Are the MeshCore logo and font available? **A:** Yes, it is on the MeshCore GitHub repo here: From 15913d580f477d7006549be0bfe241ee81c0a05e Mon Sep 17 00:00:00 2001 From: Sefinek Date: Wed, 3 Jun 2026 00:14:29 +0200 Subject: [PATCH 40/59] docs: fix FAQ rendering --- docs/faq.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/faq.md b/docs/faq.md index e8ef21a9..2c8779d2 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -785,6 +785,7 @@ After this bootloader is flashed onto the device, you can trigger an over-the-ai ### 7.2. Q: How to update ESP32-based devices over the air? **A:** For ESP32-based devices (e.g. Heltec V3): + 1. On , download the **non-merged** version of the firmware for your ESP32 device (e.g. `Heltec_v3_repeater-v1.6.2-4449fd3.bin`, no `"merged"` in the file name) 2. From the MeshCore app, log in remotely to the repeater you want to update with admin privileges 3. Go to the Command Line tab, type `start ota` and hit enter. From 456e14f7a701d1031bd6e6fdee848aeb07b51964 Mon Sep 17 00:00:00 2001 From: Sefinek Date: Wed, 3 Jun 2026 00:15:26 +0200 Subject: [PATCH 41/59] docs: add missing periods at sentence endings --- docs/faq.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index 2c8779d2..c4ec7445 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -786,13 +786,13 @@ After this bootloader is flashed onto the device, you can trigger an over-the-ai **A:** For ESP32-based devices (e.g. Heltec V3): -1. On , download the **non-merged** version of the firmware for your ESP32 device (e.g. `Heltec_v3_repeater-v1.6.2-4449fd3.bin`, no `"merged"` in the file name) -2. From the MeshCore app, log in remotely to the repeater you want to update with admin privileges +1. On , download the **non-merged** version of the firmware for your ESP32 device (e.g. `Heltec_v3_repeater-v1.6.2-4449fd3.bin`, no `"merged"` in the file name). +2. From the MeshCore app, log in remotely to the repeater you want to update with admin privileges. 3. Go to the Command Line tab, type `start ota` and hit enter. -4. you should see `OK` to confirm the repeater device is now in OTA mode -5. The command `start ota` on an ESP32-based device starts a Wi-Fi hotspot named `MeshCore OTA` -6. From your phone or computer connect to the 'MeshCore OTA' hotspot -7. From a browser, go to and upload the non-merged bin from the flasher +4. You should see `OK` to confirm the repeater device is now in OTA mode. +5. The command `start ota` on an ESP32-based device starts a Wi-Fi hotspot named `MeshCore OTA`. +6. From your phone or computer connect to the 'MeshCore OTA' hotspot. +7. From a browser, go to and upload the non-merged bin from the flasher. ### 7.3. Q: Is there a way to lower the chance of a failed OTA device firmware update (DFU)? From f7bff44572d1cc5cc9f413060385ec088e1c5aa3 Mon Sep 17 00:00:00 2001 From: Sefinek Date: Wed, 3 Jun 2026 00:24:01 +0200 Subject: [PATCH 42/59] docs: fix remaining rendering issues --- docs/faq.md | 79 +++++++++++++++++++++++++++-------------------------- 1 file changed, 41 insertions(+), 38 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index c4ec7445..551cb938 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -573,7 +573,7 @@ pio run -e RAK_4631_Repeater ``` then you'll find `firmware.zip` in `.pio/build/RAK_4631_Repeater` -Andy also has a video on how to build using VS Code: +Andy also has a video on how to build using VS Code: *How to build and flash Meshcore repeater firmware | Heltec V3* *(Link referenced in the Discord post)* @@ -614,58 +614,60 @@ Below are the instructions to flash firmware onto a supported LoRa device using For ESP-based devices (e.g. Heltec V3) you need: -- Download firmware file from - - Go to the website on a browser, find the section that has the firmware you need - - Click the Download button, right-click on the file you need, for example, +1. Download the firmware file from . + - Go to the website in a browser and find the section that has the firmware you need. + - Click the Download button, right-click on the file you need, for example: - `Heltec_V3_companion_radio_ble-v1.7.1-165fb33.bin` - - Non-merged bin keeps the existing Bluetooth pairing database + - Non-merged bin keeps the existing Bluetooth pairing database. - `Heltec_v3_companion_radio_usb-v1.7.1-165fb33-merged.bin` - - Merged bin overwrites everything including the bootloader, existing Bluetooth pairing database, but keeps configurations. - - Right-click on the file name and copy the link and note it for later use here is an example: `https://flasher.meshcore.io/releases/download/companion-v1.7.1/Heltec_v3_companion_radio_ble-v1.7.1-165fb33.bin` - - Run: - - `wget https://flasher.meshcore.io/releases/download/companion-v1.7.1/Heltec_v3_companion_radio_ble-v1.7.1-165fb33.bin` to download the firmware file for your device type. or the version you need - USB, BLE, Repeater, Room Server, merged bin or non-merged bin - - If the above wget command only downloads a very small file (10K bytes instead of more than 100K byte, use this command instead: - - `wget --user-agent="Mozilla/5.0" --content-disposition "https://flasher.meshcore.io/releases/download/companion-v1.7.1/Heltec_v3_companion_radio_usb-v1.7.1-165fb33.bin"` - - Confirm the `ttyXXXX` device path on your Raspberry Pi: - - Go to `/dev` directory, run ls command to find confirm your device path - - They are usually `/dev/ttyUSB0` for ESP devices - - For ESP-based devices, install esptool from the shell: - - `pip install esptool --break-system-packages` - - To flash, use the following command: - - For non-merged bin: - - `esptool.py -p /dev/ttyUSB0 --chip esp32-s3 write_flash 0x10000 .bin` - - For merged bin: - - `esptool.py -p /dev/ttyUSB0 --chip esp32-s3 write_flash 0x00000 .bin` - - + - Merged bin overwrites everything including the bootloader and existing Bluetooth pairing database, but keeps configurations. + - Right-click on the file name and copy the link. Here is an example: `https://flasher.meshcore.io/releases/download/companion-v1.7.1/Heltec_v3_companion_radio_ble-v1.7.1-165fb33.bin` + - Run: + - `wget https://flasher.meshcore.io/releases/download/companion-v1.7.1/Heltec_v3_companion_radio_ble-v1.7.1-165fb33.bin` to download the firmware file for your device type or the version you need: USB, BLE, Repeater, Room Server, merged bin or non-merged bin. + - If the above wget command only downloads a very small file (10K bytes instead of more than 100K byte), use this command instead: + - `wget --user-agent="Mozilla/5.0" --content-disposition "https://flasher.meshcore.io/releases/download/companion-v1.7.1/Heltec_v3_companion_radio_usb-v1.7.1-165fb33.bin"` +2. Confirm the `ttyXXXX` device path on your Raspberry Pi. + - Go to the `/dev` directory and run the `ls` command to find your device path. + - It is usually `/dev/ttyUSB0` for ESP devices. +3. Install esptool from the shell. + - `pip install esptool --break-system-packages` +4. Flash the firmware. + - For non-merged bin: + - `esptool.py -p /dev/ttyUSB0 --chip esp32-s3 write_flash 0x10000 .bin` + - For merged bin: + - `esptool.py -p /dev/ttyUSB0 --chip esp32-s3 write_flash 0x00000 .bin` **Instructions for nRF devices:** For nRF devices (e.g. RAK, Heltec T114) you need the following: -- Download firmware file from - - Go to the website on a browser, find the section that has the firmware you need - - You need the ZIP version for the adafruit flash tool (below) + +1. Download the firmware file from . + - Go to the website in a browser and find the section that has the firmware you need. + - You need the ZIP version for the adafruit flash tool below. - Click the Download button, right-click on the ZIP file, for example: - `RAK_4631_companion_radio_ble-v1.7.1-165fb33.zip` - - Right-click on the file name and copy the link and note it for later use here is an example: `https://flasher.meshcore.io/releases/download/companion-v1.7.1/RAK_4631_companion_radio_ble-v1.7.1-165fb33.zip` - - Run: - - `wget https://flasher.meshcore.io/releases/download/companion-v1.7.1/RAK_4631_companion_radio_ble-v1.7.1-165fb33.zip` to download the firmware file for your device type. or the version you need - USB, BLE, Repeater, Room Server, ZIP file only - - Confirm the `ttyXXXX` device path on your Raspberry Pi: - - Go to `/dev` directory, run ls command to find confirm your device path - - They are usually `/dev/ttyACM0` for nRF devices - - For nRF-based devices, install adafruit-nrfutil - - `pip install adafruit-nrfutil --break-system-packages` - - Use this command to flash the nRF device: - - `adafruit-nrfutil --verbose dfu serial --package RAK_4631_companion_radio_usb-v1.7.1-165fb33.zip -p /dev/ttyACM0 -b 115200 --singlebank --touch 1200` + - Right-click on the file name and copy the link. Here is an example: `https://flasher.meshcore.io/releases/download/companion-v1.7.1/RAK_4631_companion_radio_ble-v1.7.1-165fb33.zip` + - Run: + - `wget https://flasher.meshcore.io/releases/download/companion-v1.7.1/RAK_4631_companion_radio_ble-v1.7.1-165fb33.zip` to download the firmware file for your device type or the version you need: USB, BLE, Repeater, Room Server, ZIP file only. +2. Confirm the `ttyXXXX` device path on your Raspberry Pi. + - Go to the `/dev` directory and run the `ls` command to find your device path. + - It is usually `/dev/ttyACM0` for nRF devices. +3. Install adafruit-nrfutil. + - `pip install adafruit-nrfutil --break-system-packages` +4. Flash the nRF device. + - `adafruit-nrfutil --verbose dfu serial --package RAK_4631_companion_radio_usb-v1.7.1-165fb33.zip -p /dev/ttyACM0 -b 115200 --singlebank --touch 1200` To manage a repeater or room server connected to a Pi over USB serial using shell commands, you need to install `picocom`. To install `picocom`, run the following command: + - `sudo apt install picocom` To start managing your USB serial-connected device using picocom, use the following command: + - `picocom -b 115200 /dev/ttyUSB0 --imap lfcrlf` From here, reference repeater and room server command line commands in the MeshCore docs here: + - @@ -697,6 +699,7 @@ Both the Windows and Mac versions of the client app are fully unlocked and are f ### 6.1. Q: My client says another client or a repeater or a room server was last seen many, many days ago. ### 6.2. Q: A repeater or a client or a room server I expect to see on my discover list (on T-Deck) or contact list (on a smart device client) are not listed. + **A:** - If your client is a T-Deck, it may not have its time set (no GPS installed, no GPS lock, or wrong GPS baud rate). - If you are using the Android or iOS client, the other client, repeater, or room server may have the wrong time. @@ -708,11 +711,11 @@ You can get the epoch time on and use it to set ### 6.4. Q: My companion isn't showing up over Bluetooth? -**A:** make sure that you flashed the Bluetooth companion firmware and not the USB-only companion firmware. +**A:** Make sure that you flashed the Bluetooth companion firmware and not the USB-only companion firmware. ### 6.5. Q: I can't connect via Bluetooth, what is the Bluetooth pairing code? -**A:** the default Bluetooth pairing code is `123456` +**A:** The default Bluetooth pairing code is `123456` ### 6.6. Q: My Heltec V3 keeps disconnecting from my smartphone. It can't hold a solid Bluetooth connection. From 4f4699ab61a417656e43265ea5b7ab75f4f0aef8 Mon Sep 17 00:00:00 2001 From: Sefinek Date: Wed, 3 Jun 2026 00:28:09 +0200 Subject: [PATCH 43/59] docs: fix remaining rendering issues --- docs/faq.md | 48 +++++------------------------------------------- 1 file changed, 5 insertions(+), 43 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index 551cb938..b9b8358b 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -177,7 +177,6 @@ The repeater and room server CLI reference is here: - ### 3.2. Q: Do I need to set the location for a repeater? **A:** While not required, with location set for a repeater it will show up on the MeshCore map in the future. Set location with the following command: @@ -264,7 +261,6 @@ You can get the latitude and longitude from Google Maps by right-clicking the lo `set guest.password {guest-password}` ### 3.5. Q: Can I retrieve a repeater's private key or set a repeater's private key? - **A:** You can issue these commands to get or set a repeater's private key using a USB serial connection. `get prv.key` to print a repeater's private key on the serial console @@ -273,7 +269,6 @@ You can get the latitude and longitude from Google Maps by right-clicking the lo Reboot the repeater after `set prv.key ` command for the new private key to take effect. ### 3.6. Q: The first byte of my repeater's public key collides with an existing repeater on the mesh. How do I get a new private key with a matching public key that has its first byte of my choosing? - **A:** You can generate a new private key and specify the first byte of its public key here: Having multiple repeaters with the same first byte ID does not negatively affect the mesh or its functionality. Flood and pathed packets will still reach their destinations. First byte ID collision makes traceroute and path analysis harder because these tools don't know exactly which of the two (or more) colliding repeaters is the one in the path. @@ -282,7 +277,6 @@ Best practice is when you set up a new repeater, choose a public key that is not ### 3.7. Q: My repeater may be suffering from deafness due to high power interference near my mesh's frequency, it is not hearing other in-range MeshCore radios. What can I do? - **A:** This may be due to the SX1262 radio's auto gain control feature. You can use this command to periodically reset its AGC. `set agc.reset.interval ` @@ -293,11 +287,9 @@ This is a very low-cost operation. AGC reset is done by simply setting `state = ### 3.8. Q: How do I make my repeater an observer on the mesh? - **A:** The observer instruction is available here: ### 3.9. Q: What is multibyte support? What do 1-byte, 2-byte, 3-byte adverts and messages mean? - **A:** The original MeshCore protocol design uses the first byte of a repeater's public key to denote the repeater in a path. And with 1 byte for each repeater in the path, MeshCore packets can travel as many as 64 hops. @@ -306,21 +298,17 @@ However, with 1 byte, there are only 254 unique IDs (exclude 00 and FF which are Firmware version 1.14 and newer introduces the ability for repeaters to advert with 1-, 2-, or 3-byte adverts. Companions can also send out channel and direct messages with 1-, 2-, or 3-byte path. Adverts and messages sent in 1-byte path is compatible with repeater firmware older or newer than 1.14. They will travel up to 64 hops. 2-byte adverts and messages will travel up to 32 hops. 3-byte adverts and messages will travel up to 21 hops. ### 3.9.1. Q: **What path hash sizes will my repeater forward?** - Repeaters running firmware 1.14+ repeat packets sent with 1-, 2-, or 3-byte path hash. Repeaters on firmware older than 1.14 only repeat 1-byte path hash packets and silently drop 2- and 3-byte packets. ### 3.9.2. Q: **What determines a packet's path hash size?** - The original packet sender determines the path hash size. The most common original sender is a companion app. The other common original sender is a repeater, when it broadcasts its advert. ### 3.9.3. Q: **How do I change my companion's path hash size?** - As of firmware version 1.14 and MeshCore app version 1.41.0, in the MeshCore app, you can set your companion's message path hash size in `Settings (gear icon)`, `Experimental Settings`. Until your regional mesh has the vast majority of the repeaters updated to 1.14+ firmware, it is recommended to keep your companion at the default 1-byte because pre-1.14 repeaters will silently drop messages with larger path hashes. ### 3.9.4. Q: **What does the CLI command `path.hash.mode` do on a repeater?** - This CLI command `path.hash.mode` *only* controls the path hash size used in a repeater's own advert broadcasts. It does **NOT** affect which packets the repeater forwards. A repeater with firmware 1.14+ always forward 1-, 2-, and 3-byte packets regardless of this setting. Usage: `set path.hash.mode {0|1|2}`: @@ -353,11 +341,11 @@ You should move to send 2-byte or 3-byte channel and direct messages when the va ## 4. T-Deck Related ### 4.1. Q: Is there a user guide for T-Deck, T-Pager, T-Watch, or T-Display Pro? - **A:** Yes, it is available on ### 4.2. Q: What are the steps to get a T-Deck into DFU (Device Firmware Update) mode? **A:** + 1. Device off 2. Connect USB cable to device 3. Hold down trackball (keep holding) @@ -437,7 +425,6 @@ See here for packet-type: ### 4.11. Q: The T-Deck sound is too loud? ### 4.12. Q: Can you customize the sound? - **A:** You can customize the sounds on the T-Deck, by placing `.mp3` files onto the `root` dir of the SD card. The files are: * `startup.mp3` @@ -447,11 +434,9 @@ See here for packet-type: * `existing-advert.mp3` ### 4.13. Q: What is the 'Import from Clipboard' feature on the t-deck and is there a way to manually add nodes without having to receive adverts? - **A:** 'Import from Clipboard' is for importing a contact via a file named 'clipboard.txt' on the SD card. The opposite, is in the Identity screen, the 'Card to Clipboard' menu, which writes to 'clipboard.txt' so you can share yourself (call these 'biz cards', that start with "meshcore://...") ### 4.14. Q: How to capture a screenshot on T-Deck? - **A:** To capture a screenshot on a T-Deck, long press the top-left corner of the screen. The screenshot is saved to the microSD card, if one is inserted into the device. --- @@ -459,7 +444,6 @@ See here for packet-type: ## 5. General ### 5.1. Q: What are BW, SF, and CR? - **A:** **BW is bandwidth** - width of frequency spectrum that is used for transmission @@ -491,31 +475,26 @@ So, it's a balancing act between speed of the transmission and resistance to noi The Things Network is mainly focused on LoRaWAN, but the LoRa low-level stuff still checks out for any LoRa project ### 5.2. Q: Do MeshCore clients repeat? - **A:** No, MeshCore clients do not repeat. This is the core of MeshCore's messaging-first design. This is to avoid devices flooding the airwaves and create endless collisions, so messages sent aren't received. In MeshCore, only repeaters and room servers with `set repeat on` repeat. ### 5.3. Q: What happens when a node learns a route via a mobile repeater, and that repeater is gone? - **A:** If you used to reach a node through a repeater and the repeater is no longer reachable, the client will send the message using the existing (but now broken) known path, the message will fail after 3 retries, and the app will reset the path and send the message as flood on the last retry by default. This can be turned off in settings. If the destination is reachable directly or through another repeater, the new path will be used going forward. Or you can set the path manually if you know a specific repeater to use to reach that destination. In the case if users are moving around frequently, and the paths are breaking, they just see the phone client retries and revert to flood to attempt to re-establish a path. ### 5.4. Q: How does a node discover a path to its destination and then use it to send messages in the future, instead of flooding every message it sends like Meshtastic? - Routes are stored in sender's contact list. When you send a message the first time, the message first gets to your destination by flood routing. When your destination node gets the message, it will send back a delivery report to the sender with all repeaters that the original message went through. This delivery report is flood-routed back to you the sender and is a basis for future direct path. When you send the next message, the path will get embedded into the packet and be evaluated by repeaters. If the hop and address of the repeater matches, it will retransmit the message, otherwise it will not retransmit, hence minimizing utilization. [Source](https://discord.com/channels/826570251612323860/1330643963501351004/1351279141630119996) ### 5.5. Q: Do public channels always flood? Do private channels always flood? - **A:** Yes, group channels are A to B, so there is no defined path. They have to flood. Repeaters can however deny flood traffic up to some hop limit, with the `set flood.max` CLI command. Administrators of repeaters get to set the rules of their repeaters. [Source](https://discord.com/channels/1343693475589263471/1343693475589263474/1350023009527664672) ### 5.6. Q: What is the public key for the default public channel? - **A:** The smartphone app key is in hex: `8b3387e9c5cdea6ac9e5edbaa115cd72` @@ -530,7 +509,6 @@ The third character is the capital letter `O`, not zero `0`. ### 5.7. Q: Is MeshCore open source? - **A:** Most of the firmware is freely available. Everything is open source except the T-Deck firmware and Liam's native mobile apps. Firmware repo: @@ -672,7 +650,6 @@ From here, reference repeater and room server command line commands in the MeshC ### 5.14. Q: Are there projects built around MeshCore? - **A:** Yes, there are many. MeshCore's protocol is open source using the MIT license. The MIT license and the open source protocol makes it very easy for the MeshCore community to build new firmware for radios, applications on mobile devices, map tools, and analysis tools, and integration with other projects like Home Assistant. As new MeshCore community projects become available on a weekly basis, we have stopped tracking them here in this FAQ. [samuk](https://github.com/samuk) maintains a very exhaustive list of MeshCore community project at . samuk accepts PRs and merges them regularly. @@ -685,7 +662,6 @@ As new MeshCore community projects become available on a weekly basis, we have s Both the Windows and Mac versions of the client app are fully unlocked and are free to use. ### 5.16. Q: Are there any resources that compare MeshCore to other LoRa systems? - **A:** Here is a list of MeshCore comparison resources: - The Comms Channel on YouTube: @@ -699,8 +675,8 @@ Both the Windows and Mac versions of the client app are fully unlocked and are f ### 6.1. Q: My client says another client or a repeater or a room server was last seen many, many days ago. ### 6.2. Q: A repeater or a client or a room server I expect to see on my discover list (on T-Deck) or contact list (on a smart device client) are not listed. - **A:** + - If your client is a T-Deck, it may not have its time set (no GPS installed, no GPS lock, or wrong GPS baud rate). - If you are using the Android or iOS client, the other client, repeater, or room server may have the wrong time. @@ -710,19 +686,15 @@ You can get the epoch time on and use it to set **A:** You can't connect to a device running repeater firmware via Bluetooth. You can connect to devices running the BLE companion firmware via Bluetooth using the Android app. ### 6.4. Q: My companion isn't showing up over Bluetooth? - **A:** Make sure that you flashed the Bluetooth companion firmware and not the USB-only companion firmware. ### 6.5. Q: I can't connect via Bluetooth, what is the Bluetooth pairing code? - **A:** The default Bluetooth pairing code is `123456` ### 6.6. Q: My Heltec V3 keeps disconnecting from my smartphone. It can't hold a solid Bluetooth connection. - **A:** Heltec V3 has a very small coil antenna on its PCB for Wi-Fi and Bluetooth connectivity. It has a very short range, only a few feet. It is possible to remove the coil antenna and replace it with a 31mm wire. The BT range is much improved with the modification. ### 6.7. Q: My RAK/T1000-E/xiao_nRF52 device seems to be corrupted, how do I wipe it clean to start fresh? - **A:** 1. Connect USB-C cable to your device, per your device's instruction, get it to flash mode: @@ -743,7 +715,6 @@ You can get the epoch time on and use it to set Separately, starting in firmware version 1.7.0, there is a CLI Rescue mode. If your device has a user button (e.g. some RAK, T114), you can activate the rescue mode by holding down the user button of the device within 8 seconds of boot. Then you can use the 'Console' on ### 6.8. Q: WebFlasher fails on Linux with failed to open - **A:** If the usb port doesn't have the right ownership for this task, the process fails with the following error: `NetworkError: Failed to execute 'open' on 'SerialPort': Failed to open serial port.` @@ -755,7 +726,6 @@ Allow the browser user on it: ## 7. Other Questions: ### 7.1. Q: How to update nRF (RAK, T114, Seeed XIAO) companion, repeater and room server firmware over the air using the new simpler DFU app? - **A:** The steps below work on both Android and iOS as nRF has made both apps' user interface the same on both platforms: 1. Download nRF's DFU app from iOS App Store or Android's Play Store, you can find the app by searching for `nrf dfu`, the app's full name is `nRF Device Firmware Update` @@ -786,7 +756,6 @@ After this bootloader is flashed onto the device, you can trigger an over-the-ai ### 7.2. Q: How to update ESP32-based devices over the air? - **A:** For ESP32-based devices (e.g. Heltec V3): 1. On , download the **non-merged** version of the firmware for your ESP32 device (e.g. `Heltec_v3_repeater-v1.6.2-4449fd3.bin`, no `"merged"` in the file name). @@ -799,7 +768,6 @@ After this bootloader is flashed onto the device, you can trigger an over-the-ai ### 7.3. Q: Is there a way to lower the chance of a failed OTA device firmware update (DFU)? - **A:** Yes, developer `che aporeps` has an enhanced OTA DFU bootloader for nRF52 based devices. With this bootloader, if it detects that the application firmware is invalid, it falls back to OTA DFU mode so you can attempt to flash again to recover. This bootloader has other changes to make the OTA DFU process more fault tolerant. Refer to for the latest information. @@ -815,18 +783,13 @@ Currently, the following boards are supported: - RAK WisMesh Tag (new 28/11/2025) ### 7.4. Q: Are the MeshCore logo and font available? - -**A:** Yes, it is on the MeshCore GitHub repo here: - +**A:** Yes, it is on the MeshCore GitHub repo here: ### 7.5. Q: What is the format of a contact or channel QR code? - **A:** -Channel: -`meshcore://channel/add?name=&secret=` +Channel: `meshcore://channel/add?name=&secret=` -Contact: -`meshcore://contact/add?name=&public_key=&type=` +Contact: `meshcore://contact/add?name=&public_key=&type=` where `&type` is: `chat = 1` @@ -843,7 +806,6 @@ Edit WIFI_SSID and WIFI_PWD in `./variants/heltec_v3/platformio.ini` and then fl **A:** For companion radios, you can set these radios' transmit power in the smartphone app. For repeater and room server radios, you can set their transmit power using the command line command `set tx`. You can get their current value using command line command `get tx` - ⚠️ **WARNING: Set these values at your own risk. Incorrect power settings can permanently damage your radio hardware.** | Device / Model | Region / Description | In-App Setting (dBm) | Target Radio Output | Notes | From 4dcd664363163a6d2578cd50f3361a8cfb741000 Mon Sep 17 00:00:00 2001 From: Sefinek Date: Wed, 3 Jun 2026 00:32:25 +0200 Subject: [PATCH 44/59] docs: fix remaining rendering issues --- docs/faq.md | 31 ++++++++++++++++++++----------- 1 file changed, 20 insertions(+), 11 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index b9b8358b..10b9556a 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -59,8 +59,8 @@ A list of frequently-asked questions and answers for MeshCore - [5.8. Q: How can I support MeshCore?](#58-q-how-can-i-support-meshcore) - [5.9. Q: How do I build MeshCore firmware from source?](#59-q-how-do-i-build-meshcore-firmware-from-source) - [5.10. Q: Are there other MeshCore related open source projects?](#510-q-are-there-other-meshcore-related-open-source-projects) - - [5.11. Q: Does MeshCore support ATAK](#511-q-does-meshcore-support-atak) - - [5.12. Q: How do I add a node to the MeshCore Map](#512-q-how-do-i-add-a-node-to-the-meshcore-map) + - [5.11. Q: Does MeshCore support ATAK?](#511-q-does-meshcore-support-atak) + - [5.12. Q: How do I add a node to the MeshCore Map?](#512-q-how-do-i-add-a-node-to-the-meshcore-map) - [5.13. Q: Can I use a Raspberry Pi to update a MeshCore radio?](#513-q-can-i-use-a-raspberry-pi-to-update-a-meshcore-radio) - [5.14. Q: Are there projects built around MeshCore?](#514-q-are-there-projects-built-around-meshcore) - [5.15. Q: Are there client applications for Windows or Mac?](#515-q-are-there-client-applications-for-windows-or-mac) @@ -223,7 +223,8 @@ The separate `set advert.interval {minutes}` command controls the local zero-hop ## 3. Server Administration ### 3.1. Q: How do you configure a repeater or a room server? -**A:** - When MeshCore is flashed onto a LoRa device for the first time, it is necessary to set the server device's frequency to make it utilize the frequency that is legal in your country or region. + +**A:** When MeshCore is flashed onto a LoRa device for the first time, it is necessary to set the server device's frequency to make it utilize the frequency that is legal in your country or region. Repeater or room server can be administered with one of the options below: @@ -383,6 +384,7 @@ The smartphone app key is in hex: ### 4.7. Q: How do I get maps on T-Deck? **A:** You need map tiles. You can get pre-downloaded map tiles here (a good way to support development): + - (Europe) - (US) @@ -562,19 +564,21 @@ Andy also has a video on how to build using VS Code: Web client: Javascript: -### 5.11. Q: Does MeshCore support ATAK +### 5.11. Q: Does MeshCore support ATAK? **A:** ATAK is not currently on MeshCore's roadmap. MeshCore would not be best suited to ATAK because MeshCore: -clients do not repeat and therefore you would need a network of repeaters in place -will not have a stable path where all clients are constantly moving between repeaters + +- clients do not repeat and therefore you would need a network of repeaters in place +- will not have a stable path where all clients are constantly moving between repeaters MeshCore clients would need to reset path constantly and flood traffic across the network which could lead to lots of collisions with something as chatty as ATAK. This could change in the future if MeshCore develops a client firmware that repeats. + [Source](https://discord.com/channels/826570251612323860/1330643963501351004/1354780032140054659) -### 5.12. Q: How do I add a node to the [MeshCore Map](https://map.meshcore.io) +### 5.12. Q: How do I add a node to the [MeshCore Map](https://map.meshcore.io)? **A:** To add a BLE Companion radio, connect to the BLE Companion radio from the MeshCore smartphone app. In the app, tap the `3 dot` menu icon at the top right corner, then tap `Internet Map`. Tap the `3 dot` menu icon again and choose `Add me to the Map` @@ -716,9 +720,11 @@ Separately, starting in firmware version 1.7.0, there is a CLI Rescue mode. If y ### 6.8. Q: WebFlasher fails on Linux with failed to open **A:** If the usb port doesn't have the right ownership for this task, the process fails with the following error: + `NetworkError: Failed to execute 'open' on 'SerialPort': Failed to open serial port.` Allow the browser user on it: + `# setfacl -m u:YOUR_USER_HERE:rw /dev/ttyUSB0` --- @@ -773,6 +779,7 @@ After this bootloader is flashed onto the device, you can trigger an over-the-ai Refer to for the latest information. Currently, the following boards are supported: + - Heltec Automation Mesh Node T114 / HT-nRF5262 - Nologo ProMicro NRF52840 (aka SuperMini NRF52840) - Seeed Studio SenseCAP Card Tracker T1000-E @@ -787,15 +794,17 @@ Currently, the following boards are supported: ### 7.5. Q: What is the format of a contact or channel QR code? **A:** + Channel: `meshcore://channel/add?name=&secret=` Contact: `meshcore://contact/add?name=&public_key=&type=` where `&type` is: -`chat = 1` -`repeater = 2` -`room = 3` -`sensor = 4` + +- `chat = 1` +- `repeater = 2` +- `room = 3` +- `sensor = 4` ### 7.6. Q: How do I connect to the companion via Wi-Fi, e.g. using a Heltec V3? **A:** From 81510e749510ed5548c9e597fa3f7a08b0b0c53b Mon Sep 17 00:00:00 2001 From: Sefinek Date: Wed, 3 Jun 2026 00:38:53 +0200 Subject: [PATCH 45/59] docs: fix remaining rendering issues --- docs/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/faq.md b/docs/faq.md index 10b9556a..f82d3c9f 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -799,7 +799,7 @@ Channel: `meshcore://channel/add?name=&secret=` Contact: `meshcore://contact/add?name=&public_key=&type=` -where `&type` is: +Where `&type` is: - `chat = 1` - `repeater = 2` From aeca6f3f3f201e47be09d7135b263f32439d30b1 Mon Sep 17 00:00:00 2001 From: Kevin Le Date: Wed, 3 Jun 2026 14:10:28 +0700 Subject: [PATCH 46/59] Added "override" to getIRQGpio() for ESP32Board.h --- src/helpers/ESP32Board.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/helpers/ESP32Board.h b/src/helpers/ESP32Board.h index 73c58e2f..a4cbf2a9 100644 --- a/src/helpers/ESP32Board.h +++ b/src/helpers/ESP32Board.h @@ -62,7 +62,7 @@ public: return raw / 4; } - uint32_t getIRQGpio() { + uint32_t getIRQGpio() override { return P_LORA_DIO_1; // default for SX1262 } From 3c96a7de4352266441ae121c826dc741822d081a Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Thu, 4 Jun 2026 13:36:18 +1000 Subject: [PATCH 47/59] * powersaving on/off lowercase fix --- src/helpers/CommonCLI.cpp | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/helpers/CommonCLI.cpp b/src/helpers/CommonCLI.cpp index 86161413..d39251ef 100644 --- a/src/helpers/CommonCLI.cpp +++ b/src/helpers/CommonCLI.cpp @@ -433,11 +433,11 @@ void CommonCLI::handleCommand(uint32_t sender_timestamp, char* command, char* re #if defined(NRF52_PLATFORM) _prefs->powersaving_enabled = 1; savePrefs(); - strcpy(reply, "On - Immediate effect"); + strcpy(reply, "on - Immediate effect"); #elif defined(ESP32) && !defined(WITH_BRIDGE) _prefs->powersaving_enabled = 1; savePrefs(); - strcpy(reply, "On - After 2 minutes"); + strcpy(reply, "on - After 2 minutes"); #elif defined(WITH_BRIDGE) strcpy(reply, "Bridge not supported"); #else @@ -446,12 +446,12 @@ void CommonCLI::handleCommand(uint32_t sender_timestamp, char* command, char* re } else if (memcmp(command, "powersaving off", 15) == 0) { _prefs->powersaving_enabled = 0; savePrefs(); - strcpy(reply, "Off"); + strcpy(reply, "off"); } else if (memcmp(command, "powersaving", 11) == 0) { if (_prefs->powersaving_enabled) { - strcpy(reply, "On"); + strcpy(reply, "on"); } else { - strcpy(reply, "Off"); + strcpy(reply, "off"); } } else if (memcmp(command, "log start", 9) == 0) { _callbacks->setLoggingOn(true); From 2f221acd377e4d79cc23cf5928b11954ca71a9df Mon Sep 17 00:00:00 2001 From: taco Date: Thu, 4 Jun 2026 19:05:58 +1000 Subject: [PATCH 48/59] build fixes for LilyGo T-Echo Card --- variants/lilygo_techo_card/TechoCardBoard.h | 2 +- variants/lilygo_techo_card/platformio.ini | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/variants/lilygo_techo_card/TechoCardBoard.h b/variants/lilygo_techo_card/TechoCardBoard.h index d0887d00..8a2913a6 100644 --- a/variants/lilygo_techo_card/TechoCardBoard.h +++ b/variants/lilygo_techo_card/TechoCardBoard.h @@ -3,7 +3,7 @@ #include #include #include -#include +#include // built-ins #define VBAT_MV_PER_LSB (0.73242188F) // 3.0V ADC range and 12-bit ADC resolution = 3000mV/4096 diff --git a/variants/lilygo_techo_card/platformio.ini b/variants/lilygo_techo_card/platformio.ini index 36bdfe00..07bcebfe 100644 --- a/variants/lilygo_techo_card/platformio.ini +++ b/variants/lilygo_techo_card/platformio.ini @@ -113,6 +113,7 @@ build_flags = build_src_filter = ${LilyGo_T-Echo_Card.build_src_filter} +<../examples/companion_radio/*.cpp> +<../examples/companion_radio/ui-tiny/*.cpp> + + lib_deps = ${LilyGo_T-Echo_Card.lib_deps} end2endzone/NonBlockingRTTTL@^1.3.0 From 2a8bd3edad7d4735d7d99000c4e40b91150960a1 Mon Sep 17 00:00:00 2001 From: taco Date: Thu, 4 Jun 2026 23:21:41 +1000 Subject: [PATCH 49/59] pin platform-raspberrypi to 4e22a0d pins framework-arduinopico @ 1.50600.0+sha.6a1d13e9 --- platformio.ini | 2 +- variants/rpi_picow/platformio.ini | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/platformio.ini b/platformio.ini index e4a7d1c9..e16f7b83 100644 --- a/platformio.ini +++ b/platformio.ini @@ -99,7 +99,7 @@ lib_deps = extends = arduino_base upload_protocol = picotool board_build.core = earlephilhower -platform = https://github.com/maxgerhardt/platform-raspberrypi.git +platform = https://github.com/maxgerhardt/platform-raspberrypi.git#4e22a0d ; framework-arduinopico @ 1.50600.0+sha.6a1d13e9 build_flags = ${arduino_base.build_flags} -D RP2040_PLATFORM diff --git a/variants/rpi_picow/platformio.ini b/variants/rpi_picow/platformio.ini index 9253d36f..fa7a0ac3 100644 --- a/variants/rpi_picow/platformio.ini +++ b/variants/rpi_picow/platformio.ini @@ -1,6 +1,5 @@ [rpi_picow] extends = rp2040_base -platform = https://github.com/maxgerhardt/platform-raspberrypi.git board = rpipicow board_build.core = earlephilhower board_build.filesystem_size = 0.5m From 33ce1c991c9dc91dc4d2deca0e5eeaa327a7a24a Mon Sep 17 00:00:00 2001 From: taco Date: Thu, 4 Jun 2026 23:30:50 +1000 Subject: [PATCH 50/59] add missing radio_init() for rak11310 --- variants/rak11310/target.cpp | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/variants/rak11310/target.cpp b/variants/rak11310/target.cpp index 1edd315e..4c288975 100644 --- a/variants/rak11310/target.cpp +++ b/variants/rak11310/target.cpp @@ -12,6 +12,12 @@ VolatileRTCClock fallback_clock; AutoDiscoverRTCClock rtc_clock(fallback_clock); SensorManager sensors; +bool radio_init() { + rtc_clock.begin(Wire); + + return radio.std_init(&SPI1); +} + void radio_set_tx_power(int8_t dbm) { radio.setOutputPower(dbm); } From 7ce8b667182add9d2f18de07d369d34e5381c184 Mon Sep 17 00:00:00 2001 From: taco Date: Thu, 4 Jun 2026 23:36:51 +1000 Subject: [PATCH 51/59] build fix for rp2040 companion usb --- variants/rak11310/platformio.ini | 1 + variants/rpi_picow/platformio.ini | 1 + variants/waveshare_rp2040_lora/platformio.ini | 1 + variants/xiao_rp2040/platformio.ini | 1 + 4 files changed, 4 insertions(+) diff --git a/variants/rak11310/platformio.ini b/variants/rak11310/platformio.ini index 3019f9c5..ab820cf6 100644 --- a/variants/rak11310/platformio.ini +++ b/variants/rak11310/platformio.ini @@ -91,6 +91,7 @@ build_src_filter = ${rak11310.build_src_filter} +<../examples/companion_radio/*.cpp> lib_deps = ${rak11310.lib_deps} densaugeo/base64 @ ~1.4.0 +lib_ignore = BLE ; [env:RAK_11310_companion_radio_ble] ; extends = rak11310 diff --git a/variants/rpi_picow/platformio.ini b/variants/rpi_picow/platformio.ini index fa7a0ac3..66c7b9f8 100644 --- a/variants/rpi_picow/platformio.ini +++ b/variants/rpi_picow/platformio.ini @@ -64,6 +64,7 @@ build_src_filter = ${rpi_picow.build_src_filter} +<../examples/companion_radio/*.cpp> lib_deps = ${rpi_picow.lib_deps} densaugeo/base64 @ ~1.4.0 +lib_ignore = BLE ; [env:PicoW_companion_radio_ble] ; extends = rpi_picow diff --git a/variants/waveshare_rp2040_lora/platformio.ini b/variants/waveshare_rp2040_lora/platformio.ini index 36658d82..7dfe1401 100644 --- a/variants/waveshare_rp2040_lora/platformio.ini +++ b/variants/waveshare_rp2040_lora/platformio.ini @@ -90,6 +90,7 @@ build_src_filter = ${waveshare_rp2040_lora.build_src_filter} +<../examples/companion_radio/*.cpp> lib_deps = ${waveshare_rp2040_lora.lib_deps} densaugeo/base64 @ ~1.4.0 +lib_ignore = BLE ; [env:waveshare_rp2040_lora_companion_radio_ble] ; extends = waveshare_rp2040_lora diff --git a/variants/xiao_rp2040/platformio.ini b/variants/xiao_rp2040/platformio.ini index 9a0fdaf4..ca00e38b 100644 --- a/variants/xiao_rp2040/platformio.ini +++ b/variants/xiao_rp2040/platformio.ini @@ -67,6 +67,7 @@ build_src_filter = ${Xiao_rp2040.build_src_filter} +<../examples/companion_radio/*.cpp> lib_deps = ${Xiao_rp2040.lib_deps} densaugeo/base64 @ ~1.4.0 +lib_ignore = BLE ; [env:Xiao_rp2040_companion_radio_ble] ; extends = Xiao_rp2040 From b4b0a0ee0fae9a60c25877731500b875f9dc36df Mon Sep 17 00:00:00 2001 From: taco Date: Fri, 5 Jun 2026 00:55:02 +1000 Subject: [PATCH 52/59] build fixes for nibble_screen_connect and thinknode_m2 --- variants/nibble_screen_connect/platformio.ini | 12 ++++++------ variants/thinknode_m2/platformio.ini | 10 +++++++--- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/variants/nibble_screen_connect/platformio.ini b/variants/nibble_screen_connect/platformio.ini index a496a2fe..20f7dc24 100644 --- a/variants/nibble_screen_connect/platformio.ini +++ b/variants/nibble_screen_connect/platformio.ini @@ -18,7 +18,7 @@ build_flags = -D HAS_NEOPIXEL -D NEOPIXEL_COUNT=1 -D NEOPIXEL_DATA=21 - -D NEOPIXEL_TYPE=(NEO_GRB+NEO_KHZ800) + -D NEOPIXEL_TYPE=NEO_GRB+NEO_KHZ800 -D SX126X_DIO2_AS_RF_SWITCH=true -D SX126X_DIO3_TCXO_VOLTAGE=1.8 -D SX126X_CURRENT_LIMIT=140 @@ -159,8 +159,8 @@ lib_deps = ${nibble_screen_connect_base.lib_deps} densaugeo/base64 @ ~1.4.0 - -[env:nibble_screen_connect_kiss_modem] -extends = nibble_screen_connect_base -build_src_filter = ${nibble_screen_connect_base.build_src_filter} - +<../examples/kiss_modem/> + +[env:nibble_screen_connect_kiss_modem] +extends = nibble_screen_connect_base +build_src_filter = ${nibble_screen_connect_base.build_src_filter} + +<../examples/kiss_modem/> diff --git a/variants/thinknode_m2/platformio.ini b/variants/thinknode_m2/platformio.ini index 99015501..aae83324 100644 --- a/variants/thinknode_m2/platformio.ini +++ b/variants/thinknode_m2/platformio.ini @@ -34,7 +34,6 @@ build_flags = ${esp32_base.build_flags} build_src_filter = ${esp32_base.build_src_filter} + + - + +<../variants/thinknode_m2> lib_deps = ${esp32_base.lib_deps} adafruit/Adafruit SH110X @ ~2.1.13 @@ -144,6 +143,7 @@ build_flags = build_src_filter = ${ThinkNode_M2.build_src_filter} + + + + +<../examples/companion_radio/*.cpp> +<../examples/companion_radio/ui-new/*.cpp> lib_deps = @@ -162,6 +162,7 @@ build_flags = build_src_filter = ${ThinkNode_M2.build_src_filter} + + + + +<../examples/companion_radio/*.cpp> +<../examples/companion_radio/ui-new/*.cpp> lib_deps = @@ -183,6 +184,7 @@ build_flags = build_src_filter = ${ThinkNode_M2.build_src_filter} + + + + +<../examples/companion_radio/*.cpp> +<../examples/companion_radio/ui-new/*.cpp> lib_deps = @@ -197,18 +199,20 @@ build_flags = -I examples/companion_radio/ui-new -D MAX_CONTACTS=350 -D MAX_GROUP_CHANNELS=40 - -D SERIAL_TX=D6 - -D SERIAL_RX=D7 + -D SERIAL_TX=43 + -D SERIAL_RX=44 ; -D MESH_PACKET_LOGGING=1 ; -D MESH_DEBUG=1 build_src_filter = ${ThinkNode_M2.build_src_filter} + + + + +<../examples/companion_radio/*.cpp> +<../examples/companion_radio/ui-new/*.cpp> lib_deps = ${ThinkNode_M2.lib_deps} densaugeo/base64 @ ~1.4.0 + end2endzone/NonBlockingRTTTL@^1.3.0 [env:ThinkNode_M2_kiss_modem] extends = ThinkNode_M2 From 397ac6144ff5835481fd49d0912868b99fd7755d Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Sat, 6 Jun 2026 12:45:35 +1000 Subject: [PATCH 53/59] * number allocations: Ripple range reserved --- docs/number_allocations.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/number_allocations.md b/docs/number_allocations.md index 98ad86c7..857525d4 100644 --- a/docs/number_allocations.md +++ b/docs/number_allocations.md @@ -16,6 +16,7 @@ Once you have a working app/project, you need to be able to demonstrate it exist |-----------------|-----------------------------|-------------------------------------------------------------------| | 0000 - 00FF | -reserved for internal use- | | | 0100 | MeshCore Open | zsylvester@monitormx.com — https://github.com/zjs81/meshcore-open | +| 0110 - 011F | Ripple | ripple_biz@protonmail.com — https://buymeacoffee.com/ripplebiz | | FF00 - FFFF | -reserved for testing/dev- | | (add rows, inside the range 0100 - FEFF for custom apps) From 5f6821bb66a5c2dcec2d8efaab01fdeeeccea324 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Sat, 6 Jun 2026 13:09:24 +1000 Subject: [PATCH 54/59] * new CLI config: flood.max.advert (default 16) --- examples/simple_repeater/MyMesh.cpp | 2 ++ examples/simple_room_server/MyMesh.cpp | 2 ++ src/helpers/CommonCLI.cpp | 31 ++++++++++++++++++-------- src/helpers/CommonCLI.h | 1 + 4 files changed, 27 insertions(+), 9 deletions(-) diff --git a/examples/simple_repeater/MyMesh.cpp b/examples/simple_repeater/MyMesh.cpp index c24e297c..16e10514 100644 --- a/examples/simple_repeater/MyMesh.cpp +++ b/examples/simple_repeater/MyMesh.cpp @@ -431,6 +431,7 @@ bool MyMesh::allowPacketForward(const mesh::Packet *packet) { if (packet->isRouteFlood()) { if (packet->getPathHashCount() >= _prefs.flood_max) return false; if (packet->getRouteType() == ROUTE_TYPE_FLOOD && packet->getPathHashCount() >= _prefs.flood_max_unscoped) return false; + if (packet->getPayloadType() == PAYLOAD_TYPE_ADVERT && packet->getPathHashCount() >= _prefs.flood_max_advert) return false; } if (packet->isRouteFlood() && recv_pkt_region == NULL) { MESH_DEBUG_PRINTLN("allowPacketForward: unknown transport code, or wildcard not allowed for FLOOD packet"); @@ -890,6 +891,7 @@ MyMesh::MyMesh(mesh::MainBoard &board, mesh::Radio &radio, mesh::MillisecondCloc _prefs.flood_advert_interval = 47; // 47 hours _prefs.flood_max = 64; _prefs.flood_max_unscoped = 64; + _prefs.flood_max_advert = 16; _prefs.interference_threshold = 0; // disabled // bridge defaults diff --git a/examples/simple_room_server/MyMesh.cpp b/examples/simple_room_server/MyMesh.cpp index e3710d27..33d212bd 100644 --- a/examples/simple_room_server/MyMesh.cpp +++ b/examples/simple_room_server/MyMesh.cpp @@ -285,6 +285,7 @@ bool MyMesh::allowPacketForward(const mesh::Packet *packet) { if (packet->isRouteFlood()) { if (packet->getPathHashCount() >= _prefs.flood_max) return false; if (packet->getRouteType() == ROUTE_TYPE_FLOOD && packet->getPathHashCount() >= _prefs.flood_max_unscoped) return false; + if (packet->getPayloadType() == PAYLOAD_TYPE_ADVERT && packet->getPathHashCount() >= _prefs.flood_max_advert) return false; } return true; } @@ -647,6 +648,7 @@ MyMesh::MyMesh(mesh::MainBoard &board, mesh::Radio &radio, mesh::MillisecondCloc _prefs.flood_advert_interval = 47; // 47 hours _prefs.flood_max = 64; _prefs.flood_max_unscoped = 64; + _prefs.flood_max_advert = 16; _prefs.interference_threshold = 0; // disabled #ifdef ROOM_PASSWORD StrHelper::strncpy(_prefs.guest_password, ROOM_PASSWORD, sizeof(_prefs.guest_password)); diff --git a/src/helpers/CommonCLI.cpp b/src/helpers/CommonCLI.cpp index d39251ef..b78ad6eb 100644 --- a/src/helpers/CommonCLI.cpp +++ b/src/helpers/CommonCLI.cpp @@ -90,7 +90,8 @@ void CommonCLI::loadPrefsInt(FILESYSTEM* fs, const char* filename) { file.read((uint8_t *)_prefs->owner_info, sizeof(_prefs->owner_info)); // 170 file.read((uint8_t *)&_prefs->rx_boosted_gain, sizeof(_prefs->rx_boosted_gain)); // 290 file.read((uint8_t *)&_prefs->flood_max_unscoped, sizeof(_prefs->flood_max_unscoped)); // 291 - // next: 292 + file.read((uint8_t *)&_prefs->flood_max_advert, sizeof(_prefs->flood_max_advert)); // 292 + // next: 293 // sanitise bad pref values _prefs->rx_delay_base = constrain(_prefs->rx_delay_base, 0, 20.0f); @@ -182,7 +183,8 @@ void CommonCLI::savePrefs(FILESYSTEM* fs) { file.write((uint8_t *)_prefs->owner_info, sizeof(_prefs->owner_info)); // 170 file.write((uint8_t *)&_prefs->rx_boosted_gain, sizeof(_prefs->rx_boosted_gain)); // 290 file.write((uint8_t *)&_prefs->flood_max_unscoped, sizeof(_prefs->flood_max_unscoped)); // 291 - // next: 292 + file.write((uint8_t *)&_prefs->flood_max_advert, sizeof(_prefs->flood_max_advert)); // 292 + // next: 293 file.close(); } @@ -610,24 +612,33 @@ void CommonCLI::handleSetCmd(uint32_t sender_timestamp, char* command, char* rep } else { strcpy(reply, "Error, must be 0-2"); } - } else if (memcmp(config, "flood.max ", 10) == 0) { - uint8_t m = atoi(&config[10]); + } else if (memcmp(config, "flood.max.unscoped ", 19) == 0) { + uint8_t m = atoi(&config[19]); if (m <= 64) { - _prefs->flood_max = m; + _prefs->flood_max_unscoped = m; + savePrefs(); + strcpy(reply, "OK"); + } else { + strcpy(reply, "Error, max 64"); + } + } else if (memcmp(config, "flood.max.advert ", 17) == 0) { + uint8_t m = atoi(&config[17]); + if (m <= 64) { + _prefs->flood_max_advert = m; savePrefs(); strcpy(reply, "OK"); } else { strcpy(reply, "Error, max 64"); } - } else if (memcmp(config, "flood.max.unscoped ", 19) == 0) { - uint8_t m = atoi(&config[19]); + } else if (memcmp(config, "flood.max ", 10) == 0) { + uint8_t m = atoi(&config[10]); if (m <= 64) { - _prefs->flood_max_unscoped = m; + _prefs->flood_max = m; savePrefs(); strcpy(reply, "OK"); } else { strcpy(reply, "Error, max 64"); - } + } } else if (memcmp(config, "direct.txdelay ", 15) == 0) { float f = atof(&config[15]); if (f >= 0 && f <= 2.0f) { @@ -803,6 +814,8 @@ void CommonCLI::handleGetCmd(uint32_t sender_timestamp, char* command, char* rep sprintf(reply, "> %s", StrHelper::ftoa(_prefs->rx_delay_base)); } else if (memcmp(config, "txdelay", 7) == 0) { sprintf(reply, "> %s", StrHelper::ftoa(_prefs->tx_delay_factor)); + } else if (memcmp(config, "flood.max.advert", 16) == 0) { + sprintf(reply, "> %d", (uint32_t)_prefs->flood_max_advert); } else if (memcmp(config, "flood.max.unscoped", 18) == 0) { sprintf(reply, "> %d", (uint32_t)_prefs->flood_max_unscoped); } else if (memcmp(config, "flood.max", 9) == 0) { diff --git a/src/helpers/CommonCLI.h b/src/helpers/CommonCLI.h index fedc0534..b509c2b3 100644 --- a/src/helpers/CommonCLI.h +++ b/src/helpers/CommonCLI.h @@ -41,6 +41,7 @@ struct NodePrefs { // persisted to file float bw; uint8_t flood_max; uint8_t flood_max_unscoped; + uint8_t flood_max_advert; uint8_t interference_threshold; uint8_t agc_reset_interval; // secs / 4 // Bridge settings From 6a9a84e8a5aee7bfbaaa382cb1017de20820c1ae Mon Sep 17 00:00:00 2001 From: IoTThinks Date: Sat, 6 Jun 2026 11:04:36 +0700 Subject: [PATCH 55/59] Change default power saving setting to 'off' --- docs/cli_commands.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cli_commands.md b/docs/cli_commands.md index 8d4ae0f9..4a203f16 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md @@ -406,7 +406,7 @@ This document provides an overview of CLI commands that can be sent to MeshCore - `on`: enable power saving - `off`: disable power saving -**Default:** `on` +**Default:** `off` **Note:** When enabled, device enters sleep mode between radio transmissions From 8fc2da5c9828874c3b506a0b880e59cd2a98e740 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Sat, 6 Jun 2026 21:00:58 +1000 Subject: [PATCH 56/59] * default now 8, per the will of the peoples. --- examples/simple_repeater/MyMesh.cpp | 2 +- examples/simple_room_server/MyMesh.cpp | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/simple_repeater/MyMesh.cpp b/examples/simple_repeater/MyMesh.cpp index 16e10514..09690749 100644 --- a/examples/simple_repeater/MyMesh.cpp +++ b/examples/simple_repeater/MyMesh.cpp @@ -891,7 +891,7 @@ MyMesh::MyMesh(mesh::MainBoard &board, mesh::Radio &radio, mesh::MillisecondCloc _prefs.flood_advert_interval = 47; // 47 hours _prefs.flood_max = 64; _prefs.flood_max_unscoped = 64; - _prefs.flood_max_advert = 16; + _prefs.flood_max_advert = 8; _prefs.interference_threshold = 0; // disabled // bridge defaults diff --git a/examples/simple_room_server/MyMesh.cpp b/examples/simple_room_server/MyMesh.cpp index 33d212bd..98b22fdb 100644 --- a/examples/simple_room_server/MyMesh.cpp +++ b/examples/simple_room_server/MyMesh.cpp @@ -648,7 +648,7 @@ MyMesh::MyMesh(mesh::MainBoard &board, mesh::Radio &radio, mesh::MillisecondCloc _prefs.flood_advert_interval = 47; // 47 hours _prefs.flood_max = 64; _prefs.flood_max_unscoped = 64; - _prefs.flood_max_advert = 16; + _prefs.flood_max_advert = 8; _prefs.interference_threshold = 0; // disabled #ifdef ROOM_PASSWORD StrHelper::strncpy(_prefs.guest_password, ROOM_PASSWORD, sizeof(_prefs.guest_password)); From 8c0d5c5b24148f50dd619bd213225be677d0e454 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Sat, 6 Jun 2026 21:07:03 +1000 Subject: [PATCH 57/59] * version 1.16.0 --- examples/companion_radio/MyMesh.h | 4 ++-- examples/simple_repeater/MyMesh.h | 4 ++-- examples/simple_room_server/MyMesh.h | 4 ++-- examples/simple_sensor/SensorMesh.h | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/examples/companion_radio/MyMesh.h b/examples/companion_radio/MyMesh.h index bbb0d4cb..43d3950b 100644 --- a/examples/companion_radio/MyMesh.h +++ b/examples/companion_radio/MyMesh.h @@ -8,11 +8,11 @@ #define FIRMWARE_VER_CODE 13 #ifndef FIRMWARE_BUILD_DATE -#define FIRMWARE_BUILD_DATE "19 Apr 2026" +#define FIRMWARE_BUILD_DATE "6 Jun 2026" #endif #ifndef FIRMWARE_VERSION -#define FIRMWARE_VERSION "v1.15.0" +#define FIRMWARE_VERSION "v1.16.0" #endif #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) diff --git a/examples/simple_repeater/MyMesh.h b/examples/simple_repeater/MyMesh.h index 8ed0317e..7597c6c6 100644 --- a/examples/simple_repeater/MyMesh.h +++ b/examples/simple_repeater/MyMesh.h @@ -69,11 +69,11 @@ struct NeighbourInfo { }; #ifndef FIRMWARE_BUILD_DATE - #define FIRMWARE_BUILD_DATE "19 Apr 2026" + #define FIRMWARE_BUILD_DATE "6 Jun 2026" #endif #ifndef FIRMWARE_VERSION - #define FIRMWARE_VERSION "v1.15.0" + #define FIRMWARE_VERSION "v1.16.0" #endif #define FIRMWARE_ROLE "repeater" diff --git a/examples/simple_room_server/MyMesh.h b/examples/simple_room_server/MyMesh.h index 1b35ae95..5277ddad 100644 --- a/examples/simple_room_server/MyMesh.h +++ b/examples/simple_room_server/MyMesh.h @@ -27,11 +27,11 @@ /* ------------------------------ Config -------------------------------- */ #ifndef FIRMWARE_BUILD_DATE - #define FIRMWARE_BUILD_DATE "19 Apr 2026" + #define FIRMWARE_BUILD_DATE "6 Jun 2026" #endif #ifndef FIRMWARE_VERSION - #define FIRMWARE_VERSION "v1.15.0" + #define FIRMWARE_VERSION "v1.16.0" #endif #ifndef LORA_FREQ diff --git a/examples/simple_sensor/SensorMesh.h b/examples/simple_sensor/SensorMesh.h index 424b16c1..c9f135f6 100644 --- a/examples/simple_sensor/SensorMesh.h +++ b/examples/simple_sensor/SensorMesh.h @@ -34,11 +34,11 @@ #define PERM_RECV_ALERTS_HI (1 << 7) // high priority alerts #ifndef FIRMWARE_BUILD_DATE - #define FIRMWARE_BUILD_DATE "19 Apr 2026" + #define FIRMWARE_BUILD_DATE "6 Jun 2026" #endif #ifndef FIRMWARE_VERSION - #define FIRMWARE_VERSION "v1.15.0" + #define FIRMWARE_VERSION "v1.16.0" #endif #define FIRMWARE_ROLE "sensor" From 07bfe9069565729205d79edf4cd2a0071b22fe3f Mon Sep 17 00:00:00 2001 From: liamcottle Date: Tue, 9 Jun 2026 00:31:48 +1200 Subject: [PATCH 58/59] free packet on parse failure --- examples/companion_radio/MyMesh.cpp | 1 + 1 file changed, 1 insertion(+) diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp index 6fbb0f74..07353988 100644 --- a/examples/companion_radio/MyMesh.cpp +++ b/examples/companion_radio/MyMesh.cpp @@ -1981,6 +1981,7 @@ void MyMesh::handleCmdFrame(size_t len) { sendPacket(pkt, priority, 0); writeOKFrame(); } else { + _mgr->free(pkt); writeErrFrame(ERR_CODE_ILLEGAL_ARG); } } else { From ae0bb7ee9544db0a0eb05ce7405432cb8ed6496a Mon Sep 17 00:00:00 2001 From: liamcottle Date: Tue, 9 Jun 2026 00:42:58 +1200 Subject: [PATCH 59/59] use releasePacket instead of _mgr->free --- examples/companion_radio/MyMesh.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp index 07353988..c468967f 100644 --- a/examples/companion_radio/MyMesh.cpp +++ b/examples/companion_radio/MyMesh.cpp @@ -1981,7 +1981,7 @@ void MyMesh::handleCmdFrame(size_t len) { sendPacket(pkt, priority, 0); writeOKFrame(); } else { - _mgr->free(pkt); + releasePacket(pkt); writeErrFrame(ERR_CODE_ILLEGAL_ARG); } } else {