casambi-bt-revamped 0.3.12.dev9__py3-none-any.whl → 0.3.12.dev10__py3-none-any.whl

CasambiBt/_casambi.py

@@ -206,16 +206,33 @@ class Casambi:
 
         # Classic protocol uses signed command frames (u1.C1753e / u1.EnumC1754f).
         if self._casaClient is not None and self._casaClient.protocolMode == ProtocolMode.CLASSIC:
-            # EnumC1754f ordinals (ground truth: casambi-android u1.EnumC1754f):
-            # - AllUnitsLevel=4, UnitLevel=7, GroupLevel=26
-            if isinstance(target, Unit):
-                cmd = self._casaClient.buildClassicCommand(7, payload, target_id=target.deviceId)
-            elif isinstance(target, Group):
-                cmd = self._casaClient.buildClassicCommand(26, payload, target_id=target.groudId)
-            elif target is None:
-                cmd = self._casaClient.buildClassicCommand(4, payload)
+            # Check if we should use the alternative simple format from BLE captures
+            import os
+            use_simple = os.environ.get("CASAMBI_BT_CLASSIC_FORMAT", "").lower() == "simple"
+
+            if use_simple:
+                # Simple format: [counter][unit_id][param_len][dimmer]
+                # For "all units", use unit_id=0xFF
+                if isinstance(target, Unit):
+                    cmd = self._casaClient.buildClassicCommandSimple(target.deviceId, level)
+                elif isinstance(target, Group):
+                    # Groups in simple format: not fully confirmed, try group ID
+                    cmd = self._casaClient.buildClassicCommandSimple(target.groudId, level)
+                elif target is None:
+                    cmd = self._casaClient.buildClassicCommandSimple(0xFF, level)
+                else:
+                    raise TypeError(f"Unkown target type {type(target)}")
             else:
-                raise TypeError(f"Unkown target type {type(target)}")
+                # EnumC1754f ordinals (ground truth: casambi-android u1.EnumC1754f):
+                # - AllUnitsLevel=4, UnitLevel=7, GroupLevel=26
+                if isinstance(target, Unit):
+                    cmd = self._casaClient.buildClassicCommand(7, payload, target_id=target.deviceId)
+                elif isinstance(target, Group):
+                    cmd = self._casaClient.buildClassicCommand(26, payload, target_id=target.groudId)
+                elif target is None:
+                    cmd = self._casaClient.buildClassicCommand(4, payload)
+                else:
+                    raise TypeError(f"Unkown target type {type(target)}")
 
             await self._casaClient.send(cmd)
             return

CasambiBt/_classic_crypto.py

@@ -4,28 +4,143 @@ Ground truth:
 - casambi-android `t1.P.o(...)` calculates a CMAC over:
     connection_hash[0:8] + payload
   and stores the CMAC (prefix) into the packet header.
