PySwitchbot 0.52.0__tar.gz → 0.53.2__tar.gz

pyswitchbot-0.53.2/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.1
+Name: PySwitchbot
+Version: 0.53.2
+Summary: A library to communicate with Switchbot
+Home-page: https://github.com/sblibs/pySwitchbot/
+Author: Daniel Hjelseth Hoyer
+License: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Other Environment
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Topic :: Home Automation
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.9.5
+Requires-Dist: bleak>=0.19.0
+Requires-Dist: bleak-retry-connector>=3.4.0
+Requires-Dist: cryptography>=39.0.0
+Requires-Dist: pyOpenSSL>=23.0.0
+
+# pySwitchbot [![Build Status](https://travis-ci.org/sblibs/pySwitchbot.svg?branch=master)](https://travis-ci.org/sblibs/pySwitchbot)
+
+Library to control Switchbot IoT devices https://www.switch-bot.com/bot
+
+## Obtaining locks encryption key
+
+Using the script `scripts/get_encryption_key.py` you can manually obtain locks encryption key.
+
+Usage:
+
+```shell
+$ python3 get_encryption_key.py MAC USERNAME
+Key ID: xx
+Encryption key: xxxxxxxxxxxxxxxx
+```
+
+Where `MAC` is MAC address of the lock and `USERNAME` is your SwitchBot account username, after that script will ask for your password.
+If authentication succeeds then script should output your key id and encryption key.
+
+Examples:
+
+- WoLock
+
+```python
+import asyncio
+from switchbot.discovery import GetSwitchbotDevices
+from switchbot.devices import lock
+
+
+async def main():
+    wolock = await GetSwitchbotDevices().get_locks()
+    await lock.SwitchbotLock(wolock['32C0F607-18B8-xxxx-xxxx-xxxxxxxxxx'].device, "key-id", "encryption-key").get_lock_status()
+
+
+asyncio.run(main())
+
+```

pyswitchbot-0.53.2/PySwitchbot.egg-info/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.1
+Name: PySwitchbot
+Version: 0.53.2
+Summary: A library to communicate with Switchbot
+Home-page: https://github.com/sblibs/pySwitchbot/
+Author: Daniel Hjelseth Hoyer
+License: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Other Environment
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Topic :: Home Automation
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.9.5
+Requires-Dist: bleak>=0.19.0
+Requires-Dist: bleak-retry-connector>=3.4.0
+Requires-Dist: cryptography>=39.0.0
+Requires-Dist: pyOpenSSL>=23.0.0
+
+# pySwitchbot [![Build Status](https://travis-ci.org/sblibs/pySwitchbot.svg?branch=master)](https://travis-ci.org/sblibs/pySwitchbot)
+
+Library to control Switchbot IoT devices https://www.switch-bot.com/bot
+
+## Obtaining locks encryption key
+
+Using the script `scripts/get_encryption_key.py` you can manually obtain locks encryption key.
+
+Usage:
+
+```shell
+$ python3 get_encryption_key.py MAC USERNAME
+Key ID: xx
+Encryption key: xxxxxxxxxxxxxxxx
+```
+
+Where `MAC` is MAC address of the lock and `USERNAME` is your SwitchBot account username, after that script will ask for your password.
+If authentication succeeds then script should output your key id and encryption key.
+
+Examples:
+
+- WoLock
+
+```python
+import asyncio
+from switchbot.discovery import GetSwitchbotDevices
+from switchbot.devices import lock
+
+
+async def main():
+    wolock = await GetSwitchbotDevices().get_locks()
+    await lock.SwitchbotLock(wolock['32C0F607-18B8-xxxx-xxxx-xxxxxxxxxx'].device, "key-id", "encryption-key").get_lock_status()
+
+
+asyncio.run(main())
+
+```

{pyswitchbot-0.52.0 → pyswitchbot-0.53.2}/PySwitchbot.egg-info/SOURCES.txt

@@ -23,6 +23,7 @@ switchbot/adv_parsers/contact.py
 switchbot/adv_parsers/curtain.py
 switchbot/adv_parsers/hub2.py
 switchbot/adv_parsers/humidifier.py
+switchbot/adv_parsers/keypad.py
 switchbot/adv_parsers/light_strip.py
 switchbot/adv_parsers/lock.py
 switchbot/adv_parsers/meter.py
@@ -40,6 +41,7 @@ switchbot/devices/contact.py
 switchbot/devices/curtain.py
 switchbot/devices/device.py
 switchbot/devices/humidifier.py
