Переход на API v4 для управления сценариями (#53)

dext0r · dext0r · commit 6d11583fa992 · 2025-06-01T16:01:28.000+03:00
diff --git a/custom_components/yandex_station_intents/__init__.py b/custom_components/yandex_station_intents/__init__.py
@@ -248,7 +248,7 @@ async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
 
 
 async def _async_setup_intents(
-    intents: list[Intent], quasar: YandexQuasar, target_device: Device | None = None
+    intents: list[Intent], quasar: YandexQuasar, intent_player_device: Device | None = None
 ) -> None:
     await quasar.delete_stale_intents(intents)
 
@@ -260,7 +260,9 @@ async def _async_setup_intents(
 
         try:
             await quasar.async_add_or_update_intent(
-                intent=item, intent_quasar_id=quasar_intents.get(item.name), target_device=target_device
+                intent=item,
+                intent_quasar_id=quasar_intents.get(item.name),
+                intent_player_device=intent_player_device,
             )
         except AuthException:
             _LOGGER.exception(
diff --git a/custom_components/yandex_station_intents/yandex_intent.py b/custom_components/yandex_station_intents/yandex_intent.py
@@ -40,7 +40,7 @@ def scenario_name(self) -> str:
         return f"{INTENT_ID_MARKER} {self.name}"
 
     @property
-    def scenario_step_value(self) -> str:
+    def scenario_text_command(self) -> str:
         rv = STATION_STUB_COMMAND
         if self.say_phrase and not self.execute_command:
             rv = self.say_phrase
diff --git a/custom_components/yandex_station_intents/yandex_quasar.py b/custom_components/yandex_station_intents/yandex_quasar.py
@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from abc import ABC, abstractmethod
 from dataclasses import dataclass
 import json
 import logging
@@ -21,6 +22,7 @@
 
 URL_USER = "https://iot.quasar.yandex.ru/m/user"
 URL_V3_USER = "https://iot.quasar.yandex.ru/m/v3/user"
+URL_V4_USER = "https://iot.quasar.yandex.ru/m/v4/user"
 DEFAULT_RECONNECTION_DELAY = 2
 MAX_RECONNECTION_DELAY = 180
 
@@ -44,76 +46,124 @@ def from_dict(cls, data: ConfigType) -> Device:
         )
 
 
-class ScenarioStep:
-    def __init__(self, value: str | None = None, launch_devices: list[Any] | None = None) -> None:
-        self._value = value
-        self._launch_devices = launch_devices or []
-        self._request_speaker_capabilities: list[dict[Any, Any]] = []
+class ScenarioStepItem(ABC):
+    """
+    Действие в сценариях.
+    """
+
+    @property
+    @abstractmethod
+    def as_dict(self) -> ConfigType:
+        pass
+
+
+class ScenarioStepItemDeviceChannel(ScenarioStepItem):
+    """
+    Действие "Канал X" для служебного плеера.
+    """
+
+    def __init__(self, device: Device, channel: int):
+        self._device = device
+        self._channel = channel
 
     @property
     def as_dict(self) -> ConfigType:
         return {
-            "type": "scenarios.steps.actions",
-            "parameters": {
-                "launch_devices": self._launch_devices,
-                "requested_speaker_capabilities": self._request_speaker_capabilities,
+            "id": self._device.id,
+            "type": "step.action.item.device",
+            "value": {
+                "id": self._device.id,
+                # "item_type": "device",
+                "capabilities": [
+                    {
+                        "type": "devices.capabilities.range",
+                        "state": {
+                            "instance": "channel",
+                            "value": self._channel,
+                        },
+                    }
+                ],
             },
         }
 
 
-class ScenarioStepTTS(ScenarioStep):
+class ScenarioStepItemRequestedDevice(ScenarioStepItem, ABC):
     """
-    Проговаривает текст полностью и только потом выполняет следующий шаг.
-    В интерфейсе: "Прочитать текст вслух"
-    В список событий не попадает.
+    Действия из раздела "Любое умное устройство, которое активирует сценарий"
     """
 
-    def __init__(self, value: str, launch_devices: list[Any] | None = None) -> None:
-        super().__init__(value, launch_devices)
+    @property
+    def as_dict(self) -> ConfigType:
+        return {
+            "id": "requested-device",
+            "type": "step.action.item.requested_device_with_assistant",
+            "value": self._value,
+        }
 
-        self._request_speaker_capabilities.append(
-            {
-                "parameters": {"instance": "tts"},
-                "retrievable": False,
-                "state": {"instance": "tts", "value": {"text": self._value}},
-                "type": "devices.capabilities.quasar",
-            }
-        )
+    @property
+    @abstractmethod
+    def _value(self) -> ConfigType:
+        pass
 
 
-class ScenarioStepTextAction(ScenarioStep):
+class ScenarioStepItemRequestedDeviceTTS(ScenarioStepItemRequestedDevice):
     """
-    Выполняет команду на колонке.
-    В интерфейсе: "Ответить на вопрос или выполнить команду"
+    Проговаривает текст на колонке, действие не попадает в список событий.
+    В интерфейсе: "Прочитать текст вслух"
     """
 
-    def __init__(self, value: str, launch_devices: list[Any] | None = None) -> None:
-        super().__init__(value, launch_devices)
+    def __init__(self, text: str):
+        self._text = text
 
-        self._request_speaker_capabilities.append(
-            {
-                "parameters": {"instance": "text_action"},
-                "state": {"instance": "text_action", "value": self._value},
-                "type": "devices.capabilities.quasar.server_action",
-            }
-        )
+    @property
+    def _value(self) -> ConfigType:
+        return {
+            "type": "devices.capabilities.quasar",
+            "state": {
+                "instance": "tts",
+                "value": {"text": self._text},
+            },
+        }
 
 
-class ScenarioStepPhraseAction(ScenarioStep):
+class ScenarioStepItemRequestedDeviceTTSPA(ScenarioStepItemRequestedDevice):
     """
-    Проговаривает текст и сразу выполняет следующую команду.
+    Проговаривает текст на колонке, действие попадает в список событий.
     В интерфейсе: отсутствует
     """
 
-    def __init__(self, value: str, launch_devices: list[Any] | None = None) -> None:
-        super().__init__(value, launch_devices)
+    def __init__(self, text: str):
+        self._text = text
 
-        self._request_speaker_capabilities.append(
-            {
-                "state": {"instance": "phrase_action", "value": self._value},
-                "type": "devices.capabilities.quasar.server_action",
-            }
-        )
+    @property
+    def _value(self) -> ConfigType:
+        return {
+            "type": "devices.capabilities.quasar.server_action",
+            "state": {
+                "instance": "phrase_action",
+                "value": self._text,
+            },
+        }
+
+
+class ScenarioStepItemRequestedDeviceTextAction(ScenarioStepItemRequestedDevice):
+    """
+    Выполняет команду на колонке.
+    В интерфейсе: "Ответить на вопрос или выполнить команду"
+    """
+
+    def __init__(self, command: str):
+        self._command = command
+
+    @property
+    def _value(self) -> ConfigType:
+        return {
+            "type": "devices.capabilities.quasar.server_action",
+            "state": {
+                "instance": "text_action",
+                "value": self._command,
+            },
+        }
 
 
 class YandexQuasar:
@@ -160,48 +210,41 @@ async def async_get_intents(self) -> dict[str, str]:
         return rv
 
     async def async_add_or_update_intent(
-        self, intent: Intent, intent_quasar_id: str | None, target_device: Device | None
+        self, intent: Intent, intent_quasar_id: str | None, intent_player_device: Device | None
     ) -> None:
-        steps: list[ScenarioStep] = []
-
-        if target_device:
-            steps.append(
-                ScenarioStep(
-                    launch_devices=[
-                        {
-                            "id": target_device.id,
-                            "capabilities": [
-                                {
-                                    "type": "devices.capabilities.range",
-                                    "state": {"instance": "channel", "relative": False, "value": intent.id},
-                                }
-                            ],
-                        }
-                    ]
-                )
-            )
-
-        if intent.say_phrase and intent.execute_command:
-            steps.append(ScenarioStepTTS(intent.say_phrase))
-            steps.append(ScenarioStepTextAction(intent.scenario_step_value))
-        elif intent.say_phrase:
-            steps.append(ScenarioStepPhraseAction(intent.scenario_step_value))
+        step_items: list[ScenarioStepItem] = []
+
+        if intent_player_device:
+            if intent.say_phrase:
+                step_items.append(ScenarioStepItemRequestedDeviceTTS(intent.say_phrase))
+            step_items.append(ScenarioStepItemDeviceChannel(intent_player_device, intent.id))
         else:
-            steps.append(ScenarioStepTextAction(intent.scenario_step_value))
+            if intent.say_phrase and intent.execute_command:
+                step_items.append(ScenarioStepItemRequestedDeviceTTS(intent.say_phrase))
+                step_items.append(ScenarioStepItemRequestedDeviceTextAction(intent.scenario_text_command))
+            elif intent.say_phrase:
+                step_items.append(ScenarioStepItemRequestedDeviceTTSPA(intent.scenario_text_command))
+            else:
+                step_items.append(ScenarioStepItemRequestedDeviceTextAction(intent.scenario_text_command))
 
         payload = {
             "name": intent.scenario_name,
             "icon": "home",
             "triggers": [{"type": "scenario.trigger.voice", "value": v} for v in intent.trigger_phrases],
-            "steps": [s.as_dict for s in steps],
+            "steps": [
+                {
+                    "type": "scenarios.steps.actions.v2",
+                    "parameters": {"items": [si.as_dict for si in step_items]},
+                }
+            ],
         }
 
         if intent_quasar_id:
             _LOGGER.debug(f"Обновление сценария {intent.scenario_name!r}: {payload}")
-            r = await self._session.put(f"{URL_USER}/scenarios/{intent_quasar_id}", json=payload)
+            r = await self._session.put(f"{URL_V4_USER}/scenarios/{intent_quasar_id}", json=payload)
         else:
             _LOGGER.debug(f"Создание сценария {intent.scenario_name!r}: {payload}")
-            r = await self._session.post(f"{URL_USER}/scenarios", json=payload)
+            r = await self._session.post(f"{URL_V4_USER}/scenarios", json=payload)
 
         resp = await r.json()
         assert resp["status"] == "ok", resp
