cleaning + perdiodic (re)login (#201)

Author: thomasgermain

custom_components/multimatic/__init__.py

@@ -1,22 +1,27 @@
 """The multimatic integration."""
 import asyncio
-from datetime import timedelta
+from datetime import datetime, timedelta
 import logging
 
+from pymultimatic.api import ApiError, defaults
+
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import CONF_SCAN_INTERVAL, EVENT_HOMEASSISTANT_STOP
 from homeassistant.core import HomeAssistant
+from homeassistant.helpers.event import async_track_time_interval
 from homeassistant.helpers.typing import ConfigType
-from pymultimatic.api import defaults
 
 from .const import (
+    CONF_APPLICATION,
     CONF_SERIAL_NUMBER,
     COORDINATOR_LIST,
     COORDINATORS,
     DEFAULT_SCAN_INTERVAL,
     DOMAIN,
+    FORCE_RELOGIN_TIMEDELTA,
     PLATFORMS,
-    SERVICES_HANDLER, CONF_APPLICATION,
+    RELOGIN_TASK_CLEAN,
+    SERVICES_HANDLER,
 )
 from .coordinator import MultimaticApi, MultimaticCoordinator
 from .service import SERVICES, MultimaticServiceHandler
@@ -71,14 +76,26 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     async def logout(event):
         await api.logout()
 
+    async def force_relogin(time: datetime):
+        try:
+            _LOGGER.debug("Periodic relogin")
+            await api.login(True)
+        except ApiError:
+            _LOGGER.debug("Error during periodic login", exc_info=True)
+
+    hass.data[DOMAIN][entry.entry_id][RELOGIN_TASK_CLEAN] = async_track_time_interval(
+        hass, force_relogin, FORCE_RELOGIN_TIMEDELTA
+    )
     hass.bus.async_listen_once(EVENT_HOMEASSISTANT_STOP, logout)
 
     await async_setup_service(hass, api, entry)
 
     return True
 
 
-async def async_setup_service(hass, api: MultimaticApi, entry: ConfigEntry):
+async def async_setup_service(
+    hass: HomeAssistant, api: MultimaticApi, entry: ConfigEntry
+):
     """Set up services."""
     serial = api.serial if api.fixed_serial else None
 
@@ -96,7 +113,7 @@ async def async_setup_service(hass, api: MultimaticApi, entry: ConfigEntry):
         hass.data[DOMAIN][entry.entry_id][SERVICES_HANDLER] = service_handler
 
 
-async def async_unload_services(hass, entry: ConfigEntry):
+async def async_unload_services(hass: HomeAssistant, entry: ConfigEntry):
     """Remove services when integration is removed."""
     service_handler = hass.data[DOMAIN][entry.entry_id].get(SERVICES_HANDLER, None)
     if service_handler:
@@ -121,6 +138,11 @@ async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
             )
         )
     )
+
+    relogin_task_clean = hass.data[DOMAIN][entry.entry_id][RELOGIN_TASK_CLEAN]
+    if relogin_task_clean:
+        relogin_task_clean()
+
     if unload_ok:
         await async_unload_services(hass, entry)
         hass.data[DOMAIN].pop(entry.entry_id)
@@ -130,7 +152,7 @@ async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     return unload_ok
 
 
-async def async_migrate_entry(hass, config_entry: ConfigEntry):
+async def async_migrate_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> bool:
     """Migrate old entry."""
     _LOGGER.debug("Migrating from version %s", config_entry.version)
     if config_entry.version == 1:

custom_components/multimatic/binary_sensor.py

@@ -13,9 +13,10 @@
     BinarySensorEntity,
 )
 from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import EntityCategory
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.device_registry import CONNECTION_NETWORK_MAC
-from homeassistant.helpers.entity import DeviceInfo, EntityCategory
+from homeassistant.helpers.entity import DeviceInfo
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 from homeassistant.util import slugify
 
@@ -315,7 +316,7 @@ def __init__(
         detail_coo: MultimaticCoordinator,
         gw_coo: MultimaticCoordinator,
         comp_id,
-    ):
+    ) -> None:
         """Initialize entity."""
         MultimaticEntity.__init__(self, coord, DOMAIN, comp_id)
         self._detail_coo = detail_coo

custom_components/multimatic/climate.py

@@ -38,6 +38,7 @@
 
 from . import SERVICES
 from .const import (
+    CONF_APPLICATION,
     DEFAULT_QUICK_VETO_DURATION,
     DOMAIN as MULTIMATIC,
     PRESET_COOLING_FOR_X_DAYS,
@@ -52,7 +53,6 @@
     SENSO,
     VENTILATION,
     ZONES,
-    CONF_APPLICATION,
 )
 from .coordinator import MultimaticCoordinator
 from .entities import MultimaticEntity
