mmrelay 1.0.10__tar.gz → 1.1.0__tar.gz

{mmrelay-1.0.10/src/mmrelay.egg-info → mmrelay-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mmrelay
-Version: 1.0.10
+Version: 1.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
@@ -14,19 +14,29 @@ Classifier: Topic :: Communications
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: meshtastic
-Requires-Dist: Pillow==11.2.1
+Requires-Dist: meshtastic>=2.6.4
+Requires-Dist: Pillow==11.3.0
 Requires-Dist: matrix-nio==0.25.2
 Requires-Dist: matplotlib==3.10.1
-Requires-Dist: requests==2.32.3
-Requires-Dist: markdown==3.8
+Requires-Dist: requests==2.32.4
+Requires-Dist: markdown==3.8.2
 Requires-Dist: haversine==2.9.0
 Requires-Dist: schedule==1.2.2
 Requires-Dist: platformdirs==4.3.8
 Requires-Dist: py-staticmaps>=0.4.0
 Requires-Dist: rich==14.0.0
 Requires-Dist: setuptools==80.9.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
 Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # M<>M Relay
 
@@ -34,13 +44,26 @@ Dynamic: license-file
 
 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/).
 
+## 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
+- ✨️ _Bidirectional replies and 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._
+
 ## Documentation
 
 Visit our [Wiki](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki) for comprehensive guides and information.
 
 - [Installation Instructions](docs/INSTRUCTIONS.md) - Setup and configuration guide
-- [v1.0 Release Announcement](docs/ANNOUNCEMENT.md) - New changes in v1.0
-- [Upgrade Guide](docs/UPGRADE_TO_V1.md) - Migration guidance for existing users
 
 ---
 
@@ -61,22 +84,23 @@ mmrelay --install-service
 
 For detailed installation and configuration instructions, see the [Installation Guide](docs/INSTRUCTIONS.md).
 
----
+## Docker
 
-## Features
+MMRelay includes official Docker support for easy deployment and management:
 
-- 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!!**
+```bash
+# Quick setup with Docker
+make setup   # Copy config and open editor (first time)
+make build   # Build the Docker image
+make run     # Start the container
+make logs    # View logs
+```
 
