Add device_tester.py: Interactive tool for MQTT device testing.

Author: epdevlab

inelsmqtt/devices/__init__.py

@@ -104,6 +104,13 @@ def device_class(self) -> str:
         """
         return self.__device_class.TYPE_ID
 
+    def get_settable_attributes(self) -> dict:
+        """
+        Returns the settable attributes dictionary.
+        This method is used ONLY by the IntegrationDeviceTester for testing purposes.
+        """
+        return getattr(self.__device_class, "SETTABLE_ATTRIBUTES", {})
+
     @property
     def inels_type(self) -> str:
         """Get inels type of the device

inelsmqtt/protocols/elanrf.py

@@ -3,6 +3,8 @@
 from enum import IntEnum
 from typing import TYPE_CHECKING, Any, List
 
+from inelsmqtt.utils.common import SettableAttribute
+
 if TYPE_CHECKING:
     from inelsmqtt.utils.core import DeviceValue
 
@@ -93,6 +95,9 @@ class Command(IntEnum):
 
     DATA: DataDict = {RELAY: 1}
 
+    # NOTE: This dictionary is used ONLY for testing purposes.
+    SETTABLE_ATTRIBUTES = {"is_on": SettableAttribute("simple_relay.0.is_on", bool, [True, False])}
+
     @classmethod
     def COMM_TEST(cls) -> str:
         return cls.create_command_payload(cls.Command.COMM_TEST)
@@ -138,6 +143,8 @@ class Command(IntEnum):
     TIME_HIGH_BYTE = 0
     TIME_LOW_BYTE = 0
 
+    SETTABLE_ATTRIBUTES = {"is_on": SettableAttribute("simple_relay.0.is_on", bool, [True, False])}
+
     @classmethod
     def COMM_TEST(cls) -> str:
         return cls.create_command_payload(cls.Command.COMM_TEST, cls.TIME_HIGH_BYTE, cls.TIME_LOW_BYTE)
@@ -193,6 +200,14 @@ class Command(IntEnum):
         Shutter_state.Stop_down: Command.STOP_DOWN,
     }
 
+    SETTABLE_ATTRIBUTES = {
+        "state": SettableAttribute(
+            "shutters.0.state",
+            Shutter_state,
+            [Shutter_state.Open, Shutter_state.Closed, Shutter_state.Stop_up, Shutter_state.Stop_down],
+        ),
+    }
+
     @classmethod
     def COMM_TEST(cls) -> str:
         return cls.create_command_payload(cls.Command.COMM_TEST, cls.TIME_HIGH_BYTE, cls.TIME_LOW_BYTE)
@@ -235,6 +250,10 @@ class Command(IntEnum):
 
     DATA: DataDict = {RF_DIMMER: [0, 1]}
 
+    SETTABLE_ATTRIBUTES = {
+        "brightness": SettableAttribute("simple_light.0.brightness", int, list(range(0, 101, 10))),
+    }
+
     @classmethod
     def COMM_TEST(cls) -> str:
         return cls.create_command_payload(cls.Command.COMM_TEST)
@@ -279,6 +298,10 @@ class Command(IntEnum):
 
     DATA: DataDict = {RF_DIMMER: [0, 1]}
 
+    SETTABLE_ATTRIBUTES = {
+        "brightness": SettableAttribute("simple_light.0.brightness", int, list(range(0, 101, 10))),
+    }
+
     @classmethod
     def COMM_TEST(cls) -> str:
         return cls.create_command_payload(cls.Command.COMM_TEST)
@@ -321,6 +344,13 @@ class Command(IntEnum):
 
     DATA: DataDict = {RED: [1], GREEN: [2], BLUE: [3], OUT: [4]}
 
+    SETTABLE_ATTRIBUTES = {
+        "red": SettableAttribute("rgb.0.r", int, list(range(0, 256))),
+        "green": SettableAttribute("rgb.0.g", int, list(range(0, 256))),
+        "blue": SettableAttribute("rgb.0.b", int, list(range(0, 256))),
+        "brightness": SettableAttribute("rgb.0.brightness", int, list(range(0, 256))),
+    }
+
     @classmethod
     def COMM_TEST(cls) -> str:
         return cls.create_command_payload(cls.Command.COMM_TEST, 0, 0, 0, 0)
