fc23b4f83f
* migrate webostv to new aiopylgtv version of the library and add support for generic commands, input/button commands, and callback state updates * update requirements * cleanup and bump aiopylgtv version * update webostv unit tests * make webostv unit tests work with python 3.7 * cleanup for code checks * cleanup and code review * make all client request functions coroutines * make host required for webostv configuration * remove generic command and button functionality plus related cleanup * fix previous track function * update unit tests * fix imports for unit tests * update unit test * further unit test updates * remove unnecessary setup call in unit tests * restore previous behaviour with client key config file in hass configuration directory
408 lines
13 KiB
Python
408 lines
13 KiB
Python
"""Support for interface with an LG webOS Smart TV."""
|
|
import asyncio
|
|
from datetime import timedelta
|
|
from functools import wraps
|
|
import logging
|
|
|
|
from aiopylgtv import PyLGTVCmdException, PyLGTVPairException
|
|
from websockets.exceptions import ConnectionClosed
|
|
|
|
from homeassistant import util
|
|
from homeassistant.components.media_player import MediaPlayerDevice
|
|
from homeassistant.components.media_player.const import (
|
|
MEDIA_TYPE_CHANNEL,
|
|
SUPPORT_NEXT_TRACK,
|
|
SUPPORT_PAUSE,
|
|
SUPPORT_PLAY,
|
|
SUPPORT_PLAY_MEDIA,
|
|
SUPPORT_PREVIOUS_TRACK,
|
|
SUPPORT_SELECT_SOURCE,
|
|
SUPPORT_TURN_OFF,
|
|
SUPPORT_TURN_ON,
|
|
SUPPORT_VOLUME_MUTE,
|
|
SUPPORT_VOLUME_SET,
|
|
SUPPORT_VOLUME_STEP,
|
|
)
|
|
from homeassistant.const import (
|
|
CONF_CUSTOMIZE,
|
|
CONF_HOST,
|
|
CONF_NAME,
|
|
STATE_OFF,
|
|
STATE_PAUSED,
|
|
STATE_PLAYING,
|
|
)
|
|
from homeassistant.helpers.script import Script
|
|
|
|
from . import CONF_ON_ACTION, CONF_SOURCES, DOMAIN
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
LIVETV_APP_ID = "com.webos.app.livetv"
|
|
|
|
|
|
SUPPORT_WEBOSTV = (
|
|
SUPPORT_TURN_OFF
|
|
| SUPPORT_NEXT_TRACK
|
|
| SUPPORT_PAUSE
|
|
| SUPPORT_PREVIOUS_TRACK
|
|
| SUPPORT_VOLUME_MUTE
|
|
| SUPPORT_VOLUME_SET
|
|
| SUPPORT_VOLUME_STEP
|
|
| SUPPORT_SELECT_SOURCE
|
|
| SUPPORT_PLAY_MEDIA
|
|
| SUPPORT_PLAY
|
|
)
|
|
|
|
MIN_TIME_BETWEEN_SCANS = timedelta(seconds=10)
|
|
MIN_TIME_BETWEEN_FORCED_SCANS = timedelta(seconds=1)
|
|
|
|
|
|
async def async_setup_platform(hass, config, async_add_entities, discovery_info=None):
|
|
"""Set up the LG WebOS TV platform."""
|
|
|
|
if discovery_info is None:
|
|
return
|
|
|
|
host = discovery_info[CONF_HOST]
|
|
name = discovery_info[CONF_NAME]
|
|
customize = discovery_info[CONF_CUSTOMIZE]
|
|
turn_on_action = discovery_info.get(CONF_ON_ACTION)
|
|
|
|
client = hass.data[DOMAIN][host]["client"]
|
|
on_script = Script(hass, turn_on_action) if turn_on_action else None
|
|
|
|
entity = LgWebOSMediaPlayerEntity(client, name, customize, on_script)
|
|
|
|
async_add_entities([entity], update_before_add=False)
|
|
|
|
|
|
def cmd(func):
|
|
"""Catch command exceptions."""
|
|
|
|
@wraps(func)
|
|
async def wrapper(obj, *args, **kwargs):
|
|
"""Wrap all command methods."""
|
|
try:
|
|
await func(obj, *args, **kwargs)
|
|
except (
|
|
asyncio.TimeoutError,
|
|
asyncio.CancelledError,
|
|
PyLGTVCmdException,
|
|
) as exc:
|
|
# If TV is off, we expect calls to fail.
|
|
if obj.state == STATE_OFF:
|
|
level = logging.INFO
|
|
else:
|
|
level = logging.ERROR
|
|
_LOGGER.log(
|
|
level,
|
|
"Error calling %s on entity %s: %r",
|
|
func.__name__,
|
|
obj.entity_id,
|
|
exc,
|
|
)
|
|
|
|
return wrapper
|
|
|
|
|
|
class LgWebOSMediaPlayerEntity(MediaPlayerDevice):
|
|
"""Representation of a LG WebOS TV."""
|
|
|
|
def __init__(self, client, name, customize, on_script=None):
|
|
"""Initialize the webos device."""
|
|
self._client = client
|
|
self._name = name
|
|
self._customize = customize
|
|
self._on_script = on_script
|
|
|
|
# Assume that the TV is not muted
|
|
self._muted = False
|
|
# Assume that the TV is in Play mode
|
|
self._playing = True
|
|
self._volume = 0
|
|
self._current_source = None
|
|
self._current_source_id = None
|
|
self._state = None
|
|
self._source_list = {}
|
|
self._app_list = {}
|
|
self._input_list = {}
|
|
self._channel = None
|
|
self._last_icon = None
|
|
|
|
async def async_added_to_hass(self):
|
|
"""Connect and subscribe to state updates."""
|
|
await self._client.register_state_update_callback(
|
|
self.async_handle_state_update
|
|
)
|
|
|
|
# force state update if needed
|
|
if self._state is None:
|
|
await self.async_handle_state_update()
|
|
|
|
async def async_will_remove_from_hass(self):
|
|
"""Call disconnect on removal."""
|
|
self._client.unregister_state_update_callback(self.async_handle_state_update)
|
|
|
|
async def async_handle_state_update(self):
|
|
"""Update state from WebOsClient."""
|
|
self._current_source_id = self._client.current_appId
|
|
self._muted = self._client.muted
|
|
self._volume = self._client.volume
|
|
self._channel = self._client.current_channel
|
|
self._app_list = self._client.apps
|
|
self._input_list = self._client.inputs
|
|
|
|
if self._current_source_id == "":
|
|
self._state = STATE_OFF
|
|
else:
|
|
self._state = STATE_PLAYING
|
|
|
|
self.update_sources()
|
|
|
|
self.async_schedule_update_ha_state(False)
|
|
|
|
def update_sources(self):
|
|
"""Update list of sources from current source, apps, inputs and configured list."""
|
|
self._source_list = {}
|
|
conf_sources = self._customize[CONF_SOURCES]
|
|
|
|
for app in self._app_list.values():
|
|
if app["id"] == self._current_source_id:
|
|
self._current_source = app["title"]
|
|
self._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[app["title"]] = app
|
|
|
|
for source in self._input_list.values():
|
|
if source["appId"] == self._current_source_id:
|
|
self._current_source = source["label"]
|
|
self._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["label"]] = source
|
|
|
|
@util.Throttle(MIN_TIME_BETWEEN_SCANS, MIN_TIME_BETWEEN_FORCED_SCANS)
|
|
async def async_update(self):
|
|
"""Connect."""
|
|
if not self._client.is_connected():
|
|
try:
|
|
await self._client.connect()
|
|
except (
|
|
OSError,
|
|
ConnectionClosed,
|
|
ConnectionRefusedError,
|
|
asyncio.TimeoutError,
|
|
asyncio.CancelledError,
|
|
PyLGTVPairException,
|
|
PyLGTVCmdException,
|
|
):
|
|
pass
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the device."""
|
|
return self._name
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the state of the device."""
|
|
return self._state
|
|
|
|
@property
|
|
def is_volume_muted(self):
|
|
"""Boolean if volume is currently muted."""
|
|
return self._muted
|
|
|
|
@property
|
|
def volume_level(self):
|
|
"""Volume level of the media player (0..1)."""
|
|
return self._volume / 100.0
|
|
|
|
@property
|
|
def source(self):
|
|
"""Return the current input source."""
|
|
return self._current_source
|
|
|
|
@property
|
|
def source_list(self):
|
|
"""List of available input sources."""
|
|
return sorted(self._source_list.keys())
|
|
|
|
@property
|
|
def media_content_type(self):
|
|
"""Content type of current playing media."""
|
|
return MEDIA_TYPE_CHANNEL
|
|
|
|
@property
|
|
def media_title(self):
|
|
"""Title of current playing media."""
|
|
if (self._channel is not None) and ("channelName" in self._channel):
|
|
return self._channel["channelName"]
|
|
return None
|
|
|
|
@property
|
|
def media_image_url(self):
|
|
"""Image url of current playing media."""
|
|
if self._current_source_id in self._app_list:
|
|
icon = self._app_list[self._current_source_id]["largeIcon"]
|
|
if not icon.startswith("http"):
|
|
icon = self._app_list[self._current_source_id]["icon"]
|
|
|
|
# 'icon' holds a URL with a transient key. Avoid unnecessary
|
|
# updates by returning the same URL until the image changes.
|
|
if self._last_icon and (
|
|
icon.split("/")[-1] == self._last_icon.split("/")[-1]
|
|
):
|
|
return self._last_icon
|
|
self._last_icon = icon
|
|
return icon
|
|
return None
|
|
|
|
@property
|
|
def supported_features(self):
|
|
"""Flag media player features that are supported."""
|
|
if self._on_script:
|
|
return SUPPORT_WEBOSTV | SUPPORT_TURN_ON
|
|
return SUPPORT_WEBOSTV
|
|
|
|
@cmd
|
|
async def async_turn_off(self):
|
|
"""Turn off media player."""
|
|
await self._client.power_off()
|
|
|
|
async def async_turn_on(self):
|
|
"""Turn on the media player."""
|
|
connected = self._client.is_connected()
|
|
if self._on_script:
|
|
await self._on_script.async_run()
|
|
|
|
# if connection was already active
|
|
# ensure is still alive
|
|
if connected:
|
|
await self._client.get_current_app()
|
|
|
|
@cmd
|
|
async def async_volume_up(self):
|
|
"""Volume up the media player."""
|
|
await self._client.volume_up()
|
|
|
|
@cmd
|
|
async def async_volume_down(self):
|
|
"""Volume down media player."""
|
|
await self._client.volume_down()
|
|
|
|
@cmd
|
|
async def async_set_volume_level(self, volume):
|
|
"""Set volume level, range 0..1."""
|
|
tv_volume = volume * 100
|
|
await self._client.set_volume(tv_volume)
|
|
|
|
@cmd
|
|
async def async_mute_volume(self, mute):
|
|
"""Send mute command."""
|
|
self._muted = mute
|
|
await self._client.set_mute(mute)
|
|
|
|
@cmd
|
|
async def async_media_play_pause(self):
|
|
"""Simulate play pause media player."""
|
|
if self._playing:
|
|
await self.media_pause()
|
|
else:
|
|
await self.media_play()
|
|
|
|
@cmd
|
|
async def async_select_source(self, source):
|
|
"""Select input source."""
|
|
source_dict = self._source_list.get(source)
|
|
if source_dict is None:
|
|
_LOGGER.warning("Source %s not found for %s", source, self.name)
|
|
return
|
|
self._current_source_id = source_dict["id"]
|
|
if source_dict.get("title"):
|
|
self._current_source = source_dict["title"]
|
|
await self._client.launch_app(source_dict["id"])
|
|
elif source_dict.get("label"):
|
|
self._current_source = source_dict["label"]
|
|
await self._client.set_input(source_dict["id"])
|
|
|
|
@cmd
|
|
async def async_play_media(self, media_type, media_id, **kwargs):
|
|
"""Play a piece of media."""
|
|
_LOGGER.debug("Call play media type <%s>, Id <%s>", media_type, media_id)
|
|
|
|
if media_type == MEDIA_TYPE_CHANNEL:
|
|
_LOGGER.debug("Searching channel...")
|
|
partial_match_channel_id = None
|
|
perfect_match_channel_id = None
|
|
|
|
for channel in self._client.get_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.info(
|
|
"Switching to channel <%s> with perfect match",
|
|
perfect_match_channel_id,
|
|
)
|
|
await self._client.set_channel(perfect_match_channel_id)
|
|
elif partial_match_channel_id is not None:
|
|
_LOGGER.info(
|
|
"Switching to channel <%s> with partial match",
|
|
partial_match_channel_id,
|
|
)
|
|
await self._client.set_channel(partial_match_channel_id)
|
|
|
|
@cmd
|
|
async def async_media_play(self):
|
|
"""Send play command."""
|
|
self._playing = True
|
|
self._state = STATE_PLAYING
|
|
await self._client.play()
|
|
|
|
@cmd
|
|
async def async_media_pause(self):
|
|
"""Send media pause command to media player."""
|
|
self._playing = False
|
|
self._state = STATE_PAUSED
|
|
await self._client.pause()
|
|
|
|
@cmd
|
|
async def async_media_stop(self):
|
|
"""Send stop command to media player."""
|
|
await self._client.stop()
|
|
|
|
@cmd
|
|
async def async_media_next_track(self):
|
|
"""Send next track command."""
|
|
current_input = self._client.get_input()
|
|
if current_input == LIVETV_APP_ID:
|
|
await self._client.channel_up()
|
|
else:
|
|
await self._client.fast_forward()
|
|
|
|
@cmd
|
|
async def async_media_previous_track(self):
|
|
"""Send the previous track command."""
|
|
current_input = self._client.get_input()
|
|
if current_input == LIVETV_APP_ID:
|
|
await self._client.channel_down()
|
|
else:
|
|
await self._client.rewind()
|