{"id":16782740,"url":"https://github.com/geoffwhittington/meshtastic-matrix-relay","last_synced_at":"2025-04-06T00:07:43.283Z","repository":{"id":153793445,"uuid":"629244983","full_name":"geoffwhittington/meshtastic-matrix-relay","owner":"geoffwhittington","description":"A relay between a Matrix.org room and a Meshtastic radio. This relay extends your Matrix.org-based communication with a LoRa-based Meshtastic radio mesh. This is not an official product of Matrix.org or Meshtastic.","archived":false,"fork":false,"pushed_at":"2025-04-02T17:17:03.000Z","size":501,"stargazers_count":98,"open_issues_count":1,"forks_count":13,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-02T18:27:06.668Z","etag":null,"topics":["lora","matrix","mesh-networks","meshtastic","radio"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/geoffwhittington.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-17T23:40:19.000Z","updated_at":"2025-04-02T17:17:07.000Z","dependencies_parsed_at":null,"dependency_job_id":"89af4258-3872-4a4e-a595-d93a6f8bfe0d","html_url":"https://github.com/geoffwhittington/meshtastic-matrix-relay","commit_stats":{"total_commits":424,"total_committers":8,"mean_commits":53.0,"dds":"0.24292452830188682","last_synced_commit":"767658cdfc214bc75c9848c76d21952dca23057a"},"previous_names":[],"tags_count":64,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geoffwhittington%2Fmeshtastic-matrix-relay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geoffwhittington%2Fmeshtastic-matrix-relay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geoffwhittington%2Fmeshtastic-matrix-relay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geoffwhittington%2Fmeshtastic-matrix-relay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/geoffwhittington","download_url":"https://codeload.github.com/geoffwhittington/meshtastic-matrix-relay/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247415969,"owners_count":20935388,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["lora","matrix","mesh-networks","meshtastic","radio"],"created_at":"2024-10-13T07:48:04.979Z","updated_at":"2025-04-06T00:07:43.262Z","avatar_url":"https://github.com/geoffwhittington.png","language":"Python","funding_links":[],"categories":["Server Software"],"sub_categories":["Regional"],"readme":"# M\u003c\u003eM Relay\n\n## (Meshtastic \u003c=\u003e Matrix Relay)\n\nA 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/).\n\n---\n\n## Getting Started\n\nM\u003c\u003eM Relay runs on Linux, macOS, and Windows. For setup, configuration, and usage instructions, see the [INSTRUCTIONS.md](INSTRUCTIONS.md) file.\n\n---\n\n## Features\n\n- Bidirectional message relay between Meshtastic devices and Matrix chat rooms, capable of supporting multiple meshnets\n- Supports serial, network, and **_BLE (now too!)_** connections for Meshtastic devices\n- Custom fields are embedded in Matrix messages for relaying messages between multiple meshnets\n- Truncates long messages to fit within Meshtastic's payload size\n- SQLite database to store node information for improved functionality\n- Customizable logging level for easy debugging\n- Configurable through a simple YAML file\n- Supports mapping multiple rooms and channels 1:1\n- Relays messages to/from an MQTT broker, if configured in the Meshtastic firmware\n- ✨️ _Cross-platform reactions support_ ✨️ **NEW!!**\n\n_We would love to support [Matrix E2EE rooms](https://github.com/geoffwhittington/meshtastic-matrix-relay/issues/33), but this is currently not implemented._\n\n---\n\n## Windows Installer\n\n![Windows Installer Screenshot](https://user-images.githubusercontent.com/1770544/235249050-8c79107a-50cc-4803-b989-39e58100342d.png)\n\nThe latest installer is available [here](https://github.com/geoffwhittington/meshtastic-matrix-relay/releases).\n\n---\n\n## Plugins\n\nM\u003c\u003eM Relay supports plugins for extending its functionality, enabling customization and enhancement of the relay to suit specific needs.\n\n### Core Plugins\n\nGenerate a map of your nodes:\n\n![Map Plugin Screenshot](https://user-images.githubusercontent.com/1770544/235247915-47750b4f-d505-4792-a458-54a5f24c1523.png)\n\nProduce high-level details about your mesh:\n\n![Mesh Details Screenshot](https://user-images.githubusercontent.com/1770544/235245873-1ddc773b-a4cd-4c67-b0a5-b55a29504b73.png)\n\nSee the full list of core plugins [here](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki/Core-Plugins).\n\n### Community \u0026 Custom Plugins\n\nIt is possible to create custom plugins and share them with the community. Check [example_plugins/README.md](https://github.com/geoffwhittington/meshtastic-matrix-relay/tree/main/example_plugins) and the [Community Plugins Development Guide](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki/Community-Plugin-Development-Guide).\n\n✨️ Visit the [Community Plugins List](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki/Community-Plugin-List)!\n\n#### Install a Community Plugin\n\nAdd the repository under the `community-plugins` section in `config.yaml`:\n\n```yaml\ncommunity-plugins:\n  example-plugin:\n    active: true\n    repository: https://github.com/jeremiah-k/mmr-plugin-template.git\n    tag: main\n```\n\n---\n\n## Getting Started with Matrix\n\nSee our Wiki page [Getting Started With Matrix \u0026 MM Relay](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki/Getting-Started-With-Matrix-\u0026-MM-Relay).\n\n---\n\n## Already on Matrix?\n\nJoin us!\n\n- Our project's room: [#mmrelay:meshnet.club](https://matrix.to/#/#mmrelay:meshnet.club)\n- Part of the Meshtastic Community Matrix space: [#meshtastic-community:meshnet.club](https://matrix.to/#/#meshtastic-community:meshnet.club)\n- Public Relay Room: [#relay-room:meshnet.club](https://matrix.to/#/#relay-room:meshnet.club) - Where we bridge multiple meshnets. Feel free to join us, with or without a relay!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeoffwhittington%2Fmeshtastic-matrix-relay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgeoffwhittington%2Fmeshtastic-matrix-relay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeoffwhittington%2Fmeshtastic-matrix-relay/lists"}