python-roborock 2.10.1__tar.gz → 2.11.0__tar.gz

{python_roborock-2.10.1 → python_roborock-2.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: python-roborock
-Version: 2.10.1
+Version: 2.11.0
 Summary: A package to control Roborock vacuums.
 License: GPL-3.0-only
 Keywords: roborock,vacuum,homeassistant

{python_roborock-2.10.1 → python_roborock-2.11.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-roborock"
-version = "2.10.1"
+version = "2.11.0"
 description = "A package to control Roborock vacuums."
 authors = ["humbertogontijo <humbertogontijo@users.noreply.github.com>"]
 license = "GPL-3.0-only"

{python_roborock-2.10.1 → python_roborock-2.11.0}/roborock/cli.py

@@ -113,6 +113,38 @@ async def list_devices(ctx):
     click.echo(f"Known devices {device_name_id}")
 
 
+@click.command()
+@click.option("--device_id", required=True)
+@click.pass_context
+@run_sync()
+async def list_scenes(ctx, device_id):
+    context: RoborockContext = ctx.obj
+    login_data = context.login_data()
+    if not login_data.home_data:
+        await _discover(ctx)
+        login_data = context.login_data()
+    client = RoborockApiClient(login_data.email)
+    scenes = await client.get_scenes(login_data.user_data, device_id)
+    output_list = []
+    for scene in scenes:
+        output_list.append(scene.as_dict())
+    click.echo(json.dumps(output_list, indent=4))
+
+
+@click.command()
+@click.option("--scene_id", required=True)
+@click.pass_context
+@run_sync()
+async def execute_scene(ctx, scene_id):
+    context: RoborockContext = ctx.obj
+    login_data = context.login_data()
+    if not login_data.home_data:
+        await _discover(ctx)
+        login_data = context.login_data()
+    client = RoborockApiClient(login_data.email)
+    await client.execute_scene(login_data.user_data, scene_id)
+
+
 @click.command()
 @click.option("--device_id", required=True)
 @click.option("--cmd", required=True)
@@ -192,6 +224,8 @@ async def parser(_, local_key, device_ip, file):
 cli.add_command(login)
 cli.add_command(discover)
 cli.add_command(list_devices)
+cli.add_command(list_scenes)
+cli.add_command(execute_scene)
 cli.add_command(command)
 cli.add_command(parser)
 

{python_roborock-2.10.1 → python_roborock-2.11.0}/roborock/containers.py

@@ -439,6 +439,12 @@ class HomeDataRoom(RoborockBase):
     name: str
 
 
+@dataclass
+class HomeDataScene(RoborockBase):
+    id: int
+    name: str
+
+
 @dataclass
 class HomeData(RoborockBase):
     id: int

{python_roborock-2.10.1 → python_roborock-2.11.0}/roborock/web_api.py

@@ -11,7 +11,7 @@ import time
 import aiohttp
 from aiohttp import ContentTypeError, FormData
 
-from roborock.containers import HomeData, HomeDataRoom, ProductResponse, RRiot, UserData
+from roborock.containers import HomeData, HomeDataRoom, HomeDataScene, ProductResponse, RRiot, UserData
 from roborock.exceptions import (
     RoborockAccountDoesNotExist,
     RoborockException,
@@ -355,6 +355,43 @@ class RoborockApiClient:
         else:
             raise RoborockException("home_response result was an unexpected type")
 
+    async def get_scenes(self, user_data: UserData, device_id: int) -> list[HomeDataScene]:
+        rriot = user_data.rriot
+        if rriot is None:
+            raise RoborockException("rriot is none")
+        if rriot.r.a is None:
+            raise RoborockException("Missing field 'a' in rriot reference")
+        scenes_request = PreparedRequest(
+            rriot.r.a,
+            {
+                "Authorization": self._get_hawk_authentication(rriot, f"/user/scene/device/{str(device_id)}"),
+            },
+        )
+        scenes_response = await scenes_request.request("get", f"/user/scene/device/{str(device_id)}")
+        if not scenes_response.get("success"):
+            raise RoborockException(scenes_response)
+        scenes = scenes_response.get("result")
+        if isinstance(scenes, list):
+            return [HomeDataScene.from_dict(scene) for scene in scenes]
+        else:
+            raise RoborockException("scene_response result was an unexpected type")
+
+    async def execute_scene(self, user_data: UserData, scene_id: int) -> None:
+        rriot = user_data.rriot
+        if rriot is None:
+            raise RoborockException("rriot is none")
+        if rriot.r.a is None:
+            raise RoborockException("Missing field 'a' in rriot reference")
+        execute_scene_request = PreparedRequest(
+            rriot.r.a,
+            {
+                "Authorization": self._get_hawk_authentication(rriot, f"/user/scene/{str(scene_id)}/execute"),
+            },
+        )
+        execute_scene_response = await execute_scene_request.request("POST", f"/user/scene/{str(scene_id)}/execute")
+        if not execute_scene_response.get("success"):
+            raise RoborockException(execute_scene_response)
+
     async def get_products(self, user_data: UserData) -> ProductResponse:
         """Gets all products and their schemas, good for determining status codes and model numbers."""
         base_url = await self._get_base_url()