mmrelay 1.0__py3-none-any.whl

mmrelay/setup_utils.py

@@ -0,0 +1,263 @@
+"""
+Setup utilities for MMRelay.
+
+This module provides simple functions for managing the systemd user service
+and generating configuration files.
+"""
+
+# Import version from package
+import os
+import shutil
+import subprocess
+import sys
+from pathlib import Path
+
+
+def get_executable_path():
+    """Get the full path to the mmrelay executable."""
+    return shutil.which("mmrelay") or sys.executable
+
+
+def get_user_service_path():
+    """Get the path to the user service file."""
+    service_dir = Path.home() / ".config" / "systemd" / "user"
+    return service_dir / "mmrelay.service"
+
+
+def service_exists():
+    """Check if the service file exists."""
+    return get_user_service_path().exists()
+
+
+def print_service_commands():
+    """Print the commands for controlling the systemd user service."""
+    print("\nUse these commands to control the mmrelay service:")
+    print("  systemctl --user start mmrelay.service    # Start the service")
+    print("  systemctl --user stop mmrelay.service     # Stop the service")
+    print("  systemctl --user restart mmrelay.service  # Restart the service")
+    print("  systemctl --user status mmrelay.service   # Check service status")
+
+
+def wait_for_service_start():
+    """Wait for the service to start with a loading animation."""
+    import sys
+    import time
+
+    print("\nStarting mmrelay service", end="")
+    sys.stdout.flush()
+
+    # Animation characters
+    chars = ["-", "\\", "|", "/"]
+
+    # Wait for 10 seconds with animation
+    for i in range(40):  # 40 * 0.25s = 10s
+        time.sleep(0.25)
+        print(f"\rStarting mmrelay service {chars[i % len(chars)]}", end="")
+        sys.stdout.flush()
+
+    print("\rStarting mmrelay service... done!")
+    sys.stdout.flush()
+
+
+def read_service_file():
+    """Read the content of the service file if it exists."""
+    service_path = get_user_service_path()
+    if service_path.exists():
+        return service_path.read_text()
+    return None
+
+
+def create_service_file():
+    """Create the systemd user service file."""
+    executable_path = get_executable_path()
+    if not executable_path:
+        print("Error: Could not find mmrelay executable in PATH")
+        return False
+
+    # Create service directory if it doesn't exist
+    service_dir = get_user_service_path().parent
+    service_dir.mkdir(parents=True, exist_ok=True)
+
+    # Create logs directory if it doesn't exist
+    logs_dir = Path.home() / ".mmrelay" / "logs"
+    logs_dir.mkdir(parents=True, exist_ok=True)
+
+    # Try to find the service template file
+    # First, check in the package directory
+    package_dir = os.path.dirname(__file__)
+    template_path = os.path.join(
+        os.path.dirname(os.path.dirname(package_dir)), "tools", "mmrelay.service"
+    )
+
+    # If not found, try the repository root
+    if not os.path.exists(template_path):
+        repo_root = os.path.dirname(os.path.dirname(os.path.dirname(__file__)))
+        template_path = os.path.join(repo_root, "tools", "mmrelay.service")
+
+    # If still not found, try the current directory
+    if not os.path.exists(template_path):
+        template_path = os.path.join(os.getcwd(), "tools", "mmrelay.service")
+
+    if not os.path.exists(template_path):
+        print(f"Error: Could not find service template at {template_path}")
+        return False
+
+    # Read the template
+    with open(template_path, "r") as f:
+        service_template = f.read()
+
+    # Replace placeholders with actual values
+    service_content = (
+        service_template.replace(
+            "WorkingDirectory=%h/meshtastic-matrix-relay",
+            "# WorkingDirectory is not needed for installed package",
+        )
+        .replace(
+            "%h/meshtastic-matrix-relay/.pyenv/bin/python %h/meshtastic-matrix-relay/main.py",
+            executable_path,
+        )
+        .replace(
+            "--config %h/.mmrelay/config/config.yaml",
+            "--config %h/.mmrelay/config.yaml",
+        )
+    )
+
+    # Write service file
+    try:
+        get_user_service_path().write_text(service_content)
+        print(f"Service file created at {get_user_service_path()}")
+        return True
+    except (IOError, OSError) as e:
+        print(f"Error creating service file: {e}")
+        return False
+
+
+def reload_daemon():
+    """Reload the systemd user daemon."""
+    try:
+        # Using absolute path for security
+        subprocess.run(["/usr/bin/systemctl", "--user", "daemon-reload"], check=True)
+        print("Systemd user daemon reloaded")
+        return True
+    except subprocess.CalledProcessError as e:
+        print(f"Error reloading systemd daemon: {e}")
+        return False
+    except OSError as e:
+        print(f"Error: {e}")
+        return False
+
+
+def install_service():
+    """Install or update the MMRelay user service."""
+    # Check if service already exists
+    existing_service = read_service_file()
+
+    if existing_service:
+        print(f"A service file already exists at {get_user_service_path()}")
+        if (
+            not input("Do you want to reinstall/update the service? (y/n): ")
+            .lower()
+            .startswith("y")
+        ):
+            print("Service installation cancelled.")
+            print_service_commands()
+            return True
+
+    # Create or update service file
+    if not create_service_file():
+        return False
+
+    # Reload daemon
+    if not reload_daemon():
+        return False
+
+    if existing_service:
+        print("Service updated successfully")
+    else:
+        print("Service installed successfully")
+
+    # Check if config is valid before starting the service
+    from mmrelay.cli import check_config
+
+    if not check_config():
+        print(
+            "\nWarning: Configuration is not valid. Service is installed but not started."
+        )
+        print("Please fix your configuration and then start the service manually.")
+        print_service_commands()
+        return True
+
+    # Ask if user wants to enable and start the service
+    if (
+        input("Do you want to enable the service to start at boot? (y/n): ")
+        .lower()
+        .startswith("y")
+    ):
+        try:
+            subprocess.run(
+                ["/usr/bin/systemctl", "--user", "enable", "mmrelay.service"],
+                check=True,
+            )
+            print("Service enabled successfully")
+        except subprocess.CalledProcessError as e:
+            print(f"Error enabling service: {e}")
+        except OSError as e:
+            print(f"Error: {e}")
+
+    if input("Do you want to start the service now? (y/n): ").lower().startswith("y"):
+        if start_service():
+            # Wait for the service to start
+            wait_for_service_start()
+
+            # Show service status
+            show_service_status()
+            print("Service started successfully")
+        else:
+            print("\nWarning: Failed to start the service. Please check the logs.")
+
+    print_service_commands()
+
+    return True
+
+
+def start_service():
+    """Start the systemd user service.
+
+    Returns:
+        bool: True if successful, False otherwise.
+    """
+    try:
+        subprocess.run(
+            ["/usr/bin/systemctl", "--user", "start", "mmrelay.service"], check=True
+        )
+        return True
+    except subprocess.CalledProcessError as e:
+        print(f"Error starting service: {e}")
+        return False
+    except OSError as e:
+        print(f"Error: {e}")
+        return False
+
+
+def show_service_status():
+    """Show the status of the systemd user service.
+
+    Returns:
+        bool: True if successful, False otherwise.
+    """
+    try:
+        result = subprocess.run(
+            ["/usr/bin/systemctl", "--user", "status", "mmrelay.service"],
+            check=True,
+            capture_output=True,
+            text=True,
+        )
+        print("\nService Status:")
+        print(result.stdout)
+        return True
+    except subprocess.CalledProcessError as e:
+        print(f"Could not get service status: {e}")
+        return False
+    except OSError as e:
+        print(f"Error: {e}")
+        return False

