M<>M Relay

(Meshtastic <=> Matrix Relay)

A powerful and easy-to-use relay between Meshtastic devices and Matrix chat rooms, allowing seamless communication across platforms. This opens the door for bridging Meshtastic devices to many other platforms.

Features

• Bidirectional message relay between Meshtastic devices and Matrix chat rooms, capable of supporting multiple meshnets
• Supports serial, network, and BLE (now too!) connections for Meshtastic devices
• Custom keys are embedded in Matrix messages which are used when relaying messages between two or more meshnets.
• Truncates long messages to fit within Meshtastic's payload size
• SQLite database to store node information for improved functionality
• Customizable logging level for easy debugging
• Configurable through a simple YAML file
• Supports mapping multiple rooms and channels 1:1
• Relays messages to/from an MQTT broker, if configured in the Meshtastic firmware

We would love to support Matrix E2EE rooms, but this is currently not implemented.

Windows Installer

The latest installer is available here

Plugins

M<>M Relay supports plugins for extending its functionality, enabling customization and enhancement of the relay to suit specific needs.

Core Plugins

Generate a map of your nodes: (As of 11/24/24 this plugin is currently broken but hopefully will be fixed soon, time permitting.)

Produce high-level details about your mesh:

Community & custom plugins

It is possible to create custom plugins and to also easily share them with the community. Check example_plugins/README.md and also the Community Plugins Development Guide.

✨️ Visit our recently added Community Plugins List!

Install a community plugin

Add the repository under the community-plugins section in config.yaml:

community-plugins:
  example-plugin:
    active: true
    repository: https://github.com/jeremiah-k/mmr-plugin-template.git
    tag: main

Getting Started with Matrix

See our Wiki page Getting Started With Matrix & MM Relay.

Already on Matrix?

Join us!

• Our project's room: #mmrelay:meshnet.club
• Part of the Meshtastic Community Matrix space: #meshtastic-community:meshnet.club

Supported Platforms

The relay is compatible with the following operating systems:

• Linux
• MacOS
• Windows

Refer to the development instructions for details about running the relay on MacOS and Linux.