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

Classes

class  CannotConnect
 
class  DomainConfigFlow
 
class  InvalidAuth
 
class  InvalidHost
 

Functions

def _try_connect_and_fetch_basic_info (host, token)
 
def validate_input (HomeAssistant hass, data)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 DATA_SCHEMA
 
string RESULT_CANNOT_CONNECT = "cannot_connect"
 
string RESULT_INVALID_AUTH = "invalid_auth"
 
string RESULT_SUCCESS = "success"
 

Detailed Description

Config flow for Vilfo Router integration.

Function Documentation

◆ _try_connect_and_fetch_basic_info()

def homeassistant.components.vilfo.config_flow._try_connect_and_fetch_basic_info (   host,
  token 
)
private
Attempt to connect and call the ping endpoint and, if successful, fetch basic information.

Definition at line 35 of file config_flow.py.

◆ validate_input()

def homeassistant.components.vilfo.config_flow.validate_input ( HomeAssistant  hass,
  data 
)
Validate the user input allows us to connect.

Data has the keys from DATA_SCHEMA with values provided by the user.

Definition at line 69 of file config_flow.py.

Variable Documentation

◆ _LOGGER

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

Definition at line 21 of file config_flow.py.

◆ DATA_SCHEMA

homeassistant.components.vilfo.config_flow.DATA_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_HOST, default=ROUTER_DEFAULT_HOST): str,
4  vol.Required(CONF_ACCESS_TOKEN, default=""): str,
5  }
6 )

Definition at line 23 of file config_flow.py.

◆ RESULT_CANNOT_CONNECT

string homeassistant.components.vilfo.config_flow.RESULT_CANNOT_CONNECT = "cannot_connect"

Definition at line 31 of file config_flow.py.

◆ RESULT_INVALID_AUTH

string homeassistant.components.vilfo.config_flow.RESULT_INVALID_AUTH = "invalid_auth"

Definition at line 32 of file config_flow.py.

◆ RESULT_SUCCESS

string homeassistant.components.vilfo.config_flow.RESULT_SUCCESS = "success"

Definition at line 30 of file config_flow.py.