mmrelay 1.1.0__py3-none-any.whl → 1.1.1__py3-none-any.whl

mmrelay/__init__.py

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

mmrelay/meshtastic_utils.py

@@ -50,14 +50,15 @@ reconnect_task = None  # To keep track of the reconnect task
 # Track pubsub subscription state to prevent duplicate subscriptions during reconnections
 subscribed_to_messages = False
 subscribed_to_connection_lost = False
+subscribed_to_connection_established = False
 
 
 def is_running_as_service():
     """
-    Determine if the application is running as a systemd service.
-
+    Check if the application is running as a systemd service.
+    
     Returns:
-        bool: True if running under systemd (either via environment variable or parent process), False otherwise.
+        True if the process is running under systemd, either by detecting the INVOCATION_ID environment variable or by verifying that the parent process is systemd; otherwise, False.
     """
     # Check for INVOCATION_ID environment variable (set by systemd)
     if os.environ.get("INVOCATION_ID"):
@@ -88,14 +89,14 @@ def serial_port_exists(port_name):
 
 def connect_meshtastic(passed_config=None, force_connect=False):
     """
-    Establishes and manages a connection to a Meshtastic device using the configured connection type (serial, BLE, or TCP).
-
-    If a configuration is provided, updates the global configuration and Matrix room mappings. Handles reconnection logic, including closing any existing connection if `force_connect` is True. Retries connection attempts with exponential backoff until successful or shutdown is initiated. Subscribes to message and connection lost events only once per process to avoid duplicate subscriptions.
-
+    Establishes and manages a connection to a Meshtastic device using the specified connection type (serial, BLE, or TCP).
+    
+    If a configuration is provided, updates the global configuration and Matrix room mappings. Handles reconnection logic, including closing any existing connection if `force_connect` is True. Retries connection attempts with exponential backoff until successful or shutdown is initiated. Subscribes to message and connection events only once per process to avoid duplicate subscriptions.
+    
     Parameters:
         passed_config (dict, optional): Configuration dictionary to use for the connection. If provided, updates the global configuration.
         force_connect (bool, optional): If True, forces a new connection even if one already exists.
-
+    
     Returns:
         Meshtastic interface client if the connection is successful, or None if the connection fails or shutdown is in progress.
     """
@@ -202,8 +203,8 @@ def connect_meshtastic(passed_config=None, force_connect=False):
                     f"Connected to {nodeInfo['user']['shortName']} / {nodeInfo['user']['hwModel']}"
                 )
 
-                # Subscribe to message and connection lost events (only if not already subscribed)
-                global subscribed_to_messages, subscribed_to_connection_lost
+                # Subscribe to message and connection events (only if not already subscribed)
+                global subscribed_to_messages, subscribed_to_connection_lost, subscribed_to_connection_established
                 if not subscribed_to_messages:
                     pub.subscribe(on_meshtastic_message, "meshtastic.receive")
                     subscribed_to_messages = True
@@ -216,6 +217,13 @@ def connect_meshtastic(passed_config=None, force_connect=False):
                     subscribed_to_connection_lost = True
                     logger.debug("Subscribed to meshtastic.connection.lost")
 
+                if not subscribed_to_connection_established:
+                    pub.subscribe(
+                        on_established_meshtastic_connection, "meshtastic.connection.established"
+                    )
+                    subscribed_to_connection_established = True
+                    logger.debug("Subscribed to meshtastic.connection.established")
+
             except (
                 serial.SerialException,
                 BleakDBusError,
@@ -241,10 +249,13 @@ def connect_meshtastic(passed_config=None, force_connect=False):
     return meshtastic_client
 
 
-def on_lost_meshtastic_connection(interface=None):
+def on_lost_meshtastic_connection(interface=None, detection_source="detected by library"):
     """
-    Callback invoked when the Meshtastic connection is lost.
-    Initiates a reconnect sequence unless shutting_down is True.
+    Handles Meshtastic connection loss by initiating a reconnection sequence unless a shutdown is in progress or a reconnection is already underway.
+    
+    Parameters:
+        interface: The interface that lost connection (unused; present for compatibility).
+        detection_source (str): Description of how the disconnection was detected.
     """
     global meshtastic_client, reconnecting, shutting_down, event_loop, reconnect_task
     with meshtastic_lock:
@@ -257,7 +268,7 @@ def on_lost_meshtastic_connection(interface=None):
             )
             return
         reconnecting = True