@@ -81,7 +81,11 @@ async def async_setup_entry(
     if zones_coo.data:
         for zone in zones_coo.data:
             if not zone.rbr and zone.enabled:
-                climates.append(build_zone_climate(zones_coo, zone, ventilation_coo.data, system_application))
+                climates.append(
+                    build_zone_climate(
+                        zones_coo, zone, ventilation_coo.data, system_application
+                    )
+                )
 
     if rooms_coo.data:
         rbr_zone = next((zone for zone in zones_coo.data if zone.rbr), None)
@@ -113,7 +117,7 @@ def __init__(
         self,
         coordinator: MultimaticCoordinator,
         comp_id,
-    ):
+    ) -> None:
         """Initialize entity."""
         super().__init__(coordinator, DOMAIN, comp_id)
         self._comp_id = comp_id
@@ -365,14 +369,18 @@ def current_humidity(self) -> int | None:
         return int(humidity) if humidity is not None else None
 
 
-def build_zone_climate(coordinator: MultimaticCoordinator, zone: Zone, ventilation, application) -> AbstractZoneClimate:
+def build_zone_climate(
+    coordinator: MultimaticCoordinator, zone: Zone, ventilation, application
+) -> AbstractZoneClimate:
+    """Create correct climate entity."""
     if application == MULTIMATIC:
         return ZoneClimate(coordinator, zone, ventilation)
     return ZoneClimateSenso(coordinator, zone, ventilation)
 
 
 class AbstractZoneClimate(MultimaticClimate, ABC):
     """Abstract class for a climate for a zone."""
+
     def __init__(
         self, coordinator: MultimaticCoordinator, zone: Zone, ventilation
     ) -> None:
@@ -510,6 +518,7 @@ async def async_set_preset_mode(self, preset_mode: str) -> None:
         mode = self._ha_preset()[preset_mode]
         await self.coordinator.api.set_zone_operating_mode(self, mode)
 
+
 class ZoneClimate(AbstractZoneClimate):
     """Climate for a MULTIMATIC zone."""
 
@@ -602,4 +611,4 @@ def _multimatic_mode(self):
         return ZoneClimateSenso._SENSO_TO_HA
 
     def _ha_preset(self):
-        return ZoneClimateSenso._HA_PRESET_TO_SENSO
+        return ZoneClimateSenso._HA_PRESET_TO_SENSO

custom_components/multimatic/config_flow.py

@@ -8,12 +8,19 @@
 from homeassistant import config_entries, core, exceptions
 from homeassistant.config_entries import ConfigEntry, OptionsFlow
 from homeassistant.const import CONF_PASSWORD, CONF_SCAN_INTERVAL, CONF_USERNAME
-from homeassistant.core import callback
+from homeassistant.core import HomeAssistant, callback
 from homeassistant.data_entry_flow import FlowResult
 from homeassistant.helpers.aiohttp_client import async_create_clientsession
 import homeassistant.helpers.config_validation as cv
 
-from .const import CONF_SERIAL_NUMBER, DEFAULT_SCAN_INTERVAL, DOMAIN, CONF_APPLICATION
+from .const import (
+    CONF_APPLICATION,
+    CONF_SERIAL_NUMBER,
+    DEFAULT_SCAN_INTERVAL,
+    DOMAIN,
+    MULTIMATIC,
+    SENSO,
+)
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -22,7 +29,7 @@
         vol.Required(CONF_USERNAME): str,
         vol.Required(CONF_PASSWORD): str,
         vol.Optional(CONF_SERIAL_NUMBER): str,
-        vol.Required(CONF_APPLICATION, default="MULTIMATIC"): vol.In(["MULTIMATIC", "SENSO"]),
+        vol.Required(CONF_APPLICATION, default=MULTIMATIC): vol.In([MULTIMATIC, SENSO]),
     }
 )
 
