Merge branch 'main' into issue/168/obsolete

Author: kbabioch

.github/workflows/pytest.yml

@@ -17,6 +17,8 @@ jobs:
           python-version: "3.11"
       - name: Install pytest
         run: pip install pytest pytest-cov
+      - name: Install dependencies
+        run: pip install .
       - name: Run pytest
         # yamllint disable rule:line-length
         run: |

LICENCE.md renamed to LICENSE.md

@@ -0,0 +1,9 @@
+# MANIFEST.in
+# This file tells setuptools which additional non‑Python files should be
+# included in the source distribution (sdist) and wheel.
+# We explicitly include our own LICENSE and NOTICE files, as well as
+# third‑party license texts stored in the licenses/ directory.
+
+include LICENSE.md
+include NOTICE.md
+recursive-include licenses *

MANIFEST.in

@@ -0,0 +1,23 @@
+# NOTICE
+
+Project: luxtronik  
+License: MIT License  
+Copyright (c) 2018 Bouni
+
+---
+
+This project includes software developed by third parties.
+The following components are used and are subject to their respective licenses:
+
+1. pyModbusTCP (Version 0.3.0)  
+   License: [MIT License][1]  
+   Copyright (c) 2014 l.lefebvre
+
+Each of the above components is used in accordance with the terms
+of its license. Full license texts are available in the respective repositories
+or if necessary in the `licenses/` directory of this project.
+
+[1]: https://github.com/sourceperl/pyModbusTCP/blob/v0.3.0/LICENSE
+
+This NOTICE file is provided for informational purposes
+only and does not modify any license terms.

NOTICE.md

@@ -317,5 +317,6 @@ def __init__(self):
             264: Unknown("Unknown_Calculation_264"),
             265: Unknown("Unknown_Calculation_265"),
             266: Unknown("Unknown_Calculation_266"),
-            267: Celsius(["Desired_Room_Temperature", "Unknown_Calculation_267"]),
+            267: Celsius("Desired_Room_Temperature"),
+            268: Power("AC_Power_Input")
         }

luxtronik/calculations.py

@@ -0,0 +1,24 @@
+from threading import RLock
+
+# Global lock to synchronize access to the hosts_locks dictionary
+_management_lock = RLock()
+_hosts_locks = {}
+
+def get_host_lock(host):
+    """
+    Retrieve the unique lock object associated with a given host.
+    The same thread can acquire a RLock as often as desired.
+
+    If no lock exists for the host, a new one is created in a thread-safe manner.
+
+    Args:
+        host (str): Hostname or IP address.
+
+    Returns:
+        RLock: The lock object dedicated to the given host.
+    """
+    # Ensure a dedicated lock is created for each IP.
+    with _management_lock:
+        if host not in _hosts_locks:
+            _hosts_locks[host] = RLock()
+        return _hosts_locks[host]

luxtronik/common.py

@@ -874,6 +874,112 @@ def to_heatpump(cls, value):
 
         return val
 
+class HeatPumpState(SelectionBase):
+    """HeatPumpState datatype, converts from and to list of HeatPumpState codes."""
+
+    datatype_class = "selection"
+
+    codes = {
+        0: "Idle",     # Heatpump is idle
+        1: "Running",  # Heatpump is running
+    }
+
+class ModeState(SelectionBase):
+    """ModeState datatype, converts from and to list of ModeState codes."""
+
+    datatype_class = "selection"
+
+    codes = {
+        0: "Disabled",    # Heating / Hot water is disabled
+        1: "No request",  # Heating / Hot water currently not requested
+        2: "Requested",   # Heating / Hot water requested but currently not running
+        3: "Running",     # Heating / Hot water running
+    }
+
+class ControlMode(SelectionBase):
+    """ControlMode datatype, converts from and to list of ControlMode codes."""
+
+    datatype_class = "selection"
+
+    codes = {
+        0: "Off",       # System value is used
+        1: "Setpoint",  # Setpoint register value is used
+        2: "Offset",    # System values + offset register value is used
+        3: "Level",     # System values + smart-home-interface-settings
+                        # register value is used
+    }
+
+
+class LpcMode(SelectionBase):
+    """LpcMode datatype, converts from and to list of LpcMode codes."""
+
+    datatype_class = "selection"
+
+    codes = {
+        0: "No limit",
+        1: "Soft limit",
+        2: "Hard limit",
+    }
+
+
+class LockMode(SelectionBase):
+    """LockMode datatype, converts from and to list of LockMode codes."""
+
+    datatype_class = "selection"
+
+    codes = {
+        0: "Off",       # Function is not locked
+        1: "On",        # Function is locked
+    }
+
+class OnOffMode(SelectionBase):
+    """OnOffMode datatype, converts from and to list of OnOffMode codes."""
+
+    datatype_class = "selection"
+
+    codes = {
+        0: "Off",       # Function deactivated
+        1: "On",        # Function activated
+    }
+
+class LevelMode(SelectionBase):
+    """LevelMode datatype, converts from and to list of LevelMode codes."""
+
+    datatype_class = "selection"
+
+    codes = {
+        0: "Normal",     # No correction
+        1: "Increased",  # Increase the temperature by the values
+                         # within the smart-home-interface-settings
+                         # TODO: Function unknown – requires further analysis
+        2: "Increased2", # Increase the temperature by the values
+                         # within the smart-home-interface-settings
+                         # TODO: Function unknown – requires further analysis
+        3: "Decreased",  # Decrease the temperature by the values
+                         # within the smart-home-interface-settings
+                         # TODO: Function unknown – requires further analysis
+    }
+
+class PowerLimit(ScalingBase):
+    """PowerLimit datatype, converts from and to PowerLimit."""
+
+    datatype_class = "power"
+    datatype_unit = "kW"
+    scaling_factor = 0.1
+
+
+class FullVersion(Base):
+    """FullVersion datatype, converts from and to a RBEVersion"""
+
+    datatype_class = "version"
+
+    @classmethod
+    def from_heatpump(cls, value):
+        if isinstance(value, list) and len(value) >= 3:
+            return f"{value[0]}.{value[1]}.{value[2]}"
+        else:
+            return "0"
+
 
 class Unknown(Base):
     """Unknown datatype, fallback for unknown data."""