pypck 0.8.9__py3-none-any.whl → 0.9.1__py3-none-any.whl

pypck/__init__.py

@@ -8,7 +8,6 @@ from pypck import (
     lcn_defs,
     module,
     pck_commands,
-    timeout_retry,
 )
 
 __all__ = [
@@ -19,5 +18,4 @@ __all__ = [
     "lcn_defs",
     "module",
     "pck_commands",
-    "timeout_retry",
 ]

pypck/connection.py

@@ -4,7 +4,6 @@ from __future__ import annotations
 
 import asyncio
 import logging
-import time
 from collections.abc import Callable, Iterable
 from types import TracebackType
 from typing import Any
@@ -13,7 +12,7 @@ from pypck import inputs, lcn_defs
 from pypck.helpers import TaskRegistry
 from pypck.lcn_addr import LcnAddr
 from pypck.lcn_defs import LcnEvent
-from pypck.module import AbstractConnection, GroupConnection, ModuleConnection
+from pypck.module import GroupConnection, ModuleConnection
 from pypck.pck_commands import PckGenerator
 
 _LOGGER = logging.getLogger(__name__)
@@ -98,7 +97,7 @@ class PchkConnectionManager:
         self.reader: asyncio.StreamReader | None = None
         self.writer: asyncio.StreamWriter | None = None
         self.buffer: asyncio.Queue[bytes] = asyncio.Queue()
-        self.last_bus_activity = time.time()
+        self.last_bus_activity = asyncio.get_running_loop().time()
 
         self.username = username
         self.password = password
@@ -145,6 +144,7 @@ class PchkConnectionManager:
         """Processes incoming data."""
         assert self.reader is not None
         assert self.writer is not None
+        loop = asyncio.get_running_loop()
         _LOGGER.debug("Read data loop started")
         try:
             while not self.writer.is_closing():
@@ -152,7 +152,7 @@ class PchkConnectionManager:
                     data = await self.reader.readuntil(
                         PckGenerator.TERMINATION.encode()
                     )
-                    self.last_bus_activity = time.time()
+                    self.last_bus_activity = loop.time()
                 except (
                     asyncio.IncompleteReadError,
                     TimeoutError,
@@ -187,11 +187,12 @@ class PchkConnectionManager:
     async def write_data_loop(self) -> None:
         """Processes queue and writes data."""
         assert self.writer is not None
+        loop = asyncio.get_running_loop()
         try:
             _LOGGER.debug("Write data loop started")
             while not self.writer.is_closing():
                 data = await self.buffer.get()
-                while (time.time() - self.last_bus_activity) < self.idle_time:
+                while (loop.time() - self.last_bus_activity) < self.idle_time:
                     await asyncio.sleep(self.idle_time)
 
                 _LOGGER.debug(
@@ -201,7 +202,7 @@ class PchkConnectionManager:
                 )
                 self.writer.write(data)
                 await self.writer.drain()
-                self.last_bus_activity = time.time()
+                self.last_bus_activity = loop.time()
         finally:
             # empty the queue
             while not self.buffer.empty():
@@ -243,7 +244,7 @@ class PchkConnectionManager:
                     if isinstance(exc, (ConnectionRefusedError, OSError)):
                         raise PchkConnectionRefusedError()
                     else:
-                        raise awaitable.exception()  # type: ignore
+                        raise exc
 
         if pending:
             for awaitable in pending:
@@ -274,7 +275,6 @@ class PchkConnectionManager:
 
     async def async_close(self) -> None:
         """Close the active connection."""
-        await self.cancel_requests()
         if self.ping_timeout_handle is not None:
             self.ping_timeout_handle.cancel()
         await self.task_registry.cancel_all_tasks()
@@ -347,7 +347,7 @@ class PchkConnectionManager:
         """Ping was received."""
         if self.ping_timeout_handle is not None:
             self.ping_timeout_handle.cancel()
-        self.last_ping = time.time()
+        self.last_ping = asyncio.get_running_loop().time()
 
     def is_ready(self) -> bool:
         """Retrieve the overall connection state."""
@@ -378,9 +378,7 @@ class PchkConnectionManager:
             addr.is_group,
         )
 
-    def get_module_conn(
-        self, addr: LcnAddr, request_serials: bool = True
-    ) -> ModuleConnection:
+    def get_module_conn(self, addr: LcnAddr) -> ModuleConnection:
         """Create and/or return the given LCN module."""
         assert not addr.is_group
         if addr.seg_id == 0 and self.local_seg_id != -1:
@@ -390,8 +388,6 @@ class PchkConnectionManager:
             address_conn = ModuleConnection(
                 self, addr, wants_ack=self.settings["ACKNOWLEDGE"]
             )
-            if request_serials:
-                self.task_registry.create_task(address_conn.request_serials())
             self.address_conns[addr] = address_conn
 
         return address_conn
@@ -403,17 +399,15 @@ class PchkConnectionManager:
             addr = LcnAddr(self.local_seg_id, addr.addr_id, addr.is_group)
         return GroupConnection(self, addr)
 
-    def get_address_conn(
-        self, addr: LcnAddr, request_serials: bool = True
-    ) -> AbstractConnection:
-        """Create and/or return an AbstractConnection to the given module or group."""
+    def get_address_conn(self, addr: LcnAddr) -> ModuleConnection | GroupConnection:
+        """Create and/or return a connection to the given module or group."""
         if addr.is_group:
             return self.get_group_conn(addr)
-        return self.get_module_conn(addr, request_serials)
+        return self.get_module_conn(addr)
 
     # Other
 
-    def dump_modules(self) -> dict[str, dict[str, dict[str, Any]]]:
+    async def dump_modules(self) -> dict[str, dict[str, dict[str, Any]]]:
         """Dump all modules and information about them in a JSON serializable dict."""
         dump: dict[str, dict[str, dict[str, Any]]] = {}
         for address_conn in self.address_conns.values():
@@ -421,7 +415,7 @@ class PchkConnectionManager:
             addr = f"{address_conn.addr.addr_id}"
             if seg not in dump:
                 dump[seg] = {}
-            dump[seg][addr] = address_conn.dump_details()
+            dump[seg][addr] = await address_conn.dump_details()
         return dump
 
     # Command sending / retrieval.
@@ -584,19 +578,6 @@ class PchkConnectionManager:
 
         self.segment_scan_completed_event.set()
 
-    # Status requests, responses
-
-    async def cancel_requests(self) -> None:
-        """Cancel all TimeoutRetryHandlers."""
-        cancel_tasks = [
-            asyncio.create_task(address_conn.cancel_requests())
-            for address_conn in self.address_conns.values()
-            if isinstance(address_conn, ModuleConnection)
-        ]
-
-        if cancel_tasks:
-            await asyncio.wait(cancel_tasks)
-
     # Callbacks for inputs and events
 
     def register_for_inputs(

pypck/helpers.py

@@ -1,7 +1,7 @@
 """Helper functions for pypck."""
 
 import asyncio
-from collections.abc import Awaitable
+from collections.abc import Coroutine
 from typing import Any
 
 
@@ -30,9 +30,9 @@ class TaskRegistry:
         if task in self.tasks:
             self.tasks.remove(task)
 
-    def create_task(self, coro: Awaitable[Any]) -> "asyncio.Task[None]":
+    def create_task(self, coro: Coroutine[Any, Any, Any]) -> "asyncio.Task[None]":
         """Create a task and store a reference in the task registry."""
-        task = asyncio.create_task(coro)  # type: ignore
+        task: asyncio.Task[Any] = asyncio.create_task(coro)
         task.add_done_callback(self.remove_task)
         self.tasks.append(task)
         return task

pypck/lcn_defs.py

@@ -360,6 +360,64 @@ class Var(Enum):
     S0INPUT3 = auto()
     S0INPUT4 = auto()  # LCN-BU4LJVarValue
 
+    @classmethod
+    def variables(cls) -> list[Var]:
+        """Return a list of all variable types."""
+        return [
+            cls.VAR1ORTVAR,
+            cls.VAR2ORR1VAR,
+            cls.VAR3ORR2VAR,
+            cls.VAR4,
+            cls.VAR5,
+            cls.VAR6,
+            cls.VAR7,
+            cls.VAR8,
+            cls.VAR9,
+            cls.VAR10,
+            cls.VAR11,
+            cls.VAR12,
+        ]
+
+    @classmethod
+    def variables_new(cls) -> list[Var]:
+        """Return a list of all new variable types (firmware >=0x170206)."""
+        return cls.variables()
+
+    @classmethod
+    def variables_old(cls) -> list[Var]:
+        """Return a list of all variable types (firmware <0x170206)."""
+        return cls.variables()[:3]
+
+    @classmethod
+    def set_points(cls) -> list[Var]:
+        """Return a list of all set-point variable types."""
+        return [cls.R1VARSETPOINT, cls.R2VARSETPOINT]
+
+    @classmethod
+    def thresholds(cls) -> list[list[Var]]:
+        """Return a list of all threshold variable types."""
+        return [
+            [cls.THRS1, cls.THRS2, cls.THRS3, cls.THRS4, cls.THRS5],
+            [cls.THRS2_1, cls.THRS2_2, cls.THRS2_3, cls.THRS2_4],
+            [cls.THRS3_1, cls.THRS3_2, cls.THRS3_3, cls.THRS3_4],
+            [cls.THRS4_1, cls.THRS4_2, cls.THRS4_3, cls.THRS4_4],
+        ]
+
+    @classmethod
+    def thresholds_new(cls) -> list[list[Var]]:
+        """Return a list of all threshold variable types (firmware >=0x170206)."""
+        return [cls.thresholds()[0][:4], *cls.thresholds()[1:]]
+
+    @classmethod
+    def thresholds_old(cls) -> list[list[Var]]:
+        """Return a list of all old threshold variable types (firmware <0x170206)."""
+        return [cls.thresholds()[0]]
+
+    @classmethod
+    def s0s(cls) -> list[Var]:
+        """Return a list of all S0-input variable types."""
+        return [cls.S0INPUT1, cls.S0INPUT2, cls.S0INPUT3, cls.S0INPUT4]
+
     @staticmethod
     def var_id_to_var(var_id: int) -> Var:
         """Translate a given id into a variable type.
@@ -369,9 +427,9 @@ class Var(Enum):
         :returns: The translated variable enum.
         :rtype: Var
         """
-        if (var_id < 0) or (var_id >= len(Var.variables)):  # type: ignore
+        if (var_id < 0) or (var_id >= len(Var.variables())):
             raise ValueError("Bad var_id.")
-        return Var.variables[var_id]  # type: ignore
+        return Var.variables()[var_id]
 
     @staticmethod
     def set_point_id_to_var(set_point_id: int) -> Var:
@@ -382,9 +440,9 @@ class Var(Enum):
         :return: The translated var
         :rtype:  Var
         """
-        if (set_point_id < 0) or (set_point_id >= len(Var.set_points)):  # type: ignore
+        if (set_point_id < 0) or (set_point_id >= len(Var.set_points())):
             raise ValueError("Bad set_point_id.")
-        return Var.set_points[set_point_id]  # type: ignore
+        return Var.set_points()[set_point_id]
 
     @staticmethod
     def thrs_id_to_var(register_id: int, thrs_id: int) -> Var:
@@ -399,12 +457,12 @@ class Var(Enum):
         """
         if (
             (register_id < 0)
-            or (register_id >= len(Var.thresholds))  # type: ignore
+            or (register_id >= len(Var.thresholds()))
             or (thrs_id < 0)
             or (thrs_id >= (5 if (register_id == 0) else 4))
         ):
             raise ValueError("Bad register_id and/or thrs_id.")
-        return Var.thresholds[register_id][thrs_id]  # type: ignore
+        return Var.thresholds()[register_id][thrs_id]
 
     @staticmethod
     def s0_id_to_var(s0_id: int) -> Var:
@@ -415,9 +473,9 @@ class Var(Enum):
         :return:    The translated var
         :rtype:     Var
         """
-        if (s0_id < 0) or (s0_id >= len(Var.s0s)):  # type: ignore
+        if (s0_id < 0) or (s0_id >= len(Var.s0s())):
             raise ValueError("Bad s0_id.")
-        return Var.s0s[s0_id]  # type: ignore
+        return Var.s0s()[s0_id]
 
     @staticmethod
     def to_var_id(var: Var) -> int:
@@ -658,42 +716,6 @@ class Var(Enum):
         return (not lock_state) and (software_serial < 0x170206)
 
 
-# Helper list to get var by numeric id.
-Var.variables = [  # type: ignore
-    Var.VAR1ORTVAR,
-    Var.VAR2ORR1VAR,
-    Var.VAR3ORR2VAR,
-    Var.VAR4,
-    Var.VAR5,
-    Var.VAR6,
-    Var.VAR7,
-    Var.VAR8,
-    Var.VAR9,
-    Var.VAR10,
-    Var.VAR11,
-    Var.VAR12,
-]
-
-# Helper list to get set-point var by numeric id.
-Var.set_points = [Var.R1VARSETPOINT, Var.R2VARSETPOINT]  # type: ignore
-
-# Helper list to get threshold var by numeric id.
-Var.thresholds = [  # type: ignore
-    [Var.THRS1, Var.THRS2, Var.THRS3, Var.THRS4, Var.THRS5],
-    [Var.THRS2_1, Var.THRS2_2, Var.THRS2_3, Var.THRS2_4],
-    [Var.THRS3_1, Var.THRS3_2, Var.THRS3_3, Var.THRS3_4],
-    [Var.THRS4_1, Var.THRS4_2, Var.THRS4_3, Var.THRS4_4],
-]
-
-# Helper list to get S0-input var by numeric id.
-Var.s0s = [  # type: ignore
-    Var.S0INPUT1,
-    Var.S0INPUT2,
-    Var.S0INPUT3,
-    Var.S0INPUT4,
-]
-
-
 class VarUnit(Enum):
     """Measurement units used with LCN variables."""
 
@@ -1458,7 +1480,9 @@ default_connection_settings: dict[str, Any] = {
     # been send which
     # potentially changed
     # that status
+    "MAX_RESPONSE_AGE": 60,  # Age in seconds after which stored responses are purged
     "BUS_IDLE_TIME": 0.05,  # Time to wait for message traffic before sending
     "PING_SEND_DELAY": 600,  # The default timeout for pings sent to PCHK
     "PING_RECV_TIMEOUT": 10,  # The default timeout for pings expected from PCHK
+    "PING_MODULE_TIMEOUT": 60,  # The delay before sending a ping to a module
 }