switchbot-api 1.0.1__tar.gz → 1.2.0__tar.gz

{switchbot_api-1.0.1 → switchbot_api-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
-Name: switchbot-api
-Version: 1.0.1
+Name: switchbot_api
+Version: 1.2.0
 Summary: An asynchronous library to use Switchbot API
 Home-page: https://github.com/SeraphicCorp/py-switchbot-api
 License: MIT
@@ -29,3 +29,18 @@ print(await client.list_devices())
 print(await client.get_status('some-id'))
 await client.send_command('some-id', {COMMAND})
 ```
+
+## Development
+
+### Install
+
+```bash
+poetry install
+```
+
+### Lint
+
+```bash
+poetry run black switchbot_api/
+poetry run mypy switchbot_api/
+```

{switchbot_api-1.0.1 → switchbot_api-1.2.0}/README.md

@@ -11,4 +11,19 @@ client = SwitchBotAPI(token, secret)
 print(await client.list_devices())
 print(await client.get_status('some-id'))
 await client.send_command('some-id', {COMMAND})
+```
+
+## Development
+
+### Install
+
+```bash
+poetry install
+```
+
+### Lint
+
+```bash
+poetry run black switchbot_api/
+poetry run mypy switchbot_api/
 ```

{switchbot_api-1.0.1 → switchbot_api-1.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "switchbot_api"
-version = "1.0.1"
+version = "1.2.0"
 description = "An asynchronous library to use Switchbot API"
 authors = ["Ravaka Razafimanantsoa <contact@ravaka.dev>"]
 license = "MIT"

{switchbot_api-1.0.1 → switchbot_api-1.2.0}/switchbot_api/__init__.py

@@ -6,6 +6,7 @@ import hashlib
 import hmac
 import logging
 import time
+from typing import TypeVar
 import uuid
 
 from aiohttp import ClientSession
@@ -13,7 +14,6 @@ from aiohttp import ClientSession
 _API_HOST = "https://api.switch-bot.com"
 
 _LOGGER = logging.getLogger(__name__)
-OBSERVED_DEVICE_TYPES = ["Remote", "Plug", "Plug Mini (US)", "Plug Mini (JP)"]
 NON_OBSERVED_REMOTE_TYPES = ["Others"]
 
 
@@ -66,26 +66,36 @@ class PowerState(Enum):
     OFF = "off"
 
 
-class CommonCommands(Enum):
+class Commands(Enum):
+    pass
+
+
+class CommonCommands(Commands):
     """Common commands."""
 
     ON = "turnOn"
     OFF = "turnOff"
 
 
-class OthersCommands(Enum):
+class OthersCommands(Commands):
     """Others commands."""
 
     CUSTOMIZE = "customize"  # Command {user-defined button name}
 
 
-class AirConditionerCommands(Enum):
-    """xtending inherited Enum class "CommonCommands"pylint(invalid-enum-extensAir conditioner commands."""
+class AirConditionerCommands(Commands):
+    """Air conditioner commands."""
 
     SET_ALL = "setAll"  # parameter: {temperature},{mode},{fan speed},{power state}
 
 
-class TVCommands(Enum):
+class HumidifierCommands(Commands):
+    """Humidifier commands."""
+
+    SET_MODE = "setMode"  # parameter: auto, set to Auto Mode, 101, set atomization efficiency to 34%,102, set atomization efficiency to 67%, 103, set atomization efficiency to 100%
+
+
+class TVCommands(Commands):
     """TV commands."""
 
     SET_CHANNEL = "SetChannel"
@@ -95,7 +105,7 @@ class TVCommands(Enum):
     CHANNEL_SUB = "channelSub"
 
 
-class DVDCommands(Enum):
+class DVDCommands(Commands):
     """DVD commands."""
 
     SET_MUTE = "setMute"
@@ -108,14 +118,14 @@ class DVDCommands(Enum):
     STOP = "Stop"
 
 
-class SpeakerCommands(Enum):
+class SpeakerCommands(Commands):
     """Speaker commands."""
 
     VOLUME_ADD = "volumeAdd"
     VOLUME_SUB = "volumeSub"
 
 
-class FanCommands(Enum):
+class FanCommands(Commands):
     """Fan commands."""
 
     SWING = "swing"
@@ -125,13 +135,16 @@ class FanCommands(Enum):
     HIGH_SPEED = "highSpeed"
 
 
-class LightCommands(Enum):
+class LightCommands(Commands):
     """Light commands."""
 
     BRIGHTNESS_UP = "brightnessUp"
     BRIGHTNESS_DOWN = "brightnessDown"
 
 
+T = TypeVar("T", bound=CommonCommands)
+
+
 class SwitchBotAPI:
     """SwitchBot API."""
 
@@ -177,9 +190,7 @@ class SwitchBotAPI:
         """List devices."""
         body = await self._request_device("")
         _LOGGER.debug("Devices: %s", body)
-        devices = [
-            Device(**device) for device in body.get("deviceList") if device.get("deviceType") in OBSERVED_DEVICE_TYPES
-        ]
+        devices = [Device(**device) for device in body.get("deviceList")]
         remotes = [
             Remote(**remote)
             for remote in body.get("infraredRemoteList")
@@ -195,7 +206,7 @@ class SwitchBotAPI:
     async def send_command(
         self,
         device_id: str,
-        command: CommonCommands,
+        command: T,
         command_type: str = "command",
         parameters: dict | str = "default",
     ):
@@ -203,7 +214,7 @@ class SwitchBotAPI:
 
         Args:
             device_id (str): The ID of the device.
-            command (CommonCommands): The command to be sent.
+            command (extends CommonCommands): The command to be sent.
             command_type (str, optional): The type of the command. Defaults to "command".
             parameters (dict | str, optional): The parameters for the command. Defaults to "default".
 

switchbot_api-1.0.1/setup.py

@@ -1,30 +0,0 @@
-# -*- coding: utf-8 -*-
-from setuptools import setup
-
-packages = \
-['switchbot_api']
-
-package_data = \
-{'': ['*']}
-
-install_requires = \
-['aiohttp>=3.8.4,<4.0.0']
-
-setup_kwargs = {
-    'name': 'switchbot-api',
-    'version': '1.0.1',
-    'description': 'An asynchronous library to use Switchbot API',
-    'long_description': '# py-switchbot-api\nAn asynchronous library to use Switchbot API. Allows to use both devices and remotes.\n\n## Usage\n\n```python\ntoken = "xxx"\nsecret = "yyy"\n\nclient = SwitchBotAPI(token, secret)\nprint(await client.list_devices())\nprint(await client.get_status(\'some-id\'))\nawait client.send_command(\'some-id\', {COMMAND})\n```',
-    'author': 'Ravaka Razafimanantsoa',
-    'author_email': 'contact@ravaka.dev',
-    'maintainer': 'None',
-    'maintainer_email': 'None',
-    'url': 'https://github.com/SeraphicCorp/py-switchbot-api',
-    'packages': packages,
-    'package_data': package_data,
-    'install_requires': install_requires,
-    'python_requires': '>=3.10,<4.0',
-}
-
-
-setup(**setup_kwargs)