Add integration for iotty Smart Home

CODEOWNERS

@@ -618,6 +618,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/.gitignore

@@ -0,0 +1,3 @@
+.vscode/*
+
+homeassistant/components/iotty/.vscode/*

homeassistant/components/iotty/__init__.py

@@ -0,0 +1,55 @@
+"""The iotty integration."""
+from __future__ import annotations
+
+import asyncio
+import logging
+
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import Platform
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers import aiohttp_client, config_entry_oauth2_flow
+
+from . import api
+from .const import DOMAIN
+
+_LOGGER = logging.getLogger(__name__)
+
+# Uncomment these when developing
+# _LOGGER.setLevel(logging.DEBUG)
+# logging.getLogger("iottycloud").setLevel(logging.DEBUG)
+
+# For your initial PR, limit it to 1 platform.
+PLATFORMS: list[Platform] = [Platform.SWITCH]
+
+
+async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
+    """Set up iotty from a config entry."""
+    _LOGGER.debug("async_setup_entry DOMAIN %s entry_id=%s", DOMAIN, entry.entry_id)
+
+    implementation = (
+        await config_entry_oauth2_flow.async_get_config_entry_implementation(
+            hass, entry
+        )
+    )
+
+    session = config_entry_oauth2_flow.OAuth2Session(hass, entry, implementation)
+
+    iotty = api.IottyProxy(hass, aiohttp_client.async_get_clientsession(hass), session)
+
+    hass.async_add_job(iotty.init)
+
+    hass.data.setdefault(DOMAIN, {})[entry.entry_id] = iotty
+
+    await asyncio.sleep(3)
+
+    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."""
+    if unload_ok := await hass.config_entries.async_unload_platforms(entry, PLATFORMS):
+        hass.data[DOMAIN].pop(entry.entry_id)
+
+    return unload_ok

homeassistant/components/iotty/api.py

@@ -0,0 +1,97 @@
+"""API for iotty bound to Home Assistant OAuth."""
+
+import asyncio
+import logging
+from typing import Any
+
+from aiohttp import ClientSession
+from iottycloud.cloudapi import CloudApi
+from iottycloud.device import Device
+from iottycloud.verbs import RESULT, STATUS
+
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers import config_entry_oauth2_flow
+from homeassistant.helpers.entity import Entity
+
+from .const import IOTTYAPI_BASE, OAUTH2_CLIENT_ID
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class IottyProxy(CloudApi):
+    """Provide iotty authentication tied to an OAuth2 based config entry."""
+
+    _devices: list[Device]
+    _entities: dict
+    _coroutine: Any
+
+    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)
+        self._oauth_session = oauth_session
+        self._devices = []
+        self._entities = {}
+        self._hass = hass
+
+    async def init(self):
+        """Initialize iotty middleware."""
+        self._devices = await self.get_devices()
+        self._coroutine = self._hass.async_create_background_task(
+            self._polling(), "polling_task"
+        )
+
+    async def devices(self, device_type: str) -> Any:
+        """Get devices for a specific type."""
+
+        _LOGGER.debug("There are %d devices", len(self._devices))
+
+        ret = [d for d in self._devices if d.device_type == device_type]
+
+        return ret
+
+    def store_entity(self, device_id: str, entity: Entity) -> None:
+        """Test."""
+        _LOGGER.debug("store_entity %s", device_id)
+        self._entities[device_id] = entity
+
+    async def _polling(self) -> None:
+        """Continuous polling from iottyCloud."""
+        while True:
+            _LOGGER.debug("_polling routine from iottyCloud")
+
+            for device in self._devices:
+                res = await self.get_status(device.device_id)
+
+                if RESULT not in res or STATUS not in res[RESULT]:
+                    _LOGGER.warning(
+                        "Unable to read status for device %s", device.device_id
+                    )
+
+                status = res[RESULT][STATUS]
+                _LOGGER.debug("status: '%s' for device %s", status, device.device_id)
+                device.update_status(status)
+
+                if device.device_id not in self._entities:
+                    _LOGGER.warning(
+                        "Cannot find device %s (of type: %s) in _entities",
+                        device.device_id,
+                        device.device_type,
+                    )
+                else:
+                    self._entities[device.device_id].schedule_update_ha_state()
+
+            await asyncio.sleep(5)
+
+    async def async_get_access_token(self) -> str:
+        """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,14 @@
+"""application_credentials platform the iotty integration."""
+
+from homeassistant.components.application_credentials import AuthorizationServer
+from homeassistant.core import HomeAssistant
+
+from .const import OAUTH2_AUTHORIZE, 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,19 @@
+"""Config flow for iotty."""
+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,9 @@
+"""Constants for the iotty integration."""
+
+DOMAIN = "iotty"
+
+OAUTH2_AUTHORIZE = "https://auth.iotty.com/.auth/oauth2/login"
+OAUTH2_TOKEN = "https://auth.iotty.com/.auth/oauth2/token"
+OAUTH2_CLIENT_ID = "hass-iotty"
+
+IOTTYAPI_BASE = "https://cloudapi.iotty.com/"

homeassistant/components/iotty/manifest.json

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

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%]"
+    }
+  }
+}

homeassistant/components/iotty/switch.py

@@ -0,0 +1,92 @@
+"""Turn the entity on."""
+import logging
+from typing import Any
+
+from iottycloud.lightswitch import LightSwitch
+from iottycloud.verbs import LS_DEVICE_TYPE_UID
+
+from homeassistant.components.switch import SwitchDeviceClass, SwitchEntity
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import EntityCategory
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.entity_platform import AddEntitiesCallback
+
+from .api import IottyProxy
+from .const import DOMAIN
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class IottyLightSwitch(SwitchEntity):
+    """Haas entity class for iotty LightSwitch."""
+
+    _attr_entity_category = EntityCategory.CONFIG
+    _attr_device_class = SwitchDeviceClass.SWITCH
+    _iotty_cloud: Any
+    _iotty_device: Any
+
+    # _attr_should_poll = False
+
+    def __init__(self, iotty: IottyProxy, iotty_device: LightSwitch) -> None:
+        """Initialize the LightSwitch device."""
+        _LOGGER.debug(
+            "__init__ (%s) %s", iotty_device.device_type, iotty_device.device_id
+        )
+
+        super().__init__()
+        self._iotty_cloud = iotty
+        self._iotty_device = iotty_device
+
+    @property
+    def device_id(self) -> str:
+        """Get the ID of this iotty Device."""
+        return self._iotty_device.device_id
+
+    @property
+    def name(self) -> str:
+        """Get the name of this iotty Device."""
+        return self._iotty_device.name
+
+    @property
+    def is_on(self) -> bool:
+        """Return true if the LightSwitch is on."""
+        _LOGGER.debug(
+            "is_on %s ? %s", self._iotty_device.device_id, self._iotty_device.is_on
+        )
+        return self._iotty_device.is_on
+
+    async def async_turn_on(self, **kwargs: Any) -> None:
+        """Turn the LightSwitch on."""
+        _LOGGER.debug("[%s] async_turn_on", self._iotty_device.device_id)
+        await self._iotty_cloud.command(
+            self._iotty_device.device_id, self._iotty_device.cmd_turn_on()
+        )
+
+    async def async_turn_off(self, **kwargs: Any) -> None:
+        """Turn the LightSwitch off."""
+        _LOGGER.debug("[%s] async_turn_off", self._iotty_device.device_id)
+        await self._iotty_cloud.command(
+            self._iotty_device.device_id, self._iotty_device.cmd_turn_off()
+        )
+
+
+async def async_setup_entry(
+    hass: HomeAssistant,
+    config_entry: ConfigEntry,
+    async_add_entities: AddEntitiesCallback,
+) -> None:
+    """Activate the iotty LightSwitch component."""
+    _LOGGER.debug("async_setup_entry id is %s", config_entry.entry_id)
+
+    iotty = hass.data[DOMAIN][config_entry.entry_id]
+    _ls_list = await iotty.devices(LS_DEVICE_TYPE_UID)
+
+    _LOGGER.info("Found %d LightSwitches", len(_ls_list))
+
+    entities = []
+    for _ls in _ls_list:
+        new_entity = IottyLightSwitch(iotty, _ls)
+        iotty.store_entity(_ls.device_id, new_entity)
+        entities.append(new_entity)
+
+    async_add_entities(entities)

homeassistant/generated/application_credentials.py

@@ -13,6 +13,7 @@
     "google_sheets",
     "google_tasks",
     "home_connect",
+    "iotty",
     "lametric",
     "lyric",
     "neato",

homeassistant/generated/config_flows.py

@@ -225,6 +225,7 @@
         "intellifire",
         "ios",
         "iotawatt",
+        "iotty",
         "ipma",
         "ipp",
         "iqvia",

homeassistant/generated/integrations.json

@@ -2685,6 +2685,12 @@
       "config_flow": true,
       "iot_class": "local_polling"
     },
+    "iotty": {
+      "name": "iotty",
+      "integration_type": "device",
+      "config_flow": true,
+      "iot_class": "cloud_polling"
+    },
     "iperf3": {
       "name": "Iperf3",
       "integration_type": "hub",

requirements_all.txt

@@ -1082,6 +1082,9 @@ insteon-frontend-home-assistant==0.4.0
 # homeassistant.components.intellifire
 intellifire4py==2.2.2
 
+# homeassistant.components.iotty
+iottycloud==0.1.0
+
 # homeassistant.components.iperf3
 iperf3==0.1.11
 

requirements_test_all.txt

@@ -853,6 +853,9 @@ insteon-frontend-home-assistant==0.4.0
 # homeassistant.components.intellifire
 intellifire4py==2.2.2
 
+# homeassistant.components.iotty
+iottycloud==0.1.0
+
 # homeassistant.components.gogogate2
 ismartgate==5.0.1
 

tests/components/iotty/__init__.py

@@ -0,0 +1 @@
+"""Tests for iotty."""