https://github.com/geoffwhittington/meshtastic-matrix-relay
A relay between a Matrix.org room and a Meshtastic radio. This relay extends your Matrix.org-based communication with a LoRa-based Meshtastic radio mesh. This is not an official product of Matrix.org or Meshtastic.
https://github.com/geoffwhittington/meshtastic-matrix-relay
lora matrix mesh-networks meshtastic radio
Last synced: about 2 months ago
JSON representation
A relay between a Matrix.org room and a Meshtastic radio. This relay extends your Matrix.org-based communication with a LoRa-based Meshtastic radio mesh. This is not an official product of Matrix.org or Meshtastic.
- Host: GitHub
- URL: https://github.com/geoffwhittington/meshtastic-matrix-relay
- Owner: geoffwhittington
- License: mit
- Created: 2023-04-17T23:40:19.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-02T17:17:03.000Z (about 2 months ago)
- Last Synced: 2025-04-02T18:27:06.668Z (about 2 months ago)
- Topics: lora, matrix, mesh-networks, meshtastic, radio
- Language: Python
- Homepage:
- Size: 489 KB
- Stars: 98
- Watchers: 5
- Forks: 13
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-meshtastic - Meshtastic-Matrix-Relay - Meshtastic to Matrix Relay (Server Software)
README
# 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](https://matrix.org/bridges/).
---
## Getting Started
M<>M Relay runs on Linux, macOS, and Windows. For setup, configuration, and usage instructions, see the [INSTRUCTIONS.md](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](https://github.com/geoffwhittington/meshtastic-matrix-relay/issues/33), but this is currently not implemented._
---
## Windows Installer
The latest installer is available [here](https://github.com/geoffwhittington/meshtastic-matrix-relay/releases).
---
## 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:
Produce high-level details about your mesh:
See the full list of core plugins [here](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki/Core-Plugins).
### Community & Custom Plugins
It is possible to create custom plugins and share them with the community. Check [example_plugins/README.md](https://github.com/geoffwhittington/meshtastic-matrix-relay/tree/main/example_plugins) and the [Community Plugins Development Guide](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki/Community-Plugin-Development-Guide).
✨️ Visit the [Community Plugins List](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki/Community-Plugin-List)!
#### Install a Community Plugin
Add the repository under the `community-plugins` section in `config.yaml`:
```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](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki/Getting-Started-With-Matrix-&-MM-Relay).
---
## Already on Matrix?
Join us!
- Our project's room: [#mmrelay:meshnet.club](https://matrix.to/#/#mmrelay:meshnet.club)
- Part of the Meshtastic Community Matrix space: [#meshtastic-community:meshnet.club](https://matrix.to/#/#meshtastic-community:meshnet.club)
- Public Relay Room: [#relay-room:meshnet.club](https://matrix.to/#/#relay-room:meshnet.club) - Where we bridge multiple meshnets. Feel free to join us, with or without a relay!