config_flow.py

Go to the documentation of this file.

"""Config flow for Roku."""
 
from __future__ import annotations
 
import logging
from typing import Any
from urllib.parse import urlparse
 
from rokuecp import Roku, RokuError
import voluptuous as vol
 
from homeassistant.components import ssdp, zeroconf
from homeassistant.config_entries import (
    ConfigEntry,
    ConfigFlow,
    ConfigFlowResult,
    OptionsFlow,
)
from homeassistant.const import CONF_HOST, CONF_NAME
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.aiohttp_client import async_get_clientsession
 
from .const import CONF_PLAY_MEDIA_APP_ID, DEFAULT_PLAY_MEDIA_APP_ID, DOMAIN
 
DATA_SCHEMA = vol.Schema({vol.Required(CONF_HOST): str})
 
ERROR_CANNOT_CONNECT = "cannot_connect"
ERROR_UNKNOWN = "unknown"
 
_LOGGER = logging.getLogger(__name__)
 
 
async def validate_input(hass: HomeAssistant, data: dict[str, Any]) -> dict[str, Any]:
    """Validate the user input allows us to connect.
 
    Data has the keys from DATA_SCHEMA with values provided by the user.
    """
    session = async_get_clientsession(hass)
    roku = Roku(data[CONF_HOST], session=session)
    device = await roku.update()
 
    return {
        "title": device.info.name,
        "serial_number": device.info.serial_number,
    }
 
 
class RokuConfigFlow(ConfigFlow, domain=DOMAIN):
    """Handle a Roku config flow."""
 
    VERSION = 1
 
    discovery_info: dict[str, Any]
 
    def __init__(self) -> None:
        """Set up the instance."""
        self.discovery_infodiscovery_info = {}
 
    @callback
    def _show_form(self, errors: dict[str, Any] | None = None) -> ConfigFlowResult:
        """Show the form to the user."""
        return self.async_show_formasync_show_formasync_show_form(
            step_id="user",
            data_schema=DATA_SCHEMA,
            errors=errors or {},
        )
 
    async def async_step_user(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Handle a flow initialized by the user."""
        if not user_input:
            return self._show_form_show_form()
 
        errors = {}
 
        try:
            info = await validate_input(self.hass, user_input)
        except RokuError:
            _LOGGER.debug("Roku Error", exc_info=True)
            errors["base"] = ERROR_CANNOT_CONNECT
            return self._show_form_show_form(errors)
        except Exception:
            _LOGGER.exception("Unknown error trying to connect")
            return self.async_abortasync_abortasync_abort(reason=ERROR_UNKNOWN)
 
        await self.async_set_unique_idasync_set_unique_id(info["serial_number"])
        self._abort_if_unique_id_configured_abort_if_unique_id_configured(updates={CONF_HOST: user_input[CONF_HOST]})
 
        return self.async_create_entryasync_create_entryasync_create_entry(title=info["title"], data=user_input)
 
    async def async_step_homekit(
        self, discovery_info: zeroconf.ZeroconfServiceInfo
    ) -> ConfigFlowResult:
        """Handle a flow initialized by homekit discovery."""
 
        # If we already have the host configured do
        # not open connections to it if we can avoid it.
        self._async_abort_entries_match_async_abort_entries_match({CONF_HOST: discovery_info.host})
 
        self.discovery_infodiscovery_info.update({CONF_HOST: discovery_info.host})
 
        try:
            info = await validate_input(self.hass, self.discovery_infodiscovery_info)
        except RokuError:
            _LOGGER.debug("Roku Error", exc_info=True)
            return self.async_abortasync_abortasync_abort(reason=ERROR_CANNOT_CONNECT)
        except Exception:
            _LOGGER.exception("Unknown error trying to connect")
            return self.async_abortasync_abortasync_abort(reason=ERROR_UNKNOWN)
 
        await self.async_set_unique_idasync_set_unique_id(info["serial_number"])
        self._abort_if_unique_id_configured_abort_if_unique_id_configured(
            updates={CONF_HOST: discovery_info.host},
        )
 
        self.context.update({"title_placeholders": {"name": info["title"]}})
        self.discovery_infodiscovery_info.update({CONF_NAME: info["title"]})
 
        return await self.async_step_discovery_confirmasync_step_discovery_confirm()
 
    async def async_step_ssdp(
        self, discovery_info: ssdp.SsdpServiceInfo
    ) -> ConfigFlowResult:
        """Handle a flow initialized by discovery."""
        host = urlparse(discovery_info.ssdp_location).hostname
        name = discovery_info.upnp[ssdp.ATTR_UPNP_FRIENDLY_NAME]
        serial_number = discovery_info.upnp[ssdp.ATTR_UPNP_SERIAL]
 
        await self.async_set_unique_idasync_set_unique_id(serial_number)
        self._abort_if_unique_id_configured_abort_if_unique_id_configured(updates={CONF_HOST: host})
 
        self.context.update({"title_placeholders": {"name": name}})
 
        self.discovery_infodiscovery_info.update({CONF_HOST: host, CONF_NAME: name})
 
        try:
            await validate_input(self.hass, self.discovery_infodiscovery_info)
        except RokuError:
            _LOGGER.debug("Roku Error", exc_info=True)
            return self.async_abortasync_abortasync_abort(reason=ERROR_CANNOT_CONNECT)
        except Exception:
            _LOGGER.exception("Unknown error trying to connect")
            return self.async_abortasync_abortasync_abort(reason=ERROR_UNKNOWN)
 
        return await self.async_step_discovery_confirmasync_step_discovery_confirm()
 
    async def async_step_discovery_confirm(
        self, user_input: dict | None = None
    ) -> ConfigFlowResult:
        """Handle user-confirmation of discovered device."""
        if user_input is None:
            return self.async_show_formasync_show_formasync_show_form(
                step_id="discovery_confirm",
                description_placeholders={"name": self.discovery_infodiscovery_info[CONF_NAME]},
                errors={},
            )
 
        return self.async_create_entryasync_create_entryasync_create_entry(
            title=self.discovery_infodiscovery_info[CONF_NAME],
            data=self.discovery_infodiscovery_info,
        )
 
    @staticmethod
    @callback
    def async_get_options_flow(
        config_entry: ConfigEntry,
    ) -> RokuOptionsFlowHandler:
        """Create the options flow."""
        return RokuOptionsFlowHandler()
 
 
class RokuOptionsFlowHandler(OptionsFlow):
    """Handle Roku options."""
 
    async def async_step_init(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Manage Roku options."""
        if user_input is not None:
            return self.async_create_entryasync_create_entry(title="", data=user_input)
 
        return self.async_show_formasync_show_form(
            step_id="init",
            data_schema=vol.Schema(
                {
                    vol.Optional(
                        CONF_PLAY_MEDIA_APP_ID,
                        default=self.config_entryconfig_entryconfig_entry.options.get(
                            CONF_PLAY_MEDIA_APP_ID, DEFAULT_PLAY_MEDIA_APP_ID
                        ),
                    ): str,
                }
            ),
        )