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

Public Member Functions

None __init__ (self)
 
ConfigFlowResult async_step_addon (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_broker (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_hassio (self, HassioServiceInfo discovery_info)
 
ConfigFlowResult async_step_hassio_confirm (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_install_addon (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_install_failed (self, dict[str, Any]|None user_input=None)
 
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_setup_entry_from_discovery (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_start_addon (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_start_failed (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_user (self, dict[str, Any]|None user_input=None)
 
- 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_mqtt (self, MqttServiceInfo 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

MQTTOptionsFlowHandler 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

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

Static Public Attributes

 None
 
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

dict[str, Any]|None _async_get_config_and_try (self)
 
None _async_install_addon (self)
 
None _async_start_addon (self)
 

Private Attributes

 _addon_manager
 
 _hassio_discovery
 

Detailed Description

Handle a config flow.

Definition at line 204 of file config_flow.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.mqtt.config_flow.FlowHandler.__init__ (   self)
Set up flow instance.

Definition at line 212 of file config_flow.py.

Member Function Documentation

◆ _async_get_config_and_try()

dict[str, Any] | None homeassistant.components.mqtt.config_flow.FlowHandler._async_get_config_and_try (   self)
private
Get the MQTT add-on discovery info and try the connection.

Definition at line 294 of file config_flow.py.

◆ _async_install_addon()

None homeassistant.components.mqtt.config_flow.FlowHandler._async_install_addon (   self)
private
Install the Mosquitto Mqtt broker add-on.

Definition at line 225 of file config_flow.py.

◆ _async_start_addon()

None homeassistant.components.mqtt.config_flow.FlowHandler._async_start_addon (   self)
private
Start the Mosquitto Broker add-on.

Definition at line 321 of file config_flow.py.

◆ async_get_options_flow()

MQTTOptionsFlowHandler homeassistant.components.mqtt.config_flow.FlowHandler.async_get_options_flow ( ConfigEntry  config_entry)
static
Get the options flow for this handler.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 219 of file config_flow.py.

◆ async_step_addon()

ConfigFlowResult homeassistant.components.mqtt.config_flow.FlowHandler.async_step_addon (   self,
dict[str, Any] | None   user_input = None 
)
Install and start MQTT broker add-on.

Definition at line 368 of file config_flow.py.

◆ async_step_broker()

ConfigFlowResult homeassistant.components.mqtt.config_flow.FlowHandler.async_step_broker (   self,
dict[str, Any] | None   user_input = None 
)
Confirm the setup.

Definition at line 463 of file config_flow.py.

◆ async_step_hassio()

ConfigFlowResult homeassistant.components.mqtt.config_flow.FlowHandler.async_step_hassio (   self,
HassioServiceInfo   discovery_info 
)
Receive a Hass.io discovery or process setup after addon install.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 496 of file config_flow.py.

◆ async_step_hassio_confirm()

ConfigFlowResult homeassistant.components.mqtt.config_flow.FlowHandler.async_step_hassio_confirm (   self,
dict[str, Any] | None   user_input = None 
)
Confirm a Hass.io discovery.

Definition at line 506 of file config_flow.py.

◆ async_step_install_addon()

ConfigFlowResult homeassistant.components.mqtt.config_flow.FlowHandler.async_step_install_addon (   self,
dict[str, Any] | None   user_input = None 
)
Install Mosquitto Broker add-on.

Definition at line 239 of file config_flow.py.

◆ async_step_install_failed()

ConfigFlowResult homeassistant.components.mqtt.config_flow.FlowHandler.async_step_install_failed (   self,
dict[str, Any] | None   user_input = None 
)
Add-on installation failed.

Definition at line 230 of file config_flow.py.

◆ async_step_reauth()

ConfigFlowResult homeassistant.components.mqtt.config_flow.FlowHandler.async_step_reauth (   self,
Mapping[str, Any]   entry_data 
)
Handle re-authentication with MQTT broker.

Definition at line 392 of file config_flow.py.

◆ async_step_reauth_confirm()

ConfigFlowResult homeassistant.components.mqtt.config_flow.FlowHandler.async_step_reauth_confirm (   self,
dict[str, Any] | None   user_input = None 
)
Confirm re-authentication with MQTT broker.

Definition at line 428 of file config_flow.py.

◆ async_step_setup_entry_from_discovery()

ConfigFlowResult homeassistant.components.mqtt.config_flow.FlowHandler.async_step_setup_entry_from_discovery (   self,
dict[str, Any] | None   user_input = None 
)
Set up mqtt entry from discovery info.

Definition at line 353 of file config_flow.py.

◆ async_step_start_addon()

ConfigFlowResult homeassistant.components.mqtt.config_flow.FlowHandler.async_step_start_addon (   self,
dict[str, Any] | None   user_input = None 
)
Start Mosquitto Broker add-on.

Definition at line 272 of file config_flow.py.

◆ async_step_start_failed()

ConfigFlowResult homeassistant.components.mqtt.config_flow.FlowHandler.async_step_start_failed (   self,
dict[str, Any] | None   user_input = None 
)
Add-on start failed.

Definition at line 263 of file config_flow.py.

◆ async_step_user()

ConfigFlowResult homeassistant.components.mqtt.config_flow.FlowHandler.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 337 of file config_flow.py.

Member Data Documentation

◆ _addon_manager

homeassistant.components.mqtt.config_flow.FlowHandler._addon_manager
private

Definition at line 343 of file config_flow.py.

◆ _hassio_discovery

homeassistant.components.mqtt.config_flow.FlowHandler._hassio_discovery
private

Definition at line 317 of file config_flow.py.

◆ install_task

homeassistant.components.mqtt.config_flow.FlowHandler.install_task

Definition at line 244 of file config_flow.py.

◆ None

homeassistant.components.mqtt.config_flow.FlowHandler.None
static

Definition at line 209 of file config_flow.py.

◆ start_task

homeassistant.components.mqtt.config_flow.FlowHandler.start_task

Definition at line 277 of file config_flow.py.

◆ VERSION

int homeassistant.components.mqtt.config_flow.FlowHandler.VERSION = 1
static

Definition at line 207 of file config_flow.py.


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