Add sensors

custom_components/versatile_thermostat/__init__.py

@@ -15,7 +15,7 @@ from .const import DOMAIN
 
 _LOGGER = logging.getLogger(__name__)
 
-PLATFORMS: list[Platform] = [Platform.CLIMATE, Platform.BINARY_SENSOR]
+PLATFORMS: list[Platform] = [Platform.CLIMATE, Platform.BINARY_SENSOR, Platform.SENSOR]
 
 
 async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:

custom_components/versatile_thermostat/climate.py

@@ -1050,6 +1050,21 @@ class VersatileThermostat(ClimateEntity, RestoreEntity):
         """Get the presence_state"""
         return self._presence_state
 
+    @property
+    def proportional_algorithm(self) -> PropAlgorithm | None:
+        """Get the eventual ProportionalAlgorithm"""
+        return self._prop_algorithm
+
+    @property
+    def last_temperature_mesure(self) -> datetime | None:
+        """Get the last temperature datetime"""
+        return self._last_temperature_mesure
+
+    @property
+    def last_ext_temperature_mesure(self) -> datetime | None:
+        """Get the last external temperature datetime"""
+        return self._last_ext_temperature_mesure
+
     def turn_aux_heat_on(self) -> None:
         """Turn auxiliary heater on."""
         if self._is_over_climate and self._underlying_climate:

custom_components/versatile_thermostat/sensor.py

