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

Public Member Functions

None __init__ (self)
 
ConfigFlowResult async_step_dhcp (self, dhcp.DhcpServiceInfo discovery_info)
 
ConfigFlowResult async_step_reauth (self, Mapping[str, Any] entry_data)
 
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)
 
ConfigFlowResult async_step_zeroconf (self, zeroconf.ZeroconfServiceInfo discovery_info)
 
- 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)
 
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

AxisOptionsFlowHandler 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

 config
 
 discovery_schema
 
 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 _create_entry (self, str serial)
 
ConfigFlowResult _process_discovered_device (self, dict[str, Any] discovery_info)
 
ConfigFlowResult _redo_configuration (self, Mapping[str, Any] entry_data, bool keep_password)
 

Detailed Description

Handle a Axis config flow.

Definition at line 55 of file config_flow.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.axis.config_flow.AxisFlowHandler.__init__ (   self)
Initialize the Axis config flow.

Definition at line 68 of file config_flow.py.

Member Function Documentation

◆ _create_entry()

ConfigFlowResult homeassistant.components.axis.config_flow.AxisFlowHandler._create_entry (   self,
str  serial 
)
private
Create entry for device.

Generate a name to be used as a prefix for device entities.

Definition at line 135 of file config_flow.py.

◆ _process_discovered_device()

ConfigFlowResult homeassistant.components.axis.config_flow.AxisFlowHandler._process_discovered_device (   self,
dict[str, Any]   discovery_info 
)
private
Prepare configuration for a discovered Axis device.

Definition at line 232 of file config_flow.py.

◆ _redo_configuration()

ConfigFlowResult homeassistant.components.axis.config_flow.AxisFlowHandler._redo_configuration (   self,
Mapping[str, Any entry_data,
bool   keep_password 
)
private
Re-run configuration step.

Definition at line 176 of file config_flow.py.

◆ async_get_options_flow()

AxisOptionsFlowHandler homeassistant.components.axis.config_flow.AxisFlowHandler.async_get_options_flow ( ConfigEntry  config_entry)
static
Get the options flow for this handler.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 62 of file config_flow.py.

◆ async_step_dhcp()

ConfigFlowResult homeassistant.components.axis.config_flow.AxisFlowHandler.async_step_dhcp (   self,
dhcp.DhcpServiceInfo   discovery_info 
)
Prepare configuration for a DHCP discovered Axis device.

Definition at line 192 of file config_flow.py.

◆ async_step_reauth()

ConfigFlowResult homeassistant.components.axis.config_flow.AxisFlowHandler.async_step_reauth (   self,
Mapping[str, Any]   entry_data 
)
Trigger a reauthentication flow.

Definition at line 166 of file config_flow.py.

◆ async_step_reconfigure()

ConfigFlowResult homeassistant.components.axis.config_flow.AxisFlowHandler.async_step_reconfigure (   self,
dict[str, Any] | None   user_input = None 
)
Trigger a reconfiguration flow.

Definition at line 158 of file config_flow.py.

◆ async_step_ssdp()

ConfigFlowResult homeassistant.components.axis.config_flow.AxisFlowHandler.async_step_ssdp (   self,
ssdp.SsdpServiceInfo   discovery_info 
)
Prepare configuration for a SSDP discovered Axis device.

Definition at line 205 of file config_flow.py.

◆ async_step_user()

ConfigFlowResult homeassistant.components.axis.config_flow.AxisFlowHandler.async_step_user (   self,
dict[str, Any] | None   user_input = None 
)
Handle a Axis config flow start.

Manage device specific parameters.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 73 of file config_flow.py.

◆ async_step_zeroconf()

ConfigFlowResult homeassistant.components.axis.config_flow.AxisFlowHandler.async_step_zeroconf (   self,
zeroconf.ZeroconfServiceInfo   discovery_info 
)
Prepare configuration for a Zeroconf discovered Axis device.

Definition at line 219 of file config_flow.py.

Member Data Documentation

◆ config

homeassistant.components.axis.config_flow.AxisFlowHandler.config

Definition at line 116 of file config_flow.py.

◆ discovery_schema

homeassistant.components.axis.config_flow.AxisFlowHandler.discovery_schema

Definition at line 182 of file config_flow.py.

◆ source

homeassistant.components.axis.config_flow.AxisFlowHandler.source

Definition at line 104 of file config_flow.py.

◆ VERSION

int homeassistant.components.axis.config_flow.AxisFlowHandler.VERSION = 3
static

Definition at line 58 of file config_flow.py.


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