640113dfbd
|
||
|---|---|---|
| .github/workflows | ||
| example_plugins | ||
| gui | ||
| plugins | ||
| .gitignore | ||
| DEVELOPMENT.md | ||
| LICENSE | ||
| README.md | ||
| config.py | ||
| db_utils.py | ||
| log_utils.py | ||
| main.py | ||
| matrix_utils.py | ||
| meshtastic_utils.py | ||
| mmrelay.iss | ||
| plugin_loader.py | ||
| requirements.txt | ||
| sample_config.yaml | ||
README.md
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
- Supports mapping multiple rooms and channels 1:1
- Relays messages to/from a MQTT broker, if configured in the Meshtastic firmware (Note: Messages relayed via MQTT currently share the relay's
meshnet_name)
We would love to support Matrix E2EE rooms, but this is currently not implemented. If you are familiar with matrix-nio, we would gladly accept a PR for this feature!
Windows Installer
The latest installer is available here
Plugins
Generate a map of your nodes
Produce high-level details about your mesh
Getting Started with Matrix
See our Wiki page Getting Started With Matrix & MM Relay.
Already on Matrix?
Join us!
-
In our project's room: #mmrelay:matrix.org
-
Which is a part of the Meshtastic Community Matrix space (an unofficial group of enthusiasts): #meshtastic-community:matrix.org
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.