Merge 4be04b4 into e0c956c

docs/sensor.md

@@ -20,6 +20,7 @@ Sensors are monitoring temperature, air humidity, pressure etc. from KNX bus.
 * `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.
+* `value_template` may be used to modify the state of the sensor in Home-Assistant (e.g. rounding or adding an offset; see [template documentation](https://www.home-assistant.io/docs/configuration/templating) for details).
 
 ## [](#header-2)Example
 

home-assistant-plugin/custom_components/xknx/factory.py

@@ -290,6 +290,7 @@ def _create_sensor(knx_module: XKNX, config: ConfigType) -> XknxSensor:
         sync_state=config[SensorSchema.CONF_SYNC_STATE],
         always_callback=config[SensorSchema.CONF_ALWAYS_CALLBACK],
         value_type=config[CONF_TYPE],
+        value_template=config.get(SensorSchema.CONF_VALUE_TEMPLATE),
     )
 
 

home-assistant-plugin/custom_components/xknx/schema.py

@@ -11,6 +11,7 @@
     CONF_NAME,
     CONF_PORT,
     CONF_TYPE,
+    CONF_VALUE_TEMPLATE,
 )
 import homeassistant.helpers.config_validation as cv
 
@@ -361,6 +362,7 @@ class SensorSchema:
     CONF_ALWAYS_CALLBACK = "always_callback"
     CONF_STATE_ADDRESS = CONF_STATE_ADDRESS
     CONF_SYNC_STATE = CONF_SYNC_STATE
+    CONF_VALUE_TEMPLATE = CONF_VALUE_TEMPLATE
     DEFAULT_NAME = "KNX Sensor"
 
     SCHEMA = vol.Schema(
@@ -374,6 +376,7 @@ class SensorSchema:
             vol.Optional(CONF_ALWAYS_CALLBACK, default=False): cv.boolean,
             vol.Required(CONF_STATE_ADDRESS): cv.string,
             vol.Required(CONF_TYPE): vol.Any(int, float, str),
+            vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
         }
     )
 

home-assistant-plugin/custom_components/xknx/sensor.py

@@ -2,6 +2,7 @@
 from xknx.devices import Sensor as XknxSensor
 
 from homeassistant.components.sensor import DEVICE_CLASSES
+from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity import Entity
 
 from .const import DOMAIN
@@ -13,21 +14,27 @@ async def async_setup_platform(hass, config, async_add_entities, discovery_info=
     entities = []
     for device in hass.data[DOMAIN].xknx.devices:
         if isinstance(device, XknxSensor):
-            entities.append(KNXSensor(device))
+            entities.append(KNXSensor(device, hass))
     async_add_entities(entities)
 
 
 class KNXSensor(KnxEntity, Entity):
     """Representation of a KNX sensor."""
 
-    def __init__(self, device: XknxSensor):
+    def __init__(self, device: XknxSensor, hass: HomeAssistant):
         """Initialize of a KNX sensor."""
+        if device.value_template is not None:
+            device.value_template.hass = hass
         super().__init__(device)
 
     @property
     def state(self):
         """Return the state of the sensor."""
-        return self._device.resolve_state()
+        state = self._device.resolve_state()
+        template = self._device.value_template
+        if template is not None and state is not None:
+            state = template.async_render({"value": state})
+        return state
 
     @property
     def unit_of_measurement(self) -> str:

test/config_tests/config_v1_test.py

@@ -523,6 +523,7 @@ def test_config_sensor_temperature_type(self):
                 "Kitchen.Temperature",
                 group_address_state="2/0/2",
                 value_type="temperature",
+                value_template="{{  value | round(0) }}",
             ),
         )
 

xknx.yaml

@@ -273,6 +273,7 @@ groups:
                 group_address_state: "2/0/2",
                 value_type: "temperature",
                 sync_state: True,
+                value_template: "{{  value | round(0) }}",
             }
 
     expose_sensor:

xknx/devices/sensor.py

@@ -30,6 +30,7 @@ def __init__(
         sync_state: bool = True,
         always_callback: bool = False,
         value_type: Optional[str] = None,
+        value_template: Optional[str] = None,
         device_updated_cb: Optional[DeviceCallbackType] = None,
     ):
         """Initialize Sensor class."""
@@ -61,6 +62,7 @@ def __init__(
                 after_update_cb=self.after_update,
             )
         self.always_callback = always_callback
+        self.value_template = value_template
 
     def _iter_remote_values(self) -> Iterator["RemoteValue[Any]"]:
         """Iterate the devices RemoteValue classes."""
@@ -73,6 +75,7 @@ def from_config(cls, xknx: "XKNX", name: str, config: Any) -> "Sensor":
         sync_state = config.get("sync_state", True)
         always_callback = config.get("always_callback", False)
         value_type = config.get("value_type")
+        value_template = config.get("value_template")
 
         return cls(
             xknx,
@@ -81,6 +84,7 @@ def from_config(cls, xknx: "XKNX", name: str, config: Any) -> "Sensor":
             sync_state=sync_state,
             always_callback=always_callback,
             value_type=value_type,
+            value_template=value_template,
         )
 
     async def process_group_write(self, telegram: "Telegram") -> None: