Add config flow for nuki (#45664)

* implemented config_flow for nuki component

* warn -> warning

* exception handling & config_flow tests

* gen_requirements_all

* Update config_flow.py

Co-authored-by: Pascal Vizeli <pascal.vizeli@syshack.ch>
This commit is contained in:
Pascal Reeb 2021-01-29 11:05:13 +01:00 committed by GitHub
parent b74cbb2a59
commit ba55f1ff4b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 319 additions and 11 deletions

View file

@ -0,0 +1,97 @@
"""Config flow to configure the Nuki integration."""
import logging
from pynuki import NukiBridge
from pynuki.bridge import InvalidCredentialsException
from requests.exceptions import RequestException
import voluptuous as vol
from homeassistant import config_entries, exceptions
from homeassistant.const import CONF_HOST, CONF_PORT, CONF_TOKEN
from .const import ( # pylint: disable=unused-import
DEFAULT_PORT,
DEFAULT_TIMEOUT,
DOMAIN,
)
_LOGGER = logging.getLogger(__name__)
USER_SCHEMA = vol.Schema(
{
vol.Required(CONF_HOST): str,
vol.Optional(CONF_PORT, default=DEFAULT_PORT): vol.Coerce(int),
vol.Required(CONF_TOKEN): str,
}
)
async def validate_input(hass, data):
"""Validate the user input allows us to connect.
Data has the keys from USER_SCHEMA with values provided by the user.
"""
try:
bridge = await hass.async_add_executor_job(
NukiBridge,
data[CONF_HOST],
data[CONF_TOKEN],
data[CONF_PORT],
True,
DEFAULT_TIMEOUT,
)
info = bridge.info()
except InvalidCredentialsException as err:
raise InvalidAuth from err
except RequestException as err:
raise CannotConnect from err
return info
class NukiConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
"""Nuki config flow."""
async def async_step_import(self, user_input=None):
"""Handle a flow initiated by import."""
return await self.async_step_validate(user_input)
async def async_step_user(self, user_input=None):
"""Handle a flow initiated by the user."""
return await self.async_step_validate(user_input)
async def async_step_validate(self, user_input):
"""Handle init step of a flow."""
errors = {}
if user_input is not None:
try:
info = await validate_input(self.hass, user_input)
except CannotConnect:
errors["base"] = "cannot_connect"
except InvalidAuth:
errors["base"] = "invalid_auth"
except Exception: # pylint: disable=broad-except
_LOGGER.exception("Unexpected exception")
errors["base"] = "unknown"
if "base" not in errors:
await self.async_set_unique_id(info["ids"]["hardwareId"])
self._abort_if_unique_id_configured()
return self.async_create_entry(
title=info["ids"]["hardwareId"], data=user_input
)
return self.async_show_form(
step_id="user", data_schema=USER_SCHEMA, errors=errors
)
class CannotConnect(exceptions.HomeAssistantError):
"""Error to indicate we cannot connect."""
class InvalidAuth(exceptions.HomeAssistantError):
"""Error to indicate there is invalid auth."""