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

Classes

class  CannotConnect
 
class  IskraConfigFlowFlow
 
class  UnknownException
 

Functions

BasicInfo test_modbus_connection (str host, dict[str, Any] user_input)
 
BasicInfo test_rest_api_connection (str host, dict[str, Any] user_input)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 STEP_AUTHENTICATION_DATA_SCHEMA
 
 STEP_MODBUS_TCP_DATA_SCHEMA
 
 STEP_USER_DATA_SCHEMA
 

Detailed Description

Config flow for iskra integration.

Function Documentation

◆ test_modbus_connection()

BasicInfo homeassistant.components.iskra.config_flow.test_modbus_connection ( str  host,
dict[str, Any]  user_input 
)
Test the Modbus connection.

Definition at line 92 of file config_flow.py.

◆ test_rest_api_connection()

BasicInfo homeassistant.components.iskra.config_flow.test_rest_api_connection ( str  host,
dict[str, Any]  user_input 
)
Check if the RestAPI requires authentication.

Definition at line 75 of file config_flow.py.

Variable Documentation

◆ _LOGGER

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

Definition at line 39 of file config_flow.py.

◆ STEP_AUTHENTICATION_DATA_SCHEMA

homeassistant.components.iskra.config_flow.STEP_AUTHENTICATION_DATA_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_USERNAME): str,
4  vol.Required(CONF_PASSWORD): str,
5  }
6 )

Definition at line 55 of file config_flow.py.

◆ STEP_MODBUS_TCP_DATA_SCHEMA

homeassistant.components.iskra.config_flow.STEP_MODBUS_TCP_DATA_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_PORT, default=10001): vol.All(
4  vol.Coerce(int), vol.Range(min=0, max=65535)
5  ),
6  vol.Required(CONF_ADDRESS, default=33): NumberSelector(
7  NumberSelectorConfig(min=1, max=255, mode=NumberSelectorMode.BOX)
8  ),
9  }
10 )

Definition at line 63 of file config_flow.py.

◆ STEP_USER_DATA_SCHEMA

homeassistant.components.iskra.config_flow.STEP_USER_DATA_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_HOST): str,
4  vol.Required(CONF_PROTOCOL, default="rest_api"): SelectSelector(
5  SelectSelectorConfig(
6  options=["rest_api", "modbus_tcp"],
7  mode=SelectSelectorMode.LIST,
8  translation_key="protocol",
9  ),
10  ),
11  }
12 )

Definition at line 42 of file config_flow.py.