always_callback for NumericValue and RawValue (#789)

Author: farmio

changelog.md

@@ -2,7 +2,9 @@
 
 ## Unreleased changes
 
-### Internals
+### Devices
+
+- Added `always_callback` option to NumericValue and RawValue
 
 ## 0.18.11 Task Registry 2021-10-16
 

docs/numeric_value.md

@@ -20,6 +20,7 @@ NumericValue devices send values to the KNX bus. Received values update the devi
 - `respond_to_read` if `True` GroupValueRead requests to the `group_address` are answered. Defaults to `False`
 - `sync_state` defines if and how often the value should be actively read from the bus. If `False` no GroupValueRead telegrams will be sent to its group address. Defaults to `True`
 - `value_type` controls how the value should be encoded / decoded. The attribut may have may have parseable value types representing numeric values.
+- `always_callback` defines if a callback shall be triggered for consecutive GroupValueWrite telegrams with same payload. Defaults to `False`
 - `device_updated_cb` awaitable callback for each update.
 
 ## [](#header-2)Example

docs/raw_value.md

@@ -20,6 +20,7 @@ RawValue devices send uint values to the KNX bus. Received values update the dev
 - `group_address_state` is the KNX group address of the raw value device.
 - `respond_to_read` if `True` GroupValueRead requests to the `group_address` are answered. Defaults to `False`
 - `sync_state` defines if and how often the value should be actively read from the bus. If `False` no GroupValueRead telegrams will be sent to its group address. Defaults to `True`
+- `always_callback` defines if a callback shall be triggered for consecutive GroupValueWrite telegrams with same payload. Defaults to `False`
 - `device_updated_cb` awaitable callback for each update.
 
 ## [](#header-2)Example

docs/sensor.md

@@ -13,13 +13,13 @@ Sensors are monitoring temperature, air humidity, pressure etc. from KNX bus.
 
 ## [](#header-2)Interface
 
-* `xknx` is the XKNX object.
-* `name` is the name of the object.
-* `group_address_state` is the KNX group address of the sensor device.
-* `sync_state` defines if the value should be actively read from the bus. If `False` no GroupValueRead telegrams will be sent to its group address. Defaults to `True`
-* `always_callback` defines if a callback/update should always be triggered no matter if the previous and the new state are identical.
-* `value_type` controls how the value should be rendered in a human readable representation. The attribut may have may have the values `percent`, `temperature`, `illuminance`, `speed_ms` or `current`.
-* `device_updated_cb` awaitable callback for each update.
+- `xknx` is the XKNX object.
+- `name` is the name of the object.
+- `group_address_state` is the KNX group address of the sensor device.
+- `sync_state` defines if the value should be actively read from the bus. If `False` no GroupValueRead telegrams will be sent to its group address. Defaults to `True`
+- `always_callback` defines if a callback shall be triggered for consecutive GroupValueWrite telegrams with same payload. Defaults to `False`
+- `value_type` controls how the value should be rendered in a human readable representation. The attribut may have may have the values `percent`, `temperature`, `illuminance`, `speed_ms` or `current`.
+- `device_updated_cb` awaitable callback for each update.
 
 ## [](#header-2)Example
 

test/devices_tests/numeric_value_test.py

@@ -256,6 +256,36 @@ async def test_process_callback(self):
         await sensor.process(telegram)
         after_update_callback.assert_called_with(sensor)
         assert sensor.last_telegram == telegram
+        # consecutive telegrams with same payload shall only trigger one callback
+        after_update_callback.reset_mock()
+        await sensor.process(telegram)
+        after_update_callback.assert_not_called()
+
+    async def test_process_callback_always(self):
+        """Test process / reading telegrams from telegram queue. Test if callback is called."""
+
+        xknx = XKNX()
+        sensor = NumericValue(
+            xknx,
+            "TestSensor",
+            group_address="1/2/3",
+            value_type="temperature",
+            always_callback=True,
+        )
+        after_update_callback = AsyncMock()
+        sensor.register_device_updated_cb(after_update_callback)
+
+        telegram = Telegram(
+            destination_address=GroupAddress("1/2/3"),
+            payload=GroupValueWrite(DPTArray((0x01, 0x02))),
+        )
+        await sensor.process(telegram)
+        after_update_callback.assert_called_with(sensor)
+        assert sensor.last_telegram == telegram
+        # every telegram shall trigger callback
+        after_update_callback.reset_mock()
+        await sensor.process(telegram)
+        after_update_callback.assert_called_with(sensor)
 
     async def test_process_callback_set(self):
         """Test setting value. Test if callback is called."""

test/devices_tests/raw_value_test.py

@@ -1,4 +1,6 @@
 """Unit test for RawValue objects."""
+from unittest.mock import AsyncMock
+
 import pytest
 from xknx import XKNX
 from xknx.devices import RawValue
@@ -137,6 +139,61 @@ async def test_respond_to_read(self):
         )
         assert xknx.telegrams.qsize() == 0
 
