switchbot-api 2.9.0__tar.gz → 2.11.0__tar.gz

{switchbot_api-2.9.0 → switchbot_api-2.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: switchbot_api
-Version: 2.9.0
+Version: 2.11.0
 Summary: An asynchronous library to use Switchbot API
 License: MIT
 License-File: LICENSE

{switchbot_api-2.9.0 → switchbot_api-2.11.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "switchbot_api"
-version = "2.9.0"
+version = "2.11.0"
 description = "An asynchronous library to use Switchbot API"
 authors = ["Ravaka Razafimanantsoa <contact@ravaka.dev>"]
 license = "MIT"
@@ -28,6 +28,7 @@ codespell = "^2.3.0"
 pre-commit = "^4.0.1"
 pre-commit-hooks = "^5.0.0"
 yamllint = "^1.35.1"
+pycryptodome = "^3.23.0"
 
 [tool.mypy]
 # Specify the target platform details in config, so your developers are

{switchbot_api-2.9.0 → switchbot_api-2.11.0}/switchbot_api/__init__.py

@@ -14,10 +14,13 @@ import uuid
 
 from aiohttp import ClientError, ClientResponseError, ClientSession
 from aiohttp.hdrs import METH_GET, METH_POST
+from Crypto.Cipher import AES
+from Crypto.Util.Padding import unpad
 
 from switchbot_api.commands import (
     AirConditionerCommands,
     AirPurifierCommands,
+    ArtFrameCommands,
     BatteryCirculatorFanCommands,
     BlindTiltCommands,
     BotCommands,
@@ -30,9 +33,11 @@ from switchbot_api.commands import (
     FanCommands,
     HumidifierCommands,
     HumidifierV2Commands,
+    KeyPadCommands,
     LightCommands,
     LockCommands,
     LockV2Commands,
+    LockV3Commands,
     OthersCommands,
     RGBWLightCommands,
     RGBWWLightCommands,
@@ -53,7 +58,10 @@ from switchbot_api.exceptions import (
     SwitchBotDeviceOfflineError,
 )
 from switchbot_api.models import (
+    AirPurifierFanGear,
+    AirPurifierMode,
     BatteryCirculatorFanMode,
+    BatteryLevel,
     PowerState,
     SmartRadiatorThermostatMode,
     VacuumCleanMode,
@@ -64,8 +72,12 @@ from switchbot_api.models import (
 __all__ = [
     "AirConditionerCommands",
     "AirPurifierCommands",
+    "AirPurifierFanGear",
+    "AirPurifierMode",
+    "ArtFrameCommands",
     "BatteryCirculatorFanCommands",
     "BatteryCirculatorFanMode",
+    "BatteryLevel",
     "BlindTiltCommands",
     "BotCommands",
     "CeilingLightCommands",
@@ -78,9 +90,11 @@ __all__ = [
     "FanCommands",
     "HumidifierCommands",
     "HumidifierV2Commands",
+    "KeyPadCommands",
     "LightCommands",
     "LockCommands",
     "LockV2Commands",
+    "LockV3Commands",
     "OthersCommands",
     "PowerState",
     "RGBWLightCommands",
@@ -236,9 +250,22 @@ class SwitchBotAPI:
         ]
         return [*devices, *remotes]
 
+    async def get_device(self, device_id: str) -> dict[str, Any]:
+        """Get target device."""
+        body = await self._request(METH_GET, "devices")
+        for device in body["deviceList"]:
+            if device_id == device["deviceId"]:
+                return device  # type: ignore[no-any-return]
+        return {}
+
     async def get_status(self, device_id: str) -> dict[str, Any]:
         """No status for IR devices."""
-        return await self._request(METH_GET, f"devices/{device_id}/status")
+        response = await self._request(METH_GET, f"devices/{device_id}/status")
+
+        device_type = response["deviceType"]
+        if device_type and device_type in KeyPadCommands.get_supported_devices():
+            return await self.get_device(device_id)
+        return response
 
     async def get_webook_configuration(self) -> dict[str, Any]:
         """List webhooks."""
@@ -292,6 +319,23 @@ class SwitchBotAPI:
         if self.session and self._close_session:
             await self.session.close()
 
+    def aes_128_cbc_decrypt(self, encrypt_text: str, aes_iv: str) -> str:
+        """Aes 128 cbc decrypt.
+
+        Args:
+            encrypt_text (str):
+            aes_iv (str):
+
+        Notes :  only for [Keypad, Keypad Touch, Keypad Vision, Keypad Vision Pro]
+
+        """
+        encrypt_bytes = base64.b64decode(encrypt_text)
+        cipher = AES.new(
+            bytes.fromhex(self.secret), AES.MODE_CBC, bytes.fromhex(aes_iv)
+        )
+        decrypt_bytes = unpad(cipher.decrypt(encrypt_bytes), AES.block_size)
+        return decrypt_bytes.decode("utf-8")
+
     async def __aenter__(self) -> Self:
         """Async enter.
 

{switchbot_api-2.9.0 → switchbot_api-2.11.0}/switchbot_api/commands.py

@@ -93,7 +93,21 @@ class LockV2Commands(Commands):
     @classmethod
     def get_supported_devices(cls) -> list[str]:
         """Get supported devices."""
-        return ["Smart Lock", "Smart Lock Pro", "Smart Lock Ultra"]
+        return ["Smart Lock", "Smart Lock Pro", "Smart Lock Ultra", "Smart Lock Vision"]
+
+
+class LockV3Commands(Commands):
+    """Lock commands."""
+
+    LOCK = "lock"
+    UNLOCK = "unlock"
+    DEADBOLT = "deadbolt"
+    NIGHT_LATCH_UNLOCK = "nightLatchUnlock"
+
+    @classmethod
+    def get_supported_devices(cls) -> list[str]:
+        """Get supported devices."""
+        return ["Smart Lock Vision Pro"]
 
 
 class HumidifierCommands(Commands):
@@ -134,6 +148,9 @@ class AirPurifierCommands(Commands):
 
     SET_MODE = "setMode"
     SET_CHILD_LOCK = "setChildLock"
+    SET_LIGHT_COLOR = "setLightColor"
+    SET_BRIGHTNESS = "setBrightness"
+    SET_LIGHT_SENSOR = "setLightSensor"
 
     @classmethod
     def get_supported_devices(cls) -> list[str]:
@@ -245,6 +262,7 @@ class ArtFrameCommands(Commands):
 
     PREVIOUS = "previous"
     NEXT = "next"
+    UPLOAD = "uploadImage"
 
     @classmethod
     def get_supported_devices(cls) -> list[str]:
@@ -427,7 +445,7 @@ class KeyPadCommands(Commands):
     @classmethod
     def get_supported_devices(cls) -> list[str]:
         """Get supported devices."""
-        return ["Keypad", "Keypad Touch", "Keypad Vision", "Keypad Vision pro"]
+        return ["Keypad", "Keypad Touch", "Keypad Vision", "Keypad Vision Pro"]
 
 
 T = TypeVar("T", bound=CommonCommands)

{switchbot_api-2.9.0 → switchbot_api-2.11.0}/switchbot_api/exceptions.py

@@ -15,3 +15,7 @@ class SwitchBotAuthenticationError(SwitchBotError):
 
 class SwitchBotDeviceOfflineError(SwitchBotError):
     """Device currently offline."""
+
+
+class SwitchBotDeviceRequestError(SwitchBotError):
+    """Device request error."""

{switchbot_api-2.9.0 → switchbot_api-2.11.0}/switchbot_api/models.py

@@ -21,6 +21,23 @@ class BatteryCirculatorFanMode(StrEnum):
     BABY = "baby"
 
 
+class AirPurifierMode(Enum):
+    """mode types [Air Purifier] API."""
+
+    LEVEL = 1
+    AUTO = 2
+    SLEEP = 3
+    PET = 4
+
+
+class AirPurifierFanGear(Enum):
+    """Air Purifier Fan Gear."""
+
+    High = 3
+    Medium = 2
+    Low = 1
+
+
 class VacuumFanSpeed(StrEnum):
     """Fan options for VacuumCommands supported devices."""
 

switchbot_api-2.11.0/switchbot_api/utils.py

@@ -0,0 +1,28 @@
+"""util for  SwitchBot API."""
+
+import aiohttp
+from aiohttp import ClientResponse
+
+from .exceptions import SwitchBotDeviceRequestError
+
+
+def check_response_status(response: ClientResponse) -> None:
+    """Check https response status."""
+    if response.status != 200:
+        msg = f"status code != 200 (actual: {response.status})"
+        raise SwitchBotDeviceRequestError(msg)
+
+
+async def get_file_stream_from_cloud(url: str, timeout: float = 5) -> bytes:
+    """Get file stream from cloud."""
+    # now only for download <AI Art Frame> Picture
+    try:
+        async with (
+            aiohttp.ClientSession() as session,
+            session.get(url, timeout=aiohttp.ClientTimeout(total=timeout)) as response,
+        ):
+            check_response_status(response)
+            return await response.read()
+    except Exception as e:
+        msg = f"{e}"
+        raise SwitchBotDeviceRequestError(msg) from e