mmrelay-1.0.dist-info/METADATA

@@ -0,0 +1,160 @@
+Metadata-Version: 2.4
+Name: mmrelay
+Version: 1.0
+Summary: Bridge between Meshtastic mesh networks and Matrix chat rooms
+Home-page: https://github.com/geoffwhittington/meshtastic-matrix-relay
+Author: Geoff Whittington, Jeremiah K., and contributors
+Author-email: jeremiahk@gmx.com
+Project-URL: Bug Tracker, https://github.com/geoffwhittington/meshtastic-matrix-relay/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 4 - Beta
+Classifier: Topic :: Communications
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: meshtastic
+Requires-Dist: Pillow==11.1.0
+Requires-Dist: matrix-nio==0.25.2
+Requires-Dist: matplotlib==3.10.1
+Requires-Dist: requests==2.32.3
+Requires-Dist: markdown==3.7
+Requires-Dist: haversine==2.9.0
+Requires-Dist: schedule==1.2.2
+Requires-Dist: platformdirs==4.2.0
+Requires-Dist: py-staticmaps>=0.4.0
+Dynamic: license-file
+
+# 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](https://matrix.org/bridges/).
+
+---
+
+## Getting Started
+
+MMRelay runs on Linux, macOS, and Windows.
+
+### Quick Installation
+
+```bash
+# Install using pip
+pip install mmrelay
+
+# Or use pipx for isolated installation (recommended)
+pipx install mmrelay
+```
+
+### Resources
+
+- **New Users**: See [INSTRUCTIONS.md](INSTRUCTIONS.md) for setup and configuration
+- **Existing Users**: Check [UPGRADE_TO_V1.md](UPGRADE_TO_V1.md) for migration guidance
+- **Configuration**: Review [sample_config.yaml](sample_config.yaml) for examples
+
+### Command-Line Options
+
+```bash
+usage: mmrelay [-h] [--config CONFIG] [--data-dir DATA_DIR] [--log-level {error,warning,info,debug}] [--logfile LOGFILE] [--version] [--generate-config] [--install-service] [--check-config]
+
+Options:
+  -h, --help            Show this help message and exit
+  --config CONFIG       Path to config file
+  --data-dir DATA_DIR   Base directory for all data (logs, database, plugins)
+  --log-level {error,warning,info,debug}
+                        Set logging level
+  --logfile LOGFILE     Path to log file (can be overridden by --data-dir)
+  --version             Show version and exit
+  --generate-config     Generate a sample config.yaml file
+  --install-service     Install or update the systemd user service
+  --check-config        Check if the configuration file is valid
+```
+
+---
+
+## 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 fields are embedded in Matrix messages for relaying messages between multiple 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 an MQTT broker, if configured in the Meshtastic firmware
+- ✨️ _Cross-platform reactions support_ ✨️ **NEW!!**
+
+_We would love to support [Matrix E2EE rooms](https://github.com/geoffwhittington/meshtastic-matrix-relay/issues/33), but this is currently not implemented._
+
+---
+
+## Windows Installer
+
+![Windows Installer Screenshot](https://user-images.githubusercontent.com/1770544/235249050-8c79107a-50cc-4803-b989-39e58100342d.png)
+
+The latest installer is available [here](https://github.com/geoffwhittington/meshtastic-matrix-relay/releases).
+
+---
+
+## Plugins
+
+M<>M Relay supports plugins for extending its functionality, enabling customization and enhancement of the relay to suit specific needs.
+
+### Core Plugins
+
+Generate a map of your nodes:
+
+![Map Plugin Screenshot](https://user-images.githubusercontent.com/1770544/235247915-47750b4f-d505-4792-a458-54a5f24c1523.png)
+
+Produce high-level details about your mesh:
+
+![Mesh Details Screenshot](https://user-images.githubusercontent.com/1770544/235245873-1ddc773b-a4cd-4c67-b0a5-b55a29504b73.png)
+
+See the full list of core plugins [here](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki/Core-Plugins).
+
+### Community & Custom Plugins
+
+It 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).
+
+✨️ Visit the [Community Plugins List](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki/Community-Plugin-List)!
+
+#### Install a Community Plugin
+
+Add the repository under the `community-plugins` section in `config.yaml`:
+
+```yaml
+community-plugins:
+  example-plugin:
+    active: true
+    repository: https://github.com/jeremiah-k/mmr-plugin-template.git
+    tag: main
+```
+
+### Plugin System
+
+MMRelay features a powerful plugin system with standardized locations:
+
+- **Core Plugins**: Pre-installed with the package
+- **Custom Plugins**: Your own plugins in `~/.mmrelay/plugins/custom/`
+- **Community Plugins**: Third-party plugins in `~/.mmrelay/plugins/community/`
+
+Plugins make it easy to extend functionality without modifying the core code.
+
+---
+
+## 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!
+
+- Our project's room: [#mmrelay:meshnet.club](https://matrix.to/#/#mmrelay:meshnet.club)
+- Part of the Meshtastic Community Matrix space: [#meshtastic-community:meshnet.club](https://matrix.to/#/#meshtastic-community:meshnet.club)
+- 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!

mmrelay-1.0.dist-info/RECORD

@@ -0,0 +1,29 @@
+mmrelay/__init__.py,sha256=tY9iMcQ9e8IhGjiSjukqcNujnqqf7_OTORo7JvRDWvU,278
+mmrelay/cli.py,sha256=H-h-hvrFiOr9gTY5o21snBNiHJCDJx_HLR8JxTs1M-o,12273
+mmrelay/config.py,sha256=epH-xOOIMblG5w_fk86r8JgJK-70bLbX5CfMTWOfPmo,7064
+mmrelay/config_checker.py,sha256=UnoHVTXzfdTfFkbmXv9r_Si76v-sxXLb5FOaQSOM45E,4909
+mmrelay/db_utils.py,sha256=DP2YuKBZtV771wo9X-Z7Ww5txfaIR0inWh1K_oVZ7cA,11430
+mmrelay/log_utils.py,sha256=-ItwMnxa-t2ZKBIp6wzCkq19dk7A0MofsvjS_ilTSlQ,3808
+mmrelay/main.py,sha256=a_ZLDiGcBtrZgTlJq8gqGSW8YCduDgAOEDxzwy4AiXE,10097
+mmrelay/matrix_utils.py,sha256=GkIVj2bbPHtx1emFMwhEhc1SWHcv4UvkuyZYdb-Wnwo,30511
+mmrelay/meshtastic_utils.py,sha256=7Q6mQ2gLLc_yjlGCmakPgGRoBB9znRWOCGMW0MgoZ-w,21414
+mmrelay/plugin_loader.py,sha256=QfSXu4nxxBL_pGttLJGzGki8kRtWbFdtSoD_Qnx2iqU,12758
+mmrelay/setup_utils.py,sha256=iFHEGnrop3Lv2j-MDmOGT4oQYuAm_5YHAc16O2rpkew,8022
+mmrelay/plugins/__init__.py,sha256=KVMQIXRhe0wlGj4O3IZ0vOIQRKFkfPYejHXhJL17qrc,51
+mmrelay/plugins/base_plugin.py,sha256=7tBIARWp9Qc4iAEMcsKiUJh1cbqXHcXAk4dlu1b8SBg,7524
+mmrelay/plugins/debug_plugin.py,sha256=Jziht9Nj_bRO6Rmy7TjfBXaYo5eM3XsenbWFxPpyUs4,443
+mmrelay/plugins/drop_plugin.py,sha256=ACchX6GfEldqTyvsZVg-5jwbe2-CjENQVVZFnw8SaEM,4618
+mmrelay/plugins/health_plugin.py,sha256=svV_GfpAVL0QhiVzi3PVZ1mNpsOL1NHSmkRF-Mn_ExE,2250
+mmrelay/plugins/help_plugin.py,sha256=-C4M1PPi1m-fPRvNAlcMyHDNiEEIF6013z2vzrepa1Q,1453
+mmrelay/plugins/map_plugin.py,sha256=tWzNvErSoIjqpWtdR-uhbnqdX1SQZl1XQn3Qrp195Kk,10024
+mmrelay/plugins/mesh_relay_plugin.py,sha256=E04JU4uKr7KTScahS0VKBJ1xwvq1ULJaeFVYEtceMvA,4273
+mmrelay/plugins/nodes_plugin.py,sha256=RDabzyG5hKG5aYWecsRUcLSjMCCv6Pngmq2Qpld1A1U,2903
+mmrelay/plugins/ping_plugin.py,sha256=RTRdgDQUSO33lreDTmWsTlI0L1C3FJrXE0KYqfEWYO0,4017
+mmrelay/plugins/telemetry_plugin.py,sha256=8SxWv4BLXMUTbiVaD3MjlMMdQyS7S_1OfLlVNAUMSO0,6306
+mmrelay/plugins/weather_plugin.py,sha256=yoKA_HdFqFEhgYdXqLhvXatLphCyLJFuGUKCR7fILv0,8546
+mmrelay-1.0.dist-info/licenses/LICENSE,sha256=yceWauM1c0-FHxVplsD7W1-AbSeRaUNlmqT4UO1msBU,1073
+mmrelay-1.0.dist-info/METADATA,sha256=NCTfzxMnJjPpgBtOP0oGD7ZPYQBHA6CiUkvarmYzrGk,6219
+mmrelay-1.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+mmrelay-1.0.dist-info/entry_points.txt,sha256=SJZwGUOEpQ-qx4H8UL4xKFnKeInGUaZNW1I0ddjK7Ws,45
+mmrelay-1.0.dist-info/top_level.txt,sha256=B_ZLCRm7NYAmI3PipRUyHGymP-C-q16LSeMGzmqJfo4,8
+mmrelay-1.0.dist-info/RECORD,,

mmrelay-1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (78.1.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

mmrelay-1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+mmrelay = mmrelay.cli:main

mmrelay-1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 geoffwhittington
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mmrelay-1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+mmrelay