A powerful and easy-to-use relay between Meshtastic devices and Matrix chat rooms, allowing seamless communication across platforms
 
 
Go to file
Jeremiah K df9c207908
Merge pull request #38 from jeremiah-k/main
Update docs w/ alias changes
2023-05-07 18:42:39 -05:00
.github/workflows
example_plugins Added custom plugin guidance 2023-04-27 21:21:43 -04:00
gui Updates (#35) 2023-05-07 14:17:23 -04:00
plugins Updates (#35) 2023-05-07 14:17:23 -04:00
.gitignore
DEVELOPMENT.md Docs changes 2023-05-07 18:40:30 -05:00
LICENSE
README.md Update README.md 2023-04-28 22:11:11 -05:00
config.py
db_utils.py Allow plugins to use database 2023-04-28 03:04:09 -04:00
log_utils.py
main.py Allow plugins to use database 2023-04-28 03:04:09 -04:00
matrix_utils.py Matrix alias support 2023-05-07 17:51:58 -05:00
meshtastic_utils.py Updates (#35) 2023-05-07 14:17:23 -04:00
mmrelay.iss Update installer script w/ alias changes 2023-05-07 18:41:46 -05:00
plugin_loader.py Updates (#35) 2023-05-07 14:17:23 -04:00
requirements.txt Updates (#35) 2023-05-07 14:17:23 -04:00
sample_config.yaml Docs changes 2023-05-07 18:40:30 -05:00

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
  • 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.