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 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
|
import enum
import logging
import string
from collections import defaultdict
from datetime import time
from typing import List, Optional
import click
from .click_common import command, format_output
from .device import Device, DeviceStatus
from .exceptions import DeviceException
_LOGGER = logging.getLogger(__name__)
MODEL_PRESSURE1 = "chunmi.cooker.press1"
MODEL_PRESSURE2 = "chunmi.cooker.press2"
MODEL_NORMAL1 = "chunmi.cooker.normal1"
MODEL_NORMAL2 = "chunmi.cooker.normal2"
MODEL_NORMAL3 = "chunmi.cooker.normal3"
MODEL_NORMAL4 = "chunmi.cooker.normal4"
MODEL_NORMAL5 = "chunmi.cooker.normal5"
MODEL_PRESSURE = [MODEL_PRESSURE1, MODEL_PRESSURE2]
MODEL_NORMAL = [
MODEL_NORMAL1,
MODEL_NORMAL2,
MODEL_NORMAL3,
MODEL_NORMAL4,
MODEL_NORMAL5,
]
MODEL_NORMAL_GROUP1 = [MODEL_NORMAL2, MODEL_NORMAL5]
MODEL_NORMAL_GROUP2 = [MODEL_NORMAL3, MODEL_NORMAL4]
COOKING_STAGES = {
0: {
"name": "Quickly preheat",
"description": "Increase temperature in a controlled manner to soften rice gradually",
},
1: {
"name": "Water-absorbing",
"description": "Increase temperature, to flesh grains with water",
},
2: {"name": "Boiling", "description": "Last high heating, to cook rice evenly"},
3: {
"name": "Gelantinizing",
"description": "Steaming under high temperature, to bring sweetness to grains",
},
4: {"name": "Braising", "description": "Absorb water at moderate temperature"},
5: {
"name": "Boiling",
"description": "Operate at full load to boil rice",
# Keep heating at high temperature. Let rice to receive
},
7: {
"name": "Boiling",
"description": "Operate at full load to boil rice",
# Keep heating at high temperature. Let rice to receive
},
8: {
"name": "Warm up rice",
"description": "Temperature control adjustment and cyclic heating "
"achieve combination of taste, dolor and nutrition",
},
10: {
"name": "High temperature gelatinization",
"description": "High-temperature steam generates crystal clear rice g...",
},
16: {"name": "Cooking finished", "description": ""},
}
class CookerException(DeviceException):
pass
class OperationMode(enum.Enum):
# Observed
Running = "running"
Waiting = "waiting"
AutoKeepWarm = "autokeepwarm"
# Potential candidates
Cooking = "cooking"
Finish = "finish"
FinishA = "finisha"
KeepWarm = "keepwarm"
KeepTemp = "keep_temp"
Notice = "notice"
Offline = "offline"
Online = "online"
PreCook = "precook"
Resume = "resume"
ResumeP = "resumep"
Start = "start"
StartP = "startp"
Cancel = "Отмена"
class TemperatureHistory(DeviceStatus):
def __init__(self, data: str):
"""Container of temperatures recorded every 10-15 seconds while cooking.
Example values:
Status waiting:
0
2 minutes:
161515161c242a3031302f2eaa2f2f2e2f
12 minutes:
161515161c242a3031302f2eaa2f2f2e2f2e302f2e2d302f2f2e2f2f2f2f343a3f3f3d3e3c3d3c3f3d3d3d3f3d3d3d3d3e3d3e3c3f3f3d3e3d3e3e3d3f3d3c3e3d3d3e3d3f3e3d3f3e3d3c
32 minutes:
161515161c242a3031302f2eaa2f2f2e2f2e302f2e2d302f2f2e2f2f2f2f343a3f3f3d3e3c3d3c3f3d3d3d3f3d3d3d3d3e3d3e3c3f3f3d3e3d3e3e3d3f3d3c3e3d3d3e3d3f3e3d3f3e3d3c3f3e3d3c3f3e3d3c3f3f3d3d3e3d3d3f3f3d3d3f3f3e3d3d3d3e3e3d3daa3f3f3f3f3f414446474a4e53575e5c5c5b59585755555353545454555554555555565656575757575858585859595b5b5c5c5c5c5d5daa5d5e5f5f606061
55 minutes:
161515161c242a3031302f2eaa2f2f2e2f2e302f2e2d302f2f2e2f2f2f2f343a3f3f3d3e3c3d3c3f3d3d3d3f3d3d3d3d3e3d3e3c3f3f3d3e3d3e3e3d3f3d3c3e3d3d3e3d3f3e3d3f3e3d3c3f3e3d3c3f3e3d3c3f3f3d3d3e3d3d3f3f3d3d3f3f3e3d3d3d3e3e3d3daa3f3f3f3f3f414446474a4e53575e5c5c5b59585755555353545454555554555555565656575757575858585859595b5b5c5c5c5c5d5daa5d5e5f5f60606161616162626263636363646464646464646464646464646464646464646364646464646464646464646464646464646464646464646464646464aa5a59585756555554545453535352525252525151515151
Data structure:
Octet 1 (16): First temperature measurement in hex (22 °C)
Octet 2 (15): Second temperature measurement in hex (21 °C)
Octet 3 (15): Third temperature measurement in hex (21 °C)
...
"""
if not len(data) % 2:
self.data = [int(data[i : i + 2], 16) for i in range(0, len(data), 2)]
else:
self.data = []
@property
def temperatures(self) -> List[int]:
return self.data
@property
def raw(self) -> str:
return "".join([f"{value:02x}" for value in self.data])
def __str__(self) -> str:
return str(self.data)
class CookerCustomizations(DeviceStatus):
def __init__(self, custom: str):
"""Container of different user customizations.
Example values:
ffffffffffff011effff010000001d1f,
ffffffffffff011effff010004026460,
ffffffffffff011effff01000a015559,
ffffffffffff011effff01000000535d
Data structure:
Octet 1 (ff): Jingzhu Appointment Hour in hex
Octet 2 (ff): Jingzhu Appointment Minute in hex
Octet 3 (ff): Kuaizhu Appointment Hour in hex
Octet 4 (ff): Kuaizhu Appointment Minute in hex
Octet 5 (ff): Zhuzhou Appointment Hour in hex
Octet 6 (ff): Zhuzhou Appointment Minute in hex
Octet 7 (01): Favorite Appointment Hour in hex (1 hour)
Octet 8 (1e): Favorite Appointment Minute in hex (30 minutes)
Octet 9 (ff): Favorite Cooking Hour in hex
Octet 10 (ff): Favorite Cooking Minute in hex
Octet 11-16 (01 00 00 00 1d 1f): Meaning unknown
"""
self.custom = [int(custom[i : i + 2], 16) for i in range(0, len(custom), 2)]
@property
def jingzhu_appointment(self) -> time:
return time(hour=self.custom[0], minute=self.custom[1])
@property
def kuaizhu_appointment(self) -> time:
return time(hour=self.custom[2], minute=self.custom[3])
@property
def zhuzhou_appointment(self) -> time:
return time(hour=self.custom[4], minute=self.custom[5])
@property
def zhuzhou_cooking(self) -> time:
return time(hour=self.custom[6], minute=self.custom[7])
@property
def favorite_appointment(self) -> time:
return time(hour=self.custom[8], minute=self.custom[9])
@property
def favorite_cooking(self) -> time:
return time(hour=self.custom[10], minute=self.custom[11])
def __str__(self) -> str:
return "".join([f"{value:02x}" for value in self.custom])
class CookingStage(DeviceStatus):
def __init__(self, stage: str):
"""Container of cooking stages.
Example timeouts: 'null', 02000000ff, 03000000ff, 0a000000ff, 1000000000
Data structure:
Octet 1 (02): State in hex
Octet 2-3 (0000): Rice ID in hex
Octet 4 (00): Taste i n hex
Octet 5 (ff): Meaning unknown.
"""
self.stage = stage
@property
def state(self) -> int:
"""
10: Cooking finished
11: Cooking finished
12: Cooking finished
"""
return int(self.stage[0:2], 16)
@property
def rice_id(self) -> int:
return int(self.stage[2:6], 16)
@property
def taste(self) -> int:
return int(self.stage[6:8], 16)
@property
def taste_phase(self) -> int:
phase = int(self.taste / 33)
if phase > 2:
return 2
return phase
@property
def name(self) -> str:
try:
return COOKING_STAGES[self.state]["name"]
except KeyError:
return "Unknown stage"
@property
def description(self) -> str:
try:
return COOKING_STAGES[self.state]["description"]
except KeyError:
return ""
@property
def raw(self) -> str:
return self.stage
class InteractionTimeouts(DeviceStatus):
def __init__(self, timeouts: str = None):
"""Example timeouts: 05040f, 05060f.
Data structure:
Octet 1 (05): LED off timeout in hex (5 seconds)
Octet 2 (04): Lid open timeout in hex (4 seconds)
Octet 3 (0f): Lid open warning timeout (15 seconds)
"""
if timeouts is None:
self.timeouts = [5, 4, 15]
else:
self.timeouts = [
int(timeouts[i : i + 2], 16) for i in range(0, len(timeouts), 2)
]
@property
def led_off(self) -> int:
return self.timeouts[0]
@led_off.setter
def led_off(self, delay: int):
self.timeouts[0] = delay
@property
def lid_open(self) -> int:
return self.timeouts[1]
@lid_open.setter
def lid_open(self, timeout: int):
self.timeouts[1] = timeout
@property
def lid_open_warning(self) -> int:
return self.timeouts[2]
@lid_open_warning.setter
def lid_open_warning(self, timeout: int):
self.timeouts[2] = timeout
def __str__(self) -> str:
return "".join([f"{value:02x}" for value in self.timeouts])
class CookerSettings(DeviceStatus):
def __init__(self, settings: str = None):
"""Example settings: 1407, 0607, 0207.
Data structure:
Octet 1 (14): Bitmask of setting flags
Bit 1: Pressure supported
Bit 2: LED on
Bit 3: Auto keep warm
Bit 4: Lid open warning
Bit 5: Lid open warning delayed
Bit 6-8: Unused
Octet 2 (07): Second bitmask of setting flags
Bit 1: Jingzhu auto keep warm
Bit 2: Kuaizhu auto keep warm
Bit 3: Zhuzhou auto keep warm
Bit 4: Favorite auto keep warm
Bit 5-8: Unused
"""
if settings is None:
self.settings = [0, 4]
else:
self.settings = [
int(settings[i : i + 2], 16) for i in range(0, len(settings), 2)
]
@property
def pressure_supported(self) -> bool:
return self.settings[0] & 1 != 0
@pressure_supported.setter
def pressure_supported(self, supported: bool):
if supported:
self.settings[0] |= 1
else:
self.settings[0] &= 254
@property
def led_on(self) -> bool:
return self.settings[0] & 2 != 0
@led_on.setter
def led_on(self, on: bool):
if on:
self.settings[0] |= 2
else:
self.settings[0] &= 253
@property
def auto_keep_warm(self) -> bool:
return self.settings[0] & 4 != 0
@auto_keep_warm.setter
def auto_keep_warm(self, keep_warm: bool):
if keep_warm:
self.settings[0] |= 4
else:
self.settings[0] &= 251
@property
def lid_open_warning(self) -> bool:
return self.settings[0] & 8 != 0
@lid_open_warning.setter
def lid_open_warning(self, alarm: bool):
if alarm:
self.settings[0] |= 8
else:
self.settings[0] &= 247
@property
def lid_open_warning_delayed(self) -> bool:
return self.settings[0] & 16 != 0
@lid_open_warning_delayed.setter
def lid_open_warning_delayed(self, alarm: bool):
if alarm:
self.settings[0] |= 16
else:
self.settings[0] &= 239
@property
def jingzhu_auto_keep_warm(self) -> bool:
return self.settings[1] & 1 != 0
@jingzhu_auto_keep_warm.setter
def jingzhu_auto_keep_warm(self, auto_keep_warm: bool):
if auto_keep_warm:
self.settings[1] |= 1
else:
self.settings[1] &= 254
@property
def kuaizhu_auto_keep_warm(self) -> bool:
return self.settings[1] & 2 != 0
@kuaizhu_auto_keep_warm.setter
def kuaizhu_auto_keep_warm(self, auto_keep_warm: bool):
if auto_keep_warm:
self.settings[1] |= 2
else:
self.settings[1] &= 253
@property
def zhuzhou_auto_keep_warm(self) -> bool:
return self.settings[1] & 4 != 0
@zhuzhou_auto_keep_warm.setter
def zhuzhou_auto_keep_warm(self, auto_keep_warm: bool):
if auto_keep_warm:
self.settings[1] |= 4
else:
self.settings[1] &= 251
@property
def favorite_auto_keep_warm(self) -> bool:
return self.settings[1] & 8 != 0
@favorite_auto_keep_warm.setter
def favorite_auto_keep_warm(self, auto_keep_warm: bool):
if auto_keep_warm:
self.settings[1] |= 8
else:
self.settings[1] &= 247
def __str__(self) -> str:
return "".join([f"{value:02x}" for value in self.settings])
class CookerStatus(DeviceStatus):
def __init__(self, data):
"""Responses of a chunmi.cooker.normal2 (fw_ver: 1.2.8):
{ 'func': 'precook',
'menu': '0001',
'stage': '009ce63cff',
'temp': 21,
't_func': '769',
't_precook': '1180',
't_cook': 60,
'setting': '1407',
'delay': '05060f',
'version': '00030017',
'favorite': '0100',
'custom': '13281323ffff011effff010000001516'}
{ 'func': 'waiting',
'menu': '0001',
'stage': 'null',
'temp': 22,
't_func': 60,
't_precook': -1,
't_cook': 60,
'setting': '1407',
'delay': '05060f',
'version': '00030017',
'favorite': '0100',
'custom': '13281323ffff011effff010000001617'}
func , menu , stage , temp , t_func, t_precook, t_cook, setting, delay , version , favorite, custom
idle: ['waiting', '0001', 'null', '29', '60', '-1', '60', '0607', '05040f', '00030017', '0100', 'ffffffffffff011effff010000001d1f']
quickly preheat: ['running', '0001', '00000000ff', '031e0b23', '60', '-1', '60', '0607', '05040f', '00030017', '0100', 'ffffffffffff011effff010000001d1f']
absorb water at moderate temp: ['running', '0001', '02000000ff', '031e0b23', '54', '-1', '60', '0607', '05040f', '00030017', '0100', 'ffffffffffff011effff010002013e23']
absorb water at moderate temp: ['running', '0001', '02000000ff', '031e0b23', '48', '-1', '60', '0607', '05040f', '00030017', '0100', 'ffffffffffff011effff010002013f29']
operate at full load to boil rice: ['running', '0001', '03000000ff', '031e0b23', '39', '-1', '60', '0607', '05040f', '00030017', '0100', 'ffffffffffff011effff010003055332']
operate at full load to boil rice: ['running', '0001', '04000000ff', '031e0b23', '35', '-1', '60', '0607', '05040f', '00030017', '0100', 'ffffffffffff011effff010004026460']
operate at full load to boil rice: ['running', '0001', '06000000ff', '031e0b23', '29', '-1', '60', '0607', '05040f', '00030017', '0100', 'ffffffffffff011effff010006015c64']
high temperature gelatinization: ['running', '0001', '07000000ff', '031e0b23', '22', '-1', '60', '0607', '05040f', '00030017', '0100', 'ffffffffffff011effff010007015d64']
temperature gelatinization: ['running', '0001', '0a000000ff', '031e0b23', '2', '-1', '60', '0607', '05040f', '00030017', '0100', 'ffffffffffff011effff01000a015559']
meal is ready: ['autokeepwarm', '0001', '1000000000', '031e0b23031e', '1', '750', '60', '0207', '05040f', '00030017', '0100', 'ffffffffffff011effff01000000535d']
"""
self.data = data
@property
def mode(self) -> OperationMode:
"""Current operation mode."""
return OperationMode(self.data["func"])
@property
def menu(self) -> int:
"""Selected recipe id."""
return int(self.data["menu"], 16)
@property
def stage(self) -> Optional[CookingStage]:
"""Current stage if cooking."""
stage = self.data["stage"]
if len(stage) == 10:
return CookingStage(stage)
return None
@property
def temperature(self) -> Optional[int]:
"""Current temperature, if idle.
Example values: *29*, 031e0b23, 031e0b23031e
"""
value = self.data["temp"]
if len(value) == 2 and value.isdigit():
return int(value)
return None
@property
def start_time(self) -> Optional[time]:
"""Start time of cooking?
The property "temp" is used for different purposes. Example values: 29,
*031e0b23*, 031e0b23031e
"""
value = self.data["temp"]
if len(value) == 8:
return time(hour=int(value[4:6], 16), minute=int(value[6:8], 16))
return None
@property
def remaining(self) -> int:
"""Remaining minutes of the cooking process."""
return int(self.data["t_func"])
@property
def cooking_delayed(self) -> Optional[int]:
"""Wait n minutes before cooking / scheduled cooking."""
delay = int(self.data["t_precook"])
if delay >= 0:
return delay
return None
@property
def duration(self) -> int:
"""Duration of the cooking process."""
return int(self.data["t_cook"])
@property
def settings(self) -> CookerSettings:
"""Settings of the cooker."""
return CookerSettings(self.data["setting"])
@property
def interaction_timeouts(self) -> InteractionTimeouts:
"""Interaction timeouts."""
return InteractionTimeouts(self.data["delay"])
@property
def hardware_version(self) -> int:
"""Hardware version."""
return int(self.data["version"][0:4], 16)
@property
def firmware_version(self) -> int:
"""Firmware version."""
return int(self.data["version"][4:8], 16)
@property
def favorite(self) -> int:
"""Favored recipe id.
Can be compared with the menu property.
"""
return int(self.data["favorite"], 16)
@property
def custom(self) -> Optional[CookerCustomizations]:
custom = self.data["custom"]
if len(custom) > 31:
return CookerCustomizations(custom)
return None
class Cooker(Device):
"""Main class representing the chunmi.cooker.*."""
_supported_models = [*MODEL_NORMAL, *MODEL_PRESSURE]
@command(
default_output=format_output(
"",
"Mode: {result.mode}\n"
"Menu: {result.menu}\n"
"Stage: {result.stage}\n"
"Temperature: {result.temperature}\n"
"Start time: {result.start_time}\n"
"Remaining: {result.remaining}\n"
"Cooking delayed: {result.cooking_delayed}\n"
"Duration: {result.duration}\n"
"Settings: {result.settings}\n"
"Interaction timeouts: {result.interaction_timeouts}\n"
"Hardware version: {result.hardware_version}\n"
"Firmware version: {result.firmware_version}\n"
"Favorite: {result.favorite}\n"
"Custom: {result.custom}\n",
)
)
def status(self) -> CookerStatus:
"""Retrieve properties."""
properties = [
"func",
"menu",
"stage",
"temp",
"t_func",
"t_precook",
"t_cook",
"setting",
"delay",
"version",
"favorite",
"custom",
]
"""
Some cookers doesn't support a list of properties here. Therefore "all" properties
are requested. If the property count or order changes the property list above must
be updated.
""" # noqa: B018
values = self.send("get_prop", ["all"])
properties_count = len(properties)
values_count = len(values)
if properties_count != values_count:
_LOGGER.debug(
"Count (%s) of requested properties does not match the "
"count (%s) of received values.",
properties_count,
values_count,
)
return CookerStatus(defaultdict(lambda: None, zip(properties, values)))
@command(
click.argument("profile", type=str),
default_output=format_output("Cooking profile started"),
)
def start(self, profile: str):
"""Start cooking a profile."""
if not self._validate_profile(profile):
raise CookerException("Invalid cooking profile: %s" % profile)
self.send("set_start", [profile])
@command(default_output=format_output("Cooking stopped"))
def stop(self):
"""Stop cooking."""
self.send("set_func", ["end02"])
@command(default_output=format_output("Cooking stopped"))
def stop_outdated_firmware(self):
"""Stop cooking (obsolete)."""
self.send("set_func", ["end"])
@command(default_output=format_output("Setting no warnings"))
def set_no_warnings(self):
"""Disable warnings."""
self.send("set_func", ["nowarn"])
@command(default_output=format_output("Setting acknowledge"))
def set_acknowledge(self):
"""Enable warnings?"""
self.send("set_func", ["ack"])
# FIXME: Add unified CLI support
def set_interaction(self, settings: CookerSettings, timeouts: InteractionTimeouts):
"""Set interaction.
Supported by all cookers except MODEL_PRESS1
"""
self.send(
"set_interaction",
[
str(settings),
f"{timeouts.led_off:x}",
f"{timeouts.lid_open:x}",
f"{timeouts.lid_open_warning:x}",
],
)
@command(
click.argument("profile", type=str),
default_output=format_output("Setting menu to {profile}"),
)
def set_menu(self, profile: str):
"""Select one of the default(?) cooking profiles."""
if not self._validate_profile(profile):
raise CookerException("Invalid cooking profile: %s" % profile)
self.send("set_menu", [profile])
@command(default_output=format_output("", "Temperature history: {result}\n"))
def get_temperature_history(self) -> TemperatureHistory:
"""Retrieves a temperature history.
The temperature is only available while cooking. Approx. six data points per
minute.
"""
data = self.send("get_temp_history")
return TemperatureHistory(data[0])
@staticmethod
def _validate_profile(profile):
return all(c in string.hexdigits for c in profile) and len(profile) in [
228,
242,
]
|