Add anglian_water integration (home-assistant#156225)

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

Author: pantherale0

CODEOWNERS

@@ -0,0 +1,70 @@
+"""The Anglian Water integration."""
+
+from __future__ import annotations
+
+from pyanglianwater import AnglianWater
+from pyanglianwater.auth import MSOB2CAuth
+from pyanglianwater.exceptions import (
+    ExpiredAccessTokenError,
+    SelfAssertedError,
+    SmartMeterUnavailableError,
+)
+
+from homeassistant.const import (
+    CONF_ACCESS_TOKEN,
+    CONF_PASSWORD,
+    CONF_USERNAME,
+    Platform,
+)
+from homeassistant.core import HomeAssistant
+from homeassistant.exceptions import ConfigEntryAuthFailed, ConfigEntryError
+from homeassistant.helpers.aiohttp_client import async_get_clientsession
+
+from .const import CONF_ACCOUNT_NUMBER, DOMAIN
+from .coordinator import AnglianWaterConfigEntry, AnglianWaterUpdateCoordinator
+
+_PLATFORMS: list[Platform] = [Platform.SENSOR]
+
+
+async def async_setup_entry(
+    hass: HomeAssistant, entry: AnglianWaterConfigEntry
+) -> bool:
+    """Set up Anglian Water from a config entry."""
+    auth = MSOB2CAuth(
+        username=entry.data[CONF_USERNAME],
+        password=entry.data[CONF_PASSWORD],
+        session=async_get_clientsession(hass),
+        refresh_token=entry.data[CONF_ACCESS_TOKEN],
+        account_number=entry.data[CONF_ACCOUNT_NUMBER],
+    )
+    try:
+        await auth.send_refresh_request()
+    except (ExpiredAccessTokenError, SelfAssertedError) as err:
+        raise ConfigEntryAuthFailed from err
+
+    _aw = AnglianWater(authenticator=auth)
+
+    try:
+        await _aw.validate_smart_meter()
+    except SmartMeterUnavailableError as err:
+        raise ConfigEntryError(
+            translation_domain=DOMAIN, translation_key="smart_meter_unavailable"
+        ) from err
+
+    hass.config_entries.async_update_entry(
+        entry, data={**entry.data, CONF_ACCESS_TOKEN: auth.refresh_token}
+    )
+    entry.runtime_data = coordinator = AnglianWaterUpdateCoordinator(
+        hass=hass, api=_aw, config_entry=entry
+    )
+
+    await coordinator.async_config_entry_first_refresh()
+    await hass.config_entries.async_forward_entry_setups(entry, _PLATFORMS)
+    return True
+
+
+async def async_unload_entry(
+    hass: HomeAssistant, entry: AnglianWaterConfigEntry
+) -> bool:
+    """Unload a config entry."""
+    return await hass.config_entries.async_unload_platforms(entry, _PLATFORMS)

homeassistant/components/anglian_water/__init__.py

@@ -0,0 +1,103 @@
+"""Config flow for the Anglian Water integration."""
+
+from __future__ import annotations
+
+import logging
+from typing import Any
+
+from aiohttp import CookieJar
+from pyanglianwater import AnglianWater
+from pyanglianwater.auth import BaseAuth, MSOB2CAuth
+from pyanglianwater.exceptions import (
+    InvalidAccountIdError,
+    SelfAssertedError,
+    SmartMeterUnavailableError,
+)
+import voluptuous as vol
+
+from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
+from homeassistant.const import CONF_ACCESS_TOKEN, CONF_PASSWORD, CONF_USERNAME
+from homeassistant.helpers import selector
+from homeassistant.helpers.aiohttp_client import async_create_clientsession
+
+from .const import CONF_ACCOUNT_NUMBER, DOMAIN
+
+_LOGGER = logging.getLogger(__name__)
+
+STEP_USER_DATA_SCHEMA = vol.Schema(
+    {
+        vol.Required(CONF_USERNAME): selector.TextSelector(),
+        vol.Required(CONF_PASSWORD): selector.TextSelector(
+            selector.TextSelectorConfig(type=selector.TextSelectorType.PASSWORD)
+        ),
+    }
+)
+
+
+async def validate_credentials(auth: MSOB2CAuth) -> str | MSOB2CAuth:
+    """Validate the provided credentials."""
+    try:
+        await auth.send_login_request()
+    except SelfAssertedError:
+        return "invalid_auth"
+    except Exception:
+        _LOGGER.exception("Unexpected exception")
+        return "unknown"
+    _aw = AnglianWater(authenticator=auth)
+    try:
+        await _aw.validate_smart_meter()
+    except (InvalidAccountIdError, SmartMeterUnavailableError):
+        return "smart_meter_unavailable"
+    return auth
+
+
+class AnglianWaterConfigFlow(ConfigFlow, domain=DOMAIN):
+    """Handle a config flow for Anglian Water."""
+
+    async def async_step_user(
+        self, user_input: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
+        """Handle the initial step."""
+        errors: dict[str, str] = {}
+        if user_input is not None:
+            validation_response = await validate_credentials(
+                MSOB2CAuth(
+                    username=user_input[CONF_USERNAME],
+                    password=user_input[CONF_PASSWORD],
+                    session=async_create_clientsession(
+                        self.hass,
+                        cookie_jar=CookieJar(quote_cookie=False),
+                    ),
+                    account_number=user_input.get(CONF_ACCOUNT_NUMBER),
+                )
+            )
+            if isinstance(validation_response, BaseAuth):
+                account_number = (
+                    user_input.get(CONF_ACCOUNT_NUMBER)
+                    or validation_response.account_number
+                )
+                await self.async_set_unique_id(account_number)
+                self._abort_if_unique_id_configured()
+                return self.async_create_entry(
+                    title=account_number,
+                    data={
+                        **user_input,
+                        CONF_ACCESS_TOKEN: validation_response.refresh_token,
+                        CONF_ACCOUNT_NUMBER: account_number,
+                    },
+                )
+            if validation_response == "smart_meter_unavailable":
+                return self.async_show_form(
+                    step_id="user",
+                    data_schema=STEP_USER_DATA_SCHEMA.extend(
+                        {
+                            vol.Required(CONF_ACCOUNT_NUMBER): selector.TextSelector(),
+                        }
+                    ),
+                    errors={"base": validation_response},
+                )
+            errors["base"] = validation_response
+
+        return self.async_show_form(
+            step_id="user", data_schema=STEP_USER_DATA_SCHEMA, errors=errors
+        )

homeassistant/components/anglian_water/config_flow.py

@@ -0,0 +1,4 @@
+"""Constants for the Anglian Water integration."""
+
+DOMAIN = "anglian_water"
+CONF_ACCOUNT_NUMBER = "account_number"

homeassistant/components/anglian_water/const.py

@@ -0,0 +1,49 @@
+"""Anglian Water data coordinator."""
+
+from __future__ import annotations
+
+from datetime import timedelta
+import logging
+
+from pyanglianwater import AnglianWater
+from pyanglianwater.exceptions import ExpiredAccessTokenError, UnknownEndpointError
+
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
+
+from .const import DOMAIN
+
+type AnglianWaterConfigEntry = ConfigEntry[AnglianWaterUpdateCoordinator]
+
+_LOGGER = logging.getLogger(__name__)
+UPDATE_INTERVAL = timedelta(minutes=60)
+
+
+class AnglianWaterUpdateCoordinator(DataUpdateCoordinator[None]):
+    """Anglian Water data update coordinator."""
+
+    config_entry: AnglianWaterConfigEntry
+
+    def __init__(
+        self,
+        hass: HomeAssistant,
+        api: AnglianWater,
+        config_entry: AnglianWaterConfigEntry,
+    ) -> None:
+        """Initialize update coordinator."""
+        super().__init__(
+            hass=hass,
+            logger=_LOGGER,
+            name=DOMAIN,
+            update_interval=UPDATE_INTERVAL,
+            config_entry=config_entry,
+        )
+        self.api = api
+
+    async def _async_update_data(self) -> None:
+        """Update data from Anglian Water's API."""
+        try:
+            return await self.api.update()
+        except (ExpiredAccessTokenError, UnknownEndpointError) as err:
+            raise UpdateFailed from err

homeassistant/components/anglian_water/coordinator.py

@@ -0,0 +1,44 @@
+"""Anglian Water entity."""
+
+from __future__ import annotations
+
+import logging
+
+from pyanglianwater.meter import SmartMeter
+
+from homeassistant.helpers.device_registry import DeviceInfo
+from homeassistant.helpers.update_coordinator import CoordinatorEntity
+
+from .const import DOMAIN
+from .coordinator import AnglianWaterUpdateCoordinator
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class AnglianWaterEntity(CoordinatorEntity[AnglianWaterUpdateCoordinator]):
+    """Defines a Anglian Water entity."""
+
+    def __init__(
+        self,
+        coordinator: AnglianWaterUpdateCoordinator,
+        smart_meter: SmartMeter,
+    ) -> None:
+        """Initialize Anglian Water entity."""
+        super().__init__(coordinator)
+        self.smart_meter = smart_meter
+        self._attr_device_info = DeviceInfo(
+            identifiers={(DOMAIN, smart_meter.serial_number)},
+            name="Smart Water Meter",
+            manufacturer="Anglian Water",
+            serial_number=smart_meter.serial_number,
+        )
+
+    async def async_added_to_hass(self) -> None:
+        """When entity is loaded."""
+        self.coordinator.api.updated_data_callbacks.append(self.async_write_ha_state)
+        await super().async_added_to_hass()
+
+    async def async_will_remove_from_hass(self) -> None:
+        """When will be removed from HASS."""
+        self.coordinator.api.updated_data_callbacks.remove(self.async_write_ha_state)
+        await super().async_will_remove_from_hass()

homeassistant/components/anglian_water/entity.py

@@ -0,0 +1,10 @@
+{
+  "domain": "anglian_water",
+  "name": "Anglian Water",
+  "codeowners": ["@pantherale0"],
+  "config_flow": true,
+  "documentation": "https://www.home-assistant.io/integrations/anglian_water",
+  "iot_class": "cloud_polling",
+  "quality_scale": "bronze",
+  "requirements": ["pyanglianwater==2.1.0"]
+}

homeassistant/components/anglian_water/manifest.json

@@ -0,0 +1,83 @@
+rules:
+  # Bronze
+  action-setup:
+    status: exempt
+    comment: |
+      No custom actions are defined.
+  appropriate-polling: done
+  brands: done
+  common-modules: done
+  config-flow-test-coverage: done
+  config-flow: done
+  dependency-transparency: done
+  docs-actions:
+    status: exempt
+    comment: |
+      No custom actions are defined.
+  docs-high-level-description: done
+  docs-installation-instructions: done
+  docs-removal-instructions: done
+  entity-event-setup: done
+  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: |
+      No custom actions are defined.
+  config-entry-unloading: done
+  docs-configuration-parameters: done
+  docs-installation-parameters: done
+  entity-unavailable: done
+  integration-owner: done
+  log-when-unavailable: done
+  parallel-updates: done
+  reauthentication-flow: todo
+  test-coverage: todo
+
+  # Gold
+  devices: done
+  diagnostics: todo
+  discovery-update-info:
+    status: exempt
+    comment: |
+      Unable to discover meters.
+  discovery:
+    status: exempt
+    comment: |
+      Unable to discover meters.
+  docs-data-update: done
+  docs-examples: todo
+  docs-known-limitations: done
+  docs-supported-devices: done
+  docs-supported-functions: done
+  docs-troubleshooting: done
+  docs-use-cases: todo
+  dynamic-devices: todo
+  entity-category: done
+  entity-device-class: done
+  entity-disabled-by-default:
+    status: exempt
+    comment: |
+      No entities are disabled by default.
+  entity-translations: done
+  exception-translations: done
+  icon-translations:
+    status: exempt
+    comment: |
+      Entities do not require different icons.
+  reconfiguration-flow: todo
+  repair-issues:
+    status: exempt
+    comment: |
+      Read-only integration and no repairs are possible.
+  stale-devices: todo
+  # Platinum
+  async-dependency: done
+  inject-websession: done
+  strict-typing: todo