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

Public Member Functions

None __init__ (self)
 
ConfigFlowResult async_step_choose_automatic_backup (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_choose_formation_strategy (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_choose_serial_port (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_form_initial_network (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_form_new_network (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_manual_pick_radio_type (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_manual_port_config (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_maybe_confirm_ezsp_restore (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_reuse_settings (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_upload_manual_backup (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_verify_radio (self, dict[str, Any]|None user_input=None)
 
HomeAssistant hass (self)
 
None hass (self, HomeAssistant hass)
 
- 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)
 
_FlowResultT async_abort (self, *str reason, Mapping[str, str]|None description_placeholders=None)
 
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_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)
 
_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)
 

Private Member Functions

ConfigFlowResult _async_create_radio_entry (self)
 
zigpy.backups.NetworkBackup _parse_uploaded_backup (self, str uploaded_file_id)
 

Private Attributes

 _hass
 
 _radio_mgr
 
 _title
 

Additional Inherited Members

- Static Public Member Functions inherited from homeassistant.data_entry_flow.FlowHandler
None async_setup_preview (HomeAssistant hass)
 
- Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
 deprecated_show_progress
 
- 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
 

Detailed Description

Mixin for common ZHA flow steps and forms.

Definition at line 141 of file config_flow.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.zha.config_flow.BaseZhaFlow.__init__ (   self)
Initialize flow instance.

Definition at line 147 of file config_flow.py.

Member Function Documentation

◆ _async_create_radio_entry()

ConfigFlowResult homeassistant.components.zha.config_flow.BaseZhaFlow._async_create_radio_entry (   self)
private
Create a config entry with the current flow state.

Reimplemented in homeassistant.components.zha.config_flow.ZhaOptionsFlowHandler.

Definition at line 165 of file config_flow.py.

◆ _parse_uploaded_backup()

zigpy.backups.NetworkBackup homeassistant.components.zha.config_flow.BaseZhaFlow._parse_uploaded_backup (   self,
str   uploaded_file_id 
)
private
Read and parse an uploaded backup JSON file.

Definition at line 406 of file config_flow.py.

◆ async_step_choose_automatic_backup()

ConfigFlowResult homeassistant.components.zha.config_flow.BaseZhaFlow.async_step_choose_automatic_backup (   self,
dict[str, Any] | None   user_input = None 
)
Choose an automatic backup.

Definition at line 443 of file config_flow.py.

◆ async_step_choose_formation_strategy()

ConfigFlowResult homeassistant.components.zha.config_flow.BaseZhaFlow.async_step_choose_formation_strategy (   self,
dict[str, Any] | None   user_input = None 
)
Choose how to deal with the current radio's settings.

Definition at line 343 of file config_flow.py.

◆ async_step_choose_serial_port()

ConfigFlowResult homeassistant.components.zha.config_flow.BaseZhaFlow.async_step_choose_serial_port (   self,
dict[str, Any] | None   user_input = None 
)
Choose a serial port.

Definition at line 184 of file config_flow.py.

◆ async_step_form_initial_network()

ConfigFlowResult homeassistant.components.zha.config_flow.BaseZhaFlow.async_step_form_initial_network (   self,
dict[str, Any] | None   user_input = None 
)
Form an initial network.

Definition at line 392 of file config_flow.py.

◆ async_step_form_new_network()

ConfigFlowResult homeassistant.components.zha.config_flow.BaseZhaFlow.async_step_form_new_network (   self,
dict[str, Any] | None   user_input = None 
)
Form a brand-new network.

Definition at line 399 of file config_flow.py.

◆ async_step_manual_pick_radio_type()

ConfigFlowResult homeassistant.components.zha.config_flow.BaseZhaFlow.async_step_manual_pick_radio_type (   self,
dict[str, Any] | None   user_input = None 
)
Manually select the radio type.

Definition at line 248 of file config_flow.py.

◆ async_step_manual_port_config()

ConfigFlowResult homeassistant.components.zha.config_flow.BaseZhaFlow.async_step_manual_port_config (   self,
dict[str, Any] | None   user_input = None 
)
Enter port settings specific for this type of radio.

Definition at line 273 of file config_flow.py.

◆ async_step_maybe_confirm_ezsp_restore()

ConfigFlowResult homeassistant.components.zha.config_flow.BaseZhaFlow.async_step_maybe_confirm_ezsp_restore (   self,
dict[str, Any] | None   user_input = None 
)
Confirm restore for EZSP radios that require permanent IEEE writes.

Definition at line 482 of file config_flow.py.

◆ async_step_reuse_settings()

ConfigFlowResult homeassistant.components.zha.config_flow.BaseZhaFlow.async_step_reuse_settings (   self,
dict[str, Any] | None   user_input = None 
)
Reuse the existing network settings on the stick.

Definition at line 386 of file config_flow.py.

◆ async_step_upload_manual_backup()

ConfigFlowResult homeassistant.components.zha.config_flow.BaseZhaFlow.async_step_upload_manual_backup (   self,
dict[str, Any] | None   user_input = None 
)
Upload and restore a coordinator backup JSON file.

Definition at line 415 of file config_flow.py.

◆ async_step_verify_radio()

ConfigFlowResult homeassistant.components.zha.config_flow.BaseZhaFlow.async_step_verify_radio (   self,
dict[str, Any] | None   user_input = None 
)
Add a warning step to dissuade the use of deprecated radios.

Definition at line 323 of file config_flow.py.

◆ hass() [1/2]

HomeAssistant homeassistant.components.zha.config_flow.BaseZhaFlow.hass (   self)
Return hass.

Definition at line 155 of file config_flow.py.

◆ hass() [2/2]

None homeassistant.components.zha.config_flow.BaseZhaFlow.hass (   self,
HomeAssistant  hass 
)
Set hass.

Definition at line 160 of file config_flow.py.

Member Data Documentation

◆ _hass

homeassistant.components.zha.config_flow.BaseZhaFlow._hass
private

Definition at line 151 of file config_flow.py.

◆ _radio_mgr

homeassistant.components.zha.config_flow.BaseZhaFlow._radio_mgr
private

Definition at line 152 of file config_flow.py.

◆ _title

homeassistant.components.zha.config_flow.BaseZhaFlow._title
private

Definition at line 219 of file config_flow.py.


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