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

Public Member Functions

None __init__ (self)
 
ConfigEntry|None async_check_configured_entry (self)
 
str|None async_fritz_tools_init (self)
 
ConfigFlowResult async_step_confirm (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_reconfigure (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_ssdp (self, ssdp.SsdpServiceInfo discovery_info)
 
ConfigFlowResult async_step_user (self, dict[str, Any]|None user_input=None)
 
str|None fritz_tools_init (self)
 
bool is_matching (self, Self other_flow)
 
- 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_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)
 
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

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

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_create_entry (self)
 
int _determine_port (self, dict[str, Any] user_input)
 
ConfigFlowResult _show_setup_form_confirm (self, dict[str, str]|None errors=None)
 
ConfigFlowResult _show_setup_form_init (self, dict[str, str]|None errors=None)
 
ConfigFlowResult _show_setup_form_reauth_confirm (self, dict[str, Any] user_input, dict[str, str]|None errors=None)
 
ConfigFlowResult _show_setup_form_reconfigure (self, dict[str, Any] user_input, dict[str, str]|None errors=None)
 

Private Attributes

 _host
 
 _model
 
 _name
 
 _password
 
 _port
 
 _use_tls
 
 _username
 

Additional Inherited Members

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

Detailed Description

Handle a FRITZ!Box Tools config flow.

Definition at line 55 of file config_flow.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.fritz.config_flow.FritzBoxToolsFlowHandler.__init__ (   self)
Initialize FRITZ!Box Tools flow.

Definition at line 70 of file config_flow.py.

Member Function Documentation

◆ _async_create_entry()

ConfigFlowResult homeassistant.components.fritz.config_flow.FritzBoxToolsFlowHandler._async_create_entry (   self)
private
Async create flow handler entry.

Definition at line 129 of file config_flow.py.

◆ _determine_port()

int homeassistant.components.fritz.config_flow.FritzBoxToolsFlowHandler._determine_port (   self,
dict[str, Any user_input 
)
private
Determine port from user_input.

Definition at line 146 of file config_flow.py.

◆ _show_setup_form_confirm()

ConfigFlowResult homeassistant.components.fritz.config_flow.FritzBoxToolsFlowHandler._show_setup_form_confirm (   self,
dict[str, str] | None   errors = None 
)
private
Show the setup form to the user.

Definition at line 242 of file config_flow.py.

◆ _show_setup_form_init()

ConfigFlowResult homeassistant.components.fritz.config_flow.FritzBoxToolsFlowHandler._show_setup_form_init (   self,
dict[str, str] | None   errors = None 
)
private
Show the setup form to the user.

Definition at line 217 of file config_flow.py.

◆ _show_setup_form_reauth_confirm()

ConfigFlowResult homeassistant.components.fritz.config_flow.FritzBoxToolsFlowHandler._show_setup_form_reauth_confirm (   self,
dict[str, Any user_input,
dict[str, str] | None   errors = None 
)
private
Show the reauth form to the user.

Definition at line 295 of file config_flow.py.

◆ _show_setup_form_reconfigure()

ConfigFlowResult homeassistant.components.fritz.config_flow.FritzBoxToolsFlowHandler._show_setup_form_reconfigure (   self,
dict[str, Any user_input,
dict[str, str] | None   errors = None 
)
private
Show the reconfigure form to the user.

Definition at line 340 of file config_flow.py.

◆ async_check_configured_entry()

ConfigEntry | None homeassistant.components.fritz.config_flow.FritzBoxToolsFlowHandler.async_check_configured_entry (   self)
Check if entry is configured.

Definition at line 114 of file config_flow.py.

◆ async_fritz_tools_init()

str | None homeassistant.components.fritz.config_flow.FritzBoxToolsFlowHandler.async_fritz_tools_init (   self)
Initialize FRITZ!Box Tools class.

Definition at line 79 of file config_flow.py.

◆ async_get_options_flow()

FritzBoxToolsOptionsFlowHandler homeassistant.components.fritz.config_flow.FritzBoxToolsFlowHandler.async_get_options_flow ( ConfigEntry  config_entry)
static
Get the options flow for this handler.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 64 of file config_flow.py.

◆ async_step_confirm()

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

Definition at line 195 of file config_flow.py.

◆ async_step_reauth()

ConfigFlowResult homeassistant.components.fritz.config_flow.FritzBoxToolsFlowHandler.async_step_reauth (   self,
Mapping[str, Any]   entry_data 
)
Handle flow upon an API authentication error.

Definition at line 283 of file config_flow.py.

◆ async_step_reauth_confirm()

ConfigFlowResult homeassistant.components.fritz.config_flow.FritzBoxToolsFlowHandler.async_step_reauth_confirm (   self,
dict[str, Any] | None   user_input = None 
)
Dialog that informs the user that reauth is required.

Definition at line 312 of file config_flow.py.

◆ async_step_reconfigure()

ConfigFlowResult homeassistant.components.fritz.config_flow.FritzBoxToolsFlowHandler.async_step_reconfigure (   self,
dict[str, Any] | None   user_input = None 
)
Handle reconfigure flow.

Definition at line 363 of file config_flow.py.

◆ async_step_ssdp()

ConfigFlowResult homeassistant.components.fritz.config_flow.FritzBoxToolsFlowHandler.async_step_ssdp (   self,
ssdp.SsdpServiceInfo   discovery_info 
)
Handle a flow initialized by discovery.

Definition at line 152 of file config_flow.py.

◆ async_step_user()

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

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 259 of file config_flow.py.

◆ fritz_tools_init()

str | None homeassistant.components.fritz.config_flow.FritzBoxToolsFlowHandler.fritz_tools_init (   self)
Initialize FRITZ!Box Tools class.

Definition at line 83 of file config_flow.py.

◆ is_matching()

bool homeassistant.components.fritz.config_flow.FritzBoxToolsFlowHandler.is_matching (   self,
Self  other_flow 
)
Return True if other_flow is matching this flow.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 191 of file config_flow.py.

Member Data Documentation

◆ _host

homeassistant.components.fritz.config_flow.FritzBoxToolsFlowHandler._host
private

Definition at line 161 of file config_flow.py.

◆ _model

homeassistant.components.fritz.config_flow.FritzBoxToolsFlowHandler._model
private

Definition at line 104 of file config_flow.py.

◆ _name

homeassistant.components.fritz.config_flow.FritzBoxToolsFlowHandler._name
private

Definition at line 162 of file config_flow.py.

◆ _password

homeassistant.components.fritz.config_flow.FritzBoxToolsFlowHandler._password
private

Definition at line 205 of file config_flow.py.

◆ _port

homeassistant.components.fritz.config_flow.FritzBoxToolsFlowHandler._port
private

Definition at line 207 of file config_flow.py.

◆ _use_tls

homeassistant.components.fritz.config_flow.FritzBoxToolsFlowHandler._use_tls
private

Definition at line 206 of file config_flow.py.

◆ _username

homeassistant.components.fritz.config_flow.FritzBoxToolsFlowHandler._username
private

Definition at line 204 of file config_flow.py.

◆ VERSION

int homeassistant.components.fritz.config_flow.FritzBoxToolsFlowHandler.VERSION = 1
static

Definition at line 58 of file config_flow.py.


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