Merge pull request #18 from ysohma/add-scene-support

Add scene support

Author: jonghwanhyeon

README.md

@@ -79,3 +79,17 @@ remote.command('low_speed')
 # To send custom commands,
 remote.command('MyCustomCommand', customize=True)
 ```
+
+### Scenes
+```python
+# To list all infra red remotes
+scenes = switchbot.scenes()
+for scene in scenes:
+    print(scene)
+
+# If you already know a remote id:
+scene = switchbot.scene(id='')
+
+# To execute scene
+scene.execute()
+```

switchbot/__init__.py

@@ -4,6 +4,7 @@
 from switchbot.client import SwitchBotClient
 from switchbot.devices import Device
 from switchbot.remotes import Remote
+from switchbot.scene import Scene
 
 __version__ = "2.3.0"
 
@@ -41,3 +42,13 @@ def remote(self, id: str) -> Remote:
             if remote.id == id:
                 return remote
         raise ValueError(f"Unknown remote {id}")
+
+    def scenes(self) -> List[Scene]:
+        response = self.client.get("scenes")
+        return [Scene(client=self.client, id=scene["scene_id"], **scene) for scene in response["body"]]
+
+    def scene(self, id: str) -> Scene:
+        for scene in self.scenes():
+            if scene.id == id:
+                return scene
+        raise ValueError(f"Unknown scene {id}")

switchbot/scene.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from switchbot.client import SwitchBotClient
+
+
+class Scene:
+    def __init__(self, client: SwitchBotClient, id: str, **extra):
+        self.client = client
+        self.id: str = id
+        self.name: str = extra.get("scene_name")
+
+    def execute(self):
+        self.client.post(f"scenes/{self.id}/execute")
+
+    def __repr__(self):
+        name = "Scene" if self.name is None else self.name
+        name = name.replace(" ", "")
+        return f"{name}(id={self.id})"