Add Teleinfo type input: base, hchp or tempo (automatic migration during upgrade)

Author: Aohzan

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 5.0.0
+
+- Add Tempo support
+- Add Teleinfo type input: `base`, `hchp` or `tempo` (automatic migration during upgrade)
+
 ## 4.8.0
 
 - Add divider factor for both meters to allow user to choose a compatible unit of measurement (example, m³ for gas instead of dm³ with a divider factor of 1000)

custom_components/ecodevices/__init__.py

@@ -22,11 +22,60 @@
 from homeassistant.helpers.aiohttp_client import async_get_clientsession
 from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
 
-from .const import CONTROLLER, COORDINATOR, DOMAIN, PLATFORMS, UNDO_UPDATE_LISTENER
+from .const import (
+    CONF_T1_ENABLED,
+    CONF_T1_TYPE,
+    CONF_T2_ENABLED,
+    CONF_T2_TYPE,
+    CONF_TI_TYPE_BASE,
+    CONF_TI_TYPE_HCHP,
+    CONTROLLER,
+    COORDINATOR,
+    DOMAIN,
+    PLATFORMS,
+    UNDO_UPDATE_LISTENER,
+)
 
 _LOGGER = logging.getLogger(__name__)
 
 
+async def async_migrate_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
+    """Migrate old config entry."""
+
+    if entry.version == 1:
+        _LOGGER.debug("Entry version %s needs migration", entry.version)
+        new_options = entry.options.copy()
+
+        t1_enabled = new_options.get(
+            CONF_T1_ENABLED, entry.data.get(CONF_T1_ENABLED, False)
+        )
+        t2_enabled = new_options.get(
+            CONF_T2_ENABLED, entry.data.get(CONF_T2_ENABLED, False)
+        )
+        t1_hchp = new_options.get("t1_hchp", entry.data.get("t1_hchp", False))
+        t2_hchp = new_options.get("t2_hchp", entry.data.get("t2_hchp", False))
+
+        if t1_enabled:
+            new_options[CONF_T1_TYPE] = (
+                CONF_TI_TYPE_HCHP if t1_hchp else CONF_TI_TYPE_BASE
+            )
+            _LOGGER.debug("Set T1 type to %s", new_options[CONF_T1_TYPE])
+        if t2_enabled:
+            new_options[CONF_T2_TYPE] = (
+                CONF_TI_TYPE_HCHP if t2_hchp else CONF_TI_TYPE_BASE
+            )
+            _LOGGER.debug("Set T2 type to %s", new_options[CONF_T2_TYPE])
+
+        entry.version = 2
+
+        hass.config_entries.async_update_entry(
+            entry, data=entry.data, options=new_options
+        )
+        _LOGGER.debug("Migration to version %s successful", entry.version)
+
+    return True
+
+
 async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     """Set up Eco-Devices from a config entry."""
     hass.data.setdefault(DOMAIN, {})

custom_components/ecodevices/config_flow.py

@@ -33,9 +33,11 @@
     CONF_C2_TOTAL_UNIT_OF_MEASUREMENT,
     CONF_C2_UNIT_OF_MEASUREMENT,
     CONF_T1_ENABLED,
-    CONF_T1_HCHP,
+    CONF_T1_TYPE,
     CONF_T2_ENABLED,
-    CONF_T2_HCHP,
+    CONF_T2_TYPE,
+    CONF_TI_TYPE_BASE,
+    CONF_TI_TYPES,
     DEFAULT_SCAN_INTERVAL,
     DOMAIN,
 )
@@ -59,7 +61,7 @@
 class EcoDevicesConfigFlow(ConfigFlow, domain=DOMAIN):
     """Handle a eco-devices config flow."""
 
-    VERSION = 1
+    VERSION = 2
 
     def __init__(self) -> None:
         """Initialize class variables."""
