pypck 0.8.3__tar.gz → 0.8.4__tar.gz

{pypck-0.8.3/pypck.egg-info → pypck-0.8.4}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: pypck
-Version: 0.8.3
+Version: 0.8.4
 Summary: LCN-PCK library
 Home-page: https://github.com/alengwenus/pypck
 Author-email: Andre Lengwenus <alengwenus@gmail.com>

pypck-0.8.4/VERSION

@@ -0,0 +1 @@
+0.8.4

{pypck-0.8.3 → pypck-0.8.4}/pypck/connection.py

@@ -164,12 +164,22 @@ class PchkConnectionManager:
                     break
 
                 try:
-                    message = data.decode().split(PckGenerator.TERMINATION)[0]
+                    message = data.decode("utf-8").split(PckGenerator.TERMINATION)[0]
                 except UnicodeDecodeError as err:
-                    _LOGGER.warning(
-                        "PCK decoding error: %s - skipping received PCK message", err
-                    )
-                    continue
+                    try:
+                        message = data.decode("cp1250").split(PckGenerator.TERMINATION)[
+                            0
+                        ]
+                        _LOGGER.warning(
+                            "Incorrect PCK encoding detected, possibly caused by LinHK: %s - PCK recovered using cp1250",
+                            err,
+                        )
+                    except UnicodeDecodeError as err2:
+                        _LOGGER.warning(
+                            "PCK decoding error: %s - skipping received PCK message",
+                            err2,
+                        )
+                        continue
                 await self.process_message(message)
         except asyncio.CancelledError:
             pass

{pypck-0.8.3 → pypck-0.8.4}/pypck/inputs.py

@@ -392,7 +392,17 @@ class ModSn(ModInput):
         if matcher:
             addr = LcnAddr(int(matcher.group("seg_id")), int(matcher.group("mod_id")))
             hardware_serial = int(matcher.group("hardware_serial"), 16)
