roborock.data.code_mappings

  1from __future__ import annotations
  2
  3import logging
  4from collections import namedtuple
  5from enum import Enum, IntEnum, StrEnum
  6
  7_LOGGER = logging.getLogger(__name__)
  8completed_warnings = set()
  9
 10
 11class RoborockEnum(IntEnum):
 12    """Roborock Enum for codes with int values"""
 13
 14    @property
 15    def name(self) -> str:
 16        return super().name.lower()
 17
 18    @classmethod
 19    def _missing_(cls: type[RoborockEnum], key) -> RoborockEnum:
 20        if hasattr(cls, "unknown"):
 21            warning = f"Missing {cls.__name__} code: {key} - defaulting to 'unknown'"
 22            if warning not in completed_warnings:
 23                completed_warnings.add(warning)
 24                _LOGGER.warning(warning)
 25            return cls.unknown  # type: ignore
 26        default_value = next(item for item in cls)
 27        warning = f"Missing {cls.__name__} code: {key} - defaulting to {default_value}"
 28        if warning not in completed_warnings:
 29            completed_warnings.add(warning)
 30            _LOGGER.warning(warning)
 31        return default_value
 32
 33    @classmethod
 34    def as_dict(cls: type[RoborockEnum]):
 35        return {i.name: i.value for i in cls if i.name != "missing"}
 36
 37    @classmethod
 38    def as_enum_dict(cls: type[RoborockEnum]):
 39        return {i.value: i for i in cls if i.name != "missing"}
 40
 41    @classmethod
 42    def values(cls: type[RoborockEnum]) -> list[int]:
 43        return list(cls.as_dict().values())
 44
 45    @classmethod
 46    def keys(cls: type[RoborockEnum]) -> list[str]:
 47        return list(cls.as_dict().keys())
 48
 49    @classmethod
 50    def items(cls: type[RoborockEnum]):
 51        return cls.as_dict().items()
 52
 53
 54class RoborockModeEnum(StrEnum):
 55    """A custom StrEnum that also stores an integer code for each member."""
 56
 57    code: int
 58
 59    def __new__(cls, value: str, code: int) -> RoborockModeEnum:
 60        """Creates a new enum member."""
 61        member = str.__new__(cls, value)
 62        member._value_ = value
 63        member.code = code
 64        return member
 65
 66    @classmethod
 67    def from_code(cls, code: int):
 68        for member in cls:
 69            if member.code == code:
 70                return member
 71        raise ValueError(f"{code} is not a valid code for {cls.__name__}")
 72
 73    @classmethod
 74    def keys(cls) -> list[str]:
 75        """Returns a list of all member values."""
 76        return [member.value for member in cls]
 77
 78
 79ProductInfo = namedtuple("ProductInfo", ["nickname", "short_models"])
 80
 81
 82class RoborockProductNickname(Enum):
 83    # Coral Series
 84    CORAL = ProductInfo(nickname="Coral", short_models=("a20", "a21"))
 85    CORALPRO = ProductInfo(nickname="CoralPro", short_models=("a143", "a144"))
 86
 87    # Pearl Series
 88    PEARL = ProductInfo(nickname="Pearl", short_models=("a74", "a75"))
 89    PEARLC = ProductInfo(nickname="PearlC", short_models=("a103", "a104"))
 90    PEARLE = ProductInfo(nickname="PearlE", short_models=("a167", "a168"))
 91    PEARLELITE = ProductInfo(nickname="PearlELite", short_models=("a169", "a170"))
 92    PEARLPLUS = ProductInfo(nickname="PearlPlus", short_models=("a86", "a87"))
 93    PEARLPLUSS = ProductInfo(nickname="PearlPlusS", short_models=("a116", "a117", "a136"))
 94    PEARLS = ProductInfo(nickname="PearlS", short_models=("a100", "a101"))
 95    PEARLSLITE = ProductInfo(nickname="PearlSLite", short_models=("a122", "a123"))
 96
 97    # Ruby Series
 98    RUBYPLUS = ProductInfo(nickname="RubyPlus", short_models=("t4", "s4"))
 99    RUBYSC = ProductInfo(nickname="RubySC", short_models=("p5", "a08"))
100    RUBYSE = ProductInfo(nickname="RubySE", short_models=("a19",))
101    RUBYSLITE = ProductInfo(nickname="RubySLite", short_models=("p6", "s5e", "a05"))
102
103    # Tanos Series
104    TANOS = ProductInfo(nickname="Tanos", short_models=("t6", "s6"))
105    TANOSE = ProductInfo(nickname="TanosE", short_models=("t7", "a11"))
106    TANOSS = ProductInfo(nickname="TanosS", short_models=("a14", "a15"))
107    TANOSSC = ProductInfo(nickname="TanosSC", short_models=("a39", "a40"))
108    TANOSSE = ProductInfo(nickname="TanosSE", short_models=("a33", "a34"))
109    TANOSSMAX = ProductInfo(nickname="TanosSMax", short_models=("a52",))
110    TANOSSLITE = ProductInfo(nickname="TanosSLite", short_models=("a37", "a38"))
111    TANOSSPLUS = ProductInfo(nickname="TanosSPlus", short_models=("a23", "a24"))
112    TANOSV = ProductInfo(nickname="TanosV", short_models=("t7p", "a09", "a10"))
113
114    # Topaz Series
115    TOPAZS = ProductInfo(nickname="TopazS", short_models=("a29", "a30", "a76"))
116    TOPAZSC = ProductInfo(nickname="TopazSC", short_models=("a64", "a65"))
117    TOPAZSPLUS = ProductInfo(nickname="TopazSPlus", short_models=("a46", "a47", "a66"))
118    TOPAZSPOWER = ProductInfo(nickname="TopazSPower", short_models=("a62",))
119    TOPAZSV = ProductInfo(nickname="TopazSV", short_models=("a26", "a27"))
120
121    # Ultron Series
122    ULTRON = ProductInfo(nickname="Ultron", short_models=("a50", "a51"))
123    ULTRONE = ProductInfo(nickname="UltronE", short_models=("a72", "a84"))
124    ULTRONLITE = ProductInfo(nickname="UltronLite", short_models=("a73", "a85"))
125    ULTRONSC = ProductInfo(nickname="UltronSC", short_models=("a94", "a95"))
126    ULTRONSE = ProductInfo(nickname="UltronSE", short_models=("a124", "a125", "a139", "a140"))
127    ULTRONSPLUS = ProductInfo(nickname="UltronSPlus", short_models=("a68", "a69", "a70"))
128    ULTRONSV = ProductInfo(nickname="UltronSV", short_models=("a96", "a97"))
129
130    # Verdelite Series
131    VERDELITE = ProductInfo(nickname="Verdelite", short_models=("a146", "a147"))
132
133    # Vivian Series
134    VIVIAN = ProductInfo(nickname="Vivian", short_models=("a134", "a135", "a155", "a156"))
135    VIVIANC = ProductInfo(nickname="VivianC", short_models=("a158", "a159"))
136
137
138SHORT_MODEL_TO_ENUM = {model: product for product in RoborockProductNickname for model in product.value.short_models}
139
140
141class RoborockCategory(Enum):
142    """Describes the category of the device."""
143
144    WET_DRY_VAC = "roborock.wetdryvac"
145    VACUUM = "robot.vacuum.cleaner"
146    WASHING_MACHINE = "roborock.wm"
147    UNKNOWN = "UNKNOWN"
148
149    def __missing__(self, key):
150        _LOGGER.warning("Missing key %s from category", key)
151        return RoborockCategory.UNKNOWN