@@ -171,13 +173,13 @@ async def async_step_params(self, user_input=None) -> FlowResult:
         options = self.config_entry.options
 
         base_params = {
-            CONF_T1_HCHP: options.get(
-                CONF_T1_HCHP,
-                config.get(CONF_T1_HCHP, False),
+            CONF_T1_TYPE: options.get(
+                CONF_T1_TYPE,
+                config.get(CONF_T1_TYPE, False),
             ),
-            CONF_T2_HCHP: options.get(
-                CONF_T2_HCHP,
-                config.get(CONF_T2_HCHP, False),
+            CONF_T2_TYPE: options.get(
+                CONF_T2_TYPE,
+                config.get(CONF_T2_TYPE, False),
             ),
             CONF_C1_DEVICE_CLASS: options.get(
                 CONF_C1_DEVICE_CLASS, config.get(CONF_C1_DEVICE_CLASS)
@@ -240,19 +242,19 @@ def _get_params(base_input, base_params):
         params_schema.update(
             {
                 vol.Required(
-                    CONF_T1_HCHP,
-                    default=base_params.get(CONF_T1_HCHP, False),
-                ): bool,
+                    CONF_T1_TYPE,
+                    default=base_params.get(CONF_T1_TYPE, CONF_TI_TYPE_BASE),
+                ): vol.All(str, vol.Lower, vol.In(CONF_TI_TYPES)),
             }
         )
 
     if base_input[CONF_T2_ENABLED]:
         params_schema.update(
             {
                 vol.Required(
-                    CONF_T2_HCHP,
-                    default=base_params.get(CONF_T2_HCHP, False),
-                ): bool,
+                    CONF_T2_TYPE,
+                    default=base_params.get(CONF_T2_TYPE, CONF_TI_TYPE_BASE),
+                ): vol.All(str, vol.Lower, vol.In(CONF_TI_TYPES)),
             }
         )
 

custom_components/ecodevices/const.py

@@ -7,9 +7,9 @@
 UNDO_UPDATE_LISTENER = "undo_update_listener"
 
 CONF_T1_ENABLED = "t1_enabled"
-CONF_T1_HCHP = "t1_hchp"
+CONF_T1_TYPE = "t1_type"
 CONF_T2_ENABLED = "t2_enabled"
-CONF_T2_HCHP = "t2_hchp"
+CONF_T2_TYPE = "t2_type"
 CONF_C1_ENABLED = "c1_enabled"
 CONF_C1_UNIT_OF_MEASUREMENT = "c1_unit_of_measurement"
 CONF_C1_DIVIDER_FACTOR = "c1_divider_factor"
@@ -27,6 +27,15 @@
 DEFAULT_C2_NAME = "Meter 2"
 DEFAULT_SCAN_INTERVAL = 5
 
+CONF_TI_TYPE_BASE = "base"
+CONF_TI_TYPE_HCHP = "hchp"
+CONF_TI_TYPE_TEMPO = "tempo"
+CONF_TI_TYPES = [
+    CONF_TI_TYPE_BASE,
+    CONF_TI_TYPE_HCHP,
+    CONF_TI_TYPE_TEMPO,
+]
+
 TELEINFO_EXTRA_ATTR = {
     "type_heures": "PTEC",
     "souscription": "ISOUSC",
@@ -62,3 +71,11 @@
     "index_heures_pleines_jour_rouge": "BBRHPJR",
     "type_heures_demain": "DEMAIN",
 }
+TELEINFO_TEMPO_ATTR = {
+    "Jour Bleu HC": "BBRHCJB",
+    "Jour Bleu HP": "BBRHPJB",
+    "Jour Blanc HC": "BBRHCJW",
+    "Jour Blanc HP": "BBRHPJW",
+    "Jour Rouge HC": "BBRHCJR",
+    "Jour Rouge HP": "BBRHPJR",
+}

custom_components/ecodevices/sensor.py

@@ -29,9 +29,12 @@
     CONF_C2_TOTAL_UNIT_OF_MEASUREMENT,
     CONF_C2_UNIT_OF_MEASUREMENT,
     CONF_T1_ENABLED,
-    CONF_T1_HCHP,
+    CONF_T1_TYPE,
     CONF_T2_ENABLED,
-    CONF_T2_HCHP,
+    CONF_T2_TYPE,
+    CONF_TI_TYPE_BASE,
+    CONF_TI_TYPE_HCHP,
+    CONF_TI_TYPE_TEMPO,
     CONTROLLER,
     COORDINATOR,
     DEFAULT_C1_NAME,
@@ -40,6 +43,7 @@
     DEFAULT_T2_NAME,
     DOMAIN,
     TELEINFO_EXTRA_ATTR,
+    TELEINFO_TEMPO_ATTR,
 )
 
 _LOGGER = logging.getLogger(__name__)
@@ -56,9 +60,9 @@ async def async_setup_entry(
     options = entry.options
 
     t1_enabled = options.get(CONF_T1_ENABLED, config.get(CONF_T1_ENABLED))
-    t1_hchp = options.get(CONF_T1_HCHP, config.get(CONF_T1_HCHP))
+    t1_type = options.get(CONF_T1_TYPE, config.get(CONF_T1_TYPE))
     t2_enabled = options.get(CONF_T2_ENABLED, config.get(CONF_T2_ENABLED))
-    t2_hchp = options.get(CONF_T2_HCHP, config.get(CONF_T2_HCHP))
+    t2_type = options.get(CONF_T2_TYPE, config.get(CONF_T2_TYPE))
     c1_enabled = options.get(CONF_C1_ENABLED, config.get(CONF_C1_ENABLED))
     c2_enabled = options.get(CONF_C2_ENABLED, config.get(CONF_C2_ENABLED))
 
@@ -79,7 +83,21 @@ async def async_setup_entry(
                 icon="mdi:flash",
             )
         )
-        if t1_hchp:
+        if t1_type == CONF_TI_TYPE_BASE:
+            entities.append(
+                TeleinfoInputTotalEdDevice(
+                    controller,
+                    coordinator,
+                    input_number=1,
+                    input_name="t1_total",
+                    name=DEFAULT_T1_NAME + " Total",
+                    unit=UnitOfEnergy.WATT_HOUR,
+                    device_class=SensorDeviceClass.ENERGY,
+                    state_class=SensorStateClass.TOTAL_INCREASING,
+                    icon="mdi:meter-electric",
+                )
+            )
+        elif t1_type == CONF_TI_TYPE_HCHP:
             entities.append(
                 TeleinfoInputTotalHchpEdDevice(
                     controller,
@@ -119,9 +137,9 @@ async def async_setup_entry(
                     icon="mdi:meter-electric",
                 )
             )
-        else:
+        elif t1_type == CONF_TI_TYPE_TEMPO:
             entities.append(
-                TeleinfoInputTotalEdDevice(
+                TeleinfoInputTotalTempoEdDevice(
                     controller,
                     coordinator,
                     input_number=1,
@@ -133,6 +151,20 @@ async def async_setup_entry(
                     icon="mdi:meter-electric",
                 )
             )
+            for desc, key in TELEINFO_TEMPO_ATTR.items():
+                entities.append(
+                    TeleinfoInputTempoEdDevice(
+                        controller,
+                        coordinator,
+                        input_number=1,
+                        input_name=f"t1_{key}",
+                        name=DEFAULT_T1_NAME + " " + desc + " Total",
+                        unit=UnitOfEnergy.WATT_HOUR,
+                        device_class=SensorDeviceClass.ENERGY,
+                        state_class=SensorStateClass.TOTAL_INCREASING,
+                        icon="mdi:meter-electric",
+                    )
+                )
     if t2_enabled:
         _LOGGER.debug("Add the teleinfo 2 entities")
         entities.append(
@@ -148,7 +180,21 @@ async def async_setup_entry(
                 icon="mdi:flash",
             )
         )
-        if t2_hchp:
+        if t2_type == CONF_TI_TYPE_BASE:
+            entities.append(
+                TeleinfoInputTotalEdDevice(
+                    controller,
+                    coordinator,
+                    input_number=2,
+                    input_name="t2_total",
+                    name=DEFAULT_T2_NAME + " Total",
+                    unit=UnitOfEnergy.WATT_HOUR,
+                    device_class=SensorDeviceClass.ENERGY,
+                    state_class=SensorStateClass.TOTAL_INCREASING,
+                    icon="mdi:meter-electric",
+                )
+            )
+        elif t2_type == CONF_TI_TYPE_HCHP:
             entities.append(
                 TeleinfoInputTotalHchpEdDevice(
                     controller,
@@ -188,9 +234,9 @@ async def async_setup_entry(
                     icon="mdi:meter-electric",
                 )
             )
-        else:
+        elif t2_type == CONF_TI_TYPE_TEMPO:
             entities.append(
-                TeleinfoInputTotalEdDevice(
+                TeleinfoInputTotalTempoEdDevice(
                     controller,
                     coordinator,
                     input_number=2,
@@ -202,6 +248,20 @@ async def async_setup_entry(
                     icon="mdi:meter-electric",
                 )
             )
+            for desc, key in TELEINFO_TEMPO_ATTR.items():
+                entities.append(
+                    TeleinfoInputTempoEdDevice(
+                        controller,
+                        coordinator,
+                        input_number=2,
+                        input_name=f"t2_{key}",
+                        name=DEFAULT_T2_NAME + " " + desc + " Total",
+                        unit=UnitOfEnergy.WATT_HOUR,
+                        device_class=SensorDeviceClass.ENERGY,
+                        state_class=SensorStateClass.TOTAL_INCREASING,
+                        icon="mdi:meter-electric",
+                    )
+                )
     if c1_enabled:
         _LOGGER.debug("Add the Meter 1 - entities")
         entities.append(
@@ -484,6 +544,39 @@ def native_value(self) -> float | None:
         return None
 
 
+class TeleinfoInputTotalTempoEdDevice(EdDevice):
+    """Initialize the Teleinfo Input Tempo Total sensor."""
+
+    @property
+    def native_value(self) -> float | None:
+        """Return the total value if it's greater than 0."""
+        value = 0.0
+        for key in TELEINFO_TEMPO_ATTR.values():
+            value += float(self.coordinator.data[f"T{self._input_number}_{key}"])
+        if value > 0:
+            return value
+        _LOGGER.warning(
+            "Total value for Teleinfo Input %s not greater than 0, ignore",
+            self._input_number,
+        )
+        return None
+
+
+class TeleinfoInputTempoEdDevice(EdDevice):
+    """Initialize the Teleinfo Input Tempo sensor."""
+
+    @property
+    def native_value(self) -> float | None:
+        """Return the total value if it's greater than 0."""
+        if (value := float(self.coordinator.data[self._input_name.upper()])) > 0:
+            return value
+        _LOGGER.warning(
+            "Total value for Teleinfo Input %s not greater than 0, ignore",
+            self._input_number,
+        )
+        return None
+
+
 class MeterInputEdDevice(EdDevice):
     """Initialize the meter input sensor."""
 

custom_components/ecodevices/strings.json

@@ -19,8 +19,8 @@
       "params": {
         "title": "Parameters of Eco-Devices entities",
         "data": {
-          "t1_hchp": "Teleinfo 1 - HC/HP enabled",
-          "t2_hchp": "Teleinfo 2 - HC/HP enabled",
+          "t1_type": "Teleinfo 1 - Rate type (Base, HC/HP or Tempo)",
+          "t2_type": "Teleinfo 2 - Rate type (Base, HC/HP or Tempo)",
           "c1_device_class": "Meter 1 - Device Class (sensor)",
           "c1_unit_of_measurement": "Meter 1 - Unit of measurement for current and daily values",
           "c1_total_unit_of_measurement": "Meter 1 - Unit of measurement for total value",
@@ -59,8 +59,8 @@
       "params": {
         "title": "Parameters of Eco-Devices entities",
         "data": {
-          "t1_hchp": "Teleinfo 1 - HC/HP enabled",
-          "t2_hchp": "Teleinfo 2 - HC/HP enabled",
+          "t1_type": "Teleinfo 1 - Rate type (Base, HC/HP or Tempo)",
+          "t2_type": "Teleinfo 2 - Rate type (Base, HC/HP or Tempo)",
           "c1_device_class": "Meter 1 - Device Class (sensor)",
           "c1_unit_of_measurement": "Meter 1 - Unit of measurement for current and daily values",
           "c1_total_unit_of_measurement": "Meter 1 - Unit of measurement for total value",