mirror
/
meshtastic-matrix-relay
kopia lustrzana https://github.com/mate-dev/meshtastic-matrix-relay
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność
A powerful and easy-to-use relay between Meshtastic devices and Matrix chat rooms, allowing seamless communication across platforms
244 Commity
3 Gałęzie
0 Tagi
252 KiB
Python 91.7%
Inno Setup 8.3%
 
 
Go to file
mate 2851615fdc
Merge pull request #3 from CezaryPuchowski/Markdown-in-some-plugins 
nodes_plugin response in md
 		2023-10-25 18:12:34 +02:00
.github/workflows Discover the version from Git tag 2023-04-25 20:20:52 -04:00
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 try another aproche 2023-10-01 20:38:47 +02:00
.gitignore custom plugin support 2023-04-27 19:58:29 -04:00
DEVELOPMENT.md Update DEVELOPMENT.md 2023-09-11 13:30:32 -04:00
LICENSE Create LICENSE 2023-04-26 10:48:45 -04:00
README.md Documentation updates 2023-05-18 14:18:00 -05:00
config.py Feature/refactor (#18) 2023-04-27 13:04:54 -04:00
db_utils.py Making new function names uniform 2023-06-08 22:37:55 -05:00
log_utils.py Feature/refactor (#18) 2023-04-27 13:04:54 -04:00
main.py Cleanup 2023-06-09 12:17:43 -05:00
matrix_utils.py First work for shortnames 2023-06-08 17:00:06 -05:00
meshtastic_utils.py Getting closer! 2023-06-08 22:04:59 -05:00
mmrelay.iss Fix OverwriteConfig value in install script 2023-05-07 22:05:32 -05:00
plugin_loader.py Improvements to mapping, and retry capability. Plugin scheduling is now supported 2023-06-02 22:32:10 -04:00
requirements.txt nodes_plugin response in md 2023-10-01 14:46:16 +02:00
sample_config.yaml Add nodes to sample config 2023-05-19 11:02:48 -04: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
  • 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!

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.