Add known models to supported models (#1202)

rytilahti · web-flow · commit 7fc45404d1b1 · 2021-12-02T00:44:24.000+01:00
* airhumidifier: add supported models

* gateway: add supported models

* aurqualitymonitor: add supported models

* Add currently known models to supported models
diff --git a/miio/airconditioningcompanion.py b/miio/airconditioningcompanion.py
@@ -227,6 +227,8 @@ def mode(self) -> Optional[OperationMode]:
 class AirConditioningCompanion(Device):
     """Main class representing Xiaomi Air Conditioning Companion V1 and V2."""
 
+    _supported_models = MODELS_SUPPORTED
+
     def __init__(
         self,
         ip: str = None,
diff --git a/miio/airconditioningcompanionMCN.py b/miio/airconditioningcompanionMCN.py
@@ -102,6 +102,8 @@ def swing_mode(self) -> Optional[SwingMode]:
 class AirConditioningCompanionMcn02(Device):
     """Main class representing Xiaomi Air Conditioning Companion V1 and V2."""
 
+    _supported_models = [MODEL_ACPARTNER_MCN02]
+
     def __init__(
         self,
         ip: str = None,
diff --git a/miio/airdehumidifier.py b/miio/airdehumidifier.py
@@ -158,6 +158,8 @@ def alarm(self) -> str:
 class AirDehumidifier(Device):
     """Implementation of Xiaomi Mi Air Dehumidifier."""
 
+    _supported_models = list(AVAILABLE_PROPERTIES.keys())
+
     @command(
         default_output=format_output(
             "",
diff --git a/miio/airfresh.py b/miio/airfresh.py
@@ -219,6 +219,8 @@ def extra_features(self) -> Optional[int]:
 class AirFresh(Device):
     """Main class representing the air fresh."""
 
+    _supported_models = list(AVAILABLE_PROPERTIES.keys())
+
     @command(
         default_output=format_output(
             "",
diff --git a/miio/airfresh_t2017.py b/miio/airfresh_t2017.py
@@ -224,6 +224,8 @@ def display_orientation(self) -> Optional[DisplayOrientation]:
 class AirFreshA1(Device):
     """Main class representing the air fresh a1."""
 
+    _supported_models = list(AVAILABLE_PROPERTIES.keys())
+
     @command(
         default_output=format_output(
             "",
diff --git a/miio/airhumidifier.py b/miio/airhumidifier.py
@@ -17,6 +17,13 @@
 MODEL_HUMIDIFIER_CB1 = "zhimi.humidifier.cb1"
 MODEL_HUMIDIFIER_CB2 = "zhimi.humidifier.cb2"
 
+SUPPORTED_MODELS = [
+    MODEL_HUMIDIFIER_V1,
+    MODEL_HUMIDIFIER_CA1,
+    MODEL_HUMIDIFIER_CB1,
+    MODEL_HUMIDIFIER_CB2,
+]
+
 AVAILABLE_PROPERTIES_COMMON = [
     "power",
     "mode",
@@ -251,6 +258,8 @@ def button_pressed(self) -> Optional[str]:
 class AirHumidifier(Device):
     """Implementation of Xiaomi Mi Air Humidifier."""
 
+    _supported_models = SUPPORTED_MODELS
+
     @command(
         default_output=format_output(
             "",
diff --git a/miio/airhumidifier_jsq.py b/miio/airhumidifier_jsq.py
@@ -141,6 +141,8 @@ def use_time(self) -> Optional[int]:
 class AirHumidifierJsq(Device):
     """Implementation of Xiaomi Zero Fog Humidifier: shuii.humidifier.jsq001."""
 
+    _supported_models = [MODEL_HUMIDIFIER_JSQ001]
+
     @command(
         default_output=format_output(
             "",
diff --git a/miio/airhumidifier_mjjsq.py b/miio/airhumidifier_mjjsq.py
@@ -132,6 +132,8 @@ def use_time(self) -> Optional[int]:
 class AirHumidifierMjjsq(Device):
     """Support for deerma.humidifier.(mj)jsq."""
 
+    _supported_models = list(AVAILABLE_PROPERTIES.keys())
+
     @command(
         default_output=format_output(
             "",
diff --git a/miio/airpurifier.py b/miio/airpurifier.py
@@ -13,6 +13,15 @@
 _LOGGER = logging.getLogger(__name__)
 
 
+SUPPORTED_MODELS = [
+    "zhimi.airpurifier.v3",
+    "zhimi.airpurifier.v6",
+    "zhimi.airpurifier.v7",
+    "zhimi.airpurifier.m1",
+    "zhimi.airpurifier.m2",
+]
+
+
 class AirPurifierException(DeviceException):
     pass
 
@@ -300,6 +309,8 @@ def button_pressed(self) -> Optional[str]:
 class AirPurifier(Device):
     """Main class representing the air purifier."""
 
+    _supported_models = SUPPORTED_MODELS
+
     @command(
         default_output=format_output(
             "",
diff --git a/miio/airpurifier_airdog.py b/miio/airpurifier_airdog.py
@@ -101,6 +101,10 @@ def hcho(self) -> Optional[int]:
 
 
 class AirDogX3(Device):
+    """Support for Airdog air purifiers (airdog.airpurifier.x*)."""
+
+    _supported_models = list(AVAILABLE_PROPERTIES.keys())
+
     @command(
         default_output=format_output(
             "",
diff --git a/miio/airqualitymonitor.py b/miio/airqualitymonitor.py
@@ -151,6 +151,8 @@ def tvoc(self) -> Optional[int]:
 class AirQualityMonitor(Device):
     """Xiaomi PM2.5 Air Quality Monitor."""
 
+    _supported_models = list(AVAILABLE_PROPERTIES.keys())
+
     @command(
         default_output=format_output(
             "",
diff --git a/miio/alarmclock.py b/miio/alarmclock.py
@@ -63,6 +63,8 @@ class AlarmClock(Device):
     seconds /tries to get an answer.
     """
 
+    _supported_models = ["zimi.clock.myk01"]
+
     @command()
     def get_config_version(self):
         """
diff --git a/miio/aqaracamera.py b/miio/aqaracamera.py
@@ -156,6 +156,8 @@ def av_password(self) -> str:
 class AqaraCamera(Device):
     """Main class representing the Xiaomi Aqara Camera."""
 
+    _supported_models = ["lumi.camera.aq1"]
+
     @command(
         default_output=format_output(
             "",
diff --git a/miio/ceil.py b/miio/ceil.py
@@ -73,6 +73,8 @@ class Ceil(Device):
     # TODO: - Auto On/Off Not Supported
     #       - Adjust Scenes with Wall Switch Not Supported
 
+    _supported_models = ["unknown.models"]
+
     @command(
         default_output=format_output(
             "",
diff --git a/miio/chuangmi_camera.py b/miio/chuangmi_camera.py
@@ -64,6 +64,8 @@ class NASVideoRetentionTime(enum.IntEnum):
 CONST_HIGH_SENSITIVITY = [MotionDetectionSensitivity.High] * 32
 CONST_LOW_SENSITIVITY = [MotionDetectionSensitivity.Low] * 32
 
+SUPPORTED_MODELS = ["chuangmi.camera.ipc009", "chuangmi.camera.ipc019"]
+
 
 class CameraStatus(DeviceStatus):
     """Container for status reports from the Xiaomi Chuangmi Camera."""
@@ -148,6 +150,8 @@ def mini_level(self) -> int:
 class ChuangmiCamera(Device):
     """Main class representing the Xiaomi Chuangmi Camera."""
 
+    _supported_models = SUPPORTED_MODELS
+
     @command(
         default_output=format_output(
             "",
diff --git a/miio/chuangmi_ir.py b/miio/chuangmi_ir.py
@@ -31,6 +31,8 @@ class ChuangmiIrException(DeviceException):
 class ChuangmiIr(Device):
     """Main class representing Chuangmi IR Remote Controller."""
 
+    _supported_models = ["unknown.models"]
+
     PRONTO_RE = re.compile(r"^([\da-f]{4}\s?){3,}([\da-f]{4})$", re.IGNORECASE)
 
     @command(
diff --git a/miio/chuangmi_plug.py b/miio/chuangmi_plug.py
@@ -89,6 +89,8 @@ def wifi_led(self) -> Optional[bool]:
 class ChuangmiPlug(Device):
     """Main class representing the Chuangmi Plug."""
 
+    _supported_models = list(AVAILABLE_PROPERTIES.keys())
+
     @command(
         default_output=format_output(
             "",
diff --git a/miio/cooker.py b/miio/cooker.py
@@ -578,7 +578,9 @@ def custom(self) -> Optional[CookerCustomizations]:
 
 
 class Cooker(Device):
-    """Main class representing the cooker."""
+    """Main class representing the chunmi.cooker.*."""
+
+    _supported_models = [*MODEL_NORMAL, *MODEL_PRESSURE]
 
     @command(
         default_output=format_output(
diff --git a/miio/fan.py b/miio/fan.py
@@ -276,6 +276,8 @@ def child_lock(self) -> bool:
 class Fan(Device):
     """Main class representing the Xiaomi Mi Smart Pedestal Fan."""
 
+    _supported_models = list(AVAILABLE_PROPERTIES.keys() - MODEL_FAN_P5)
+
     def __init__(
         self,
         ip: str = None,
@@ -524,6 +526,10 @@ def __init__(
 
 
 class FanP5(Device):
+    """Support for dmaker.fan.p5."""
+
+    _supported_models = [MODEL_FAN_P5]
+
     def __init__(
         self,
         ip: str = None,
diff --git a/miio/fan_leshow.py b/miio/fan_leshow.py
@@ -93,6 +93,8 @@ def error_detected(self) -> bool:
 class FanLeshow(Device):
     """Main class representing the Xiaomi Rosou SS4 Ventilator."""
 
+    _supported_models = list(AVAILABLE_PROPERTIES.keys())
+
     @command(
         default_output=format_output(
             "",
diff --git a/miio/gateway/gateway.py b/miio/gateway/gateway.py
@@ -27,6 +27,17 @@
 GATEWAY_MODEL_AC_V3 = "lumi.acpartner.v3"
 
 
+SUPPORTED_MODELS = [
+    GATEWAY_MODEL_CHINA,
+    GATEWAY_MODEL_EU,
+    GATEWAY_MODEL_ZIG3,
+    GATEWAY_MODEL_AQARA,
+    GATEWAY_MODEL_AC_V1,
+    GATEWAY_MODEL_AC_V2,
+    GATEWAY_MODEL_AC_V3,
+]
+
+
 class GatewayException(DeviceException):
     """Exception for the Xioami Gateway communication."""
 
@@ -77,6 +88,8 @@ class Gateway(Device):
     * get_lumi_bind ["scene", <page number>] for rooms/devices
     """
 
+    _supported_models = SUPPORTED_MODELS
+
     def __init__(
         self,
         ip: str = None,
diff --git a/miio/gateway/gatewaydevice.py b/miio/gateway/gatewaydevice.py
@@ -17,6 +17,8 @@ class GatewayDevice(Device):
     """GatewayDevice class Specifies the init method for all gateway device
     functionalities."""
 
+    _supported_models = ["dummy.device"]
+
     def __init__(
         self,
         ip: str = None,
diff --git a/miio/heater.py b/miio/heater.py
@@ -127,6 +127,8 @@ def delay_off_countdown(self) -> Optional[int]:
 class Heater(Device):
     """Main class representing the Smartmi Zhimi Heater."""
 
+    _supported_models = list(SUPPORTED_MODELS.keys())
+
     @command(
         default_output=format_output(
             "",
diff --git a/miio/integrations/vacuum/viomi/viomivacuum.py b/miio/integrations/vacuum/viomi/viomivacuum.py
@@ -62,6 +62,7 @@
 
 _LOGGER = logging.getLogger(__name__)
 
+SUPPORTED_MODELS = ["viomi.vacuum.v7"]
 
 ERROR_CODES = {
     0: "Sleeping and not charging",
@@ -479,6 +480,8 @@ def _get_rooms_from_schedules(schedules: List[str]) -> Tuple[bool, Dict]:
 class ViomiVacuum(Device):
     """Interface for Viomi vacuums (viomi.vacuum.v7)."""
 
+    _supported_models = SUPPORTED_MODELS
+
     timeout = 5
     retry_count = 10
 
diff --git a/miio/philips_bulb.py b/miio/philips_bulb.py
@@ -68,6 +68,8 @@ def delay_off_countdown(self) -> int:
 class PhilipsWhiteBulb(Device):
     """Main class representing Xiaomi Philips White LED Ball Lamp."""
 
+    _supported_models = list(AVAILABLE_PROPERTIES.keys())
+
     @command(
         default_output=format_output(
             "",
diff --git a/miio/philips_eyecare.py b/miio/philips_eyecare.py
@@ -78,6 +78,8 @@ def delay_off_countdown(self) -> int:
 class PhilipsEyecare(Device):
     """Main class representing Xiaomi Philips Eyecare Smart Lamp 2."""
 
+    _supported_models = ["unknown.models"]
+
     @command(
         default_output=format_output(
             "",
diff --git a/miio/philips_moonlight.py b/miio/philips_moonlight.py
@@ -114,6 +114,8 @@ class PhilipsMoonlight(Device):
     enable_bl                       # Night light
     """
 
+    _supported_models = ["philips.light.moonlight"]
+
     @command(
         default_output=format_output(
             "",
diff --git a/miio/philips_rwread.py b/miio/philips_rwread.py
@@ -83,6 +83,8 @@ def child_lock(self) -> bool:
 class PhilipsRwread(Device):
     """Main class representing Xiaomi Philips RW Read."""
 
+    _supported_models = list(AVAILABLE_PROPERTIES.keys())
+
     @command(
         default_output=format_output(
             "",
diff --git a/miio/pwzn_relay.py b/miio/pwzn_relay.py
@@ -99,6 +99,8 @@ def on_count(self) -> Optional[int]:
 class PwznRelay(Device):
     """Main class representing the PWZN Relay."""
 
+    _supported_models = list(AVAILABLE_PROPERTIES.keys())
+
     @command(default_output=format_output("", "on_count: {result.on_count}\n"))
     def status(self) -> PwznRelayStatus:
         """Retrieve properties."""
diff --git a/miio/scishare_coffeemaker.py b/miio/scishare_coffeemaker.py
@@ -29,6 +29,8 @@ class Status(IntEnum):
 class ScishareCoffee(Device):
     """Main class for Scishare coffee maker (scishare.coffee.s1102)."""
 
+    _supported_models = ["scishare.coffee.s1102"]
+
     @command()
     def status(self) -> int:
         """Device status."""
diff --git a/miio/tests/test_device.py b/miio/tests/test_device.py
@@ -104,3 +104,12 @@ def test_device_ctor_model(cls):
     dummy_model = "dummy"
     dev = cls("127.0.0.1", "68ffffffffffffffffffffffffffffff", model=dummy_model)
     assert dev.model == dummy_model
+
+
+@pytest.mark.parametrize("cls", Device.__subclasses__())
+def test_device_supported_models(cls):
+    """Make sure that every device subclass has a non-empty supported models."""
+    if cls.__name__ == "MiotDevice":  # skip miotdevice
+        return
+
+    assert cls._supported_models
diff --git a/miio/toiletlid.py b/miio/toiletlid.py
@@ -71,6 +71,10 @@ def ambient_light(self) -> str:
 
 
 class Toiletlid(Device):
+    """Support for tinymu.toiletlid.v1."""
+
+    _supported_models = list(AVAILABLE_PROPERTIES.keys())
+
     @command(
         default_output=format_output(
             "",
diff --git a/miio/walkingpad.py b/miio/walkingpad.py
@@ -101,6 +101,8 @@ def calories(self) -> int:
 class Walkingpad(Device):
     """Main class representing Xiaomi Walkingpad."""
 
+    _supported_models = ["ksmb.walkingpad.v3"]
+
     @command(
         default_output=format_output(
             "",
diff --git a/miio/waterpurifier.py b/miio/waterpurifier.py
@@ -91,7 +91,9 @@ def valve(self) -> str:
 
 
 class WaterPurifier(Device):
-    """Main class representing the waiter purifier."""
+    """Main class representing the water purifier."""
+
+    _supported_models = ["unknown.models"]
 
     @command(
         default_output=format_output(
diff --git a/miio/waterpurifier_yunmi.py b/miio/waterpurifier_yunmi.py
diff --git a/miio/wifirepeater.py b/miio/wifirepeater.py
diff --git a/miio/wifispeaker.py b/miio/wifispeaker.py
