Optimize evaporative humidifier test (#346)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: J. Nick Koston <[email protected]>

Author: 3 people

switchbot/__init__.py

@@ -12,6 +12,9 @@
 from .const import (
     AirPurifierMode,
     FanMode,
+    HumidifierAction,
+    HumidifierMode,
+    HumidifierWaterLevel,
     LockStatus,
     SwitchbotAccountConnectionError,
     SwitchbotApiError,
@@ -43,6 +46,9 @@
     "ColorMode",
     "FanMode",
     "GetSwitchbotDevices",
+    "HumidifierAction",
+    "HumidifierMode",
+    "HumidifierWaterLevel",
     "LockStatus",
     "SwitchBotAdvertisement",
     "Switchbot",

switchbot/adv_parsers/hub2.py

@@ -5,6 +5,7 @@
 from typing import Any
 
 from ..const.hub2 import LIGHT_INTENSITY_MAP
+from ..helpers import celsius_to_fahrenheit
 
 
 def process_wohub2(data: bytes | None, mfr_data: bytes | None) -> dict[str, Any]:
@@ -22,7 +23,7 @@ def process_wohub2(data: bytes | None, mfr_data: bytes | None) -> dict[str, Any]
     _temp_c = _temp_sign * (
         (temp_data[1] & 0b01111111) + ((temp_data[0] & 0b00001111) / 10)
     )
-    _temp_f = (_temp_c * 9 / 5) + 32
+    _temp_f = celsius_to_fahrenheit(_temp_c)
     _temp_f = (_temp_f * 10) / 10
     humidity = temp_data[2] & 0b01111111
     light_level = status & 0b11111

switchbot/adv_parsers/hub3.py

@@ -5,6 +5,7 @@
 from typing import Any
 
 from ..const.hub3 import LIGHT_INTENSITY_MAP
+from ..helpers import celsius_to_fahrenheit
 
 
 def process_hub3(data: bytes | None, mfr_data: bytes | None) -> dict[str, Any]:
@@ -26,7 +27,7 @@ def process_hub3(data: bytes | None, mfr_data: bytes | None) -> dict[str, Any]:
     _temp_c = _temp_sign * (
         (temp_data[1] & 0b01111111) + ((temp_data[0] & 0b00001111) / 10)
     )
-    _temp_f = round(((_temp_c * 9 / 5) + 32), 1)
+    _temp_f = round(celsius_to_fahrenheit(_temp_c), 1)
     humidity = temp_data[2] & 0b01111111
     motion_detected = bool(device_data[10] & 0b10000000)
 

switchbot/adv_parsers/hubmini_matter.py

@@ -4,6 +4,8 @@
 
 from typing import Any
 
+from ..helpers import celsius_to_fahrenheit
+
 
 def process_hubmini_matter(
     data: bytes | None, mfr_data: bytes | None
@@ -21,7 +23,7 @@ def process_hubmini_matter(
     _temp_c = _temp_sign * (
         (temp_data[1] & 0b01111111) + ((temp_data[0] & 0b00001111) / 10)
     )
-    _temp_f = (_temp_c * 9 / 5) + 32
+    _temp_f = celsius_to_fahrenheit(_temp_c)
     _temp_f = (_temp_f * 10) / 10
     humidity = temp_data[2] & 0b01111111
 

switchbot/adv_parsers/humidifier.py

@@ -6,11 +6,10 @@
 from datetime import timedelta
 
 from ..const.evaporative_humidifier import (
-    OVER_HUMIDIFY_PROTECTION_MODES,
-    TARGET_HUMIDITY_MODES,
     HumidifierMode,
     HumidifierWaterLevel,
 )
+from ..helpers import celsius_to_fahrenheit
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -23,6 +22,26 @@
 # Low:  658000c5222b6300
 # Med:  658000c5432b6300
 # High: 658000c5642b6300
+
+
+def calculate_temperature_and_humidity(
+    data: bytes, is_meter_binded: bool = True
+) -> tuple[float | None, float | None, int | None]:
+    """Calculate temperature and humidity based on the given flag."""
+    if len(data) < 3 or not is_meter_binded:
+        return None, None, None
+
+    humidity = data[0] & 0b01111111
+    if humidity > 100:
+        return None, None, None
+
+    _temp_sign = 1 if data[1] & 0b10000000 else -1
+    _temp_c = _temp_sign * ((data[1] & 0b01111111) + ((data[2] >> 4) / 10))
+    _temp_f = celsius_to_fahrenheit(_temp_c)
+
+    return _temp_c, _temp_f, humidity
+
+
 def process_wohumidifier(
     data: bytes | None, mfr_data: bytes | None
 ) -> dict[str, bool | int]:
@@ -46,48 +65,43 @@ def process_evaporative_humidifier(
 ) -> dict[str, bool | int]:
     """Process WoHumi services data."""
     if mfr_data is None:
-        return {
-            "isOn": None,
-            "mode": None,
-            "target_humidity": None,
-            "child_lock": None,
-            "over_humidify_protection": None,
-            "tank_removed": None,
-            "tilted_alert": None,
-            "filter_missing": None,
-            "humidity": None,
-            "temperature": None,
-            "filter_run_time": None,
-            "filter_alert": None,
-            "water_level": None,
-        }
+        return {}
 
+    seq_number = mfr_data[6]
     is_on = bool(mfr_data[7] & 0b10000000)
     mode = HumidifierMode(mfr_data[7] & 0b00001111)
-    filter_run_time = timedelta(hours=int.from_bytes(mfr_data[12:14], byteorder="big"))
-    has_humidity = bool(mfr_data[9] & 0b10000000)
-    has_temperature = bool(mfr_data[10] & 0b10000000)
-    is_tank_removed = bool(mfr_data[8] & 0b00000100)
+    over_humidify_protection = bool(mfr_data[8] & 0b10000000)
+    child_lock = bool(mfr_data[8] & 0b00100000)
+    tank_removed = bool(mfr_data[8] & 0b00000100)
+    tilted_alert = bool(mfr_data[8] & 0b00000010)
+    filter_missing = bool(mfr_data[8] & 0b00000001)
+    is_meter_binded = bool(mfr_data[9] & 0b10000000)
+
+    _temp_c, _temp_f, humidity = calculate_temperature_and_humidity(
+        mfr_data[9:12], is_meter_binded
+    )
+
+    water_level = HumidifierWaterLevel(mfr_data[11] & 0b00000011).name.lower()
+    filter_run_time = timedelta(
+        hours=int.from_bytes(mfr_data[12:14], byteorder="big") & 0xFFF
+    )
+    target_humidity = mfr_data[16] & 0b01111111
+
     return {
+        "seq_number": seq_number,
         "isOn": is_on,
-        "mode": mode if is_on else None,
-        "target_humidity": (mfr_data[16] & 0b01111111)
-        if is_on and mode in TARGET_HUMIDITY_MODES
-        else None,
-        "child_lock": bool(mfr_data[8] & 0b00100000),
-        "over_humidify_protection": bool(mfr_data[8] & 0b10000000)
-        if is_on and mode in OVER_HUMIDIFY_PROTECTION_MODES
-        else None,
-        "tank_removed": is_tank_removed,
-        "tilted_alert": bool(mfr_data[8] & 0b00000010),
-        "filter_missing": bool(mfr_data[8] & 0b00000001),
-        "humidity": (mfr_data[9] & 0b01111111) if has_humidity else None,
-        "temperature": float(mfr_data[10] & 0b01111111) + float(mfr_data[11] >> 4) / 10
-        if has_temperature
-        else None,
+        "mode": mode,
+        "over_humidify_protection": over_humidify_protection,
+        "child_lock": child_lock,
+        "tank_removed": tank_removed,
+        "tilted_alert": tilted_alert,
+        "filter_missing": filter_missing,
+        "is_meter_binded": is_meter_binded,
+        "humidity": humidity,
+        "temperature": _temp_c,
+        "temp": {"c": _temp_c, "f": _temp_f},
+        "water_level": water_level,
         "filter_run_time": filter_run_time,
         "filter_alert": filter_run_time.days >= 10,
-        "water_level": HumidifierWaterLevel(mfr_data[11] & 0b00000011)
-        if not is_tank_removed
-        else None,
+        "target_humidity": target_humidity,
     }

switchbot/adv_parsers/meter.py

@@ -5,6 +5,8 @@
 import struct
 from typing import Any
 
+from ..helpers import celsius_to_fahrenheit
+
 CO2_UNPACK = struct.Struct(">H").unpack_from
 
 
@@ -28,7 +30,7 @@ def process_wosensorth(data: bytes | None, mfr_data: bytes | None) -> dict[str,
     _temp_c = _temp_sign * (
         (temp_data[1] & 0b01111111) + ((temp_data[0] & 0b00001111) / 10)
     )
-    _temp_f = (_temp_c * 9 / 5) + 32
+    _temp_f = celsius_to_fahrenheit(_temp_c)
     _temp_f = (_temp_f * 10) / 10
     humidity = temp_data[2] & 0b01111111
 

switchbot/const/__init__.py

@@ -4,6 +4,11 @@
 
 from ..enum import StrEnum
 from .air_purifier import AirPurifierMode
+from .evaporative_humidifier import (
+    HumidifierAction,
+    HumidifierMode,
+    HumidifierWaterLevel,
+)
 from .fan import FanMode
 
 # Preserve old LockStatus export for backwards compatibility
@@ -86,6 +91,9 @@ class SwitchbotModel(StrEnum):
     "DEFAULT_SCAN_TIMEOUT",
     "AirPurifierMode",
     "FanMode",
+    "HumidifierAction",
+    "HumidifierMode",
+    "HumidifierWaterLevel",
     "LockStatus",
     "SwitchbotAccountConnectionError",
     "SwitchbotApiError",

switchbot/const/evaporative_humidifier.py

@@ -13,13 +13,27 @@ class HumidifierMode(Enum):
     AUTO = 7
     DRYING_FILTER = 8
 
+    @classmethod
+    def get_modes(cls) -> list[str]:
+        return [mode.name.lower() for mode in cls]
+
 
 class HumidifierWaterLevel(Enum):
     EMPTY = 0
     LOW = 1
     MEDIUM = 2
     HIGH = 3
 
+    @classmethod
+    def get_levels(cls) -> list[str]:
+        return [level.name.lower() for level in cls]
+
+
+class HumidifierAction(Enum):
+    OFF = 0
+    HUMIDIFYING = 1
+    DRYING = 2
+
 
 OVER_HUMIDIFY_PROTECTION_MODES = {
     HumidifierMode.QUIET,

switchbot/devices/device.py

@@ -583,11 +583,11 @@ async def get_device_data(
 
         return self._sb_adv_data
 
-    async def _get_basic_info(self) -> bytes | None:
+    async def _get_basic_info(
+        self, cmd: str = DEVICE_GET_BASIC_SETTINGS_KEY
+    ) -> bytes | None:
         """Return basic info of device."""
-        _data = await self._send_command(
-            key=DEVICE_GET_BASIC_SETTINGS_KEY, retry=self._retry_count
-        )
+        _data = await self._send_command(key=cmd, retry=self._retry_count)
 
         if _data in (b"\x07", b"\x00"):
             _LOGGER.error("Unsuccessful, please try again")