Add debug messages for obsolete entry names

Author: Guzz-T

luxtronik/calculations.py

@@ -318,13 +318,17 @@ def __init__(self):
         }
 
     def get_firmware_version(self):
+        """Get the firmware version as string."""
         return "".join([super(Calculations, self).get(i).value for i in range(81, 91)])
 
     def _get_firmware_version(self):
+        """Get the firmware version as string like in previous versions."""
         return self.get_firmware_version().strip("\x00") 
 
     def get(self, target):
+        """Treats certain names specially. For all others, the function of the base class is called."""
         if target == "ID_WEB_SoftStand":
+            self.logger.debug(f"The name 'ID_WEB_SoftStand' is obsolete! Use 'get_firmware_version()' instead.")
             entry = Base("ID_WEB_SoftStand")
             entry.raw = self._get_firmware_version()
             return entry

luxtronik/data_vector.py

@@ -47,8 +47,11 @@ def _lookup(self, target, with_index=False):
                 # Get entry by name
                 target_index = None
                 for index, entry in self._data.items():
-                    if target in entry.get_supported_names():
+                    check_result = entry.check_name(target)
+                    if check_result in ["preferred", "obsolete"]:
                         target_index = index
+                    if check_result == "obsolete":
+                        self.logger.debug(f"The name '{target}' is obsolete! Use '{entry.name}' instead.")
         elif isinstance(target, int):
             # Get entry by id
             target_index = target

luxtronik/datatypes.py

@@ -47,6 +47,18 @@ def get_supported_names(self):
         else:
             return [self._name]
 
+    def check_name(self, name):
+        """
+        Check whether a name matches one of the supported entry names. 
+        The result string can be used to trigger a debug message for obsolete names.
+        """
+        if name == self.name:
+            return "preferred"
+        elif name in self.get_supported_names():
+            return "obsolete"
+        else:
+            return "none"
+
     @property
     def value(self):
         """Return the stored value converted from heatpump units."""