mirror of
https://github.com/home-assistant/core
synced 2024-08-28 03:36:46 +02:00
107 lines
3.6 KiB
Python
107 lines
3.6 KiB
Python
"""Config flow to configure the LCN integration."""
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
|
|
import pypck
|
|
|
|
from homeassistant import config_entries
|
|
from homeassistant.const import (
|
|
CONF_HOST,
|
|
CONF_IP_ADDRESS,
|
|
CONF_PASSWORD,
|
|
CONF_PORT,
|
|
CONF_USERNAME,
|
|
)
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.data_entry_flow import FlowResult
|
|
from homeassistant.helpers.typing import ConfigType
|
|
|
|
from .const import CONF_DIM_MODE, CONF_SK_NUM_TRIES, DOMAIN
|
|
from .helpers import purge_device_registry, purge_entity_registry
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
def get_config_entry(
|
|
hass: HomeAssistant, data: ConfigType
|
|
) -> config_entries.ConfigEntry | None:
|
|
"""Check config entries for already configured entries based on the ip address/port."""
|
|
return next(
|
|
(
|
|
entry
|
|
for entry in hass.config_entries.async_entries(DOMAIN)
|
|
if entry.data[CONF_IP_ADDRESS] == data[CONF_IP_ADDRESS]
|
|
and entry.data[CONF_PORT] == data[CONF_PORT]
|
|
),
|
|
None,
|
|
)
|
|
|
|
|
|
async def validate_connection(host_name: str, data: ConfigType) -> ConfigType:
|
|
"""Validate if a connection to LCN can be established."""
|
|
host = data[CONF_IP_ADDRESS]
|
|
port = data[CONF_PORT]
|
|
username = data[CONF_USERNAME]
|
|
password = data[CONF_PASSWORD]
|
|
sk_num_tries = data[CONF_SK_NUM_TRIES]
|
|
dim_mode = data[CONF_DIM_MODE]
|
|
|
|
settings = {
|
|
"SK_NUM_TRIES": sk_num_tries,
|
|
"DIM_MODE": pypck.lcn_defs.OutputPortDimMode[dim_mode],
|
|
}
|
|
|
|
_LOGGER.debug("Validating connection parameters to PCHK host '%s'", host_name)
|
|
|
|
connection = pypck.connection.PchkConnectionManager(
|
|
host, port, username, password, settings=settings
|
|
)
|
|
|
|
await connection.async_connect(timeout=5)
|
|
|
|
_LOGGER.debug("LCN connection validated")
|
|
await connection.async_close()
|
|
return data
|
|
|
|
|
|
class LcnFlowHandler(config_entries.ConfigFlow, domain=DOMAIN):
|
|
"""Handle a LCN config flow."""
|
|
|
|
VERSION = 1
|
|
|
|
async def async_step_import(self, data: ConfigType) -> FlowResult:
|
|
"""Import existing configuration from LCN."""
|
|
host_name = data[CONF_HOST]
|
|
# validate the imported connection parameters
|
|
try:
|
|
await validate_connection(host_name, data)
|
|
except pypck.connection.PchkAuthenticationError:
|
|
_LOGGER.warning('Authentication on PCHK "%s" failed', host_name)
|
|
return self.async_abort(reason="authentication_error")
|
|
except pypck.connection.PchkLicenseError:
|
|
_LOGGER.warning(
|
|
(
|
|
'Maximum number of connections on PCHK "%s" was '
|
|
"reached. An additional license key is required"
|
|
),
|
|
host_name,
|
|
)
|
|
return self.async_abort(reason="license_error")
|
|
except TimeoutError:
|
|
_LOGGER.warning('Connection to PCHK "%s" failed', host_name)
|
|
return self.async_abort(reason="connection_timeout")
|
|
|
|
# check if we already have a host with the same address configured
|
|
if entry := get_config_entry(self.hass, data):
|
|
entry.source = config_entries.SOURCE_IMPORT
|
|
# Cleanup entity and device registry, if we imported from configuration.yaml to
|
|
# remove orphans when entities were removed from configuration
|
|
purge_entity_registry(self.hass, entry.entry_id, data)
|
|
purge_device_registry(self.hass, entry.entry_id, data)
|
|
|
|
self.hass.config_entries.async_update_entry(entry, data=data)
|
|
return self.async_abort(reason="existing_configuration_updated")
|
|
|
|
return self.async_create_entry(title=f"{host_name}", data=data)
|