media_player.py

Go to the documentation of this file.

"""Media player support for Panasonic Viera TV."""
 
from __future__ import annotations
 
import logging
from typing import Any
 
from panasonic_viera import Keys
 
from homeassistant.components import media_source
from homeassistant.components.media_player import (
    BrowseMedia,
    MediaPlayerDeviceClass,
    MediaPlayerEntity,
    MediaPlayerEntityFeature,
    MediaPlayerState,
    MediaType,
    async_process_play_media_url,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CONF_NAME
from homeassistant.core import HomeAssistant
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from .const import (
    ATTR_DEVICE_INFO,
    ATTR_MANUFACTURER,
    ATTR_MODEL_NUMBER,
    ATTR_REMOTE,
    ATTR_UDN,
    DEFAULT_MANUFACTURER,
    DEFAULT_MODEL_NUMBER,
    DOMAIN,
)
 
_LOGGER = logging.getLogger(__name__)
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up Panasonic Viera TV from a config entry."""
 
    config = config_entry.data
 
    remote = hass.data[DOMAIN][config_entry.entry_id][ATTR_REMOTE]
    name = config[CONF_NAME]
    device_info = config[ATTR_DEVICE_INFO]
 
    tv_device = PanasonicVieraTVEntity(remote, name, device_info)
    async_add_entities([tv_device])
 
 
class PanasonicVieraTVEntity(MediaPlayerEntity):
    """Representation of a Panasonic Viera TV."""
 
    _attr_supported_features = (
        MediaPlayerEntityFeature.PAUSE
        | MediaPlayerEntityFeature.VOLUME_STEP
        | MediaPlayerEntityFeature.VOLUME_SET
        | MediaPlayerEntityFeature.VOLUME_MUTE
        | MediaPlayerEntityFeature.PREVIOUS_TRACK
        | MediaPlayerEntityFeature.NEXT_TRACK
        | MediaPlayerEntityFeature.TURN_OFF
        | MediaPlayerEntityFeature.TURN_ON
        | MediaPlayerEntityFeature.PLAY
        | MediaPlayerEntityFeature.PLAY_MEDIA
        | MediaPlayerEntityFeature.STOP
        | MediaPlayerEntityFeature.BROWSE_MEDIA
    )
    _attr_has_entity_name = True
    _attr_name = None
    _attr_device_class = MediaPlayerDeviceClass.TV
 
    def __init__(self, remote, name, device_info):
        """Initialize the entity."""
        self._remote_remote = remote
        if device_info is not None:
            self._attr_device_info_attr_device_info = DeviceInfo(
                identifiers={(DOMAIN, device_info[ATTR_UDN])},
                manufacturer=device_info.get(ATTR_MANUFACTURER, DEFAULT_MANUFACTURER),
                model=device_info.get(ATTR_MODEL_NUMBER, DEFAULT_MODEL_NUMBER),
                name=name,
            )
            self._attr_unique_id_attr_unique_id = device_info[ATTR_UDN]
        else:
            self._attr_name_attr_name = name
 
    @property
    def state(self) -> MediaPlayerState | None:
        """Return the state of the device."""
        return self._remote_remote.state
 
    @property
    def available(self) -> bool:
        """Return True if the device is available."""
        return self._remote_remote.available
 
    @property
    def volume_level(self) -> float | None:
        """Volume level of the media player (0..1)."""
        return self._remote_remote.volume
 
    @property
    def is_volume_muted(self) -> bool | None:
        """Boolean if volume is currently muted."""
        return self._remote_remote.muted
 
    async def async_update(self) -> None:
        """Retrieve the latest data."""
        await self._remote_remote.async_update()
 
    async def async_turn_on(self) -> None:
        """Turn on the media player."""
        await self._remote_remote.async_turn_on(context=self._context_context)
 
    async def async_turn_off(self) -> None:
        """Turn off media player."""
        await self._remote_remote.async_turn_off()
 
    async def async_volume_up(self) -> None:
        """Volume up the media player."""
        await self._remote_remote.async_send_key(Keys.VOLUME_UP)
 
    async def async_volume_down(self) -> None:
        """Volume down media player."""
        await self._remote_remote.async_send_key(Keys.VOLUME_DOWN)
 
    async def async_mute_volume(self, mute: bool) -> None:
        """Send mute command."""
        await self._remote_remote.async_set_mute(mute)
 
    async def async_set_volume_level(self, volume: float) -> None:
        """Set volume level, range 0..1."""
        await self._remote_remote.async_set_volume(volume)
 
    async def async_media_play_pause(self) -> None:
        """Simulate play pause media player."""
        if self._remote_remote.playing:
            await self._remote_remote.async_send_key(Keys.PAUSE)
            self._remote_remote.playing = False
        else:
            await self._remote_remote.async_send_key(Keys.PLAY)
            self._remote_remote.playing = True
 
    async def async_media_play(self) -> None:
        """Send play command."""
        await self._remote_remote.async_send_key(Keys.PLAY)
        self._remote_remote.playing = True
 
    async def async_media_pause(self) -> None:
        """Send pause command."""
        await self._remote_remote.async_send_key(Keys.PAUSE)
        self._remote_remote.playing = False
 
    async def async_media_stop(self) -> None:
        """Stop playback."""
        await self._remote_remote.async_send_key(Keys.STOP)
 
    async def async_media_next_track(self) -> None:
        """Send the fast forward command."""
        await self._remote_remote.async_send_key(Keys.FAST_FORWARD)
 
    async def async_media_previous_track(self) -> None:
        """Send the rewind command."""
        await self._remote_remote.async_send_key(Keys.REWIND)
 
    async def async_play_media(
        self, media_type: MediaType | str, media_id: str, **kwargs: Any
    ) -> None:
        """Play media."""
        if media_source.is_media_source_id(media_id):
            media_type = MediaType.URL
            play_item = await media_source.async_resolve_media(
                self.hasshass, media_id, self.entity_identity_id
            )
            media_id = play_item.url
 
        if media_type != MediaType.URL:
            _LOGGER.warning("Unsupported media_type: %s", media_type)
            return
 
        media_id = async_process_play_media_url(self.hasshass, media_id)
        await self._remote_remote.async_play_media(media_type, media_id)
 
    async def async_browse_media(
        self,
        media_content_type: MediaType | str | None = None,
        media_content_id: str | None = None,
    ) -> BrowseMedia:
        """Implement the websocket media browsing helper."""
        return await media_source.async_browse_media(self.hasshass, media_content_id)