Add Essent dynamic price integration (home-assistant#157010)

Co-authored-by: Joost Lekkerkerker <[email protected]>

Author: jaapp

CODEOWNERS

@@ -0,0 +1,29 @@
+"""The Essent integration."""
+
+from __future__ import annotations
+
+from homeassistant.const import Platform
+from homeassistant.core import HomeAssistant
+
+from .coordinator import EssentConfigEntry, EssentDataUpdateCoordinator
+
+PLATFORMS: list[Platform] = [Platform.SENSOR]
+
+
+async def async_setup_entry(hass: HomeAssistant, entry: EssentConfigEntry) -> bool:
+    """Set up Essent from a config entry."""
+    coordinator = EssentDataUpdateCoordinator(hass, entry)
+    await coordinator.async_config_entry_first_refresh()
+
+    # Start listener updates on the hour to advance cached tariffs
+    coordinator.start_listener_schedule()
+
+    entry.runtime_data = coordinator
+
+    await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
+    return True
+
+
+async def async_unload_entry(hass: HomeAssistant, entry: EssentConfigEntry) -> bool:
+    """Unload a config entry."""
+    return await hass.config_entries.async_unload_platforms(entry, PLATFORMS)

homeassistant/components/essent/__init__.py

@@ -0,0 +1,47 @@
+"""Config flow for Essent integration."""
+
+from __future__ import annotations
+
+import logging
+from typing import Any
+
+from essent_dynamic_pricing import (
+    EssentClient,
+    EssentConnectionError,
+    EssentDataError,
+    EssentResponseError,
+)
+
+from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
+from homeassistant.helpers.aiohttp_client import async_get_clientsession
+
+from .const import DOMAIN
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class EssentConfigFlow(ConfigFlow, domain=DOMAIN):
+    """Handle a config flow for Essent."""
+
+    VERSION = 1
+
+    async def async_step_user(
+        self, user_input: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
+        """Handle the initial step."""
+        client = EssentClient(async_get_clientsession(self.hass))
+
+        try:
+            await client.async_get_prices()
+        except (EssentConnectionError, EssentResponseError):
+            return self.async_abort(reason="cannot_connect")
+        except EssentDataError:
+            return self.async_abort(reason="invalid_data")
+        except Exception:
+            _LOGGER.exception("Unexpected error while validating the connection")
+            return self.async_abort(reason="unknown")
+
+        if user_input is None:
+            return self.async_show_form(step_id="user")
+
+        return self.async_create_entry(title="Essent", data={})

homeassistant/components/essent/config_flow.py

@@ -0,0 +1,29 @@
+"""Constants for the Essent integration."""
+
+from __future__ import annotations
+
+from datetime import timedelta
+from enum import StrEnum
+from typing import Final
+
+DOMAIN: Final = "essent"
+UPDATE_INTERVAL: Final = timedelta(hours=12)
+ATTRIBUTION: Final = "Data provided by Essent"
+
+
+class EnergyType(StrEnum):
+    """Supported energy types for Essent pricing."""
+
+    ELECTRICITY = "electricity"
+    GAS = "gas"
+
+
+class PriceGroup(StrEnum):
+    """Price group types as provided in tariff groups.
+
+    VAT is not emitted as a price group; use tariff.total_amount_vat for VAT.
+    """
+
+    MARKET_PRICE = "MARKET_PRICE"
+    PURCHASING_FEE = "PURCHASING_FEE"
+    TAX = "TAX"

homeassistant/components/essent/const.py

@@ -0,0 +1,108 @@
+"""DataUpdateCoordinator for Essent integration."""
+
+from __future__ import annotations
+
+from collections.abc import Callable
+from datetime import datetime, timedelta
+import logging
+
+from essent_dynamic_pricing import (
+    EssentClient,
+    EssentConnectionError,
+    EssentDataError,
+    EssentError,
+    EssentPrices,
+    EssentResponseError,
+)
+
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.core import HomeAssistant, callback
+from homeassistant.helpers.aiohttp_client import async_get_clientsession
+from homeassistant.helpers.event import async_track_point_in_utc_time
+from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
+from homeassistant.util import dt as dt_util
+
+from .const import DOMAIN, UPDATE_INTERVAL
+
+_LOGGER = logging.getLogger(__name__)
+type EssentConfigEntry = ConfigEntry[EssentDataUpdateCoordinator]
+
+
+class EssentDataUpdateCoordinator(DataUpdateCoordinator[EssentPrices]):
+    """Class to manage fetching Essent data."""
+
+    config_entry: EssentConfigEntry
+
+    def __init__(self, hass: HomeAssistant, config_entry: EssentConfigEntry) -> None:
+        """Initialize."""
+        super().__init__(
+            hass,
+            _LOGGER,
+            config_entry=config_entry,
+            name=DOMAIN,
+            update_interval=UPDATE_INTERVAL,
+        )
+        self._client = EssentClient(async_get_clientsession(hass))
+        self._unsub_listener: Callable[[], None] | None = None
+
+    def start_listener_schedule(self) -> None:
+        """Start listener tick schedule after first successful data fetch."""
+        if self.config_entry.pref_disable_polling:
+            _LOGGER.debug("Polling disabled by config entry, not starting listener")
+            return
+        if self._unsub_listener:
+            return
+        _LOGGER.info("Starting listener updates on the hour")
+        self._schedule_listener_tick()
+
+    async def async_shutdown(self) -> None:
+        """Cancel any scheduled call, and ignore new runs."""
+        await super().async_shutdown()
+        if self._unsub_listener:
+            self._unsub_listener()
+            self._unsub_listener = None
+
+    def _schedule_listener_tick(self) -> None:
+        """Schedule listener updates on the hour to advance cached tariffs."""
+        if self._unsub_listener:
+            self._unsub_listener()
+
+        now = dt_util.utcnow()
+        next_hour = now + timedelta(hours=1)
+        next_run = datetime(
+            next_hour.year,
+            next_hour.month,
+            next_hour.day,
+            next_hour.hour,
+            tzinfo=dt_util.UTC,
+        )
+
+        _LOGGER.debug("Scheduling next listener tick for %s", next_run)
+
+        @callback
+        def _handle(_: datetime) -> None:
+            """Handle the scheduled listener tick to update sensors."""
+            self._unsub_listener = None
+            _LOGGER.debug("Listener tick fired, updating sensors with cached data")
+            self.async_update_listeners()
+            self._schedule_listener_tick()
+
+        self._unsub_listener = async_track_point_in_utc_time(
+            self.hass,
+            _handle,
+            next_run,
+        )
+
+    async def _async_update_data(self) -> EssentPrices:
+        """Fetch data from API."""
+        try:
+            return await self._client.async_get_prices()
+        except EssentConnectionError as err:
+            raise UpdateFailed(f"Error communicating with API: {err}") from err
+        except EssentResponseError as err:
+            raise UpdateFailed(str(err)) from err
+        except EssentDataError as err:
+            _LOGGER.debug("Invalid data received: %s", err)
+            raise UpdateFailed(str(err)) from err
+        except EssentError as err:
+            raise UpdateFailed("Unexpected Essent error") from err

homeassistant/components/essent/coordinator.py

@@ -0,0 +1,36 @@
+"""Base entity for Essent integration."""
+
+from essent_dynamic_pricing.models import EnergyData
+
+from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
+from homeassistant.helpers.update_coordinator import CoordinatorEntity
+
+from .const import ATTRIBUTION, DOMAIN, EnergyType
+from .coordinator import EssentDataUpdateCoordinator
+
+
+class EssentEntity(CoordinatorEntity[EssentDataUpdateCoordinator]):
+    """Base class for Essent entities."""
+
+    _attr_has_entity_name = True
+    _attr_attribution = ATTRIBUTION
+
+    def __init__(
+        self,
+        coordinator: EssentDataUpdateCoordinator,
+        energy_type: EnergyType,
+    ) -> None:
+        """Initialize the entity."""
+        super().__init__(coordinator)
+        self.energy_type = energy_type
+        self._attr_device_info = DeviceInfo(
+            entry_type=DeviceEntryType.SERVICE,
+            identifiers={(DOMAIN, coordinator.config_entry.entry_id)},
+            name="Essent",
+            manufacturer="Essent",
+        )
+
+    @property
+    def energy_data(self) -> EnergyData:
+        """Return the energy data for this entity."""
+        return getattr(self.coordinator.data, self.energy_type.value)

homeassistant/components/essent/entity.py

@@ -0,0 +1,12 @@
+{
+  "domain": "essent",
+  "name": "Essent",
+  "codeowners": ["@jaapp"],
+  "config_flow": true,
+  "documentation": "https://www.home-assistant.io/integrations/essent",
+  "integration_type": "service",
+  "iot_class": "cloud_polling",
+  "quality_scale": "silver",
+  "requirements": ["essent-dynamic-pricing==0.2.7"],
+  "single_config_entry": true
+}

homeassistant/components/essent/manifest.json

@@ -0,0 +1,89 @@
+rules:
+  # Bronze
+  action-setup:
+    status: exempt
+    comment: |
+      This integration does not provide additional actions or services.
+  appropriate-polling: done
+  brands: done
+  common-modules: done
+  config-flow-test-coverage: done
+  config-flow: done
+  dependency-transparency: done
+  docs-actions:
+    status: exempt
+    comment: |
+      This integration does not expose services or actions.
+  docs-high-level-description: done
+  docs-installation-instructions: done
+  docs-removal-instructions: done
+  entity-event-setup:
+    status: exempt
+    comment: |
+      Entities rely on DataUpdateCoordinator updates rather than event subscriptions.
+  entity-unique-id: done
+  has-entity-name: done
+  runtime-data: done
+  test-before-configure: done
+  test-before-setup: done
+  unique-config-entry: done
+
+  # Silver
+  action-exceptions:
+    status: exempt
+    comment: |
+      This integration does not expose user actions.
+  config-entry-unloading: done
+  docs-configuration-parameters:
+    status: exempt
+    comment: |
+      No options flow is provided.
+  docs-installation-parameters: done
+  entity-unavailable: done
+  integration-owner: done
+  log-when-unavailable: done
+  parallel-updates: done
+  reauthentication-flow:
+    status: exempt
+    comment: |
+      No authentication is required for this integration.
+  test-coverage: done
+  # Gold
+  devices: done
+  diagnostics: todo
+  discovery-update-info: todo
+  discovery: todo
+  docs-data-update: todo
+  docs-examples: todo
+  docs-known-limitations: todo
+  docs-supported-devices: todo
+  docs-supported-functions: todo
+  docs-troubleshooting: todo
+  docs-use-cases: todo
+  dynamic-devices:
+    status: exempt
+    comment: |
+      Device-less integration.
+  entity-category: done
+  entity-device-class: done
+  entity-disabled-by-default: done
+  entity-translations: done
+  exception-translations: todo
+  icon-translations:
+    status: exempt
+    comment: |
+      No custom icons are defined.
+  reconfiguration-flow: todo
+  repair-issues:
+    status: exempt
+    comment: |
+      No known repair flows at this time.
+  stale-devices:
+    status: exempt
+    comment: |
+      Device-less integration.
+
+  # Platinum
+  async-dependency: done
+  inject-websession: done
+  strict-typing: todo