Songpal code and test improvement (#35318)
* Use tests.async_mock instead of asynctest * Remove unnecessary existence check * Improve songpal service registering * Add tests * Seperate device api from entity api * Improve disconnect log messages * Improve tests * Rename SongpalDevice to SongpalEntity * Improve reconnecting * Remove logging and sleep patch from tests * Test unavailable state when disconnected * Rename SongpalEntity.dev to _dev * Add quality scale to manifest
This commit is contained in:
1 parent
3af3900581
commit
8994931ec4
7 files changed
+550
-153
No files matched your search
@@ -10,5 +10,6 @@
|
||||
"st": "urn:schemas-sony-com:service:ScalarWebAPI:1",
|
||||
"manufacturer": "Sony Corporation"
|
||||
}
|
||||
]
|
||||
],
|
||||
"quality_scale": "gold"
|
||||
}
|
||||
@@ -3,6 +3,7 @@ import asyncio
|
||||
from collections import OrderedDict
|
||||
import logging
|
||||
|
||||
import async_timeout
|
||||
from songpal import (
|
||||
ConnectChange,
|
||||
ContentChange,
|
||||
@@ -23,15 +24,13 @@ from homeassistant.components.media_player.const import (
|
||||
SUPPORT_VOLUME_STEP,
|
||||
)
|
||||
from homeassistant.config_entries import ConfigEntry
|
||||
from homeassistant.const import (
|
||||
ATTR_ENTITY_ID,
|
||||
CONF_NAME,
|
||||
EVENT_HOMEASSISTANT_STOP,
|
||||
STATE_OFF,
|
||||
STATE_ON,
|
||||
)
|
||||
from homeassistant.const import CONF_NAME, EVENT_HOMEASSISTANT_STOP, STATE_OFF, STATE_ON
|
||||
from homeassistant.exceptions import PlatformNotReady
|
||||
from homeassistant.helpers import config_validation as cv, device_registry as dr
|
||||
from homeassistant.helpers import (
|
||||
config_validation as cv,
|
||||
device_registry as dr,
|
||||
entity_platform,
|
||||
)
|
||||
from homeassistant.helpers.typing import HomeAssistantType
|
||||
|
||||
from .const import CONF_ENDPOINT, DOMAIN, SET_SOUND_SETTING
|
||||
@@ -50,13 +49,7 @@ SUPPORT_SONGPAL = (
|
||||
| SUPPORT_TURN_OFF
|
||||
)
|
||||
|
||||
SET_SOUND_SCHEMA = vol.Schema(
|
||||
{
|
||||
vol.Optional(ATTR_ENTITY_ID): cv.entity_id,
|
||||
vol.Required(PARAM_NAME): cv.string,
|
||||
vol.Required(PARAM_VALUE): cv.string,
|
||||
}
|
||||
)
|
||||
INITIAL_RETRY_DELAY = 10
|
||||
|
||||
|
||||
async def async_setup_platform(
|
||||
@@ -72,58 +65,38 @@ async def async_setup_entry(
|
||||
hass: HomeAssistantType, config_entry: ConfigEntry, async_add_entities
|
||||
) -> None:
|
||||
"""Set up songpal media player."""
|
||||
if DOMAIN not in hass.data:
|
||||
hass.data[DOMAIN] = {}
|
||||
|
||||
name = config_entry.data[CONF_NAME]
|
||||
endpoint = config_entry.data[CONF_ENDPOINT]
|
||||
|
||||
if endpoint in hass.data[DOMAIN]:
|
||||
_LOGGER.debug("The endpoint exists already, skipping setup.")
|
||||
return
|
||||
|
||||
device = SongpalDevice(name, endpoint)
|
||||
device = Device(endpoint)
|
||||
try:
|
||||
await device.initialize()
|
||||
except SongpalException as ex:
|
||||
_LOGGER.error("Unable to get methods from songpal: %s", ex)
|
||||
async with async_timeout.timeout(
|
||||
10
|
||||
): # set timeout to avoid blocking the setup process
|
||||
await device.get_supported_methods()
|
||||
except (SongpalException, asyncio.TimeoutError) as ex:
|
||||
_LOGGER.warning("[%s(%s)] Unable to connect.", name, endpoint)
|
||||
_LOGGER.debug("Unable to get methods from songpal: %s", ex)
|
||||
raise PlatformNotReady
|
||||
|
||||
hass.data[DOMAIN][endpoint] = device
|
||||
songpal_entity = SongpalEntity(name, device)
|
||||
async_add_entities([songpal_entity], True)
|
||||
|
||||
async_add_entities([device], True)
|
||||
|
||||
async def async_service_handler(service):
|
||||
"""Service handler."""
|
||||
entity_id = service.data.get("entity_id", None)
|
||||
params = {
|
||||
key: value for key, value in service.data.items() if key != ATTR_ENTITY_ID
|
||||
}
|
||||
|
||||
for device in hass.data[DOMAIN].values():
|
||||
if device.entity_id == entity_id or entity_id is None:
|
||||
_LOGGER.debug(
|
||||
"Calling %s (entity: %s) with params %s", service, entity_id, params
|
||||
)
|
||||
|
||||
await device.async_set_sound_setting(
|
||||
params[PARAM_NAME], params[PARAM_VALUE]
|
||||
)
|
||||
|
||||
hass.services.async_register(
|
||||
DOMAIN, SET_SOUND_SETTING, async_service_handler, schema=SET_SOUND_SCHEMA
|
||||
platform = entity_platform.current_platform.get()
|
||||
platform.async_register_entity_service(
|
||||
SET_SOUND_SETTING,
|
||||
{vol.Required(PARAM_NAME): cv.string, vol.Required(PARAM_VALUE): cv.string},
|
||||
"async_set_sound_setting",
|
||||
)
|
||||
|
||||
|
||||
class SongpalDevice(MediaPlayerEntity):
|
||||
class SongpalEntity(MediaPlayerEntity):
|
||||
"""Class representing a Songpal device."""
|
||||
|
||||
def __init__(self, name, endpoint, poll=False):
|
||||
def __init__(self, name, device):
|
||||
"""Init."""
|
||||
self._name = name
|
||||
self._endpoint = endpoint
|
||||
self._poll = poll
|
||||
self.dev = Device(self._endpoint)
|
||||
self._dev = device
|
||||
self._sysinfo = None
|
||||
self._model = None
|
||||
|
||||
@@ -143,19 +116,15 @@ class SongpalDevice(MediaPlayerEntity):
|
||||
@property
|
||||
def should_poll(self):
|
||||
"""Return True if the device should be polled."""
|
||||
return self._poll
|
||||
return False
|
||||
|
||||
async def initialize(self):
|
||||
"""Initialize the device."""
|
||||
await self.dev.get_supported_methods()
|
||||
self._sysinfo = await self.dev.get_system_info()
|
||||
interface_info = await self.dev.get_interface_information()
|
||||
self._model = interface_info.modelName
|
||||
async def async_added_to_hass(self):
|
||||
"""Run when entity is added to hass."""
|
||||
await self.async_activate_websocket()
|
||||
|
||||
async def async_will_remove_from_hass(self):
|
||||
"""Run when entity will be removed from hass."""
|
||||
self.hass.data[DOMAIN].pop(self._endpoint)
|
||||
await self.dev.stop_listen_notifications()
|
||||
await self._dev.stop_listen_notifications()
|
||||
|
||||
async def async_activate_websocket(self):
|
||||
"""Activate websocket for listening if wanted."""
|
||||
@@ -182,40 +151,48 @@ class SongpalDevice(MediaPlayerEntity):
|
||||
self.async_write_ha_state()
|
||||
|
||||
async def _try_reconnect(connect: ConnectChange):
|
||||
_LOGGER.error(
|
||||
"Got disconnected with %s, trying to reconnect.", connect.exception
|
||||
_LOGGER.warning(
|
||||
"[%s(%s)] Got disconnected, trying to reconnect.",
|
||||
self.name,
|
||||
self._dev.endpoint,
|
||||
)
|
||||
_LOGGER.debug("Disconnected: %s", connect.exception)
|
||||
self._available = False
|
||||
self.dev.clear_notification_callbacks()
|
||||
self.async_write_ha_state()
|
||||
|
||||
# Try to reconnect forever, a successful reconnect will initialize
|
||||
# the websocket connection again.
|
||||
delay = 10
|
||||
delay = INITIAL_RETRY_DELAY
|
||||
while not self._available:
|
||||
_LOGGER.debug("Trying to reconnect in %s seconds", delay)
|
||||
await asyncio.sleep(delay)
|
||||
# We need to inform HA about the state in case we are coming
|
||||
# back from a disconnected state.
|
||||
await self.async_update_ha_state(force_refresh=True)
|
||||
delay = min(2 * delay, 300)
|
||||
|
||||
_LOGGER.info("Reconnected to %s", self.name)
|
||||
try:
|
||||
await self._dev.get_supported_methods()
|
||||
except SongpalException as ex:
|
||||
_LOGGER.debug("Failed to reconnect: %s", ex)
|
||||
delay = min(2 * delay, 300)
|
||||
else:
|
||||
# We need to inform HA about the state in case we are coming
|
||||
# back from a disconnected state.
|
||||
await self.async_update_ha_state(force_refresh=True)
|
||||
|
||||
self.dev.on_notification(VolumeChange, _volume_changed)
|
||||
self.dev.on_notification(ContentChange, _source_changed)
|
||||
self.dev.on_notification(PowerChange, _power_changed)
|
||||
self.dev.on_notification(ConnectChange, _try_reconnect)
|
||||
self.hass.loop.create_task(self._dev.listen_notifications())
|
||||
_LOGGER.warning(
|
||||
"[%s(%s)] Connection reestablished.", self.name, self._dev.endpoint
|
||||
)
|
||||
|
||||
async def listen_events():
|
||||
await self.dev.listen_notifications()
|
||||
self._dev.on_notification(VolumeChange, _volume_changed)
|
||||
self._dev.on_notification(ContentChange, _source_changed)
|
||||
self._dev.on_notification(PowerChange, _power_changed)
|
||||
self._dev.on_notification(ConnectChange, _try_reconnect)
|
||||
|
||||
async def handle_stop(event):
|
||||
await self.dev.stop_listen_notifications()
|
||||
await self._dev.stop_listen_notifications()
|
||||
|
||||
self.hass.bus.async_listen_once(EVENT_HOMEASSISTANT_STOP, handle_stop)
|
||||
|
||||
self.hass.loop.create_task(listen_events())
|
||||
self.hass.loop.create_task(self._dev.listen_notifications())
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
@@ -246,12 +223,20 @@ class SongpalDevice(MediaPlayerEntity):
|
||||
|
||||
async def async_set_sound_setting(self, name, value):
|
||||
"""Change a setting on the device."""
|
||||
await self.dev.set_sound_settings(name, value)
|
||||
_LOGGER.debug("Calling set_sound_setting with %s: %s", name, value)
|
||||
await self._dev.set_sound_settings(name, value)
|
||||
|
||||
async def async_update(self):
|
||||
"""Fetch updates from the device."""
|
||||
try:
|
||||
volumes = await self.dev.get_volume_information()
|
||||
if self._sysinfo is None:
|
||||
self._sysinfo = await self._dev.get_system_info()
|
||||
|
||||
if self._model is None:
|
||||
interface_info = await self._dev.get_interface_information()
|
||||
self._model = interface_info.modelName
|
||||
|
||||
volumes = await self._dev.get_volume_information()
|
||||
if not volumes:
|
||||
_LOGGER.error("Got no volume controls, bailing out")
|
||||
self._available = False
|
||||
@@ -269,11 +254,11 @@ class SongpalDevice(MediaPlayerEntity):
|
||||
self._volume_control = volume
|
||||
self._is_muted = self._volume_control.is_muted
|
||||
|
||||
status = await self.dev.get_power()
|
||||
status = await self._dev.get_power()
|
||||
self._state = status.status
|
||||
_LOGGER.debug("Got state: %s", status)
|
||||
|
||||
inputs = await self.dev.get_inputs()
|
||||
inputs = await self._dev.get_inputs()
|
||||
_LOGGER.debug("Got ins: %s", inputs)
|
||||
|
||||
self._sources = OrderedDict()
|
||||
@@ -286,9 +271,6 @@ class SongpalDevice(MediaPlayerEntity):
|
||||
|
||||
self._available = True
|
||||
|
||||
# activate notifications if wanted
|
||||
if not self._poll:
|
||||
await self.hass.async_create_task(self.async_activate_websocket())
|
||||
except SongpalException as ex:
|
||||
_LOGGER.error("Unable to update: %s", ex)
|
||||
self._available = False
|
||||
@@ -342,11 +324,11 @@ class SongpalDevice(MediaPlayerEntity):
|
||||
|
||||
async def async_turn_on(self):
|
||||
"""Turn the device on."""
|
||||
return await self.dev.set_power(True)
|
||||
return await self._dev.set_power(True)
|
||||
|
||||
async def async_turn_off(self):
|
||||
"""Turn the device off."""
|
||||
return await self.dev.set_power(False)
|
||||
return await self._dev.set_power(False)
|
||||
|
||||
async def async_mute_volume(self, mute):
|
||||
"""Mute or unmute the device."""
|
||||
|
||||
Reference in new issue
Block a user