@@ -33,20 +40,24 @@ async def validate_input(hass: core.HomeAssistant, data):
     Data has the keys from DATA_SCHEMA with values provided by the user.
     """
 
-    await validate_authentication(hass, data[CONF_USERNAME], data[CONF_PASSWORD], data[CONF_APPLICATION])
+    await validate_authentication(
+        hass, data[CONF_USERNAME], data[CONF_PASSWORD], data[CONF_APPLICATION]
+    )
 
     return {"title": "Multimatic"}
 
 
-async def validate_authentication(hass, username, password, application):
+async def validate_authentication(
+    hass: HomeAssistant, username: str, password: str, application: str
+):
     """Ensure provided credentials are working."""
     try:
-        systemApplication = defaults.SENSO if application == "SENSO" else defaults.MULTIMATIC
+        system_app = defaults.SENSO if application == SENSO else defaults.MULTIMATIC
         if not await SystemManager(
             user=username,
             password=password,
             session=async_create_clientsession(hass),
-            application=systemApplication,
+            application=system_app,
         ).login(True):
             raise InvalidAuth
     except ApiError as err:

custom_components/multimatic/const.py

@@ -6,6 +6,7 @@
 
 DOMAIN = "multimatic"
 SENSO = "SENSO"
+MULTIMATIC = "MULTIMATIC"
 ENTITIES = "entities"
 
 # list of platforms into entity are created
@@ -79,3 +80,6 @@
     GATEWAY: timedelta(days=1),
     EMF_REPORTS: None,
 }
+
+FORCE_RELOGIN_TIMEDELTA = timedelta(hours=1)
+RELOGIN_TASK_CLEAN = "relogin_task_clean"

custom_components/multimatic/coordinator.py

@@ -26,17 +26,19 @@
 
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import CONF_PASSWORD, CONF_USERNAME
+from homeassistant.core import HomeAssistant
 from homeassistant.helpers.aiohttp_client import async_create_clientsession
 from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
 
 from .const import (
     CONF_APPLICATION,
     CONF_SERIAL_NUMBER,
     DEFAULT_QUICK_VETO_DURATION,
+    DEFAULT_QUICK_VETO_DURATION_HOURS,
     HOLIDAY_MODE,
     QUICK_MODE,
     REFRESH_EVENT,
-    SENSO, DEFAULT_QUICK_VETO_DURATION_HOURS,
+    SENSO,
 )
 from .utils import (
     holiday_mode_from_json,
@@ -51,22 +53,26 @@
 class MultimaticApi:
     """Utility to interact with multimatic API."""
 
-    def __init__(self, hass, entry: ConfigEntry):
+    def __init__(self, hass: HomeAssistant, entry: ConfigEntry) -> None:
         """Init."""
 
         self.serial = entry.data.get(CONF_SERIAL_NUMBER)
         self.fixed_serial = self.serial is not None
 
         username = entry.data[CONF_USERNAME]
         password = entry.data[CONF_PASSWORD]
-        systemApplication = defaults.SENSO if entry.data[CONF_APPLICATION] == SENSO else defaults.MULTIMATIC
+        self._application = (
+            defaults.SENSO
+            if entry.data[CONF_APPLICATION] == SENSO
+            else defaults.MULTIMATIC
+        )
 
         self._manager = pymultimatic.systemmanager.SystemManager(
             user=username,
             password=password,
             session=async_create_clientsession(hass),
             serial=self.serial,
-            application=systemApplication,
+            application=self._application,
         )
 
         self._quick_mode: QuickMode | None = None
@@ -115,7 +121,7 @@ async def get_ventilation(self):
     async def get_dhw(self):
         """Get domestic hot water.
 
-        There is a 2 queries here, one to ge the dhw and a second one to get the current temperature if
+        There are 2 queries here, one to ge the dhw and a second one to get the current temperature if
         there is a water tank.
         """
         _LOGGER.debug("Will get dhw")
@@ -352,7 +358,7 @@ async def set_quick_veto(self, entity, temperature, duration=None):
 
         q_duration = duration if duration else DEFAULT_QUICK_VETO_DURATION
         # For senso, the duration is in hours
-        if self._manager._application == defaults.SENSO:
+        if self._application == defaults.SENSO:
             q_duration = round(q_duration / 60 / 0.5) * 0.5
         qveto = QuickVeto(q_duration, temperature)
 
@@ -471,20 +477,24 @@ async def _refresh(self, touch_system, entity):
         entity.async_schedule_update_ha_state(True)
 
     def _default_quick_veto_duration(self):
-        return DEFAULT_QUICK_VETO_DURATION_HOURS if self._manager._application == defaults.SENSO else DEFAULT_QUICK_VETO_DURATION
+        return (
+            DEFAULT_QUICK_VETO_DURATION_HOURS
+            if self._application == defaults.SENSO
+            else DEFAULT_QUICK_VETO_DURATION
+        )
 
 
 class MultimaticCoordinator(DataUpdateCoordinator):
     """Multimatic coordinator."""
 
     def __init__(
         self,
-        hass,
+        hass: HomeAssistant,
         name,
         api: MultimaticApi,
         method: str,
         update_interval: timedelta | None,
-    ):
+    ) -> None:
         """Init."""
 
         self._api_listeners: set = set()

custom_components/multimatic/entities.py

@@ -18,7 +18,7 @@ class MultimaticEntity(CoordinatorEntity, ABC):
 
     coordinator: MultimaticCoordinator
 
-    def __init__(self, coordinator: MultimaticCoordinator, domain, device_id):
+    def __init__(self, coordinator: MultimaticCoordinator, domain, device_id) -> None:
         """Initialize entity."""
         super().__init__(coordinator)
 

custom_components/multimatic/manifest.json

@@ -12,7 +12,7 @@
   "homekit": {},
   "dependencies": [],
   "codeowners": ["@thomasgermain"],
-  "version": "1.14.0b2",
+  "version": "1.14.0b3",
   "iot_class": "cloud_polling",
   "integration_type": "hub"
 }

custom_components/multimatic/sensor.py

@@ -107,7 +107,9 @@ class ReportSensor(MultimaticEntity, SensorEntity):
 
     def __init__(self, coordinator: MultimaticCoordinator, report: Report) -> None:
         """Init entity."""
-        MultimaticEntity.__init__(self, coordinator, DOMAIN, f"{report.device_id}_{report.id}")
+        MultimaticEntity.__init__(
+            self, coordinator, DOMAIN, f"{report.device_id}_{report.id}"
+        )
         self._report_id = report.id
         self._unit = report.unit
         self._name = report.name