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
581 Commity
4 Gałęzie
0 Tagi
436 KiB
Python 93.7%
Inno Setup 6.3%
 
 
Go to file
mate bff269a45c
Merge branch 'geoffwhittington:main' into main 		2024-07-19 22:40:37 +02:00
.github/workflows Remove hardcoded workflow body so github generates release notes properly 2024-04-03 11:20:04 -05: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 Add parameter passing to plugins and help 2024-07-15 20:48:32 +02:00
.gitignore Add Channel Utilization plugin 2024-07-14 17:33:19 +02: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 Update README.md 2024-07-01 13:55:51 -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 Update main.py for reconnection changes 2024-07-17 14:19:48 -05:00
matrix_utils.py Removed debug logging 2024-07-17 14:26:25 -05:00
meshtastic_utils.py Logging changes 2024-07-19 12:48:48 -05:00
mmrelay.iss Increase window height 2024-07-03 14:10:44 -05:00
plugin_loader.py Add airutilz, battery, snr and voltage plugins 2024-07-14 21:24:11 +02:00
requirements.txt Bump matplotlib version to latest 2024-07-01 14:42:19 -05:00
sample_config.yaml Update ble config field 2024-07-01 14:18:42 -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 serial, network, and BLE (now too!) 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.