core/homeassistant/components/yamaha_musiccast/config_flow.py

135 lines
4.4 KiB
Python

"""Config flow for MusicCast."""
from __future__ import annotations
import logging
from typing import Any
from urllib.parse import urlparse
from aiohttp import ClientConnectorError
from aiomusiccast import MusicCastConnectionException, MusicCastDevice
import voluptuous as vol
from homeassistant import data_entry_flow
from homeassistant.components import ssdp
from homeassistant.config_entries import ConfigFlow
from homeassistant.const import CONF_HOST
from homeassistant.helpers.aiohttp_client import async_get_clientsession
from . import get_upnp_desc
from .const import CONF_SERIAL, CONF_UPNP_DESC, DOMAIN
_LOGGER = logging.getLogger(__name__)
class MusicCastFlowHandler(ConfigFlow, domain=DOMAIN):
"""Handle a MusicCast config flow."""
VERSION = 1
serial_number: str | None = None
host: str
upnp_description: str | None = None
async def async_step_user(
self, user_input: dict[str, Any] | None = None
) -> data_entry_flow.ConfigFlowResult:
"""Handle a flow initiated by the user."""
# Request user input, unless we are preparing discovery flow
if user_input is None:
return self._show_setup_form()
host = user_input[CONF_HOST]
serial_number = None
errors = {}
# Check if device is a MusicCast device
try:
info = await MusicCastDevice.get_device_info(
host, async_get_clientsession(self.hass)
)
except (MusicCastConnectionException, ClientConnectorError):
errors["base"] = "cannot_connect"
except Exception:
_LOGGER.exception("Unexpected exception")
errors["base"] = "unknown"
else:
if (serial_number := info.get("system_id")) is None:
errors["base"] = "no_musiccast_device"
if not errors:
await self.async_set_unique_id(serial_number, raise_on_progress=False)
self._abort_if_unique_id_configured()
return self.async_create_entry(
title=host,
data={
CONF_HOST: host,
CONF_SERIAL: serial_number,
CONF_UPNP_DESC: await get_upnp_desc(self.hass, host),
},
)
return self._show_setup_form(errors)
def _show_setup_form(
self, errors: dict | None = None
) -> data_entry_flow.ConfigFlowResult:
"""Show the setup form to the user."""
return self.async_show_form(
step_id="user",
data_schema=vol.Schema({vol.Required(CONF_HOST): str}),
errors=errors or {},
)
async def async_step_ssdp(
self, discovery_info: ssdp.SsdpServiceInfo
) -> data_entry_flow.ConfigFlowResult:
"""Handle ssdp discoveries."""
if not await MusicCastDevice.check_yamaha_ssdp(
discovery_info.ssdp_location, async_get_clientsession(self.hass)
):
return self.async_abort(reason="yxc_control_url_missing")
self.serial_number = discovery_info.upnp[ssdp.ATTR_UPNP_SERIAL]
self.upnp_description = discovery_info.ssdp_location
# ssdp_location and hostname have been checked in check_yamaha_ssdp so it is safe to ignore type assignment
self.host = urlparse(discovery_info.ssdp_location).hostname # type: ignore[assignment]
await self.async_set_unique_id(self.serial_number)
self._abort_if_unique_id_configured(
{
CONF_HOST: self.host,
CONF_UPNP_DESC: self.upnp_description,
}
)
self.context.update(
{
"title_placeholders": {
"name": discovery_info.upnp.get(
ssdp.ATTR_UPNP_FRIENDLY_NAME, self.host
)
}
}
)
return await self.async_step_confirm()
async def async_step_confirm(
self, user_input=None
) -> data_entry_flow.ConfigFlowResult:
"""Allow the user to confirm adding the device."""
if user_input is not None:
return self.async_create_entry(
title=self.host,
data={
CONF_HOST: self.host,
CONF_SERIAL: self.serial_number,
CONF_UPNP_DESC: self.upnp_description,
},
)
return self.async_show_form(step_id="confirm")