2023-05-17 23:31:33 +00:00
# M<>M Relay
2023-04-28 20:35:49 +00:00
### (Meshtastic <=> Matrix Relay)
2023-04-17 23:50:28 +00:00
2023-04-19 06:21:25 +00:00
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/ ).
2023-04-19 05:30:30 +00:00
## Features
- Bidirectional message relay between Meshtastic devices and Matrix chat rooms, capable of supporting multiple meshnets
2024-07-01 18:55:51 +00:00
- Supports serial, network, and ** *BLE (now too!)*** connections for Meshtastic devices
2023-04-19 06:10:37 +00:00
- Custom keys are embedded in Matrix messages which are used when relaying messages between two or more meshnets.
2023-04-19 05:30:30 +00:00
- Truncates long messages to fit within Meshtastic's payload size
2023-04-29 03:11:11 +00:00
- SQLite database to store node information for improved functionality
2023-04-19 05:30:30 +00:00
- Customizable logging level for easy debugging
- Configurable through a simple YAML file
2023-05-18 19:18:00 +00:00
- 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 ](https://github.com/geoffwhittington/meshtastic-matrix-relay/issues/33 ), but this is currently not implemented. If you are familiar with [matrix-nio ](https://github.com/poljar/matrix-nio/ ), we would gladly accept a PR for this feature!*
2023-04-19 05:30:30 +00:00
2023-04-28 20:42:56 +00:00
### Windows Installer
2023-04-17 23:50:28 +00:00
2023-05-18 19:18:00 +00:00
< img src = "https://user-images.githubusercontent.com/1770544/235249050-8c79107a-50cc-4803-b989-39e58100342d.png" width = "500" / >
2023-04-17 23:50:28 +00:00
2023-04-28 20:42:56 +00:00
The latest installer is available [here ](https://github.com/geoffwhittington/meshtastic-matrix-relay/releases )
2023-04-17 23:50:28 +00:00
2023-04-28 20:42:56 +00:00
### Plugins
2023-04-17 23:50:28 +00:00
2023-04-28 20:42:56 +00:00
Generate a map of your nodes
2023-04-17 23:50:28 +00:00
2023-05-18 19:18:00 +00:00
< img src = "https://user-images.githubusercontent.com/1770544/235247915-47750b4f-d505-4792-a458-54a5f24c1523.png" width = "500" / >
2023-04-17 23:50:28 +00:00
2023-04-28 20:42:56 +00:00
Produce high-level details about your mesh
2023-04-17 23:50:28 +00:00
2023-05-18 19:18:00 +00:00
< img src = "https://user-images.githubusercontent.com/1770544/235245873-1ddc773b-a4cd-4c67-b0a5-b55a29504b73.png" width = "500" / >
## 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!
- In our project's room:
[#mmrelay:matrix.org ](https://matrix.to/#/#mmrelay:matrix.org )
- Which is a part of the Meshtastic Community Matrix space *(an unofficial group of enthusiasts)* :
[#meshtastic-community:matrix.org ](https://matrix.to/#/#meshtastic-community:matrix.org )
2023-04-17 23:50:28 +00:00
2023-04-28 20:42:56 +00:00
## Supported Platforms
2023-04-17 23:50:28 +00:00
2023-05-18 19:18:00 +00:00
The relay is compatible with the following operating systems:
2023-04-19 05:30:30 +00:00
2023-05-17 23:31:33 +00:00
- Linux
- MacOS
- Windows
2023-04-17 23:50:28 +00:00
2023-05-18 19:18:00 +00:00
Refer to [the development instructions ](DEVELOPMENT.md ) for details about running the relay on MacOS and Linux.
