Initial PR for virtual device

kingsleyadam · Nov 21, 2024 · 33f18d0 · 33f18d0
1 parent 977a608
commit 33f18d0
Show file tree

Hide file tree

Showing 21 changed files with 100 additions and 9 deletions.
diff --git a/src/abbfreeathome/devices/base.py b/src/abbfreeathome/devices/base.py
@@ -28,6 +28,7 @@ def __init__(
         api: FreeAtHomeApi,
         floor_name: str | None = None,
         room_name: str | None = None,
+        virtual_device: bool = False,
     ) -> None:
         """Initialize the Free@Home Base class."""
         self._device_id = device_id
@@ -41,6 +42,7 @@ def __init__(
         self._floor_name = floor_name
         self._room_name = room_name
         self._callbacks = set()
+        self._virtual_device = virtual_device
 
         # Set the initial state of the device based on output
         self._refresh_state_from_outputs()
@@ -75,6 +77,11 @@ def room_name(self) -> str | None:
         """Get the room name of the device."""
         return self._room_name
 
+    @property
+    def virtual_device(self) -> bool:
+        """Get the virtual_device state of the device."""
+        return self._virtual_device
+
     def get_input_by_pairing(self, pairing: Pairing) -> tuple[str, Any]:
         """Get the channel input by pairing id."""
         for _input_id, _input in self._inputs.items():
@@ -95,7 +102,7 @@ def get_output_by_pairing(self, pairing: Pairing) -> tuple[str, Any]:
             self.device_id, self.channel_id, pairing.value
         )
 
