1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
|
"""Base Commands for SwitchBot API."""
from __future__ import annotations
from enum import Enum
from typing import TypeVar
class Commands(Enum):
"""Base command class."""
@classmethod
def is_supported(cls, device_type: str) -> bool:
"""Is this commands supported this device type."""
return device_type in cls.get_supported_devices()
@classmethod
def get_supported_devices(cls) -> list[str]:
"""Get supported devices."""
return []
class CommonCommands(Commands):
"""Common commands."""
ON = "turnOn"
OFF = "turnOff"
TOGGLE = "toggle"
PRESS = "press"
# Considering the wide range of CommonCommands, they are not inherited here.
@classmethod
def is_supported(cls, device_type: str) -> bool:
"""Is this commands supported this device type."""
error_msg = "CommonCommands not implement this method"
raise NotImplementedError(error_msg)
@classmethod
def get_supported_devices(cls) -> list[str]:
"""Get supported devices."""
error_msg = "CommonCommands not implement this method"
raise NotImplementedError(error_msg)
class BotCommands(Commands):
"""Bot commands."""
PRESS = "press"
@classmethod
def get_supported_devices(cls) -> list[str]:
"""Get supported devices."""
return ["Bot"]
class OthersCommands(Commands):
"""Others commands."""
CUSTOMIZE = "customize" # Command {user-defined button name}
class CurtainCommands(Commands):
"""Curtain & Curtain3 commands."""
SET_POSITION = "setPosition" # parameter(str): index0,mode0,position0 e.g. 0,ff,80
PAUSE = "pause"
@classmethod
def get_supported_devices(cls) -> list[str]:
"""Get supported devices."""
return ["Curtain", "Curtain 3"]
class LockCommands(Commands):
"""Lock commands."""
LOCK = "lock"
UNLOCK = "unlock"
@classmethod
def get_supported_devices(cls) -> list[str]:
"""Get supported devices."""
return ["Smart Lock", "Smart Lock Lite", "Smart Lock Pro", "Smart Lock Ultra"]
class LockV2Commands(Commands):
"""Lock commands."""
LOCK = "lock"
UNLOCK = "unlock"
DEADBOLT = "deadbolt"
@classmethod
def get_supported_devices(cls) -> list[str]:
"""Get supported devices."""
return ["Smart Lock", "Smart Lock Pro", "Smart Lock Ultra"]
class HumidifierCommands(Commands):
"""Humidifier commands."""
# parameter: auto, set to Auto Mode
# 101, set atomization efficiency to 34%
# 102, set atomization efficiency to 67%
# 103, set atomization efficiency to 100%
SET_MODE = "setMode"
@classmethod
def get_supported_devices(cls) -> list[str]:
"""Get supported devices."""
return ["Humidifier"]
class HumidifierV2Commands(Commands):
"""Humidifier 2 commands."""
SET_MODE = "setMode"
SET_CHILD_LOCK = "setChildLock"
@classmethod
def get_supported_devices(cls) -> list[str]:
"""Get supported devices."""
return ["Humidifier 2"]
class AirPurifierCommands(Commands):
"""Purifier commands."""
# Supported Device list:
# Air Purifier VOC
# Air Purifier Table VOC
# Air Purifier PM2.5
# Air Purifier Table PM2.5
SET_MODE = "setMode"
SET_CHILD_LOCK = "setChildLock"
@classmethod
def get_supported_devices(cls) -> list[str]:
"""Get supported devices."""
return [
"Air Purifier VOC",
"Air Purifier Table VOC",
"Air Purifier PM2.5",
"Air Purifier Table PM2.5",
]
class AirConditionerCommands(Commands):
"""Air conditioner commands."""
SET_ALL = "setAll"
@classmethod
def get_supported_devices(cls) -> list[str]:
"""Get supported devices."""
return ["Air Conditioner"]
class SwitchCommands(Commands):
"""Switch commands."""
# Supported Device list:
# Relay Switch 1
# Relay Switch 1PM
SET_MODE = "setMode"
@classmethod
def get_supported_devices(cls) -> list[str]:
"""Get supported devices."""
return ["Relay Switch 1", "Relay Switch 1PM"]
class Switch2PMCommands(Commands):
"""Switch commands."""
# Supported Device list:
# Relay Switch 2PM
SET_MODE = "setMode"
SET_POSITION = "setPosition"
@classmethod
def get_supported_devices(cls) -> list[str]:
"""Get supported devices."""
return ["Relay Switch 2PM"]
class RGBWLightCommands(Commands):
"""RGBWLight commands."""
# Supported Device list:
# Strip Light
SET_BRIGHTNESS = "setBrightness"
SET_COLOR = "setColor"
@classmethod
def get_supported_devices(cls) -> list[str]:
"""Get supported devices."""
return ["Strip Light"]
class RGBWWLightCommands(Commands):
"""RGBWwLight commands."""
# Supported Device list:
# Floor Lamp
# Strip Light 3
# Color Bulb
SET_BRIGHTNESS = "setBrightness"
SET_COLOR = "setColor"
SET_COLOR_TEMPERATURE = "setColorTemperature"
@classmethod
def get_supported_devices(cls) -> list[str]:
"""Get supported devices."""
return ["Strip Light 3", "Floor Lamp", "Color Bulb"]
class DoorBellCommands(Commands):
"""Door Bell commands."""
ENABLE = "enableMotionDetection"
DISABLE = "disableMotionDetection"
@classmethod
def get_supported_devices(cls) -> list[str]:
"""Get supported devices."""
return ["Video Doorbell"]
class VacuumCommands(Commands):
"""Vacuum commands."""
START = "start"
STOP = "stop"
DOCK = "dock"
POW_LEVEL = "PowLevel"
@classmethod
def get_supported_devices(cls) -> list[str]:
"""Get supported devices."""
return [
"K10+",
"K10+ Pro",
"Robot Vacuum Cleaner S1",
"Robot Vacuum Cleaner S1 Plus",
]
class VacuumCleanerV2Commands(Commands):
"""VacuumCleanerV2 commands."""
# Supported Device list:
# K20+ Pro
# Robot Vacuum Cleaner K10+ Pro Combo
START_CLEAN = "startClean"
PAUSE = "pause"
DOCK = "dock"
SET_VOLUME = "setVolume"
CHANGE_PARAM = "changeParam"
@classmethod
def get_supported_devices(cls) -> list[str]:
"""Get supported devices."""
return ["K20+ Pro", "Robot Vacuum Cleaner K10+ Pro Combo"]
class VacuumCleanerV3Commands(Commands):
"""VacuumCleanerV3 commands."""
# Supported Device list:
# Floor Cleaning Robot S10
# S20
START_CLEAN = "startClean"
PAUSE = "pause"
DOCK = "dock"
SET_VOLUME = "setVolume"
CHANGE_PARAM = "changeParam"
ADD_WATER_FOR_HUMI = "addWaterForHumi"
SELF_CLEAN = "selfClean"
@classmethod
def get_supported_devices(cls) -> list[str]:
"""Get supported devices."""
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."""
SET_POSITION = "setPosition"
FULLY_OPEN = "fullyOpen"
CLOSE_UP = "closeUp"
CLOSE_DOWN = "closeDown"
@classmethod
def get_supported_devices(cls) -> list[str]:
"""Get supported devices."""
return ["Blind Tilt"]
class RollerShadeCommands(Commands):
"""Roller Shade commands."""
SET_POSITION = "setPosition"
@classmethod
def get_supported_devices(cls) -> list[str]:
"""Get supported devices."""
return ["Roller Shade"]
class BatteryCirculatorFanCommands(Commands):
"""Command types for [Battery Circulator Fan] API."""
SET_WIND_SPEED = "setWindSpeed"
SET_WIND_MODE = "setWindMode"
SET_NIGHT_LIGHT_MODE = "setNightLightMode"
@classmethod
def get_supported_devices(cls) -> list[str]:
"""Get supported devices."""
return ["Circulator Fan", "Battery Circulator Fan"]
class TVCommands(Commands):
"""TV commands."""
SET_CHANNEL = "SetChannel"
VOLUME_ADD = "volumeAdd"
VOLUME_SUB = "volumeSub"
CHANNEL_ADD = "channelAdd"
CHANNEL_SUB = "channelSub"
class DVDCommands(Commands):
"""DVD commands."""
SET_MUTE = "setMute"
FAST_FORWARD = "FastForward"
REWIND = "Rewind"
NEXT = "Next"
PREVIOUS = "Previous"
PAUSE = "Pause"
PLAY = "Play"
STOP = "Stop"
class SpeakerCommands(Commands):
"""Speaker commands."""
VOLUME_ADD = "volumeAdd"
VOLUME_SUB = "volumeSub"
class FanCommands(Commands):
"""Fan commands."""
SWING = "swing"
TIMER = "timer"
LOW_SPEED = "lowSpeed"
MIDDLE_SPEED = "middleSpeed"
HIGH_SPEED = "highSpeed"
class LightCommands(Commands):
"""Light commands."""
BRIGHTNESS_UP = "brightnessUp"
BRIGHTNESS_DOWN = "brightnessDown"
class SmartRadiatorThermostatCommands(Commands):
"""Smart Radiator Thermostat commands."""
SET_MODE = "setMode"
SET_MANUAL_MODE_TEMPERATURE = "setManualModeTemperature"
@classmethod
def get_supported_devices(cls) -> list[str]:
"""Get supported devices."""
return ["Smart Radiator Thermostat"]
T = TypeVar("T", bound=CommonCommands)
|