Skip to content

Latest commit

 

History

History
87 lines (52 loc) · 3.43 KB

README.md

File metadata and controls

87 lines (52 loc) · 3.43 KB

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.


Getting Started

M<>M Relay runs on Linux, macOS, and Windows. For setup, configuration, and usage instructions, see the INSTRUCTIONS.md file.


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 fields are embedded in Matrix messages for relaying messages between multiple 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
  • ✨️ Cross-platform reactions support ✨️ NEW!!

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


Windows Installer

Windows Installer Screenshot

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:

Map Plugin Screenshot

Produce high-level details about your mesh:

Mesh Details Screenshot

See the full list of core plugins here.

Community & Custom Plugins

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

✨️ Visit the 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!