Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.esphome.config_flow.EsphomeFlowHandler Class Reference
Inheritance diagram for homeassistant.components.esphome.config_flow.EsphomeFlowHandler:
[legend]
Collaboration diagram for homeassistant.components.esphome.config_flow.EsphomeFlowHandler:
[legend]

Public Member Functions

None __init__ (self)
 
ConfigFlowResult async_step_authenticate (self, dict[str, Any]|None user_input=None, str|None error=None)
 
ConfigFlowResult async_step_dhcp (self, dhcp.DhcpServiceInfo discovery_info)
 
ConfigFlowResult async_step_discovery_confirm (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_encryption_key (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_hassio (self, HassioServiceInfo discovery_info)
 
ConfigFlowResult async_step_mqtt (self, MqttServiceInfo discovery_info)
 
ConfigFlowResult async_step_reauth (self, Mapping[str, Any] entry_data)
 
ConfigFlowResult async_step_reauth_confirm (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_user (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_zeroconf (self, zeroconf.ZeroconfServiceInfo discovery_info)
 
str|None fetch_device_info (self)
 
str|None try_login (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_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_ssdp (self, SsdpServiceInfo discovery_info)
 
ConfigFlowResult async_step_usb (self, UsbServiceInfo discovery_info)
 
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

OptionsFlowHandler 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 = 1
 
- 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_authenticate_or_add (self)
 
ConfigFlowResult _async_get_entry (self)
 
ConfigFlowResult _async_step_user_base (self, dict[str, Any]|None user_input=None, str|None error=None)
 
ConfigFlowResult _async_try_fetch_device_info (self)
 
str _name (self)
 
None _name (self, str value)
 
bool _retrieve_encryption_key_from_dashboard (self)
 

Private Attributes

 __name
 
 _device_info
 
 _device_name
 
 _host
 
 _name
 
 _noise_psk
 
 _noise_required
 
 _password
 
 _port
 
 _reauth_entry
 

Detailed Description

Handle a esphome config flow.

Definition at line 56 of file config_flow.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.esphome.config_flow.EsphomeFlowHandler.__init__ (   self)
Initialize flow.

Definition at line 63 of file config_flow.py.

Member Function Documentation

◆ _async_authenticate_or_add()

ConfigFlowResult homeassistant.components.esphome.config_flow.EsphomeFlowHandler._async_authenticate_or_add (   self)
private

Definition at line 206 of file config_flow.py.

◆ _async_get_entry()

ConfigFlowResult homeassistant.components.esphome.config_flow.EsphomeFlowHandler._async_get_entry (   self)
private

Definition at line 318 of file config_flow.py.

◆ _async_step_user_base()

ConfigFlowResult homeassistant.components.esphome.config_flow.EsphomeFlowHandler._async_step_user_base (   self,
dict[str, Any] | None   user_input = None,
str | None   error = None 
)
private

Definition at line 75 of file config_flow.py.

◆ _async_try_fetch_device_info()

ConfigFlowResult homeassistant.components.esphome.config_flow.EsphomeFlowHandler._async_try_fetch_device_info (   self)
private
Try to fetch device info and return any errors.

Definition at line 164 of file config_flow.py.

◆ _name() [1/2]

str homeassistant.components.esphome.config_flow.EsphomeFlowHandler._name (   self)
private

Definition at line 156 of file config_flow.py.

◆ _name() [2/2]

None homeassistant.components.esphome.config_flow.EsphomeFlowHandler._name (   self,
str  value 
)
private

Definition at line 160 of file config_flow.py.

◆ _retrieve_encryption_key_from_dashboard()

bool homeassistant.components.esphome.config_flow.EsphomeFlowHandler._retrieve_encryption_key_from_dashboard (   self)
private
Try to retrieve the encryption key from the dashboard.

Return boolean if a key was retrieved.

Definition at line 448 of file config_flow.py.

◆ async_get_options_flow()

OptionsFlowHandler homeassistant.components.esphome.config_flow.EsphomeFlowHandler.async_get_options_flow ( ConfigEntry  config_entry)
static
Get the options flow for this handler.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 484 of file config_flow.py.

◆ async_step_authenticate()

ConfigFlowResult homeassistant.components.esphome.config_flow.EsphomeFlowHandler.async_step_authenticate (   self,
dict[str, Any] | None   user_input = None,
str | None   error = None 
)
Handle getting password for authentication.

Definition at line 361 of file config_flow.py.

◆ async_step_dhcp()

ConfigFlowResult homeassistant.components.esphome.config_flow.EsphomeFlowHandler.async_step_dhcp (   self,
dhcp.DhcpServiceInfo   discovery_info 
)
Handle DHCP discovery.

Definition at line 295 of file config_flow.py.

◆ async_step_discovery_confirm()

ConfigFlowResult homeassistant.components.esphome.config_flow.EsphomeFlowHandler.async_step_discovery_confirm (   self,
dict[str, Any] | None   user_input = None 
)
Handle user-confirmation of discovered node.

Definition at line 215 of file config_flow.py.

◆ async_step_encryption_key()

ConfigFlowResult homeassistant.components.esphome.config_flow.EsphomeFlowHandler.async_step_encryption_key (   self,
dict[str, Any] | None   user_input = None 
)
Handle getting psk for transport encryption.

Definition at line 342 of file config_flow.py.

◆ async_step_hassio()

ConfigFlowResult homeassistant.components.esphome.config_flow.EsphomeFlowHandler.async_step_hassio (   self,
HassioServiceInfo   discovery_info 
)
Handle Supervisor service discovery.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 305 of file config_flow.py.

◆ async_step_mqtt()

ConfigFlowResult homeassistant.components.esphome.config_flow.EsphomeFlowHandler.async_step_mqtt (   self,
MqttServiceInfo   discovery_info 
)
Handle MQTT discovery.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 256 of file config_flow.py.

◆ async_step_reauth()

ConfigFlowResult homeassistant.components.esphome.config_flow.EsphomeFlowHandler.async_step_reauth (   self,
Mapping[str, Any]   entry_data 
)
Handle a flow initialized by a reauth event.

Definition at line 104 of file config_flow.py.

◆ async_step_reauth_confirm()

ConfigFlowResult homeassistant.components.esphome.config_flow.EsphomeFlowHandler.async_step_reauth_confirm (   self,
dict[str, Any] | None   user_input = None 
)
Handle reauthorization flow.

Definition at line 130 of file config_flow.py.

◆ async_step_user()

ConfigFlowResult homeassistant.components.esphome.config_flow.EsphomeFlowHandler.async_step_user (   self,
dict[str, Any] | None   user_input = None 
)
Handle a flow initialized by the user.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 98 of file config_flow.py.

◆ async_step_zeroconf()

ConfigFlowResult homeassistant.components.esphome.config_flow.EsphomeFlowHandler.async_step_zeroconf (   self,
zeroconf.ZeroconfServiceInfo   discovery_info 
)
Handle zeroconf discovery.

Definition at line 225 of file config_flow.py.

◆ fetch_device_info()

str | None homeassistant.components.esphome.config_flow.EsphomeFlowHandler.fetch_device_info (   self)
Fetch device info from API and return any errors.

Definition at line 383 of file config_flow.py.

◆ try_login()

str | None homeassistant.components.esphome.config_flow.EsphomeFlowHandler.try_login (   self)
Try logging in to device and return any errors.

Definition at line 424 of file config_flow.py.

Member Data Documentation

◆ __name

homeassistant.components.esphome.config_flow.EsphomeFlowHandler.__name
private

Definition at line 161 of file config_flow.py.

◆ _device_info

homeassistant.components.esphome.config_flow.EsphomeFlowHandler._device_info
private

Definition at line 398 of file config_flow.py.

◆ _device_name

homeassistant.components.esphome.config_flow.EsphomeFlowHandler._device_name
private

Definition at line 113 of file config_flow.py.

◆ _host

homeassistant.components.esphome.config_flow.EsphomeFlowHandler._host
private

Definition at line 79 of file config_flow.py.

◆ _name

homeassistant.components.esphome.config_flow.EsphomeFlowHandler._name
private

Definition at line 112 of file config_flow.py.

◆ _noise_psk

homeassistant.components.esphome.config_flow.EsphomeFlowHandler._noise_psk
private

Definition at line 142 of file config_flow.py.

◆ _noise_required

homeassistant.components.esphome.config_flow.EsphomeFlowHandler._noise_required
private

Definition at line 246 of file config_flow.py.

◆ _password

homeassistant.components.esphome.config_flow.EsphomeFlowHandler._password
private

Definition at line 111 of file config_flow.py.

◆ _port

homeassistant.components.esphome.config_flow.EsphomeFlowHandler._port
private

Definition at line 80 of file config_flow.py.

◆ _reauth_entry

homeassistant.components.esphome.config_flow.EsphomeFlowHandler._reauth_entry
private

Definition at line 108 of file config_flow.py.

◆ source

homeassistant.components.esphome.config_flow.EsphomeFlowHandler.source

Definition at line 330 of file config_flow.py.

◆ VERSION

int homeassistant.components.esphome.config_flow.EsphomeFlowHandler.VERSION = 1
static

Definition at line 59 of file config_flow.py.


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