Cast unique_id and async discovery (#12474)
* Cast unique_id and async discovery * Lazily load chromecasts * Lint * Fixes & Improvements * Fixes * Improve disconnects cast.disconnect with blocking=False does **not** do I/O; it simply sets an event for the socket client looper * Add tests * Remove unnecessary calls * Lint * Fix use of hass object
This commit is contained in:
1 parent
7f5ca314ec
commit
2261ce30e3
2 files changed
+391
-128
No files matched your search
@@ -5,10 +5,16 @@ For more details about this platform, please refer to the documentation at
|
||||
https://home-assistant.io/components/media_player.cast/
|
||||
"""
|
||||
# pylint: disable=import-error
|
||||
import asyncio
|
||||
import logging
|
||||
import threading
|
||||
|
||||
import voluptuous as vol
|
||||
|
||||
from homeassistant.helpers.typing import HomeAssistantType, ConfigType
|
||||
from homeassistant.core import callback
|
||||
from homeassistant.helpers.dispatcher import (dispatcher_send,
|
||||
async_dispatcher_connect)
|
||||
from homeassistant.components.media_player import (
|
||||
MEDIA_TYPE_MUSIC, MEDIA_TYPE_TVSHOW, MEDIA_TYPE_VIDEO, SUPPORT_NEXT_TRACK,
|
||||
SUPPORT_PAUSE, SUPPORT_PLAY_MEDIA, SUPPORT_PREVIOUS_TRACK,
|
||||
@@ -16,7 +22,7 @@ from homeassistant.components.media_player import (
|
||||
SUPPORT_STOP, SUPPORT_PLAY, MediaPlayerDevice, PLATFORM_SCHEMA)
|
||||
from homeassistant.const import (
|
||||
CONF_HOST, STATE_IDLE, STATE_OFF, STATE_PAUSED, STATE_PLAYING,
|
||||
STATE_UNKNOWN)
|
||||
STATE_UNKNOWN, EVENT_HOMEASSISTANT_STOP)
|
||||
import homeassistant.helpers.config_validation as cv
|
||||
import homeassistant.util.dt as dt_util
|
||||
|
||||
@@ -33,7 +39,13 @@ SUPPORT_CAST = SUPPORT_PAUSE | SUPPORT_VOLUME_SET | SUPPORT_VOLUME_MUTE | \
|
||||
SUPPORT_TURN_ON | SUPPORT_TURN_OFF | SUPPORT_PREVIOUS_TRACK | \
|
||||
SUPPORT_NEXT_TRACK | SUPPORT_PLAY_MEDIA | SUPPORT_STOP | SUPPORT_PLAY
|
||||
|
||||
KNOWN_HOSTS_KEY = 'cast_known_hosts'
|
||||
INTERNAL_DISCOVERY_RUNNING_KEY = 'cast_discovery_running'
|
||||
# UUID -> CastDevice mapping; cast devices without UUID are not stored
|
||||
ADDED_CAST_DEVICES_KEY = 'cast_added_cast_devices'
|
||||
# Stores every discovered (host, port, uuid)
|
||||
KNOWN_CHROMECASTS_KEY = 'cast_all_chromecasts'
|
||||
|
||||
SIGNAL_CAST_DISCOVERED = 'cast_discovered'
|
||||
|
||||
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
||||
vol.Optional(CONF_HOST): cv.string,
|
||||
@@ -41,67 +53,144 @@ PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
||||
})
|
||||
|
||||
|
||||
# pylint: disable=unused-argument
|
||||
def setup_platform(hass, config, add_devices, discovery_info=None):
|
||||
def _setup_internal_discovery(hass: HomeAssistantType) -> None:
|
||||
"""Set up the pychromecast internal discovery."""
|
||||
hass.data.setdefault(INTERNAL_DISCOVERY_RUNNING_KEY, threading.Lock())
|
||||
if not hass.data[INTERNAL_DISCOVERY_RUNNING_KEY].acquire(blocking=False):
|
||||
# Internal discovery is already running
|
||||
return
|
||||
|
||||
import pychromecast
|
||||
|
||||
def internal_callback(name):
|
||||
"""Called when zeroconf has discovered a new chromecast."""
|
||||
mdns = listener.services[name]
|
||||
ip_address, port, uuid, _, _ = mdns
|
||||
key = (ip_address, port, uuid)
|
||||
|
||||
if key in hass.data[KNOWN_CHROMECASTS_KEY]:
|
||||
_LOGGER.debug("Discovered previous chromecast %s", mdns)
|
||||
return
|
||||
|
||||
_LOGGER.debug("Discovered new chromecast %s", mdns)
|
||||
try:
|
||||
# pylint: disable=protected-access
|
||||
chromecast = pychromecast._get_chromecast_from_host(
|
||||
mdns, blocking=True)
|
||||
except pychromecast.ChromecastConnectionError:
|
||||
_LOGGER.debug("Can't set up cast with mDNS info %s. "
|
||||
"Assuming it's not a Chromecast", mdns)
|
||||
return
|
||||
hass.data[KNOWN_CHROMECASTS_KEY][key] = chromecast
|
||||
dispatcher_send(hass, SIGNAL_CAST_DISCOVERED, chromecast)
|
||||
|
||||
_LOGGER.debug("Starting internal pychromecast discovery.")
|
||||
listener, browser = pychromecast.start_discovery(internal_callback)
|
||||
|
||||
def stop_discovery(event):
|
||||
"""Stop discovery of new chromecasts."""
|
||||
pychromecast.stop_discovery(browser)
|
||||
hass.data[INTERNAL_DISCOVERY_RUNNING_KEY].release()
|
||||
|
||||
hass.bus.listen_once(EVENT_HOMEASSISTANT_STOP, stop_discovery)
|
||||
|
||||
|
||||
@callback
|
||||
def _async_create_cast_device(hass, chromecast):
|
||||
"""Create a CastDevice Entity from the chromecast object.
|
||||
|
||||
Returns None if the cast device has already been added. Additionally,
|
||||
automatically updates existing chromecast entities.
|
||||
"""
|
||||
if chromecast.uuid is None:
|
||||
# Found a cast without UUID, we don't store it because we won't be able
|
||||
# to update it anyway.
|
||||
return CastDevice(chromecast)
|
||||
|
||||
# Found a cast with UUID
|
||||
added_casts = hass.data[ADDED_CAST_DEVICES_KEY]
|
||||
old_cast_device = added_casts.get(chromecast.uuid)
|
||||
if old_cast_device is None:
|
||||
# -> New cast device
|
||||
cast_device = CastDevice(chromecast)
|
||||
added_casts[chromecast.uuid] = cast_device
|
||||
return cast_device
|
||||
|
||||
old_key = (old_cast_device.cast.host,
|
||||
old_cast_device.cast.port,
|
||||
old_cast_device.cast.uuid)
|
||||
new_key = (chromecast.host, chromecast.port, chromecast.uuid)
|
||||
|
||||
if old_key == new_key:
|
||||
# Re-discovered with same data, ignore
|
||||
return None
|
||||
|
||||
# -> Cast device changed host
|
||||
# Remove old pychromecast.Chromecast from global list, because it isn't
|
||||
# valid anymore
|
||||
old_cast_device.async_set_chromecast(chromecast)
|
||||
return None
|
||||
|
||||
|
||||
@asyncio.coroutine
|
||||
def async_setup_platform(hass: HomeAssistantType, config: ConfigType,
|
||||
async_add_devices, discovery_info=None):
|
||||
"""Set up the cast platform."""
|
||||
import pychromecast
|
||||
|
||||
# Import CEC IGNORE attributes
|
||||
pychromecast.IGNORE_CEC += config.get(CONF_IGNORE_CEC, [])
|
||||
hass.data.setdefault(ADDED_CAST_DEVICES_KEY, {})
|
||||
hass.data.setdefault(KNOWN_CHROMECASTS_KEY, {})
|
||||
|
||||
known_hosts = hass.data.get(KNOWN_HOSTS_KEY)
|
||||
if known_hosts is None:
|
||||
known_hosts = hass.data[KNOWN_HOSTS_KEY] = []
|
||||
|
||||
# None -> use discovery; (host, port) -> manually specify chromecast.
|
||||
want_host = None
|
||||
if discovery_info:
|
||||
host = (discovery_info.get('host'), discovery_info.get('port'))
|
||||
|
||||
if host in known_hosts:
|
||||
return
|
||||
|
||||
hosts = [host]
|
||||
|
||||
want_host = (discovery_info.get('host'), discovery_info.get('port'))
|
||||
elif CONF_HOST in config:
|
||||
host = (config.get(CONF_HOST), DEFAULT_PORT)
|
||||
want_host = (config.get(CONF_HOST), DEFAULT_PORT)
|
||||
|
||||
if host in known_hosts:
|
||||
return
|
||||
enable_discovery = False
|
||||
if want_host is None:
|
||||
# We were explicitly told to enable pychromecast discovery.
|
||||
enable_discovery = True
|
||||
elif want_host[1] != DEFAULT_PORT:
|
||||
# We're trying to add a group, so we have to use pychromecast's
|
||||
# discovery to get the correct friendly name.
|
||||
enable_discovery = True
|
||||
|
||||
hosts = [host]
|
||||
if enable_discovery:
|
||||
@callback
|
||||
def async_cast_discovered(chromecast):
|
||||
"""Callback for when a new chromecast is discovered."""
|
||||
if want_host is not None and \
|
||||
(chromecast.host, chromecast.port) != want_host:
|
||||
return # for groups, only add requested device
|
||||
cast_device = _async_create_cast_device(hass, chromecast)
|
||||
|
||||
if cast_device is not None:
|
||||
async_add_devices([cast_device])
|
||||
|
||||
async_dispatcher_connect(hass, SIGNAL_CAST_DISCOVERED,
|
||||
async_cast_discovered)
|
||||
# Re-play the callback for all past chromecasts, store the objects in
|
||||
# a list to avoid concurrent modification resulting in exception.
|
||||
for chromecast in list(hass.data[KNOWN_CHROMECASTS_KEY].values()):
|
||||
async_cast_discovered(chromecast)
|
||||
|
||||
hass.async_add_job(_setup_internal_discovery, hass)
|
||||
else:
|
||||
hosts = [tuple(dev[:2]) for dev in pychromecast.discover_chromecasts()
|
||||
if tuple(dev[:2]) not in known_hosts]
|
||||
|
||||
casts = []
|
||||
|
||||
# get_chromecasts() returns Chromecast objects with the correct friendly
|
||||
# name for grouped devices
|
||||
all_chromecasts = pychromecast.get_chromecasts()
|
||||
|
||||
for host in hosts:
|
||||
(_, port) = host
|
||||
found = [device for device in all_chromecasts
|
||||
if (device.host, device.port) == host]
|
||||
if found:
|
||||
try:
|
||||
casts.append(CastDevice(found[0]))
|
||||
known_hosts.append(host)
|
||||
except pychromecast.ChromecastConnectionError:
|
||||
pass
|
||||
|
||||
# do not add groups using pychromecast.Chromecast as it leads to names
|
||||
# collision since pychromecast.Chromecast will get device name instead
|
||||
# of group name
|
||||
elif port == DEFAULT_PORT:
|
||||
try:
|
||||
# add the device anyway, get_chromecasts couldn't find it
|
||||
casts.append(CastDevice(pychromecast.Chromecast(*host)))
|
||||
known_hosts.append(host)
|
||||
except pychromecast.ChromecastConnectionError:
|
||||
pass
|
||||
|
||||
add_devices(casts)
|
||||
# Manually add a "normal" Chromecast, we can do that without discovery.
|
||||
try:
|
||||
chromecast = pychromecast.Chromecast(*want_host)
|
||||
except pychromecast.ChromecastConnectionError:
|
||||
_LOGGER.warning("Can't set up chromecast on %s", want_host[0])
|
||||
raise
|
||||
key = (chromecast.host, chromecast.port, chromecast.uuid)
|
||||
cast_device = _async_create_cast_device(hass, chromecast)
|
||||
if cast_device is not None:
|
||||
hass.data[KNOWN_CHROMECASTS_KEY][key] = chromecast
|
||||
async_add_devices([cast_device])
|
||||
|
||||
|
||||
class CastDevice(MediaPlayerDevice):
|
||||
@@ -109,16 +198,13 @@ class CastDevice(MediaPlayerDevice):
|
||||
|
||||
def __init__(self, chromecast):
|
||||
"""Initialize the Cast device."""
|
||||
self.cast = chromecast
|
||||
|
||||
self.cast.socket_client.receiver_controller.register_status_listener(
|
||||
self)
|
||||
self.cast.socket_client.media_controller.register_status_listener(self)
|
||||
|
||||
self.cast_status = self.cast.status
|
||||
self.media_status = self.cast.media_controller.status
|
||||
self.cast = None # type: pychromecast.Chromecast
|
||||
self.cast_status = None
|
||||
self.media_status = None
|
||||
self.media_status_received = None
|
||||
|
||||
self.async_set_chromecast(chromecast)
|
||||
|
||||
@property
|
||||
def should_poll(self):
|
||||
"""No polling needed."""
|
||||
@@ -325,3 +411,39 @@ class CastDevice(MediaPlayerDevice):
|
||||
self.media_status = status
|
||||
self.media_status_received = dt_util.utcnow()
|
||||
self.schedule_update_ha_state()
|
||||
|
||||
@property
|
||||
def unique_id(self) -> str:
|
||||
"""Return an unique ID."""
|
||||
if self.cast.uuid is not None:
|
||||
return str(self.cast.uuid)
|
||||
return None
|
||||
|
||||
@callback
|
||||
def async_set_chromecast(self, chromecast):
|
||||
"""Set the internal Chromecast object and disconnect the previous."""
|
||||
self._async_disconnect()
|
||||
|
||||
self.cast = chromecast
|
||||
|
||||
self.cast.socket_client.receiver_controller.register_status_listener(
|
||||
self)
|
||||
self.cast.socket_client.media_controller.register_status_listener(self)
|
||||
|
||||
self.cast_status = self.cast.status
|
||||
self.media_status = self.cast.media_controller.status
|
||||
|
||||
@asyncio.coroutine
|
||||
def async_will_remove_from_hass(self):
|
||||
"""Disconnect Chromecast object when removed."""
|
||||
self._async_disconnect()
|
||||
|
||||
@callback
|
||||
def _async_disconnect(self):
|
||||
"""Disconnect Chromecast object if it is set."""
|
||||
if self.cast is None:
|
||||
return
|
||||
_LOGGER.debug("Disconnecting existing chromecast object")
|
||||
old_key = (self.cast.host, self.cast.port, self.cast.uuid)
|
||||
self.hass.data[KNOWN_CHROMECASTS_KEY].pop(old_key)
|
||||
self.cast.disconnect(blocking=False)
|
||||
Reference in new issue
Block a user