Add integration for iotty Smart Home

.strict-typing

@@ -253,6 +253,7 @@ homeassistant.components.integration.*
 homeassistant.components.intent.*
 homeassistant.components.intent_script.*
 homeassistant.components.ios.*
+homeassistant.components.iotty.*
 homeassistant.components.ipp.*
 homeassistant.components.iqvia.*
 homeassistant.components.islamic_prayer_times.*

CODEOWNERS

@@ -689,6 +689,8 @@ build.json @home-assistant/supervisor
 /tests/components/ios/ @robbiet480
 /homeassistant/components/iotawatt/ @gtdiehl @jyavenard
 /tests/components/iotawatt/ @gtdiehl @jyavenard
+/homeassistant/components/iotty/ @pburgio
+/tests/components/iotty/ @pburgio
 /homeassistant/components/iperf3/ @rohankapoorcom
 /homeassistant/components/ipma/ @dgomes
 /tests/components/ipma/ @dgomes

homeassistant/components/iotty/__init__.py

@@ -0,0 +1,56 @@
+"""The iotty integration."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+import logging
+
+from iottycloud.device import Device
+
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import Platform
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.config_entry_oauth2_flow import (
+    OAuth2Session,
+    async_get_config_entry_implementation,
+)
+
+from . import coordinator
+
+_LOGGER = logging.getLogger(__name__)
+
+PLATFORMS: list[Platform] = [Platform.SWITCH]
+
+type IottyConfigEntry = ConfigEntry[IottyConfigEntryData]
+
+
+@dataclass
+class IottyConfigEntryData:
+    """Contains config entry data for iotty."""
+
+    known_devices: set[Device]
+    coordinator: coordinator.IottyDataUpdateCoordinator
+
+
+async def async_setup_entry(hass: HomeAssistant, entry: IottyConfigEntry) -> bool:
+    """Set up iotty from a config entry."""
+    _LOGGER.debug("async_setup_entry entry_id=%s", entry.entry_id)
+
+    implementation = await async_get_config_entry_implementation(hass, entry)
+    session = OAuth2Session(hass, entry, implementation)
+
+    data_update_coordinator = coordinator.IottyDataUpdateCoordinator(
+        hass, entry, session
+    )
+
+    entry.runtime_data = IottyConfigEntryData(set(), data_update_coordinator)
+
+    await data_update_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: ConfigEntry) -> bool:
+    """Unload a config entry."""
+    return await hass.config_entries.async_unload_platforms(entry, PLATFORMS)

homeassistant/components/iotty/api.py

@@ -0,0 +1,40 @@
+"""API for iotty bound to Home Assistant OAuth."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from aiohttp import ClientSession
+from iottycloud.cloudapi import CloudApi
+
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers import config_entry_oauth2_flow
+
+OAUTH2_CLIENT_ID = "hass-iotty"
+IOTTYAPI_BASE = "https://homeassistant.iotty.com/"
+
+
+class IottyProxy(CloudApi):
+    """Provide iotty authentication tied to an OAuth2 based config entry."""
+
+    def __init__(
+        self,
+        hass: HomeAssistant,
+        websession: ClientSession,
+        oauth_session: config_entry_oauth2_flow.OAuth2Session,
+    ) -> None:
+        """Initialize iotty auth."""
+
+        super().__init__(websession, IOTTYAPI_BASE, OAUTH2_CLIENT_ID)
+        if oauth_session is None:
+            raise ValueError("oauth_session")
+        self._oauth_session = oauth_session
+        self._hass = hass
+
+    async def async_get_access_token(self) -> Any:
+        """Return a valid access token."""
+
+        if not self._oauth_session.valid_token:
+            await self._oauth_session.async_ensure_token_valid()
+
+        return self._oauth_session.token["access_token"]

homeassistant/components/iotty/application_credentials.py

@@ -0,0 +1,17 @@
+"""Application credentials platform for iotty."""
+
+from __future__ import annotations
+
+from homeassistant.components.application_credentials import AuthorizationServer
+from homeassistant.core import HomeAssistant
+
+OAUTH2_AUTHORIZE = "https://auth.iotty.com/.auth/oauth2/login"
+OAUTH2_TOKEN = "https://auth.iotty.com/.auth/oauth2/token"
+
+
+async def async_get_authorization_server(hass: HomeAssistant) -> AuthorizationServer:
+    """Return authorization server."""
+    return AuthorizationServer(
+        authorize_url=OAUTH2_AUTHORIZE,
+        token_url=OAUTH2_TOKEN,
+    )

homeassistant/components/iotty/config_flow.py

@@ -0,0 +1,22 @@
+"""Config flow for iotty."""
+
+from __future__ import annotations
+
+import logging
+
+from homeassistant.helpers import config_entry_oauth2_flow
+
+from .const import DOMAIN
+
+
+class OAuth2FlowHandler(
+    config_entry_oauth2_flow.AbstractOAuth2FlowHandler, domain=DOMAIN
+):
+    """Config flow to handle iotty OAuth2 authentication."""
+
+    DOMAIN = DOMAIN
+
+    @property
+    def logger(self) -> logging.Logger:
+        """Return logger."""
+        return logging.getLogger(__name__)

