pypck 0.8.12__tar.gz → 0.9.2__tar.gz

pypck-0.9.2/PKG-INFO

@@ -0,0 +1,65 @@
+Metadata-Version: 2.4
+Name: pypck
+Version: 0.9.2
+Summary: LCN-PCK library
+Home-page: https://github.com/alengwenus/pypck
+Author-email: Andre Lengwenus <alengwenus@gmail.com>
+License: MIT
+Project-URL: Source Code, https://github.com/alengwenus/pypck
+Project-URL: Bug Reports, https://github.com/alengwenus/pypck/issues
+Keywords: lcn,pck
+Platform: any
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Intended Audience :: Developers
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Home Automation
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# pypck - Asynchronous LCN-PCK library written in Python
+
+![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/alengwenus/pypck?color=success)
+![GitHub Workflow Status (dev branch)](https://github.com/alengwenus/pypck/actions/workflows/ci.yaml/badge.svg?branch=dev)
+![Codecov branch](https://img.shields.io/codecov/c/github/alengwenus/pypck/dev)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/pypck)](https://pypi.org/project/pypck/)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
+
+<a href="https://www.buymeacoffee.com/alengwenus" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/white_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>
+
+## Overview
+
+**pypck** is an open source library written in Python which allows the connection to the [LCN (local control network) system](https://www.lcn.eu). It uses the vendor protocol LCN-PCK.
+To get started an unused license of the coupling software LCN-PCHK and a hardware coupler is necessary.
+
+**pypck** is used by the LCN integration of the [Home Assistant](https://home-assistant.io/) project.
+
+## Example
+
+```python
+"""Example for switching an output port of module 10 on and off."""
+import asyncio
+
+from pypck.connection import PchkConnectionManager
+from pypck.lcn_addr import LcnAddr
+
+async def main():
+    """Connect to PCK host, get module object and switch output port on and off."""
+    async with PchkConnectionManager(
+        "192.168.2.41",
+        4114,
+        username="lcn",
+        password="lcn",
+        settings={"SK_NUM_TRIES": 0},
+    ) as pck_client:
+        module = pck_client.get_address_conn(LcnAddr(0, 10, False))
+
+        await module.dim_output(0, 100, 0)
+        await asyncio.sleep(1)
+        await module.dim_output(0, 0, 0)
+
+asyncio.run(main())
+```

pypck-0.9.2/README.md

@@ -0,0 +1,43 @@
+# pypck - Asynchronous LCN-PCK library written in Python
+
+![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/alengwenus/pypck?color=success)
+![GitHub Workflow Status (dev branch)](https://github.com/alengwenus/pypck/actions/workflows/ci.yaml/badge.svg?branch=dev)
+![Codecov branch](https://img.shields.io/codecov/c/github/alengwenus/pypck/dev)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/pypck)](https://pypi.org/project/pypck/)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
+
+<a href="https://www.buymeacoffee.com/alengwenus" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/white_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>
+
+## Overview
+
+**pypck** is an open source library written in Python which allows the connection to the [LCN (local control network) system](https://www.lcn.eu). It uses the vendor protocol LCN-PCK.
+To get started an unused license of the coupling software LCN-PCHK and a hardware coupler is necessary.
+
+**pypck** is used by the LCN integration of the [Home Assistant](https://home-assistant.io/) project.
+
+## Example
+
+```python
+"""Example for switching an output port of module 10 on and off."""
+import asyncio
+
+from pypck.connection import PchkConnectionManager
+from pypck.lcn_addr import LcnAddr
+
+async def main():
+    """Connect to PCK host, get module object and switch output port on and off."""
+    async with PchkConnectionManager(
+        "192.168.2.41",
+        4114,
+        username="lcn",
+        password="lcn",
+        settings={"SK_NUM_TRIES": 0},
+    ) as pck_client:
+        module = pck_client.get_address_conn(LcnAddr(0, 10, False))
+
+        await module.dim_output(0, 100, 0)
+        await asyncio.sleep(1)
+        await module.dim_output(0, 0, 0)
+
+asyncio.run(main())
+```

pypck-0.9.2/VERSION

@@ -0,0 +1 @@
+0.9.2

{pypck-0.8.12 → pypck-0.9.2}/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-0.8.12 → pypck-0.9.2}/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
@@ -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():
@@ -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
-    ) -> ModuleConnection | GroupConnection:
+    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-0.8.12 → pypck-0.9.2}/pypck/lcn_defs.py

@@ -378,6 +378,16 @@ class Var(Enum):
             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."""
@@ -393,6 +403,16 @@ class Var(Enum):
             [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."""
@@ -1460,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
 }