Add OSO Energy integration

.coveragerc

@@ -915,6 +915,9 @@ omit =
     homeassistant/components/opple/light.py
     homeassistant/components/oru/*
     homeassistant/components/orvibo/switch.py
+    homeassistant/components/osoenergy/__init__.py
+    homeassistant/components/osoenergy/const.py
+    homeassistant/components/osoenergy/water_heater.py
     homeassistant/components/osramlightify/light.py
     homeassistant/components/otp/sensor.py
     homeassistant/components/overkiz/__init__.py

CODEOWNERS

@@ -923,6 +923,8 @@ build.json @home-assistant/supervisor
 /homeassistant/components/oralb/ @bdraco @Lash-L
 /tests/components/oralb/ @bdraco @Lash-L
 /homeassistant/components/oru/ @bvlaicu
+/homeassistant/components/osoenergy/ @osohotwateriot
+/tests/components/osoenergy/ @osohotwateriot
 /homeassistant/components/otbr/ @home-assistant/core
 /tests/components/otbr/ @home-assistant/core
 /homeassistant/components/overkiz/ @imicknl @vlebourl @tetienne @nyroDev

homeassistant/components/osoenergy/__init__.py

@@ -0,0 +1,72 @@
+"""Support for the OSO Energy devices and services."""
+from typing import Any
+
+from aiohttp.web_exceptions import HTTPException
+from apyosoenergyapi import OSOEnergy
+from apyosoenergyapi.helper.osoenergy_exceptions import OSOEnergyReauthRequired
+
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import CONF_API_KEY, Platform
+from homeassistant.core import HomeAssistant
+from homeassistant.exceptions import ConfigEntryAuthFailed, ConfigEntryNotReady
+from homeassistant.helpers import aiohttp_client
+from homeassistant.helpers.entity import Entity
+
+from .const import DOMAIN
+
+PLATFORMS = [
+    Platform.WATER_HEATER,
+]
+PLATFORM_LOOKUP = {
+    Platform.WATER_HEATER: "water_heater",
+}
+
+
+async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
+    """Set up OSO Energy from a config entry."""
+    subscription_key = entry.data[CONF_API_KEY]
+    websession = aiohttp_client.async_get_clientsession(hass)
+    osoenergy = OSOEnergy(subscription_key, websession)
+
+    osoenergy_config = dict(entry.data)
+
+    hass.data.setdefault(DOMAIN, {})
+
+    try:
+        devices: Any = await osoenergy.session.start_session(osoenergy_config)
+    except HTTPException as error:
+        raise ConfigEntryNotReady() from error
+    except OSOEnergyReauthRequired as err:
+        raise ConfigEntryAuthFailed from err
+
+    hass.data[DOMAIN][entry.entry_id] = osoenergy
+
+    platforms = set()
+    for ha_type, oso_type in PLATFORM_LOOKUP.items():
+        device_list = devices.get(oso_type, [])
+        if device_list:
+            platforms.add(ha_type)
+    if platforms:
+        await hass.config_entries.async_forward_entry_setups(entry, platforms)
+    return True
+
+
+async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
+    """Unload a config entry."""
+    unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
+    if unload_ok:
+        hass.data[DOMAIN].pop(entry.entry_id)
+
+    return unload_ok
+
+
+class OSOEnergyEntity(Entity):
+    """Initiate OSO Energy Base Class."""
+
+    _attr_has_entity_name = True
+
+    def __init__(self, osoenergy, osoenergy_device) -> None:
+        """Initialize the instance."""
+        self.osoenergy = osoenergy
+        self.device = osoenergy_device
+        self._attr_unique_id = osoenergy_device["device_id"]

homeassistant/components/osoenergy/config_flow.py

@@ -0,0 +1,75 @@
+"""Config Flow for OSO Energy."""
+from collections.abc import Mapping
+import logging
+from typing import Any
+
+from apyosoenergyapi import OSOEnergy
+import voluptuous as vol
+
+from homeassistant import config_entries
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import CONF_API_KEY
+from homeassistant.data_entry_flow import FlowResult
+from homeassistant.helpers import aiohttp_client
+
+from .const import DOMAIN
+
+_LOGGER = logging.getLogger(__name__)
+_SCHEMA_STEP_USER = vol.Schema({vol.Required(CONF_API_KEY): str})
+
+
+class OSOEnergyFlowHandler(config_entries.ConfigFlow, domain=DOMAIN):
+    """Handle a OSO Energy config flow."""
+
+    VERSION = 1
+    CONNECTION_CLASS = config_entries.CONN_CLASS_CLOUD_POLL
+
+    def __init__(self) -> None:
+        """Initialize."""
+        self.entry: ConfigEntry | None = None
+
+    async def async_step_user(self, user_input=None) -> FlowResult:
+        """Handle a flow initialized by the user."""
+        errors = {}
+
+        if user_input is not None:
+            # Verify Subscription key
+            if user_email := await self.get_user_email(user_input[CONF_API_KEY]):
+                await self.async_set_unique_id(user_email)
+
+                if (
+                    self.context["source"] == config_entries.SOURCE_REAUTH
+                    and self.entry
+                ):
+                    self.hass.config_entries.async_update_entry(
+                        self.entry, title=user_email, data=user_input
+                    )
+                    await self.hass.config_entries.async_reload(self.entry.entry_id)
+                    return self.async_abort(reason="reauth_successful")
+
+                self._abort_if_unique_id_configured()
+                return self.async_create_entry(title=user_email, data=user_input)
+
+            errors["base"] = "invalid_auth"
+
+        return self.async_show_form(
+            step_id="user",
+            data_schema=_SCHEMA_STEP_USER,
+            errors=errors,
+        )
+
+    async def get_user_email(self, subscription_key: str) -> str | None:
+        """Return true if credentials is valid."""
+        try:
+            websession = aiohttp_client.async_get_clientsession(self.hass)
+            client = OSOEnergy(subscription_key, websession)
+            return await client.get_user_email()
+        except Exception:  # pylint: disable=broad-except
+            _LOGGER.exception("Unknown error occurred")
+        return None
+
+    async def async_step_reauth(self, user_input: Mapping[str, Any]) -> FlowResult:
+        """Re Authenticate a user."""
+        self.entry = self.hass.config_entries.async_get_entry(self.context["entry_id"])
+        data = {CONF_API_KEY: user_input[CONF_API_KEY]}
+        return await self.async_step_user(data)

homeassistant/components/osoenergy/const.py

@@ -0,0 +1,3 @@
+"""Constants for OSO Energy."""
+
+DOMAIN = "osoenergy"

homeassistant/components/osoenergy/manifest.json

@@ -0,0 +1,9 @@
+{
+  "domain": "osoenergy",
+  "name": "OSO Energy",
+  "codeowners": ["@osohotwateriot"],
+  "config_flow": true,
+  "documentation": "https://www.home-assistant.io/integrations/osoenergy",
+  "iot_class": "cloud_polling",
+  "requirements": ["pyosoenergyapi==1.0.4"]
+}