PySwitchbot 0.60.0__tar.gz → 0.61.0__tar.gz

{pyswitchbot-0.60.0 → pyswitchbot-0.61.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PySwitchbot
-Version: 0.60.0
+Version: 0.61.0
 Summary: A library to communicate with Switchbot
 Home-page: https://github.com/sblibs/pySwitchbot/
 Author: Daniel Hjelseth Hoyer

{pyswitchbot-0.60.0 → pyswitchbot-0.61.0}/PySwitchbot.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PySwitchbot
-Version: 0.60.0
+Version: 0.61.0
 Summary: A library to communicate with Switchbot
 Home-page: https://github.com/sblibs/pySwitchbot/
 Author: Daniel Hjelseth Hoyer

{pyswitchbot-0.60.0 → pyswitchbot-0.61.0}/PySwitchbot.egg-info/SOURCES.txt

@@ -36,6 +36,7 @@ switchbot/adv_parsers/plug.py
 switchbot/adv_parsers/relay_switch.py
 switchbot/adv_parsers/remote.py
 switchbot/adv_parsers/roller_shade.py
+switchbot/adv_parsers/vacuum.py
 switchbot/const/__init__.py
 switchbot/const/evaporative_humidifier.py
 switchbot/const/fan.py
@@ -62,6 +63,7 @@ switchbot/devices/motion.py
 switchbot/devices/plug.py
 switchbot/devices/relay_switch.py
 switchbot/devices/roller_shade.py
+switchbot/devices/vacuum.py
 tests/test_adv_parser.py
 tests/test_base_cover.py
 tests/test_blind_tilt.py
@@ -70,4 +72,5 @@ tests/test_evaporative_humidifier.py
 tests/test_fan.py
 tests/test_hub2.py
 tests/test_relay_switch.py
-tests/test_roller_shade.py
+tests/test_roller_shade.py
+tests/test_vacuum.py

{pyswitchbot-0.60.0 → pyswitchbot-0.61.0}/pyproject.toml

@@ -28,8 +28,13 @@ ignore = [
     "UP038", # Use `X | Y` in `isinstance` is slower
     "S603", #  check for execution of untrusted input
     "S105", # possible hard coded creds
+    "TID252", # not for this lib
+    "TRY003", # nice but too many to fix,
+    "G201", # too noisy
+    "PLR2004", # too many to fix
 ]
 select = [
+    "ASYNC", # async rules
     "B",   # flake8-bugbear
     "D",   # flake8-docstrings
     "C4",  # flake8-comprehensions
@@ -40,6 +45,24 @@ select = [
     "UP",  # pyupgrade
     "I",   # isort
     "RUF", # ruff specific
+    "FLY", # flynt
+    "G", # flake8-logging-format   ,
+    "PERF", # Perflint
+    "PGH", # pygrep-hooks
+    "PIE", # flake8-pie
+    "PL", # pylint
+    "PT", # flake8-pytest-style
+    "PTH", # flake8-pathlib
+    "PYI", # flake8-pyi
+    "RET", # flake8-return
+    "RSE", # flake8-raise    ,
+    "SIM", # flake8-simplify
+    "SLF", # flake8-self
+    "SLOT", # flake8-slots
+    "T100", # Trace found: {name} used
+    "T20", # flake8-print
+    "TID", # Tidy imports
+    "TRY", # tryceratops
 ]
 
 [tool.ruff.lint.per-file-ignores]
@@ -50,10 +73,15 @@ select = [
     "D103",
     "D104",
     "S101",
+    "SLF001",
+    "PLR2004",
 ]
 "setup.py" = ["D100"]
 "conftest.py" = ["D100"]
 "docs/conf.py" = ["D100"]
+"scripts/**/*" = [
+    "T201"
+]
 
 [tool.ruff.lint.isort]
 known-first-party = ["pySwitchbot", "tests"]

{pyswitchbot-0.60.0 → pyswitchbot-0.61.0}/setup.py

@@ -20,7 +20,7 @@ setup(
         "cryptography>=39.0.0",
         "pyOpenSSL>=23.0.0",
     ],
-    version="0.60.0",
+    version="0.61.0",
     description="A library to communicate with Switchbot",
     long_description=long_description,
     long_description_content_type="text/markdown",

{pyswitchbot-0.60.0 → pyswitchbot-0.61.0}/switchbot/__init__.py

@@ -32,6 +32,7 @@ from .devices.lock import SwitchbotLock
 from .devices.plug import SwitchbotPlugMini
 from .devices.relay_switch import SwitchbotRelaySwitch
 from .devices.roller_shade import SwitchbotRollerShade
+from .devices.vacuum import SwitchbotVacuum
 from .discovery import GetSwitchbotDevices
 from .models import SwitchBotAdvertisement
 
@@ -66,6 +67,7 @@ __all__ = [
     "SwitchbotRollerShade",
     "SwitchbotSupportedType",
     "SwitchbotSupportedType",
+    "SwitchbotVacuum",
     "close_stale_connections",
     "close_stale_connections_by_address",
     "get_device",

{pyswitchbot-0.60.0 → pyswitchbot-0.61.0}/switchbot/adv_parser.py

@@ -33,6 +33,7 @@ from .adv_parsers.relay_switch import (
 )
 from .adv_parsers.remote import process_woremote
 from .adv_parsers.roller_shade import process_worollershade
+from .adv_parsers.vacuum import process_vacuum, process_vacuum_k
 from .const import SwitchbotModel
 from .models import SwitchBotAdvertisement
 
@@ -237,6 +238,36 @@ SUPPORTED_TYPES: dict[str, SwitchbotSupportedType] = {
         "func": process_fan,
         "manufacturer_id": 2409,
     },
+    ".": {
+        "modelName": SwitchbotModel.K20_VACUUM,
+        "modelFriendlyName": "K20 Vacuum",
+        "func": process_vacuum,
+        "manufacturer_id": 2409,
+    },
+    "z": {
+        "modelName": SwitchbotModel.S10_VACUUM,
+        "modelFriendlyName": "S10 Vacuum",
+        "func": process_vacuum,
+        "manufacturer_id": 2409,
+    },
+    "3": {
+        "modelName": SwitchbotModel.K10_PRO_COMBO_VACUUM,
+        "modelFriendlyName": "K10+ Pro Combo Vacuum",
+        "func": process_vacuum,
+        "manufacturer_id": 2409,
+    },
+    "}": {
+        "modelName": SwitchbotModel.K10_VACUUM,
+        "modelFriendlyName": "K10+ Vacuum",
+        "func": process_vacuum_k,
+        "manufacturer_id": 2409,
+    },
+    "(": {
+        "modelName": SwitchbotModel.K10_PRO_VACUUM,
+        "modelFriendlyName": "K10+ Pro Vacuum",
+        "func": process_vacuum_k,
+        "manufacturer_id": 2409,
+    },
 }
 
 _SWITCHBOT_MODEL_TO_CHAR = {
@@ -285,10 +316,8 @@ def parse_advertisement_data(
             _mfr_id,
             model,
         )
-    except Exception as err:  # pylint: disable=broad-except
-        _LOGGER.exception(
-            "Failed to parse advertisement data: %s: %s", advertisement_data, err
-        )
+    except Exception:  # pylint: disable=broad-except
+        _LOGGER.exception("Failed to parse advertisement data: %s", advertisement_data)
         return None
 
     if not data:

{pyswitchbot-0.60.0 → pyswitchbot-0.61.0}/switchbot/adv_parsers/fan.py

@@ -15,7 +15,7 @@ def process_fan(data: bytes | None, mfr_data: bytes | None) -> dict[str, bool |
     _seq_num = device_data[0]
     _isOn = bool(device_data[1] & 0b10000000)
     _mode = (device_data[1] & 0b01110000) >> 4
-    _mode = FanMode(_mode).name if 1 <= _mode <= 4 else None
+    _mode = FanMode(_mode).name.lower() if 1 <= _mode <= 4 else None
     _nightLight = (device_data[1] & 0b00001100) >> 2
     _oscillate_left_and_right = bool(device_data[1] & 0b00000010)
     _oscillate_up_and_down = bool(device_data[1] & 0b00000001)

{pyswitchbot-0.60.0 → pyswitchbot-0.61.0}/switchbot/adv_parsers/hub2.py

@@ -30,7 +30,7 @@ def process_wohub2(data: bytes | None, mfr_data: bytes | None) -> dict[str, Any]
     if _temp_c == 0 and humidity == 0:
         return {}
 
-    _wohub2_data = {
+    return {
         # Data should be flat, but we keep the original structure for now
         "temp": {"c": _temp_c, "f": _temp_f},
         "temperature": _temp_c,
@@ -40,8 +40,6 @@ def process_wohub2(data: bytes | None, mfr_data: bytes | None) -> dict[str, Any]
         "illuminance": calculate_light_intensity(light_level),
     }
 
-    return _wohub2_data
-
 
 def calculate_light_intensity(light_level: int) -> int:
     """

{pyswitchbot-0.60.0 → pyswitchbot-0.61.0}/switchbot/adv_parsers/hubmini_matter.py

@@ -28,10 +28,9 @@ def process_hubmini_matter(
     if _temp_c == 0 and humidity == 0:
         return {}
 
-    paraser_data = {
+    return {
         "temp": {"c": _temp_c, "f": _temp_f},
         "temperature": _temp_c,
         "fahrenheit": bool(temp_data[2] & 0b10000000),
         "humidity": humidity,
     }
-    return paraser_data

{pyswitchbot-0.60.0 → pyswitchbot-0.61.0}/switchbot/adv_parsers/meter.py

@@ -35,7 +35,7 @@ def process_wosensorth(data: bytes | None, mfr_data: bytes | None) -> dict[str,
     if _temp_c == 0 and humidity == 0 and battery == 0:
         return {}
 
-    _wosensorth_data = {
+    return {
         # Data should be flat, but we keep the original structure for now
         "temp": {"c": _temp_c, "f": _temp_f},
         "temperature": _temp_c,
@@ -44,8 +44,6 @@ def process_wosensorth(data: bytes | None, mfr_data: bytes | None) -> dict[str,
         "battery": battery,
     }
 
-    return _wosensorth_data
-
 
 def process_wosensorth_c(data: bytes | None, mfr_data: bytes | None) -> dict[str, Any]:
     """Process woSensorTH/Temp sensor services data with CO2."""

pyswitchbot-0.61.0/switchbot/adv_parsers/vacuum.py

@@ -0,0 +1,61 @@
+"""Vacuum parser."""
+
+from __future__ import annotations
+
+import struct
+
+
+def process_vacuum(
+    data: bytes | None, mfr_data: bytes | None
+) -> dict[str, bool | int | str]:
+    """Support for s10, k10+ pro combo, k20 process service data."""
+    if mfr_data is None:
+        return {}
+
+    _seq_num = mfr_data[6]
+    _soc_version = get_device_fw_version(mfr_data[8:11])
+    # Steps at the end of the last network configuration
+    _step = mfr_data[11] & 0b00001111
+    _mqtt_connected = bool(mfr_data[11] & 0b00010000)
+    _battery = mfr_data[12]
+    _work_status = mfr_data[13] & 0b00111111
+
+    return {
+        "sequence_number": _seq_num,
+        "soc_version": _soc_version,
+        "step": _step,
+        "mqtt_connected": _mqtt_connected,
+        "battery": _battery,
+        "work_status": _work_status,
+    }
+
+
+def get_device_fw_version(version_bytes: bytes) -> str | None:
+    version1 = version_bytes[0] & 0x0F
+    version2 = version_bytes[0] >> 4
+    version3 = struct.unpack("<H", version_bytes[1:])[0]
+    return f"{version1}.{version2}.{version3:>03d}"
+
+
+def process_vacuum_k(
+    data: bytes | None, mfr_data: bytes | None
+) -> dict[str, bool | int | str]:
+    """Support for k10+, k10+ pro process service data."""
+    if mfr_data is None:
+        return {}
+
+    _seq_num = mfr_data[6]
+    _dustbin_bound = bool(mfr_data[7] & 0b10000000)
+    _dusbin_connected = bool(mfr_data[7] & 0b01000000)
+    _network_connected = bool(mfr_data[7] & 0b00100000)
+    _work_status = (mfr_data[7] & 0b00010000) >> 4
+    _battery = mfr_data[8] & 0b01111111
+
+    return {
+        "sequence_number": _seq_num,
+        "dustbin_bound": _dustbin_bound,
+        "dusbin_connected": _dusbin_connected,
+        "network_connected": _network_connected,
+        "work_status": _work_status,
+        "battery": _battery,
+    }

{pyswitchbot-0.60.0 → pyswitchbot-0.61.0}/switchbot/const/__init__.py

@@ -3,10 +3,10 @@
 from __future__ import annotations
 
 from ..enum import StrEnum
-from .fan import FanMode as FanMode
+from .fan import FanMode
 
 # Preserve old LockStatus export for backwards compatibility
-from .lock import LockStatus as LockStatus
+from .lock import LockStatus
 
 DEFAULT_RETRY_COUNT = 3
 DEFAULT_RETRY_TIMEOUT = 1
@@ -67,3 +67,21 @@ class SwitchbotModel(StrEnum):
     ROLLER_SHADE = "Roller Shade"
     HUBMINI_MATTER = "HubMini Matter"
     CIRCULATOR_FAN = "Circulator Fan"
+    K20_VACUUM = "K20 Vacuum"
+    S10_VACUUM = "S10 Vacuum"
+    K10_VACUUM = "K10+ Vacuum"
+    K10_PRO_VACUUM = "K10+ Pro Vacuum"
+    K10_PRO_COMBO_VACUUM = "K10+ Pro Combo Vacuum"
+
+
+__all__ = [
+    "DEFAULT_RETRY_COUNT",
+    "DEFAULT_RETRY_TIMEOUT",
+    "DEFAULT_SCAN_TIMEOUT",
+    "FanMode",
+    "LockStatus",
+    "SwitchbotAccountConnectionError",
+    "SwitchbotApiError",
+    "SwitchbotAuthenticationError",
+    "SwitchbotModel",
+]

{pyswitchbot-0.60.0 → pyswitchbot-0.61.0}/switchbot/const/fan.py

@@ -11,4 +11,4 @@ class FanMode(Enum):
 
     @classmethod
     def get_modes(cls) -> list[str]:
-        return [mode.name for mode in cls]
+        return [mode.name.lower() for mode in cls]

{pyswitchbot-0.60.0 → pyswitchbot-0.61.0}/switchbot/devices/blind_tilt.py

@@ -100,8 +100,7 @@ class SwitchbotBlindTilt(SwitchbotBaseCover, SwitchbotSequenceDevice):
         """Send close command."""
         if self.get_position() > 50:
             return await self.close_up()
-        else:
-            return await self.close_down()
+        return await self.close_down()
 
     def get_position(self) -> Any:
         """Return cached tilt (0-100) of Blind Tilt."""

{pyswitchbot-0.60.0 → pyswitchbot-0.61.0}/switchbot/devices/device.py

@@ -646,7 +646,7 @@ class SwitchbotBaseDevice:
         """
         if not self._sb_adv_data:
             _LOGGER.exception("No advertisement data to update")
-            return
+            return None
         old_data = self._sb_adv_data.data.get("data") or {}
         merged_data = _merge_data(old_data, new_data)
         if merged_data == old_data:
@@ -688,9 +688,7 @@ class SwitchbotBaseDevice:
         ):
             return False
         time_since_last_full_update = time.monotonic() - self._last_full_update
-        if time_since_last_full_update < PASSIVE_POLL_INTERVAL:
-            return False
-        return True
+        return not time_since_last_full_update < PASSIVE_POLL_INTERVAL
 
 
 class SwitchbotDevice(SwitchbotBaseDevice):
@@ -723,11 +721,11 @@ class SwitchbotEncryptedDevice(SwitchbotDevice):
         """Switchbot base class constructor for encrypted devices."""
         if len(key_id) == 0:
             raise ValueError("key_id is missing")
-        elif len(key_id) != 2:
+        if len(key_id) != 2:
             raise ValueError("key_id is invalid")
         if len(encryption_key) == 0:
             raise ValueError("encryption_key is missing")
-        elif len(encryption_key) != 32:
+        if len(encryption_key) != 32:
             raise ValueError("encryption_key is invalid")
         self._key_id = key_id
         self._encryption_key = bytearray.fromhex(encryption_key)

{pyswitchbot-0.60.0 → pyswitchbot-0.61.0}/switchbot/devices/evaporative_humidifier.py

@@ -117,7 +117,7 @@ class SwitchbotEvaporativeHumidifier(SwitchbotEncryptedDevice):
         """Set device mode."""
         if mode == HumidifierMode.DRYING_FILTER:
             return await self.start_drying_filter()
-        elif mode not in MODES_COMMANDS:
+        if mode not in MODES_COMMANDS:
             raise ValueError("Invalid mode")
 
         command = COMMAND_SET_MODE + MODES_COMMANDS[mode]

{pyswitchbot-0.60.0 → pyswitchbot-0.61.0}/switchbot/devices/fan.py

@@ -21,10 +21,10 @@ COMMAND_TURN_OFF = f"{COMMAND_HEAD}0102"
 COMMAND_START_OSCILLATION = f"{COMMAND_HEAD}020101ff"
 COMMAND_STOP_OSCILLATION = f"{COMMAND_HEAD}020102ff"
 COMMAND_SET_MODE = {
-    FanMode.NORMAL.name: f"{COMMAND_HEAD}030101ff",
-    FanMode.NATURAL.name: f"{COMMAND_HEAD}030102ff",
-    FanMode.SLEEP.name: f"{COMMAND_HEAD}030103",
-    FanMode.BABY.name: f"{COMMAND_HEAD}030104",
+    FanMode.NORMAL.name.lower(): f"{COMMAND_HEAD}030101ff",
+    FanMode.NATURAL.name.lower(): f"{COMMAND_HEAD}030102ff",
+    FanMode.SLEEP.name.lower(): f"{COMMAND_HEAD}030103",
+    FanMode.BABY.name.lower(): f"{COMMAND_HEAD}030104",
 }
 COMMAND_SET_PERCENTAGE = f"{COMMAND_HEAD}0302"  #  +speed
 COMMAND_GET_BASIC_INFO = "570f428102"
@@ -48,7 +48,7 @@ class SwitchbotFan(SwitchbotSequenceDevice):
         isOn = bool(_data[3] & 0b10000000)
         oscillating = bool(_data[3] & 0b01100000)
         _mode = _data[8] & 0b00000111
-        mode = FanMode(_mode).name if 1 <= _mode <= 4 else None
+        mode = FanMode(_mode).name.lower() if 1 <= _mode <= 4 else None
         speed = _data[9]
         firmware = _data1[2] / 10.0
 
@@ -86,8 +86,7 @@ class SwitchbotFan(SwitchbotSequenceDevice):
         """Send command to set fan oscillation"""
         if oscillating:
             return await self._send_command(COMMAND_START_OSCILLATION)
-        else:
-            return await self._send_command(COMMAND_STOP_OSCILLATION)
+        return await self._send_command(COMMAND_STOP_OSCILLATION)
 
     @update_after_operation
     async def turn_on(self) -> bool:

{pyswitchbot-0.60.0 → pyswitchbot-0.61.0}/switchbot/devices/relay_switch.py

@@ -106,9 +106,7 @@ class SwitchbotRelaySwitch(SwitchbotEncryptedDevice):
         ):
             return False
         time_since_last_full_update = time.monotonic() - self._last_full_update
-        if time_since_last_full_update < PASSIVE_POLL_INTERVAL:
-            return False
-        return True
+        return not time_since_last_full_update < PASSIVE_POLL_INTERVAL
 
     async def turn_on(self) -> bool:
         """Turn device on."""
@@ -131,8 +129,7 @@ class SwitchbotRelaySwitch(SwitchbotEncryptedDevice):
     async def async_toggle(self, **kwargs) -> bool:
         """Toggle device."""
         result = await self._send_command(COMMAND_TOGGLE)
-        status = self._check_command_result(result, 0, {1})
-        return status
+        return self._check_command_result(result, 0, {1})
 
     def is_on(self) -> bool | None:
         """Return switch state from cache."""

pyswitchbot-0.61.0/switchbot/devices/vacuum.py

@@ -0,0 +1,73 @@
+"""Library to handle connection with Switchbot."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from .device import SwitchbotSequenceDevice, update_after_operation
+
+COMMAND_CLEAN_UP = {
+    1: "570F5A00FFFF7001",
+    2: "5A400101010126",
+}
+COMMAND_RETURN_DOCK = {
+    1: "570F5A00FFFF7002",
+    2: "5A400101010225",
+}
+
+
+class SwitchbotVacuum(SwitchbotSequenceDevice):
+    """Representation of a Switchbot Vacuum."""
+
+    def __init__(self, device, password=None, interface=0, **kwargs):
+        super().__init__(device, password, interface, **kwargs)
+
+    @update_after_operation
+    async def clean_up(self, protocol_version: int) -> bool:
+        """Send command to perform a spot clean-up."""
+        return await self._send_command(COMMAND_CLEAN_UP[protocol_version])
+
+    @update_after_operation
+    async def return_to_dock(self, protocol_version: int) -> bool:
+        """Send command to return the dock."""
+        return await self._send_command(COMMAND_RETURN_DOCK[protocol_version])
+
+    async def get_basic_info(self) -> dict[str, Any] | None:
+        """Only support get the ble version through the command."""
+        if not (_data := await self._get_basic_info()):
+            return None
+        return {
+            "firmware": _data[2],
+        }
+
+    def get_soc_version(self) -> str:
+        """Return device soc version."""
+        return self._get_adv_value("soc_version")
+
+    def get_last_step(self) -> int:
+        """Return device last step after network configuration."""
+        return self._get_adv_value("step")
+
+    def get_mqtt_connnect_status(self) -> bool:
+        """Return device mqtt connect status."""
+        return self._get_adv_value("mqtt_connected")
+
+    def get_battery(self) -> int:
+        """Return device battery."""
+        return self._get_adv_value("battery")
+
+    def get_work_status(self) -> int:
+        """Return device work status."""
+        return self._get_adv_value("work_status")
+
+    def get_dustbin_bound_status(self) -> bool:
+        """Return the dustbin bound status"""
+        return self._get_adv_value("dustbin_bound")
+
+    def get_dustbin_connnected_status(self) -> bool:
+        """Return the dustbin connected status"""
+        return self._get_adv_value("dusbin_connected")
+
+    def get_network_connected_status(self) -> bool:
+        """Return the network connected status"""
+        return self._get_adv_value("network_connected")

{pyswitchbot-0.60.0 → pyswitchbot-0.61.0}/switchbot/enum.py

@@ -3,17 +3,13 @@
 from __future__ import annotations
 
 from enum import Enum
-from typing import Any, TypeVar
-
-_StrEnumT = TypeVar("_StrEnumT", bound="StrEnum")
+from typing import Any, Self
 
 
 class StrEnum(str, Enum):
     """Partial backport of Python 3.11's StrEnum for our basic use cases."""
 
-    def __new__(
-        cls: type[_StrEnumT], value: str, *args: Any, **kwargs: Any
-    ) -> _StrEnumT:
+    def __new__(cls, value: str, *args: Any, **kwargs: Any) -> Self:
         """Create a new StrEnum instance."""
         if not isinstance(value, str):
             raise TypeError(f"{value!r} is not a string")