-_We would love to support [Matrix E2EE rooms](https://github.com/geoffwhittington/meshtastic-matrix-relay/issues/33), but this is currently not implemented._
+Docker provides isolated environment, easy deployment, automatic restarts, and volume persistence.
+
+For detailed Docker setup instructions, see the [Docker Guide](DOCKER.md).
+
+> **Note**: Docker builds currently use a temporary fork of the meshtastic library with BLE hanging fixes. PyPI releases use the upstream library. This will be resolved when the fixes are merged upstream.
 
 ---
 
@@ -84,7 +108,7 @@ _We would love to support [Matrix E2EE rooms](https://github.com/geoffwhittingto
 
 ![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).
+The latest installer is available in the [releases section](https://github.com/geoffwhittington/meshtastic-matrix-relay/releases).
 
 ---
 
@@ -102,7 +126,7 @@ 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).
+See the full list of [core plugins](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki/Core-Plugins).
 
 ### Community & Custom Plugins
 
@@ -147,6 +171,6 @@ See our Wiki page [Getting Started With Matrix & MM Relay](https://github.com/ge
 
 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!
+- Our project's room: [#mmrelay:matrix.org](https://matrix.to/#/#mmrelay:matrix.org)
+- Part of the Meshtastic Community Matrix space: [#meshnetclub:matrix.org](https://matrix.to/#/#meshnetclub:matrix.org)
+- Public Relay Room: [#mmrelay-relay-room:matrix.org](https://matrix.to/#/#mmrelay-relay-room:matrix.org) - Where we bridge multiple meshnets. Feel free to join us, with or without a relay!

{mmrelay-1.0.10 → mmrelay-1.1.0}/README.md

@@ -4,13 +4,26 @@
 
 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/).
 
+## 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
+- ✨️ _Bidirectional replies and 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._
+
 ## Documentation
 
 Visit our [Wiki](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki) for comprehensive guides and information.
 
 - [Installation Instructions](docs/INSTRUCTIONS.md) - Setup and configuration guide
-- [v1.0 Release Announcement](docs/ANNOUNCEMENT.md) - New changes in v1.0
-- [Upgrade Guide](docs/UPGRADE_TO_V1.md) - Migration guidance for existing users
 
 ---
 
@@ -31,22 +44,23 @@ mmrelay --install-service
 
 For detailed installation and configuration instructions, see the [Installation Guide](docs/INSTRUCTIONS.md).
 
----
+## Docker
 
-## Features
+MMRelay includes official Docker support for easy deployment and management:
 
-- 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!!**
+```bash
+# Quick setup with Docker
+make setup   # Copy config and open editor (first time)
+make build   # Build the Docker image
+make run     # Start the container
+make logs    # View logs
+```
 
-_We would love to support [Matrix E2EE rooms](https://github.com/geoffwhittington/meshtastic-matrix-relay/issues/33), but this is currently not implemented._
+Docker provides isolated environment, easy deployment, automatic restarts, and volume persistence.
+
+For detailed Docker setup instructions, see the [Docker Guide](DOCKER.md).
+
+> **Note**: Docker builds currently use a temporary fork of the meshtastic library with BLE hanging fixes. PyPI releases use the upstream library. This will be resolved when the fixes are merged upstream.
 
 ---
 
@@ -54,7 +68,7 @@ _We would love to support [Matrix E2EE rooms](https://github.com/geoffwhittingto
 
 ![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).
+The latest installer is available in the [releases section](https://github.com/geoffwhittington/meshtastic-matrix-relay/releases).
 
 ---
 
@@ -72,7 +86,7 @@ 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).
+See the full list of [core plugins](https://github.com/geoffwhittington/meshtastic-matrix-relay/wiki/Core-Plugins).
 
 ### Community & Custom Plugins
 
@@ -117,6 +131,6 @@ See our Wiki page [Getting Started With Matrix & MM Relay](https://github.com/ge
 
 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!
+- Our project's room: [#mmrelay:matrix.org](https://matrix.to/#/#mmrelay:matrix.org)
+- Part of the Meshtastic Community Matrix space: [#meshnetclub:matrix.org](https://matrix.to/#/#meshnetclub:matrix.org)
+- Public Relay Room: [#mmrelay-relay-room:matrix.org](https://matrix.to/#/#mmrelay-relay-room:matrix.org) - Where we bridge multiple meshnets. Feel free to join us, with or without a relay!

mmrelay-1.1.0/requirements.txt

@@ -0,0 +1,15 @@
+# TEMPORARY: Using fork with BLE hanging fix until upstream merge
+# Commit: 33d23e9c28508a740da6567627e42d81552c9b58
+# For PyPI compatibility, setup.py uses upstream meshtastic>=2.6.4
+meshtastic @ git+https://github.com/jeremiah-k/meshtastic-python.git@33d23e9c28508a740da6567627e42d81552c9b58
+Pillow==11.3.0
+matrix-nio==0.25.2
+matplotlib==3.10.1
+requests==2.32.4
+markdown==3.8.2
+haversine==2.9.0
+schedule==1.2.2
+platformdirs==4.3.8
+py-staticmaps>=0.4.0
+rich==14.0.0
+setuptools==80.9.0

mmrelay-1.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

mmrelay-1.1.0/setup.py

@@ -0,0 +1,46 @@
+from setuptools import find_packages, setup
+
+# Read README file with proper resource management
+with open("README.md", encoding="utf-8") as f:
+    long_description = f.read()
+
+setup(
+    name="mmrelay",
+    version="1.1.0",
+    author="Geoff Whittington, Jeremiah K., and contributors",
+    author_email="jeremiahk@gmx.com",
+    description="Bridge between Meshtastic mesh networks and Matrix chat rooms",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/geoffwhittington/meshtastic-matrix-relay",
+    project_urls={
+        "Bug Tracker": "https://github.com/geoffwhittington/meshtastic-matrix-relay/issues"
+    },
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Development Status :: 4 - Beta",
+        "Topic :: Communications",
+    ],
+    python_requires=">=3.8",
+    install_requires=[
+        "meshtastic>=2.6.4",
+        "Pillow==11.3.0",
+        "matrix-nio==0.25.2",
+        "matplotlib==3.10.1",
+        "requests==2.32.4",
+        "markdown==3.8.2",
+        "haversine==2.9.0",
+        "schedule==1.2.2",
+        "platformdirs==4.3.8",
+        "py-staticmaps>=0.4.0",
+        "rich==14.0.0",
+        "setuptools==80.9.0",
+    ],
+    packages=find_packages(where="src"),
+    package_dir={"": "src"},
+    include_package_data=True,
+    package_data={"mmrelay.tools": ["sample_config.yaml"]},
+    entry_points={"console_scripts": ["mmrelay = mmrelay.cli:main"]},
+)

{mmrelay-1.0.10 → mmrelay-1.1.0}/src/mmrelay/__init__.py

@@ -14,4 +14,4 @@ else:
         __version__ = version("mmrelay")
     except PackageNotFoundError:
         # If all else fails, use hardcoded version
-        __version__ = "1.0.10"
+        __version__ = "1.1.0"

{mmrelay-1.0.10 → mmrelay-1.1.0}/src/mmrelay/db_utils.py

@@ -8,17 +8,57 @@ from mmrelay.log_utils import get_logger
 # Global config variable that will be set from main.py
 config = None
 
+# Cache for database path to avoid repeated logging and path resolution
+_cached_db_path = None
+_db_path_logged = False
+_cached_config_hash = None
+
 logger = get_logger(name="db_utils")
 
 
+def clear_db_path_cache():
+    """Clear the cached database path to force re-resolution on next call.
+
+    This is useful for testing or if the application supports runtime
+    configuration changes.
+    """
+    global _cached_db_path, _db_path_logged, _cached_config_hash
+    _cached_db_path = None
+    _db_path_logged = False
+    _cached_config_hash = None
+
+
 # Get the database path
 def get_db_path():
     """
-    Returns the path to the SQLite database file.
-    By default, uses the standard data directory (~/.mmrelay/data).
-    Can be overridden by setting 'path' under 'database' in config.yaml.
+    Resolve and return the file path to the SQLite database, using configuration overrides if provided.
+
+    By default, returns the path to `meshtastic.sqlite` in the standard data directory (`~/.mmrelay/data`).
+    If a custom path is specified in the configuration under `database.path` (preferred) or `db.path` (legacy),
+    that path is used instead. The resolved path is cached for subsequent calls, and the directory is created
+    if it does not exist. Cache is automatically invalidated if the relevant configuration changes.
     """
-    global config
+    global config, _cached_db_path, _db_path_logged, _cached_config_hash
+
+    # Create a hash of the relevant config sections to detect changes
+    current_config_hash = None
+    if config is not None:
+        # Hash only the database-related config sections
+        db_config = {
+            "database": config.get("database", {}),
+            "db": config.get("db", {}),  # Legacy format
+        }
+        current_config_hash = hash(str(sorted(db_config.items())))
+
+    # Check if cache is valid (path exists and config hasn't changed)
+    if _cached_db_path is not None and current_config_hash == _cached_config_hash:
+        return _cached_db_path
+
+    # Config changed or first call - clear cache and re-resolve
+    if current_config_hash != _cached_config_hash:
+        _cached_db_path = None
+        _db_path_logged = False
+        _cached_config_hash = current_config_hash
 
     # Check if config is available
     if config is not None:
@@ -30,7 +70,12 @@ def get_db_path():
                 db_dir = os.path.dirname(custom_path)
                 if db_dir:
                     os.makedirs(db_dir, exist_ok=True)
-                logger.info(f"Using database path from config: {custom_path}")
+
+                # Cache the path and log only once
+                _cached_db_path = custom_path
+                if not _db_path_logged:
+                    logger.info(f"Using database path from config: {custom_path}")
+                    _db_path_logged = True
                 return custom_path
 
         # Check legacy format (db section)
@@ -41,13 +86,20 @@ def get_db_path():
                 db_dir = os.path.dirname(custom_path)
                 if db_dir:
                     os.makedirs(db_dir, exist_ok=True)
-                logger.warning(
-                    "Using 'db.path' configuration (legacy). 'database.path' is now the preferred format and 'db.path' will be deprecated in a future version."
-                )
+
+                # Cache the path and log only once
+                _cached_db_path = custom_path
+                if not _db_path_logged:
+                    logger.warning(
+                        "Using 'db.path' configuration (legacy). 'database.path' is now the preferred format and 'db.path' will be deprecated in a future version."
+                    )
+                    _db_path_logged = True
                 return custom_path
 
     # Use the standard data directory
-    return os.path.join(get_data_dir(), "meshtastic.sqlite")
+    default_path = os.path.join(get_data_dir(), "meshtastic.sqlite")
+    _cached_db_path = default_path
+    return default_path
 
 
 # Initialize SQLite database

{mmrelay-1.0.10 → mmrelay-1.1.0}/src/mmrelay/log_utils.py

@@ -30,6 +30,17 @@ log_file_path = None
 
 
 def get_logger(name):
+    """
+    Create and configure a logger with console and optional file output, supporting colorized output and log rotation.
+
+    The logger's level, color usage, and file logging behavior are determined by global configuration and command line arguments. Console output uses rich formatting if enabled. File logging supports log rotation and stores logs in a configurable or default location. The log file path is stored globally if the logger name is "M<>M Relay".
+
+    Parameters:
+        name (str): The name of the logger to create.
+
+    Returns:
+        logging.Logger: The configured logger instance.
+    """
     logger = logging.getLogger(name=name)
 
     # Default to INFO level if config is not available
@@ -134,3 +145,48 @@ def get_logger(name):
         logger.addHandler(file_handler)
 
     return logger
+
+
+def setup_upstream_logging_capture():
+    """
+    Redirects warning and error log messages from upstream libraries and the root logger into the application's formatted logging system.
+
+    This ensures that log output from external dependencies (such as "meshtastic", "bleak", and "asyncio") appears with consistent formatting alongside the application's own logs. Only messages at WARNING level or higher are captured, and messages originating from the application's own loggers are excluded to prevent recursion.
+    """
+    # Get our main logger
+    main_logger = get_logger("Upstream")
+
+    # Create a custom handler that redirects root logger messages
+    class UpstreamLogHandler(logging.Handler):
+        def emit(self, record):
+            # Skip if this is already from our logger to avoid recursion
+            """
+            Redirects log records from external sources to the main logger, mapping their severity and prefixing with the original logger name.
+
+            Skips records originating from the application's own loggers to prevent recursion.
+            """
+            if record.name.startswith("mmrelay") or record.name == "Upstream":
+                return
+
+            # Map the log level and emit through our logger
+            if record.levelno >= logging.ERROR:
+                main_logger.error(f"[{record.name}] {record.getMessage()}")
+            elif record.levelno >= logging.WARNING:
+                main_logger.warning(f"[{record.name}] {record.getMessage()}")
+            elif record.levelno >= logging.INFO:
+                main_logger.info(f"[{record.name}] {record.getMessage()}")
+            else:
+                main_logger.debug(f"[{record.name}] {record.getMessage()}")
+
+    # Add our handler to the root logger
+    root_logger = logging.getLogger()
+    upstream_handler = UpstreamLogHandler()
+    upstream_handler.setLevel(logging.WARNING)  # Only capture warnings and errors
+    root_logger.addHandler(upstream_handler)
+
+    # Also set up specific loggers for known upstream libraries
+    for logger_name in ["meshtastic", "bleak", "asyncio"]:
+        upstream_logger = logging.getLogger(logger_name)
+        upstream_logger.addHandler(upstream_handler)
+        upstream_logger.setLevel(logging.WARNING)
+        upstream_logger.propagate = False  # Prevent duplicate messages via root logger

{mmrelay-1.0.10 → mmrelay-1.1.0}/src/mmrelay/main.py

@@ -20,7 +20,7 @@ from mmrelay.db_utils import (
     update_shortnames,
     wipe_message_map,
 )
-from mmrelay.log_utils import get_logger
+from mmrelay.log_utils import get_logger, setup_upstream_logging_capture
 from mmrelay.matrix_utils import connect_matrix, join_matrix_room
 from mmrelay.matrix_utils import logger as matrix_logger
 from mmrelay.matrix_utils import on_room_member, on_room_message
@@ -50,13 +50,12 @@ def print_banner():
 
 async def main(config):
     """
-    Main asynchronous function to set up and run the relay.
-    Includes logic for wiping the message_map if configured in database.msg_map.wipe_on_restart
-    or db.msg_map.wipe_on_restart (legacy format).
-    Also updates longnames and shortnames periodically as before.
+    Sets up and runs the asynchronous relay between Meshtastic and Matrix, managing connections, event handling, and graceful shutdown.
 
-    Args:
-        config: The loaded configuration
+    This function initializes the database, configures logging, loads plugins, connects to both Meshtastic and Matrix, joins specified Matrix rooms, and registers event callbacks for message and membership events. It periodically updates node names from the Meshtastic network and manages the Matrix sync loop, handling reconnections and shutdown signals. If configured, it wipes the message map on startup and shutdown.
+
+    Parameters:
+        config: The loaded configuration dictionary containing Matrix, Meshtastic, and database settings.
     """
     # Extract Matrix configuration
     from typing import List
@@ -69,6 +68,9 @@ async def main(config):
     # Initialize the SQLite database
     initialize_database()
 
+    # Set up upstream logging capture to format library messages consistently
+    setup_upstream_logging_capture()
+
     # Check database config for wipe_on_restart (preferred format)
     database_config = config.get("database", {})
     msg_map_config = database_config.get("msg_map", {})
@@ -131,11 +133,8 @@ async def main(config):
         # On Windows, we can't use add_signal_handler, so we'll handle KeyboardInterrupt
         pass
 
-    # -------------------------------------------------------------------
-    # IMPORTANT: We create a task to run the meshtastic_utils.check_connection()
-    # so its while loop runs in parallel with the matrix sync loop
-    # Use "_" to avoid trunk's "assigned but unused variable" warning
-    # -------------------------------------------------------------------
+    # Start connection health monitoring using getMetadata() heartbeat
+    # This provides proactive connection detection for all interface types
     _ = asyncio.create_task(meshtastic_utils.check_connection())
 
     # Start the Matrix client sync loop