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
|
import enum
import logging
from typing import Optional
import click
from .click_common import EnumType, command, format_output
from .device import Device, DeviceStatus
from .exceptions import DeviceException
_LOGGER = logging.getLogger(__name__)
MODEL_ACPARTNER_V1 = "lumi.acpartner.v1"
MODEL_ACPARTNER_V2 = "lumi.acpartner.v2"
MODEL_ACPARTNER_V3 = "lumi.acpartner.v3"
MODELS_SUPPORTED = [MODEL_ACPARTNER_V1, MODEL_ACPARTNER_V2, MODEL_ACPARTNER_V3]
class AirConditioningCompanionException(DeviceException):
pass
class OperationMode(enum.Enum):
Heat = 0
Cool = 1
Auto = 2
Dehumidify = 3
Ventilate = 4
class FanSpeed(enum.Enum):
Low = 0
Medium = 1
High = 2
Auto = 3
class SwingMode(enum.Enum):
On = "0"
Off = "1"
Unknown2 = "2"
Unknown7 = "7"
ChigoOn = "C"
ChigoOff = "D"
class Power(enum.Enum):
On = 1
Off = 0
class Led(enum.Enum):
On = "0"
Off = "A"
STORAGE_SLOT_ID = 30
POWER_OFF = "off"
# Command templates per model number (f.e. 0180111111)
# [po], [mo], [wi], [sw], [tt], [tt1], [tt4] and [tt7] are markers which will be replaced
DEVICE_COMMAND_TEMPLATES = {
"fallback": {"deviceType": "generic", "base": "[po][mo][wi][sw][tt][li]"},
"0100010727": {
"deviceType": "gree_2",
"base": "[po][mo][wi][sw][tt]1100190[tt1]205002102000[tt7]0190[tt1]207002000000[tt4]",
"off": "01011101004000205002112000D04000207002000000A0",
},
"0100004795": {
"deviceType": "gree_8",
"base": "[po][mo][wi][sw][tt][li]10009090000500",
},
"0180333331": {"deviceType": "haier_1", "base": "[po][mo][wi][sw][tt]1"},
"0180666661": {"deviceType": "aux_1", "base": "[po][mo][wi][sw][tt]1"},
"0180777771": {"deviceType": "chigo_1", "base": "[po][mo][wi][sw][tt]1"},
}
class AirConditioningCompanionStatus(DeviceStatus):
"""Container for status reports of the Xiaomi AC Companion."""
def __init__(self, data):
"""Device model: lumi.acpartner.v2.
Response of "get_model_and_state":
['010500978022222102', '010201190280222221', '2']
AC turned on by set_power=on:
['010507950000257301', '011001160100002573', '807']
AC turned off by set_power=off:
['010507950000257301', '010001160100002573', '6']
...
['010507950000257301', '010001160100002573', '1']
Example data payload:
{ 'model_and_state': ['010500978022222102', '010201190280222221', '2'],
'power_socket': 'on' }
"""
self.data = data
self.model = data["model_and_state"][0]
self.state = data["model_and_state"][1]
@property
def load_power(self) -> int:
"""Current power load of the air conditioner."""
return int(self.data["model_and_state"][2])
@property
def power_socket(self) -> Optional[str]:
"""Current socket power state."""
if "power_socket" in self.data and self.data["power_socket"] is not None:
return self.data["power_socket"]
return None
@property
def air_condition_model(self) -> bytes:
"""Model of the air conditioner."""
return bytes.fromhex(self.model)
@property
def model_format(self) -> int:
"""Version number of the model format."""
return self.air_condition_model[0]
@property
def device_type(self) -> int:
"""Device type identifier."""
return self.air_condition_model[1]
@property
def air_condition_brand(self) -> int:
"""Brand of the air conditioner.
Known brand ids are 0x0182, 0x0097, 0x0037, 0x0202, 0x02782, 0x0197, 0x0192.
"""
return int(self.air_condition_model[2:4].hex(), 16)
@property
def air_condition_remote(self) -> int:
"""Remote id.
Known remote ids:
* 0x80111111, 0x80111112 (brand: 0x0182)
* 0x80222221 (brand: 0x0097)
* 0x80333331 (brand: 0x0037)
* 0x80444441 (brand: 0x0202)
* 0x80555551 (brand: 0x2782)
* 0x80777771 (brand: 0x0197)
* 0x80666661 (brand: 0x0192)
"""
return int(self.air_condition_model[4:8].hex(), 16)
@property
def state_format(self) -> int:
"""Version number of the state format.
Known values are: 1, 2, 3
"""
return int(self.air_condition_model[8])
@property
def air_condition_configuration(self) -> int:
return self.state[2:10]
@property
def power(self) -> str:
"""Current power state."""
return "on" if int(self.state[2:3]) == Power.On.value else "off"
@property
def led(self) -> Optional[bool]:
"""Current LED state."""
state = self.state[8:9]
if state == Led.On.value:
return True
if state == Led.Off.value:
return False
_LOGGER.info("Unsupported LED state: %s", state)
return None
@property
def is_on(self) -> bool:
"""True if the device is turned on."""
return self.power == "on"
@property
def target_temperature(self) -> Optional[int]:
"""Target temperature."""
try:
return int(self.state[6:8], 16)
except TypeError:
return None
@property
def swing_mode(self) -> Optional[SwingMode]:
"""Current swing mode."""
try:
mode = self.state[5:6]
return SwingMode(mode)
except TypeError:
return None
@property
def fan_speed(self) -> Optional[FanSpeed]:
"""Current fan speed."""
try:
speed = int(self.state[4:5])
return FanSpeed(speed)
except TypeError:
return None
@property
def mode(self) -> Optional[OperationMode]:
"""Current operation mode."""
try:
mode = int(self.state[3:4])
return OperationMode(mode)
except TypeError:
return None
class AirConditioningCompanion(Device):
"""Main class representing Xiaomi Air Conditioning Companion V1 and V2."""
_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_ACPARTNER_V2,
) -> None:
super().__init__(ip, token, start_id, debug, lazy_discover, model=model)
if self.model not in MODELS_SUPPORTED:
_LOGGER.error(
"Device model %s unsupported. Falling back to %s.", model, self.model
)
@command(
default_output=format_output(
"",
"Power: {result.power}\n"
"Load power: {result.load_power}\n"
"Air Condition model: {result.air_condition_model}\n"
"LED: {result.led}\n"
"Target temperature: {result.target_temperature} °C\n"
"Swing mode: {result.swing_mode}\n"
"Fan speed: {result.fan_speed}\n"
"Mode: {result.mode}\n",
)
)
def status(self) -> AirConditioningCompanionStatus:
"""Return device status."""
status = self.send("get_model_and_state")
return AirConditioningCompanionStatus(dict(model_and_state=status))
@command(default_output=format_output("Powering the air condition on"))
def on(self):
"""Turn the air condition on by infrared."""
return self.send("set_power", ["on"])
@command(default_output=format_output("Powering the air condition off"))
def off(self):
"""Turn the air condition off by infrared."""
return self.send("set_power", ["off"])
@command(
click.argument("slot", type=int),
default_output=format_output(
"Learning infrared command into storage slot {slot}"
),
)
def learn(self, slot: int = STORAGE_SLOT_ID):
"""Learn an infrared command."""
return self.send("start_ir_learn", [slot])
@command(default_output=format_output("Reading learned infrared commands"))
def learn_result(self):
"""Read the learned command."""
return self.send("get_ir_learn_result")
@command(
click.argument("slot", type=int),
default_output=format_output(
"Learning infrared command into storage slot {slot} stopped"
),
)
def learn_stop(self, slot: int = STORAGE_SLOT_ID):
"""Stop learning of a infrared command."""
return self.send("end_ir_learn", [slot])
@command(
click.argument("model", type=str),
click.argument("code", type=str),
default_output=format_output("Sending the supplied infrared command"),
)
def send_ir_code(self, model: str, code: str, slot: int = 0):
"""Play a captured command.
:param str model: Air condition model
:param str code: Command to execute
:param int slot: Unknown internal register or slot
"""
try:
model_bytes = bytes.fromhex(model)
except ValueError:
raise AirConditioningCompanionException(
"Invalid model. A hexadecimal string must be provided"
)
try:
code_bytes = bytes.fromhex(code)
except ValueError:
raise AirConditioningCompanionException(
"Invalid code. A hexadecimal string must be provided"
)
if slot < 0 or slot > 134:
raise AirConditioningCompanionException("Invalid slot: %s" % slot)
slot_bytes = bytes([121 + slot])
# FE + 0487 + 00007145 + 9470 + 1FFF + 7F + FF + 06 + 0042 + 27 + 4E + 0025002D008500AC01...
command_bytes = (
code_bytes[0:1]
+ model_bytes[2:8]
+ b"\x94\x70\x1F\xFF"
+ slot_bytes
+ b"\xFF"
+ code_bytes[13:16]
+ b"\x27"
)
checksum = sum(command_bytes) & 0xFF
command_bytes = command_bytes + bytes([checksum]) + code_bytes[18:]
return self.send("send_ir_code", [command_bytes.hex().upper()])
@command(
click.argument("command", type=str),
default_output=format_output("Sending a command to the air conditioner"),
)
def send_command(self, command: str):
"""Send a command to the air conditioner.
:param str command: Command to execute
"""
return self.send("send_cmd", [str(command)])
@command(
click.argument("model", type=str),
click.argument("power", type=EnumType(Power)),
click.argument("operation_mode", type=EnumType(OperationMode)),
click.argument("target_temperature", type=int),
click.argument("fan_speed", type=EnumType(FanSpeed)),
click.argument("swing_mode", type=EnumType(SwingMode)),
click.argument("led", type=EnumType(Led)),
default_output=format_output("Sending a configuration to the air conditioner"),
)
def send_configuration(
self,
model: str,
power: Power,
operation_mode: OperationMode,
target_temperature: int,
fan_speed: FanSpeed,
swing_mode: SwingMode,
led: Led,
):
prefix = str(model[0:2] + model[8:16])
suffix = model[-1:]
# Static turn off command available?
if (
(power is Power.Off)
and (prefix in DEVICE_COMMAND_TEMPLATES)
and (POWER_OFF in DEVICE_COMMAND_TEMPLATES[prefix])
):
return self.send_command(
prefix + DEVICE_COMMAND_TEMPLATES[prefix][POWER_OFF]
)
if prefix in DEVICE_COMMAND_TEMPLATES:
configuration = prefix + DEVICE_COMMAND_TEMPLATES[prefix]["base"]
else:
configuration = prefix + DEVICE_COMMAND_TEMPLATES["fallback"]["base"]
configuration = configuration.replace("[po]", str(power.value))
configuration = configuration.replace("[mo]", str(operation_mode.value))
configuration = configuration.replace("[wi]", str(fan_speed.value))
configuration = configuration.replace("[sw]", str(swing_mode.value))
configuration = configuration.replace("[tt]", format(target_temperature, "X"))
configuration = configuration.replace("[li]", str(led.value))
temperature = format((1 + target_temperature - 17) % 16, "X")
configuration = configuration.replace("[tt1]", temperature)
temperature = format((4 + target_temperature - 17) % 16, "X")
configuration = configuration.replace("[tt4]", temperature)
temperature = format((7 + target_temperature - 17) % 16, "X")
configuration = configuration.replace("[tt7]", temperature)
configuration = configuration + suffix
return self.send_command(configuration)
class AirConditioningCompanionV3(AirConditioningCompanion):
def __init__(
self,
ip: str = None,
token: str = None,
start_id: int = 0,
debug: int = 0,
lazy_discover: bool = True,
) -> None:
super().__init__(
ip, token, start_id, debug, lazy_discover, model=MODEL_ACPARTNER_V3
)
@command(default_output=format_output("Powering socket on"))
def socket_on(self):
"""Socket power on."""
return self.send("toggle_plug", ["on"])
@command(default_output=format_output("Powering socket off"))
def socket_off(self):
"""Socket power off."""
return self.send("toggle_plug", ["off"])
@command(
default_output=format_output(
"",
"Power: {result.power}\n"
"Power socket: {result.power_socket}\n"
"Load power: {result.load_power}\n"
"Air Condition model: {result.air_condition_model}\n"
"LED: {result.led}\n"
"Target temperature: {result.target_temperature} °C\n"
"Swing mode: {result.swing_mode}\n"
"Fan speed: {result.fan_speed}\n"
"Mode: {result.mode}\n",
)
)
def status(self) -> AirConditioningCompanionStatus:
"""Return device status."""
status = self.send("get_model_and_state")
power_socket = self.send("get_device_prop", ["lumi.0", "plug_state"])
return AirConditioningCompanionStatus(
dict(model_and_state=status, power_socket=power_socket[0])
)
|