From 2f6046d7ba017c1cff78bae45549a1abd7ddf656 Mon Sep 17 00:00:00 2001 From: liamcottle Date: Tue, 24 Mar 2026 15:38:15 +1300 Subject: [PATCH 01/19] update docs cname --- .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 d50a044c..5fd2734b 100644 --- a/.github/workflows/github-pages.yml +++ b/.github/workflows/github-pages.yml @@ -31,6 +31,6 @@ jobs: uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - cname: docs.meshcore.nz + cname: docs.meshcore.io publish_dir: ./site publish_branch: 'gh-pages' From aad1cf81da662cd164ee9bd79fa7a2c419f1a50f Mon Sep 17 00:00:00 2001 From: uncle lit <43320854+LitBomb@users.noreply.github.com> Date: Fri, 27 Mar 2026 11:39:29 -0700 Subject: [PATCH 02/19] add multibyte FAQ, reference awesome-meshcore community projects, minor changes - Add multi byte FAQ - Reword amped radio output setting numbers - Clarify repeater ID collision including distance, supercede https://github.com/meshcore-dev/MeshCore/pull/1478 - Reference awesome meshcore for community projects. Supercede https://github.com/meshcore-dev/MeshCore/pull/1893 --- docs/faq.md | 339 +++++++++++++++++++++++----------------------------- 1 file changed, 148 insertions(+), 191 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index 530f9701..4df2dcc5 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -2,101 +2,86 @@ A list of frequently-asked questions and answers for MeshCore -- [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 exisitng 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-exisitng-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 maybe 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-maybe-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) -- [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 discovery 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-discovery-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 are projects built around MeshCore?](#514-q-are-there-are-projects-built-around-meshcore) - - [5.14.1. overview](#5141-overview) - - [5.14.1.1. awesome-meshcore](#51411-awesome-meshcore) - - [5.14.2. programming libraries, command line software](#5142-programming-libraries-command-line-software) - - [5.14.2.1. meshcoremqtt](#51421-meshcoremqtt) - - [5.14.2.2. MeshCore for Home Assistant](#51422-meshcore-for-home-assistant) - - [5.14.2.3. Python MeshCore](#51423-python-meshcore) - - [5.14.2.4. meshcore-cli](#51424-meshcore-cli) - - [5.14.2.5. meshcore.js](#51425-meshcorejs) - - [5.14.2.6. pyMC\_core](#51426-pymc_core) - - [5.14.2.7. MeshCore Packet Decoder](#51427-meshcore-packet-decoder) - - [5.14.2.8. meshcore-pi](#51428-meshcore-pi) - - [5.14.2.9. pyMC\_Repeater](#51429-pymc_repeater) - - [5.14.2.10. MeshCore map auto uploader](#514210-MeshCore-map-auto-uploader) - - [5.14.3. apps, graphical software](#5143-apps-graphical-software) - - [5.14.3.1. meshcore-open](#51431-meshcore-open) - - [5.14.4. firmwares](#5144-firmwares) - - [5.14.4.1. MeshCore-Cardputer-ADV](#51441-MeshCore-Cardputer-ADV) - - [5.14.4.2. LunarCore](#51442-LunarCore) - - [5.14.4.3. MC-Term](#51443-MC-Term) - - [5.14.4.4. Meck](#51444-Meck) - - [5.14.4.5. Meshcore for Wio Tracker L1 Pro](#51445-Meshcore-for-Wio-Tracker-L1-Pro) - - [5.14.5. online services](#5145-online-services) - - [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 WIFI, e.g. using a heltec v3?](#76-q-how-do-i-connect-to-the-companion-via-wifi-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) +- [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 exisitng 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-exisitng-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 maybe 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-maybe-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 `path.hash.mode` on a repeater do?**](#394-q-what-does-pathhashmode-on-a-repeater-do) + - [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 discovery 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-discovery-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 are projects built around MeshCore?](#514-q-are-there-are-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 WIFI, e.g. using a heltec v3?](#76-q-how-do-i-connect-to-the-companion-via-wifi-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) + - [⚠️ **WARNING: Set these values at your own risk. Incorrect power settings can permanently damage your radio hardware.**](#️-warning-set-these-values-at-your-own-risk-incorrect-power-settings-can-permanently-damage-your-radio-hardware) ## 1. Introduction @@ -290,6 +275,10 @@ Reboot the repeater after `set prv.key ` command for the new private key to **A:** You can generate a new private key and specific the first byte of its public key here: https://gessaman.com/mc-keygen/ +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. + +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 maybe 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? @@ -306,6 +295,58 @@ This is a very low cost operation. AGC reset is done by simply setting `state = **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? + +**A:** + +**Background:** +The orginal 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 anyway. 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 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+ will repeat packets with 1-, 2-, or 3-byte path hash. Repeaters on firmware older than 1.14 will only repeat 1-byte path hash packets and will silently drop 2- and 3-byte packets. + +### 3.9.2. Q: **What determines a packet's path hash size?** + +The original sender. 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 1.14, you can set your companion's message path hash size in the Experimental settings section of the app. 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 `path.hash.mode` on a repeater do?** + +It *only* controls the path hash size used in that repeater's own advert broadcasts. It does **not** affect which packets the repeater forwards. A 1.14+ repeater will always forward 1-, 2-, and 3-byte packets regardless of this setting. + +You can set it with `set path.hash.mode {0|1|2}`: + +``` +┌────────────────┬───────────────────────┐ +│ path.hash.mode │ Advert path hash size │ +├────────────────┼───────────────────────┤ +│ 0 │ 1 byte (default) │ +├────────────────┼───────────────────────┤ +│ 1 │ 2 bytes │ +├────────────────┼───────────────────────┤ +│ 2 │ 3 bytes │ +└────────────────┴───────────────────────┘ +``` + +It is safe to set your 1.14+ repeaters to mode 1 or 2. + +**Why use 2- or 3-byte path hash for adverts?** + +A longer path hash helps tools like the LetsMesh Analyzer and MeshMapper disambiguate repeaters more reliably. With only 1 byte, the chance of different repeaters have the same first byte in their public key is high, making it harder to tell them apart in network analysis. Since this only affects adverts, there's no downside. 2- and 3-byte adverts don't travel as far, but it is not important for MechCore nodes to hear a repeater's advert that is 21 or 32 hops away. + +**When can we move away from 1-byte path hash?** + +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) or 2 (for 3-byte path) helps the community gauge 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 messages. + + --- ## 4. T-Deck Related @@ -618,94 +659,9 @@ From here, reference repeater and room server command line commands on MeshCore ### 5.14. Q: Are there are projects built around MeshCore? -**A:** Yes. Some of them are listed below. +**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 Asistant. -#### 5.14.1. overview - -Some resources that by themselves give overviews about MeshCore related projects: - -##### 5.14.1.1. awesome-meshcore -A meta website/ git-repository collecting many projects related to MeshCore, grouped by type. See -https://github.com/samuk/awesome-meshcore. - -#### 5.14.2. programming libraries, command line software - -##### 5.14.2.1. meshcoremqtt -A Python script to send meshcore debug and packet capture data to MQTT for analysis. Cisien's version is a fork of Andrew-a-g's and is being used to to collect data for https://map.w0z.is/messages and https://analyzer.letsmesh.net/ -https://github.com/Cisien/meshcoretomqtt -https://github.com/Andrew-a-g/meshcoretomqtt - -##### 5.14.2.2. MeshCore for Home Assistant -A custom Home Assistant integration for MeshCore mesh radio nodes. It allows you to monitor and control MeshCore nodes via USB, BLE, or TCP connections. -https://github.com/awolden/meshcore-ha - -##### 5.14.2.3. Python MeshCore -Bindings to access your MeshCore companion radio nodes in python. -https://github.com/fdlamotte/meshcore_py - -##### 5.14.2.4. meshcore-cli -CLI interface to MeshCore companion radio over BLE, TCP, or serial. Uses Python MeshCore above. - https://github.com/fdlamotte/meshcore-cli - -##### 5.14.2.5. meshcore.js -A JavaScript library for interacting with a MeshCore device running the companion radio firmware -https://github.com/liamcottle/meshcore.js - -##### 5.14.2.6. pyMC_core -pyMC_Core is a Python port of MeshCore, designed for Raspberry Pi and similar hardware, it talks to LoRa modules over SPI. -https://github.com/rightup/pyMC_core - -##### 5.14.2.7. MeshCore Packet Decoder -A TypeScript library for decoding MeshCore mesh networking packets with full cryptographic support. Uses WebAssembly (WASM) for Ed25519 key derivation through the orlp/ed25519 library. It powers the [MeshCore Packet Analyzer](https://analyzer.letsmesh.net/packets). -https://github.com/michaelhart/meshcore-decoder - -##### 5.14.2.8. meshcore-pi -meshcore-pi is another Python port of MeshCore, designed for Raspberry Pi and similar hardware, it talks to LoRa modules over SPI or GPIO. -https://github.com/brianwiddas/meshcore-pi - -##### 5.14.2.9. pyMC_Repeater -pyMC_Repeater is a repeater daemon in Python built on top of the [`pymc_core`](#5146-pymc_core) library. -https://github.com/rightup/pyMC_Repeater - -##### 5.14.2.10. MeshCore map auto uploader -A Node.js software that will upload every repeater or room server to [map.meshcore.dev](https://map.meshcore.dev/) when a connected companion hears new advert. -https://github.com/recrof/map.meshcore.dev-uploader - -#### 5.14.3. apps, graphical software - -##### 5.14.3.1. meshcore-open -Open Source companion app for Android, iOS, GNU/Linux (and maybe other Unixes), Windows, macOS, chromium-based browsers. -https://github.com/zjs81/meshcore-open - -#### 5.14.4. firmwares - -##### 5.14.4.1. MeshCore-Cardputer-ADV -Standalone client firmware for the "[M5Stack Cardputer ADV](https://docs.m5stack.com/en/core/Cardputer-Adv)" with the "[M5Stack Cap LoRa-1262](https://docs.m5stack.com/en/cap/Cap_LoRa-1262)" module. - -There are two variants: - -* https://github.com/Stachugit/MeshCore-Cardputer-ADV, -* https://github.com/sosprz/meshcore-cardputer-adv. - -##### 5.14.4.2. LunarCore -Multi-protocol mesh firmware for ESP32-S3 LoRa devices (MeshCore, Meshtastic, RNode/KISS (Reticulum)). Protocol is auto-detected from the first bytes over serial or BLE. -https://github.com/STCisGOOD/lunarcore - -##### 5.14.4.3. MC-Term -(Soon to be) Open Source companion firmware for [LilyGO T-Deck (Plus)](https://lilygo.cc/en-us/products/t-deck-plus-1) and [Seeed Studio SenseCap Indicator (TFT / D1Pro)](https://www.seeedstudio.com/SenseCAP-Indicator-D1Pro-p-5644.html), that can be used both standalone and together with a companion app. -https://github.com/dabeani/meshcore - -##### 5.14.4.4. Meck -Companion firmware for [LilyGo T-Deck Pro](https://lilygo.cc/products/t-deck-pro) that allows standalone operation and connection to a companion app via Bluetooth Low Energy (BLE). -https://github.com/pelgraine/Meck - -##### 5.14.4.5. Meshcore for Wio Tracker L1 Pro -Companion firmware for [Seeed Studio Wio Tracker L1 Pro](https://www.seeedstudio.com/Wio-Tracker-L1-Pro-p-6454.html) with specific UI adjustments that can be used standalone. -https://github.com/sosprz/Meshcore-Wio-Tracker-L1-Pro - -#### 5.14.5. online services - -*(None yet listed here. See [overview ressources](#5141-overview).)* +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 exhausive 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? @@ -866,17 +822,18 @@ Edit WIFI_SSID and WIFI_PWD in `./variants/heltec_v3/platformio.ini` and then fl 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 comand `get tx` -> ### ⚠️ **WARNING: Set these values at your own risk. Incorrect power settings can permanently damage your radio hardware.** + ### ⚠️ **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 | | :--- | :--- | :--- | :--- | :--- | | **Station G2**
[Reference](https://wiki.uniteng.com/en/meshtastic/station-g2) | US915 Max Output | 19 dBm | 36.5 dBm (4.46W) | | -| | US915 Recommended Max | 16 dBm | 35 dBm (3.16W) | 1dB compression point | -| | EU868 Recommended Max | 15 dBm | 34.5 dBm (2.82W) | 1dB compression point | -| | US915 1W Output | 10 dBm | 1W | | -| | EU868 1W Output | 9 dBm | 1W | | -| **Ikoka Stick E22-900M30S** | 1W Model | 19 dBm | 1W | **DO NOT EXCEED** (Risk of burn out) | -| **Ikoka Stick E22-900M33S** | 2W Model | 9 dBm | 2W | **DO NOT EXCEED** (Risk of burn out) | -| **Heltec V4** | Standard Output | 10 dBm | 22 dBm | | -| | High Output | 22 dBm | 28 dBm | | +| | US915 Max at 1dB compression point | 16 dBm | 35 dBm (3.16W) | 1dB compression point | +| | EU868 Max at 1dB compression point | 15 dBm | 34.5 dBm (2.82W) | 1dB compression point | +| | US915 1W Output | 10 dBm | 1W | Refer to your local government's requirements | +| | EU868 1W Output | 9 dBm | 1W |Refer to your local government's requirements | +| **Ikoka Stick E22-900M30S** | 1W Model | 19 dBm | 1W | **DO NOT EXCEED** (Risk of burn out) [data sheet](https://www.cdebyte.com/pdf-down.aspx?id=4216) | +| **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) | | + --- From 7268d7d0d3f72bfa289d95e0425dccfbb86258b5 Mon Sep 17 00:00:00 2001 From: Jim Schrempp Date: Fri, 27 Mar 2026 15:51:36 -0700 Subject: [PATCH 03/19] Update RAK 4631 entry in FAQ on new bootloader Removed "see note" from RAK 4631 entry in FAQ. --- docs/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/faq.md b/docs/faq.md index 530f9701..95e74d13 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -833,7 +833,7 @@ Currently, the following boards are supported: - Seeed Studio Wio Tracker L1 - Seeed Studio XIAO nRF52840 BLE - Seeed Studio XIAO nRF52840 BLE SENSE -- RAK 4631 (See note) +- RAK 4631 - RAK WisMesh Tag (new 28/11/2025) ### 7.4. Q: are the MeshCore logo and font available? From ea6ec53709a7a3defd2490ffa554216630e993e7 Mon Sep 17 00:00:00 2001 From: uncle lit <43320854+LitBomb@users.noreply.github.com> Date: Sun, 29 Mar 2026 16:22:41 -0700 Subject: [PATCH 04/19] Fix TOC insertion by Markdown All in One VS Code extension Fixed an extra TOC jump link inserted by VSCode Markdown All in One VS Code extension. --- docs/faq.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index 4df2dcc5..502b71b5 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -81,7 +81,6 @@ A list of frequently-asked questions and answers for MeshCore - [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 WIFI, e.g. using a heltec v3?](#76-q-how-do-i-connect-to-the-companion-via-wifi-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) - - [⚠️ **WARNING: Set these values at your own risk. Incorrect power settings can permanently damage your radio hardware.**](#️-warning-set-these-values-at-your-own-risk-incorrect-power-settings-can-permanently-damage-your-radio-hardware) ## 1. Introduction @@ -822,7 +821,7 @@ Edit WIFI_SSID and WIFI_PWD in `./variants/heltec_v3/platformio.ini` and then fl 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 comand `get tx` - ### ⚠️ **WARNING: Set these values at your own risk. Incorrect power settings can permanently damage your radio hardware.** + ⚠️ **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 30963231ce630766fef44727cb1519a73cd5c3ca Mon Sep 17 00:00:00 2001 From: liamcottle Date: Tue, 31 Mar 2026 00:51:15 +1300 Subject: [PATCH 05/19] update docs logo --- docs/_assets/meshcore.svg | 12 ++++++++++++ mkdocs.yml | 2 +- 2 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 docs/_assets/meshcore.svg diff --git a/docs/_assets/meshcore.svg b/docs/_assets/meshcore.svg new file mode 100644 index 00000000..eb1b7bc4 --- /dev/null +++ b/docs/_assets/meshcore.svg @@ -0,0 +1,12 @@ + + + + + + + + + + + + diff --git a/mkdocs.yml b/mkdocs.yml index 3a76842f..110680cd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,7 +8,7 @@ edit_uri: edit/main/docs/ theme: name: material - logo: _assets/meshcore_tm.svg + logo: _assets/meshcore.svg features: - content.action.edit - content.code.copy From 633db082d14a141dc9af25b8fe5ea2f961e82b30 Mon Sep 17 00:00:00 2001 From: uncle lit <43320854+LitBomb@users.noreply.github.com> Date: Tue, 31 Mar 2026 12:22:11 -0700 Subject: [PATCH 06/19] fixed typos and refined multibyte sections. fixed typos and refined multibyte sections. --- docs/faq.md | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index 502b71b5..36cd3fc8 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -30,7 +30,9 @@ A list of frequently-asked questions and answers for MeshCore - [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 `path.hash.mode` on a repeater do?**](#394-q-what-does-pathhashmode-on-a-repeater-do) + - [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) @@ -297,31 +299,31 @@ This is a very low cost operation. AGC reset is done by simply setting `state = ### 3.9. Q: What is multi-byte support? What do 1-byte, 2-byte, 3-byte adverts and messages mean? **A:** - -**Background:** -The orginal 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 anyway. 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 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?** -Repeaters running firmware 1.14+ will repeat packets with 1-, 2-, or 3-byte path hash. Repeaters on firmware older than 1.14 will only repeat 1-byte path hash packets and will silently drop 2- and 3-byte packets. +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 sender. The most common original sender is a companion app. The other common original sender is a repeater, when it broadcasts its advert. +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 1.14, you can set your companion's message path hash size in the Experimental settings section of the app. 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. +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`. -### 3.9.4. Q: **What does `path.hash.mode` on a repeater do?** +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. -It *only* controls the path hash size used in that repeater's own advert broadcasts. It does **not** affect which packets the repeater forwards. A 1.14+ repeater will always forward 1-, 2-, and 3-byte packets regardless of this setting. +### 3.9.4. Q: **What does the CLI command `path.hash.mode` do on a repeater?** -You can set it with `set path.hash.mode {0|1|2}`: +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}`: ``` ┌────────────────┬───────────────────────┐ @@ -337,13 +339,13 @@ You can set it with `set path.hash.mode {0|1|2}`: It is safe to set your 1.14+ repeaters to mode 1 or 2. -**Why use 2- or 3-byte path hash for adverts?** +### 3.9.5. Q: **Why use 2- or 3-byte path hash for adverts?** -A longer path hash helps tools like the LetsMesh Analyzer and MeshMapper disambiguate repeaters more reliably. With only 1 byte, the chance of different repeaters have the same first byte in their public key is high, making it harder to tell them apart in network analysis. Since this only affects adverts, there's no downside. 2- and 3-byte adverts don't travel as far, but it is not important for MechCore nodes to hear a repeater's advert that is 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 are 21 or 32 hops away. -**When can we move away from 1-byte path hash?** +### 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) or 2 (for 3-byte path) helps the community gauge 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 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. --- From a9b55f58f1611487c5cce485392b610e191a392c Mon Sep 17 00:00:00 2001 From: liamcottle Date: Thu, 2 Apr 2026 23:24:17 +1300 Subject: [PATCH 07/19] update neighbor.remove docs --- docs/cli_commands.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/cli_commands.md b/docs/cli_commands.md index 8ae95443..0e785f4e 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md @@ -102,7 +102,9 @@ This document provides an overview of CLI commands that can be sent to MeshCore - `neighbor.remove ` **Parameters:** -- `pubkey_prefix`: The public key of the node to remove from the neighbors list +- `pubkey_prefix`: The public key of the node to remove from the neighbors list. This can be a short prefix or the full key. All neighbors matching the provided prefix will be removed. + +**Note:** You can remove all neighbors by sending a space character as the prefix. The space indicates an empty prefix, which matches all existing neighbors. --- From 8ede764104a2766b227aa36fbd1822759f62f82d Mon Sep 17 00:00:00 2001 From: liamcottle Date: Fri, 3 Apr 2026 17:07:02 +1300 Subject: [PATCH 08/19] update readme links --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3a671f0b..ebad1f6f 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,8 @@ 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. -- Read through our [Frequently Asked Questions](./docs/faq.md) section. +- 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. - Connect with a supported client. @@ -51,7 +52,7 @@ The Simple Secure Chat example can be interacted with through the Serial Monitor We have prebuilt firmware ready to flash on supported devices. -- Launch https://flasher.meshcore.co.uk +- Launch https://meshcore.io/flasher - Select a supported device - Flash one of the firmware types: - Companion, Repeater or Room Server @@ -73,13 +74,13 @@ The companion firmware can be connected to via BLE, USB or WiFi depending on the The repeater and room server firmwares can be setup via USB in the web config tool. -- https://config.meshcore.dev +- https://config.meshcore.io They can also be managed via LoRa in the mobile app by using the Remote Management feature. ## 🛠 Hardware Compatibility -MeshCore is designed for devices listed in the [MeshCore Flasher](https://flasher.meshcore.co.uk) +MeshCore is designed for devices listed in the [MeshCore Flasher](https://meshcore.io/flasher) ## 📜 License From c0252ab82c1826f0842f193cf2c2b83983a74d21 Mon Sep 17 00:00:00 2001 From: Wessel Nieboer Date: Fri, 13 Mar 2026 14:06:09 +0100 Subject: [PATCH 09/19] Add sanity build for LR1110 and SX1276 too --- .github/workflows/pr-build-check.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/pr-build-check.yml b/.github/workflows/pr-build-check.yml index 37f3701b..67468b56 100644 --- a/.github/workflows/pr-build-check.yml +++ b/.github/workflows/pr-build-check.yml @@ -39,6 +39,10 @@ jobs: - wio-e5-mini_repeater # ESP32-C6 - LilyGo_Tlora_C6_repeater_ + # LR1110 (nRF52) + - wio_wm1110_repeater + # SX1276 (ESP32) + - Tbeam_SX1276_repeater steps: - name: Clone Repo From a5ae89aac011e09a059e078f113df7abde8bbbbb Mon Sep 17 00:00:00 2001 From: Wessel Nieboer Date: Thu, 12 Mar 2026 05:32:27 +0100 Subject: [PATCH 10/19] Fix RAK4631 SX1262 hardware pin config --- variants/rak4631/variant.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/variants/rak4631/variant.h b/variants/rak4631/variant.h index 142d93e9..38cc8868 100644 --- a/variants/rak4631/variant.h +++ b/variants/rak4631/variant.h @@ -147,7 +147,7 @@ extern "C" // LoRa radio module pins for RAK4631 #define P_LORA_DIO_1 (47) #define P_LORA_NSS (42) -#define P_LORA_RESET (-1) +#define P_LORA_RESET (38) #define P_LORA_BUSY (46) #define P_LORA_SCLK (43) #define P_LORA_MISO (45) From 9ec08228e50f22b0f8fac4a545fd275739664977 Mon Sep 17 00:00:00 2001 From: liamcottle Date: Sun, 5 Apr 2026 22:04:36 +1200 Subject: [PATCH 11/19] update faq --- docs/faq.md | 56 ++++++++++++++++++++++++++--------------------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index 36cd3fc8..46741d1c 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -88,7 +88,7 @@ A list of frequently-asked questions and answers for MeshCore ### 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.co.uk/)) +**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/)) MeshCore is free and open source: * MeshCore is the routing and firmware etc, available on GitHub under MIT license @@ -106,19 +106,20 @@ Anyone is able to build anything they like on top of MeshCore without paying any ### 1.2. Q: What do you need to start using MeshCore? **A:** Everything you need for MeshCore is available at: -- Main web site: [https://meshcore.co.uk](https://meshcore.co.uk) -- Firmware Flasher: [https://flasher.meshcore.co.uk](https://flasher.meshcore.co.uk) +- Main Website: [https://meshcore.io](https://meshcore.io) +- Firmware Flasher: [https://flasher.meshcore.io](https://flasher.meshcore.io) - MeshCore Firmware on GitHub: [https://github.com/meshcore-dev/MeshCore](https://github.com/meshcore-dev/MeshCore) -- MeshCore Companion App: [https://meshcore.nz](https://meshcore.nz) -- MeshCore Map: [https://meshcore.co.uk/map.html](https://meshcore.co.uk/map.html) -- Andy Kirby has a very useful [intro video](https://www.youtube.com/watch?v=t1qne8uJBAc) for beginners. +- 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). #### 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.co.uk/ +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. @@ -130,12 +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. @@ -229,11 +229,11 @@ The separate `set advert.interval {minutes}` command controls the local zero-hop 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 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. ![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.co.uk/, then use the `console` feature to connect to the device +- 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. @@ -365,7 +365,7 @@ You should move to send 2-byte or 3-byte channel and direct messages when the va 5. Hear USB connection sound 6. Release trackball 7. T-Deck in DFU mode now -8. At this point you can begin flashing using +8. At this point you can begin flashing using ### 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. @@ -586,7 +586,7 @@ MeshCore clients would need to reset path constantly and flood traffic across th 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://meshcore.co.uk/map.html) +### 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` @@ -603,18 +603,18 @@ 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 flasher.meshcore.co.uk +- Download firmware file from https://flasher.meshcore.io - Go to the web site on a browser, find the section that has the firmware up 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.dev/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.dev/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 + - `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.dev/releases/download/companion-v1.7.1/Heltec_v3_companion_radio_usb-v1.7.1-165fb33.bin"` + - `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 @@ -631,14 +631,14 @@ 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 flasher.meshcore.co.uk +- Download firmware file from https://flasher.meshcore.io - Go to the web site on a browser, find the section that has the firmware up 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.dev/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.dev/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 + - `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 @@ -666,10 +666,10 @@ As new MeshCore community projects become available on a weekly basis, we have s ### 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 Intel Mac (sorry, not available for ARM-based Mac yet). 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 Intel Mac versions of the client app are fully unlocked and are free to use. +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? @@ -718,16 +718,16 @@ You can get the epoch time on and use it to se - 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, disconnection 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)) 5. A new folder will appear on your computer's desktop -6. Download the `flash_erase*.uf2` file for your device on flasher.meshcore.co.uk +6. 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` 8. drag and drop the uf2 file for your device to the root of the new folder 9. Wait for the copy to complete. You might get an error dialog, you can ignore it -10. Go to https://flasher.meshcore.co.uk/, click `Console` and select the serial port for your connected device +10. Go to https://flasher.meshcore.io, click `Console` and select the serial port for your connected device 11. In the console, press enter. Your flash should now be erased 12. 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 flasher.meshcore.co.uk +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 ### 6.8. Q: WebFlasher fails on Linux with failed to open @@ -745,7 +745,7 @@ 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 flasher.meshcore.co.uk, download the **ZIP** version of the firmware for your nRF device (e.g. RAK or Heltec T114 or Seeed Studio's Xiao) +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 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 @@ -768,7 +768,7 @@ After this bootloader is flashed onto the device, you can trigger over the air u ### 7.2. Q: How to update ESP32-based devices over the air? **A:** For ESP32-based devices (e.g. Heltec V3): -1. On flasher.meshcore.co.uk, 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 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 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 From 992dddeee5cdaf4802c9e905f964c5b083f72def Mon Sep 17 00:00:00 2001 From: Kevin Le Date: Sat, 18 Apr 2026 09:24:53 +0700 Subject: [PATCH 12/19] Added support for Expansion Kit to Heltec V4 OLED repeaters --- variants/heltec_v4/platformio.ini | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/variants/heltec_v4/platformio.ini b/variants/heltec_v4/platformio.ini index 6f6bf2b5..87632f32 100644 --- a/variants/heltec_v4/platformio.ini +++ b/variants/heltec_v4/platformio.ini @@ -102,6 +102,28 @@ lib_deps = ${esp32_ota.lib_deps} bakercp/CRC32 @ ^2.0.0 +[env:heltec_v4_expansionkit_repeater] +extends = heltec_v4_oled +build_flags = + ${heltec_v4_oled.build_flags} + -D DISPLAY_CLASS=SSD1306Display + -D ADVERT_NAME='"Heltec 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 + -D ENV_PIN_SDA=4 + -D ENV_PIN_SCL=3 +build_src_filter = ${heltec_v4_oled.build_src_filter} + + + +<../examples/simple_repeater> +lib_deps = + ${heltec_v4_oled.lib_deps} + ${esp32_ota.lib_deps} + bakercp/CRC32 @ ^2.0.0 + [env:heltec_v4_repeater_bridge_espnow] extends = heltec_v4_oled build_flags = From e8907a31086dd0fb4adb55f5cdfbc26c84d3aaaf Mon Sep 17 00:00:00 2001 From: Marco Date: Sun, 19 Apr 2026 15:29:43 +0200 Subject: [PATCH 13/19] Add Heltec V4 set adc.multiplier --- variants/heltec_v4/HeltecV4Board.cpp | 2 +- variants/heltec_v4/HeltecV4Board.h | 20 ++++++++++++++++++-- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/variants/heltec_v4/HeltecV4Board.cpp b/variants/heltec_v4/HeltecV4Board.cpp index 49580d2e..8f013797 100644 --- a/variants/heltec_v4/HeltecV4Board.cpp +++ b/variants/heltec_v4/HeltecV4Board.cpp @@ -73,7 +73,7 @@ void HeltecV4Board::begin() { digitalWrite(PIN_ADC_CTRL, LOW); - return (5.42 * (3.3 / 1024.0) * raw) * 1000; + return (adc_mult * (3.3 / 1024.0) * raw) * 1000; } const char* HeltecV4Board::getManufacturerName() const { diff --git a/variants/heltec_v4/HeltecV4Board.h b/variants/heltec_v4/HeltecV4Board.h index 4d5ee461..95def06c 100644 --- a/variants/heltec_v4/HeltecV4Board.h +++ b/variants/heltec_v4/HeltecV4Board.h @@ -5,8 +5,16 @@ #include #include #include "LoRaFEMControl.h" + +#ifndef ADC_MULTIPLIER + #define ADC_MULTIPLIER 5.42 +#endif + class HeltecV4Board : public ESP32Board { +protected: + float adc_mult = ADC_MULTIPLIER; + public: RefCountedDigitalPin periph_power; LoRaFEMControl loRaFEMControl; @@ -18,6 +26,14 @@ public: void enterDeepSleep(uint32_t secs, int pin_wake_btn = -1); void powerOff() override; uint16_t getBattMilliVolts() override; - const char* getManufacturerName() const override ; - + bool setAdcMultiplier(float multiplier) override { + if (multiplier == 0.0f) { + adc_mult = ADC_MULTIPLIER; + } else { + adc_mult = multiplier; + } + return true; + } + float getAdcMultiplier() const override { return adc_mult; } + const char* getManufacturerName() const override; }; From db7baa7bd7a10a9f22af968b8e1f6abadf89f2bc Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Tue, 21 Apr 2026 12:07:39 +1000 Subject: [PATCH 14/19] * CommonCLI: bounds check added to "unknown config:" replies --- src/helpers/CommonCLI.cpp | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/helpers/CommonCLI.cpp b/src/helpers/CommonCLI.cpp index d495aada..1f03d915 100644 --- a/src/helpers/CommonCLI.cpp +++ b/src/helpers/CommonCLI.cpp @@ -2,6 +2,7 @@ #include "CommonCLI.h" #include "TxtDataHelpers.h" #include "AdvertDataHelpers.h" +#include "TxtDataHelpers.h" #include #ifndef BRIDGE_MAX_BAUD @@ -726,7 +727,8 @@ void CommonCLI::handleSetCmd(uint32_t sender_timestamp, char* command, char* rep strcpy(reply, "Error: unsupported by this board"); }; } else { - sprintf(reply, "unknown config: %s", config); + strcpy(reply, "unknown config: "); + StrHelper::strncpy(&reply[16], config, 160-17); } } From 3d982711a6014e318050c556c615916ebaa13391 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Tue, 21 Apr 2026 12:12:47 +1000 Subject: [PATCH 15/19] * CommonCLI: more reply bounds checking --- src/helpers/CommonCLI.cpp | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/helpers/CommonCLI.cpp b/src/helpers/CommonCLI.cpp index 1f03d915..b71afc72 100644 --- a/src/helpers/CommonCLI.cpp +++ b/src/helpers/CommonCLI.cpp @@ -286,7 +286,8 @@ void CommonCLI::handleCommand(uint32_t sender_timestamp, char* command, char* re // change admin password StrHelper::strncpy(_prefs->password, &command[9], sizeof(_prefs->password)); savePrefs(); - sprintf(reply, "password now: %s", _prefs->password); // echo back just to let admin know for sure!! + sprintf(reply, "password now: "); + StrHelper::strncpy(&reply[14], _prefs->password, 160-15); // echo back just to let admin know for sure!! } else if (memcmp(command, "clear stats", 11) == 0) { _callbacks->clearStats(); strcpy(reply, "(OK - stats reset)"); @@ -786,10 +787,11 @@ void CommonCLI::handleGetCmd(uint32_t sender_timestamp, char* command, char* rep } else if (memcmp(config, "direct.txdelay", 14) == 0) { sprintf(reply, "> %s", StrHelper::ftoa(_prefs->direct_tx_delay_factor)); } else if (memcmp(config, "owner.info", 10) == 0) { + auto start = reply; *reply++ = '>'; *reply++ = ' '; const char* sp = _prefs->owner_info; - while (*sp) { + while (*sp && reply - start < 159) { *reply++ = (*sp == '\n') ? '|' : *sp; // translate newline back to orig '|' sp++; } From 28b1586fd737533f0d8da46561791e406f34c0d3 Mon Sep 17 00:00:00 2001 From: me Date: Mon, 20 Apr 2026 20:45:04 -0700 Subject: [PATCH 16/19] feat(techo-lite): add Non-Shell (screenless) companion BLE variant T-Echo Lite Non-Shell has no ePaper display, but the existing companion BLE env inherits DISPLAY_CLASS=GxEPDDisplay from the base env. This causes display.begin() to run on non-existent hardware, corrupting BLE initialization and generating a random PIN that cannot be displayed, making BLE connection impossible. Add LilyGo_T-Echo-Lite_non_shell_companion_radio_ble env that: - excludes DISPLAY_CLASS and ePaper-related build flags - removes GxEPDDisplay.cpp and ui-new from build sources - uses static BLE_PIN_CODE=123456 (avoids random PIN generation) Also fix boards/t-echo.json: - add nrfutil to upload protocols list - add use_1200bps_touch=true and wait_for_upload_port=true to enable reliable flashing via PlatformIO upload button --- boards/t-echo.json | 7 ++-- variants/lilygo_techo_lite/platformio.ini | 44 +++++++++++++++++++++++ 2 files changed, 49 insertions(+), 2 deletions(-) diff --git a/boards/t-echo.json b/boards/t-echo.json index c974ca65..e0df6eac 100644 --- a/boards/t-echo.json +++ b/boards/t-echo.json @@ -53,11 +53,14 @@ "protocols": [ "jlink", "nrfjprog", + "nrfutil", "stlink", "cmsis-dap", "blackmagic" - ] + ], + "use_1200bps_touch": true, + "wait_for_upload_port": true }, "url": "https://os.mbed.com/platforms/Nordic-nRF52840-DK/", "vendor": "Nordic" -} \ No newline at end of file +} diff --git a/variants/lilygo_techo_lite/platformio.ini b/variants/lilygo_techo_lite/platformio.ini index 0ba6a197..88616858 100644 --- a/variants/lilygo_techo_lite/platformio.ini +++ b/variants/lilygo_techo_lite/platformio.ini @@ -96,3 +96,47 @@ build_src_filter = ${LilyGo_T-Echo-Lite.build_src_filter} lib_deps = ${LilyGo_T-Echo-Lite.lib_deps} densaugeo/base64 @ ~1.4.0 + +[env:LilyGo_T-Echo-Lite_non_shell_companion_radio_ble] +extends = LilyGo_T-Echo-Lite +upload_protocol = nrfutil +board_build.ldscript = boards/nrf52840_s140_v6_extrafs.ld +board_upload.maximum_size = 712704 +build_flags = + ${nrf52_base.build_flags} + -I variants/lilygo_techo_lite + -I src/helpers/nrf52 + -I lib/nrf52/s140_nrf52_6.1.1_API/include + -I lib/nrf52/s140_nrf52_6.1.1_API/include/nrf52 + -I src/helpers/ui + -I examples/companion_radio/ui-new + -D LILYGO_TECHO + -D RADIO_CLASS=CustomSX1262 + -D WRAPPER_CLASS=CustomSX1262Wrapper + -D LORA_TX_POWER=22 + -D SX126X_POWER_EN=30 + -D SX126X_CURRENT_LIMIT=140 + -D SX126X_RX_BOOSTED_GAIN=1 + -D P_LORA_TX_LED=LED_GREEN + -D DISABLE_DIAGNOSTIC_OUTPUT + -D ENV_INCLUDE_GPS=1 + -D GPS_BAUD_RATE=9600 + -D PIN_GPS_EN=GPS_EN + -D AUTO_OFF_MILLIS=0 + -D MAX_CONTACTS=350 + -D MAX_GROUP_CHANNELS=40 + -D BLE_PIN_CODE=123456 + -D OFFLINE_QUEUE_SIZE=256 + -D UI_RECENT_LIST_SIZE=9 + -D AUTO_SHUTDOWN_MILLIVOLTS=3300 +build_src_filter = ${nrf52_base.build_src_filter} + + + + + + + + + +<../variants/lilygo_techo_lite> + + + +<../examples/companion_radio/*.cpp> +lib_deps = + ${LilyGo_T-Echo-Lite.lib_deps} + densaugeo/base64 @ ~1.4.0 From 07671cf1fe6a1b9ed6bc3f24ec2a9ee52d21acbb Mon Sep 17 00:00:00 2001 From: Wessel Nieboer Date: Tue, 21 Apr 2026 21:29:18 +0200 Subject: [PATCH 17/19] Implement proper shutdown procedure for R1 neo fixes #2361 --- variants/muziworks_r1_neo/R1NeoBoard.cpp | 5 ++++- variants/muziworks_r1_neo/R1NeoBoard.h | 6 ++++++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/variants/muziworks_r1_neo/R1NeoBoard.cpp b/variants/muziworks_r1_neo/R1NeoBoard.cpp index 616d255a..89cde02a 100644 --- a/variants/muziworks_r1_neo/R1NeoBoard.cpp +++ b/variants/muziworks_r1_neo/R1NeoBoard.cpp @@ -14,9 +14,12 @@ const PowerMgtConfig power_config = { void R1NeoBoard::initiateShutdown(uint8_t reason) { // Disable LoRa module power before shutdown - MESH_DEBUG_PRINTLN("R1Neo: shutting down"); digitalWrite(SX126X_POWER_EN, LOW); + // Signal IO controller that MCU is off, then release DCDC latch + digitalWrite(PIN_SOFT_SHUTDOWN, LOW); + digitalWrite(PIN_DCDC_EN_MCU_HOLD, LOW); + if (reason == SHUTDOWN_REASON_LOW_VOLTAGE || reason == SHUTDOWN_REASON_BOOT_PROTECT) { configureVoltageWake(power_config.lpcomp_ain_channel, power_config.lpcomp_refsel); diff --git a/variants/muziworks_r1_neo/R1NeoBoard.h b/variants/muziworks_r1_neo/R1NeoBoard.h index c27ea232..c56f1f5c 100644 --- a/variants/muziworks_r1_neo/R1NeoBoard.h +++ b/variants/muziworks_r1_neo/R1NeoBoard.h @@ -18,6 +18,12 @@ public: R1NeoBoard() : NRF52Board("R1NEO_OTA") {} void begin(); +#ifdef NRF52_POWER_MANAGEMENT + void powerOff() override { + initiateShutdown(SHUTDOWN_REASON_USER); + } +#endif + #if defined(P_LORA_TX_LED) void onBeforeTransmit() override { digitalWrite(P_LORA_TX_LED, HIGH); // turn TX LED on From d516cd8a9eedfe0f4cd6c32e4526d6b0427ad338 Mon Sep 17 00:00:00 2001 From: pelgraine <140762863+pelgraine@users.noreply.github.com> Date: Fri, 10 Apr 2026 14:25:51 +1000 Subject: [PATCH 18/19] =?UTF-8?q?Fixes=20#1183=20=E2=80=94=20T-Echo=20Lite?= =?UTF-8?q?=20incorrect=20battery=20voltage?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Battery (TechoBoard.h/cpp): Added PIN_VBAT_MEAS_EN (P0.31) — the T-Echo Lite has a gated voltage divider that must be enabled before reading. Also added pinMode(PIN_VBAT_READ, INPUT) before each ADC read to reclaim P0.02 from other peripherals. Pin definitions hardcoded from LilyGo's t_echo_lite_config.h. I2C (variant.h): Corrected SDA/SCL from P0.04/P0.02 to P1.04/P1.02 per LilyGo's IIC_1_SDA/IIC_1_SCL. The old P0.02 mapping conflicted with the battery ADC pin. GPS (variant.h): Corrected all five GPS pin assignments to match LilyGo's config — UART TX/RX, wake, PPS, and power enable were all scrambled. SPI (variant.h): Fixed SPI_INTERFACES_COUNT from _PINNUM(0, 2) to (2). Tested on T-Echo Lite Non-Shell (USB-C, no display). Battery readings match Heltec V4 reference within 10mV. --- variants/lilygo_techo_lite/TechoBoard.cpp | 43 +++++++++++++++++------ variants/lilygo_techo_lite/TechoBoard.h | 19 +++++----- variants/lilygo_techo_lite/variant.h | 21 +++++------ 3 files changed, 53 insertions(+), 30 deletions(-) diff --git a/variants/lilygo_techo_lite/TechoBoard.cpp b/variants/lilygo_techo_lite/TechoBoard.cpp index 81d3d0c9..a11d31b2 100644 --- a/variants/lilygo_techo_lite/TechoBoard.cpp +++ b/variants/lilygo_techo_lite/TechoBoard.cpp @@ -8,24 +8,47 @@ void TechoBoard::begin() { NRF52Board::begin(); + // Configure battery measurement control BEFORE Wire.begin() + // to ensure P0.02 is not claimed by another peripheral + pinMode(PIN_VBAT_MEAS_EN, OUTPUT); + digitalWrite(PIN_VBAT_MEAS_EN, LOW); + pinMode(PIN_VBAT_READ, INPUT); + Wire.begin(); pinMode(SX126X_POWER_EN, OUTPUT); digitalWrite(SX126X_POWER_EN, HIGH); - delay(10); // give sx1262 some time to power up + delay(10); } uint16_t TechoBoard::getBattMilliVolts() { - int adcvalue = 0; - + // Use LilyGo's exact ADC configuration analogReference(AR_INTERNAL_3_0); analogReadResolution(12); - delay(10); - // ADC range is 0..3000mV and resolution is 12-bit (0..4095) - adcvalue = analogRead(PIN_VBAT_READ); - // Convert the raw value to compensated mv, taking the resistor- - // divider into account (providing the actual LIPO voltage) - return (uint16_t)((float)adcvalue * REAL_VBAT_MV_PER_LSB); + // Enable battery voltage divider (MOSFET gate on P0.31) + pinMode(PIN_VBAT_MEAS_EN, OUTPUT); + digitalWrite(PIN_VBAT_MEAS_EN, HIGH); + + // Reclaim P0.02 for analog input (in case another peripheral touched it) + pinMode(PIN_VBAT_READ, INPUT); + delay(10); // let divider + ADC settle + + // Read and average (matching LilyGo's approach) + uint32_t sum = 0; + for (int i = 0; i < 8; i++) { + sum += analogRead(PIN_VBAT_READ); + delayMicroseconds(100); + } + uint16_t adc = sum / 8; + + // Disable divider to save power + digitalWrite(PIN_VBAT_MEAS_EN, LOW); + + // LilyGo's exact formula: adc * (3000.0 / 4096.0) * 2.0 + // = adc * 0.73242188 * 2.0 = adc * 1.46484375 + uint16_t millivolts = (uint16_t)((float)adc * (3000.0f / 4096.0f) * 2.0f); + + return millivolts; } -#endif +#endif \ No newline at end of file diff --git a/variants/lilygo_techo_lite/TechoBoard.h b/variants/lilygo_techo_lite/TechoBoard.h index fda393e7..7a43fd83 100644 --- a/variants/lilygo_techo_lite/TechoBoard.h +++ b/variants/lilygo_techo_lite/TechoBoard.h @@ -4,14 +4,12 @@ #include #include -// built-ins -#define VBAT_MV_PER_LSB (0.73242188F) // 3.0V ADC range and 12-bit ADC resolution = 3000mV/4096 - -#define VBAT_DIVIDER (0.5F) // 150K + 150K voltage divider on VBAT -#define VBAT_DIVIDER_COMP (2.0F) // Compensation factor for the VBAT divider - -#define PIN_VBAT_READ (4) -#define REAL_VBAT_MV_PER_LSB (VBAT_DIVIDER_COMP * VBAT_MV_PER_LSB) +// ============================================================ +// T-Echo Lite battery pins — hardcoded from LilyGo t_echo_lite_config.h +// NOT using any defines from variant.h for battery measurement +// ============================================================ +#define PIN_VBAT_READ _PINNUM(0, 2) // BATTERY_ADC_DATA +#define PIN_VBAT_MEAS_EN _PINNUM(0, 31) // BATTERY_MEASUREMENT_CONTROL class TechoBoard : public NRF52BoardDCDC { public: @@ -20,10 +18,11 @@ public: uint16_t getBattMilliVolts() override; const char* getManufacturerName() const override { - return "LilyGo T-Echo"; + return "LilyGo T-Echo Lite"; } void powerOff() override { + digitalWrite(PIN_VBAT_MEAS_EN, LOW); #ifdef LED_RED digitalWrite(LED_RED, LOW); #endif @@ -41,4 +40,4 @@ public: #endif sd_power_system_off(); } -}; +}; \ No newline at end of file diff --git a/variants/lilygo_techo_lite/variant.h b/variants/lilygo_techo_lite/variant.h index 16e0b5cb..07202165 100644 --- a/variants/lilygo_techo_lite/variant.h +++ b/variants/lilygo_techo_lite/variant.h @@ -24,7 +24,7 @@ #define PIN_PWR_EN _PINNUM(0, 30) // RT9080_EN #define BATTERY_PIN _PINNUM(0, 2) -#define ADC_MULTIPLIER (4.90F) +#define ADC_MULTIPLIER (2.0F) #define ADC_RESOLUTION (14) #define BATTERY_SENSE_RES (12) @@ -47,13 +47,13 @@ //////////////////////////////////////////////////////////////////////////////// // I2C pin definition -#define PIN_WIRE_SDA _PINNUM(0, 4) // (SDA) -#define PIN_WIRE_SCL _PINNUM(0, 2) // (SCL) +#define PIN_WIRE_SDA _PINNUM(1, 4) // (SDA) - per LilyGo IIC_1_SDA +#define PIN_WIRE_SCL _PINNUM(1, 2) // (SCL) - per LilyGo IIC_1_SCL //////////////////////////////////////////////////////////////////////////////// // SPI pin definition -#define SPI_INTERFACES_COUNT _PINNUM(0, 2) +#define SPI_INTERFACES_COUNT (2) #define PIN_SPI_MISO _PINNUM(0, 17) // (MISO) #define PIN_SPI_MOSI _PINNUM(0, 15) // (MOSI) @@ -149,10 +149,11 @@ extern const int SCK; #define PIN_DISPLAY_BUSY DISP_BUSY //////////////////////////////////////////////////////////////////////////////// -// GPS +// GPS — per LilyGo t_echo_lite_config.h +// PIN_GPS_TX/RX named from GPS module's perspective -#define PIN_GPS_RX _PINNUM(1, 13) // RXD -#define PIN_GPS_TX _PINNUM(1, 15) // TXD -#define GPS_EN _PINNUM(1, 11) // POWER_RT9080_EN -#define PIN_GPS_STANDBY _PINNUM(1, 10) -#define PIN_GPS_PPS _PINNUM(0, 29) // 1PPS +#define PIN_GPS_TX _PINNUM(0, 29) // GPS UART TX → MCU RX +#define PIN_GPS_RX _PINNUM(1, 10) // GPS UART RX ← MCU TX +#define GPS_EN _PINNUM(1, 11) // GPS RT9080 power enable +#define PIN_GPS_STANDBY _PINNUM(1, 13) // GPS wake-up +#define PIN_GPS_PPS _PINNUM(1, 15) // GPS 1PPS \ No newline at end of file From 66fe9ac2db2f7d7bbfbbbf3c60f456eaaa7dc02f Mon Sep 17 00:00:00 2001 From: Wessel Nieboer Date: Mon, 20 Apr 2026 09:42:39 +0200 Subject: [PATCH 19/19] Fix FEM/LNA enbaled by default for Heltec T096, Heltec Wireless Tracker v2 Should only really be disabled when it causes issues. --- variants/heltec_t096/LoRaFEMControl.cpp | 2 +- variants/heltec_t096/LoRaFEMControl.h | 2 +- variants/heltec_tracker_v2/LoRaFEMControl.cpp | 2 +- variants/heltec_tracker_v2/LoRaFEMControl.h | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/variants/heltec_t096/LoRaFEMControl.cpp b/variants/heltec_t096/LoRaFEMControl.cpp index 9aeb8385..fb60a8f7 100644 --- a/variants/heltec_t096/LoRaFEMControl.cpp +++ b/variants/heltec_t096/LoRaFEMControl.cpp @@ -9,7 +9,7 @@ void LoRaFEMControl::init(void) pinMode(P_LORA_KCT8103L_PA_CSD, OUTPUT); digitalWrite(P_LORA_KCT8103L_PA_CSD, HIGH); pinMode(P_LORA_KCT8103L_PA_CTX, OUTPUT); - digitalWrite(P_LORA_KCT8103L_PA_CTX, HIGH); + digitalWrite(P_LORA_KCT8103L_PA_CTX, lna_enabled ? LOW : HIGH); setLnaCanControl(true); } diff --git a/variants/heltec_t096/LoRaFEMControl.h b/variants/heltec_t096/LoRaFEMControl.h index 2c50b742..fe61b7e4 100644 --- a/variants/heltec_t096/LoRaFEMControl.h +++ b/variants/heltec_t096/LoRaFEMControl.h @@ -16,6 +16,6 @@ class LoRaFEMControl void setLnaCanControl(bool can_control) { lna_can_control = can_control; } private: - bool lna_enabled = false; + bool lna_enabled = true; bool lna_can_control = false; }; diff --git a/variants/heltec_tracker_v2/LoRaFEMControl.cpp b/variants/heltec_tracker_v2/LoRaFEMControl.cpp index 3cf6c311..b846465d 100644 --- a/variants/heltec_tracker_v2/LoRaFEMControl.cpp +++ b/variants/heltec_tracker_v2/LoRaFEMControl.cpp @@ -14,7 +14,7 @@ void LoRaFEMControl::init(void) pinMode(P_LORA_KCT8103L_PA_CSD, OUTPUT); digitalWrite(P_LORA_KCT8103L_PA_CSD, HIGH); pinMode(P_LORA_KCT8103L_PA_CTX, OUTPUT); - digitalWrite(P_LORA_KCT8103L_PA_CTX, HIGH); + digitalWrite(P_LORA_KCT8103L_PA_CTX, lna_enabled ? LOW : HIGH); setLnaCanControl(true); } diff --git a/variants/heltec_tracker_v2/LoRaFEMControl.h b/variants/heltec_tracker_v2/LoRaFEMControl.h index 2c50b742..fe61b7e4 100644 --- a/variants/heltec_tracker_v2/LoRaFEMControl.h +++ b/variants/heltec_tracker_v2/LoRaFEMControl.h @@ -16,6 +16,6 @@ class LoRaFEMControl void setLnaCanControl(bool can_control) { lna_can_control = can_control; } private: - bool lna_enabled = false; + bool lna_enabled = true; bool lna_can_control = false; };