-        logger.error("Lost connection. Reconnecting...")
+        logger.error(f"Lost connection ({detection_source}). Reconnecting...")
 
         if meshtastic_client:
             try:
@@ -278,8 +289,9 @@ def on_lost_meshtastic_connection(interface=None):
 
 async def reconnect():
     """
-    Asynchronously attempts to reconnect with exponential backoff.
-    Stops if shutting_down is set.
+    Asynchronously attempts to reconnect to the Meshtastic device using exponential backoff, stopping if a shutdown is initiated.
+    
+    The function increases the wait time between attempts up to a maximum of 5 minutes and provides a progress bar if not running as a service. The reconnection process halts immediately if the shutdown flag is set or if reconnection succeeds.
     """
     global meshtastic_client, reconnecting, shutting_down
     backoff_time = 10
@@ -334,11 +346,23 @@ async def reconnect():
         reconnecting = False
 
 
-def on_meshtastic_message(packet, interface):
+def on_established_meshtastic_connection(interface=None):
+    """
+    Callback triggered when a Meshtastic connection is successfully established.
+    
+    Clears the reconnecting flag and logs the connection event.
     """
-    Processes incoming Meshtastic messages and relays them to Matrix rooms or plugins based on message type and interaction settings.
+    global reconnecting
+    with meshtastic_lock:
+        logger.info("Connection established (detected by library)")
+        reconnecting = False  # Clear reconnecting flag when connection is confirmed
+
 
-    Handles reactions and replies by relaying them to Matrix if enabled in the interaction settings. Normal text messages are relayed to all mapped Matrix rooms unless handled by a plugin or directed to the relay node. Non-text messages are passed to plugins for processing. Filters out messages from unmapped channels or disabled detection sensors, and ensures sender information is retrieved or stored as needed.
+def on_meshtastic_message(packet, interface):
+    """
+    Process incoming Meshtastic messages and relay them to Matrix rooms or plugins according to message type and interaction settings.
+    
+    Handles reactions and replies by relaying them to Matrix if enabled. Normal text messages are relayed to all mapped Matrix rooms unless handled by a plugin or directed to the relay node. Non-text messages are passed to plugins for processing. Messages from unmapped channels or disabled detection sensors are filtered out, and sender information is retrieved or stored as needed.
     """
     global config, matrix_rooms
 
@@ -643,10 +667,11 @@ def on_meshtastic_message(packet, interface):
 
 async def check_connection():
     """
-    Periodically checks the Meshtastic connection by calling localNode.getMetadata().
-    This creates an admin message to verify the connection is alive for all interface types.
-    If it fails or doesn't return the firmware version, we assume the connection is lost
-    and attempt to reconnect.
+    Periodically verifies the health of the Meshtastic connection and triggers reconnection if needed.
+    
+    For non-BLE connections, this coroutine calls `localNode.getMetadata()` at a configurable interval to confirm the connection is alive. If the health check fails or does not return expected metadata, it invokes the connection lost handler to initiate reconnection. BLE connections are excluded from periodic checks, as their library provides real-time disconnection detection.
+    
+    This coroutine runs continuously until shutdown is requested.
     """
     global meshtastic_client, shutting_down, config, reconnecting
 
@@ -663,33 +688,44 @@ async def check_connection():
         f"Starting connection heartbeat monitor (interval: {heartbeat_interval}s)"
     )
 
+    # Track if we've logged the BLE skip message to avoid spam
+    ble_skip_logged = False
+
     while not shutting_down:
         if meshtastic_client and not reconnecting:
-            try:
-                logger.debug(
-                    f"Checking {connection_type} connection health using getMetadata()"
-                )
-                output_capture = io.StringIO()
-                with contextlib.redirect_stdout(
-                    output_capture
-                ), contextlib.redirect_stderr(output_capture):
-                    meshtastic_client.localNode.getMetadata()
+            # BLE has real-time disconnection detection in the library
+            # Skip periodic health checks to avoid duplicate reconnection attempts
+            if connection_type == "ble":
+                if not ble_skip_logged:
+                    logger.info("BLE connection uses real-time disconnection detection - health checks disabled")
+                    ble_skip_logged = True
+            else:
+                try:
+                    logger.debug(
+                        f"Checking {connection_type} connection health using getMetadata()"
+                    )
+                    output_capture = io.StringIO()
+                    with contextlib.redirect_stdout(
+                        output_capture
+                    ), contextlib.redirect_stderr(output_capture):
+                        meshtastic_client.localNode.getMetadata()
 