+switchbot/devices/keypad.py
 switchbot/devices/light_strip.py
 switchbot/devices/lock.py
 switchbot/devices/meter.py

{pyswitchbot-0.52.0 → pyswitchbot-0.53.2}/README.md

@@ -1,4 +1,4 @@
-# pySwitchbot [![Build Status](https://travis-ci.org/Danielhiversen/pySwitchbot.svg?branch=master)](https://travis-ci.org/Danielhiversen/pySwitchbot)
+# pySwitchbot [![Build Status](https://travis-ci.org/sblibs/pySwitchbot.svg?branch=master)](https://travis-ci.org/sblibs/pySwitchbot)
 
 Library to control Switchbot IoT devices https://www.switch-bot.com/bot
 

{pyswitchbot-0.52.0 → pyswitchbot-0.53.2}/setup.py

@@ -1,5 +1,10 @@
+from pathlib import Path
+
 from setuptools import setup
 
+this_directory = Path(__file__).parent
+long_description = (this_directory / "README.md").read_text()
+
 setup(
     name="PySwitchbot",
     packages=["switchbot", "switchbot.devices", "switchbot.adv_parsers"],
@@ -10,10 +15,12 @@ setup(
         "cryptography>=39.0.0",
         "pyOpenSSL>=23.0.0",
     ],
-    version="0.52.0",
+    version="0.53.2",
     description="A library to communicate with Switchbot",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
     author="Daniel Hjelseth Hoyer",
-    url="https://github.com/Danielhiversen/pySwitchbot/",
+    url="https://github.com/sblibs/pySwitchbot/",
     license="MIT",
     classifiers=[
         "Development Status :: 3 - Alpha",

{pyswitchbot-0.52.0 → pyswitchbot-0.53.2}/switchbot/adv_parser.py

@@ -18,6 +18,7 @@ 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.keypad import process_wokeypad
 from .adv_parsers.light_strip import process_wostrip
 from .adv_parsers.lock import process_wolock, process_wolock_pro
 from .adv_parsers.meter import process_wosensorth, process_wosensorth_c
@@ -177,14 +178,20 @@ SUPPORTED_TYPES: dict[str, SwitchbotSupportedType] = {
         "func": process_woblindtilt,
         "manufacturer_id": 2409,
     },
+    "y": {
+        "modelName": SwitchbotModel.KEYPAD,
+        "modelFriendlyName": "Keypad",
+        "func": process_wokeypad,
+        "manufacturer_id": 2409,
+    },
     "<": {
-        "modelName": SwitchbotModel.RelaySwitch1PM,
+        "modelName": SwitchbotModel.RELAY_SWITCH_1PM,
         "modelFriendlyName": "Relay Switch 1PM",
         "func": process_worelay_switch_1pm,
         "manufacturer_id": 2409,
     },
     ";": {
-        "modelName": SwitchbotModel.RelaySwitch1Plus,
+        "modelName": SwitchbotModel.RELAY_SWITCH_1_PLUS,
         "modelFriendlyName": "Relay Switch 1",
         "func": process_worelay_switch_1plus,
         "manufacturer_id": 2409,

pyswitchbot-0.53.2/switchbot/adv_parsers/keypad.py

@@ -0,0 +1,22 @@
+"""Keypad parser."""
+
+from __future__ import annotations
+
+import logging
+
+_LOGGER = logging.getLogger(__name__)
+
+
+def process_wokeypad(
+    data: bytes | None,
+    mfr_data: bytes | None,
+) -> dict[str, bool | int | None]:
+    """Process woKeypad services data."""
+    if data is None or mfr_data is None:
+        return {"battery": None, "attempt_state": None}
+
+    _LOGGER.debug("mfr_data: %s", mfr_data.hex())
+    if data:
+        _LOGGER.debug("data: %s", data.hex())
+
+    return {"battery": data[2] & 0b01111111, "attempt_state": mfr_data[6]}

{pyswitchbot-0.52.0 → pyswitchbot-0.53.2}/switchbot/const.py

@@ -1,4 +1,5 @@
 """Library to handle connection with Switchbot."""
+
 from __future__ import annotations
 
 from enum import Enum
@@ -52,8 +53,9 @@ class SwitchbotModel(StrEnum):
     LOCK_PRO = "WoLockPro"
     BLIND_TILT = "WoBlindTilt"
     HUB2 = "WoHub2"
-    RelaySwitch1PM = "Relay Switch 1PM"
-    RelaySwitch1Plus = "Relay Switch 1"
+    KEYPAD = "WoKeypad"
+    RELAY_SWITCH_1PM = "Relay Switch 1PM"
+    RELAY_SWITCH_1_PLUS = "Relay Switch 1"
 
 
 class LockStatus(Enum):

pyswitchbot-0.53.2/switchbot/devices/motion.py

@@ -0,0 +1 @@
+from __future__ import annotations

{pyswitchbot-0.52.0 → pyswitchbot-0.53.2}/switchbot/devices/relay_switch.py

@@ -25,7 +25,7 @@ class SwitchbotRelaySwitch(SwitchbotSequenceDevice):
         key_id: str,
         encryption_key: str,
         interface: int = 0,
-        model: SwitchbotModel = SwitchbotModel.RelaySwitch1PM,
+        model: SwitchbotModel = SwitchbotModel.RELAY_SWITCH_1PM,
         **kwargs: Any,
     ) -> None:
         if len(key_id) == 0:

{pyswitchbot-0.52.0 → pyswitchbot-0.53.2}/switchbot/discovery.py

@@ -124,6 +124,10 @@ class GetSwitchbotDevices:
         lock_pros = await self._get_devices_by_model("$")
         return {**locks, **lock_pros}
 
+    async def get_keypads(self) -> dict[str, SwitchBotAdvertisement]:
+        """Return all WoKeypad/Keypad devices with services data."""
+        return await self._get_devices_by_model("y")
+
     async def get_device_data(
         self, address: str
     ) -> dict[str, SwitchBotAdvertisement] | None:

{pyswitchbot-0.52.0 → pyswitchbot-0.53.2}/tests/test_adv_parser.py

@@ -1647,3 +1647,28 @@ def test_meter_pro_c_passive() -> None:
         rssi=-67,
         active=False,
     )
+
+
+def test_parse_advertisement_data_keypad():
+    """Test parse_advertisement_data for the keypad."""
+    ble_device = generate_ble_device("aa:bb:cc:dd:ee:ff", "any")
+    adv_data = generate_advertisement_data(
+        manufacturer_data={2409: b"\xeb\x13\x02\xe6#\x0f\x8fd\x00\x00\x00\x00"},
+        service_data={"0000fd3d-0000-1000-8000-00805f9b34fb": b"y\x00d"},
+        rssi=-67,
+    )
+    result = parse_advertisement_data(ble_device, adv_data, SwitchbotModel.KEYPAD)
+    assert result == SwitchBotAdvertisement(
+        address="aa:bb:cc:dd:ee:ff",
+        data={
+            "data": {"attempt_state": 143, "battery": 100},
+            "isEncrypted": False,
+            "model": "y",
+            "modelFriendlyName": "Keypad",
+            "modelName": SwitchbotModel.KEYPAD,
+            "rawAdvData": b"y\x00d",
+        },
+        device=ble_device,
+        rssi=-67,
+        active=True,
+    )

pyswitchbot-0.52.0/PKG-INFO

@@ -1,20 +0,0 @@
-Metadata-Version: 2.1
-Name: PySwitchbot
-Version: 0.52.0
-Summary: A library to communicate with Switchbot
-Home-page: https://github.com/Danielhiversen/pySwitchbot/
-Author: Daniel Hjelseth Hoyer
-License: MIT
-Classifier: Development Status :: 3 - Alpha
-Classifier: Environment :: Other Environment
-Classifier: Intended Audience :: Developers
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Topic :: Home Automation
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-License-File: LICENSE
-Requires-Dist: aiohttp>=3.9.5
-Requires-Dist: bleak>=0.19.0
-Requires-Dist: bleak-retry-connector>=3.4.0
-Requires-Dist: cryptography>=39.0.0
-Requires-Dist: pyOpenSSL>=23.0.0

pyswitchbot-0.52.0/PySwitchbot.egg-info/PKG-INFO

@@ -1,20 +0,0 @@
-Metadata-Version: 2.1
-Name: PySwitchbot
-Version: 0.52.0
-Summary: A library to communicate with Switchbot
-Home-page: https://github.com/Danielhiversen/pySwitchbot/
-Author: Daniel Hjelseth Hoyer
-License: MIT
-Classifier: Development Status :: 3 - Alpha
-Classifier: Environment :: Other Environment
-Classifier: Intended Audience :: Developers
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Topic :: Home Automation
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-License-File: LICENSE
-Requires-Dist: aiohttp>=3.9.5
-Requires-Dist: bleak>=0.19.0
-Requires-Dist: bleak-retry-connector>=3.4.0
-Requires-Dist: cryptography>=39.0.0
-Requires-Dist: pyOpenSSL>=23.0.0