PySwitchbot 0.56.0__tar.gz → 0.57.0__tar.gz

{pyswitchbot-0.56.0 → pyswitchbot-0.57.0}/PKG-INFO

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

{pyswitchbot-0.56.0 → pyswitchbot-0.57.0}/PySwitchbot.egg-info/PKG-INFO

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

{pyswitchbot-0.56.0 → pyswitchbot-0.57.0}/PySwitchbot.egg-info/SOURCES.txt

@@ -1,6 +1,7 @@
 LICENSE
 MANIFEST.in
 README.md
+pyproject.toml
 setup.py
 PySwitchbot.egg-info/PKG-INFO
 PySwitchbot.egg-info/SOURCES.txt
@@ -10,9 +11,9 @@ PySwitchbot.egg-info/top_level.txt
 switchbot/__init__.py
 switchbot/adv_parser.py
 switchbot/api_config.py
-switchbot/const.py
 switchbot/discovery.py
 switchbot/enum.py
+switchbot/helpers.py
 switchbot/models.py
 switchbot/adv_parsers/__init__.py
 switchbot/adv_parsers/blind_tilt.py
@@ -32,6 +33,9 @@ switchbot/adv_parsers/motion.py
 switchbot/adv_parsers/plug.py
 switchbot/adv_parsers/relay_switch.py
 switchbot/adv_parsers/remote.py
+switchbot/const/__init__.py
+switchbot/const/evaporative_humidifier.py
+switchbot/const/lock.py
 switchbot/devices/__init__.py
 switchbot/devices/base_cover.py
 switchbot/devices/base_light.py
@@ -42,6 +46,7 @@ switchbot/devices/ceiling_light.py
 switchbot/devices/contact.py
 switchbot/devices/curtain.py
 switchbot/devices/device.py
+switchbot/devices/evaporative_humidifier.py
 switchbot/devices/humidifier.py
 switchbot/devices/keypad.py
 switchbot/devices/light_strip.py
@@ -54,4 +59,5 @@ tests/test_adv_parser.py
 tests/test_base_cover.py
 tests/test_blind_tilt.py
 tests/test_curtain.py
+tests/test_evaporative_humidifier.py
 tests/test_relay_switch.py

pyswitchbot-0.57.0/pyproject.toml

