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 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
|
"""Basic implementation for HUAYI HUIZUO LAMPS (huayi.light.*)
These lamps have a white color only and support dimming and control of the temperature
from 3000K to 6400K
"""
import logging
from typing import Any, Dict, Optional
import click
from .click_common import command, format_output
from .exceptions import DeviceException
from .miot_device import DeviceStatus, MiotDevice
_LOGGER = logging.getLogger(__name__)
# Lights with the basic support
MODEL_HUIZUO_PIS123 = "huayi.light.pis123"
MODEL_HUIZUO_ARI013 = "huayi.light.ari013"
MODEL_HUIZUO_ARIES = "huayi.light.aries"
MODEL_HUIZUO_PEG091 = "huayi.light.peg091"
MODEL_HUIZUO_PEG093 = "huayi.light.peg093"
MODEL_HUIZUO_PISCES = "huayi.light.pisces"
MODEL_HUIZUO_TAU023 = "huayi.light.tau023"
MODEL_HUIZUO_TAURUS = "huayi.light.taurus"
MODEL_HUIZUO_VIR063 = "huayi.light.vir063"
MODEL_HUIZUO_VIRGO = "huayi.light.virgo"
MODEL_HUIZUO_WY = "huayi.light.wy"
MODEL_HUIZUO_ZW131 = "huayi.light.zw131"
# Lights: basic + fan
MODEL_HUIZUO_FANWY = "huayi.light.fanwy"
MODEL_HUIZUO_FANWY2 = "huayi.light.fanwy2"
# Lights: basic + scene
MODEL_HUIZUO_WY200 = "huayi.light.wy200"
MODEL_HUIZUO_WY201 = "huayi.light.wy201"
MODEL_HUIZUO_WY202 = "huayi.light.wy202"
MODEL_HUIZUO_WY203 = "huayi.light.wy203"
# Lights: basic + heater
MODEL_HUIZUO_WYHEAT = "huayi.light.wyheat"
BASIC_MODELS = [
MODEL_HUIZUO_PIS123,
MODEL_HUIZUO_ARI013,
MODEL_HUIZUO_ARIES,
MODEL_HUIZUO_PEG091,
MODEL_HUIZUO_PEG093,
MODEL_HUIZUO_PISCES,
MODEL_HUIZUO_TAU023,
MODEL_HUIZUO_TAURUS,
MODEL_HUIZUO_VIR063,
MODEL_HUIZUO_VIRGO,
MODEL_HUIZUO_WY,
MODEL_HUIZUO_ZW131,
]
MODELS_WITH_FAN_WY = [MODEL_HUIZUO_FANWY]
MODELS_WITH_FAN_WY2 = [MODEL_HUIZUO_FANWY2]
MODELS_WITH_SCENES = [
MODEL_HUIZUO_WY200,
MODEL_HUIZUO_WY201,
MODEL_HUIZUO_WY202,
MODEL_HUIZUO_WY203,
]
MODELS_WITH_HEATER = [MODEL_HUIZUO_WYHEAT]
MODELS_SUPPORTED = BASIC_MODELS
# Define a basic mapping for properties, which exists for all lights
_MAPPING = {
"power": {"siid": 2, "piid": 1}, # Boolean: True, False
"brightness": {"siid": 2, "piid": 2}, # Percentage: 1-100
"color_temp": {
"siid": 2,
"piid": 3,
}, # Kelvin: 3000-6400 (but for MODEL_HUIZUO_FANWY2: 3000-5700!)
}
_ADDITIONAL_MAPPING_FAN_WY2 = { # for MODEL_HUIZUO_FANWY2
"fan_power": {"siid": 3, "piid": 1}, # Boolean: True, False
"fan_level": {"siid": 3, "piid": 2}, # Percentage: 1-100
"fan_mode": {"siid": 3, "piid": 3}, # Enum: 0 - Basic, 1 - Natural wind
}
_ADDITIONAL_MAPPING_FAN_WY = { # for MODEL_HUIZUO_FANWY
"fan_power": {"siid": 3, "piid": 1}, # Boolean: True, False
"fan_level": {"siid": 3, "piid": 2}, # Percentage: 1-100
"fan_motor_reverse": {"siid": 3, "piid": 3}, # Boolean: True, False
"fan_mode": {"siid": 3, "piid": 4}, # Enum: 0 - Basic, 1 - Natural wind
}
_ADDITIONAL_MAPPING_HEATER = {
"heater_power": {"siid": 3, "piid": 1}, # Boolean: True, False
"heater_fault_code": {"siid": 3, "piid": 1}, # Fault code: 0 means "No fault"
"heat_level": {"siid": 3, "piid": 1}, # Enum: 1-3
}
_ADDITIONAL_MAPPING_SCENE = { # Only for write, send "0" to activate
"on_off": {"siid": 3, "piid": 1},
"brightness_increase": {"siid": 3, "piid": 2},
"brightness_decrease": {"siid": 3, "piid": 3},
"brightness_switch": {"siid": 3, "piid": 4},
"colortemp_increase": {"siid": 3, "piid": 5},
"colortemp_decrease": {"siid": 3, "piid": 6},
"colortemp_switch": {"siid": 3, "piid": 7},
"on_or_increase_brightness": {"siid": 3, "piid": 8},
"on_or_increase_colortemp": {"siid": 3, "piid": 9},
}
class HuizuoException(DeviceException):
pass
class HuizuoStatus(DeviceStatus):
def __init__(self, data: Dict[str, Any]) -> None:
self.data = data
@property
def is_on(self) -> bool:
"""Return True if device is on."""
return self.data["power"]
@property
def brightness(self) -> int:
"""Return current brightness."""
return self.data["brightness"]
@property
def color_temp(self) -> int:
"""Return current color temperature."""
return self.data["color_temp"]
@property
def is_fan_on(self) -> Optional[bool]:
"""Return True if Fan is on."""
if "fan_power" in self.data:
return self.data["fan_power"]
return None
@property
def fan_speed_level(self) -> Optional[int]:
"""Return current Fan speed level."""
if "fan_level" in self.data:
return self.data["fan_level"]
return None
@property
def is_fan_reverse(self) -> Optional[bool]:
"""Return True if Fan reverse is on."""
if "fan_motor_reverse" in self.data:
return self.data["fan_motor_reverse"]
return None
@property
def fan_mode(self) -> Optional[int]:
"""Return 0 if 'Basic' and 1 if 'Natural wind'."""
if "fan_mode" in self.data:
return self.data["fan_mode"]
return None
@property
def is_heater_on(self) -> Optional[bool]:
"""Return True if Heater is on."""
if "heater_power" in self.data:
return self.data["heater_power"]
return None
@property
def heater_fault_code(self) -> Optional[int]:
"""Return Heater's fault code.
0 - No Fault
"""
if "heater_fault_code" in self.data:
return self.data["heater_fault_code"]
return None
@property
def heat_level(self) -> Optional[int]:
"""Return Heater's heat level."""
if "heat_level" in self.data:
return self.data["heat_level"]
return None
class Huizuo(MiotDevice):
"""A basic support for Huizuo Lamps.
Example: response of a Huizuo Pisces For Bedroom (huayi.light.pis123)
{'id': 1, 'result': [
{'did': '', 'siid': 2, 'piid': 1, 'code': 0, 'value': False},
{'did': '', 'siid': 2, 'piid': 2, 'code': 0, 'value': 94},
{'did': '', 'siid': 2, 'piid': 3, 'code': 0, 'value': 6400}
]
}
Explanation (line-by-line):
power = '{"siid":2,"piid":1}' values = true,false
brightless(%) = '{"siid":2,"piid":2}' values = 1-100
color temperature(Kelvin) = '{"siid":2,"piid":3}' values = 3000-6400
This is basic response for all HUIZUO lamps
Also some models supports additional properties, like for Fan or Heating management.
If your device does't support some properties, the 'None' will be returned
"""
mapping = _MAPPING
_supported_models = MODELS_SUPPORTED
def __init__(
self,
ip: str = None,
token: str = None,
start_id: int = 0,
debug: int = 0,
lazy_discover: bool = True,
model: str = MODEL_HUIZUO_PIS123,
) -> None:
if model in MODELS_WITH_FAN_WY:
self.mapping.update(_ADDITIONAL_MAPPING_FAN_WY)
if model in MODELS_WITH_FAN_WY2:
self.mapping.update(_ADDITIONAL_MAPPING_FAN_WY2)
if model in MODELS_WITH_SCENES:
self.mapping.update(_ADDITIONAL_MAPPING_SCENE)
if model in MODELS_WITH_HEATER:
self.mapping.update(_ADDITIONAL_MAPPING_HEATER)
super().__init__(ip, token, start_id, debug, lazy_discover, model=model)
if model not in MODELS_SUPPORTED:
self._model = MODEL_HUIZUO_PIS123
_LOGGER.error(
"Device model %s unsupported. Falling back to %s.", model, self.model
)
@command(
default_output=format_output("Powering on"),
)
def on(self):
"""Power on."""
return self.set_property("power", True)
@command(
default_output=format_output("Powering off"),
)
def off(self):
"""Power off."""
return self.set_property("power", False)
@command(
default_output=format_output(
"\n",
"------------ Basic parameters for lamp -----------\n"
"Power: {result.is_on}\n"
"Brightness: {result.brightness}\n"
"Color Temperature: {result.color_temp}\n"
"\n",
),
)
def status(self) -> HuizuoStatus:
"""Retrieve properties."""
return HuizuoStatus(
{
prop["did"]: prop["value"] if prop["code"] == 0 else None
for prop in self.get_properties_for_mapping()
}
)
@command(
click.argument("level", type=int),
default_output=format_output("Setting brightness to {level}"),
)
def set_brightness(self, level):
"""Set brightness."""
if level < 0 or level > 100:
raise HuizuoException("Invalid brightness: %s" % level)
return self.set_property("brightness", level)
@command(
click.argument("color_temp", type=int),
default_output=format_output("Setting color temperature to {color_temp}"),
)
def set_color_temp(self, color_temp):
"""Set color temp in kelvin."""
# I don't know why only one lamp has smaller color temperature (based on specs),
# but let's process it correctly
if self.model == MODELS_WITH_FAN_WY2:
max_color_temp = 5700
else:
max_color_temp = 6400
if color_temp < 3000 or color_temp > max_color_temp:
raise HuizuoException("Invalid color temperature: %s" % color_temp)
return self.set_property("color_temp", color_temp)
class HuizuoLampFan(Huizuo):
"""Support for Huizuo Lamps with fan.
The next section contains the fan management commands Right now I have no devices
with the fan for live testing, so the following section generated based on device
specitifations
"""
@command(
default_output=format_output("Fan powering on"),
)
def fan_on(self):
"""Power fan on (only for models with fan)."""
if self.model in MODELS_WITH_FAN_WY or self.model in MODELS_WITH_FAN_WY2:
return self.set_property("fan_power", True)
raise HuizuoException("Your device doesn't support a fan management")
@command(
default_output=format_output("Fan powering off"),
)
def fan_off(self):
"""Power fan off (only for models with fan)."""
if self.model in MODELS_WITH_FAN_WY or self.model in MODELS_WITH_FAN_WY2:
return self.set_property("fan_power", False)
raise HuizuoException("Your device doesn't support a fan management")
@command(
click.argument("fan_level", type=int),
default_output=format_output("Setting fan speed level to {fan_level}"),
)
def set_fan_level(self, fan_level):
"""Set fan speed level (only for models with fan)"""
if fan_level < 0 or fan_level > 100:
raise HuizuoException("Invalid fan speed level: %s" % fan_level)
if self.model in MODELS_WITH_FAN_WY or self.model in MODELS_WITH_FAN_WY2:
return self.set_property("fan_level", fan_level)
raise HuizuoException("Your device doesn't support a fan management")
@command(
default_output=format_output("Setting fan mode to 'Basic'"),
)
def set_basic_fan_mode(self):
"""Set fan mode to 'Basic' (only for models with fan)"""
if self.model in MODELS_WITH_FAN_WY or self.model in MODELS_WITH_FAN_WY2:
return self.set_property("fan_mode", 0)
raise HuizuoException("Your device doesn't support a fan management")
@command(
default_output=format_output("Setting fan mode to 'Natural wind'"),
)
def set_natural_fan_mode(self):
"""Set fan mode to 'Natural wind' (only for models with fan)"""
if self.model in MODELS_WITH_FAN_WY or self.model in MODELS_WITH_FAN_WY2:
return self.set_property("fan_mode", 1)
raise HuizuoException("Your device doesn't support a fan management")
@command(
default_output=format_output(
"\n",
"------------ Lamp parameters -----------\n"
"Power: {result.is_on}\n"
"Brightness: {result.brightness}\n"
"Color Temperature: {result.color_temp}\n"
"\n"
"------------Fan parameters -------------\n"
"Fan power: {result.is_fan_on}\n"
"Fan level: {result.fan_speed_level}\n"
"Fan mode: {result.fan_mode}\n"
"Fan reverse: {result.is_fan_reverse}\n"
"\n",
),
)
def status(self) -> HuizuoStatus:
"""Retrieve properties."""
return HuizuoStatus(
{
prop["did"]: prop["value"] if prop["code"] == 0 else None
for prop in self.get_properties_for_mapping()
}
)
# Fan Reverse option is not available for all models with fan
@command(
default_output=format_output("Enable fan reverse"),
)
def fan_reverse_on(self):
"""Enable fan reverse (only for models which support this fan option)"""
if self.model in MODELS_WITH_FAN_WY:
return self.set_property("fan_motor_reverse", True)
raise HuizuoException("Your device doesn't support a fan management")
@command(
default_output=format_output("Disable fan reverse"),
)
def fan_reverse_off(self):
"""Disable fan reverse (only for models which support this fan option)"""
if self.model in MODELS_WITH_FAN_WY:
return self.set_property("fan_motor_reverse", False)
raise HuizuoException("Your device doesn't support a fan management")
class HuizuoLampHeater(Huizuo):
"""Support for Huizuo Lamps with heater.
The next section contains the heater management commands Right now I have no devices
with the heater for live testing, so the following section generated based on device
specitifations
"""
@command(
default_output=format_output("Heater powering on"),
)
def heater_on(self):
"""Power heater on (only for models with heater)."""
if self.model in MODELS_WITH_HEATER:
return self.set_property("heater_power", True)
raise HuizuoException("Your device doesn't support a heater management")
@command(
default_output=format_output("Heater powering off"),
)
def heater_off(self):
"""Power heater off (only for models with heater)."""
if self.model in MODELS_WITH_HEATER:
return self.set_property("heater_power", False)
raise HuizuoException("Your device doesn't support a heater management")
@command(
click.argument("heat_level", type=int),
default_output=format_output("Setting heat level to {heat_level}"),
)
def set_heat_level(self, heat_level):
"""Set heat level (only for models with heater)"""
if heat_level not in [1, 2, 3]:
raise HuizuoException("Invalid heat level: %s" % heat_level)
if self.model in MODELS_WITH_HEATER:
return self.set_property("heat_level", heat_level)
raise HuizuoException("Your device doesn't support a heat management")
@command(
default_output=format_output(
"\n",
"------------ Lamp parameters -----------\n"
"Power: {result.is_on}\n"
"Brightness: {result.brightness}\n"
"Color Temperature: {result.color_temp}\n"
"\n"
"---------- Heater parameters -----------\n"
"Heater power: {result.is_heater_on}\n"
"Heat level: {result.heat_level}\n"
"Heat fault code (0 means 'OK'): {result.heater_fault_code}\n",
),
)
def status(self) -> HuizuoStatus:
"""Retrieve properties."""
return HuizuoStatus(
{
prop["did"]: prop["value"] if prop["code"] == 0 else None
for prop in self.get_properties_for_mapping()
}
)
class HuizuoLampScene(Huizuo):
"""Support for Huizuo Lamps with additional scene commands.
The next section contains the scene management commands Right now I have no devices
with the scenes for live testing, so the following section generated based on device
specitifations
"""
@command(
default_output=format_output("On/Off switch"),
)
def scene_on_off(self):
"""Switch the on/off (only for models with scenes support)."""
if self.model in MODELS_WITH_SCENES:
return self.set_property("on_off", 0)
raise HuizuoException("Your device doesn't support scenes")
@command(
default_output=format_output("Increase the brightness"),
)
def brightness_increase(self):
"""Increase the brightness (only for models with scenes support)."""
if self.model in MODELS_WITH_SCENES:
return self.set_property("brightness_increase", 0)
raise HuizuoException("Your device doesn't support scenes")
@command(
default_output=format_output("Decrease the brightness"),
)
def brightness_decrease(self):
"""Decrease the brightness (only for models with scenes support)."""
if self.model in MODELS_WITH_SCENES:
return self.set_property("brightness_decrease", 0)
raise HuizuoException("Your device doesn't support scenes")
@command(
default_output=format_output("Switch between the brightnesses"),
)
def brightness_switch(self):
"""Switch between the brightnesses (only for models with scenes support)."""
if self.model in MODELS_WITH_SCENES:
return self.set_property("brightness_switch", 0)
raise HuizuoException("Your device doesn't support scenes")
@command(
default_output=format_output("Increase the color temperature"),
)
def colortemp_increase(self):
"""Increase the color temperature (only for models with scenes support)."""
if self.model in MODELS_WITH_SCENES:
return self.set_property("colortemp_increase", 0)
raise HuizuoException("Your device doesn't support scenes")
@command(
default_output=format_output("Decrease the color temperature"),
)
def colortemp_decrease(self):
"""Decrease the color temperature (only for models with scenes support)."""
if self.model in MODELS_WITH_SCENES:
return self.set_property("colortemp_decrease", 0)
raise HuizuoException("Your device doesn't support scenes")
@command(
default_output=format_output("Switch between the color temperatures"),
)
def colortemp_switch(self):
"""Switch between the color temperatures (only for models with scenes
support)."""
if self.model in MODELS_WITH_SCENES:
return self.set_property("colortemp_switch", 0)
raise HuizuoException("Your device doesn't support scenes")
@command(
default_output=format_output("Switch on or increase brightness"),
)
def on_or_increase_brightness(self):
"""Switch on or increase brightness (only for models with scenes support)."""
if self.model in MODELS_WITH_SCENES:
return self.set_property("on_or_increase_brightness", 0)
raise HuizuoException("Your device doesn't support scenes")
@command(
default_output=format_output("Switch on or increase color temperature"),
)
def on_or_increase_colortemp(self):
"""Switch on or increase color temperature (only for models with scenes
support)."""
if self.model in MODELS_WITH_SCENES:
return self.set_property("on_or_increase_colortemp", 0)
raise HuizuoException("Your device doesn't support scenes")
|