PySwitchbot 2.10.0__tar.gz → 3.1.0__tar.gz

{pyswitchbot-2.10.0 → pyswitchbot-3.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PySwitchbot
-Version: 2.10.0
+Version: 3.1.0
 Summary: A library to communicate with Switchbot
 License: MIT
 License-File: LICENSE
@@ -42,6 +42,19 @@ source .venv/bin/activate
 pip install .
 ```
 
+## Air purifier filter reset
+
+After replacing the filter, call `await purifier.reset_filter_usage()` on a
+configured `SwitchbotAirPurifier` instance. The method uses the device's
+encrypted BLE connection, sends the reset command without automatic retries,
+and reads back the used-hours counter. It returns `True` and refreshes the
+cached `filter element working time` only after the device reports zero.
+
+Failed commands or an unconfirmed reset raise `SwitchbotOperationError`. If a
+reply is lost, check the device before retrying: the reset may already have
+been applied. This resets the device counter and does not restore its previous
+value.
+
 ## OAuth account access
 
 pySwitchbot provides helpers for SwitchBot's authorization-code flow. The

{pyswitchbot-2.10.0 → pyswitchbot-3.1.0}/README.md

@@ -10,6 +10,19 @@ source .venv/bin/activate
 pip install .
 ```
 
+## Air purifier filter reset
+
+After replacing the filter, call `await purifier.reset_filter_usage()` on a
+configured `SwitchbotAirPurifier` instance. The method uses the device's
+encrypted BLE connection, sends the reset command without automatic retries,
+and reads back the used-hours counter. It returns `True` and refreshes the
+cached `filter element working time` only after the device reports zero.
+
+Failed commands or an unconfirmed reset raise `SwitchbotOperationError`. If a
+reply is lost, check the device before retrying: the reset may already have
+been applied. This resets the device counter and does not restore its previous
+value.
+
 ## OAuth account access
 
 pySwitchbot provides helpers for SwitchBot's authorization-code flow. The

{pyswitchbot-2.10.0 → pyswitchbot-3.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "PySwitchbot"
-version = "2.10.0"
+version = "3.1.0"
 description = "A library to communicate with Switchbot"
 authors = ["Daniel Hjelseth Hoyer"]
 license = "MIT"

pyswitchbot-3.1.0/switchbot/__version__.py

@@ -0,0 +1 @@
+__version__ = "3.1.0"

{pyswitchbot-2.10.0 → pyswitchbot-3.1.0}/switchbot/adv_parser.py

@@ -129,13 +129,13 @@ SUPPORTED_TYPES: dict[str | bytes, SwitchbotSupportedType] = {
         "manufacturer_id": 2409,
     },
     "{": {
-        "modelName": SwitchbotModel.CURTAIN,
+        "modelName": SwitchbotModel.CURTAIN_3,
         "modelFriendlyName": "Curtain 3",
         "func": process_wocurtain,
         "manufacturer_id": 2409,
     },
     "[": {
-        "modelName": SwitchbotModel.CURTAIN,
+        "modelName": SwitchbotModel.CURTAIN_3,
         "modelFriendlyName": "Curtain 3",
         "func": process_wocurtain,
         "manufacturer_id": 2409,
@@ -153,25 +153,25 @@ SUPPORTED_TYPES: dict[str | bytes, SwitchbotSupportedType] = {
         "manufacturer_id": 2409,
     },
     "w": {
-        "modelName": SwitchbotModel.IO_METER,
-        "modelFriendlyName": "Indoor/Outdoor Meter",
+        "modelName": SwitchbotModel.INDOOR_OUTDOOR_THERMO_HYGROMETER,
+        "modelFriendlyName": "Indoor/Outdoor Thermo-Hygrometer",
         "func": process_wosensorth,
         "manufacturer_id": 2409,
     },
     "W": {
-        "modelName": SwitchbotModel.IO_METER,
-        "modelFriendlyName": "Indoor/Outdoor Meter",
+        "modelName": SwitchbotModel.INDOOR_OUTDOOR_THERMO_HYGROMETER,
+        "modelFriendlyName": "Indoor/Outdoor Thermo-Hygrometer",
         "func": process_wosensorth,
         "manufacturer_id": 2409,
     },
     "i": {
-        "modelName": SwitchbotModel.METER,
+        "modelName": SwitchbotModel.METER_PLUS,
         "modelFriendlyName": "Meter Plus",
         "func": process_wosensorth,
         "manufacturer_id": 2409,
     },
     "I": {
-        "modelName": SwitchbotModel.METER,
+        "modelName": SwitchbotModel.METER_PLUS,
         "modelFriendlyName": "Meter Plus",
         "func": process_wosensorth,
         "manufacturer_id": 2409,
@@ -201,13 +201,13 @@ SUPPORTED_TYPES: dict[str | bytes, SwitchbotSupportedType] = {
         "manufacturer_id": 2409,
     },
     "5": {
-        "modelName": SwitchbotModel.METER_PRO_C,
+        "modelName": SwitchbotModel.METER_PRO_CO2,
         "modelFriendlyName": "Meter Pro CO2",
         "func": process_wosensorth_c,
         "manufacturer_id": 2409,
     },
     b"\x15": {
-        "modelName": SwitchbotModel.METER_PRO_C,
+        "modelName": SwitchbotModel.METER_PRO_CO2,
         "modelFriendlyName": "Meter Pro CO2",
         "func": process_wosensorth_c,
         "manufacturer_id": 2409,
@@ -225,25 +225,25 @@ SUPPORTED_TYPES: dict[str | bytes, SwitchbotSupportedType] = {
         "manufacturer_id": 2409,
     },
     "g": {
-        "modelName": SwitchbotModel.PLUG_MINI,
-        "modelFriendlyName": "Plug Mini",
+        "modelName": SwitchbotModel.PLUG_MINI_US,
+        "modelFriendlyName": "Plug Mini (US)",
         "func": process_woplugmini,
         "manufacturer_id": 2409,
     },
     "G": {
-        "modelName": SwitchbotModel.PLUG_MINI,
-        "modelFriendlyName": "Plug Mini",
+        "modelName": SwitchbotModel.PLUG_MINI_US,
+        "modelFriendlyName": "Plug Mini (US)",
         "func": process_woplugmini,
         "manufacturer_id": 2409,
     },
     "j": {
-        "modelName": SwitchbotModel.PLUG_MINI,
+        "modelName": SwitchbotModel.PLUG_MINI_JP,
         "modelFriendlyName": "Plug Mini (JP)",
         "func": process_woplugmini,
         "manufacturer_id": 2409,
     },
     "J": {
-        "modelName": SwitchbotModel.PLUG_MINI,
+        "modelName": SwitchbotModel.PLUG_MINI_JP,
         "modelFriendlyName": "Plug Mini (JP)",
         "func": process_woplugmini,
         "manufacturer_id": 2409,
@@ -273,13 +273,13 @@ SUPPORTED_TYPES: dict[str | bytes, SwitchbotSupportedType] = {
         "manufacturer_id": 2409,
     },
     "n": {
-        "modelName": SwitchbotModel.CEILING_LIGHT,
+        "modelName": SwitchbotModel.CEILING_LIGHT_PRO,
         "modelFriendlyName": "Ceiling Light Pro",
         "func": process_woceiling,
         "manufacturer_id": 2409,
     },
     "N": {
-        "modelName": SwitchbotModel.CEILING_LIGHT,
+        "modelName": SwitchbotModel.CEILING_LIGHT_PRO,
         "modelFriendlyName": "Ceiling Light Pro",
         "func": process_woceiling,
         "manufacturer_id": 2409,

{pyswitchbot-2.10.0 → pyswitchbot-3.1.0}/switchbot/const/__init__.py

@@ -63,17 +63,27 @@ class SwitchbotAccountConnectionError(RuntimeError):
 class SwitchbotModel(StrEnum):
     BOT = "WoHand"
     CURTAIN = "WoCurtain"
+    CURTAIN_3 = "WoCurtain3"
     HUMIDIFIER = "WoHumi"
+    # Deprecated import-only symbol; use PLUG_MINI_US or PLUG_MINI_JP to parse.
     PLUG_MINI = "WoPlug"
+    PLUG_MINI_US = "WoPlugUS"
+    PLUG_MINI_JP = "WoPlugJP"
     CONTACT_SENSOR = "WoContact"
     LIGHT_STRIP = "WoStrip"
     METER = "WoSensorTH"
+    METER_PLUS = "WoMeterPlus"
     METER_PRO = "WoTHP"
+    METER_PRO_CO2 = "WoTHPc"
+    # Deprecated alias; use METER_PRO_CO2.
     METER_PRO_C = "WoTHPc"
+    INDOOR_OUTDOOR_THERMO_HYGROMETER = "WoIOSensorTH"
+    # Deprecated alias; use INDOOR_OUTDOOR_THERMO_HYGROMETER.
     IO_METER = "WoIOSensorTH"
     MOTION_SENSOR = "WoPresence"
     COLOR_BULB = "WoBulb"
     CEILING_LIGHT = "WoCeiling"
+    CEILING_LIGHT_PRO = "WoCeilingPro"
     LOCK = "WoLock"
     LOCK_PRO = "WoLockPro"
     BLIND_TILT = "WoBlindTilt"
@@ -86,6 +96,7 @@ class SwitchbotModel(StrEnum):
     UNIVERSAL_REMOTE = "WoUniversalRemote"
     EVAPORATIVE_HUMIDIFIER = "Evaporative Humidifier"
     ROLLER_SHADE = "Roller Shade"
+    HUB_MINI = "WoLinkMini"
     HUBMINI_MATTER = "HubMini Matter"
     CIRCULATOR_FAN = "Circulator Fan"
     CIRCULATOR_FAN_PRO = "Circulator Fan Pro"

{pyswitchbot-2.10.0 → pyswitchbot-3.1.0}/switchbot/devices/air_purifier.py

@@ -33,6 +33,8 @@ DEVICE_GET_BASIC_SETTINGS_KEY = "570f4d81"
 COMMAND_SET_PERCENTAGE = f"{COMMAND_HEAD}02{{percentage:02x}}"
 READ_LED_SETTINGS_COMMAND = "570f4d05"
 READ_LED_STATUS_COMMAND = "570f4d07"
+RESET_FILTER_USAGE_COMMAND = f"{COMMAND_HEAD}09"
+READ_FILTER_USAGE_COMMAND = "570f4d09"
 
 
 class SwitchbotAirPurifier(SwitchbotSequenceBaseLight, SwitchbotEncryptedDevice):
@@ -147,6 +149,31 @@ class SwitchbotAirPurifier(SwitchbotSequenceBaseLight, SwitchbotEncryptedDevice)
             return data | {"pm25": pm25}
         return data
 
+    async def reset_filter_usage(self) -> bool:
+        """Reset filter usage, returning True only after a verified zero readback."""
+        result = await self._send_command(RESET_FILTER_USAGE_COMMAND, retry=0)
+        if not self._check_command_result(result, 0, {1}):
+            raise SwitchbotOperationError("Filter usage reset was rejected")
+
+        result = await self._send_command(READ_FILTER_USAGE_COMMAND)
+        if not result or len(result) < 3:
+            raise SwitchbotOperationError(
+                "Reset was sent, but filter usage could not be verified. "
+                "Check the device before retrying"
+            )
+        if not self._check_command_result(result, 0, {1}):
+            raise SwitchbotOperationError("Filter usage read was rejected")
+        used_hours = _UNPACK_UINT16_BE(result, 1)[0]
+        if used_hours != 0:
+            raise SwitchbotOperationError(
+                f"Reset was sent, but the device still reports {used_hours} used hours. "
+                "Check the device before retrying"
+            )
+
+        self._update_parsed_data({"filter element working time": used_hours})
+        self._fire_callbacks()
+        return True
+
     @update_after_operation
     async def set_preset_mode(self, preset_mode: str) -> bool:
         """Send command to set air purifier preset_mode."""

{pyswitchbot-2.10.0 → pyswitchbot-3.1.0}/switchbot/devices/device.py

@@ -65,27 +65,28 @@ def _extract_region(userinfo: dict[str, Any]) -> str:
 API_MODEL_TO_ENUM: dict[str, SwitchbotModel] = {
     "WoHand": SwitchbotModel.BOT,
     "WoCurtain": SwitchbotModel.CURTAIN,
-    "WoCurtain3": SwitchbotModel.CURTAIN,  # Curtain3
+    "WoCurtain3": SwitchbotModel.CURTAIN_3,
     "WoHumi": SwitchbotModel.HUMIDIFIER,
     "WoHumi2": SwitchbotModel.EVAPORATIVE_HUMIDIFIER,
-    "WoPlug": SwitchbotModel.PLUG_MINI,
-    "WoPlugUS": SwitchbotModel.PLUG_MINI,
+    "WoPlugUS": SwitchbotModel.PLUG_MINI_US,
+    "WoPlugJP": SwitchbotModel.PLUG_MINI_JP,
     "WoContact": SwitchbotModel.CONTACT_SENSOR,
     "WoStrip": SwitchbotModel.LIGHT_STRIP,
     "WoMeter": SwitchbotModel.METER,
-    "WoMeterPlus": SwitchbotModel.METER,  # Meter Plus
+    "WoMeterPlus": SwitchbotModel.METER_PLUS,
     "WoPresence": SwitchbotModel.MOTION_SENSOR,
     "WoBulb": SwitchbotModel.COLOR_BULB,
     "WoCeiling": SwitchbotModel.CEILING_LIGHT,
-    "WoCeilingPro": SwitchbotModel.CEILING_LIGHT,  # Ceiling Light Pro
+    "WoCeilingPro": SwitchbotModel.CEILING_LIGHT_PRO,
     "WoLock": SwitchbotModel.LOCK,
     "WoLockPro": SwitchbotModel.LOCK_PRO,
     "WoLockLite": SwitchbotModel.LOCK_LITE,
     "WoBlindTilt": SwitchbotModel.BLIND_TILT,
-    "WoIOSensor": SwitchbotModel.IO_METER,  # Outdoor Meter
+    "WoIOSensor": SwitchbotModel.INDOOR_OUTDOOR_THERMO_HYGROMETER,
     "WoButton": SwitchbotModel.REMOTE,  # Remote button
     "WoUniversalRemote": SwitchbotModel.UNIVERSAL_REMOTE,  # Universal Remote
-    "WoLinkMini": SwitchbotModel.HUBMINI_MATTER,  # Hub Mini
+    "WoLinkMini": SwitchbotModel.HUB_MINI,
+    "WoLinkMatter": SwitchbotModel.HUBMINI_MATTER,
     "WoFan2": SwitchbotModel.CIRCULATOR_FAN,
     "WoHub2": SwitchbotModel.HUB2,
     "WoRollerShade": SwitchbotModel.ROLLER_SHADE,
@@ -104,7 +105,7 @@ API_MODEL_TO_ENUM: dict[str, SwitchbotModel] = {
     "W1083001": SwitchbotModel.RELAY_SWITCH_2PM,
     "W1083002": SwitchbotModel.RELAY_SWITCH_1,  # Relay Switch 1
     "W1079000": SwitchbotModel.METER_PRO,  # Meter Pro (another variant)
-    "W1079001": SwitchbotModel.METER_PRO_C,
+    "W1079001": SwitchbotModel.METER_PRO_CO2,
     "W1101000": SwitchbotModel.PRESENCE_SENSOR,
     "W1091000": SwitchbotModel.LOCK_ULTRA,
     "W1096000": SwitchbotModel.HUB3,

pyswitchbot-2.10.0/switchbot/__version__.py

@@ -1 +0,0 @@
-__version__ = "2.10.0"