@@ -0,0 +1,59 @@
+[tool.ruff]
+target-version = "py311"
+line-length = 88
+
+[tool.ruff.lint]
+ignore = [
+    "S101", # use of assert
+    "D203", # 1 blank line required before class docstring
+    "D212", # Multi-line docstring summary should start at the first line
+    "D100", # Missing docstring in public module
+    "D101", # Missing docstring in public module
+    "D102", # Missing docstring in public method
+    "D103", # Missing docstring in public module
+    "D104", # Missing docstring in public package
+    "D105", # Missing docstring in magic method
+    "D107", # Missing docstring in `__init__`
+    "D400", # First line should end with a period
+    "D401", # First line of docstring should be in imperative mood
+    "D205", # 1 blank line required between summary line and description
+    "D415", # First line should end with a period, question mark, or exclamation point
+    "D417", # Missing argument descriptions in the docstring
+    "E501", # Line too long
+    "RUF012", # Mutable class attributes should be annotated with `typing.ClassVar`
+    "B008", # Do not perform function call
+    "S110", # `try`-`except`-`pass` detected, consider logging the exception
+    "D106", # Missing docstring in public nested class
+    "UP007", # typer needs Optional syntax
+    "UP038", # Use `X | Y` in `isinstance` is slower
+    "S603", #  check for execution of untrusted input
+    "S105", # possible hard coded creds
+]
+select = [
+    "B",   # flake8-bugbear
+    "D",   # flake8-docstrings
+    "C4",  # flake8-comprehensions
+    "S",   # flake8-bandit
+    "F",   # pyflake
+    "E",   # pycodestyle
+    "W",   # pycodestyle
+    "UP",  # pyupgrade
+    "I",   # isort
+    "RUF", # ruff specific
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*" = [
+    "D100",
+    "D101",
+    "D102",
+    "D103",
+    "D104",
+    "S101",
+]
+"setup.py" = ["D100"]
+"conftest.py" = ["D100"]
+"docs/conf.py" = ["D100"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["pySwitchbot", "tests"]

{pyswitchbot-0.56.0 → pyswitchbot-0.57.0}/setup.py

@@ -7,7 +7,12 @@ long_description = (this_directory / "README.md").read_text()
 
 setup(
     name="PySwitchbot",
-    packages=["switchbot", "switchbot.devices", "switchbot.adv_parsers"],
+    packages=[
+        "switchbot",
+        "switchbot.devices",
+        "switchbot.const",
+        "switchbot.adv_parsers",
+    ],
     install_requires=[
         "aiohttp>=3.9.5",
         "bleak>=0.19.0",
@@ -15,7 +20,7 @@ setup(
         "cryptography>=39.0.0",
         "pyOpenSSL>=23.0.0",
     ],
-    version="0.56.0",
+    version="0.57.0",
     description="A library to communicate with Switchbot",
     long_description=long_description,
     long_description_content_type="text/markdown",

{pyswitchbot-0.56.0 → pyswitchbot-0.57.0}/switchbot/__init__.py

@@ -16,14 +16,14 @@ from .const import (
     SwitchbotAuthenticationError,
     SwitchbotModel,
 )
-from .devices.device import SwitchbotEncryptedDevice
 from .devices.base_light import SwitchbotBaseLight
 from .devices.blind_tilt import SwitchbotBlindTilt
 from .devices.bot import Switchbot
 from .devices.bulb import SwitchbotBulb
 from .devices.ceiling_light import SwitchbotCeilingLight
 from .devices.curtain import SwitchbotCurtain
-from .devices.device import ColorMode, SwitchbotDevice
+from .devices.device import ColorMode, SwitchbotDevice, SwitchbotEncryptedDevice
+from .devices.evaporative_humidifier import SwitchbotEvaporativeHumidifier
 from .devices.humidifier import SwitchbotHumidifier
 from .devices.light_strip import SwitchbotLightStrip
 from .devices.lock import SwitchbotLock
@@ -33,30 +33,35 @@ from .discovery import GetSwitchbotDevices
 from .models import SwitchBotAdvertisement
 
 __all__ = [
-    "get_device",
-    "close_stale_connections",
-    "close_stale_connections_by_address",
-    "parse_advertisement_data",
+    "ColorMode",
     "GetSwitchbotDevices",
+    "LockStatus",
     "SwitchBotAdvertisement",
+    "Switchbot",
+    "Switchbot",
     "SwitchbotAccountConnectionError",
     "SwitchbotApiError",
     "SwitchbotAuthenticationError",
-    "SwitchbotEncryptedDevice",
-    "ColorMode",
-    "LockStatus",
     "SwitchbotBaseLight",
+    "SwitchbotBlindTilt",
     "SwitchbotBulb",
     "SwitchbotCeilingLight",
-    "SwitchbotDevice",
     "SwitchbotCurtain",
-    "SwitchbotLightStrip",
+    "SwitchbotDevice",
+    "SwitchbotEncryptedDevice",
+    "SwitchbotEvaporativeHumidifier",
     "SwitchbotHumidifier",
-    "Switchbot",
-    "SwitchbotPlugMini",
-    "SwitchbotSupportedType",
-    "SwitchbotModel",
+    "SwitchbotLightStrip",
     "SwitchbotLock",
-    "SwitchbotBlindTilt",
+    "SwitchbotModel",
+    "SwitchbotModel",
+    "SwitchbotPlugMini",
+    "SwitchbotPlugMini",
     "SwitchbotRelaySwitch",
+    "SwitchbotSupportedType",
+    "SwitchbotSupportedType",
+    "close_stale_connections",
+    "close_stale_connections_by_address",
+    "get_device",
+    "parse_advertisement_data",
 ]

{pyswitchbot-0.56.0 → pyswitchbot-0.57.0}/switchbot/adv_parser.py

@@ -17,7 +17,7 @@ from .adv_parsers.ceiling_light import process_woceiling
 from .adv_parsers.contact import process_wocontact
 from .adv_parsers.curtain import process_wocurtain
 from .adv_parsers.hub2 import process_wohub2
-from .adv_parsers.humidifier import process_wohumidifier
+from .adv_parsers.humidifier import process_evaporative_humidifier, process_wohumidifier
 from .adv_parsers.keypad import process_wokeypad
 from .adv_parsers.leak import process_leak
 from .adv_parsers.light_strip import process_wostrip
@@ -41,6 +41,8 @@ SERVICE_DATA_ORDER = (
 )
 MFR_DATA_ORDER = (2409, 741, 89)
 
+APPLE_MANUFACTURER_ID = 76
+
 
 class SwitchbotSupportedType(TypedDict):
     """Supported type of Switchbot."""
@@ -162,6 +164,12 @@ SUPPORTED_TYPES: dict[str, SwitchbotSupportedType] = {
         "manufacturer_id": 741,
         "manufacturer_data_length": 6,
     },
+    "#": {
+        "modelName": SwitchbotModel.EVAPORATIVE_HUMIDIFIER,
+        "modelFriendlyName": "Evaporative Humidifier",
+        "func": process_evaporative_humidifier,
+        "manufacturer_id": 2409,
+    },
     "o": {
         "modelName": SwitchbotModel.LOCK,
         "modelFriendlyName": "Lock",
@@ -242,10 +250,14 @@ def parse_advertisement_data(
 
     _mfr_data = None
     _mfr_id = None
+    manufacturer_data = advertisement_data.manufacturer_data
+    if APPLE_MANUFACTURER_ID in manufacturer_data:
+        return None
+
     for mfr_id in MFR_DATA_ORDER:
-        if mfr_id in advertisement_data.manufacturer_data:
+        if mfr_id in manufacturer_data:
             _mfr_id = mfr_id
-            _mfr_data = advertisement_data.manufacturer_data[mfr_id]
+            _mfr_data = manufacturer_data[mfr_id]
             break
 
     if _mfr_data is None and _service_data is None:

{pyswitchbot-0.56.0 → pyswitchbot-0.57.0}/switchbot/adv_parsers/blind_tilt.py

@@ -7,7 +7,6 @@ def process_woblindtilt(
     data: bytes | None, mfr_data: bytes | None, reverse: bool = False
 ) -> dict[str, bool | int]:
     """Process woBlindTilt services data."""
-
     if mfr_data is None:
         return {}
 

pyswitchbot-0.57.0/switchbot/adv_parsers/humidifier.py

@@ -0,0 +1,93 @@
+"""Humidifier adv parser."""
+
+from __future__ import annotations
+
+import logging
+from datetime import timedelta
+
+from ..const.evaporative_humidifier import (
+    OVER_HUMIDIFY_PROTECTION_MODES,
+    TARGET_HUMIDITY_MODES,
+    HumidifierMode,
+    HumidifierWaterLevel,
+)
+
+_LOGGER = logging.getLogger(__name__)
+
+# mfr_data: 943cc68d3d2e
+# data: 650000cd802b6300
+# data: 650000cd802b6300
+# data: 658000c9802b6300
+
+
+# Low:  658000c5222b6300
+# Med:  658000c5432b6300
+# High: 658000c5642b6300
+def process_wohumidifier(
+    data: bytes | None, mfr_data: bytes | None
+) -> dict[str, bool | int]:
+    """Process WoHumi services data."""
+    if data is None:
+        return {
+            "isOn": None,
+            "level": None,
+            "switchMode": True,
+        }
+
+    return {
+        "isOn": bool(data[1]),
+        "level": data[4],
+        "switchMode": True,
+    }
+
+
+def process_evaporative_humidifier(
+    data: bytes | None, mfr_data: bytes | None
+) -> 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,
+        }
+
+    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)
+    return {
+        "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,
+        "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,
+    }

{pyswitchbot-0.56.0 → pyswitchbot-0.57.0}/switchbot/adv_parsers/lock.py

@@ -4,7 +4,7 @@ from __future__ import annotations
 
 import logging
 
-from ..const import LockStatus
+from ..const.lock import LockStatus
 
 _LOGGER = logging.getLogger(__name__)
 

{pyswitchbot-0.56.0 → pyswitchbot-0.57.0}/switchbot/adv_parsers/remote.py

@@ -11,7 +11,6 @@ def process_woremote(
     data: bytes | None, mfr_data: bytes | None
 ) -> dict[str, int | None]:
     """Process WoRemote adv data."""
-
     if data is None:
         return {
             "battery": None,

pyswitchbot-0.56.0/switchbot/const.py → pyswitchbot-0.57.0/switchbot/const/__init__.py

@@ -1,10 +1,11 @@
-"""Library to handle connection with Switchbot."""
+"""Switchbot Device Consts Library."""
 
 from __future__ import annotations
 
-from enum import Enum
+from ..enum import StrEnum
 
-from .enum import StrEnum
+# Preserve old LockStatus export for backwards compatibility
+from .lock import LockStatus as LockStatus
 
 DEFAULT_RETRY_COUNT = 3
 DEFAULT_RETRY_TIMEOUT = 1
@@ -12,7 +13,8 @@ DEFAULT_SCAN_TIMEOUT = 5
 
 
 class SwitchbotApiError(RuntimeError):
-    """Raised when API call fails.
+    """
+    Raised when API call fails.
 
     This exception inherits from RuntimeError to avoid breaking existing code
     but will be changed to Exception in a future release.
@@ -20,7 +22,8 @@ class SwitchbotApiError(RuntimeError):
 
 
 class SwitchbotAuthenticationError(RuntimeError):
-    """Raised when authentication fails.
+    """
+    Raised when authentication fails.
 
     This exception inherits from RuntimeError to avoid breaking existing code
     but will be changed to Exception in a future release.
@@ -28,7 +31,8 @@ class SwitchbotAuthenticationError(RuntimeError):
 
 
 class SwitchbotAccountConnectionError(RuntimeError):
-    """Raised when connection to Switchbot account fails.
+    """
+    Raised when connection to Switchbot account fails.
 
     This exception inherits from RuntimeError to avoid breaking existing code
     but will be changed to Exception in a future release.
@@ -58,13 +62,4 @@ class SwitchbotModel(StrEnum):
     RELAY_SWITCH_1PM = "Relay Switch 1PM"
     RELAY_SWITCH_1 = "Relay Switch 1"
     REMOTE = "WoRemote"
-
-
-class LockStatus(Enum):
-    LOCKED = 0
-    UNLOCKED = 1
-    LOCKING = 2
-    UNLOCKING = 3
-    LOCKING_STOP = 4  # LOCKING_BLOCKED
-    UNLOCKING_STOP = 5  # UNLOCKING_BLOCKED
-    NOT_FULLY_LOCKED = 6  # LATCH_LOCKED - Only EU lock type
+    EVAPORATIVE_HUMIDIFIER = "Evaporative Humidifier"

pyswitchbot-0.57.0/switchbot/const/evaporative_humidifier.py

@@ -0,0 +1,34 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class HumidifierMode(Enum):
+    HIGH = 1
+    MEDIUM = 2
+    LOW = 3
+    QUIET = 4
+    TARGET_HUMIDITY = 5
+    SLEEP = 6
+    AUTO = 7
+    DRYING_FILTER = 8
+
+
+class HumidifierWaterLevel(Enum):
+    EMPTY = 0
+    LOW = 1
+    MEDIUM = 2
+    HIGH = 3
+
+
+OVER_HUMIDIFY_PROTECTION_MODES = {
+    HumidifierMode.QUIET,
+    HumidifierMode.LOW,
+    HumidifierMode.MEDIUM,
+    HumidifierMode.HIGH,
+}
+
+TARGET_HUMIDITY_MODES = {
+    HumidifierMode.SLEEP,
+    HumidifierMode.TARGET_HUMIDITY,
+}

pyswitchbot-0.57.0/switchbot/const/lock.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class LockStatus(Enum):
+    LOCKED = 0
+    UNLOCKED = 1
+    LOCKING = 2
+    UNLOCKING = 3
+    LOCKING_STOP = 4  # LOCKING_BLOCKED
+    UNLOCKING_STOP = 5  # UNLOCKING_BLOCKED
+    NOT_FULLY_LOCKED = 6  # LATCH_LOCKED - Only EU lock type

{pyswitchbot-0.56.0 → pyswitchbot-0.57.0}/switchbot/devices/base_cover.py

@@ -33,7 +33,6 @@ class SwitchbotBaseCover(SwitchbotDevice):
 
     def __init__(self, reverse: bool, *args: Any, **kwargs: Any) -> None:
         """Switchbot Cover device constructor."""
-
         super().__init__(*args, **kwargs)
         self._reverse = reverse
         self._settings: dict[str, Any] = {}
@@ -43,7 +42,8 @@ class SwitchbotBaseCover(SwitchbotDevice):
         self._is_closing: bool = False
 
     async def _send_multiple_commands(self, keys: list[str]) -> bool:
-        """Send multiple commands to device.
+        """
+        Send multiple commands to device.
 
         Since we current have no way to tell which command the device
         needs we send both.
@@ -84,7 +84,6 @@ class SwitchbotBaseCover(SwitchbotDevice):
 
     async def get_extended_info_adv(self) -> dict[str, Any] | None:
         """Get advance page info for device chain."""
-
         _data = await self._send_command(key=COVER_EXT_ADV_KEY)
         if not _data:
             _LOGGER.error("%s: Unsuccessful, no result from device", self.name)

{pyswitchbot-0.56.0 → pyswitchbot-0.57.0}/switchbot/devices/base_light.py

@@ -1,11 +1,11 @@
 from __future__ import annotations
 
-import asyncio
 import logging
 import time
 from abc import abstractmethod
 from typing import Any
 
+from ..helpers import create_background_task
 from ..models import SwitchBotAdvertisement
 from .device import ColorMode, SwitchbotDevice
 
@@ -106,4 +106,4 @@ class SwitchbotSequenceBaseLight(SwitchbotBaseLight):
             new_state,
         )
         if current_state != new_state:
-            asyncio.ensure_future(self.update())
+            create_background_task(self.update())

{pyswitchbot-0.56.0 → pyswitchbot-0.57.0}/switchbot/devices/curtain.py

@@ -38,7 +38,6 @@ class SwitchbotCurtain(SwitchbotBaseCover):
 
     def __init__(self, *args: Any, **kwargs: Any) -> None:
         """Switchbot Curtain/WoCurtain constructor."""
-
         # The position of the curtain is saved returned with 0 = open and 100 = closed.
         # This is independent of the calibration of the curtain bot (Open left to right/
         # Open right to left/Open from the middle).