homeassistant.components.airvisual.config_flow.AirVisualFlowHandler Class Reference

Inheritance diagram for homeassistant.components.airvisual.config_flow.AirVisualFlowHandler:

Collaboration diagram for homeassistant.components.airvisual.config_flow.AirVisualFlowHandler:

Public Member Functions
None	__init__ (self)
ConfigFlowResult	async_step_geography_by_coords (self, dict[str, str]|None user_input=None)
ConfigFlowResult	async_step_geography_by_name (self, dict[str, str]|None user_input=None)
ConfigFlowResult	async_step_import (self, dict[str, str] import_data)
ConfigFlowResult	async_step_reauth (self, Mapping[str, Any] entry_data)
ConfigFlowResult	async_step_reauth_confirm (self, dict[str, str]|None user_input=None)
ConfigFlowResult	async_step_user (self, dict[str, str]|None user_input=None)
vol.Schema	geography_coords_schema (self)
Public Member Functions inherited from homeassistant.config_entries.ConfigFlow
None	__init_subclass__ (cls, *str|None domain=None, **Any kwargs)
ConfigFlowResult	async_abort (self, *str reason, Mapping[str, str]|None description_placeholders=None)
ConfigFlowResult	async_create_entry (self, *str title, Mapping[str, Any] data, str|None description=None, Mapping[str, str]|None description_placeholders=None, Mapping[str, Any]|None options=None)
ConfigEntry|None	async_set_unique_id (self, str|None unique_id=None, *bool raise_on_progress=True)
ConfigFlowResult	async_show_form (self, *str|None step_id=None, vol.Schema|None data_schema=None, dict[str, str]|None errors=None, Mapping[str, str]|None description_placeholders=None, bool|None last_step=None, str|None preview=None)
ConfigFlowResult	async_step_bluetooth (self, BluetoothServiceInfoBleak discovery_info)
ConfigFlowResult	async_step_dhcp (self, DhcpServiceInfo discovery_info)
ConfigFlowResult	async_step_discovery (self, DiscoveryInfoType discovery_info)
ConfigFlowResult	async_step_hassio (self, HassioServiceInfo discovery_info)
ConfigFlowResult	async_step_homekit (self, ZeroconfServiceInfo discovery_info)
ConfigFlowResult	async_step_ignore (self, dict[str, Any] user_input)
ConfigFlowResult	async_step_integration_discovery (self, DiscoveryInfoType discovery_info)
ConfigFlowResult	async_step_mqtt (self, MqttServiceInfo discovery_info)
ConfigFlowResult	async_step_ssdp (self, SsdpServiceInfo discovery_info)
ConfigFlowResult	async_step_usb (self, UsbServiceInfo discovery_info)
ConfigFlowResult	async_step_user (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_zeroconf (self, ZeroconfServiceInfo discovery_info)
bool	async_supports_options_flow (cls, ConfigEntry config_entry)
ConfigFlowResult	async_update_reload_and_abort (self, ConfigEntry entry, *str|None|UndefinedType unique_id=UNDEFINED, str|UndefinedType title=UNDEFINED, Mapping[str, Any]|UndefinedType data=UNDEFINED, Mapping[str, Any]|UndefinedType data_updates=UNDEFINED, Mapping[str, Any]|UndefinedType options=UNDEFINED, str|UndefinedType reason=UNDEFINED, bool reload_even_if_entry_is_unchanged=True)
bool	is_matching (self, Self other_flow)
str|None	unique_id (self)
Public Member Functions inherited from homeassistant.data_entry_flow.FlowHandler
vol.Schema	add_suggested_values_to_schema (self, vol.Schema data_schema, Mapping[str, Any]|None suggested_values)
None	async_cancel_progress_task (self)
_FlowResultT	async_create_entry (self, *str|None title=None, Mapping[str, Any] data, str|None description=None, Mapping[str, str]|None description_placeholders=None)
_FlowResultT	async_external_step (self, *str|None step_id=None, str url, Mapping[str, str]|None description_placeholders=None)
_FlowResultT	async_external_step_done (self, *str next_step_id)
asyncio.Task[Any]|None	async_get_progress_task (self)
None	async_remove (self)
None	async_set_progress_task (self, asyncio.Task[Any] progress_task)
_FlowResultT	async_show_menu (self, *str|None step_id=None, Container[str] menu_options, Mapping[str, str]|None description_placeholders=None)
_FlowResultT	async_show_progress (self, *str|None step_id=None, str progress_action, Mapping[str, str]|None description_placeholders=None, asyncio.Task[Any]|None progress_task=None)
_FlowResultT	async_show_progress_done (self, *str next_step_id)
bool	show_advanced_options (self)
str|None	source (self)

Static Public Member Functions
SchemaOptionsFlowHandler	async_get_options_flow (ConfigEntry config_entry)
Static Public Member Functions inherited from homeassistant.data_entry_flow.FlowHandler
None	async_setup_preview (HomeAssistant hass)

Public Attributes
	source
Public Attributes inherited from homeassistant.config_entries.ConfigFlow
	source
Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
	deprecated_show_progress

Static Public Attributes
int	VERSION = 3
Static Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
	Any
bool	deprecated_show_progress = False
	HomeAssistant
string	init_step = "init"
int	MINOR_VERSION = 1
	None
	str
int	VERSION = 1

Private Member Functions
ConfigFlowResult	_async_finish_geography (self, dict[str, str] user_input, str integration_type)
ConfigFlowResult	_async_init_geography (self, dict[str, str] user_input, str integration_type)
None	_async_set_unique_id (self, str unique_id)

Private Attributes
	_entry_data_for_reauth
	_geo_id

Detailed Description

Handle an AirVisual config flow.

Definition at line 77 of file config_flow.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.airvisual.config_flow.AirVisualFlowHandler.__init__

(

self

)

Initialize the config flow.

Definition at line 82 of file config_flow.py.

Member Function Documentation

_async_finish_geography()

ConfigFlowResult homeassistant.components.airvisual.config_flow.AirVisualFlowHandler._async_finish_geography (   self, dict[str, str]  user_input, str   integration_type  )

private

Validate a Cloud API key.

Definition at line 101 of file config_flow.py.

_async_init_geography()

ConfigFlowResult homeassistant.components.airvisual.config_flow.AirVisualFlowHandler._async_init_geography (   self, dict[str, str]  user_input, str   integration_type  )

private

Handle the initialization of the integration via the cloud API.

Definition at line 159 of file config_flow.py.

_async_set_unique_id()

None homeassistant.components.airvisual.config_flow.AirVisualFlowHandler._async_set_unique_id (   self, str  unique_id  )

private

Set the unique ID of the config flow and abort if it already exists.

Definition at line 168 of file config_flow.py.

async_get_options_flow()

SchemaOptionsFlowHandler homeassistant.components.airvisual.config_flow.AirVisualFlowHandler.async_get_options_flow ( ConfigEntry  config_entry )

static

Define the config flow to handle options.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 175 of file config_flow.py.

async_step_geography_by_coords()

ConfigFlowResult homeassistant.components.airvisual.config_flow.AirVisualFlowHandler.async_step_geography_by_coords	(		self,
		dict[str, str] | None	user_input = None
	)

Handle the initialization of the cloud API based on latitude/longitude.

Definition at line 186 of file config_flow.py.

async_step_geography_by_name()

ConfigFlowResult homeassistant.components.airvisual.config_flow.AirVisualFlowHandler.async_step_geography_by_name	(		self,
		dict[str, str] | None	user_input = None
	)

Handle the initialization of the cloud API based on city/state/country.

Definition at line 199 of file config_flow.py.

async_step_import()

ConfigFlowResult homeassistant.components.airvisual.config_flow.AirVisualFlowHandler.async_step_import	(		self,
		dict[str, str]	import_data
	)

Handle import of config entry version 1 data.

Definition at line 179 of file config_flow.py.

async_step_reauth()

ConfigFlowResult homeassistant.components.airvisual.config_flow.AirVisualFlowHandler.async_step_reauth	(		self,
		Mapping[str, Any]	entry_data
	)

Handle configuration by re-auth.

Definition at line 212 of file config_flow.py.

async_step_reauth_confirm()

ConfigFlowResult homeassistant.components.airvisual.config_flow.AirVisualFlowHandler.async_step_reauth_confirm	(		self,
		dict[str, str] | None	user_input = None
	)

Handle re-auth completion.

Definition at line 220 of file config_flow.py.

async_step_user()

ConfigFlowResult homeassistant.components.airvisual.config_flow.AirVisualFlowHandler.async_step_user	(		self,
		dict[str, str] | None	user_input = None
	)

Handle the start of the config flow.

Definition at line 235 of file config_flow.py.

geography_coords_schema()

vol.Schema homeassistant.components.airvisual.config_flow.AirVisualFlowHandler.geography_coords_schema

(

self

)

Return the data schema for the cloud API.

Definition at line 88 of file config_flow.py.

Member Data Documentation

_entry_data_for_reauth

homeassistant.components.airvisual.config_flow.AirVisualFlowHandler._entry_data_for_reauth

private

Definition at line 216 of file config_flow.py.

_geo_id

homeassistant.components.airvisual.config_flow.AirVisualFlowHandler._geo_id

private

Definition at line 163 of file config_flow.py.

source

homeassistant.components.airvisual.config_flow.AirVisualFlowHandler.source

Definition at line 148 of file config_flow.py.

VERSION

int homeassistant.components.airvisual.config_flow.AirVisualFlowHandler.VERSION = 3

static

Definition at line 80 of file config_flow.py.

---

The documentation for this class was generated from the following file:

• core/homeassistant/components/airvisual/config_flow.py