+
+The CMAC input structure from t1.P.o():
+    kVar.i(rVar.f16699L, 0, 8);  // connection_hash[0:8]
+    kVar.i(b(), this.f16551t + i9, (c() - i9) - this.f16551t);  // payload starting at seq offset
+
+For "conformant" classic (rVar.Z=true):
+    CMAC input = conn_hash[0:8] || seq(2 bytes BE) || command_bytes
+
+For "legacy" classic (rVar.Z=false):
+    CMAC input = conn_hash[0:8] || command_bytes
+
+Test vectors based on community BLE captures (GitHub lkempf/casambi-bt#17):
+
+Capture from sMauldaeschle:
+    Raw packet: 0215db43c40004040200b3
+    - Byte 0: 02 (auth level = visitor)
+    - Bytes 1-4: 15db43c4 (4-byte CMAC signature)
+    - Byte 5: 00 (padding/marker)
+    - Byte 6: 04 (counter/sequence)
+    - Byte 7: 04 (unit id)
+    - Byte 8: 02 (length of parameters)
+    - Byte 9: 00 (dimmer value)
+    - Byte 10: b3 (temperature/vertical value)
+
+Capture from FliegenKLATSCH:
+    Raw packet: 0200 43A2 9600 0203 0254 FF
+    - Bytes 0-1: 0200 (auth 02, then...)
+    - Bytes 2-5: 43A2 9600 (first 4 bytes of CMAC)
+    - The CMAC input was: <8 bytes connection hash> 00 0203 0254 FF
 """
 
 from __future__ import annotations
 
+import logging
+from typing import TYPE_CHECKING
+
 from cryptography.hazmat.primitives.cmac import CMAC
 from cryptography.hazmat.primitives.ciphers.algorithms import AES
 
+if TYPE_CHECKING:
+    pass
+
+_logger = logging.getLogger(__name__)
+
 
-def classic_cmac(key: bytes, conn_hash8: bytes, payload: bytes) -> bytes:
-    """Compute the Classic CMAC (16 bytes) over connection hash + payload."""
+def classic_cmac(key: bytes, conn_hash8: bytes, payload: bytes, *, debug: bool = False) -> bytes:
+    """Compute the Classic CMAC (16 bytes) over connection hash + payload.
+
+    Args:
+        key: 16-byte AES key (visitor or manager key from cloud)
+        conn_hash8: First 8 bytes of the connection hash read from CA51/auth char
+        payload: The data to sign (for conformant: seq + command; for legacy: command only)
+        debug: If True, log CMAC input/output for debugging
+
+    Returns:
+        16-byte CMAC
+    """
     if len(conn_hash8) != 8:
         raise ValueError("conn_hash8 must be 8 bytes")
+
+    cmac_input = conn_hash8 + payload
     cmac = CMAC(AES(key))
-    cmac.update(conn_hash8)
-    cmac.update(payload)
-    return cmac.finalize()
+    cmac.update(cmac_input)
+    result = cmac.finalize()
+
+    if debug:
+        _logger.warning(
+            "[CLASSIC_CMAC_DEBUG] key_len=%d conn_hash8=%s payload_len=%d payload_prefix=%s cmac=%s",
+            len(key),
+            conn_hash8.hex(),
+            len(payload),
+            payload[:16].hex() if len(payload) > 16 else payload.hex(),
+            result.hex(),
+        )
+
+    return result
 
 
 def classic_cmac_prefix(
-    key: bytes, conn_hash8: bytes, payload: bytes, prefix_len: int
+    key: bytes, conn_hash8: bytes, payload: bytes, prefix_len: int, *, debug: bool = False
 ) -> bytes:
-    """Return the prefix bytes that are embedded into the Classic packet header."""
-    mac = classic_cmac(key, conn_hash8, payload)
+    """Return the prefix bytes that are embedded into the Classic packet header.
+
+    Args:
+        key: 16-byte AES key
+        conn_hash8: First 8 bytes of connection hash
+        payload: Data to sign
+        prefix_len: Number of CMAC bytes to use (4 for visitor, 16 for manager)
+        debug: If True, log CMAC computation
+
+    Returns:
+        First prefix_len bytes of the CMAC
+    """
+    mac = classic_cmac(key, conn_hash8, payload, debug=debug)
     return mac[:prefix_len]
 
+
+def verify_classic_cmac(
+    key: bytes, conn_hash8: bytes, payload: bytes, expected_prefix: bytes
+) -> bool:
+    """Verify a Classic CMAC signature prefix.
+
+    Args:
+        key: 16-byte AES key
+        conn_hash8: First 8 bytes of connection hash
+        payload: Data that was signed
+        expected_prefix: The CMAC prefix from the packet header
+
+    Returns:
+        True if the computed CMAC prefix matches expected_prefix
+    """
+    computed = classic_cmac_prefix(key, conn_hash8, payload, len(expected_prefix))
+    return computed == expected_prefix
+
+
+# Test vectors from RFC 4493 (AES-CMAC) - used in test_classic_protocol.py
+# These confirm our CMAC implementation is correct.
+RFC4493_TEST_KEY = bytes.fromhex("2b7e151628aed2a6abf7158809cf4f3c")
+RFC4493_VECTORS = [
+    # (message, expected_cmac)
+    (bytes.fromhex("6bc1bee22e409f96e93d7e117393172a"),
+     bytes.fromhex("070a16b46b4d4144f79bdd9dd04a287c")),
+    (bytes.fromhex("6bc1bee22e409f96e93d7e117393172aae2d8a571e03ac9c9eb76fac45af8e51"),
+     bytes.fromhex("ce0cbf1738f4df6428b1d93bf12081c9")),
+]
+
+# Placeholder for real Casambi test vectors once we have them from captures
+# Format: (visitor_key, conn_hash8, payload_after_header, expected_cmac_prefix_4, description)
+CASAMBI_CLASSIC_TEST_VECTORS: list[tuple[bytes, bytes, bytes, bytes, str]] = [
+    # These will be populated from real BLE captures
+    # Example structure (not verified yet):
+    # (
+    #     bytes.fromhex("...16 byte key..."),
+    #     bytes.fromhex("...8 byte conn hash..."),
+    #     bytes.fromhex("...payload after auth byte..."),
+    #     bytes.fromhex("...4 byte expected cmac..."),
+    #     "Description of what this packet does"
+    # ),
+]
+

CasambiBt/_client.py

@@ -163,6 +163,11 @@ class CasambiClient:
         self._classicRxKindSamples: dict[str, int] = {}
         self._classicRxLastStatsTs = time.monotonic()
 
+        # Classic diagnostic packet history (for dump_classic_diagnostics service)
+        self._classicTxHistory: list[dict[str, Any]] = []
+        self._classicRxHistory: list[dict[str, Any]] = []
+        self._classicDiagMaxHistory = 50  # Keep last 50 TX and RX packets
+
     @property
     def protocolMode(self) -> ProtocolMode | None:
         return self._protocolMode
@@ -1004,6 +1009,39 @@ class CasambiClient:
 
         return bytes(b)
 
+    def buildClassicCommandSimple(
+        self,
+        unit_id: int,
+        dimmer: int,
+        extra: int | None = None,
+    ) -> bytes:
+        """Build a Classic command using the simple format from BLE captures.
+
+        This alternative format was observed in real BLE captures and differs from
+        the Android u1.C1753e command record format. Use with env variable
+        CASAMBI_BT_CLASSIC_FORMAT=simple to experiment.
+
+        Format (before header added by _sendClassic):
+        [counter:1][unit_id:1][param_len:1][dimmer:1][extra:1?]
+
+        The header (added by _sendClassic) is:
+        - Conformant: [auth:1][cmac:4|16][seq:2]
+        - Legacy: [cmac:4]
+
+        Args:
+            unit_id: Target unit ID (0-255, use 0xFF for "all units")
+            dimmer: Dimmer/level value (0-255)
+            extra: Optional extra parameter (e.g., temperature/vertical value)
+
+        Returns:
+            Command bytes to pass to _sendClassic
+        """
+        counter = self._classic_next_div()
+        if extra is not None:
+            return bytes([counter, unit_id & 0xFF, 2, dimmer & 0xFF, extra & 0xFF])
+        else:
+            return bytes([counter, unit_id & 0xFF, 1, dimmer & 0xFF])
+
     async def _sendClassic(self, command_bytes: bytes) -> None:
         self._checkState(ConnectionState.AUTHENTICATED)
         if self._protocolMode != ProtocolMode.CLASSIC:
@@ -1143,7 +1181,46 @@ class CasambiClient:
 
         # Classic packets can exceed 20 bytes when using a 16-byte manager signature.
         # Bleak needs a write-with-response for long writes on most backends.
-        await self._gattClient.write_gatt_char(tx_uuid, bytes(pkt), response=True)
+        tx_result = "pending"
+        try:
+            await self._gattClient.write_gatt_char(tx_uuid, bytes(pkt), response=True)
+            tx_result = "ok"
+        except Exception as e:
+            tx_result = f"error: {type(e).__name__}: {e}"
+            raise
+        finally:
+            # Record TX in diagnostic history
+            tx_entry = {
+                "timestamp": time.monotonic(),
+                "header_mode": header_mode,
+                "key": key_name,
+                "signed": signed,
+                "tx_uuid": tx_uuid,
+                "auth_level": auth_level if header_mode == "conformant" else None,
+                "sig_len": sig_len,
+                "seq": seq,
+                "cmd_ordinal": cmd_ordinal,
+                "cmd_target": cmd_target,
+                "cmd_div": cmd_div,
+                "cmd_lifetime": cmd_lifetime,
+                "cmd_payload_len": cmd_payload_len,
+                "total_len": len(pkt),
+                "pre_sign_hex": b2a(command_bytes).decode("ascii"),
+                "post_sign_hex": b2a(bytes(pkt)).decode("ascii"),
+                "result": tx_result,
+            }
+            self._classicTxHistory.append(tx_entry)
+            if len(self._classicTxHistory) > self._classicDiagMaxHistory:
+                self._classicTxHistory = self._classicTxHistory[-self._classicDiagMaxHistory:]
+
+            # Enhanced TX diagnostic log
+            self._logger.warning(
+                "[CLASSIC_DIAG_TX_RESULT] result=%s header=%s seq=%s total_len=%d",
+                tx_result,
+                header_mode,
+                None if seq is None else f"0x{seq:04x}",
+                len(pkt),
+            )
 
     def _establishedNofityCallback(
         self, handle: BleakGATTCharacteristic, data: bytes
@@ -1231,10 +1308,26 @@ class CasambiClient:
         """
         self._inPacketCount += 1
         self._classicRxFrames += 1
+        rx_ts = time.monotonic()
         if self._classicFirstRxTs is None:
-            self._classicFirstRxTs = time.monotonic()
+            self._classicFirstRxTs = rx_ts
 
         raw = bytes(data)
+
+        # Enhanced RX diagnostic logging
+        try:
+            handle_uuid = str(getattr(handle, "uuid", "unknown")).lower()
+        except Exception:
+            handle_uuid = "unknown"
+
+        self._logger.warning(
+            "[CLASSIC_DIAG_RX] #%d handle=%s len=%d hex=%s",
+            self._classicRxFrames,
+            handle_uuid,
+            len(raw),
+            b2a(raw[: min(len(raw), 48)]).decode("ascii") + ("..." if len(raw) > 48 else ""),
+        )
+
         if self._logger.isEnabledFor(logging.DEBUG):
             self._logger.debug(
                 "[CASAMBI_CLASSIC_RX_RAW] len=%d hex=%s",
@@ -1424,6 +1517,36 @@ class CasambiClient:
         elif verified is None:
             self._classicRxUnverifiable += 1
 
+        # Record RX in diagnostic history
+        rx_entry = {
+            "timestamp": rx_ts,
+            "handle_uuid": handle_uuid,
+            "header_mode": best["mode"],
+            "verified": verified,
+            "auth_level": best["auth_level"],
+            "sig_len": best["sig_len"],
+            "seq": best["seq"],
+            "payload_len": len(payload),
+            "raw_hex": b2a(raw).decode("ascii"),
+            "payload_hex": b2a(payload).decode("ascii"),
+            "score": best["score"],
+        }
+        self._classicRxHistory.append(rx_entry)
+        if len(self._classicRxHistory) > self._classicDiagMaxHistory:
+            self._classicRxHistory = self._classicRxHistory[-self._classicDiagMaxHistory:]
+
+        # Enhanced RX parse result log
+        self._logger.warning(
+            "[CLASSIC_DIAG_RX_PARSE] mode=%s verified=%s auth=%s sig_len=%d seq=%s score=%d payload_len=%d",
+            best["mode"],
+            verified,
+            None if best["auth_level"] is None else f"0x{best['auth_level']:02x}",
+            best["sig_len"],
+            None if best["seq"] is None else f"0x{best['seq']:04x}",
+            best["score"],
+            len(payload),
+        )
+
         # Auto-correct header mode if the other format parses much better.
         if best["mode"] != preferred:
             # Only switch if we got a stronger signal (verified or plausible payload with fewer assumptions).
@@ -1865,3 +1988,39 @@ class CasambiClient:
 
         self._connectionState = ConnectionState.NONE
         self._logger.info("Disconnected.")
+
+    def getClassicDiagnostics(self) -> dict[str, Any]:
+        """Return Classic protocol diagnostic state for external services.
+
+        This method provides a snapshot of Classic protocol state including:
+        - Connection parameters (hash, mode, UUIDs)
+        - RX/TX statistics
+        - Last N TX and RX packets
+        - Any detected errors or anomalies
+
+        Safe to call from HA services for dump_classic_diagnostics.
+        """
+        return {
+            "protocol_mode": self._protocolMode.name if self._protocolMode else None,
+            "classic_header_mode": self._classicHeaderMode,
+            "classic_hash_source": self._classicHashSource,
+            "classic_conn_hash8_hex": b2a(self._classicConnHash8).decode("ascii") if self._classicConnHash8 else None,
+            "classic_tx_uuid": self._classicTxCharUuid,
+            "classic_notify_uuids": sorted(self._classicNotifyCharUuids) if self._classicNotifyCharUuids else [],
+            "classic_first_rx_ts": self._classicFirstRxTs,
+            "classic_rx_stats": {
+                "frames": self._classicRxFrames,
+                "verified": self._classicRxVerified,
+                "unverifiable": self._classicRxUnverifiable,
+                "parse_fail": self._classicRxParseFail,
+                "type6_unitstate": self._classicRxType6,
+                "type7_switch": self._classicRxType7,
+                "type9_netconf": self._classicRxType9,
+                "cmdstream": self._classicRxCmdStream,
+                "unknown": self._classicRxUnknown,
+            },
+            "classic_tx_count": len(self._classicTxHistory),
+            "classic_rx_count": len(self._classicRxHistory),
+            "classic_tx_history": self._classicTxHistory[-20:],  # Last 20
+            "classic_rx_history": self._classicRxHistory[-20:],  # Last 20
+        }

CasambiBt/_version.py

@@ -7,4 +7,4 @@ Avoid using importlib.metadata in hot paths by providing a static version string
 __all__ = ["__version__"]
 
 # NOTE: Must match `casambi-bt/setup.cfg` [metadata] version.
-__version__ = "0.3.12.dev9"
+__version__ = "0.3.12.dev10"

{casambi_bt_revamped-0.3.12.dev9.dist-info → casambi_bt_revamped-0.3.12.dev10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: casambi-bt-revamped
-Version: 0.3.12.dev9
+Version: 0.3.12.dev10
 Summary: Forked Casambi Bluetooth client library with switch event support, use original if no special need. https://github.com/lkempf/casambi-bt
 Home-page: https://github.com/rankjie/casambi-bt
 Author: rankjie

{casambi_bt_revamped-0.3.12.dev9.dist-info → casambi_bt_revamped-0.3.12.dev10.dist-info}/RECORD

@@ -1,8 +1,8 @@
 CasambiBt/__init__.py,sha256=iJdTF4oeXfj5d5gfGxQkacqUjtnQo0IW-zFPJvFjWWk,336
 CasambiBt/_cache.py,sha256=3bQil8vhSy4f4sf9JusMfEdQC7d3cJuva9qHhyKro-0,3808
-CasambiBt/_casambi.py,sha256=TN4ecgjm95nSJ4h9TsKayNn577Y82fdsGK4IGUZF23Q,40666
-CasambiBt/_classic_crypto.py,sha256=6DcCOdjLQo7k2cOOutNdUKupykOG_E2TDDwg6fH-ODM,998
-CasambiBt/_client.py,sha256=yn6DckDCKap1YJ0xyDhk5wlvE6wvPIUGPe9M1veRDVs,77317
+CasambiBt/_casambi.py,sha256=9pWTxR1ZBARK-IB91PSRAQrcRoswU40jI-9AfLPpvW0,41649
+CasambiBt/_classic_crypto.py,sha256=XIp3JBaeY8hIUv5kB0ygVG_eRx9AgHHF4ts2--CFm78,4973
+CasambiBt/_client.py,sha256=EuaCwb3t6D0sbQR6XA84UWDEtkc3n7WBRozsM2kFu-Y,83927
 CasambiBt/_constants.py,sha256=86heoDdb5iPaRrPmK2DIIl-4uSxbFFcnCo9zlCvTLww,1290
 CasambiBt/_discover.py,sha256=jLc6H69JddrCURgtANZEjws6_UbSzXJtvJkbKTaIUHY,1849
 CasambiBt/_encryption.py,sha256=CLcoOOrggQqhJbnr_emBnEnkizpWDvb_0yFnitq4_FM,3831
@@ -12,11 +12,11 @@ CasambiBt/_network.py,sha256=ai1o3EybsAhjyPohSOxeE0cWoFvEqdcc3PE3uFDaTfE,21346
 CasambiBt/_operation.py,sha256=Q5UccsrtNp_B_wWqwH_3eLFW_yF6A55FMmfUKDk2WrI,1059
 CasambiBt/_switch_events.py,sha256=S8OD0dBcw5T4J2C7qfmOQMnTJ7omIXRUYv4PqDOB87E,13137
 CasambiBt/_unit.py,sha256=nxbg_8UCCVB9WI8dUS21g2JrGyPKcefqKMSusMOhLOo,18721
-CasambiBt/_version.py,sha256=VtWwYBijhWhHtBHLmr-n1eqgiJjNkNATaUweLPXTAo4,337
+CasambiBt/_version.py,sha256=KfDHVZ0HvUoCJCQD90I4l0PCSgOKne4pUVo8Y_Hv5Xk,338
 CasambiBt/errors.py,sha256=1L_Q8og_N_BRYEKizghAQXr6tihlHykFgtcCHUDcBas,1961
 CasambiBt/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-casambi_bt_revamped-0.3.12.dev9.dist-info/licenses/LICENSE,sha256=TAIIitFxpxEDi6Iju7foW4TDQmWvC-IhLVLhl67jKmQ,11341
-casambi_bt_revamped-0.3.12.dev9.dist-info/METADATA,sha256=R31XEvi4eCtF_CYH_DfCnN9lvMmhDS8zCYJlqFAuu2U,5877
-casambi_bt_revamped-0.3.12.dev9.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-casambi_bt_revamped-0.3.12.dev9.dist-info/top_level.txt,sha256=uNbqLjtecFosoFzpGAC89-5icikWODKI8rOjbi8v_sA,10
-casambi_bt_revamped-0.3.12.dev9.dist-info/RECORD,,
+casambi_bt_revamped-0.3.12.dev10.dist-info/licenses/LICENSE,sha256=TAIIitFxpxEDi6Iju7foW4TDQmWvC-IhLVLhl67jKmQ,11341
+casambi_bt_revamped-0.3.12.dev10.dist-info/METADATA,sha256=VYoGQSXLxJqbL3RSHlXZbuwsMydhxXPvfIPYQnGfhac,5878
+casambi_bt_revamped-0.3.12.dev10.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+casambi_bt_revamped-0.3.12.dev10.dist-info/top_level.txt,sha256=uNbqLjtecFosoFzpGAC89-5icikWODKI8rOjbi8v_sA,10
+casambi_bt_revamped-0.3.12.dev10.dist-info/RECORD,,