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

Classes

class  AsusWrtFlowHandler
 

Functions

str|None _get_ip (str host)
 
bool _is_file (str value)
 
vol.Schema get_options_schema (SchemaCommonFlowHandler handler)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
list ALLOWED_PROTOCOL
 
 LEGACY_SCHEMA
 
dictionary OPTIONS_FLOW
 
 OPTIONS_SCHEMA
 
string PASS_KEY = "pass_key"
 
string PASS_KEY_MSG = "Only provide password or SSH key file"
 
string RESULT_CONN_ERROR = "cannot_connect"
 
string RESULT_SUCCESS = "success"
 
string RESULT_UNKNOWN = "unknown"
 

Detailed Description

Config flow to configure the AsusWrt integration.

Function Documentation

◆ _get_ip()

str | None homeassistant.components.asuswrt.config_flow._get_ip ( str  host)
private
Get the ip address from the host name.

Definition at line 124 of file config_flow.py.

◆ _is_file()

bool homeassistant.components.asuswrt.config_flow._is_file ( str  value)
private
Validate that the value is an existing file.

Definition at line 118 of file config_flow.py.

◆ get_options_schema()

vol.Schema homeassistant.components.asuswrt.config_flow.get_options_schema ( SchemaCommonFlowHandler  handler)
Get options schema.

Definition at line 90 of file config_flow.py.

Variable Documentation

◆ _LOGGER

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

Definition at line 70 of file config_flow.py.

◆ ALLOWED_PROTOCOL

list homeassistant.components.asuswrt.config_flow.ALLOWED_PROTOCOL
Initial value:
1 = [
2  PROTOCOL_HTTPS,
3  PROTOCOL_SSH,
4  PROTOCOL_HTTP,
5  PROTOCOL_TELNET,
6 ]

Definition at line 56 of file config_flow.py.

◆ LEGACY_SCHEMA

homeassistant.components.asuswrt.config_flow.LEGACY_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_MODE, default=MODE_ROUTER): vol.In(
4  {MODE_ROUTER: "Router", MODE_AP: "Access Point"}
5  ),
6  }
7 )

Definition at line 72 of file config_flow.py.

◆ OPTIONS_FLOW

dictionary homeassistant.components.asuswrt.config_flow.OPTIONS_FLOW
Initial value:
1 = {
2  "init": SchemaFlowFormStep(get_options_schema),
3 }

Definition at line 113 of file config_flow.py.

◆ OPTIONS_SCHEMA

homeassistant.components.asuswrt.config_flow.OPTIONS_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Optional(
4  CONF_CONSIDER_HOME, default=DEFAULT_CONSIDER_HOME.total_seconds()
5  ): vol.All(vol.Coerce(int), vol.Clamp(min=0, max=900)),
6  vol.Optional(CONF_TRACK_UNKNOWN, default=DEFAULT_TRACK_UNKNOWN): bool,
7  }
8 )

Definition at line 80 of file config_flow.py.

◆ PASS_KEY

string homeassistant.components.asuswrt.config_flow.PASS_KEY = "pass_key"

Definition at line 63 of file config_flow.py.

◆ PASS_KEY_MSG

string homeassistant.components.asuswrt.config_flow.PASS_KEY_MSG = "Only provide password or SSH key file"

Definition at line 64 of file config_flow.py.

◆ RESULT_CONN_ERROR

string homeassistant.components.asuswrt.config_flow.RESULT_CONN_ERROR = "cannot_connect"

Definition at line 66 of file config_flow.py.

◆ RESULT_SUCCESS

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

Definition at line 67 of file config_flow.py.

◆ RESULT_UNKNOWN

string homeassistant.components.asuswrt.config_flow.RESULT_UNKNOWN = "unknown"

Definition at line 68 of file config_flow.py.