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

Public Member Functions

None __init__ (self)
 
ConfigFlowResult async_step_finish_addon_setup (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_manual (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_on_supervisor (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)
 
ConfigFlowResult async_step_zeroconf (self, 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_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)
 
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)
 

Public Attributes

 install_task
 
 integration_created_addon
 
 start_task
 
 use_addon
 
 ws_address
 
- 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_create_entry_or_abort (self)
 
dict _async_get_addon_discovery_info (self)
 
AddonInfo _async_get_addon_info (self)
 
None _async_install_addon (self)
 
None _async_start_addon (self)
 

Private Attributes

 _running_in_background
 

Additional Inherited Members

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

Detailed Description

Handle a config flow for Matter.

Definition at line 62 of file config_flow.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.matter.config_flow.MatterConfigFlow.__init__ (   self)
Set up flow instance.

Definition at line 67 of file config_flow.py.

Member Function Documentation

◆ _async_create_entry_or_abort()

ConfigFlowResult homeassistant.components.matter.config_flow.MatterConfigFlow._async_create_entry_or_abort (   self)
private
Return a config entry for the flow or abort if already configured.

Definition at line 318 of file config_flow.py.

◆ _async_get_addon_discovery_info()

dict homeassistant.components.matter.config_flow.MatterConfigFlow._async_get_addon_discovery_info (   self)
private
Return add-on discovery info.

Definition at line 118 of file config_flow.py.

◆ _async_get_addon_info()

AddonInfo homeassistant.components.matter.config_flow.MatterConfigFlow._async_get_addon_info (   self)
private
Return Matter Server add-on info.

Definition at line 188 of file config_flow.py.

◆ _async_install_addon()

None homeassistant.components.matter.config_flow.MatterConfigFlow._async_install_addon (   self)
private
Install the Matter Server add-on.

Definition at line 113 of file config_flow.py.

◆ _async_start_addon()

None homeassistant.components.matter.config_flow.MatterConfigFlow._async_start_addon (   self)
private
Start the Matter Server add-on.

Definition at line 162 of file config_flow.py.

◆ async_step_finish_addon_setup()

ConfigFlowResult homeassistant.components.matter.config_flow.MatterConfigFlow.async_step_finish_addon_setup (   self,
dict[str, Any] | None   user_input = None 
)
Prepare info needed to complete the config entry.

Definition at line 301 of file config_flow.py.

◆ async_step_hassio()

ConfigFlowResult homeassistant.components.matter.config_flow.MatterConfigFlow.async_step_hassio (   self,
HassioServiceInfo   discovery_info 
)
Receive configuration from add-on discovery info.

This flow is triggered by the Matter Server add-on.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 249 of file config_flow.py.

◆ async_step_hassio_confirm()

ConfigFlowResult homeassistant.components.matter.config_flow.MatterConfigFlow.async_step_hassio_confirm (   self,
dict[str, Any] | None   user_input = None 
)
Confirm the add-on discovery.

Definition at line 267 of file config_flow.py.

◆ async_step_install_addon()

ConfigFlowResult homeassistant.components.matter.config_flow.MatterConfigFlow.async_step_install_addon (   self,
dict[str, Any] | None   user_input = None 
)
Install Matter Server add-on.

Definition at line 77 of file config_flow.py.

◆ async_step_install_failed()

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

Definition at line 107 of file config_flow.py.

◆ async_step_manual()

ConfigFlowResult homeassistant.components.matter.config_flow.MatterConfigFlow.async_step_manual (   self,
dict[str, Any] | None   user_input = None 
)
Handle a manual configuration.

Definition at line 208 of file config_flow.py.

◆ async_step_on_supervisor()

ConfigFlowResult homeassistant.components.matter.config_flow.MatterConfigFlow.async_step_on_supervisor (   self,
dict[str, Any] | None   user_input = None 
)
Handle logic when on Supervisor host.

Definition at line 278 of file config_flow.py.

◆ async_step_start_addon()

ConfigFlowResult homeassistant.components.matter.config_flow.MatterConfigFlow.async_step_start_addon (   self,
dict[str, Any] | None   user_input = None 
)
Start Matter Server add-on.

Definition at line 129 of file config_flow.py.

◆ async_step_start_failed()

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

Definition at line 156 of file config_flow.py.

◆ async_step_user()

ConfigFlowResult homeassistant.components.matter.config_flow.MatterConfigFlow.async_step_user (   self,
dict[str, Any] | None   user_input = None 
)
Handle the initial step.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 199 of file config_flow.py.

◆ async_step_zeroconf()

ConfigFlowResult homeassistant.components.matter.config_flow.MatterConfigFlow.async_step_zeroconf (   self,
ZeroconfServiceInfo   discovery_info 
)
Handle zeroconf discovery.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 237 of file config_flow.py.

Member Data Documentation

◆ _running_in_background

homeassistant.components.matter.config_flow.MatterConfigFlow._running_in_background
private

Definition at line 69 of file config_flow.py.

◆ install_task

homeassistant.components.matter.config_flow.MatterConfigFlow.install_task

Definition at line 82 of file config_flow.py.

◆ integration_created_addon

homeassistant.components.matter.config_flow.MatterConfigFlow.integration_created_addon

Definition at line 72 of file config_flow.py.

◆ start_task

homeassistant.components.matter.config_flow.MatterConfigFlow.start_task

Definition at line 134 of file config_flow.py.

◆ use_addon

homeassistant.components.matter.config_flow.MatterConfigFlow.use_addon

Definition at line 75 of file config_flow.py.

◆ VERSION

int homeassistant.components.matter.config_flow.MatterConfigFlow.VERSION = 1
static
Handle a config flow for Matter.

Definition at line 65 of file config_flow.py.

◆ ws_address

homeassistant.components.matter.config_flow.MatterConfigFlow.ws_address

Definition at line 173 of file config_flow.py.


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