-                console_output = output_capture.getvalue()
-                if "firmware_version" not in console_output:
-                    raise Exception("No firmware_version in getMetadata output.")
+                    console_output = output_capture.getvalue()
+                    if "firmware_version" not in console_output:
+                        raise Exception("No firmware_version in getMetadata output.")
 
-                logger.debug(f"{connection_type.capitalize()} connection healthy")
+                    logger.debug(f"{connection_type.capitalize()} connection healthy")
 
-            except Exception as e:
-                # Only trigger reconnection if we're not already reconnecting
-                if not reconnecting:
-                    logger.warning(
-                        f"{connection_type.capitalize()} connection health check failed: {e}"
-                    )
-                    on_lost_meshtastic_connection(meshtastic_client)
-                else:
-                    logger.debug("Skipping reconnection trigger - already reconnecting")
+                except Exception as e:
+                    # Only trigger reconnection if we're not already reconnecting
+                    if not reconnecting:
+                        logger.warning(
+                            f"{connection_type.capitalize()} connection health check failed: {e}"
+                        )
+                        # Use existing handler with health check reason
+                        on_lost_meshtastic_connection(detection_source=f"health check failed: {str(e)}")
+                    else:
+                        logger.debug("Skipping reconnection trigger - already reconnecting")
         elif reconnecting:
             logger.debug("Skipping connection check - reconnection in progress")
         elif not meshtastic_client:

mmrelay/tools/sample-docker-compose.yaml

@@ -3,6 +3,7 @@ services:
     build: .
     container_name: meshtastic-matrix-relay
     restart: unless-stopped
+    user: "${UID:-1000}:${GID:-1000}"
 
     environment:
       - TZ=UTC
@@ -28,5 +29,11 @@ services:
     #   - /dev/ttyUSB0:/dev/ttyUSB0
     #   - /dev/ttyACM0:/dev/ttyACM0
 
-    # For BLE connections, uncomment this:
+    # For BLE connections, uncomment these:
     # privileged: true
+    # network_mode: host
+    # Additional volumes for BLE (add to existing volumes section above):
+    #   - /var/run/dbus:/var/run/dbus:ro
+    #   - /sys/bus/usb:/sys/bus/usb:ro
+    #   - /sys/class/bluetooth:/sys/class/bluetooth:ro
+    #   - /sys/devices:/sys/devices:ro

