PySwitchbot 3.0.0__py3-none-any.whl → 3.2.0__py3-none-any.whl

{pyswitchbot-3.0.0.dist-info → pyswitchbot-3.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PySwitchbot
-Version: 3.0.0
+Version: 3.2.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-3.0.0.dist-info → pyswitchbot-3.2.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 switchbot/__init__.py,sha256=pltMTceeYF7-Y9-3kGrnoTFXTIVHKoSWGgW-5JL3uwU,4673
-switchbot/__version__.py,sha256=EPmgXOdWKks5S__ZMH7Nu6xpAeVrZpfxaFy4pykuyeI,22
+switchbot/__version__.py,sha256=OUX37Yd6ZO82d0GJL2dmK0gZTtc_xvlTvGQIl2I-D8k,22
 switchbot/adv_parser.py,sha256=M0Wy6rAlv0gipNFuV6FKW4IwQ0ea_wcPPhDN3Py5s9M,35473
 switchbot/adv_parsers/__init__.py,sha256=d39GEAICA1RrQiLy1ks49x0d9a-A_yKn9Awkj5za8Uk,46
 switchbot/adv_parsers/_sensor_th.py,sha256=FjVvxtkH6nZ-3u2W4q6zvDE1H4849JZ5LXRNd_nedhU,1182
@@ -44,12 +44,12 @@ switchbot/const/light.py,sha256=DsCua_IYYvGy23GmviSB9GkwATPGVYIe6VNF7rZt97U,817
 switchbot/const/lock.py,sha256=wKvq5uctsKpcM6gSzxPrcvmezzRhPZPd5n948I8R4n0,342
 switchbot/const/presence_sensor.py,sha256=X2oCfl0rbdd1-dSrqQFn3NDtEBXbti-87DbWq7NyN3A,135
 switchbot/devices/__init__.py,sha256=_fyzMy8qWC_2Y1BJ4hggrCP1udNqSoU6wFmfOiYpEl0,32
-switchbot/devices/air_purifier.py,sha256=JwT5HHQLvkDdFrDEKFT8sA41bM2G_DGfuOpf-74Smyw,10620
+switchbot/devices/air_purifier.py,sha256=T-a61C2MNq4Cc4bOCy-JF60vuPf1P9qOxXO9BQl-AmI,11897
 switchbot/devices/art_frame.py,sha256=doMr_hGWWE9eqSXzxLGYJaBy_6AkBjGfhvB3vb5ZN30,5024
 switchbot/devices/base_cover.py,sha256=UWNA7eGbJdY80Mu-k41xO4tnyk7FhpYaWRWihGvDM2g,4385
 switchbot/devices/base_light.py,sha256=WWJJdRHfvoSYMRHDSv_RCmo5D6hYoZRxQVYfsOXZ7K0,6590
 switchbot/devices/blind_tilt.py,sha256=tY0JoZhyqU_6PlhjtnIaEeIG3Z-JdZKJ5Jwg_5b6xSQ,5761
-switchbot/devices/bot.py,sha256=Co2IiQa2si0WPs3HFize2CPpj5GVbMT570vMP5YWpaQ,4121
+switchbot/devices/bot.py,sha256=yM2woM_HVxI9_Cf8qFSYztGRIKdHKjJzs6QDBQ9KHFE,4828
 switchbot/devices/bulb.py,sha256=ISxXck8JsBlFojLB8M5Wfip_z4o6_-VvyFbBvqK6_Bg,2313
 switchbot/devices/ceiling_light.py,sha256=7gxgsZz5ku6Bx8jfHSBkPcydjgagwGEuPvl5N-cMO6M,4600
 switchbot/devices/contact.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
@@ -77,7 +77,7 @@ switchbot/helpers.py,sha256=DJLvYZ4Dq0dkiGMOzfR--nSTM_8jE9QtB7t570PuGSU,2091
 switchbot/models.py,sha256=xibQOVGHC60FWWc54N6BW46vxFuJUjj6tK1Qw0_eTbI,372
 switchbot/oauth.py,sha256=j8tsfcy4d5qPqsnqrzaQ_Nro3ltyO0rCRgVTFXMFTKc,6487
 switchbot/utils.py,sha256=x1Qm0uIA1Jvxg4uxcQDBgWnopoU04-swKtjjCJ1Khak,1224
-pyswitchbot-3.0.0.dist-info/METADATA,sha256=nMSCKvgmubcHokReNBviTXqWlNs-5VFcyoFVqBBDunE,7728
-pyswitchbot-3.0.0.dist-info/WHEEL,sha256=L-WvLdSBvJWHXv5zrQxDvNRnIgoBzLUpcbuiw19KCuQ,88
-pyswitchbot-3.0.0.dist-info/licenses/LICENSE,sha256=_hdUCmoRDzki4fYDJfn-5KpG7-7p6YJ6IsbMfrTXN6Y,1078
-pyswitchbot-3.0.0.dist-info/RECORD,,
+pyswitchbot-3.2.0.dist-info/METADATA,sha256=bBquIslC7-75BXR8OSEiYq9Yig8eg_H4eMK_nv8I-8M,8374
+pyswitchbot-3.2.0.dist-info/WHEEL,sha256=L-WvLdSBvJWHXv5zrQxDvNRnIgoBzLUpcbuiw19KCuQ,88
+pyswitchbot-3.2.0.dist-info/licenses/LICENSE,sha256=_hdUCmoRDzki4fYDJfn-5KpG7-7p6YJ6IsbMfrTXN6Y,1078
+pyswitchbot-3.2.0.dist-info/RECORD,,

switchbot/__version__.py

@@ -1 +1 @@
-__version__ = "3.0.0"
+__version__ = "3.2.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."""

switchbot/devices/bot.py

@@ -9,6 +9,7 @@ from .device import (
     DEVICE_SET_EXTENDED_KEY,
     DEVICE_SET_MODE_KEY,
     SwitchbotDeviceOverrideStateDuringConnection,
+    SwitchbotOperationError,
     update_after_operation,
 )
 
@@ -90,6 +91,18 @@ class Switchbot(SwitchbotDeviceOverrideStateDuringConnection):
         result = await self._send_command(DEVICE_SET_MODE_KEY + strength_key + mode_key)
         return self._check_command_result(result, 0, {1})
 
+    async def set_inverse_direction(self, inverse: bool) -> bool:
+        """Set the Bot's inverse direction while preserving its other mode settings."""
+        if not (settings := await self.get_basic_info()):
+            raise SwitchbotOperationError(
+                f"{self.name}: Unable to get current Bot mode settings"
+            )
+        return await self.set_switch_mode(
+            switch_mode=settings["switchMode"],
+            strength=settings["strength"],
+            inverse=inverse,
+        )
+
     @update_after_operation
     async def set_long_press(self, duration: int = 0) -> bool:
         """Set bot long press duration."""
@@ -121,3 +134,7 @@ class Switchbot(SwitchbotDeviceOverrideStateDuringConnection):
         if self._inverse:
             return not value
         return value
+
+    def inverse_direction(self) -> bool | None:
+        """Return the cached inverse direction setting."""
+        return self._get_adv_value("inverseDirection")