switchbot-api 2.8.0__tar.gz → 2.10.0__tar.gz

{switchbot_api-2.8.0 → switchbot_api-2.10.0}/PKG-INFO

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

{switchbot_api-2.8.0 → switchbot_api-2.10.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "switchbot_api"
-version = "2.8.0"
+version = "2.10.0"
 description = "An asynchronous library to use Switchbot API"
 authors = ["Ravaka Razafimanantsoa <contact@ravaka.dev>"]
 license = "MIT"

{switchbot_api-2.8.0 → switchbot_api-2.10.0}/switchbot_api/__init__.py

@@ -18,6 +18,7 @@ from aiohttp.hdrs import METH_GET, METH_POST
 from switchbot_api.commands import (
     AirConditionerCommands,
     AirPurifierCommands,
+    ArtFrameCommands,
     BatteryCirculatorFanCommands,
     BlindTiltCommands,
     BotCommands,
@@ -30,9 +31,11 @@ from switchbot_api.commands import (
     FanCommands,
     HumidifierCommands,
     HumidifierV2Commands,
+    KeyPadCommands,
     LightCommands,
     LockCommands,
     LockV2Commands,
+    LockV3Commands,
     OthersCommands,
     RGBWLightCommands,
     RGBWWLightCommands,
@@ -54,6 +57,7 @@ from switchbot_api.exceptions import (
 )
 from switchbot_api.models import (
     BatteryCirculatorFanMode,
+    BatteryLevel,
     PowerState,
     SmartRadiatorThermostatMode,
     VacuumCleanMode,
@@ -64,8 +68,10 @@ from switchbot_api.models import (
 __all__ = [
     "AirConditionerCommands",
     "AirPurifierCommands",
+    "ArtFrameCommands",
     "BatteryCirculatorFanCommands",
     "BatteryCirculatorFanMode",
+    "BatteryLevel",
     "BlindTiltCommands",
     "BotCommands",
     "CeilingLightCommands",
@@ -78,9 +84,11 @@ __all__ = [
     "FanCommands",
     "HumidifierCommands",
     "HumidifierV2Commands",
+    "KeyPadCommands",
     "LightCommands",
     "LockCommands",
     "LockV2Commands",
+    "LockV3Commands",
     "OthersCommands",
     "PowerState",
     "RGBWLightCommands",

{switchbot_api-2.8.0 → switchbot_api-2.10.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):
@@ -190,13 +204,15 @@ class RGBWLightCommands(Commands):
 
     # Supported Device list:
     # Strip Light
+    # RGBIC Neon Rope Light
+    # RGBIC Neon Wire Rope Light
     SET_BRIGHTNESS = "setBrightness"
     SET_COLOR = "setColor"
 
     @classmethod
     def get_supported_devices(cls) -> list[str]:
         """Get supported devices."""
-        return ["Strip Light"]
+        return ["Strip Light", "RGBIC Neon Rope Light", "RGBIC Neon Wire Rope Light"]
 
 
 class RGBWWLightCommands(Commands):
@@ -206,6 +222,8 @@ class RGBWWLightCommands(Commands):
     # Floor Lamp
     # Strip Light 3
     # Color Bulb
+    # RGBICWW Floor Lamp
+    # RGBICWW Strip Light
     SET_BRIGHTNESS = "setBrightness"
     SET_COLOR = "setColor"
     SET_COLOR_TEMPERATURE = "setColorTemperature"
@@ -213,7 +231,39 @@ class RGBWWLightCommands(Commands):
     @classmethod
     def get_supported_devices(cls) -> list[str]:
         """Get supported devices."""
-        return ["Strip Light 3", "Floor Lamp", "Color Bulb"]
+        return [
+            "Strip Light 3",
+            "Floor Lamp",
+            "Color Bulb",
+            "RGBICWW Floor Lamp",
+            "RGBICWW Strip Light",
+        ]
+
+
+class CeilingLightCommands(Commands):
+    """Ceiling light commands."""
+
+    # 1-100
+    SET_BRIGHTNESS = "setBrightness"
+    # 2700-6500
+    SET_COLOR_TEMPERATURE = "setColorTemperature"
+
+    @classmethod
+    def get_supported_devices(cls) -> list[str]:
+        """Get supported devices."""
+        return ["Ceiling Light", "Ceiling Light Pro"]
+
+
+class ArtFrameCommands(Commands):
+    """AI Art Frame commands."""
+
+    PREVIOUS = "previous"
+    NEXT = "next"
+
+    @classmethod
+    def get_supported_devices(cls) -> list[str]:
+        """Get supported devices."""
+        return ["AI Art Frame"]
 
 
 class DoorBellCommands(Commands):
@@ -285,20 +335,6 @@ class VacuumCleanerV3Commands(Commands):
         return ["Robot Vacuum Cleaner S10", "S20"]
 
 
-class CeilingLightCommands(Commands):
-    """Ceiling light commands."""
-
-    # 1-100
-    SET_BRIGHTNESS = "setBrightness"
-    # 2700-6500
-    SET_COLOR_TEMPERATURE = "setColorTemperature"
-
-    @classmethod
-    def get_supported_devices(cls) -> list[str]:
-        """Get supported devices."""
-        return ["Ceiling Light", "Ceiling Light Pro"]
-
-
 class BlindTiltCommands(Commands):
     """Blind Tilt commands."""
 
@@ -396,4 +432,16 @@ class SmartRadiatorThermostatCommands(Commands):
         return ["Smart Radiator Thermostat"]
 
 
+class KeyPadCommands(Commands):
+    """Keypad commands."""
+
+    DELETE_KEY = "deleteKey"
+    CREATE_KEY = "createKey"
+
+    @classmethod
+    def get_supported_devices(cls) -> list[str]:
+        """Get supported devices."""
+        return ["Keypad", "Keypad Touch", "Keypad Vision", "Keypad Vision pro"]
+
+
 T = TypeVar("T", bound=CommonCommands)

{switchbot_api-2.8.0 → switchbot_api-2.10.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.8.0 → switchbot_api-2.10.0}/switchbot_api/models.py

@@ -68,3 +68,26 @@ class SmartRadiatorThermostatMode(Enum):
             cls.COMFORT,
             cls.FAST_HEATING,
         ]
+
+
+class BatteryLevel(Enum):
+    """Battery Level modes."""
+
+    High = "high"
+    Medium = "medium"
+    Low = "low"
+    Critical = "critical"
+    Unknown = "unknown"
+
+    @classmethod
+    def get_battery_level(cls, value: int) -> BatteryLevel:
+        """Return a battery level."""
+        if 100 >= value >= 60:
+            return cls.High
+        if 60 > value >= 20:
+            return cls.Medium
+        if 20 > value >= 10:
+            return cls.Low
+        if 10 > value >= 0:
+            return cls.Critical
+        return cls.Unknown

switchbot_api-2.10.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