media_player.py

Go to the documentation of this file.

"""Support for Russound multizone controllers using RIO Protocol."""
 
from __future__ import annotations
 
import logging
 
from aiorussound import Controller
from aiorussound.models import PlayStatus, Source
from aiorussound.rio import ZoneControlSurface
 
from homeassistant.components.media_player import (
    MediaPlayerDeviceClass,
    MediaPlayerEntity,
    MediaPlayerEntityFeature,
    MediaPlayerState,
    MediaType,
)
from homeassistant.config_entries import SOURCE_IMPORT
from homeassistant.core import DOMAIN as HOMEASSISTANT_DOMAIN, HomeAssistant
from homeassistant.data_entry_flow import FlowResultType
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.issue_registry import IssueSeverity, async_create_issue
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
from . import RussoundConfigEntry
from .const import DOMAIN, MP_FEATURES_BY_FLAG
from .entity import RussoundBaseEntity, command
 
_LOGGER = logging.getLogger(__name__)
 
 
async def async_setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    async_add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Set up the Russound RIO platform."""
 
    result = await hass.config_entries.flow.async_init(
        DOMAIN,
        context={"source": SOURCE_IMPORT},
        data=config,
    )
    if (
        result["type"] is FlowResultType.CREATE_ENTRY
        or result["reason"] == "single_instance_allowed"
    ):
        async_create_issue(
            hass,
            HOMEASSISTANT_DOMAIN,
            f"deprecated_yaml_{DOMAIN}",
            breaks_in_ha_version="2025.2.0",
            is_fixable=False,
            issue_domain=DOMAIN,
            severity=IssueSeverity.WARNING,
            translation_key="deprecated_yaml",
            translation_placeholders={
                "domain": DOMAIN,
                "integration_title": "Russound RIO",
            },
        )
        return
    async_create_issue(
        hass,
        DOMAIN,
        f"deprecated_yaml_import_issue_{result['reason']}",
        breaks_in_ha_version="2025.2.0",
        is_fixable=False,
        issue_domain=DOMAIN,
        severity=IssueSeverity.WARNING,
        translation_key=f"deprecated_yaml_import_issue_{result['reason']}",
        translation_placeholders={
            "domain": DOMAIN,
            "integration_title": "Russound RIO",
        },
    )
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    entry: RussoundConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up the Russound RIO platform."""
    client = entry.runtime_data
    sources = client.sources
 
    async_add_entities(
        RussoundZoneDevice(controller, zone_id, sources)
        for controller in client.controllers.values()
        for zone_id in controller.zones
    )
 
 
class RussoundZoneDevice(RussoundBaseEntity, MediaPlayerEntity):
    """Representation of a Russound Zone."""
 
    _attr_device_class = MediaPlayerDeviceClass.SPEAKER
    _attr_media_content_type = MediaType.MUSIC
    _attr_supported_features = (
        MediaPlayerEntityFeature.VOLUME_SET
        | MediaPlayerEntityFeature.VOLUME_STEP
        | MediaPlayerEntityFeature.TURN_ON
        | MediaPlayerEntityFeature.TURN_OFF
        | MediaPlayerEntityFeature.SELECT_SOURCE
    )
 
    def __init__(
        self, controller: Controller, zone_id: int, sources: dict[int, Source]
    ) -> None:
        """Initialize the zone device."""
        super().__init__(controller)
        self._zone_id_zone_id = zone_id
        _zone = self._zone_zone
        self._sources_sources = sources
        self._attr_name_attr_name = _zone.name
        self._attr_unique_id_attr_unique_id = f"{self._primary_mac_address}-{_zone.device_str}"
        for flag, feature in MP_FEATURES_BY_FLAG.items():
            if flag in self._client_client.supported_features:
                self._attr_supported_features_attr_supported_features |= feature
 
    @property
    def _zone(self) -> ZoneControlSurface:
        return self._controller_controller.zones[self._zone_id_zone_id]
 
    @property
    def _source(self) -> Source:
        return self._zone_zone.fetch_current_source()
 
    @property
    def state(self) -> MediaPlayerState | None:
        """Return the state of the device."""
        status = self._zone_zone.status
        play_status = self._source_source.play_status
        if not status:
            return MediaPlayerState.OFF
        if play_status == PlayStatus.PLAYING:
            return MediaPlayerState.PLAYING
        if play_status == PlayStatus.PAUSED:
            return MediaPlayerState.PAUSED
        if play_status == PlayStatus.TRANSITIONING:
            return MediaPlayerState.BUFFERING
        if play_status == PlayStatus.STOPPED:
            return MediaPlayerState.IDLE
        return MediaPlayerState.ON
 
    @property
    def source(self):
        """Get the currently selected source."""
        return self._source_source.name
 
    @property
    def source_list(self):
        """Return a list of available input sources."""
        return [x.name for x in self._sources_sources.values()]
 
    @property
    def media_title(self):
        """Title of current playing media."""
        return self._source_source.song_name
 
    @property
    def media_artist(self):
        """Artist of current playing media, music track only."""
        return self._source_source.artist_name
 
    @property
    def media_album_name(self):
        """Album name of current playing media, music track only."""
        return self._source_source.album_name
 
    @property
    def media_image_url(self):
        """Image url of current playing media."""
        return self._source_source.cover_art_url
 
    @property
    def volume_level(self):
        """Volume level of the media player (0..1).
 
        Value is returned based on a range (0..50).
        Therefore float divide by 50 to get to the required range.
        """
        return self._zone_zone.volume / 50.0
 
    @command
    async def async_turn_off(self) -> None:
        """Turn off the zone."""
        await self._zone_zone.zone_off()
 
    @command
    async def async_turn_on(self) -> None:
        """Turn on the zone."""
        await self._zone_zone.zone_on()
 
    @command
    async def async_set_volume_level(self, volume: float) -> None:
        """Set the volume level."""
        rvol = int(volume * 50.0)
        await self._zone_zone.set_volume(str(rvol))
 
    @command
    async def async_select_source(self, source: str) -> None:
        """Select the source input for this zone."""
        for source_id, src in self._sources_sources.items():
            if src.name.lower() != source.lower():
                continue
            await self._zone_zone.select_source(source_id)
            break
 
    @command
    async def async_volume_up(self) -> None:
        """Step the volume up."""
        await self._zone_zone.volume_up()
 
    @command
    async def async_volume_down(self) -> None:
        """Step the volume down."""
        await self._zone_zone.volume_down()