@@ -377,6 +407,10 @@ class Command(IntEnum):
         False: Command.OFF,
     }
 
+    SETTABLE_ATTRIBUTES = {
+        "is_on": SettableAttribute("simple_relay.0.is_on", bool, [True, False]),
+    }
+
     @classmethod
     def COMM_TEST(cls) -> str:
         return cls.create_command_payload(cls.Command.COMM_TEST)
@@ -418,6 +452,10 @@ class DT_09(CommTest):
         REQUIRED_TEMP: [3],
     }
 
+    SETTABLE_ATTRIBUTES = {
+        "required_temp": SettableAttribute("thermovalve.required", float, [x / 2 for x in range(0, 129)]),
+    }
+
     @staticmethod
     def create_command_payload(temp_required: int) -> str:
         return Formatter.format_data([0, temp_required, 0])
@@ -502,6 +540,11 @@ class Command(IntEnum):
 
     DATA: DataDict = {OUT: [4], WHITE: [5]}
 
+    SETTABLE_ATTRIBUTES = {
+        "brightness": SettableAttribute("warm_light.0.brightness", int, list(range(0, 101))),
+        "relative_ct": SettableAttribute("warm_light.0.relative_ct", int, list(range(0, 101))),
+    }
+
     @classmethod
     def COMM_TEST(cls) -> str:
         return cls.create_command_payload(cls.Command.COMM_TEST)
@@ -710,6 +753,15 @@ class Command(IntEnum):
         Shutter_state.Stop_down: Command.STOP_DOWN,
     }
 
+    SETTABLE_ATTRIBUTES = {
+        "state": SettableAttribute(
+            "shutters_with_pos.0.state",
+            Shutter_state,
+            [Shutter_state.Open, Shutter_state.Closed, Shutter_state.Stop_up, Shutter_state.Stop_down],
+        ),
+        "position": SettableAttribute("shutters_with_pos.0.position", int, list(range(0, 101))),
+    }
+
     @classmethod
     def COMM_TEST(cls) -> str:
         return cls.create_command_payload(cls.Command.COMM_TEST, cls.HIGH_BYTE, cls.LOW_BYTE)

inelsmqtt/utils/common.py

@@ -141,3 +141,25 @@ class Formatter:
     def format_data(data: List[int]) -> str:
         """Formats a list of integers into a newline-separated hexadecimal string with a trailing newline."""
         return "\n".join(f"{x:02X}" for x in data) + "\n"
+
+
+class SettableAttribute:
+    def __init__(self, route: str, attr_type: type, possible_values: Union[List[Any], Tuple[int, int], None] = None):
+        self.route = route
+        self.attr_type = attr_type
+        self.possible_values = possible_values
+
+    def is_valid_value(self, value: Any) -> bool:
+        if self.possible_values is None:
+            return True
+        if isinstance(self.possible_values, tuple) and len(self.possible_values) == 2:
+            min_val, max_val = self.possible_values
+            return bool(min_val <= value <= max_val)  # Explicit cast to bool
+        return value in self.possible_values
+
+    def get_value_description(self) -> str:
+        if self.possible_values is None:
+            return f"Any {self.attr_type.__name__}"
+        if isinstance(self.possible_values, tuple) and len(self.possible_values) == 2:
+            return f"Range: {self.possible_values[0]} to {self.possible_values[1]}"
+        return f"Possible values: {self.possible_values}"

pyproject.toml

@@ -79,7 +79,7 @@ skip-magic-trailing-comma = false
 # Automatically detect and use the appropriate line ending style.
 line-ending = "auto"
 
-[tool.ruff.mccabe]
+[lint.mccabe]
 max-complexity = 10
 
 # https://github.com/home-assistant/core/blob/dev/mypy.ini

setup.py

@@ -4,7 +4,7 @@
 
 setup(
     name="elkoep-mqtt",
-    version="0.2.33.beta.10",
+    version="0.2.33.beta.11",
     url="https://github.com/epdevlab/elkoep-mqtt",
     license="MIT",
     author="Elko EP s.r.o.",