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

Classes

class  GuardianConfigFlow
 

Functions

str async_get_pin_from_discovery_hostname (str hostname)
 
str async_get_pin_from_uid (str uid)
 
dict[str, Any] validate_input (HomeAssistant hass, dict[str, Any] data)
 

Variables

 DATA_SCHEMA
 
int DEFAULT_PORT = 7777
 
string UNIQUE_ID = "guardian_{0}"
 

Detailed Description

Config flow for Elexa Guardian integration.

Function Documentation

◆ async_get_pin_from_discovery_hostname()

str homeassistant.components.guardian.config_flow.async_get_pin_from_discovery_hostname ( str  hostname)
Get the device's 4-digit PIN from its zeroconf-discovered hostname.

Definition at line 31 of file config_flow.py.

◆ async_get_pin_from_uid()

str homeassistant.components.guardian.config_flow.async_get_pin_from_uid ( str  uid)
Get the device's 4-digit PIN from its UID.

Definition at line 37 of file config_flow.py.

◆ validate_input()

dict[str, Any] homeassistant.components.guardian.config_flow.validate_input ( HomeAssistant  hass,
dict[str, Any]  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 42 of file config_flow.py.

Variable Documentation

◆ DATA_SCHEMA

homeassistant.components.guardian.config_flow.DATA_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_IP_ADDRESS): str,
4  vol.Required(CONF_PORT, default=DEFAULT_PORT): int,
5  }
6 )

Definition at line 20 of file config_flow.py.

◆ DEFAULT_PORT

int homeassistant.components.guardian.config_flow.DEFAULT_PORT = 7777

Definition at line 18 of file config_flow.py.

◆ UNIQUE_ID

string homeassistant.components.guardian.config_flow.UNIQUE_ID = "guardian_{0}"

Definition at line 27 of file config_flow.py.