Add media player device actions

homeassistant/components/media_player/const.py

@@ -1,4 +1,4 @@
-"""Proides the constants needed for component."""
+"""Provides the constants needed for component."""
 
 ATTR_APP_ID = "app_id"
 ATTR_APP_NAME = "app_name"
@@ -27,6 +27,17 @@
 ATTR_SOUND_MODE = "sound_mode"
 ATTR_SOUND_MODE_LIST = "sound_mode_list"
 
+CONF_CLEAR_PLAYLIST = "clear_playlist"
+CONF_MEDIA_PLAY_PAUSE = "media_play_pause"
+CONF_MEDIA_PLAY = "media_play"
+CONF_MEDIA_PAUSE = "media_pause"
+CONF_MEDIA_STOP = "media_stop"
+CONF_MEDIA_NEXT_TRACK = "media_next_track"
+CONF_MEDIA_PREVIOUS_TRACK = "media_previous_track"
+CONF_SUPPORTED_FEATURES = "supported_features"
+CONF_VOLUME_UP = "volume_up"
+CONF_VOLUME_DOWN = "volume_down"
+
 DOMAIN = "media_player"
 
 MEDIA_TYPE_MUSIC = "music"

homeassistant/components/media_player/device_action.py

@@ -0,0 +1,165 @@
+"""Provides device actions for Media Player."""
+from typing import Any, Dict, List, Optional
+
+import voluptuous as vol
+
+from homeassistant.const import (
+    ATTR_ENTITY_ID,
+    CONF_DEVICE_ID,
+    CONF_DOMAIN,
+    CONF_ENTITY_ID,
+    CONF_SERVICE,
+    CONF_TYPE,
+    SERVICE_MEDIA_NEXT_TRACK,
+    SERVICE_MEDIA_PAUSE,
+    SERVICE_MEDIA_PLAY,
+    SERVICE_MEDIA_PLAY_PAUSE,
+    SERVICE_MEDIA_PREVIOUS_TRACK,
+    SERVICE_MEDIA_STOP,
+    SERVICE_TOGGLE,
+    SERVICE_TURN_OFF,
+    SERVICE_TURN_ON,
+    SERVICE_VOLUME_DOWN,
+    SERVICE_VOLUME_UP,
+)
+from homeassistant.core import Context, HomeAssistant
+from homeassistant.helpers import entity_registry
+import homeassistant.helpers.config_validation as cv
+
+from . import (
+    DOMAIN,
+    SUPPORT_CLEAR_PLAYLIST,
+    SUPPORT_NEXT_TRACK,
+    SUPPORT_PAUSE,
+    SUPPORT_PLAY,
+    SUPPORT_PREVIOUS_TRACK,
+    SUPPORT_STOP,
+    SUPPORT_TURN_OFF,
+    SUPPORT_TURN_ON,
+    SUPPORT_VOLUME_SET,
+    SUPPORT_VOLUME_STEP,
+)
+from ..device_automation.const import CONF_TOGGLE, CONF_TURN_OFF, CONF_TURN_ON
+from .const import (
+    CONF_CLEAR_PLAYLIST,
+    CONF_MEDIA_NEXT_TRACK,
+    CONF_MEDIA_PAUSE,
+    CONF_MEDIA_PLAY,
+    CONF_MEDIA_PLAY_PAUSE,
+    CONF_MEDIA_PREVIOUS_TRACK,
+    CONF_MEDIA_STOP,
+    CONF_SUPPORTED_FEATURES,
+    CONF_VOLUME_DOWN,
+    CONF_VOLUME_UP,
+    SERVICE_CLEAR_PLAYLIST,
+)
+
+ACTION_TYPES: Dict[str, Dict[str, Any]] = {
+    CONF_TURN_ON: {
+        CONF_SERVICE: SERVICE_TURN_ON,
+        CONF_SUPPORTED_FEATURES: [SUPPORT_TURN_ON],
+    },
+    CONF_TURN_OFF: {
+        CONF_SERVICE: SERVICE_TURN_OFF,
+        CONF_SUPPORTED_FEATURES: [SUPPORT_TURN_OFF],
+    },
+    CONF_TOGGLE: {
+        CONF_SERVICE: SERVICE_TOGGLE,
+        CONF_SUPPORTED_FEATURES: [SUPPORT_TURN_ON | SUPPORT_TURN_OFF],
+    },
+    CONF_VOLUME_UP: {
+        CONF_SERVICE: SERVICE_VOLUME_UP,
+        CONF_SUPPORTED_FEATURES: [SUPPORT_VOLUME_SET, SUPPORT_VOLUME_STEP],
+    },
+    CONF_VOLUME_DOWN: {
+        CONF_SERVICE: SERVICE_VOLUME_DOWN,
+        CONF_SUPPORTED_FEATURES: [SUPPORT_VOLUME_SET, SUPPORT_VOLUME_STEP],
+    },
+    CONF_MEDIA_PLAY_PAUSE: {
+        CONF_SERVICE: SERVICE_MEDIA_PLAY_PAUSE,
+        CONF_SUPPORTED_FEATURES: [SUPPORT_PLAY | SUPPORT_PAUSE],
+    },
+    CONF_MEDIA_PLAY: {
+        CONF_SERVICE: SERVICE_MEDIA_PLAY,
+        CONF_SUPPORTED_FEATURES: [SUPPORT_PLAY],
+    },
+    CONF_MEDIA_PAUSE: {
+        CONF_SERVICE: SERVICE_MEDIA_PAUSE,
+        CONF_SUPPORTED_FEATURES: [SUPPORT_PAUSE],
+    },
+    CONF_MEDIA_STOP: {
+        CONF_SERVICE: SERVICE_MEDIA_STOP,
+        CONF_SUPPORTED_FEATURES: [SUPPORT_STOP],
+    },
+    CONF_MEDIA_NEXT_TRACK: {
+        CONF_SERVICE: SERVICE_MEDIA_NEXT_TRACK,
+        CONF_SUPPORTED_FEATURES: [SUPPORT_NEXT_TRACK],
+    },
+    CONF_MEDIA_PREVIOUS_TRACK: {
+        CONF_SERVICE: SERVICE_MEDIA_PREVIOUS_TRACK,
+        CONF_SUPPORTED_FEATURES: [SUPPORT_PREVIOUS_TRACK],
+    },
+    CONF_CLEAR_PLAYLIST: {
+        CONF_SERVICE: SERVICE_CLEAR_PLAYLIST,
+        CONF_SUPPORTED_FEATURES: [SUPPORT_CLEAR_PLAYLIST],
+    },
+}
+
+ACTION_SCHEMA = cv.DEVICE_ACTION_BASE_SCHEMA.extend(
+    {
+        vol.Required(CONF_TYPE): vol.In(list(ACTION_TYPES.keys())),
+        vol.Required(CONF_ENTITY_ID): cv.entity_domain(DOMAIN),
+    }
+)
+
+
+async def async_get_actions(hass: HomeAssistant, device_id: str) -> List[dict]:
+    """List device actions for Media Player devices."""
+    registry = await entity_registry.async_get_registry(hass)
+    actions = []
+
+    # Get all the integrations entities for this device
+    for entry in entity_registry.async_entries_for_device(registry, device_id):
+        if entry.domain != DOMAIN:
+            continue
+
+        state = hass.states.get(entry.entity_id)
+
+        if state:
+            supported_features = state.attributes.get(CONF_SUPPORTED_FEATURES, 0)
+        else:
+            supported_features = entry.supported_features
+
+        # Add actions for each entity that belongs to this integration
+        for action, action_config in ACTION_TYPES.items():
+            if any(
+                (x & supported_features) == x
+                for x in action_config[CONF_SUPPORTED_FEATURES]
+            ):
+                actions.append(
+                    {
+                        CONF_DEVICE_ID: device_id,
+                        CONF_DOMAIN: DOMAIN,
+                        CONF_ENTITY_ID: entry.entity_id,
+                        CONF_TYPE: action,
+                    }
+                )
+
+    return actions
+
+
+async def async_call_action_from_config(
+    hass: HomeAssistant, config: dict, variables: dict, context: Optional[Context]
+) -> None:
+    """Execute a device action."""
+    config = ACTION_SCHEMA(config)
+
+    service_data = {ATTR_ENTITY_ID: config[CONF_ENTITY_ID]}
+
+    config_type = config[CONF_TYPE]
+    action_config = ACTION_TYPES[config_type]
+    service: str = action_config[CONF_SERVICE]
+
+    await hass.services.async_call(
+        DOMAIN, service, service_data, blocking=True, context=context
+    )

homeassistant/components/media_player/strings.json

@@ -1,6 +1,20 @@
 {
   "title": "Media player",
   "device_automation": {
+    "action_type": {
+      "turn_on": "Turn on {entity_name}",
+      "turn_off": "Turn off {entity_name}",
+      "toggle": "Toggle {entity_name}",
+      "volume_up": "Increase volume of {entity_name}",
+      "volume_down": "Decrease volume of {entity_name}",
+      "media_play_pause": "Toggle play {entity_name}",
+      "media_pause": "Pause {entity_name}",
+      "media_play": "Play {entity_name}",
+      "media_stop": "Stop {entity_name}",
+      "media_next_track": "Play next track on {entity_name}",
+      "media_previous_track": "Play previous track on {entity_name}",
+      "clear_playlist": "Clear playlist on {entity_name}"
+    },
     "condition_type": {
       "is_on": "{entity_name} is on",
       "is_off": "{entity_name} is off",