{mmrelay-1.1.0.dist-info → mmrelay-1.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mmrelay
-Version: 1.1.0
+Version: 1.1.1
 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
@@ -56,6 +56,7 @@ A powerful and easy-to-use relay between Meshtastic devices and Matrix chat room
 - 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!!**
+- ✨️ _Native Docker 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._
 
@@ -98,7 +99,7 @@ make logs    # View logs
 
 Docker provides isolated environment, easy deployment, automatic restarts, and volume persistence.
 
-For detailed Docker setup instructions, see the [Docker Guide](DOCKER.md).
+For detailed Docker setup instructions, see the [Docker Guide](docs/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.
 

{mmrelay-1.1.0.dist-info → mmrelay-1.1.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-mmrelay/__init__.py,sha256=wo5bAmayppAqLHI02pEu7w2K2_YUxHWbnanigSNlXa8,594
+mmrelay/__init__.py,sha256=v-xcK3JoA0m2eBmIudme82RPgp5PQInzRSs5mitHB28,594
 mmrelay/cli.py,sha256=hdPTlcGsXTJC9GEUiScG7b3IFp02B3lwhqgwFpU3NsM,13835
 mmrelay/config.py,sha256=5VZag8iSc5yLQgvwI76bbpizbtqag74cHnfXCrWHNyA,7910
 mmrelay/config_checker.py,sha256=UnoHVTXzfdTfFkbmXv9r_Si76v-sxXLb5FOaQSOM45E,4909
@@ -6,7 +6,7 @@ mmrelay/db_utils.py,sha256=eTMMkYVWsmO_DkrBfnZMw4ohg_xa0S9TXJoBjRFTwzo,13590
 mmrelay/log_utils.py,sha256=ot0GpYppyNuPOWY8d3EXdLPojoJYEqfmUjVlcYm8neY,7532
 mmrelay/main.py,sha256=TL5xWFXIGwAQKau-hN4sRB0wxtNWzc629ry_qPbovv0,11585
 mmrelay/matrix_utils.py,sha256=XSOHztRrdIjFGyYt8QhGBL6nMv_6iodeYL288pG9voA,45813
-mmrelay/meshtastic_utils.py,sha256=WdRiqbmCtUJrd45VZdJvfbrXct6rD09rtusi9nHMzc4,29163
+mmrelay/meshtastic_utils.py,sha256=MgCNGSufQDddncVKJVgmp_6DDZbcHSvOvW72vuNDLeg,31596
 mmrelay/plugin_loader.py,sha256=NRiXF6Ty1WD9jNXXKvzJh7kE0ba5oICXNVAfMaTPqH4,39247
 mmrelay/setup_utils.py,sha256=N6qdScHKHEMFKDmT1l7dcLDPNTusZXPkyxrLXjFLhRI,19910
 mmrelay/plugins/__init__.py,sha256=KVMQIXRhe0wlGj4O3IZ0vOIQRKFkfPYejHXhJL17qrc,51
@@ -23,12 +23,12 @@ mmrelay/plugins/telemetry_plugin.py,sha256=8SxWv4BLXMUTbiVaD3MjlMMdQyS7S_1OfLlVN
 mmrelay/plugins/weather_plugin.py,sha256=1bQhmiX-enNphzGoFVprU0LcZQX9BvGxWAJAG8Wekg0,8596
 mmrelay/tools/__init__.py,sha256=WFjDQjdevgg19_zT6iEoL29rvb1JPqYSd8708Jn5D7A,838
 mmrelay/tools/mmrelay.service,sha256=3vqK1VbfXvVftkTrTEOan77aTHeOT36hIAL7HqJsmTg,567
-mmrelay/tools/sample-docker-compose.yaml,sha256=eXi-7TGb4fjC4g0Q-qs55pBZ4UWNKAstSO1ozOXlrUI,939
+mmrelay/tools/sample-docker-compose.yaml,sha256=vVgJrh-6l48hkj5F-52JA5tpDWPBjiPQ36CE9Pkqn44,1251
 mmrelay/tools/sample.env,sha256=RP-o3rX3jnEIrVG2rqCZq31O1yRXou4HcGrXWLVbKKw,311
 mmrelay/tools/sample_config.yaml,sha256=0BKND0qbke8z9X9J9iHleu567dZt3RmHUxhZlQEEdFk,3290
-mmrelay-1.1.0.dist-info/licenses/LICENSE,sha256=yceWauM1c0-FHxVplsD7W1-AbSeRaUNlmqT4UO1msBU,1073
-mmrelay-1.1.0.dist-info/METADATA,sha256=IstoM9NyCmerUqL9QOEygC2BfAoxrHJLfXWY-J7kEd0,6658
-mmrelay-1.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-mmrelay-1.1.0.dist-info/entry_points.txt,sha256=SJZwGUOEpQ-qx4H8UL4xKFnKeInGUaZNW1I0ddjK7Ws,45
-mmrelay-1.1.0.dist-info/top_level.txt,sha256=B_ZLCRm7NYAmI3PipRUyHGymP-C-q16LSeMGzmqJfo4,8
-mmrelay-1.1.0.dist-info/RECORD,,
+mmrelay-1.1.1.dist-info/licenses/LICENSE,sha256=yceWauM1c0-FHxVplsD7W1-AbSeRaUNlmqT4UO1msBU,1073
+mmrelay-1.1.1.dist-info/METADATA,sha256=ltSYRsnKQvdwsKd0CqAqMoSMWLsqZq8Pcpmfy_OjqI8,6713
+mmrelay-1.1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+mmrelay-1.1.1.dist-info/entry_points.txt,sha256=SJZwGUOEpQ-qx4H8UL4xKFnKeInGUaZNW1I0ddjK7Ws,45
+mmrelay-1.1.1.dist-info/top_level.txt,sha256=B_ZLCRm7NYAmI3PipRUyHGymP-C-q16LSeMGzmqJfo4,8
+mmrelay-1.1.1.dist-info/RECORD,,