-            manu = int(matcher.group("manu"), 16)
+            try:
+                manu = int(matcher.group("manu"), 16)
+            except (
+                ValueError
+            ):  # unconventional manufacturer code (e.g., due to LinHK VM)
+                manu = 0xFF
+                _LOGGER.debug(
+                    "Unconventional manufacturer code: %s. Defaulting to 0x%02X",
+                    matcher.group("manu"),
+                    manu,
+                )
             software_serial = int(matcher.group("software_serial"), 16)
             try:
                 hardware_type = lcn_defs.HardwareType(

{pypck-0.8.3 → pypck-0.8.4}/pypck/pck_commands.py

@@ -60,7 +60,7 @@ class PckParser:
     # Pattern to parse serial number and firmware date responses.
     PATTERN_SN = re.compile(
         r"=M(?P<seg_id>\d{3})(?P<mod_id>\d{3})\.SN(?P<hardware_serial>[0-9|A-F]{10})"
-        r"(?P<manu>[0-9|A-F]{2})FW(?P<software_serial>[0-9|A-F]{6})"
+        r"(?P<manu>.{2})FW(?P<software_serial>[0-9|A-F]{6})"
         r"HW(?P<hardware_type>\d+)"
     )
 

{pypck-0.8.3 → pypck-0.8.4/pypck.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: pypck
-Version: 0.8.3
+Version: 0.8.4
 Summary: LCN-PCK library
 Home-page: https://github.com/alengwenus/pypck
 Author-email: Andre Lengwenus <alengwenus@gmail.com>

pypck-0.8.4/tests/test_messages.py

@@ -0,0 +1,329 @@
+"""Tests for input message parsing for bus messages."""
+
+import pytest
+
+from pypck.inputs import (
+    InputParser,
+    ModAck,
+    ModNameComment,
+    ModSendCommandHost,
+    ModSendKeysHost,
+    ModSk,
+    ModSn,
+    ModStatusAccessControl,
+    ModStatusBinSensors,
+    ModStatusGroups,
+    ModStatusKeyLocks,
+    ModStatusLedsAndLogicOps,
+    ModStatusOutput,
+    ModStatusOutputNative,
+    ModStatusRelays,
+    ModStatusSceneOutputs,
+    ModStatusVar,
+)
+from pypck.lcn_addr import LcnAddr
+from pypck.lcn_defs import (
+    AccessControlPeriphery,
+    BatteryStatus,
+    HardwareType,
+    KeyAction,
+    LedStatus,
+    LogicOpStatus,
+    OutputPort,
+    SendKeyCommand,
+    Var,
+    VarValue,
+)
+
+MESSAGES = {
+    # Ack
+    "-M000010!": [(ModAck, -1)],
+    "-M000010005": [(ModAck, 5)],
+    # SK
+    "=M000010.SK007": [(ModSk, 7)],
+    # SN
+    "=M000010.SN1AB20A123401FW190B11HW015": [
+        (
+            ModSn,
+            0x1AB20A1234,
+            0x1,
+            0x190B11,
+            HardwareType.SH_PLUS,
+        )
+    ],
+    "=M000010.SN1234567890AFFW190011HW011": [
+        (
+            ModSn,
+            0x1234567890,
+            0xAF,
+            0x190011,
+            HardwareType.UPP,
+        )
+    ],
+    "=M000010.SN1234567890vMFW190011HW011": [
+        (
+            ModSn,
+            0x1234567890,
+            0xFF,
+            0x190011,
+            HardwareType.UPP,
+        )
+    ],
+    # Name
+    "=M000010.N1EG HWR Hau": [(ModNameComment, "N", 0, "EG HWR Hau")],
+    "=M000010.N2EG HWR Hau": [(ModNameComment, "N", 1, "EG HWR Hau")],
+    # Comment
+    "=M000010.K1EG HWR Hau": [(ModNameComment, "K", 0, "EG HWR Hau")],
+    "=M000010.K2EG HWR Hau": [(ModNameComment, "K", 1, "EG HWR Hau")],
+    "=M000010.K3EG HWR Hau": [(ModNameComment, "K", 2, "EG HWR Hau")],
+    # Oem
+    "=M000010.O1EG HWR Hau": [(ModNameComment, "O", 0, "EG HWR Hau")],
+    "=M000010.O2EG HWR Hau": [(ModNameComment, "O", 1, "EG HWR Hau")],
+    "=M000010.O3EG HWR Hau": [(ModNameComment, "O", 2, "EG HWR Hau")],
+    "=M000010.O4EG HWR Hau": [(ModNameComment, "O", 3, "EG HWR Hau")],
+    # Groups
+    "=M000010.GP012005040": [
+        (
+            ModStatusGroups,
+            False,
+            12,
+            [LcnAddr(0, 5, True), LcnAddr(0, 40, True)],
+        )
+    ],
+    "=M000010.GD008005040": [
+        (
+            ModStatusGroups,
+            True,
+            8,
+            [LcnAddr(0, 5, True), LcnAddr(0, 40, True)],
+        )
+    ],
+    "=M000010.GD010005040030020010100200150099201": [
+        (
+            ModStatusGroups,
+            True,
+            10,
+            [
+                LcnAddr(0, 5, True),
+                LcnAddr(0, 40, True),
+                LcnAddr(0, 30, True),
+                LcnAddr(0, 20, True),
+                LcnAddr(0, 10, True),
+                LcnAddr(0, 100, True),
+                LcnAddr(0, 200, True),
+                LcnAddr(0, 150, True),
+                LcnAddr(0, 99, True),
+                LcnAddr(0, 201, True),
+            ],
+        )
+    ],
+    # Status Output
+    ":M000010A1050": [(ModStatusOutput, OutputPort.OUTPUT1.value, 50.0)],
+    # Status Output Native
+    ":M000010O1050": [(ModStatusOutputNative, OutputPort.OUTPUT1.value, 50)],
+    # Status Relays
+    ":M000010Rx204": [
+        (
+            ModStatusRelays,
+            [False, False, True, True, False, False, True, True],
+        )
+    ],
+    # Status BinSensors
+    ":M000010Bx204": [
+        (
+            ModStatusBinSensors,
+            [False, False, True, True, False, False, True, True],
+        )
+    ],
+    # Status Var
+    "%M000010.A00301200": [(ModStatusVar, Var.VAR3, VarValue(1200))],
+    "%M000010.01200": [(ModStatusVar, Var.UNKNOWN, VarValue(1200))],
+    "%M000010.S101200": [(ModStatusVar, Var.R1VARSETPOINT, VarValue(1200))],
+    "%M000010.T1100050": [(ModStatusVar, Var.THRS1, VarValue(50))],
+    "%M000010.T3400050": [(ModStatusVar, Var.THRS3_4, VarValue(50))],
+    "=M000010.S1111112222233333444445555512345": [
+        (ModStatusVar, Var.THRS1, VarValue(11111)),
+        (ModStatusVar, Var.THRS2, VarValue(22222)),
+        (ModStatusVar, Var.THRS3, VarValue(33333)),
+        (ModStatusVar, Var.THRS4, VarValue(44444)),
+        (ModStatusVar, Var.THRS5, VarValue(55555)),
+    ],
+    # Status Leds and LogicOps
+    "=M000010.TLAEBFAAAAAAAANTVN": [
+        (
+            ModStatusLedsAndLogicOps,
+            [
+                LedStatus.OFF,
+                LedStatus.ON,
+                LedStatus.BLINK,
+                LedStatus.FLICKER,
+                LedStatus.OFF,
+                LedStatus.OFF,
+                LedStatus.OFF,
+                LedStatus.OFF,
+                LedStatus.OFF,
+                LedStatus.OFF,
+                LedStatus.OFF,
+                LedStatus.OFF,
+            ],
+            [
+                LogicOpStatus.NONE,
+                LogicOpStatus.SOME,
+                LogicOpStatus.ALL,
+                LogicOpStatus.NONE,
+            ],
+        )
+    ],
+    # Status Key Locks
+    "=M000010.TX255000063204": [
+        (
+            ModStatusKeyLocks,
+            [
+                [True, True, True, True, True, True, True, True],
+                [False, False, False, False, False, False, False, False],
+                [True, True, True, True, True, True, False, False],
+                [False, False, True, True, False, False, True, True],
+            ],
+        )
+    ],
+    # Status Access Control
+    "=M000010.ZI026043060013002": [
+        (
+            ModStatusAccessControl,
+            AccessControlPeriphery.TRANSMITTER,
+            "1a2b3c",
+            1,
+            2,
+            KeyAction.MAKE,
+            BatteryStatus.FULL,
+        )
+    ],
+    "=M000010.ZI026043060013011": [
+        (
+            ModStatusAccessControl,
+            AccessControlPeriphery.TRANSMITTER,
+            "1a2b3c",
+            1,
+            2,
+            KeyAction.HIT,
+            BatteryStatus.WEAK,
+        )
+    ],
+    "=M000010.ZT026043060": [
+        (
+            ModStatusAccessControl,
+            AccessControlPeriphery.TRANSPONDER,
+            "1a2b3c",
+        )
+    ],
+    "=M000010.ZF026043060": [
+        (
+            ModStatusAccessControl,
+            AccessControlPeriphery.FINGERPRINT,
+            "1a2b3c",
+        )
+    ],
+    "=M000010.ZC026043060": [
+        (
+            ModStatusAccessControl,
+            AccessControlPeriphery.CODELOCK,
+            "1a2b3c",
+        )
+    ],
+    # Status scene outputs
+    "=M000010.SZ003025150075100140000033200": [
+        (
+            ModStatusSceneOutputs,
+            3,
+            [25, 75, 140, 33],
+            [150, 100, 0, 200],
+        )
+    ],
+    # SKH
+    "+M004000010.SKH000001": [(ModSendCommandHost, (0, 1))],
+    "+M004000010.SKH000001002003004005": [
+        (
+            ModSendCommandHost,
+            tuple(i for i in range(6)),
+        )
+    ],
+    "+M004000010.SKH000001002003004005006007008009010011012013": [
+        (
+            ModSendCommandHost,
+            tuple(i for i in range(14)),
+        )
+    ],
+    # SKH with partially invalid data
+    "+M004000010.SKH000001002": [(ModSendCommandHost, (0, 1))],
+    "+M004000010.SKH000001002003": [(ModSendCommandHost, (0, 1))],
+    "+M004000010.SKH000001002003004005006": [
+        (
+            ModSendCommandHost,
+            tuple(i for i in range(6)),
+        )
+    ],
+    # SKH (new header)
+    "$M000010.SKH000001": [(ModSendCommandHost, (0, 1))],
+    "$M000010.SKH000001002003004005": [
+        (
+            ModSendCommandHost,
+            tuple(i for i in range(6)),
+        )
+    ],
+    "$M000010.SKH000001002003004005006007008009010011012013": [
+        (
+            ModSendCommandHost,
+            tuple(i for i in range(14)),
+        )
+    ],
+    # SKH (new header) with partially invalid data
+    "$M000010.SKH000001002": [(ModSendCommandHost, (0, 1))],
+    "$M000010.SKH000001002003": [(ModSendCommandHost, (0, 1))],
+    "$M000010.SKH000001002003004005006": [
+        (
+            ModSendCommandHost,
+            tuple(i for i in range(6)),
+        )
+    ],
+    # STH
+    "+M004000010.STH000000": [
+        (
+            ModSendKeysHost,
+            [SendKeyCommand.DONTSEND] * 3,
+            [False] * 8,
+        )
+    ],
+    "+M004000010.STH057078": [
+        (
+            ModSendKeysHost,
+            [SendKeyCommand.HIT, SendKeyCommand.MAKE, SendKeyCommand.BREAK],
+            [False, True, True, True, False, False, True, False],
+        )
+    ],
+    # STH
+    "$M000010.STH000000": [
+        (
+            ModSendKeysHost,
+            [SendKeyCommand.DONTSEND] * 3,
+            [False] * 8,
+        )
+    ],
+    "$M000010.STH057078": [
+        (
+            ModSendKeysHost,
+            [SendKeyCommand.HIT, SendKeyCommand.MAKE, SendKeyCommand.BREAK],
+            [False, True, True, True, False, False, True, False],
+        )
+    ],
+}
+
+
+@pytest.mark.parametrize("message, expected", MESSAGES.items())
+def test_message_parsing_mod_inputs(message, expected):
+    """Test if InputMod parses message correctly."""
+    inputs = InputParser.parse(message)
+    assert len(inputs) == len(expected)
+    for idx, inp in enumerate(inputs):
+        exp = (expected[idx][0])(LcnAddr(0, 10, False), *expected[idx][1:])
+        assert type(inp) is type(exp)  # pylint: disable=unidiomatic-typecheck
+        assert vars(inp) == vars(exp)

pypck-0.8.3/VERSION

@@ -1 +0,0 @@
-0.8.3

pypck-0.8.3/tests/test_messages.py

@@ -1,257 +0,0 @@
-"""Tests for input message parsing for bus messages."""
-
-import pytest
-
-from pypck.inputs import (
-    InputParser,
-    ModAck,
-    ModNameComment,
-    ModSendCommandHost,
-    ModSendKeysHost,
-    ModSk,
-    ModSn,
-    ModStatusAccessControl,
-    ModStatusBinSensors,
-    ModStatusGroups,
-    ModStatusKeyLocks,
-    ModStatusLedsAndLogicOps,
-    ModStatusOutput,
-    ModStatusOutputNative,
-    ModStatusRelays,
-    ModStatusSceneOutputs,
-    ModStatusVar,
-)
-from pypck.lcn_addr import LcnAddr
-from pypck.lcn_defs import (
-    AccessControlPeriphery,
-    BatteryStatus,
-    HardwareType,
-    KeyAction,
-    LedStatus,
-    LogicOpStatus,
-    OutputPort,
-    SendKeyCommand,
-    Var,
-    VarValue,
-)
-
-MESSAGES = {
-    # Ack
-    "-M000010!": (ModAck, -1),
-    "-M000010005": (ModAck, 5),
-    # SK
-    "=M000010.SK007": (ModSk, 7),
-    # SN
-    "=M000010.SN1AB20A123401FW190B11HW015": (
-        ModSn,
-        0x1AB20A1234,
-        0x1,
-        0x190B11,
-        HardwareType.SH_PLUS,
-    ),
-    "=M000010.SN1234567890AFFW190011HW011": (
-        ModSn,
-        0x1234567890,
-        0xAF,
-        0x190011,
-        HardwareType.UPP,
-    ),
-    # Name
-    "=M000010.N1EG HWR Hau": (ModNameComment, "N", 0, "EG HWR Hau"),
-    "=M000010.N2EG HWR Hau": (ModNameComment, "N", 1, "EG HWR Hau"),
-    # Comment
-    "=M000010.K1EG HWR Hau": (ModNameComment, "K", 0, "EG HWR Hau"),
-    "=M000010.K2EG HWR Hau": (ModNameComment, "K", 1, "EG HWR Hau"),
-    "=M000010.K3EG HWR Hau": (ModNameComment, "K", 2, "EG HWR Hau"),
-    # Oem
-    "=M000010.O1EG HWR Hau": (ModNameComment, "O", 0, "EG HWR Hau"),
-    "=M000010.O2EG HWR Hau": (ModNameComment, "O", 1, "EG HWR Hau"),
-    "=M000010.O3EG HWR Hau": (ModNameComment, "O", 2, "EG HWR Hau"),
-    "=M000010.O4EG HWR Hau": (ModNameComment, "O", 3, "EG HWR Hau"),
-    # Groups
-    "=M000010.GP012005040": (
-        ModStatusGroups,
-        False,
-        12,
-        [LcnAddr(0, 5, True), LcnAddr(0, 40, True)],
-    ),
-    "=M000010.GD008005040": (
-        ModStatusGroups,
-        True,
-        8,
-        [LcnAddr(0, 5, True), LcnAddr(0, 40, True)],
-    ),
-    "=M000010.GD010005040030020010100200150099201": (
-        ModStatusGroups,
-        True,
-        10,
-        [
-            LcnAddr(0, 5, True),
-            LcnAddr(0, 40, True),
-            LcnAddr(0, 30, True),
-            LcnAddr(0, 20, True),
-            LcnAddr(0, 10, True),
-            LcnAddr(0, 100, True),
-            LcnAddr(0, 200, True),
-            LcnAddr(0, 150, True),
-            LcnAddr(0, 99, True),
-            LcnAddr(0, 201, True),
-        ],
-    ),
-    # Status Output
-    ":M000010A1050": (ModStatusOutput, OutputPort.OUTPUT1.value, 50.0),
-    # Status Output Native
-    ":M000010O1050": (ModStatusOutputNative, OutputPort.OUTPUT1.value, 50),
-    # Status Relays
-    ":M000010Rx204": (
-        ModStatusRelays,
-        [False, False, True, True, False, False, True, True],
-    ),
-    # Status BinSensors
-    ":M000010Bx204": (
-        ModStatusBinSensors,
-        [False, False, True, True, False, False, True, True],
-    ),
-    # Status Var
-    "%M000010.A00301200": (ModStatusVar, Var.VAR3, VarValue(1200)),
-    "%M000010.01200": (ModStatusVar, Var.UNKNOWN, VarValue(1200)),
-    "%M000010.S101200": (ModStatusVar, Var.R1VARSETPOINT, VarValue(1200)),
-    "%M000010.T1100050": (ModStatusVar, Var.THRS1, VarValue(50)),
-    "%M000010.T3400050": (ModStatusVar, Var.THRS3_4, VarValue(50)),
-    # Status Leds and LogicOps
-    "=M000010.TLAEBFAAAAAAAANTVN": (
-        ModStatusLedsAndLogicOps,
-        [
-            LedStatus.OFF,
-            LedStatus.ON,
-            LedStatus.BLINK,
-            LedStatus.FLICKER,
-            LedStatus.OFF,
-            LedStatus.OFF,
-            LedStatus.OFF,
-            LedStatus.OFF,
-            LedStatus.OFF,
-            LedStatus.OFF,
-            LedStatus.OFF,
-            LedStatus.OFF,
-        ],
-        [LogicOpStatus.NONE, LogicOpStatus.SOME, LogicOpStatus.ALL, LogicOpStatus.NONE],
-    ),
-    # Status Key Locks
-    "=M000010.TX255000063204": (
-        ModStatusKeyLocks,
-        [
-            [True, True, True, True, True, True, True, True],
-            [False, False, False, False, False, False, False, False],
-            [True, True, True, True, True, True, False, False],
-            [False, False, True, True, False, False, True, True],
-        ],
-    ),
-    # Status Access Control
-    "=M000010.ZI026043060013002": (
-        ModStatusAccessControl,
-        AccessControlPeriphery.TRANSMITTER,
-        "1a2b3c",
-        1,
-        2,
-        KeyAction.MAKE,
-        BatteryStatus.FULL,
-    ),
-    "=M000010.ZI026043060013011": (
-        ModStatusAccessControl,
-        AccessControlPeriphery.TRANSMITTER,
-        "1a2b3c",
-        1,
-        2,
-        KeyAction.HIT,
-        BatteryStatus.WEAK,
-    ),
-    "=M000010.ZT026043060": (
-        ModStatusAccessControl,
-        AccessControlPeriphery.TRANSPONDER,
-        "1a2b3c",
-    ),
-    "=M000010.ZF026043060": (
-        ModStatusAccessControl,
-        AccessControlPeriphery.FINGERPRINT,
-        "1a2b3c",
-    ),
-    "=M000010.ZC026043060": (
-        ModStatusAccessControl,
-        AccessControlPeriphery.CODELOCK,
-        "1a2b3c",
-    ),
-    # Status scene outputs
-    "=M000010.SZ003025150075100140000033200": (
-        ModStatusSceneOutputs,
-        3,
-        [25, 75, 140, 33],
-        [150, 100, 0, 200],
-    ),
-    # SKH
-    "+M004000010.SKH000001": (ModSendCommandHost, (0, 1)),
-    "+M004000010.SKH000001002003004005": (
-        ModSendCommandHost,
-        tuple(i for i in range(6)),
-    ),
-    "+M004000010.SKH000001002003004005006007008009010011012013": (
-        ModSendCommandHost,
-        tuple(i for i in range(14)),
-    ),
-    # SKH with partially invalid data
-    "+M004000010.SKH000001002": (ModSendCommandHost, (0, 1)),
-    "+M004000010.SKH000001002003": (ModSendCommandHost, (0, 1)),
-    "+M004000010.SKH000001002003004005006": (
-        ModSendCommandHost,
-        tuple(i for i in range(6)),
-    ),
-    # SKH (new header)
-    "$M000010.SKH000001": (ModSendCommandHost, (0, 1)),
-    "$M000010.SKH000001002003004005": (
-        ModSendCommandHost,
-        tuple(i for i in range(6)),
-    ),
-    "$M000010.SKH000001002003004005006007008009010011012013": (
-        ModSendCommandHost,
-        tuple(i for i in range(14)),
-    ),
-    # SKH (new header) with partially invalid data
-    "$M000010.SKH000001002": (ModSendCommandHost, (0, 1)),
-    "$M000010.SKH000001002003": (ModSendCommandHost, (0, 1)),
-    "$M000010.SKH000001002003004005006": (
-        ModSendCommandHost,
-        tuple(i for i in range(6)),
-    ),
-    # STH
-    "+M004000010.STH000000": (
-        ModSendKeysHost,
-        [SendKeyCommand.DONTSEND] * 3,
-        [False] * 8,
-    ),
-    "+M004000010.STH057078": (
-        ModSendKeysHost,
-        [SendKeyCommand.HIT, SendKeyCommand.MAKE, SendKeyCommand.BREAK],
-        [False, True, True, True, False, False, True, False],
-    ),
-    # STH
-    "$M000010.STH000000": (
-        ModSendKeysHost,
-        [SendKeyCommand.DONTSEND] * 3,
-        [False] * 8,
-    ),
-    "$M000010.STH057078": (
-        ModSendKeysHost,
-        [SendKeyCommand.HIT, SendKeyCommand.MAKE, SendKeyCommand.BREAK],
-        [False, True, True, True, False, False, True, False],
-    ),
-}
-
-
-@pytest.mark.parametrize("message, expected", MESSAGES.items())
-def test_message_parsing_single_mod_input(message, expected):
-    """Test if InputMod parses message correctly."""
-    exp = (expected[0])(LcnAddr(0, 10, False), *expected[1:])
-    inp = InputParser.parse(message)
-    assert len(inp) == 1
-    assert type(inp[0]) is type(exp)  # pylint: disable=unidiomatic-typecheck
-    assert vars(inp[0]) == vars(exp)