This repository packages a Zephyr native Meshtastic® stack that should work out-of-the-box on any Zephyr-supported board + LoRa transceiver.

DISCLAIMER: this project is not affiliated with or endorsed by Meshtastic LLC. Meshtastic® is a registered trademark of Meshtastic LLC.

The original Meshtastic firmware is a PlatformIO/Arduino application with a (very!) large amount of device-specific integration code (including drivers for sensors, displays, etc.) and lots of places in the code where conditional compilation is used to adapt to different hardware platforms.

Zephyr RTOS _is_ designed to abstract away the hardware details and already provides ready-to-use subsystems for many of the features that Meshtastic needs (LoRa, Bluetooth, GNSS, ...).

The initial goal is to provide a minimal set of API for setting up and configuring the stack, as wel as sending and receiving messages.

A typical "original" Meshtastic firmware would typically expose a UI but this initial part doesn't have any at this point and instead focus has been put on providing shell commands that can be executed directly from the device's console (e.g. meshtastic status, meshtastic nodedb list, ...), and on providing a PhoneAPI interface over Bluetooth LE and serial so that a host application (see https://meshtastic.org/downloads/) can provide a nice frontend to the device.

The original Meshtastic firmware is inherently very re-configurable (e.g. LoRa radio settings, node identification, ...) without having to recompile it (i.e. change your LoRa presets, reboot device, done!). This project, however, is currently mainly proposing build-time configuration, (using Kconfig) so trying to reconfigure it using your favorite app's config UI will simply not work (and likely fail miserably). Support for settings (persisted in flash) has started to be introduced though, and configuring channels (tested through shell commands only at the time of writing) works as expected and channels survive a reboot.

As this project is mostly a rewrite from scratch, and as there aren't really (to the best of my knowledge) any interoperability test suites available, the support matrix below reflects what has been implemented and tested against the reference Meshtastic firmware and the official module documentation.

Legend: ✅ Full · 🟡 Partial · ❌ Not yet

When CONFIG_MESHTASTIC_SHELL is enabled, the firmware registers a meshtastic command tree on the Zephyr . Commands marked (optional) are only present when their corresponding CONFIG_MESHTASTIC_* Kconfig option is set.

This repository can be used to directly provision a full-blown workspace from scratch, or it can be pulled into an existing workspace as a module.

Before getting started, make sure you have followed the initial steps of the Zephyr Getting Started Guide up to install/update host dependencies that Zephyr requires such as Python, CMake, ...

At the "Get the Zephyr source code" step, replace the default west init <workspace_location> step with the following command so that you use this repository as the main manifest for your workspace:

$ west init -m https://github.com/kartben/meshtastic-zephyr --mr main <workspace_location>

Add the module to your west manifest or a Zephyr submanifest:

manifest:
  projects:
    - name: meshtastic-zephyr
      url: https://github.com/kartben/meshtastic-zephyr.git
      revision: main
      path: modules/lib/meshtastic-zephyr

Then update the workspace:

$ west update

Note: The meshtastic-zephyr module requires Zephyr's nanopb module to be present in the west workspace (which should be the case by default).

Build the Meshtastic sample with:

$ west build -b <board> samples/meshtastic

Refer to the [sample's README](samples/meshtastic/README.rst) for more information on how to build and run the sample and enable additional features.

This project is licensed under GPL-3.0, similar to the original Meshtastic firmware.