python-mobius 0.10.2__py3-none-any.whl → 0.10.3__py3-none-any.whl

mobius/__init__.py

@@ -87,7 +87,7 @@ from .mob import (
     MAX_PUMP_PRIMITIVE_SIZE,
 )
 
-__version__ = "0.10.2"
+__version__ = "0.10.3"
 
 __all__ = [
     "__version__",

mobius/device.py

@@ -12,6 +12,7 @@ from __future__ import annotations
 import asyncio
 import datetime
 import struct
+import logging
 import time
 from dataclasses import dataclass, field
 from typing import Optional, Callable, Any
@@ -79,6 +80,8 @@ CHAR_TX_DATA = "01ff0103-ba5e-f4ee-5ca1-eb1e5e4b1ce0"   # write: app -> device,
 CHAR_TX_FINAL = "01ff0104-ba5e-f4ee-5ca1-eb1e5e4b1ce0"  # write: app -> device, last fragment
 
 # count=0xFFFF requests every element of a list attribute.
+_LOGGER = logging.getLogger(__name__)
+
 ALL_ELEMENTS = 0xFFFF
 
 # Write fragment size when the ATT MTU is unknown or the minimum (23).
@@ -87,6 +90,23 @@ DEFAULT_WRITE_SIZE = 20
 MTU_WRITE_OVERHEAD = 5
 
 
+def _log_bad_frame(raw: bytes, frame, trace: list[tuple[str, int]]) -> None:
+    """Debug details of a received frame that doesn't parse or fails its
+    CRC: what was received against what its header declares, and the
+    notifications it was assembled from (D = RX_DATA, F = RX_FINAL)."""
+    if not _LOGGER.isEnabledFor(logging.DEBUG):
+        return
+    declared = struct.unpack_from("<H", raw, 7)[0] + 11 if len(raw) >= 9 else None
+    pieces = " ".join(f"{kind}{length}" for kind, length in trace)
+    _LOGGER.debug(
+        "Received a frame that %s: %d bytes, header declares %s; op_group=%s op_code=%s msg_id=%s; "
+        "%d notifications [%s]; first bytes %s; last bytes %s",
+        "doesn't parse" if frame is None else "fails its CRC", len(raw), declared,
+        f"{frame.op_group:#04x}" if frame else "?", frame.op_code if frame else "?",
+        frame.message_id if frame else "?", len(trace), pieces, raw[:24].hex(), raw[-24:].hex(),
+    )
+
+
 def write_size_for_mtu(att_mtu: Optional[int]) -> int:
     """Write fragment size for a negotiated ATT MTU: `att_mtu` minus 5, as
     the app does, or DEFAULT_WRITE_SIZE when it is unknown or not above the
@@ -917,6 +937,9 @@ class MobiusDevice:
         self.adapter = adapter
         self._client: Optional[BleakClient] = None
         self._rx_buffer = bytearray()
+        # ("D"/"F", length) of each notification of the frame being
+        # received, logged when it fails its CRC.
+        self._rx_trace: list[tuple[str, int]] = []
         # Pending direct requests, keyed by FSCI message ID.
         self._pending: dict[int, asyncio.Future] = {}
         # Pending relayed requests, keyed by CoAP token (see mobius.relay).
@@ -1014,12 +1037,18 @@ class MobiusDevice:
 
     def _on_rx_data(self, _handle, data: bytearray):
         self._rx_buffer.extend(data)
+        self._rx_trace.append(("D", len(data)))
 
     def _on_rx_final(self, _handle, data: bytearray):
         self._rx_buffer.extend(data)
+        self._rx_trace.append(("F", len(data)))
         raw = bytes(self._rx_buffer)
+        trace = self._rx_trace
         self._rx_buffer.clear()
+        self._rx_trace = []
         frame = parse_frame(raw)
+        if frame is None or not frame.crc_ok:
+            _log_bad_frame(raw, frame, trace)
         if frame is None:
             return
         if self.on_any_frame is not None:

{python_mobius-0.10.2.dist-info → python_mobius-0.10.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: python-mobius
-Version: 0.10.2
+Version: 0.10.3
 Summary: Reverse-engineered Python client for the Mobius BLE protocol (EcoTech Marine VorTech/Radion, AquaIllumination, Neptune Systems, NYOS)
 Project-URL: Homepage, https://code.r3pek.org/r3pek/python-mobius
 Project-URL: Documentation, https://code.r3pek.org/r3pek/python-mobius/src/branch/main/documentation

{python_mobius-0.10.2.dist-info → python_mobius-0.10.3.dist-info}/RECORD

@@ -1,10 +1,10 @@
-mobius/__init__.py,sha256=ownwnGpQ6cybzgLY8bzjmBG4D7JOQ1bw_m9hMPMdvA8,8555
+mobius/__init__.py,sha256=vXZoC15RSsPkTLgOhdRb6T0zjIuL4KX_PByrCGlUzuY,8555
 mobius/checksums.py,sha256=PB9RqvaZu9AqfT6tU6NI2qbbZXrqaHUnow3Qi_6UFHs,5191
 mobius/cli.py,sha256=tyft0SzbuLgbmzps-Ym1hCzcr6A9D5MsALkg6o4ynBs,57876
 mobius/coap.py,sha256=-XV3kI4q-JoL8r0oLFNnHAdZAc_yUP-aICagKh-qbf4,4862
 mobius/constants.py,sha256=pcG9Su_b81pmMA_GxR41lZz9UM9BjtV0T6nuslMICko,41138
 mobius/crc.py,sha256=LOCHZe3a1UnR5thdpZ4S4SFP8BdmoMEnhDNiNMd0iJI,2508
-mobius/device.py,sha256=1awCx8TIzSFHHEnkGMbuItbpQtAt1DINdmSnLJqENWI,133014
+mobius/device.py,sha256=fIoN0YvF0VE85Ln0hHMqqGW7SxRDMbyEqLDH3jNH_xY,134445
 mobius/device_status.py,sha256=XclYijAknrgT8SdSW4XvyBemWHUQqw6UPE4tmwq6Yug,15658
 mobius/discovery.py,sha256=poNeXGekB44cpHOFbGyps9d4mwW_hJptmJODwSMTUSg,7176
 mobius/dump.py,sha256=eQBYoi8J6CxRd2ojgWK5QoB8z416oywLRTBnnh0pLwo,9253
@@ -19,8 +19,8 @@ mobius/relay.py,sha256=trGkWQSarwURF05gXHeb5jTJ9UvWbQGu8NarEP6sRqE,10107
 mobius/scenes.py,sha256=VLfDdTKSv3qTsBt2bJGg8iPtUkfNEmNgu0TTtYT6jJE,4274
 mobius/schedule.py,sha256=si9uJdYOj5vh6owuxxMyMyZRY0-tAmCPt3s6ROAeRww,13243
 mobius/timezone.py,sha256=Q7oPKtCdEYcEHXLx4lt-VPq6KH-MNgQwVnDtIXJV-kQ,2267
-python_mobius-0.10.2.dist-info/METADATA,sha256=O31L0MYu8ryhtqYYdQoXfTE9B23dqI4H2OJrWVH5EZI,5829
-python_mobius-0.10.2.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
-python_mobius-0.10.2.dist-info/entry_points.txt,sha256=Q2hlcek-bWm70zvd12v32essflPgC2su-dKDHAqbPoE,48
-python_mobius-0.10.2.dist-info/licenses/LICENSE,sha256=7a72Msu2Q-TnoiFxemxEGkwafJGObk1W3rw9hzmyM_Y,17984
-python_mobius-0.10.2.dist-info/RECORD,,
+python_mobius-0.10.3.dist-info/METADATA,sha256=XZMR0-mC2Ph-T0tOxBn_Gl3hPEXzmRcwjim4Nem0QMs,5829
+python_mobius-0.10.3.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+python_mobius-0.10.3.dist-info/entry_points.txt,sha256=Q2hlcek-bWm70zvd12v32essflPgC2su-dKDHAqbPoE,48
+python_mobius-0.10.3.dist-info/licenses/LICENSE,sha256=7a72Msu2Q-TnoiFxemxEGkwafJGObk1W3rw9hzmyM_Y,17984
+python_mobius-0.10.3.dist-info/RECORD,,