Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.lcn.config_flow Namespace Reference

Classes

class  LcnFlowHandler
 

Functions

config_entries.ConfigEntry|None get_config_entry (HomeAssistant hass, ConfigType data)
 
str|None validate_connection (ConfigType data)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
dictionary CONFIG_DATA
 
 CONFIG_SCHEMA = vol.Schema(CONFIG_DATA)
 
dictionary USER_DATA = {vol.Required(CONF_HOST, default="pchk"): str, **CONFIG_DATA}
 
 USER_SCHEMA = vol.Schema(USER_DATA)
 

Detailed Description

Config flow to configure the LCN integration.

Function Documentation

◆ get_config_entry()

config_entries.ConfigEntry | None homeassistant.components.lcn.config_flow.get_config_entry ( HomeAssistant  hass,
ConfigType   data 
)
Check config entries for already configured entries based on the ip address/port.

Definition at line 47 of file config_flow.py.

◆ validate_connection()

str | None homeassistant.components.lcn.config_flow.validate_connection ( ConfigType  data)
Validate if a connection to LCN can be established.

Definition at line 62 of file config_flow.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.lcn.config_flow._LOGGER = logging.getLogger(__name__)
private

Definition at line 29 of file config_flow.py.

◆ CONFIG_DATA

dictionary homeassistant.components.lcn.config_flow.CONFIG_DATA
Initial value:
1 = {
2  vol.Required(CONF_IP_ADDRESS, default=""): str,
3  vol.Required(CONF_PORT, default=4114): cv.positive_int,
4  vol.Required(CONF_USERNAME, default=""): str,
5  vol.Required(CONF_PASSWORD, default=""): str,
6  vol.Required(CONF_SK_NUM_TRIES, default=0): cv.positive_int,
7  vol.Required(CONF_DIM_MODE, default="STEPS200"): vol.In(DIM_MODES),
8  vol.Required(CONF_ACKNOWLEDGE, default=False): cv.boolean,
9 }

Definition at line 31 of file config_flow.py.

◆ CONFIG_SCHEMA

homeassistant.components.lcn.config_flow.CONFIG_SCHEMA = vol.Schema(CONFIG_DATA)

Definition at line 43 of file config_flow.py.

◆ USER_DATA

dictionary homeassistant.components.lcn.config_flow.USER_DATA = {vol.Required(CONF_HOST, default="pchk"): str, **CONFIG_DATA}

Definition at line 41 of file config_flow.py.

◆ USER_SCHEMA

homeassistant.components.lcn.config_flow.USER_SCHEMA = vol.Schema(USER_DATA)

Definition at line 44 of file config_flow.py.