-    def update_device(self, datapoint_key: str, datapoint_value: str):
+    async def update_device(self, datapoint_key: str, datapoint_value: str):
         """Update the device state."""
         _LOGGER.info(
             "%s received updated data: %s: %s",
@@ -110,6 +117,10 @@ def update_device(self, datapoint_key: str, datapoint_value: str):
             self._outputs[_io_key]["value"] = datapoint_value
             _refreshed = self._refresh_state_from_output(output=self._outputs[_io_key])
 
+        # If this is a virtual device and the update was an input, ack the request.
+        if self.virtual_device and _io_key in self._inputs:
+            await self._vd_acknowledgement(datapoint_key, datapoint_value)
+
         if _refreshed and self._callbacks:
             for callback in self._callbacks:
                 callback()
@@ -149,3 +160,8 @@ def _refresh_state_from_outputs(self):
         """Refresh the state of the device from the _outputs."""
         for _output in self._outputs.values():
             self._refresh_state_from_output(_output)
+
+    async def _vd_acknowledgement(
+        self, datapoint_key: str, datapoint_value: str
+    ) -> bool:
+        """Acknowledge a request from free@home to control the device."""
diff --git a/src/abbfreeathome/devices/blind_sensor.py b/src/abbfreeathome/devices/blind_sensor.py
@@ -38,6 +38,7 @@ def __init__(
         api: FreeAtHomeApi,
         floor_name: str | None = None,
         room_name: str | None = None,
+        virtual_device: bool = False,
     ) -> None:
         """Initialize the Free@Home BlindSensor class."""
         self._state: BlindSensorState = BlindSensorState.unknown
@@ -55,6 +56,7 @@ def __init__(
             api,
             floor_name,
             room_name,
+            virtual_device,
         )
 
     @property

diff --git a/src/abbfreeathome/devices/brightness_sensor.py b/src/abbfreeathome/devices/brightness_sensor.py
@@ -27,6 +27,7 @@ def __init__(
         api: FreeAtHomeApi,
         floor_name: str | None = None,
         room_name: str | None = None,
+        virtual_device: bool = False,
     ) -> None:
         """Initialize the Free@Home BrightnessSensor class."""
         self._state: float | None = None
@@ -43,6 +44,7 @@ def __init__(
             api,
             floor_name,
             room_name,
+            virtual_device,
         )
 
     @property

diff --git a/src/abbfreeathome/devices/carbon_monoxide_sensor.py b/src/abbfreeathome/devices/carbon_monoxide_sensor.py
@@ -26,6 +26,7 @@ def __init__(
         api: FreeAtHomeApi,
         floor_name: str | None = None,
         room_name: str | None = None,
+        virtual_device: bool = False,
     ) -> None:
         """Initialize the Free@Home CarbonMonoxideSensor class."""
         self._state: bool | None = None
@@ -41,6 +42,7 @@ def __init__(
             api,
             floor_name,
             room_name,
+            virtual_device,
         )
 
     @property

diff --git a/src/abbfreeathome/devices/cover_actuator.py b/src/abbfreeathome/devices/cover_actuator.py
@@ -49,6 +49,7 @@ def __init__(
         api: FreeAtHomeApi,
         floor_name: str | None = None,
         room_name: str | None = None,
+        virtual_device: bool = False,
     ) -> None:
         """Initialize the Free@Home CoverActuator class."""
         self._state: CoverActuatorState = CoverActuatorState.unknown
@@ -69,6 +70,7 @@ def __init__(
             api,
             floor_name,
             room_name,
+            virtual_device,
         )
 
     @property

diff --git a/src/abbfreeathome/devices/des_door_opener_actuator.py b/src/abbfreeathome/devices/des_door_opener_actuator.py
@@ -26,6 +26,7 @@ def __init__(
         api: FreeAtHomeApi,
         floor_name: str | None = None,
         room_name: str | None = None,
+        virtual_device: bool = False,
     ) -> None:
         """Initialize the Free@Home DesDoorOpenerActuator class."""
         self._state: bool | None = None
@@ -41,6 +42,7 @@ def __init__(
             api,
             floor_name,
             room_name,
+            virtual_device,
         )
 
     @property

diff --git a/src/abbfreeathome/devices/des_door_ringing_sensor.py b/src/abbfreeathome/devices/des_door_ringing_sensor.py
@@ -26,6 +26,7 @@ def __init__(
         api: FreeAtHomeApi,
         floor_name: str | None = None,
         room_name: str | None = None,
+        virtual_device: bool = False,
     ) -> None:
         """Initialize the Free@Home SwitchSensor class."""
         super().__init__(
@@ -39,6 +40,7 @@ def __init__(
             api,
             floor_name,
             room_name,
+            virtual_device,
         )
 
     def _refresh_state_from_output(self, output: dict[str, Any]) -> bool:

diff --git a/src/abbfreeathome/devices/dimming_actuator.py b/src/abbfreeathome/devices/dimming_actuator.py
@@ -38,6 +38,7 @@ def __init__(
         api: FreeAtHomeApi,
         floor_name: str | None = None,
         room_name: str | None = None,
+        virtual_device: bool = False,
     ) -> None:
         """Initialize the Free@Home DimmingActuator class."""
         self._state: bool | None = None
@@ -57,6 +58,7 @@ def __init__(
             api,
             floor_name,
             room_name,
+            virtual_device,
         )
 
     @property

diff --git a/src/abbfreeathome/devices/force_on_off_sensor.py b/src/abbfreeathome/devices/force_on_off_sensor.py
@@ -35,6 +35,7 @@ def __init__(
         api: FreeAtHomeApi,
         floor_name: str | None = None,
         room_name: str | None = None,
+        virtual_device: bool = False,
     ) -> None:
         """Initialize the Free@Home ForceOnOffSensor class."""
         self._state: ForceOnOffSensorState = ForceOnOffSensorState.unknown
@@ -50,6 +51,7 @@ def __init__(
             api,
             floor_name,
             room_name,
+            virtual_device,
         )
 
     @property

diff --git a/src/abbfreeathome/devices/heating_actuator.py b/src/abbfreeathome/devices/heating_actuator.py
@@ -26,6 +26,7 @@ def __init__(
         api: FreeAtHomeApi,
         floor_name: str | None = None,
         room_name: str | None = None,
+        virtual_device: bool = False,
     ) -> None:
         """Initialize the Free@Home HeatingActuator class."""
         self._position: int | None = None
@@ -41,6 +42,7 @@ def __init__(
             api,
             floor_name,
             room_name,
+            virtual_device,
         )
 
     @property

diff --git a/src/abbfreeathome/devices/movement_detector.py b/src/abbfreeathome/devices/movement_detector.py
@@ -27,6 +27,7 @@ def __init__(
         api: FreeAtHomeApi,
         floor_name: str | None = None,
         room_name: str | None = None,
+        virtual_device: bool = False,
     ) -> None:
         """Initialize the Free@Home SwitchActuator class."""
         self._state: bool | None = None
@@ -43,6 +44,7 @@ def __init__(
             api,
             floor_name,
             room_name,
+            virtual_device,
         )
 
     @property

diff --git a/src/abbfreeathome/devices/rain_sensor.py b/src/abbfreeathome/devices/rain_sensor.py
@@ -26,6 +26,7 @@ def __init__(
         api: FreeAtHomeApi,
         floor_name: str | None = None,
         room_name: str | None = None,
+        virtual_device: bool = False,
     ) -> None:
         """Initialize the Free@Home RainSensor class."""
         self._state: bool | None = None
@@ -41,6 +42,7 @@ def __init__(
             api,
             floor_name,
             room_name,
+            virtual_device,
         )
 
     @property

diff --git a/src/abbfreeathome/devices/room_temperature_controller.py b/src/abbfreeathome/devices/room_temperature_controller.py
@@ -30,6 +30,7 @@ def __init__(
         api: FreeAtHomeApi,
         floor_name: str | None = None,
         room_name: str | None = None,
+        virtual_device: bool = False,
     ) -> None:
         """Initialize the Free@Home RoomTemperatureController class."""
         self._state: bool | None = None
@@ -50,6 +51,7 @@ def __init__(
             api,
             floor_name,
             room_name,
+            virtual_device,
         )
 
     @property

diff --git a/src/abbfreeathome/devices/smoke_detector.py b/src/abbfreeathome/devices/smoke_detector.py
@@ -26,6 +26,7 @@ def __init__(
         api: FreeAtHomeApi,
         floor_name: str | None = None,
         room_name: str | None = None,
+        virtual_device: bool = False,
     ) -> None:
         """Initialize the Free@Home SmokeDetector class."""
         self._state: bool | None = None
@@ -41,6 +42,7 @@ def __init__(
             api,
             floor_name,
             room_name,
+            virtual_device,
         )
 
     @property

diff --git a/src/abbfreeathome/devices/switch_actuator.py b/src/abbfreeathome/devices/switch_actuator.py
@@ -37,6 +37,7 @@ def __init__(
         api: FreeAtHomeApi,
         floor_name: str | None = None,
         room_name: str | None = None,
+        virtual_device: bool = False,
     ) -> None:
         """Initialize the Free@Home SwitchActuator class."""
         self._state: bool | None = None
@@ -55,6 +56,7 @@ def __init__(
             api,
             floor_name,
             room_name,
+            virtual_device,
         )
 
     @property
@@ -93,6 +95,28 @@ async def set_forced_position(self, forced_position_name: str):
 
         self._forced_position = _position
 
+    async def _vd_acknowledgement(
+        self, datapoint_key: str, datapoint_value: str
+    ) -> bool:
+        _io_key = datapoint_key.split("/")[-1]
+
+        try:
+            _input = self._inputs[_io_key]
+        except KeyError:
+            return False
+
+        if _input.get("pairingID") == Pairing.AL_SWITCH_ON_OFF.value:
+            _switch_datapoint_id, _switch_datapoint_value = self.get_output_by_pairing(
+                pairing=Pairing.AL_INFO_ON_OFF
+            )
+            return await self._api.set_datapoint(
+                device_id=self.device_id,
+                channel_id=self.channel_id,
+                datapoint=_switch_datapoint_id,
+                value=datapoint_value,
+            )
+        return False
+
     def _refresh_state_from_output(self, output: dict[str, Any]) -> bool:
         """
         Refresh the state of the device from a given output.
@@ -114,13 +138,18 @@ def _refresh_state_from_output(self, output: dict[str, Any]) -> bool:
 
     async def _set_switching_datapoint(self, value: str):
         """Set the switching datapoint on the api."""
-        _switch_input_id, _switch_input_value = self.get_input_by_pairing(
-            pairing=Pairing.AL_SWITCH_ON_OFF
-        )
+        if self.virtual_device:
+            _switch_datapoint_id, _switch_datapoint_value = self.get_output_by_pairing(
+                pairing=Pairing.AL_INFO_ON_OFF
+            )
+        else:
+            _switch_datapoint_id, _switch_datapoint_value = self.get_input_by_pairing(
+                pairing=Pairing.AL_SWITCH_ON_OFF
+            )
         return await self._api.set_datapoint(
             device_id=self.device_id,
             channel_id=self.channel_id,
-            datapoint=_switch_input_id,
+            datapoint=_switch_datapoint_id,
             value=value,
         )
 

diff --git a/src/abbfreeathome/devices/switch_sensor.py b/src/abbfreeathome/devices/switch_sensor.py
@@ -46,6 +46,7 @@ def __init__(
         api: FreeAtHomeApi,
         floor_name: str | None = None,
         room_name: str | None = None,
+        virtual_device: bool = False,
     ) -> None:
         """Initialize the Free@Home SwitchSensor class."""
         self._state: SwitchSensorState | DimmingSensorState = SwitchSensorState.unknown
@@ -63,6 +64,7 @@ def __init__(
             api,
             floor_name,
             room_name,
+            virtual_device,
         )
 
     @property

diff --git a/src/abbfreeathome/devices/temperature_sensor.py b/src/abbfreeathome/devices/temperature_sensor.py
@@ -27,6 +27,7 @@ def __init__(
         api: FreeAtHomeApi,
         floor_name: str | None = None,
         room_name: str | None = None,
+        virtual_device: bool = False,
     ) -> None:
         """Initialize the Free@Home TemperatureSensor class."""
         self._state: float | None = None
@@ -43,6 +44,7 @@ def __init__(
             api,
             floor_name,
             room_name,
+            virtual_device,
         )
 
     @property

diff --git a/src/abbfreeathome/devices/trigger.py b/src/abbfreeathome/devices/trigger.py
@@ -25,6 +25,7 @@ def __init__(
         api: FreeAtHomeApi,
         floor_name: str | None = None,
         room_name: str | None = None,
+        virtual_device: bool = False,
     ) -> None:
         """Initialize the Free@Home Trigger class."""
         super().__init__(
@@ -38,6 +39,7 @@ def __init__(
             api,
             floor_name,
             room_name,
+            virtual_device,
         )
 
     async def press(self):

diff --git a/src/abbfreeathome/devices/wind_sensor.py b/src/abbfreeathome/devices/wind_sensor.py
@@ -28,6 +28,7 @@ def __init__(
         api: FreeAtHomeApi,
         floor_name: str | None = None,
         room_name: str | None = None,
+        virtual_device: bool = False,
     ) -> None:
         """Initialize the Free@Home WindSensor class."""
         self._state: float | None = None
@@ -45,6 +46,7 @@ def __init__(
             api,
             floor_name,
             room_name,
+            virtual_device,
         )
 
     @property