Rework for hass integration

Author: iluvdata

.gitignore

@@ -4,3 +4,6 @@
 .vscode/
 pykasacloud/__main__.py
 dist
+.DS_Store
+pykasacloud/__main__.py
+.DS_Store

README.md

@@ -1,14 +1,16 @@
 # PyKasaCloud
 
+![GitHub Release](https://img.shields.io/github/v/release/iluvdata/PyKasaCloud)
+
 This is a library wrapper that allows you to connect to *some* TPLink/Kasa/Tapo devices via the cloud utilizing the excellent [python-kasa](https://pypi.org/project/python-kasa/) library.  Essentially this adds a transport and protocol class to facilitate this.  This has not been tested extensively as I only have access to "iot" protocol devices and I'm not sure if other devices utilize passthrough mechanism via the cloud api.
 
 ## Usage
 
 Rather than use discovery like `python-kasa` you must get connect to the cloud (providing credentials) to obtain a token.
 ```python
-cloud: KasaCloud = await KasaCloud.auth(username="username", password="password")
+cloud: KasaCloud = await KasaCloud.kasacloud(username="username", password="password")
 ```
-You can then get a dictionary of devices.  The deviceId in the cloud will be the keys and the values will be `kasa.Device`s.
+You can then get a dictionary of devices.  The `deviceId` in the cloud will be the keys and the values will be `kasa.Device`s.
 ```python
 devices: dict[str, Device] = cloud.getDevices()
 ```
@@ -18,23 +20,30 @@ You can then interact with these devices like python-kasa devices.
 
 To cache tokens to a json file, provide a path.
 ```python
-cloud: KasaCloud = await KasaCloud.auth(username="username", password="password", token_storage_file=".kasacloud.json")
+cloud: KasaCloud = await KasaCloud.kasacloud(username="username", password="password", token_storage_file=".kasacloud.json")
 ```
 Subsequent authenication can be accomplished just using the `token_storage_file` parameter.
 ```python
-cloud: KasaCloud = await KasaCloud.auth( token_storage_file=".kasacloud.json")
+cloud: KasaCloud = await KasaCloud.kasacloud( token_storage_file=".kasacloud.json")
 ```
 ### Refesh Token and Callbacks
-If you are storing the token externally, say in a HomeAssistant Config Entry simply pass a `Token` object:
+If you are storing the token externally, say in a HomeAssistant Config Entry simply pass a `Token` object (inside `async_setup_entry` in `__init__.py` of a given integration)
 ```python
 
-def token_update_callback(config_entry: ConfigEntry) -> Callable:
-    def updated_token(token: Token) -> None:
-        config_entry["token"] <- token
-    return update_token
-
-token = Token(**config_entry.get("token"))
-cloud: KasaCloud = await KasaCloud.auth(token=token, token_update_callback = token_update_callback(config_entry))
+async def update_token(token: Token) -> None:
+    data = entry.data | {TOKEN: token}
+    result = hass.config_entries.async_update_entry(
+        entry=entry, data=data, unique_id=entry.unique_id
+    )
+    if not result:
+        raise TokenUpdateError("Unable to update token in config entry")
+
+    try:
+        cloud: KasaCloud = await KasaCloud.kasacloud(
+            token=entry.data.get(TOKEN), token_update_callback=update_token
+        )
+    except AuthenticationError as err:
+        raise ConfigEntryAuthFailed(err) from err
 ```
 
 

pykasacloud/__init__.py

@@ -9,10 +9,4 @@
 
 __version__ = version("python-kasa")
 
-__all__ = [
-    "CloudTransport",
-    "KasaCloudError",
-    "CloudProtocol",
-    "KasaCloud",
-    "Token"
-]
+__all__ = ["CloudTransport", "KasaCloudError", "CloudProtocol", "KasaCloud", "Token"]

pykasacloud/const.py

@@ -1,5 +1,10 @@
 """Constants for PyKasaCloud integration."""
 
 API_URL = "https://wap.tplinkcloud.com"
-APPTYPE = "Kasa_Android"
+APPTYPE = "Tapo_Ios"
 USERAGENT = "User-Agent: Dalvik/2.1.0 (Linux; U; Android 6.0.1; A0001 Build/M4B30X)"
+TOKEN = "token"
+REFRESH_TOKEN = "refresh_token"
+CLIENT_ID = "client_id"
+ACCOUNT_ID = "account_id"
+APPSERVERURL = "appServerUrl"

pykasacloud/exceptions.py

@@ -1,23 +1,29 @@
 """Extension of python-kasa exceptions for Kasa Cloud integration."""
 
 from enum import IntEnum
+
 from kasa.exceptions import KasaException
 
+
 class KasaCloudError(KasaException):
     """Exception raised for errors in the Kasa Cloud API interaction."""
 
     def __init__(self, msg: str) -> None:
         """Initialize the KasaCloudError with a message."""
         super().__init__(msg)
 
+
 class MissingCredentials(KasaCloudError):
     """Exception raised when credentials are missing."""
 
+
 class CloudErrorCode(IntEnum):
     """Enum for cloud error codes."""
+
     SUCCESS = 0
     TOKEN_EXPIRED = -20651
     MISSING_METHOD = -20103
     MISSING_PARAMETER = -20104
     MISSING_REQUEST_DATA = -20573
     DEVICE_OFFLINE = -20571
+    ACCOUNT_NOT_FOUND = -20600

pykasacloud/kasacloud.py

@@ -1,8 +1,8 @@
 """KasaCloud."""
 
+from collections.abc import Callable, Coroutine
 import logging
 import time
-from collections.abc import Callable, Coroutine
 from typing import Any
 
 from kasa import Device, DeviceType
@@ -17,20 +17,18 @@
 )
 
 from .exceptions import KasaCloudError
-
 from .protocols import CloudProtocol
 from .transports import CloudTransport, Token
 
-_GET_DEVICES_QUERY: dict[str, str] = {
-   "method": "getDeviceList"
-}
+_GET_DEVICES_QUERY: dict[str, str] = {"method": "getDeviceList"}
 
 GET_SYSINFO_QUERY: dict[str, dict[str, dict]] = {
     "system": {"get_sysinfo": {}},
 }
 
 _LOGGER = logging.getLogger(__name__)
 
+
 class KasaCloud:
     """Class to instantiate and get devices."""
 
@@ -56,13 +54,22 @@ async def kasacloud(
             password=password,
             token=ctoken,
             token_storage_file=token_storage_file,
-            token_update_callback=token_update_callback
+            token_update_callback=token_update_callback,
         )
 
         return self
 
-    async def get_devices(self) -> dict[str, Device]:
-        """Get kasa devices from cloud."""
+    @property
+    def token(self) -> Token:
+        """Return the token associated with this authentication."""
+        return self._transport.token
+
+    async def close(self) -> None:
+        """Close the underlying resources."""
+        await self._transport.close()
+
+    async def get_device_list(self) -> dict[str, Any]:
+        """Get kasa device ids from cloud."""
 
         protocol: CloudProtocol = CloudProtocol(transport=self._transport)
 
@@ -73,16 +80,18 @@ async def get_devices(self) -> dict[str, Device]:
 
         device_list: list[dict[str, Any]] = resp["deviceList"]
 
-        device_dict: dict[str, Device] = {}
+        devices: dict[str, Any] = {}
         for device in device_list:
             if device["status"]:
-                device_dict[device["deviceId"]] = await self._get_device(device)
+                devices[device["deviceId"]] = device
 
-        return device_dict
+        return devices
 
-    async def _get_device(self, device_dict: dict[str, Any]) -> Device:
-        """Initantiate and populate the device.  
-        Taken from device_factory.py in python-kasa."""
+    async def get_device(self, device_dict: dict[str, Any]) -> Device:
+        """Initantiate and populate the device.
+
+        Taken from device_factory.py in python-kasa.
+        """
         debug_enabled = _LOGGER.isEnabledFor(logging.DEBUG)
         if debug_enabled:
             start_time = time.perf_counter()
@@ -116,9 +125,10 @@ def _perf_log(has_params: bool, perf_type: str) -> None:
         _perf_log(True, "update")
         return device
 
+
 def _get_device_class_from_sys_info(sysinfo: dict[str, Any]) -> type[IotDevice]:
     """Find SmartDevice subclass for device described by passed data."""
-    TYPE_TO_CLASS = { # pylint: disable=invalid-name
+    TYPE_TO_CLASS = {  # pylint: disable=invalid-name
         DeviceType.Bulb: IotBulb,
         DeviceType.Plug: IotPlug,
         DeviceType.Dimmer: IotDimmer,
@@ -128,4 +138,4 @@ def _get_device_class_from_sys_info(sysinfo: dict[str, Any]) -> type[IotDevice]:
         # Disabled until properly implemented
         # DeviceType.Camera: IotCamera,
     }
-    return TYPE_TO_CLASS[IotDevice._get_device_type_from_sys_info(sysinfo)] # pylint: disable=protected-access
+    return TYPE_TO_CLASS[IotDevice._get_device_type_from_sys_info(sysinfo)]  # pylint: disable=protected-access  # noqa: SLF001

pykasacloud/protocols/cloudprotocol.py

@@ -10,10 +10,11 @@
 from kasa.protocols.protocol import redact_data
 from yarl import URL
 
-from ..transports import CloudTransport
+from pykasacloud.transports import CloudTransport
 
 _LOGGER = logging.getLogger(__name__)
 
+
 class CloudProtocol(IotProtocol):
     """Cloud Protocol Class."""
 
@@ -36,7 +37,9 @@ async def _execute_query(self, request: str, retry_count: int) -> dict:
             )
         transport: CloudTransport = cast(CloudTransport, self._transport)
 
-        resp = await transport.send_request(json_loads(request), self._device_id, self._url)
+        resp = await transport.send_request(
+            json_loads(request), self._device_id, self._url
+        )
 
         if debug_enabled:
             data = redact_data(resp, REDACTORS) if self._redact_data else resp