@@ -0,0 +1,273 @@
+""" Implements the VersatileThermostat sensors component """
+import logging
+import math
+
+from homeassistant.core import HomeAssistant, callback, Event
+
+from homeassistant.const import STATE_ON
+
+from homeassistant.components.sensor import SensorEntity
+from homeassistant.components.sensor.const import SensorDeviceClass, SensorStateClass
+from homeassistant.config_entries import ConfigEntry
+
+from homeassistant.helpers.entity_platform import AddEntitiesCallback
+
+from .commons import VersatileThermostatBaseEntity
+from .const import (
+    CONF_NAME,
+    CONF_USE_POWER_FEATURE,
+    CONF_USE_PRESENCE_FEATURE,
+    CONF_USE_MOTION_FEATURE,
+    CONF_USE_WINDOW_FEATURE,
+    CONF_DEVICE_POWER,
+    CONF_PROP_FUNCTION,
+    PROPORTIONAL_FUNCTION_TPI,
+    CONF_THERMOSTAT_SWITCH,
+    CONF_THERMOSTAT_TYPE,
+)
+
+_LOGGER = logging.getLogger(__name__)
+
+
+async def async_setup_entry(
+    hass: HomeAssistant,
+    entry: ConfigEntry,
+    async_add_entities: AddEntitiesCallback,
+) -> None:
+    """Set up the VersatileThermostat sensors with config flow."""
+    _LOGGER.debug(
+        "Calling async_setup_entry entry=%s, data=%s", entry.entry_id, entry.data
+    )
+
+    unique_id = entry.entry_id
+    name = entry.data.get(CONF_NAME)
+
+    entities = [
+        LastTemperatureSensor(hass, unique_id, name, entry.data),
+        LastExtTemperatureSensor(hass, unique_id, name, entry.data),
+    ]
+    if entry.data.get(CONF_DEVICE_POWER):
+        entities.append(EnergySensor(hass, unique_id, name, entry.data))
+        if entry.data.get(CONF_THERMOSTAT_TYPE) == CONF_THERMOSTAT_SWITCH:
+            entities.append(MeanPowerSensor(hass, unique_id, name, entry.data))
+
+    if entry.data.get(CONF_PROP_FUNCTION) == PROPORTIONAL_FUNCTION_TPI:
+        entities.append(OnPercentSensor(hass, unique_id, name, entry.data))
+    # if entry.data.get(CONF_USE_WINDOW_FEATURE):
+    #     entities.append(WindowBinarySensor(hass, unique_id, name, entry.data))
+    # if entry.data.get(CONF_USE_PRESENCE_FEATURE):
+    #     entities.append(PresenceBinarySensor(hass, unique_id, name, entry.data))
+    # if entry.data.get(CONF_USE_POWER_FEATURE):
+    #     entities.append(OverpoweringBinarySensor(hass, unique_id, name, entry.data))
+
+    async_add_entities(entities, True)
+
+
+class EnergySensor(VersatileThermostatBaseEntity, SensorEntity):
+    """Representation of a Energy sensor which exposes the energy"""
+
+    def __init__(self, hass: HomeAssistant, unique_id, name, entry_infos) -> None:
+        """Initialize the energy sensor"""
+        super().__init__(hass, unique_id, entry_infos.get(CONF_NAME))
+        self._attr_name = "Energy"
+        self._attr_unique_id = f"{self._device_name}_energy"
+
+    @callback
+    async def async_my_climate_changed(self, event: Event):
+        """Called when my climate have change"""
+        _LOGGER.debug("%s - climate state change", event.origin.name)
+
+        if math.isnan(self.my_climate.total_energy) or math.isinf(
+            self.my_climate.total_energy
+        ):
+            raise ValueError(f"Sensor has illegal state {self.my_climate.total_energy}")
+
+        old_state = self._attr_native_value
+        self._attr_native_value = round(
+            self.my_climate.total_energy, self.suggested_display_precision
+        )
+        if old_state != self._attr_native_value:
+            self.async_write_ha_state()
+        return
+
+    @property
+    def icon(self) -> str | None:
+        return "mdi:lightning-bolt"
+
+    @property
+    def device_class(self) -> SensorDeviceClass | None:
+        return SensorDeviceClass.ENERGY
+
+    @property
+    def state_class(self) -> SensorStateClass | None:
+        return SensorStateClass.TOTAL_INCREASING
+
+    @property
+    def native_unit_of_measurement(self) -> str | None:
+        return "kWh"
+
+    @property
+    def suggested_display_precision(self) -> int | None:
+        """Return the suggested number of decimal digits for display."""
+        return 3
+
+
+class MeanPowerSensor(VersatileThermostatBaseEntity, SensorEntity):
+    """Representation of a power sensor which exposes the mean power in a cycle"""
+
+    def __init__(self, hass: HomeAssistant, unique_id, name, entry_infos) -> None:
+        """Initialize the energy sensor"""
+        super().__init__(hass, unique_id, entry_infos.get(CONF_NAME))
+        self._attr_name = "Mean power cycle"
+        self._attr_unique_id = f"{self._device_name}_mean_power_cycle"
+
+    @callback
+    async def async_my_climate_changed(self, event: Event):
+        """Called when my climate have change"""
+        _LOGGER.debug("%s - climate state change", event.origin.name)
+
+        if math.isnan(float(self.my_climate.mean_cycle_power)) or math.isinf(
+            self.my_climate.mean_cycle_power
+        ):
+            raise ValueError(
+                f"Sensor has illegal state {self.my_climate.mean_cycle_power}"
+            )
+
+        old_state = self._attr_native_value
+        self._attr_native_value = round(
+            self.my_climate.mean_cycle_power, self.suggested_display_precision
+        )
+        if old_state != self._attr_native_value:
+            self.async_write_ha_state()
+        return
+
+    @property
+    def icon(self) -> str | None:
+        return "mdi:flash-outline"
+
+    @property
+    def device_class(self) -> SensorDeviceClass | None:
+        return SensorDeviceClass.POWER
+
+    @property
+    def state_class(self) -> SensorStateClass | None:
+        return SensorStateClass.MEASUREMENT
+
+    @property
+    def native_unit_of_measurement(self) -> str | None:
+        return "kW"
+
+    @property
+    def suggested_display_precision(self) -> int | None:
+        """Return the suggested number of decimal digits for display."""
+        return 3
+
+
+class OnPercentSensor(VersatileThermostatBaseEntity, SensorEntity):
+    """Representation of a on percent sensor which exposes the on_percent in a cycle"""
+
+    def __init__(self, hass: HomeAssistant, unique_id, name, entry_infos) -> None:
+        """Initialize the energy sensor"""
+        super().__init__(hass, unique_id, entry_infos.get(CONF_NAME))
+        self._attr_name = "Power percent"
+        self._attr_unique_id = f"{self._device_name}_power_percent"
+
+    @callback
+    async def async_my_climate_changed(self, event: Event):
+        """Called when my climate have change"""
+        _LOGGER.debug("%s - climate state change", event.origin.name)
+
+        on_percent = (
+            float(self.my_climate.proportional_algorithm.on_percent)
+            if self.my_climate and self.my_climate.proportional_algorithm
+            else None
+        )
+        if math.isnan(on_percent) or math.isinf(on_percent):
+            raise ValueError(f"Sensor has illegal state {on_percent}")
+
+        old_state = self._attr_native_value
+        self._attr_native_value = round(
+            on_percent * 100.0, self.suggested_display_precision
+        )
+        if old_state != self._attr_native_value:
+            self.async_write_ha_state()
+        return
+
+    @property
+    def icon(self) -> str | None:
+        return "mdi:meter-electric-outline"
+
+    @property
+    def device_class(self) -> SensorDeviceClass | None:
+        return SensorDeviceClass.POWER_FACTOR
+
+    @property
+    def state_class(self) -> SensorStateClass | None:
+        return SensorStateClass.MEASUREMENT
+
+    @property
+    def native_unit_of_measurement(self) -> str | None:
+        return "%"
+
+    @property
+    def suggested_display_precision(self) -> int | None:
+        """Return the suggested number of decimal digits for display."""
+        return 1
+
+
+class LastTemperatureSensor(VersatileThermostatBaseEntity, SensorEntity):
+    """Representation of a last temperature datetime sensor"""
+
+    def __init__(self, hass: HomeAssistant, unique_id, name, entry_infos) -> None:
+        """Initialize the last temperature datetime sensor"""
+        super().__init__(hass, unique_id, entry_infos.get(CONF_NAME))
+        self._attr_name = "Last temperature date"
+        self._attr_unique_id = f"{self._device_name}_last_temp_datetime"
+
+    @callback
+    async def async_my_climate_changed(self, event: Event):
+        """Called when my climate have change"""
+        _LOGGER.debug("%s - climate state change", event.origin.name)
+
+        old_state = self._attr_native_value
+        self._attr_native_value = self.my_climate.last_temperature_mesure
+        if old_state != self._attr_native_value:
+            self.async_write_ha_state()
+        return
+
+    @property
+    def icon(self) -> str | None:
+        return "mdi:home-clock"
+
+    @property
+    def device_class(self) -> SensorDeviceClass | None:
+        return SensorDeviceClass.TIMESTAMP
+
+
+class LastExtTemperatureSensor(VersatileThermostatBaseEntity, SensorEntity):
+    """Representation of a last external temperature datetime sensor"""
+
+    def __init__(self, hass: HomeAssistant, unique_id, name, entry_infos) -> None:
+        """Initialize the last temperature datetime sensor"""
+        super().__init__(hass, unique_id, entry_infos.get(CONF_NAME))
+        self._attr_name = "Last external temperature date"
+        self._attr_unique_id = f"{self._device_name}_last_ext_temp_datetime"
+
+    @callback
+    async def async_my_climate_changed(self, event: Event):
+        """Called when my climate have change"""
+        _LOGGER.debug("%s - climate state change", event.origin.name)
+
+        old_state = self._attr_native_value
+        self._attr_native_value = self.my_climate.last_ext_temperature_mesure
+        if old_state != self._attr_native_value:
+            self.async_write_ha_state()
+        return
+
+    @property
+    def icon(self) -> str | None:
+        return "mdi:sun-clock"
+
+    @property
+    def device_class(self) -> SensorDeviceClass | None:
+        return SensorDeviceClass.TIMESTAMP