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
|
from __future__ import annotations
import logging
from collections import namedtuple
from enum import Enum, IntEnum, StrEnum
from typing import Any, Self
_LOGGER = logging.getLogger(__name__)
completed_warnings = set()
class RoborockEnum(IntEnum):
"""Roborock Enum for codes with int values"""
@property
def name(self) -> str:
return super().name.lower()
@classmethod
def _missing_(cls: type[RoborockEnum], key) -> RoborockEnum:
if hasattr(cls, "unknown"):
warning = f"Missing {cls.__name__} code: {key} - defaulting to 'unknown'"
if warning not in completed_warnings:
completed_warnings.add(warning)
_LOGGER.warning(warning)
return cls.unknown # type: ignore
default_value = next(item for item in cls)
warning = f"Missing {cls.__name__} code: {key} - defaulting to {default_value}"
if warning not in completed_warnings:
completed_warnings.add(warning)
_LOGGER.warning(warning)
return default_value
@classmethod
def as_dict(cls: type[RoborockEnum]):
return {i.name: i.value for i in cls if i.name != "missing"}
@classmethod
def as_enum_dict(cls: type[RoborockEnum]):
return {i.value: i for i in cls if i.name != "missing"}
@classmethod
def values(cls: type[RoborockEnum]) -> list[int]:
return list(cls.as_dict().values())
@classmethod
def keys(cls: type[RoborockEnum]) -> list[str]:
return list(cls.as_dict().keys())
@classmethod
def items(cls: type[RoborockEnum]):
return cls.as_dict().items()
class RoborockModeEnum(StrEnum):
"""A custom StrEnum that also stores an integer code for each member."""
code: int
"""The integer code associated with the enum member."""
def __new__(cls, value: str, code: int) -> Self:
"""Creates a new enum member."""
member = str.__new__(cls, value)
member._value_ = value
member.code = code
return member
@classmethod
def from_code(cls, code: int) -> Self:
for member in cls:
if member.code == code:
return member
message = f"{code} is not a valid code for {cls.__name__}"
if message not in completed_warnings:
completed_warnings.add(message)
_LOGGER.warning(message)
raise ValueError(message)
@classmethod
def from_code_optional(cls, code: int) -> Self | None:
"""Gracefully return None if the code does not exist."""
try:
return cls.from_code(code)
except ValueError:
return None
@classmethod
def from_value(cls, value: str) -> Self:
"""Find enum member by string value (case-insensitive)."""
for member in cls:
if member.value.lower() == value.lower():
return member
raise ValueError(f"{value} is not a valid value for {cls.__name__}")
@classmethod
def from_name(cls, name: str) -> Self:
"""Find enum member by name (case-insensitive)."""
for member in cls:
if member.name.lower() == name.lower():
return member
raise ValueError(f"{name} is not a valid name for {cls.__name__}")
@classmethod
def keys(cls) -> list[str]:
"""Returns a list of all member values."""
return [member.value for member in cls]
def __eq__(self, other: Any) -> bool:
if isinstance(other, str):
return self.value == other or self.name == other
if isinstance(other, int):
return self.code == other
return super().__eq__(other)
def __hash__(self) -> int:
"""Hash a RoborockModeEnum.
It is critical that you do not mix RoborockModeEnums with raw strings or ints in hashed situations
(i.e. sets or keys in dictionaries)
"""
return hash((self.code, self._value_))
ProductInfo = namedtuple("ProductInfo", ["nickname", "short_models"])
class RoborockProductNickname(Enum):
# Coral Series
CORAL = ProductInfo(nickname="Coral", short_models=("a20", "a21"))
CORALPRO = ProductInfo(nickname="CoralPro", short_models=("a143", "a144"))
# Pearl Series
PEARL = ProductInfo(nickname="Pearl", short_models=("a74", "a75"))
PEARLC = ProductInfo(nickname="PearlC", short_models=("a103", "a104"))
PEARLE = ProductInfo(nickname="PearlE", short_models=("a167", "a168"))
PEARLELITE = ProductInfo(nickname="PearlELite", short_models=("a169", "a170"))
PEARLPLUS = ProductInfo(nickname="PearlPlus", short_models=("a86", "a87"))
PEARLPLUSS = ProductInfo(nickname="PearlPlusS", short_models=("a116", "a117", "a136"))
PEARLS = ProductInfo(nickname="PearlS", short_models=("a100", "a101"))
PEARLSLITE = ProductInfo(nickname="PearlSLite", short_models=("a122", "a123"))
# Ruby Series
RUBYPLUS = ProductInfo(nickname="RubyPlus", short_models=("t4", "s4"))
RUBYSC = ProductInfo(nickname="RubySC", short_models=("p5", "a08"))
RUBYSE = ProductInfo(nickname="RubySE", short_models=("a19",))
RUBYSLITE = ProductInfo(nickname="RubySLite", short_models=("p6", "s5e", "a05"))
# Tanos Series
TANOS = ProductInfo(nickname="Tanos", short_models=("t6", "s6"))
TANOSE = ProductInfo(nickname="TanosE", short_models=("t7", "a11"))
TANOSS = ProductInfo(nickname="TanosS", short_models=("a14", "a15"))
TANOSSC = ProductInfo(nickname="TanosSC", short_models=("a39", "a40"))
TANOSSE = ProductInfo(nickname="TanosSE", short_models=("a33", "a34"))
TANOSSMAX = ProductInfo(nickname="TanosSMax", short_models=("a52",))
TANOSSLITE = ProductInfo(nickname="TanosSLite", short_models=("a37", "a38"))
TANOSSPLUS = ProductInfo(nickname="TanosSPlus", short_models=("a23", "a24"))
TANOSV = ProductInfo(nickname="TanosV", short_models=("t7p", "a09", "a10"))
# Topaz Series
TOPAZS = ProductInfo(nickname="TopazS", short_models=("a29", "a30", "a76"))
TOPAZSC = ProductInfo(nickname="TopazSC", short_models=("a64", "a65"))
TOPAZSPLUS = ProductInfo(nickname="TopazSPlus", short_models=("a46", "a47", "a66"))
TOPAZSPOWER = ProductInfo(nickname="TopazSPower", short_models=("a62",))
TOPAZSV = ProductInfo(nickname="TopazSV", short_models=("a26", "a27"))
# Ultron Series
ULTRON = ProductInfo(nickname="Ultron", short_models=("a50", "a51"))
ULTRONE = ProductInfo(nickname="UltronE", short_models=("a72", "a84"))
ULTRONLITE = ProductInfo(nickname="UltronLite", short_models=("a73", "a85"))
ULTRONSC = ProductInfo(nickname="UltronSC", short_models=("a94", "a95"))
ULTRONSE = ProductInfo(nickname="UltronSE", short_models=("a124", "a125", "a139", "a140"))
ULTRONSPLUS = ProductInfo(nickname="UltronSPlus", short_models=("a68", "a69", "a70"))
ULTRONSV = ProductInfo(nickname="UltronSV", short_models=("a96", "a97"))
# Verdelite Series
VERDELITE = ProductInfo(nickname="Verdelite", short_models=("a146", "a147"))
# Vivian Series
VIVIAN = ProductInfo(nickname="Vivian", short_models=("a134", "a135", "a155", "a156"))
VIVIANC = ProductInfo(nickname="VivianC", short_models=("a158", "a159"))
SHORT_MODEL_TO_ENUM = {model: product for product in RoborockProductNickname for model in product.value.short_models}
class RoborockCategory(Enum):
"""Describes the category of the device."""
WET_DRY_VAC = "roborock.wetdryvac"
VACUUM = "robot.vacuum.cleaner"
WASHING_MACHINE = "roborock.wm"
MOWER = "roborock.mower"
UNKNOWN = "UNKNOWN"
@classmethod
def _missing_(cls, value):
_LOGGER.warning("Missing code %s from category", value)
return RoborockCategory.UNKNOWN
|