dandri/MeshCore
1
0
Fork 0
mirror of https://github.com/meshcore-dev/MeshCore.git synced 2026-04-27 00:32:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

deploy: 9ec08228e5

Browse Source
This commit is contained in:
liamcottle
2026-04-05 10:05:00 +00:00
parent 48199ed9d5
commit 860bce5b27
4 changed files with 41 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files
faq/index.html
+28 -28
View File
@@ -2610,7 +2610,7 @@
</ul>
<h2 id="1-introduction">1. Introduction</h2>
<h3 id="11-q-what-is-meshcore">1.1. Q: What is MeshCore?</h3>
<p><strong>A:</strong> 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 &amp; Disaster Recovery, Outdoor Activities, Tactical Security including law enforcement and private security and also IoT sensor networks. (<a href="https://meshcore.co.uk/">source</a>)</p>
<p><strong>A:</strong> 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 &amp; Disaster Recovery, Outdoor Activities, Tactical Security including law enforcement and private security and also IoT sensor networks. (<a href="https://meshcore.io/">source</a>)</p>
<p>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
@@ -2622,17 +2622,18 @@
<h3 id="12-q-what-do-you-need-to-start-using-meshcore">1.2. Q: What do you need to start using MeshCore?</h3>
<p><strong>A:</strong> Everything you need for MeshCore is available at:</p>
<ul>
<li>Main web site: <a href="https://meshcore.co.uk">https://meshcore.co.uk</a></li>
<li>Firmware Flasher: <a href="https://flasher.meshcore.co.uk">https://flasher.meshcore.co.uk</a></li>
<li>Main Website: <a href="https://meshcore.io">https://meshcore.io</a></li>
<li>Firmware Flasher: <a href="https://flasher.meshcore.io">https://flasher.meshcore.io</a></li>
<li>MeshCore Firmware on GitHub: <a href="https://github.com/meshcore-dev/MeshCore">https://github.com/meshcore-dev/MeshCore</a></li>
<li>MeshCore Companion App: <a href="https://meshcore.nz">https://meshcore.nz</a></li>
<li>MeshCore Map: <a href="https://meshcore.co.uk/map.html">https://meshcore.co.uk/map.html</a></li>
<li>Andy Kirby has a very useful <a href="https://www.youtube.com/watch?v=t1qne8uJBAc">intro video</a> for beginners.</li>
<li>MeshCore Companion Web App: <a href="https://app.meshcore.nz">https://app.meshcore.nz</a></li>
<li>MeshCore Map: <a href="https://map.meshcore.io">https://map.meshcore.io</a></li>
<li>Andy Kirby's <a href="https://www.youtube.com/watch?v=t1qne8uJBAc">MeshCore Intro Video</a></li>
<li>Liam Cottle's <a href="https://www.youtube.com/watch?v=OwmkVkZQTf4">MeshCore Technical Presentation</a></li>
</ul>
<p>You need LoRa hardware devices to run MeshCore firmware as clients or server (repeater and room server).</p>
<h4 id="121-hardware">1.2.1. Hardware</h4>
<p>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.</p>
<p>For an up-to-date list of supported devices, please go to https://flasher.meshcore.co.uk/</p>
<p>For an up-to-date list of supported devices, please go to https://flasher.meshcore.io</p>
<p>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.</p>
<h4 id="122-firmware">1.2.2. Firmware</h4>
<p>MeshCore has four firmware types that are not available on other LoRa systems. MeshCore has the following:</p>
@@ -2642,13 +2643,12 @@
<li>
<p><strong>BLE Companion</strong>
BLE Companion firmware runs on a supported LoRa device and connects to a smart device running the Android or iOS MeshCore client over BLE
<a href="https://meshcore.co.uk/apps.html">https://meshcore.co.uk/apps.html</a></p>
<a href="https://meshcore.io/">https://meshcore.io/</a></p>
</li>
<li>
<p><strong>USB Serial Companion</strong>
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
<a href="https://meshcore.liamcottle.net/#/">https://meshcore.liamcottle.net/#/</a>
<a href="https://client.meshcore.co.uk/tabs/devices">https://client.meshcore.co.uk/tabs/devices</a></p>
<a href="https://app.meshcore.nz/">https://app.meshcore.nz/</a></p>
</li>
</ol>
<h4 id="124-repeater">1.2.4. Repeater</h4>
@@ -2700,12 +2700,12 @@ Advert means to advertise yourself on the network. In Reticulum terms it would b
<p><strong>A:</strong> - 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.</p>
<p>Repeater or room server can be administered with one of the options below:</p>
<ul>
<li>After a repeater or room server firmware is flashed on to a LoRa device, go to <a href="https://config.meshcore.dev">https://config.meshcore.dev</a> 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.</li>
<li>After a repeater or room server firmware is flashed on to a LoRa device, go to <a href="https://config.meshcore.io">https://config.meshcore.io</a> 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.</li>
</ul>
<p><img alt="image" src="https://github.com/user-attachments/assets/2a9d9894-e34d-4dbe-b57c-fc3c250a2d34" /></p>
<ul>
<li>
<p>Connect the server device using a USB cable to a computer running Chrome on https://flasher.meshcore.co.uk/, then use the <code>console</code> feature to connect to the device</p>
<p>Connect the server device using a USB cable to a computer running Chrome on https://flasher.meshcore.io, then use the <code>console</code> feature to connect to the device</p>
</li>
<li>
<p>Use a MeshCore smartphone clients to remotely administer servers via LoRa.</p>
@@ -2785,7 +2785,7 @@ The original MeshCore protocol design uses the first byte of a repeater's public
5. Hear USB connection sound
6. Release trackball
7. T-Deck in DFU mode now
8. At this point you can begin flashing using <a href="https://flasher.meshcore.co.uk/">https://flasher.meshcore.co.uk/</a></p>
8. At this point you can begin flashing using <a href="https://flasher.meshcore.io">https://flasher.meshcore.io</a></p>
<h3 id="43-q-why-is-my-t-deck-plus-not-getting-any-satellite-lock">4.3. Q: Why is my T-Deck Plus not getting any satellite lock?</h3>
<p><strong>A:</strong> For T-Deck Plus, the GPS baud rate should be set to <strong>38400</strong>. 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.</p>
<p>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 <code>GPS Info</code> screen; you should see the <code>Sentences:</code> counter increasing if the baud rate is correct.</p>
@@ -2931,7 +2931,7 @@ will not have a stable path where all clients are constantly moving between repe
<p>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.</p>
<p>This could change in the future if MeshCore develops a client firmware that repeats.
<a href="https://discord.com/channels/826570251612323860/1330643963501351004/1354780032140054659">Source</a></p>
<h3 id="512-q-how-do-i-add-a-node-to-the-meshcore-map">5.12. Q: How do I add a node to the <a href="https://meshcore.co.uk/map.html">MeshCore Map</a></h3>
<h3 id="512-q-how-do-i-add-a-node-to-the-meshcore-map">5.12. Q: How do I add a node to the <a href="https://map.meshcore.io">MeshCore Map</a></h3>
<p><strong>A:</strong></p>
<p>To add a BLE Companion radio, connect to the BLE Companion radio from the MeshCore smartphone app. In the app, tap the <code>3 dot</code> menu icon at the top right corner, then tap <code>Internet Map</code>. Tap the <code>3 dot</code> menu icon again and choose <code>Add me to the Map</code></p>
<p>To add a Repeater or Room Server to the map, go to the Contact List, tap the <code>3 dot</code> next to the Repeater or Room Server you want to add to the Internet Map, tap <code>Share</code>, then tap <code>Upload to Internet Map</code>.</p>
@@ -2943,18 +2943,18 @@ Below are the instructions to flash firmware onto a supported LoRa device using
<p>Instructions for nRF devices like RAK, T1000-E, T114 are immediately after the ESP instructions</p>
</blockquote>
<p>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,
- <code>Heltec_V3_companion_radio_ble-v1.7.1-165fb33.bin</code>
- Non-merged bin keeps the existing Bluetooth pairing database
- <code>Heltec_v3_companion_radio_usb-v1.7.1-165fb33-merged.bin</code>
- 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: <code>https://flasher.meshcore.dev/releases/download/companion-v1.7.1/Heltec_v3_companion_radio_ble-v1.7.1-165fb33.bin</code>
- Right click on the file name and copy the link and note it for later use here is an example: <code>https://flasher.meshcore.io/releases/download/companion-v1.7.1/Heltec_v3_companion_radio_ble-v1.7.1-165fb33.bin</code>
- Run:
- <code>wget https://flasher.meshcore.dev/releases/download/companion-v1.7.1/Heltec_v3_companion_radio_ble-v1.7.1-165fb33.bin</code> 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
- <code>wget https://flasher.meshcore.io/releases/download/companion-v1.7.1/Heltec_v3_companion_radio_ble-v1.7.1-165fb33.bin</code> 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:
- <code>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"</code>
- <code>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"</code>
- Confirm the <code>ttyXXXX</code> device path on your Raspberry Pi:
- Go to <code>/dev</code> directory, run ls command to find confirm your device path
- They are usually <code>/dev/ttyUSB0</code> for ESP devices
@@ -2967,14 +2967,14 @@ Below are the instructions to flash firmware onto a supported LoRa device using
- <code>esptool.py -p /dev/ttyUSB0 --chip esp32-s3 write_flash 0x00000 &lt;merged_firmware&gt;.bin</code></p>
<p><strong>Instructions for nRF devices:</strong></p>
<p>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:
- <code>RAK_4631_companion_radio_ble-v1.7.1-165fb33.zip</code>
- Right click on the file name and copy the link and note it for later use here is an example: <code>https://flasher.meshcore.dev/releases/download/companion-v1.7.1/RAK_4631_companion_radio_ble-v1.7.1-165fb33.zip</code>
- Right click on the file name and copy the link and note it for later use here is an example: <code>https://flasher.meshcore.io/releases/download/companion-v1.7.1/RAK_4631_companion_radio_ble-v1.7.1-165fb33.zip</code>
- Run:
- <code>wget https://flasher.meshcore.dev/releases/download/companion-v1.7.1/RAK_4631_companion_radio_ble-v1.7.1-165fb33.zip</code> to download the firmware file for your device type. or the version you need - USB, BLE, Repeater, Room Server, ZIP file only
- <code>wget https://flasher.meshcore.io/releases/download/companion-v1.7.1/RAK_4631_companion_radio_ble-v1.7.1-165fb33.zip</code> to download the firmware file for your device type. or the version you need - USB, BLE, Repeater, Room Server, ZIP file only
- Confirm the <code>ttyXXXX</code> device path on your Raspberry Pi:
- Go to <code>/dev</code> directory, run ls command to find confirm your device path
- They are usually <code>/dev/ttyACM0</code> for nRF devices
@@ -2992,9 +2992,9 @@ Below are the instructions to flash firmware onto a supported LoRa device using
<p><strong>A:</strong> 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.</p>
<p>As new MeshCore community projects become available on a weekly basis, we have stopped tracking them here in this FAQ. <a href="https://github.com/samuk">samuk</a> 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.</p>
<h3 id="515-q-are-there-client-applications-for-windows-or-mac">5.15. Q: Are there client applications for Windows or Mac?</h3>
<p><strong>A:</strong> 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:
<p><strong>A:</strong> 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</p>
<p>Both the Windows and Intel Mac versions of the client app are fully unlocked and are free to use.</p>
<p>Both the Windows and Mac versions of the client app are fully unlocked and are free to use.</p>
<h3 id="516-q-are-there-any-resources-that-compare-meshcore-to-other-lora-systems">5.16. Q: Are there any resources that compare MeshCore to other LoRa systems?</h3>
<p><strong>A:</strong> Here is a list of MeshCore comparison resources:
The Comms Channel on YouTube:
@@ -3027,15 +3027,15 @@ https://www.austinmesh.org/learn/meshcore-vs-meshtastic/</p>
- For Heltec T114, click the reset button <strong>TWICE</strong> (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 (<a href="https://wiki.seeedstudio.com/XIAO_BLE/#access-the-swd-pins-for-debugging-and-reflashing-bootloader">seeed studio wiki</a>)
5. A new folder will appear on your computer's desktop
6. Download the <code>flash_erase*.uf2</code> file for your device on flasher.meshcore.co.uk
6. Download the <code>flash_erase*.uf2</code> file for your device on https://flasher.meshcore.io
- RAK WisBlock and Heltec T114: <code>Flash_erase-nRF32_softdevice_v6.uf2</code>
- Seeed Studio Xiao nRF52 WIO: <code>Flash_erase-nRF52_softdevice_v7.uf2</code>
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 <code>Console</code> and select the serial port for your connected device
10. Go to https://flasher.meshcore.io, click <code>Console</code> 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</p>
<p>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</p>
<p>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</p>
<h3 id="68-q-webflasher-fails-on-linux-with-failed-to-open">6.8. Q: WebFlasher fails on Linux with failed to open</h3>
<p><strong>A:</strong> If the usb port doesn't have the right ownership for this task, the process fails with the following error:
<code>NetworkError: Failed to execute 'open' on 'SerialPort': Failed to open serial port.</code></p>
@@ -3047,7 +3047,7 @@ https://www.austinmesh.org/learn/meshcore-vs-meshtastic/</p>
<p><strong>A:</strong> The steps below work on both Android and iOS as nRF has made both apps' user interface the same on both platforms:</p>
<ol>
<li>Download nRF's DFU app from iOS App Store or Android's Play Store, you can find the app by searching for <code>nrf dfu</code>, the app's full name is <code>nRF Device Firmware Update</code></li>
<li>On flasher.meshcore.co.uk, download the <strong>ZIP</strong> version of the firmware for your nRF device (e.g. RAK or Heltec T114 or Seeed Studio's Xiao)</li>
<li>On https://flasher.meshcore.io, download the <strong>ZIP</strong> version of the firmware for your nRF device (e.g. RAK or Heltec T114 or Seeed Studio's Xiao)</li>
<li>From the MeshCore app, login remotely to the repeater you want to update with admin privilege</li>
<li>Go to the Command Line tab, type <code>start ota</code> and hit enter.</li>
<li>you should see <code>OK</code> to confirm the repeater device is now in OTA mode</li>
@@ -3066,7 +3066,7 @@ https://github.com/oltaco/Adafruit_nRF52_Bootloader_OTAFIX</p>
<p>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 <code>start ota</code> instruction and start the update using the DFU app.</p>
<h3 id="72-q-how-to-update-esp32-based-devices-over-the-air">7.2. Q: How to update ESP32-based devices over the air?</h3>
<p><strong>A:</strong> For ESP32-based devices (e.g. Heltec V3):
1. On flasher.meshcore.co.uk, download the <strong>non-merged</strong> version of the firmware for your ESP32 device (e.g. <code>Heltec_v3_repeater-v1.6.2-4449fd3.bin</code>, no <code>"merged"</code> in the file name)
1. On https://flasher.meshcore.io, download the <strong>non-merged</strong> version of the firmware for your ESP32 device (e.g. <code>Heltec_v3_repeater-v1.6.2-4449fd3.bin</code>, no <code>"merged"</code> 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 <code>start ota</code> and hit enter.
5. you should see <code>OK</code> to confirm the repeater device is now in OTA mode
search/search_index.json
+1 -1
View File
File diff suppressed because one or more lines are too long
sitemap.xml
+12 -12
View File
@@ -2,50 +2,50 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://meshcore-dev.github.io/meshcore/</loc>
<lastmod>2026-04-03</lastmod>
<lastmod>2026-04-05</lastmod>
</url>
<url>
<loc>https://meshcore-dev.github.io/meshcore/cli_commands/</loc>
<lastmod>2026-04-03</lastmod>
<lastmod>2026-04-05</lastmod>
</url>
<url>
<loc>https://meshcore-dev.github.io/meshcore/companion_protocol/</loc>
<lastmod>2026-04-03</lastmod>
<lastmod>2026-04-05</lastmod>
</url>
<url>
<loc>https://meshcore-dev.github.io/meshcore/docs/</loc>
<lastmod>2026-04-03</lastmod>
<lastmod>2026-04-05</lastmod>
</url>
<url>
<loc>https://meshcore-dev.github.io/meshcore/faq/</loc>
<lastmod>2026-04-03</lastmod>
<lastmod>2026-04-05</lastmod>
</url>
<url>
<loc>https://meshcore-dev.github.io/meshcore/kiss_modem_protocol/</loc>
<lastmod>2026-04-03</lastmod>
<lastmod>2026-04-05</lastmod>
</url>
<url>
<loc>https://meshcore-dev.github.io/meshcore/nrf52_power_management/</loc>
<lastmod>2026-04-03</lastmod>
<lastmod>2026-04-05</lastmod>
</url>
<url>
<loc>https://meshcore-dev.github.io/meshcore/packet_format/</loc>
<lastmod>2026-04-03</lastmod>
<lastmod>2026-04-05</lastmod>
</url>
<url>
<loc>https://meshcore-dev.github.io/meshcore/payloads/</loc>
<lastmod>2026-04-03</lastmod>
<lastmod>2026-04-05</lastmod>
</url>
<url>
<loc>https://meshcore-dev.github.io/meshcore/qr_codes/</loc>
<lastmod>2026-04-03</lastmod>
<lastmod>2026-04-05</lastmod>
</url>
<url>
<loc>https://meshcore-dev.github.io/meshcore/stats_binary_frames/</loc>
<lastmod>2026-04-03</lastmod>
<lastmod>2026-04-05</lastmod>
</url>
<url>
<loc>https://meshcore-dev.github.io/meshcore/terminal_chat_cli/</loc>
<lastmod>2026-04-03</lastmod>
<lastmod>2026-04-05</lastmod>
</url>
</urlset>
sitemap.xml.gz
BIN
View File
Binary file not shown.