You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
ripplebiz 71f46ddaea
Merge pull request #496 from recrof/patch-8
11 months ago
.github * .yml files, permissions: write 1 year ago
.vscode Initial commit 1 year ago
arch wio-e5 : initial port 1 year ago
bin/uf2conv setup automated firmware builds with github actions 1 year ago
boards add mising config for `openocd_target` 1 year ago
docs Update faq.md 11 months ago
examples * ver bump to v1.7.2 11 months ago
include Initial commit 1 year ago
lib moved nrf sdk headers to ./lib/ and added Repeater envs for t114 & t-echo 1 year ago
logo add logo files 1 year ago
src Merge pull request #455 from jquatier/wireless-paper 11 months ago
variants t1000e: set preamble to 16 at init 11 months ago
.clang-format Re-applying 73a7a96, formatting, MyMesh reformat 1 year ago
.envrc add default.nix/.envrc for automagic platformio dev environment on NixOS 1 year ago
.gitignore t-beam supreme: display fix, BME add, user btn fix 1 year ago
README.md remove hardware compatibility list - it was outdated. 11 months ago
RELEASE.md add release docs 1 year ago
build.sh detect if we have nrf52 by probing for *.zip and *.hex output files 1 year ago
default.nix add default.nix/.envrc for automagic platformio dev environment on NixOS 1 year ago
license.txt * tidy ups 1 year ago
merge-bin.py * merge-bin.py script 1 year ago
platformio.ini Merge pull request #396 from jbrazio/jbrazio/2025_5dba32d2 12 months ago

README.md

About MeshCore

MeshCore is a lightweight, portable C++ library that enables multi-hop packet routing for embedded projects using LoRa and other packet radios. It is designed for developers who want to create resilient, decentralized communication networks that work without the internet.

🔍 What is MeshCore?

MeshCore now supports a range of LoRa devices, allowing for easy flashing without the need to compile firmware manually. Users can flash a pre-built binary using tools like Adafruit ESPTool and interact with the network through a serial console. MeshCore provides the ability to create wireless mesh networks, similar to Meshtastic and Reticulum but with a focus on lightweight multi-hop packet routing for embedded projects. Unlike Meshtastic, which is tailored for casual LoRa communication, or Reticulum, which offers advanced networking, MeshCore balances simplicity with scalability, making it ideal for custom embedded solutions., where devices (nodes) can communicate over long distances by relaying messages through intermediate nodes. This is especially useful in off-grid, emergency, or tactical situations where traditional communication infrastructure is unavailable.

Key Features

  • Multi-Hop Packet Routing – Devices can forward messages across multiple nodes, extending range beyond a single radio's reach. MeshCore supports up to a configurable number of hops to balance network efficiency and prevent excessive traffic.
  • Supports LoRa Radios – Works with Heltec, RAK Wireless, and other LoRa-based hardware.
  • Decentralized & Resilient – No central server or internet required; the network is self-healing.
  • Low Power Consumption – Ideal for battery-powered or solar-powered devices.
  • Simple to Deploy – Pre-built example applications make it easy to get started.

🎯 What Can You Use MeshCore For?

  • Off-Grid Communication: Stay connected even in remote areas.
  • Emergency Response & Disaster Recovery: Set up instant networks where infrastructure is down.
  • Outdoor Activities: Hiking, camping, and adventure racing communication.
  • Tactical & Security Applications: Military, law enforcement, and private security use cases.
  • IoT & Sensor Networks: Collect data from remote sensors and relay it back to a central location.

🚀 How to Get Started

For developers;

The Simple Secure Chat example can be interacted with through the Serial Monitor in Visual Studio Code, or with a Serial USB Terminal on Android.

️ MeshCore Flasher

We have prebuilt firmware ready to flash on supported devices.

  • Launch https://flasher.meshcore.co.uk
  • Select a supported device
  • Flash one of the firmware types:
    • Companion, Repeater or Room Server
  • Once flashing is complete, you can connect with one of the MeshCore clients below.

📱 MeshCore Clients

Companion Firmware

The companion firmware can be connected to via BLE, USB or WiFi depending on the firmware type you flashed.

Repeater and Room Server Firmware

The repeater and room server firmwares can be setup via USB in the web config tool.

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

📜 License

MeshCore is open-source software released under the MIT License. You are free to use, modify, and distribute it for personal and commercial projects.

Contributing

Please submit PR's using 'dev' as the base branch! For minor changes just submit your PR and I'll try to review it, but for anything more 'impactful' please open an Issue first and start a discussion. Is better to sound out what it is you want to achieve first, and try to come to a consensus on what the best approach is, especially when it impacts the structure or architecture of this codebase.

Here are some general principals you should try to adhere to:

  • Keep it simple. Please, don't think like a high-level lang programmer. Think embedded, and keep code concise, without any unecessary layers.
  • No dynamic memory allocation, except during setup/begin functions.
  • Use the same brace and indenting style that's in the core source modules. (A .clang-format is prob going to be added soon, but please do NOT retroactively re-format existing code. This just creates unnecessary diffs that make finding problems harder)

📞 Get Support

RAK Wireless Board Support in PlatformIO

Before building/flashing the RAK4631 targets in this project, there is, unfortunately, some patching you have to do to your platformIO packages to make it work. There is a guide here on the process: RAK Wireless: How to Perform Installation of Board Support Package in PlatformIO

After building, you will need to convert the output firmware.hex file into a .uf2 file you can copy over to your RAK4631 device (after doing a full erase) by using the command uf2conv.py -f 0xADA52840 -c firmware.hex with the python script available from: GitHub: Microsoft - uf2