homeassistant/components/iotty/const.py

@@ -0,0 +1,5 @@
+"""Constants for the iotty integration."""
+
+from __future__ import annotations
+
+DOMAIN = "iotty"

homeassistant/components/iotty/coordinator.py

@@ -0,0 +1,108 @@
+"""DataUpdateCoordinator for iotty."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from datetime import timedelta
+import logging
+
+from iottycloud.device import Device
+from iottycloud.verbs import RESULT, STATUS
+
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers import aiohttp_client, device_registry as dr
+from homeassistant.helpers.config_entry_oauth2_flow import OAuth2Session
+from homeassistant.helpers.entity import Entity
+from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
+
+from . import api
+from .const import DOMAIN
+
+_LOGGER = logging.getLogger(__name__)
+
+UPDATE_INTERVAL = timedelta(seconds=30)
+
+
+@dataclass
+class IottyData:
+    """iotty data stored in the DataUpdateCoordinator."""
+
+    devices: list[Device]
+
+
+class IottyDataUpdateCoordinator(DataUpdateCoordinator[IottyData]):
+    """Class to manage fetching Iotty data."""
+
+    config_entry: ConfigEntry
+    _entities: dict[str, Entity]
+    _devices: list[Device]
+    _device_registry: dr.DeviceRegistry
+
+    def __init__(
+        self, hass: HomeAssistant, entry: ConfigEntry, session: OAuth2Session
+    ) -> None:
+        """Initialize the coordinator."""
+        _LOGGER.debug("Initializing iotty data update coordinator")
+
+        super().__init__(
+            hass,
+            _LOGGER,
+            name=f"{DOMAIN}_coordinator",
+            update_interval=UPDATE_INTERVAL,
+        )
+
+        self.config_entry = entry
+        self._entities = {}
+        self._devices = []
+        self.iotty = api.IottyProxy(
+            hass, aiohttp_client.async_get_clientsession(hass), session
+        )
+        self._device_registry = dr.async_get(hass)
+
+    async def async_config_entry_first_refresh(self) -> None:
+        """Override the first refresh to also fetch iotty devices list."""
+        _LOGGER.debug("Fetching devices list from iottyCloud")
+        self._devices = await self.iotty.get_devices()
+        _LOGGER.debug("There are %d devices", len(self._devices))
+
+        await super().async_config_entry_first_refresh()
+
+    async def _async_update_data(self) -> IottyData:
+        """Fetch data from iottyCloud device."""
+        _LOGGER.debug("Fetching devices status from iottyCloud")
+
+        current_devices = await self.iotty.get_devices()
+
+        removed_devices = [
+            d
+            for d in self._devices
+            if not any(x.device_id == d.device_id for x in current_devices)
+        ]
+
+        for removed_device in removed_devices:
+            device_to_remove = self._device_registry.async_get_device(
+                {(DOMAIN, removed_device.device_id)}
+            )
+            if device_to_remove is not None:
+                self._device_registry.async_remove_device(device_to_remove.id)
+
+        self._devices = current_devices
+
+        for device in self._devices:
+            res = await self.iotty.get_status(device.device_id)
+            json = res.get(RESULT, {})
+            if (
+                not isinstance(res, dict)
+                or RESULT not in res
+                or not isinstance(json := res[RESULT], dict)
+                or not (status := json.get(STATUS))
+            ):
+                _LOGGER.warning("Unable to read status for device %s", device.device_id)
+            else:
+                _LOGGER.debug(
+                    "Retrieved status: '%s' for device %s", status, device.device_id
+                )
+                device.update_status(status)
+
+        return IottyData(self._devices)

homeassistant/components/iotty/manifest.json

@@ -0,0 +1,11 @@
+{
+  "domain": "iotty",
+  "name": "iotty",
+  "codeowners": ["@pburgio"],
+  "config_flow": true,
+  "dependencies": ["application_credentials"],
+  "documentation": "https://www.home-assistant.io/integrations/iotty",
+  "integration_type": "device",
+  "iot_class": "cloud_polling",
+  "requirements": ["iottycloud==0.1.3"]
+}

homeassistant/components/iotty/strings.json

@@ -0,0 +1,21 @@
+{
+  "config": {
+    "step": {
+      "pick_implementation": {
+        "title": "[%key:common::config_flow::title::oauth2_pick_implementation%]"
+      }
+    },
+    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_account%]",
+      "already_in_progress": "[%key:common::config_flow::abort::already_in_progress%]",
+      "oauth_error": "[%key:common::config_flow::abort::oauth2_error%]",
+      "missing_configuration": "[%key:common::config_flow::abort::oauth2_missing_configuration%]",
+      "authorize_url_timeout": "[%key:common::config_flow::abort::oauth2_authorize_url_timeout%]",
+      "no_url_available": "[%key:common::config_flow::abort::oauth2_no_url_available%]",
+      "user_rejected_authorize": "[%key:common::config_flow::abort::oauth2_user_rejected_authorize%]"
+    },
+    "create_entry": {
+      "default": "[%key:common::config_flow::create_entry::authenticated%]"
+    }
+  }
+}