meshtastic-matrix-relay/README.md

1.6 KiB

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 both serial and network 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
  • New: Supports mapping multiple rooms and channels 1:1

Windows Installer

The latest installer is available here

Plugins

Generate a map of your nodes

Produce high-level details about your mesh

Supported Platforms

The relay can run on:

  • Linux
  • MacOS
  • Windows

Refer to the development instructions for more details.