Просмотр исходного кода

fix(meter-pro): validate display setting input types (#622)

* fix(meter-pro): validate display setting input types

Enum setters now accept the enum or its integer value and raise
SwitchbotOperationError for anything else, bool setters reject
non-bool values, unknown zone icons are kept as raw ints, the
calibration tenths byte is range-checked in full, and the weather
opcodes are grouped again.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(meter-pro): honor readback field boundaries

* refactor(meter-pro): reuse enum validation for weather icons

---------

Co-authored-by: Benoit Vuillemin <6716106+bvuillemin@users.noreply.github.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: zerzhang <916250497@qq.com>
Benoit Vuillemin 2 дней назад
Родитель
Сommit
a0e68a6a9d
2 измененных файлов с 140 добавлено и 22 удалено
  1. 59 21
      switchbot/devices/meter_pro.py
  2. 81 1
      tests/test_meter_pro_settings.py

+ 59 - 21
switchbot/devices/meter_pro.py

@@ -1,5 +1,6 @@
 from decimal import ROUND_HALF_UP, Decimal
 from decimal import ROUND_HALF_UP, Decimal
-from typing import Any
+from enum import Enum
+from typing import Any, TypeVar
 
 
 from ..const.meter_pro import (
 from ..const.meter_pro import (
     MeterProAlarmMode,
     MeterProAlarmMode,
@@ -18,6 +19,8 @@ from ..const.meter_pro import (
 from ..helpers import parse_uint24_be
 from ..helpers import parse_uint24_be
 from .device import SwitchbotDevice, SwitchbotOperationError
 from .device import SwitchbotDevice, SwitchbotOperationError
 
 
+_E = TypeVar("_E", bound=Enum)
+
 COMMAND_SET_TIME_OFFSET = "570f680506"
 COMMAND_SET_TIME_OFFSET = "570f680506"
 COMMAND_GET_TIME_OFFSET = "570f690506"
 COMMAND_GET_TIME_OFFSET = "570f690506"
 MAX_TIME_OFFSET = (1 << 24) - 1
 MAX_TIME_OFFSET = (1 << 24) - 1
@@ -25,6 +28,8 @@ MAX_TIME_OFFSET = (1 << 24) - 1
 COMMAND_GET_DEVICE_DATETIME = "570f6901"
 COMMAND_GET_DEVICE_DATETIME = "570f6901"
 COMMAND_SET_DEVICE_DATETIME = "57000503"
 COMMAND_SET_DEVICE_DATETIME = "57000503"
 COMMAND_SET_DISPLAY_FORMAT = "570f680505"
 COMMAND_SET_DISPLAY_FORMAT = "570f680505"
+COMMAND_GET_WEATHER = "570f6906"
+COMMAND_SET_WEATHER = "570f680601"
 
 
 COMMAND_GET_COMFORT_LEVEL = "570f69020101"
 COMMAND_GET_COMFORT_LEVEL = "570f69020101"
 COMMAND_GET_TEMPERATURE_HUMIDITY_ALARM = "570f69020100"
 COMMAND_GET_TEMPERATURE_HUMIDITY_ALARM = "570f69020100"
@@ -53,9 +58,6 @@ KEEP_BUTTON_FUNCTION = 0xFF
 KEEP_ALARM_VOLUME = 0xFF
 KEEP_ALARM_VOLUME = 0xFF
 TEMPERATURE_HUMIDITY_ALARM_MASK = 0x77
 TEMPERATURE_HUMIDITY_ALARM_MASK = 0x77
 SOURCES_WITHOUT_MAC = {MeterProDisplaySource.NONE, MeterProDisplaySource.NETWORK}
 SOURCES_WITHOUT_MAC = {MeterProDisplaySource.NONE, MeterProDisplaySource.NETWORK}
-COMMAND_GET_WEATHER = "570f6906"
-COMMAND_SET_WEATHER = "570f680601"
-
 COMMAND_TRIGGER_CO2_SAMPLING = "570f680b04"
 COMMAND_TRIGGER_CO2_SAMPLING = "570f680b04"
 COMMAND_START_CO2_CALIBRATION = "570f680b02"
 COMMAND_START_CO2_CALIBRATION = "570f680b02"
 COMMAND_GET_USB_POWER_STATE = "570f690b02"
 COMMAND_GET_USB_POWER_STATE = "570f690b02"
@@ -134,12 +136,13 @@ def _encode_weather_humidity(humidity: float | Decimal) -> int:
     return int(relative_humidity.quantize(Decimal(1), rounding=ROUND_HALF_UP))
     return int(relative_humidity.quantize(Decimal(1), rounding=ROUND_HALF_UP))
 
 
 
 
-def _encode_weather_icon(icon: MeterProWeatherIcon | int) -> MeterProWeatherIcon:
-    if isinstance(icon, MeterProWeatherIcon):
-        return icon
-    if isinstance(icon, bool) or not isinstance(icon, int):
-        raise TypeError("Weather icon must be a MeterProWeatherIcon or integer")
-    return MeterProWeatherIcon(icon)
+def _coerce_enum(enum_cls: type[_E], value: _E | int, name: str) -> _E:
+    """Return value as enum_cls; accept the enum or its integer value."""
+    if isinstance(value, enum_cls):
+        return value
+    if isinstance(value, bool) or not isinstance(value, int):
+        raise TypeError(f"{name} must be a {enum_cls.__name__} or integer")
+    return enum_cls(value)
 
 
 
 
 def _mac_hex(mac: str | None) -> str:
 def _mac_hex(mac: str | None) -> str:
@@ -521,8 +524,9 @@ class SwitchbotMeterPro(SwitchbotDevice):
         Get the zones, data update interval, date format and battery icon.
         Get the zones, data update interval, date format and battery icon.
 
 
         Missing fields and unknown date or battery icon values are None.
         Missing fields and unknown date or battery icon values are None.
-        Each zone has "icon", "source" (the raw int if unknown) and "source_mac"
-        (None when the zone shows this device or network data).
+        Each zone has "icon" (None when unset or held), "source", and "source_mac"
+        (None when the zone shows this device or network data). Other unknown icon
+        and source codes are returned as raw ints for inspection.
         """
         """
         # [status][icons mid|bot][sources mid|bot][mac mid x6][mac bot x6]
         # [status][icons mid|bot][sources mid|bot][mac mid x6][mac bot x6]
         # [data update interval u16][date format][reserved][battery icon]
         # [data update interval u16][date format][reserved][battery icon]
@@ -531,7 +535,11 @@ class SwitchbotMeterPro(SwitchbotDevice):
 
 
         def zone(icon: int, source: int, mac: bytes) -> dict[str, Any]:
         def zone(icon: int, source: int, mac: bytes) -> dict[str, Any]:
             return {
             return {
-                "icon": next((i for i in MeterProZoneIcon if i.value == icon), None),
+                "icon": (
+                    next((i for i in MeterProZoneIcon if i.value == icon), icon)
+                    if icon not in (0, KEEP_ICON)
+                    else None
+                ),
                 "source": next(
                 "source": next(
                     (s for s in MeterProDisplaySource if s.value == source), source
                     (s for s in MeterProDisplaySource if s.value == source), source
                 ),
                 ),
@@ -558,10 +566,10 @@ class SwitchbotMeterPro(SwitchbotDevice):
 
 
     async def set_display_zone(
     async def set_display_zone(
         self,
         self,
-        zone: MeterProDisplayZone,
-        source: MeterProDisplaySource,
+        zone: MeterProDisplayZone | int,
+        source: MeterProDisplaySource | int,
         source_mac: str | None = None,
         source_mac: str | None = None,
-        icon: MeterProZoneIcon | None = None,
+        icon: MeterProZoneIcon | int | None = None,
     ) -> None:
     ) -> None:
         """
         """
         Choose what a screen zone shows; icon None keeps the current icon.
         Choose what a screen zone shows; icon None keeps the current icon.
@@ -571,8 +579,12 @@ class SwitchbotMeterPro(SwitchbotDevice):
         device. The screen applies it at the next data update.
         device. The screen applies it at the next data update.
         """
         """
         try:
         try:
+            zone = _coerce_enum(MeterProDisplayZone, zone, "Display zone")
+            source = _coerce_enum(MeterProDisplaySource, source, "Display source")
+            if icon is not None:
+                icon = _coerce_enum(MeterProZoneIcon, icon, "Zone icon")
             mac = _mac_hex(source_mac)
             mac = _mac_hex(source_mac)
-        except ValueError as err:
+        except (TypeError, ValueError) as err:
             raise SwitchbotOperationError(f"{self.name}: {err}") from err
             raise SwitchbotOperationError(f"{self.name}: {err}") from err
         if mac != NO_MAC and source in SOURCES_WITHOUT_MAC:
         if mac != NO_MAC and source in SOURCES_WITHOUT_MAC:
             raise SwitchbotOperationError(
             raise SwitchbotOperationError(
@@ -595,10 +607,17 @@ class SwitchbotMeterPro(SwitchbotDevice):
 
 
     async def set_zone_icons(
     async def set_zone_icons(
         self,
         self,
-        middle: MeterProZoneIcon | None = None,
-        bottom: MeterProZoneIcon | None = None,
+        middle: MeterProZoneIcon | int | None = None,
+        bottom: MeterProZoneIcon | int | None = None,
     ) -> None:
     ) -> None:
         """Set the indoor/outdoor icons of both zones; None keeps an icon."""
         """Set the indoor/outdoor icons of both zones; None keeps an icon."""
+        try:
+            if middle is not None:
+                middle = _coerce_enum(MeterProZoneIcon, middle, "Middle icon")
+            if bottom is not None:
+                bottom = _coerce_enum(MeterProZoneIcon, bottom, "Bottom icon")
+        except (TypeError, ValueError) as err:
+            raise SwitchbotOperationError(f"{self.name}: {err}") from err
         middle_byte = KEEP_ICON if middle is None else middle.value
         middle_byte = KEEP_ICON if middle is None else middle.value
         bottom_byte = KEEP_ICON if bottom is None else bottom.value
         bottom_byte = KEEP_ICON if bottom is None else bottom.value
         payload = f"{COMMAND_SET_ZONE_ICONS}{middle_byte:02x}{bottom_byte:02x}"
         payload = f"{COMMAND_SET_ZONE_ICONS}{middle_byte:02x}{bottom_byte:02x}"
@@ -620,20 +639,26 @@ class SwitchbotMeterPro(SwitchbotDevice):
         result = await self._send_command(payload)
         result = await self._send_command(payload)
         self._validate_result("set_data_update_interval", result)
         self._validate_result("set_data_update_interval", result)
 
 
-    async def set_date_format(self, date_format: MeterProDateFormat) -> None:
+    async def set_date_format(self, date_format: MeterProDateFormat | int) -> None:
         """Set the date format; the app offers it from firmware 1.5."""
         """Set the date format; the app offers it from firmware 1.5."""
+        try:
+            date_format = _coerce_enum(MeterProDateFormat, date_format, "Date format")
+        except (TypeError, ValueError) as err:
+            raise SwitchbotOperationError(f"{self.name}: {err}") from err
         payload = f"{COMMAND_SET_DATE_FORMAT}{date_format.value:02x}"
         payload = f"{COMMAND_SET_DATE_FORMAT}{date_format.value:02x}"
         result = await self._send_command(payload)
         result = await self._send_command(payload)
         self._validate_result("set_date_format", result)
         self._validate_result("set_date_format", result)
 
 
     async def set_battery_icon(self, always: bool) -> None:
     async def set_battery_icon(self, always: bool) -> None:
         """Show the battery icon always, or only when the battery is low."""
         """Show the battery icon always, or only when the battery is low."""
+        self._check_bool(always, "always")
         payload = f"{COMMAND_SET_BATTERY_ICON}{'01' if always else '00'}"
         payload = f"{COMMAND_SET_BATTERY_ICON}{'01' if always else '00'}"
         result = await self._send_command(payload)
         result = await self._send_command(payload)
         self._validate_result("set_battery_icon", result)
         self._validate_result("set_battery_icon", result)
 
 
     async def set_temperature_unit(self, fahrenheit: bool) -> None:
     async def set_temperature_unit(self, fahrenheit: bool) -> None:
         """Set the default temperature unit shown on the screen (F or C)."""
         """Set the default temperature unit shown on the screen (F or C)."""
+        self._check_bool(fahrenheit, "fahrenheit")
         payload = f"{COMMAND_SET_TEMPERATURE_UNIT}{'01' if fahrenheit else '00'}"
         payload = f"{COMMAND_SET_TEMPERATURE_UNIT}{'01' if fahrenheit else '00'}"
         result = await self._send_command(payload)
         result = await self._send_command(payload)
         self._validate_result("set_temperature_unit", result)
         self._validate_result("set_temperature_unit", result)
@@ -652,6 +677,12 @@ class SwitchbotMeterPro(SwitchbotDevice):
         self, unit_switch: bool | None = None, source_switch: bool | None = None
         self, unit_switch: bool | None = None, source_switch: bool | None = None
     ) -> None:
     ) -> None:
         """Allow or forbid the button actions; None keeps one as is."""
         """Allow or forbid the button actions; None keeps one as is."""
+        for flag, name in (
+            (unit_switch, "unit_switch"),
+            (source_switch, "source_switch"),
+        ):
+            if flag is not None:
+                self._check_bool(flag, name)
         unit_byte = (
         unit_byte = (
             KEEP_BUTTON_FUNCTION
             KEEP_BUTTON_FUNCTION
             if unit_switch is None
             if unit_switch is None
@@ -666,6 +697,12 @@ class SwitchbotMeterPro(SwitchbotDevice):
         result = await self._send_command(payload)
         result = await self._send_command(payload)
         self._validate_result("set_button_functions", result)
         self._validate_result("set_button_functions", result)
 
 
+    def _check_bool(self, value: object, name: str) -> None:
+        if not isinstance(value, bool):
+            raise SwitchbotOperationError(
+                f"{self.name}: {name} must be a boolean, got {value!r}"
+            )
+
     def _validate_result(
     def _validate_result(
         self, op_name: str, result: bytes | None, min_length: int | None = None
         self, op_name: str, result: bytes | None, min_length: int | None = None
     ) -> bytes:
     ) -> bytes:
@@ -735,7 +772,8 @@ class SwitchbotMeterPro(SwitchbotDevice):
                 f"{self.name}: Supply at least one weather field"
                 f"{self.name}: Supply at least one weather field"
             )
             )
         try:
         try:
-            icon = _encode_weather_icon(icon) if icon is not None else None
+            if icon is not None:
+                icon = _coerce_enum(MeterProWeatherIcon, icon, "Weather icon")
             temperature = (
             temperature = (
                 _encode_weather_temperature(temperature_c)
                 _encode_weather_temperature(temperature_c)
                 if temperature_c is not None
                 if temperature_c is not None

+ 81 - 1
tests/test_meter_pro_settings.py

@@ -135,6 +135,41 @@ async def test_get_display_settings_unknown_source_kept_raw():
     assert settings["bottom"]["source"] == 7
     assert settings["bottom"]["source"] == 7
 
 
 
 
+@pytest.mark.asyncio
+async def test_get_display_settings_unknown_icon_kept_raw():
+    device = create_device()
+    device._send_command.return_value = bytes.fromhex(
+        "013053000000000000aabbccddeeff0258010101"
+    )
+
+    settings = await device.get_display_settings()
+
+    assert settings["middle"]["icon"] == 3
+    assert settings["bottom"]["icon"] is None
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    ("icon_byte", "middle", "bottom"),
+    [
+        ("f1", None, MeterProZoneIcon.INDOOR),
+        ("2f", MeterProZoneIcon.OUTDOOR, None),
+    ],
+)
+async def test_get_display_settings_hold_icon(
+    icon_byte: str, middle: MeterProZoneIcon | None, bottom: MeterProZoneIcon | None
+):
+    device = create_device()
+    device._send_command.return_value = bytes.fromhex(
+        DISPLAY_SETTINGS[:2] + icon_byte + DISPLAY_SETTINGS[4:]
+    )
+
+    settings = await device.get_display_settings()
+
+    assert settings["middle"]["icon"] is middle
+    assert settings["bottom"]["icon"] is bottom
+
+
 @pytest.mark.asyncio
 @pytest.mark.asyncio
 async def test_get_display_settings_weather_station_and_hub3():
 async def test_get_display_settings_weather_station_and_hub3():
     device = create_device()
     device = create_device()
@@ -370,6 +405,7 @@ async def test_set_button_functions(
         ("01018305", -1.5, 3),
         ("01018305", -1.5, 3),
         ("01820a03", 2.3, -10),
         ("01820a03", 2.3, -10),
         ("01800005", 0.5, 0),
         ("01800005", 0.5, 0),
+        ("01808015", 0.5, 0),
     ],
     ],
 )
 )
 async def test_get_calibration(response: str, temperature: float, humidity: int):
 async def test_get_calibration(response: str, temperature: float, humidity: int):
@@ -384,7 +420,7 @@ async def test_get_calibration(response: str, temperature: float, humidity: int)
 
 
 
 
 @pytest.mark.asyncio
 @pytest.mark.asyncio
-@pytest.mark.parametrize("response", ["0180800a", "0180e400", "01806400"])
+@pytest.mark.parametrize("response", ["0180800a", "0180e400", "01806400", "018080fa"])
 async def test_get_calibration_rejects_invalid_values(response: str):
 async def test_get_calibration_rejects_invalid_values(response: str):
     device = create_device()
     device = create_device()
     device._send_command.return_value = bytes.fromhex(response)
     device._send_command.return_value = bytes.fromhex(response)
@@ -994,3 +1030,47 @@ async def test_set_temperature_humidity_alarm_rejects_device_error():
         await device.set_temperature_humidity_alarm(
         await device.set_temperature_humidity_alarm(
             MeterProTemperatureHumidityAlarmMode.DISABLED, 0, 0, 0, 0
             MeterProTemperatureHumidityAlarmMode.DISABLED, 0, 0, 0, 0
         )
         )
+
+
+@pytest.mark.asyncio
+async def test_enum_setters_accept_raw_ints():
+    device = create_device()
+
+    await device.set_display_zone(2, 3, "D4:E5:F6:A1:B2:C3", icon=2)
+    device._send_command.assert_called_with("570f6807010202" + "03d4e5f6a1b2c3")
+    await device.set_zone_icons(middle=1, bottom=2)
+    device._send_command.assert_called_with("570f680701030102")
+    await device.set_date_format(1)
+    device._send_command.assert_called_with("570f6807010701")
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    ("method", "args", "kwargs"),
+    [
+        ("set_display_zone", (3, MeterProDisplaySource.NONE), {}),
+        ("set_display_zone", ("bottom", MeterProDisplaySource.NONE), {}),
+        ("set_display_zone", (MeterProDisplayZone.BOTTOM, 15), {}),
+        ("set_display_zone", (MeterProDisplayZone.BOTTOM, True), {}),
+        (
+            "set_display_zone",
+            (MeterProDisplayZone.BOTTOM, MeterProDisplaySource.NONE),
+            {"icon": 9},
+        ),
+        ("set_zone_icons", (), {"middle": 3}),
+        ("set_zone_icons", (), {"bottom": "outdoor"}),
+        ("set_date_format", (2,), {}),
+        ("set_date_format", ("DD/MM",), {}),
+        ("set_battery_icon", ("false",), {}),
+        ("set_battery_icon", (1,), {}),
+        ("set_temperature_unit", (0.0,), {}),
+        ("set_button_functions", (), {"unit_switch": "off"}),
+        ("set_button_functions", (), {"source_switch": 1}),
+    ],
+)
+async def test_setters_reject_wrong_types(method: str, args: tuple, kwargs: dict):
+    device = create_device()
+
+    with pytest.raises(SwitchbotOperationError):
+        await getattr(device, method)(*args, **kwargs)
+    device._send_command.assert_not_called()