Merge pull request #202 from Guzz-T/issue/190/data_vector

Support Smart-Home-Interface Part 4: Data vector classes

Author: kbabioch

luxtronik/shi/constants.py

@@ -11,6 +11,12 @@
 # Default offset for the input or holding indices
 LUXTRONIK_DEFAULT_DEFINITION_OFFSET: Final = 10000
 
+# Identifier of holding data-vectors and partial name for unknown holding fields
+HOLDINGS_FIELD_NAME: Final = "holding"
+
+# Identifier of input data-vectors and partial name for unknown input fields
+INPUTS_FIELD_NAME: Final = "input"
+
 # Waiting time (in seconds) after writing the holdings
 # to give the controller time to recalculate values, etc.
 LUXTRONIK_WAIT_TIME_AFTER_HOLDING_WRITE: Final = 1
@@ -21,3 +27,9 @@
 
 # First Luxtronik firmware version that supports the Smart Home Interface (SHI)
 LUXTRONIK_FIRST_VERSION_WITH_SHI: Final = (3, 90, 1, 0)
+
+# Latest supported Luxtronik firmware version
+# Note:
+# No checks are performed against this version.
+# This is merely the default value if no version is specified.
+LUXTRONIK_LATEST_SHI_VERSION: Final = (3, 92, 0, 0)

luxtronik/shi/definitions.py

@@ -203,8 +203,10 @@ def __init__(self):
     def __getitem__(self, name_or_idx):
         return self.get(name_or_idx)
 
-    def __contains__(self, name_or_idx):
-        return self._get(name_or_idx) is not None
+    def __contains__(self, def_name_or_idx):
+        if isinstance(def_name_or_idx, LuxtronikDefinition):
+            return any(def_name_or_idx is d for d in self._index_dict.values())
+        return self._get(def_name_or_idx) is not None
 
     def _add_alias(self, definition, alias):
         """
@@ -410,11 +412,15 @@ def __init__(self, definitions_list, name, offset=LUXTRONIK_DEFAULT_DEFINITION_O
         # The correct sorting has already been ensured by the pytest
         for item in definitions_list:
             d = LuxtronikDefinition(item, name, offset)
-            self._add(d)
+            if d.valid:
+                self._add(d)
 
     def __getitem__(self, name_or_idx):
         return self.get(name_or_idx)
 
+    def __contains__(self, def_name_or_idx):
+        return def_name_or_idx in self._lookup
+
     def __len__(self):
         return len(self._definitions)
 
@@ -488,13 +494,12 @@ def _add(self, definition):
         Args:
             definition (LuxtronikDefinition): Definition to add
         """
-        if definition.valid:
-            self._definitions.append(definition)
-            self._lookup.add(definition)
+        self._definitions.append(definition)
+        self._lookup.add(definition)
 
     def add(self, data_dict):
         """
-        Add a custom (valid) definition
+        Add a custom (valid) definition. Existing definitions will not be overwritten.
 
         Args:
             data_dict (dict): Data for the definition to add
@@ -506,9 +511,11 @@ def add(self, data_dict):
             If multiple definitions added for the same index/name, the last added takes precedence.
         """
         definition = LuxtronikDefinition(data_dict, self._name, self._offset)
+        if not definition.valid:
+            return None
         self._add(definition)
         self._definitions.sort(key=lambda item: item.index)
-        return definition if definition.valid else None
+        return definition
 
 
 ###############################################################################

luxtronik/shi/holdings.py

@@ -0,0 +1,24 @@
+"""Parse luxtronik Holdings."""
+
+import logging
+from typing import Final
+
+from luxtronik.definitions.holdings import HOLDINGS_DEFINITIONS_LIST, HOLDINGS_OFFSET
+
+from luxtronik.shi.constants import HOLDINGS_FIELD_NAME
+from luxtronik.shi.definitions import LuxtronikDefinitionsList
+from luxtronik.shi.vector import DataVectorSmartHome
+
+
+HOLDINGS_DEFINITIONS: Final = LuxtronikDefinitionsList(
+    HOLDINGS_DEFINITIONS_LIST,
+    HOLDINGS_FIELD_NAME,
+    HOLDINGS_OFFSET
+)
+
+class Holdings(DataVectorSmartHome):
+    """Class that holds holding fields."""
+
+    logger = logging.getLogger("Luxtronik.Holdings")
+    name = HOLDINGS_FIELD_NAME
+    definitions = HOLDINGS_DEFINITIONS

luxtronik/shi/inputs.py

@@ -0,0 +1,24 @@
+"""Parse luxtronik Inputs."""
+
+import logging
+from typing import Final
+
+from luxtronik.definitions.inputs import INPUTS_DEFINITIONS_LIST, INPUTS_OFFSET
+
+from luxtronik.shi.constants import INPUTS_FIELD_NAME
+from luxtronik.shi.definitions import LuxtronikDefinitionsList
+from luxtronik.shi.vector import DataVectorSmartHome
+
+
+INPUTS_DEFINITIONS: Final = LuxtronikDefinitionsList(
+    INPUTS_DEFINITIONS_LIST,
+    INPUTS_FIELD_NAME,
+    INPUTS_OFFSET
+)
+
+class Inputs(DataVectorSmartHome):
+    """Class that holds input fields."""
+
+    logger = logging.getLogger("Luxtronik.Inputs")
+    name = INPUTS_FIELD_NAME
+    definitions = INPUTS_DEFINITIONS