home-automation-home-assistant/custom_components/reolink_dev/config_flow.py

"""Config flow for the Reolink camera component."""
import logging

import voluptuous as vol

from homeassistant import config_entries, core, data_entry_flow, exceptions
from homeassistant.const import (
    CONF_HOST,
    CONF_PASSWORD,
    CONF_PORT,
    CONF_TIMEOUT,
    CONF_USERNAME,
)
from homeassistant.core import callback
from homeassistant.helpers import config_validation as cv

from .base import ReolinkBase
from .const import (
    BASE,
    CONF_CHANNEL,
    CONF_MOTION_OFF_DELAY,
    CONF_PLAYBACK_MONTHS,
    CONF_PLAYBACK_THUMBNAILS,
    CONF_PROTOCOL,
    CONF_STREAM,
    CONF_THUMBNAIL_OFFSET,
    DEFAULT_MOTION_OFF_DELAY,
    DEFAULT_PLAYBACK_MONTHS,
    DEFAULT_PLAYBACK_THUMBNAILS,
    DEFAULT_PROTOCOL,
    DEFAULT_STREAM,
    DEFAULT_THUMBNAIL_OFFSET,
    DEFAULT_TIMEOUT,
    DOMAIN,
)

_LOGGER = logging.getLogger(__name__)


class ReolinkFlowHandler(config_entries.ConfigFlow, domain=DOMAIN):
    """Handle a config flow for Reolink camera's."""

    VERSION = 1
    CONNECTION_CLASS = config_entries.CONN_CLASS_LOCAL_POLL

    channels = 1
    mac_address = None
    base = None

    @staticmethod
    @callback
    def async_get_options_flow(config_entry):
        """Get the options flow for this handler."""
        return ReolinkOptionsFlowHandler(config_entry)

    async def async_step_user(self, user_input=None):
        """Handle the initial step."""
        errors = {}

        if user_input is not None:
            self.data = user_input

            try:
                self.info = await self.async_validate_input(self.hass, user_input)

                if self.channels > 1:
                    return await self.async_step_nvr()

                self.data[CONF_CHANNEL] = 1
                await self.async_set_unique_id(
                    f"{self.mac_address}{user_input[CONF_CHANNEL]}"
                )
                self._abort_if_unique_id_configured()
                return self.async_create_entry(title=self.info["title"], data=self.data)

            except CannotConnect:
                errors["base"] = "cannot_connect"
            except InvalidHost:
                errors["host"] = "cannot_connect"
            except Exception:  # pylint: disable=broad-except
                _LOGGER.exception("Unexpected exception")
                errors["base"] = "unknown"

        return self.async_show_form(
            step_id="user",
            data_schema=vol.Schema(
                {
                    vol.Required(CONF_HOST): str,
                    vol.Optional(CONF_PORT, default=80): cv.positive_int,
                    vol.Required(CONF_USERNAME): str,
                    vol.Required(CONF_PASSWORD): str,
                }
            ),
            errors=errors,
        )

    async def async_step_nvr(self, user_input=None):
        """Configure a NVR with multiple channels."""
        errors = {}
        if user_input is not None:
            self.data.update(user_input)

            await self.async_set_unique_id(
                f"{self.mac_address}{user_input[CONF_CHANNEL]}"
            )
            self._abort_if_unique_id_configured()

            await self.base.set_channel(user_input[CONF_CHANNEL])
            await self.base.update_settings()

            return self.async_create_entry(title=self.base.name, data=self.data)

        return self.async_show_form(
            step_id="nvr",
            data_schema=vol.Schema(
                {
                    vol.Required(CONF_CHANNEL): vol.All(
                        vol.Coerce(int), vol.Range(min=1, max=self.channels)
                    ),
                }
            ),
            errors=errors,
        )

    async def async_validate_input(self, hass: core.HomeAssistant, user_input: dict):
        """Validate the user input allows us to connect."""
        self.base = ReolinkBase(hass, user_input, [])

        if not await self.base.connect_api():
            raise CannotConnect

        title = self.base.api.name
        self.channels = self.base.api.channels
        self.mac_address = self.base.api.mac_address

        return {"title": title}

    async def async_finish_flow(self, flow, result):
        """Finish flow."""
        # if result['type'] == data_entry_flow.RESULT_TYPE_ABORT:
        self.base.disconnect_api()


class ReolinkOptionsFlowHandler(config_entries.OptionsFlow):
    """Handle Reolink options."""

    def __init__(self, config_entry):
        """Initialize Reolink options flow."""
        self.config_entry = config_entry

    async def async_step_init(self, user_input=None):  # pylint: disable=unused-argument
        """Manage the Reolink options."""

        if user_input is not None:
            return self.async_create_entry(title="", data=user_input)

        return self.async_show_form(
            step_id="init",
            data_schema=vol.Schema(
                {
                    vol.Required(
                        CONF_PROTOCOL,
                        default=self.config_entry.options.get(
                            CONF_PROTOCOL, DEFAULT_PROTOCOL
                        ),
                    ): vol.In(["rtmp", "rtsp"]),
                    vol.Required(
                        CONF_STREAM,
                        default=self.config_entry.options.get(
                            CONF_STREAM, DEFAULT_STREAM
                        ),
                    ): vol.In(["main", "sub"]),
                    vol.Required(
                        CONF_MOTION_OFF_DELAY,
                        default=self.config_entry.options.get(
                            CONF_MOTION_OFF_DELAY, DEFAULT_MOTION_OFF_DELAY
                        ),
                    ): vol.All(vol.Coerce(int), vol.Range(min=0)),
                    vol.Required(
                        CONF_PLAYBACK_MONTHS,
                        default=self.config_entry.options.get(
                            CONF_PLAYBACK_MONTHS, DEFAULT_PLAYBACK_MONTHS
                        ),
                    ): cv.positive_int,
                    vol.Optional(
                        CONF_PLAYBACK_THUMBNAILS,
                        default=self.config_entry.options.get(
                            CONF_PLAYBACK_THUMBNAILS, DEFAULT_PLAYBACK_THUMBNAILS
                        ),
                    ): cv.boolean,
                    vol.Optional(
                        CONF_THUMBNAIL_OFFSET,
                        default=self.config_entry.options.get(
                            CONF_THUMBNAIL_OFFSET, DEFAULT_THUMBNAIL_OFFSET
                        ),
                    ): vol.All(vol.Coerce(int), vol.Range(min=0, max=60)),
                    vol.Optional(
                        CONF_TIMEOUT,
                        default=self.config_entry.options.get(
                            CONF_TIMEOUT, DEFAULT_TIMEOUT
                        ),
                    ): vol.All(vol.Coerce(int), vol.Range(min=1, max=60)),
                }
            ),
        )


class AlreadyConfigured(exceptions.HomeAssistantError):
    """Error to indicate device is already configured."""


class CannotConnect(exceptions.HomeAssistantError):
    """Error to indicate we cannot connect."""


class InvalidHost(exceptions.HomeAssistantError):
    """Error to indicate there is an invalid hostname."""