+    #
+    # TEST PROCESS CALLBACK
+    #
+
+    async def test_process_callback(self):
+        """Test process / reading telegrams from telegram queue. Test if callback is called."""
+
+        xknx = XKNX()
+        sensor = RawValue(
+            xknx,
+            "TestSensor",
+            2,
+            group_address="1/2/3",
+        )
+        after_update_callback = AsyncMock()
+        sensor.register_device_updated_cb(after_update_callback)
+
+        telegram = Telegram(
+            destination_address=GroupAddress("1/2/3"),
+            payload=GroupValueWrite(DPTArray((0x01, 0x02))),
+        )
+        await sensor.process(telegram)
+        after_update_callback.assert_called_with(sensor)
+        assert sensor.last_telegram == telegram
+        # consecutive telegrams with same payload shall only trigger one callback
+        after_update_callback.reset_mock()
+        await sensor.process(telegram)
+        after_update_callback.assert_not_called()
+
+    async def test_process_callback_always(self):
+        """Test process / reading telegrams from telegram queue. Test if callback is called."""
+
+        xknx = XKNX()
+        sensor = RawValue(
+            xknx,
+            "TestSensor",
+            2,
+            group_address="1/2/3",
+            always_callback=True,
+        )
+        after_update_callback = AsyncMock()
+        sensor.register_device_updated_cb(after_update_callback)
+
+        telegram = Telegram(
+            destination_address=GroupAddress("1/2/3"),
+            payload=GroupValueWrite(DPTArray((0x01, 0x02))),
+        )
+        await sensor.process(telegram)
+        after_update_callback.assert_called_with(sensor)
+        assert sensor.last_telegram == telegram
+        # every telegram shall trigger callback
+        after_update_callback.reset_mock()
+        await sensor.process(telegram)
+        after_update_callback.assert_called_with(sensor)
+
     #
     # TEST SET
     #

xknx/devices/numeric_value.py

@@ -32,10 +32,12 @@ def __init__(
         respond_to_read: bool = False,
         sync_state: bool | int | float | str = True,
         value_type: int | str | None = None,
+        always_callback: bool = False,
         device_updated_cb: DeviceCallbackType | None = None,
     ):
         """Initialize Sensor class."""
         super().__init__(xknx, name, device_updated_cb)
+        self.always_callback = always_callback
         self.respond_to_read = respond_to_read
         self.sensor_value = RemoteValueNumeric(
             xknx,
@@ -58,7 +60,7 @@ def last_telegram(self) -> Telegram | None:
 
     async def process_group_write(self, telegram: "Telegram") -> None:
         """Process incoming and outgoing GROUP WRITE telegram."""
-        await self.sensor_value.process(telegram)
+        await self.sensor_value.process(telegram, always_callback=self.always_callback)
 
     async def process_group_read(self, telegram: "Telegram") -> None:
         """Process incoming GroupValueResponse telegrams."""

xknx/devices/raw_value.py

@@ -32,10 +32,12 @@ def __init__(
         group_address_state: GroupAddressesType | None = None,
         respond_to_read: bool = False,
         sync_state: bool | int | float | str = True,
+        always_callback: bool = False,
         device_updated_cb: DeviceCallbackType | None = None,
     ):
         """Initialize Sensor class."""
         super().__init__(xknx, name, device_updated_cb)
+        self.always_callback = always_callback
         self.respond_to_read = respond_to_read
         self.remote_value = RemoteValueRaw(
             xknx,
@@ -58,7 +60,7 @@ def last_telegram(self) -> Telegram | None:
 
     async def process_group_write(self, telegram: "Telegram") -> None:
         """Process incoming and outgoing GROUP WRITE telegram."""
-        await self.remote_value.process(telegram)
+        await self.remote_value.process(telegram, always_callback=self.always_callback)
 
     async def process_group_read(self, telegram: "Telegram") -> None:
         """Process incoming GroupValueResponse telegrams."""