Enable velbus config entries (#25308)
* Initial work on config_flow * Finish config flow * Pylint checks, make sure the import only happens once * Added support for unloading, small fixes * Check in the hassfest output files * Flake8 fixes * pylint mistake after flake8 fixes * Work on comments * Abort the import if it is already imported * More comments resolved * Added testcases for velbus config flow * Fix pylint and flake8 * Added connection test to the config flow * More sugestions * renamed the abort reason * excluded all but the config_flow.py from the velbus component in coveragerc * Rewrote testcases with a patched version of _test_connection * Docstyle fixes * Updated the velbus testcases * just yield * flake8 fixes
This commit is contained in:
parent
03052802a4
commit
1f9f201571
18 changed files with 407 additions and 81 deletions
93
homeassistant/components/velbus/config_flow.py
Normal file
93
homeassistant/components/velbus/config_flow.py
Normal file
|
@ -0,0 +1,93 @@
|
|||
"""Config flow for the Velbus platform."""
|
||||
import velbus
|
||||
import voluptuous as vol
|
||||
|
||||
from homeassistant import config_entries
|
||||
from homeassistant.const import CONF_PORT, CONF_NAME
|
||||
from homeassistant.core import HomeAssistant, callback
|
||||
from homeassistant.util import slugify
|
||||
|
||||
from .const import DOMAIN
|
||||
|
||||
|
||||
@callback
|
||||
def velbus_entries(hass: HomeAssistant):
|
||||
"""Return connections for Velbus domain."""
|
||||
return set((entry.data[CONF_PORT]) for
|
||||
entry in hass.config_entries.async_entries(DOMAIN))
|
||||
|
||||
|
||||
@config_entries.HANDLERS.register(DOMAIN)
|
||||
class VelbusConfigFlow(config_entries.ConfigFlow):
|
||||
"""Handle a config flow."""
|
||||
|
||||
VERSION = 1
|
||||
CONNECTION_CLASS = config_entries.CONN_CLASS_LOCAL_PUSH
|
||||
|
||||
def __init__(self) -> None:
|
||||
"""Initialize the velbus config flow."""
|
||||
self._errors = {}
|
||||
|
||||
def _create_device(self, name: str, prt: str):
|
||||
"""Create an antry async."""
|
||||
return self.async_create_entry(
|
||||
title=name,
|
||||
data={
|
||||
CONF_PORT: prt
|
||||
}
|
||||
)
|
||||
|
||||
def _test_connection(self, prt):
|
||||
"""Try to connect to the velbus with the port specified."""
|
||||
try:
|
||||
controller = velbus.Controller(prt)
|
||||
except Exception: # pylint: disable=broad-except
|
||||
self._errors[CONF_PORT] = 'connection_failed'
|
||||
return False
|
||||
controller.stop()
|
||||
return True
|
||||
|
||||
def _prt_in_configuration_exists(self, prt: str) -> bool:
|
||||
"""Return True if port exists in configuration."""
|
||||
if prt in velbus_entries(self.hass):
|
||||
return True
|
||||
return False
|
||||
|
||||
async def async_step_user(self, user_input=None):
|
||||
"""Step when user intializes a integration."""
|
||||
self._errors = {}
|
||||
if user_input is not None:
|
||||
name = slugify(user_input[CONF_NAME])
|
||||
prt = user_input[CONF_PORT]
|
||||
if not self._prt_in_configuration_exists(prt):
|
||||
if self._test_connection(prt):
|
||||
return self._create_device(name, prt)
|
||||
else:
|
||||
self._errors[CONF_PORT] = 'port_exists'
|
||||
else:
|
||||
user_input = {}
|
||||
user_input[CONF_NAME] = ''
|
||||
user_input[CONF_PORT] = ''
|
||||
|
||||
return self.async_show_form(
|
||||
step_id='user',
|
||||
data_schema=vol.Schema({
|
||||
vol.Required(CONF_NAME,
|
||||
default=user_input[CONF_NAME]): str,
|
||||
vol.Required(CONF_PORT,
|
||||
default=user_input[CONF_PORT]): str
|
||||
}),
|
||||
errors=self._errors
|
||||
)
|
||||
|
||||
async def async_step_import(self, user_input=None):
|
||||
"""Import a config entry."""
|
||||
user_input[CONF_NAME] = 'Velbus Import'
|
||||
prt = user_input[CONF_PORT]
|
||||
if self._prt_in_configuration_exists(prt):
|
||||
# if the velbus import is already in the config
|
||||
# we should not proceed the import
|
||||
return self.async_abort(
|
||||
reason='port_exists'
|
||||
)
|
||||
return await self.async_step_user(user_input)
|
Loading…
Add table
Add a link
Reference in a new issue