media_player.py

Go to the documentation of this file.

"""Support for interface with an LG webOS Smart TV."""
 
from __future__ import annotations
 
import asyncio
from collections.abc import Awaitable, Callable, Coroutine
from contextlib import suppress
from datetime import timedelta
from functools import wraps
from http import HTTPStatus
import logging
from typing import Any, Concatenate, cast
 
from aiowebostv import WebOsClient, WebOsTvPairError
 
from homeassistant import util
from homeassistant.components.media_player import (
    MediaPlayerDeviceClass,
    MediaPlayerEntity,
    MediaPlayerEntityFeature,
    MediaPlayerState,
    MediaType,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import (
    ATTR_ENTITY_ID,
    ATTR_SUPPORTED_FEATURES,
    ENTITY_MATCH_ALL,
    ENTITY_MATCH_NONE,
)
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import HomeAssistantError
from homeassistant.helpers.aiohttp_client import async_get_clientsession
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.dispatcher import async_dispatcher_connect
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.restore_state import RestoreEntity
from homeassistant.helpers.trigger import PluggableAction
 
from . import update_client_key
from .const import (
    ATTR_PAYLOAD,
    ATTR_SOUND_OUTPUT,
    CONF_SOURCES,
    DATA_CONFIG_ENTRY,
    DOMAIN,
    LIVE_TV_APP_ID,
    WEBOSTV_EXCEPTIONS,
)
from .triggers.turn_on import async_get_turn_on_trigger
 
_LOGGER = logging.getLogger(__name__)
 
SUPPORT_WEBOSTV = (
    MediaPlayerEntityFeature.TURN_OFF
    | MediaPlayerEntityFeature.NEXT_TRACK
    | MediaPlayerEntityFeature.PAUSE
    | MediaPlayerEntityFeature.PREVIOUS_TRACK
    | MediaPlayerEntityFeature.SELECT_SOURCE
    | MediaPlayerEntityFeature.PLAY_MEDIA
    | MediaPlayerEntityFeature.PLAY
    | MediaPlayerEntityFeature.STOP
)
 
SUPPORT_WEBOSTV_VOLUME = (
    MediaPlayerEntityFeature.VOLUME_MUTE | MediaPlayerEntityFeature.VOLUME_STEP
)
 
MIN_TIME_BETWEEN_SCANS = timedelta(seconds=10)
MIN_TIME_BETWEEN_FORCED_SCANS = timedelta(seconds=1)
SCAN_INTERVAL = timedelta(seconds=10)
 
 
async def async_setup_entry(
    hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
) -> None:
    """Set up the LG webOS Smart TV platform."""
    client = hass.data[DOMAIN][DATA_CONFIG_ENTRY][entry.entry_id]
    async_add_entities([LgWebOSMediaPlayerEntity(entry, client)])
 
 
def cmd[_T: LgWebOSMediaPlayerEntity, **_P](
    func: Callable[Concatenate[_T, _P], Awaitable[None]],
) -> Callable[Concatenate[_T, _P], Coroutine[Any, Any, None]]:
    """Catch command exceptions."""
 
    @wraps(func)
    async def cmd_wrapper(self: _T, *args: _P.args, **kwargs: _P.kwargs) -> None:
        """Wrap all command methods."""
        try:
            await func(self, *args, **kwargs)
        except WEBOSTV_EXCEPTIONS as exc:
            if self.state != MediaPlayerState.OFF:
                raise HomeAssistantError(
                    f"Error calling {func.__name__} on entity {self.entity_id},"
                    f" state:{self.state}"
                ) from exc
            _LOGGER.warning(
                "Error calling %s on entity %s, state:%s, error: %r",
                func.__name__,
                self.entity_id,
                self.state,
                exc,
            )
 
    return cmd_wrapper
 
 
class LgWebOSMediaPlayerEntity(RestoreEntity, MediaPlayerEntity):
    """Representation of a LG webOS Smart TV."""
 
    _attr_device_class = MediaPlayerDeviceClass.TV
    _attr_has_entity_name = True
    _attr_name = None
 
    def __init__(self, entry: ConfigEntry, client: WebOsClient) -> None:
        """Initialize the webos device."""
        self._entry_entry = entry
        self._client_client = client
        self._attr_assumed_state_attr_assumed_state = True
        self._device_name_device_name = entry.title
        self._attr_unique_id_attr_unique_id = entry.unique_id
        self._sources_sources = entry.options.get(CONF_SOURCES)
 
        # Assume that the TV is not paused
        self._paused_paused = False
        self._turn_on_turn_on = PluggableAction(self.async_write_ha_stateasync_write_ha_state)
        self._current_source_current_source = None
        self._source_list_source_list: dict = {}
 
        self._supported_features_supported_features = MediaPlayerEntityFeature(0)
        self._update_states_update_states()
 
    async def async_added_to_hass(self) -> None:
        """Connect and subscribe to dispatcher signals and state updates."""
        await super().async_added_to_hass()
 
        if (entry := self.registry_entryregistry_entry) and entry.device_id:
            self.async_on_removeasync_on_remove(
                self._turn_on_turn_on.async_register(
                    self.hasshass, async_get_turn_on_trigger(entry.device_id)
                )
            )
 
        self.async_on_removeasync_on_remove(
            async_dispatcher_connect(self.hasshass, DOMAIN, self.async_signal_handlerasync_signal_handler)
        )
 
        await self._client_client.register_state_update_callback(
            self.async_handle_state_updateasync_handle_state_update
        )
 
        if (
            self.statestatestatestatestate == MediaPlayerState.OFF
            and (state := await self.async_get_last_stateasync_get_last_state()) is not None
        ):
            self._supported_features_supported_features = (
                state.attributes.get(
                    ATTR_SUPPORTED_FEATURES, MediaPlayerEntityFeature(0)
                )
                & ~MediaPlayerEntityFeature.TURN_ON
            )
 
    async def async_will_remove_from_hass(self) -> None:
        """Call disconnect on removal."""
        self._client_client.unregister_state_update_callback(self.async_handle_state_updateasync_handle_state_update)
 
    async def async_signal_handler(self, data: dict[str, Any]) -> None:
        """Handle domain-specific signal by calling appropriate method."""
        if (entity_ids := data[ATTR_ENTITY_ID]) == ENTITY_MATCH_NONE:
            return
 
        if entity_ids == ENTITY_MATCH_ALL or self.entity_identity_id in entity_ids:
            params = {
                key: value
                for key, value in data.items()
                if key not in ["entity_id", "method"]
            }
            await getattr(self, data["method"])(**params)
 
    async def async_handle_state_update(self, _client: WebOsClient) -> None:
        """Update state from WebOsClient."""
        self._update_states_update_states()
        self.async_write_ha_stateasync_write_ha_state()
 
    def _update_states(self) -> None:
        """Update entity state attributes."""
        self._update_sources_update_sources()
 
        self._attr_state_attr_state = (
            MediaPlayerState.ON if self._client_client.is_on else MediaPlayerState.OFF
        )
        self._attr_is_volume_muted_attr_is_volume_muted = cast(bool, self._client_client.muted)
 
        self._attr_volume_level_attr_volume_level = None
        if self._client_client.volume is not None:
            self._attr_volume_level_attr_volume_level = cast(float, self._client_client.volume / 100.0)
 
        self._attr_source_attr_source = self._current_source_current_source
        self._attr_source_list_attr_source_list = sorted(self._source_list_source_list)
 
        self._attr_media_content_type_attr_media_content_type = None
        if self._client_client.current_app_id == LIVE_TV_APP_ID:
            self._attr_media_content_type_attr_media_content_type = MediaType.CHANNEL
 
        self._attr_media_title_attr_media_title = None
        if (self._client_client.current_app_id == LIVE_TV_APP_ID) and (
            self._client_client.current_channel is not None
        ):
            self._attr_media_title_attr_media_title = cast(
                str, self._client_client.current_channel.get("channelName")
            )
 
        self._attr_media_image_url_attr_media_image_url = None
        if self._client_client.current_app_id in self._client_client.apps:
            icon: str = self._client_client.apps[self._client_client.current_app_id]["largeIcon"]
            if not icon.startswith("http"):
                icon = self._client_client.apps[self._client_client.current_app_id]["icon"]
            self._attr_media_image_url_attr_media_image_url = icon
 
        if self.statestatestatestatestate != MediaPlayerState.OFF or not self._supported_features_supported_features:
            supported = SUPPORT_WEBOSTV
            if self._client_client.sound_output in ("external_arc", "external_speaker"):
                supported = supported | SUPPORT_WEBOSTV_VOLUME
            elif self._client_client.sound_output != "lineout":
                supported = (
                    supported
                    | SUPPORT_WEBOSTV_VOLUME
                    | MediaPlayerEntityFeature.VOLUME_SET
                )
 
            self._supported_features_supported_features = supported
 
        self._attr_device_info_attr_device_info = DeviceInfo(
            identifiers={(DOMAIN, cast(str, self.unique_idunique_id))},
            manufacturer="LG",
            name=self._device_name_device_name,
        )
 
        self._attr_assumed_state_attr_assumed_state = True
        if (
            self._client_client.is_on
            and self._client_client.media_state is not None
            and self._client_client.media_state.get("foregroundAppInfo") is not None
        ):
            self._attr_assumed_state_attr_assumed_state = False
            for entry in self._client_client.media_state.get("foregroundAppInfo"):
                if entry.get("playState") == "playing":
                    self._attr_state_attr_state = MediaPlayerState.PLAYING
                elif entry.get("playState") == "paused":
                    self._attr_state_attr_state = MediaPlayerState.PAUSED
                elif entry.get("playState") == "unloaded":
                    self._attr_state_attr_state = MediaPlayerState.IDLE
 
        if self._client_client.system_info is not None or self.statestatestatestatestate != MediaPlayerState.OFF:
            maj_v = self._client_client.software_info.get("major_ver")
            min_v = self._client_client.software_info.get("minor_ver")
            if maj_v and min_v:
                self._attr_device_info_attr_device_info["sw_version"] = f"{maj_v}.{min_v}"
 
            if model := self._client_client.system_info.get("modelName"):
                self._attr_device_info_attr_device_info["model"] = model
 
        self._attr_extra_state_attributes_attr_extra_state_attributes = {}
        if self._client_client.sound_output is not None or self.statestatestatestatestate != MediaPlayerState.OFF:
            self._attr_extra_state_attributes_attr_extra_state_attributes = {
                ATTR_SOUND_OUTPUT: self._client_client.sound_output
            }
 
    def _update_sources(self) -> None:
        """Update list of sources from current source, apps, inputs and configured list."""
        source_list = self._source_list_source_list
        self._source_list_source_list = {}
        conf_sources = self._sources_sources
 
        found_live_tv = False
        for app in self._client_client.apps.values():
            if app["id"] == LIVE_TV_APP_ID:
                found_live_tv = True
            if app["id"] == self._client_client.current_app_id:
                self._current_source_current_source = app["title"]
                self._source_list_source_list[app["title"]] = app
            elif (
                not conf_sources
                or app["id"] in conf_sources
                or any(word in app["title"] for word in conf_sources)
                or any(word in app["id"] for word in conf_sources)
            ):
                self._source_list_source_list[app["title"]] = app
 
        for source in self._client_client.inputs.values():
            if source["appId"] == LIVE_TV_APP_ID:
                found_live_tv = True
            if source["appId"] == self._client_client.current_app_id:
                self._current_source_current_source = source["label"]
                self._source_list_source_list[source["label"]] = source
            elif (
                not conf_sources
                or source["label"] in conf_sources
                or any(source["label"].find(word) != -1 for word in conf_sources)
            ):
                self._source_list_source_list[source["label"]] = source
 
        # empty list, TV may be off, keep previous list
        if not self._source_list_source_list and source_list:
            self._source_list_source_list = source_list
        # special handling of live tv since this might
        # not appear in the app or input lists in some cases
        elif not found_live_tv:
            app = {"id": LIVE_TV_APP_ID, "title": "Live TV"}
            if self._client_client.current_app_id == LIVE_TV_APP_ID:
                self._current_source_current_source = app["title"]
                self._source_list_source_list["Live TV"] = app
            elif (
                not conf_sources
                or app["id"] in conf_sources
                or any(word in app["title"] for word in conf_sources)
                or any(word in app["id"] for word in conf_sources)
            ):
                self._source_list_source_list["Live TV"] = app
 
    @util.Throttle(MIN_TIME_BETWEEN_SCANS, MIN_TIME_BETWEEN_FORCED_SCANS)
    async def async_update(self) -> None:
        """Connect."""
        if self._client_client.is_connected():
            return
 
        with suppress(*WEBOSTV_EXCEPTIONS, WebOsTvPairError):
            try:
                await self._client_client.connect()
            except WebOsTvPairError:
                self._entry_entry.async_start_reauth(self.hasshass)
            else:
                update_client_key(self.hasshass, self._entry_entry, self._client_client)
 
    @property
    def supported_features(self) -> MediaPlayerEntityFeature:
        """Flag media player features that are supported."""
        if self._turn_on_turn_on:
            return self._supported_features_supported_features | MediaPlayerEntityFeature.TURN_ON
 
        return self._supported_features_supported_features
 
    @cmd
    async def async_turn_off(self) -> None:
        """Turn off media player."""
        await self._client_client.power_off()
 
    async def async_turn_on(self) -> None:
        """Turn on media player."""
        await self._turn_on_turn_on.async_run(self.hasshass, self._context_context)
 
    @cmd
    async def async_volume_up(self) -> None:
        """Volume up the media player."""
        await self._client_client.volume_up()
 
    @cmd
    async def async_volume_down(self) -> None:
        """Volume down media player."""
        await self._client_client.volume_down()
 
    @cmd
    async def async_set_volume_level(self, volume: float) -> None:
        """Set volume level, range 0..1."""
        tv_volume = int(round(volume * 100))
        await self._client_client.set_volume(tv_volume)
 
    @cmd
    async def async_mute_volume(self, mute: bool) -> None:
        """Send mute command."""
        await self._client_client.set_mute(mute)
 
    @cmd
    async def async_select_sound_output(self, sound_output: str) -> None:
        """Select the sound output."""
        await self._client_client.change_sound_output(sound_output)
 
    @cmd
    async def async_media_play_pause(self) -> None:
        """Simulate play pause media player."""
        if self._paused_paused:
            await self.async_media_playasync_media_playasync_media_play()
        else:
            await self.async_media_pauseasync_media_pauseasync_media_pause()
 
    @cmd
    async def async_select_source(self, source: str) -> None:
        """Select input source."""
        if (source_dict := self._source_list_source_list.get(source)) is None:
            _LOGGER.warning(
                "Source %s not found for %s", source, self._friendly_name_internal_friendly_name_internal()
            )
            return
        if source_dict.get("title"):
            await self._client_client.launch_app(source_dict["id"])
        elif source_dict.get("label"):
            await self._client_client.set_input(source_dict["id"])
 
    @cmd
    async def async_play_media(
        self, media_type: MediaType | str, media_id: str, **kwargs: Any
    ) -> None:
        """Play a piece of media."""
        _LOGGER.debug("Call play media type <%s>, Id <%s>", media_type, media_id)
 
        if media_type == MediaType.CHANNEL:
            _LOGGER.debug("Searching channel")
            partial_match_channel_id = None
            perfect_match_channel_id = None
 
            for channel in self._client_client.channels:
                if media_id == channel["channelNumber"]:
                    perfect_match_channel_id = channel["channelId"]
                    continue
 
                if media_id.lower() == channel["channelName"].lower():
                    perfect_match_channel_id = channel["channelId"]
                    continue
 
                if media_id.lower() in channel["channelName"].lower():
                    partial_match_channel_id = channel["channelId"]
 
            if perfect_match_channel_id is not None:
                _LOGGER.debug(
                    "Switching to channel <%s> with perfect match",
                    perfect_match_channel_id,
                )
                await self._client_client.set_channel(perfect_match_channel_id)
            elif partial_match_channel_id is not None:
                _LOGGER.debug(
                    "Switching to channel <%s> with partial match",
                    partial_match_channel_id,
                )
                await self._client_client.set_channel(partial_match_channel_id)
 
    @cmd
    async def async_media_play(self) -> None:
        """Send play command."""
        self._paused_paused = False
        await self._client_client.play()
 
    @cmd
    async def async_media_pause(self) -> None:
        """Send media pause command to media player."""
        self._paused_paused = True
        await self._client_client.pause()
 
    @cmd
    async def async_media_stop(self) -> None:
        """Send stop command to media player."""
        await self._client_client.stop()
 
    @cmd
    async def async_media_next_track(self) -> None:
        """Send next track command."""
        if self._client_client.current_app_id == LIVE_TV_APP_ID:
            await self._client_client.channel_up()
        else:
            await self._client_client.fast_forward()
 
    @cmd
    async def async_media_previous_track(self) -> None:
        """Send the previous track command."""
        if self._client_client.current_app_id == LIVE_TV_APP_ID:
            await self._client_client.channel_down()
        else:
            await self._client_client.rewind()
 
    @cmd
    async def async_button(self, button: str) -> None:
        """Send a button press."""
        await self._client_client.button(button)
 
    @cmd
    async def async_command(self, command: str, **kwargs: Any) -> None:
        """Send a command."""
        await self._client_client.request(command, payload=kwargs.get(ATTR_PAYLOAD))
 
    async def _async_fetch_image(self, url: str) -> tuple[bytes | None, str | None]:
        """Retrieve an image.
 
        webOS uses self-signed certificates, thus we need to use an empty
        SSLContext to bypass validation errors if url starts with https.
        """
        content = None
 
        websession = async_get_clientsession(self.hasshass)
        with suppress(TimeoutError):
            async with asyncio.timeout(10):
                response = await websession.get(url, ssl=False)
                if response.status == HTTPStatus.OK:
                    content = await response.read()
 
        if content is None:
            _LOGGER.warning("Error retrieving proxied image from %s", url)
 
        return content, None