switchbot-api 2.11.1__tar.gz → 2.13.0__tar.gz

{switchbot_api-2.11.1 → switchbot_api-2.13.0}/PKG-INFO

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

{switchbot_api-2.11.1 → switchbot_api-2.13.0}/pyproject.toml

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

{switchbot_api-2.11.1 → switchbot_api-2.13.0}/switchbot_api/__init__.py

@@ -33,12 +33,14 @@ from switchbot_api.commands import (
     FanCommands,
     HumidifierCommands,
     HumidifierV2Commands,
+    KataFriendsCommands,
     KeyPadCommands,
     LightCommands,
     LockCommands,
     LockV2Commands,
     LockV3Commands,
     OthersCommands,
+    RGBICWWCeilingLightCommands,
     RGBWLightCommands,
     RGBWWLightCommands,
     RollerShadeCommands,
@@ -56,14 +58,24 @@ from switchbot_api.exceptions import (
     SwitchBotAuthenticationError,
     SwitchBotConnectionError,
     SwitchBotDeviceOfflineError,
+    SwitchBotDeviceRequestError,
+    SwitchBotError,
 )
 from switchbot_api.models import (
     AirPurifierFanGear,
     AirPurifierMode,
+    AirPurifierModeV2,
+    BatteryCirculatorFan2ProMode,
     BatteryCirculatorFanMode,
     BatteryLevel,
+    Humidifier2Mode,
+    KataFriendsHospitalizedStatus,
+    KataFriendsMode,
+    KataFriendsWorkStatus,
     PowerState,
     SmartRadiatorThermostatMode,
+    Switch,
+    SwitchbotCloudDeviceLockState,
     VacuumCleanMode,
     VacuumFanSpeed,
     VacuumFanSpeedV2,
@@ -74,7 +86,9 @@ __all__ = [
     "AirPurifierCommands",
     "AirPurifierFanGear",
     "AirPurifierMode",
+    "AirPurifierModeV2",
     "ArtFrameCommands",
+    "BatteryCirculatorFan2ProMode",
     "BatteryCirculatorFanCommands",
     "BatteryCirculatorFanMode",
     "BatteryLevel",
@@ -88,8 +102,13 @@ __all__ = [
     "Device",
     "DoorBellCommands",
     "FanCommands",
+    "Humidifier2Mode",
     "HumidifierCommands",
     "HumidifierV2Commands",
+    "KataFriendsCommands",
+    "KataFriendsHospitalizedStatus",
+    "KataFriendsMode",
+    "KataFriendsWorkStatus",
     "KeyPadCommands",
     "LightCommands",
     "LockCommands",
@@ -97,6 +116,7 @@ __all__ = [
     "LockV3Commands",
     "OthersCommands",
     "PowerState",
+    "RGBICWWCeilingLightCommands",
     "RGBWLightCommands",
     "RGBWWLightCommands",
     "Remote",
@@ -104,9 +124,16 @@ __all__ = [
     "SmartRadiatorThermostatCommands",
     "SmartRadiatorThermostatMode",
     "SpeakerCommands",
+    "Switch",
     "Switch2PMCommands",
     "SwitchBotAPI",
+    "SwitchBotAuthenticationError",
+    "SwitchBotConnectionError",
+    "SwitchBotDeviceOfflineError",
+    "SwitchBotDeviceRequestError",
+    "SwitchBotError",
     "SwitchCommands",
+    "SwitchbotCloudDeviceLockState",
     "T",
     "TVCommands",
     "VacuumCleanMode",

{switchbot_api-2.11.1 → switchbot_api-2.13.0}/switchbot_api/commands.py

@@ -60,7 +60,7 @@ class OthersCommands(Commands):
 
 
 class CurtainCommands(Commands):
-    """Curtain & Curtain3 commands."""
+    """Curtain & Curtain3  & Curtain4 commands."""
 
     SET_POSITION = "setPosition"  # parameter(str): index0,mode0,position0  e.g. 0,ff,80
     PAUSE = "pause"
@@ -68,7 +68,7 @@ class CurtainCommands(Commands):
     @classmethod
     def get_supported_devices(cls) -> list[str]:
         """Get supported devices."""
-        return ["Curtain", "Curtain 3"]
+        return ["Curtain", "Curtain 3", "Curtain 4"]
 
 
 class LockCommands(Commands):
@@ -240,6 +240,8 @@ class RGBWWLightCommands(Commands):
             "Color Bulb",
             "RGBICWW Floor Lamp",
             "RGBICWW Strip Light",
+            "Permanent Outdoor Lights",
+            "RGBICWW Light Bars",
         ]
 
 
@@ -257,6 +259,33 @@ class CeilingLightCommands(Commands):
         return ["Ceiling Light", "Ceiling Light Pro"]
 
 
+class RGBICWWCeilingLightCommands(Commands):
+    """RGBICWW Ceiling Light commands.
+
+    The RGBICWW Ceiling Light has two independent sub-lights:
+    a main light (color temperature + brightness) and a
+    color light (RGB + brightness).
+    """
+
+    TURN_ON_MAIN_LIGHT = "turnOnMainLight"
+    TURN_OFF_MAIN_LIGHT = "turnOffMainLight"
+    TURN_ON_COLOR_LIGHT = "turnOnColorLight"
+    TURN_OFF_COLOR_LIGHT = "turnOffColorLight"
+    # 1-100
+    SET_MAIN_LIGHT_BRIGHTNESS = "setMainLightBrightness"
+    # 2700-6500
+    SET_MAIN_LIGHT_COLOR_TEMP = "setMainLightColorTemp"
+    # 1-100
+    SET_COLOR_LIGHT_BRIGHTNESS = "setColorLightBrightness"
+    # R:G:B
+    SET_COLOR_LIGHT_RGB = "setColorLightRGB"
+
+    @classmethod
+    def get_supported_devices(cls) -> list[str]:
+        """Get supported devices."""
+        return ["RGBICWW Ceiling Light"]
+
+
 class ArtFrameCommands(Commands):
     """AI Art Frame commands."""
 
@@ -267,7 +296,7 @@ class ArtFrameCommands(Commands):
     @classmethod
     def get_supported_devices(cls) -> list[str]:
         """Get supported devices."""
-        return ["AI Art Frame"]
+        return ["AI Art Frame", "AI Art Frame Luma"]
 
 
 class DoorBellCommands(Commands):
@@ -374,7 +403,11 @@ class BatteryCirculatorFanCommands(Commands):
     @classmethod
     def get_supported_devices(cls) -> list[str]:
         """Get supported devices."""
-        return ["Circulator Fan", "Battery Circulator Fan"]
+        return [
+            "Circulator Fan",
+            "Battery Circulator Fan",
+            "Battery Circulator Fan 2 Pro",
+        ]
 
 
 class TVCommands(Commands):
@@ -448,4 +481,20 @@ class KeyPadCommands(Commands):
         return ["Keypad", "Keypad Touch", "Keypad Vision", "Keypad Vision Pro"]
 
 
+class KataFriendsCommands(Commands):
+    """Kata Friends commands."""
+
+    MODE = "mode"
+    BACK_HOME = "backHome"
+    SNAPSHOTS = "snapshots"
+    CHILD_LOCK = "childLock"
+    PICTURE_TAKING = "pictureTaking"
+    TALK = "talk"
+
+    @classmethod
+    def get_supported_devices(cls) -> list[str]:
+        """Get supported devices."""
+        return ["Kata Friends"]
+
+
 T = TypeVar("T", bound=CommonCommands)

{switchbot_api-2.11.1 → switchbot_api-2.13.0}/switchbot_api/models.py

@@ -21,6 +21,16 @@ class BatteryCirculatorFanMode(StrEnum):
     BABY = "baby"
 
 
+class BatteryCirculatorFan2ProMode(StrEnum):
+    """Fan mode types [Battery Circulator Fan2 Pro] API."""
+
+    DIRECT = "direct"
+    NATURAL = "natural"
+    SLEEP = "sleep"
+    BABY = "baby"
+    HURRICANE = "hurricane"
+
+
 class AirPurifierMode(Enum):
     """mode types [Air Purifier] API."""
 
@@ -30,6 +40,20 @@ class AirPurifierMode(Enum):
     PET = 4
 
 
+class AirPurifierModeV2(Enum):
+    """Air Purifier Modes."""
+
+    NORMAL = 1
+    AUTO = 2
+    SLEEP = 3
+    PET = 4
+
+    @classmethod
+    def get_modes(cls) -> list[str]:
+        """Return a list of available air purifier modes as lowercase strings."""
+        return [mode.name.lower() for mode in cls]
+
+
 class AirPurifierFanGear(Enum):
     """Air Purifier Fan Gear."""
 
@@ -108,3 +132,78 @@ class BatteryLevel(Enum):
         if 10 > value >= 0:
             return cls.Critical
         return cls.Unknown
+
+
+class Switch(Enum):
+    """Switch parameter."""
+
+    ON = "on"
+    OFF = "off"
+
+
+class KataFriendsMode(Enum):
+    """Kata Friends Mode."""
+
+    NORMAL = "Normal"
+    STANDBY = "Standby"
+    SLEEP = "Sleep"
+
+
+class KataFriendsWorkStatus(Enum):
+    """Kata Friends Work Status."""
+
+    STROLLING = "Strolling"
+    WELCOMING_HOME = "Welcoming Home"
+    WAKE_UP_CALL = "Wake-up Call"
+    SLEEPING = "Sleeping"
+    PLAYING = "Playing"
+    RETURNING = "Returning"
+
+
+class KataFriendsHospitalizedStatus(Enum):
+    """Kata Friends Hospitalized Status."""
+
+    NORMAL = 0
+    REPAIR = 1
+    MAINTAIN = 2
+    CLEAN = 3
+
+
+class Humidifier2Mode(Enum):
+    """Enumerates the available modes for a SwitchBot humidifier2."""
+
+    HIGH = 1
+    MEDIUM = 2
+    LOW = 3
+    QUIET = 4
+    TARGET_HUMIDITY = 5
+    SLEEP = 6
+    AUTO = 7
+    DRYING_FILTER = 8
+
+    @classmethod
+    def get_modes(cls) -> list[str]:
+        """Return a list of available humidifier2 modes as lowercase strings."""
+        return [mode.name.lower() for mode in cls]
+
+
+class SwitchbotCloudDeviceLockState(Enum):
+    """Lock State."""
+
+    LOCKED = "locked"
+    UNLOCKED = "unlocked"
+    LOCKING = "locking"
+    UNLOCKING = "unlocking"
+    JAMMED = "jammed"
+    LATCH_BOLT_LOCKED = "latchBoltLocked"
+    HALF_LOCKED = "halfLocked"
+
+    @classmethod
+    def get_states(cls) -> list[SwitchbotCloudDeviceLockState]:
+        """Get lock states."""
+        return list(cls)
+
+    @classmethod
+    def get_values(cls) -> list[str]:
+        """Get lock value."""
+        return [mode.value for mode in cls]