config_flow.py

Go to the documentation of this file.

"""Config flow for Volumio integration."""
 
from __future__ import annotations
 
import logging
from typing import Any
 
from pyvolumio import CannotConnectError, Volumio
import voluptuous as vol
 
from homeassistant.components import zeroconf
from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
from homeassistant.const import CONF_HOST, CONF_ID, CONF_NAME, CONF_PORT
from homeassistant.core import HomeAssistant, callback
from homeassistant.exceptions import HomeAssistantError
from homeassistant.helpers.aiohttp_client import async_get_clientsession
 
from .const import DOMAIN
 
_LOGGER = logging.getLogger(__name__)
 
 
DATA_SCHEMA = vol.Schema(
    {vol.Required(CONF_HOST): str, vol.Required(CONF_PORT, default=3000): int}
)
 
 
async def validate_input(hass: HomeAssistant, host: str, port: int) -> dict[str, Any]:
    """Validate the user input allows us to connect."""
    volumio = Volumio(host, port, async_get_clientsession(hass))
 
    try:
        return await volumio.get_system_info()
    except CannotConnectError as error:
        raise CannotConnect from error
 
 
class VolumioConfigFlow(ConfigFlow, domain=DOMAIN):
    """Handle a config flow for Volumio."""
 
    VERSION = 1
 
    _host: str
    _port: int
    _name: str
    _uuid: str | None
 
    @callback
    def _async_get_entry(self) -> ConfigFlowResult:
        return self.async_create_entryasync_create_entryasync_create_entry(
            title=self._name_name,
            data={
                CONF_NAME: self._name_name,
                CONF_HOST: self._host_host,
                CONF_PORT: self._port_port,
                CONF_ID: self._uuid_uuid,
            },
        )
 
    async def _set_uid_and_abort(self):
        await self.async_set_unique_idasync_set_unique_id(self._uuid_uuid)
        self._abort_if_unique_id_configured_abort_if_unique_id_configured(
            updates={
                CONF_HOST: self._host_host,
                CONF_PORT: self._port_port,
                CONF_NAME: self._name_name,
            }
        )
 
    async def async_step_user(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Handle the initial step."""
        errors = {}
        if user_input is not None:
            info = None
            self._host_host = user_input[CONF_HOST]
            self._port_port = user_input[CONF_PORT]
            try:
                info = await validate_input(self.hass, self._host_host, self._port_port)
            except CannotConnect:
                errors["base"] = "cannot_connect"
            except Exception:
                _LOGGER.exception("Unexpected exception")
                errors["base"] = "unknown"
 
            if info is not None:
                self._name_name = info.get("name", self._host_host)
                self._uuid_uuid = info.get("id")
                if self._uuid_uuid is not None:
                    await self._set_uid_and_abort_set_uid_and_abort()
 
                return self._async_get_entry_async_get_entry()
 
        return self.async_show_formasync_show_formasync_show_form(
            step_id="user", data_schema=DATA_SCHEMA, errors=errors
        )
 
    async def async_step_zeroconf(
        self, discovery_info: zeroconf.ZeroconfServiceInfo
    ) -> ConfigFlowResult:
        """Handle zeroconf discovery."""
        self._host_host = discovery_info.host
        self._port_port = discovery_info.port or 3000
        self._name_name = discovery_info.properties["volumioName"]
        self._uuid_uuid = discovery_info.properties["UUID"]
 
        await self._set_uid_and_abort_set_uid_and_abort()
 
        return await self.async_step_discovery_confirmasync_step_discovery_confirm()
 
    async def async_step_discovery_confirm(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Handle user-confirmation of discovered node."""
        if user_input is not None:
            try:
                await validate_input(self.hass, self._host_host, self._port_port)
                return self._async_get_entry_async_get_entry()
            except CannotConnect:
                return self.async_abortasync_abortasync_abort(reason="cannot_connect")
 
        return self.async_show_formasync_show_formasync_show_form(
            step_id="discovery_confirm", description_placeholders={"name": self._name_name}
        )
 
 
class CannotConnect(HomeAssistantError):
    """Error to indicate we cannot connect."""