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

Public Member Functions

None __init__ (self, ConfigEntry config_entry)
 
def async_remove (self)
 
ConfigFlowResult async_step_init (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_instruct_unplug (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_intent_migrate (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_intent_reconfigure (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_prompt_migrate_or_reconfigure (self, dict[str, Any]|None user_input=None)
 
- Public Member Functions inherited from homeassistant.components.zha.config_flow.BaseZhaFlow
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_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)
 
- Public Member Functions inherited from homeassistant.config_entries.OptionsFlow
ConfigEntry config_entry (self)
 
None config_entry (self, ConfigEntry value)
 

Private Member Functions

def _async_create_radio_entry (self)
 

Private Attributes

 _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

Handle an options flow.

Definition at line 719 of file config_flow.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.zha.config_flow.ZhaOptionsFlowHandler.__init__ (   self,
ConfigEntry  config_entry 
)
Initialize options flow.

Definition at line 722 of file config_flow.py.

Member Function Documentation

◆ _async_create_radio_entry()

def homeassistant.components.zha.config_flow.ZhaOptionsFlowHandler._async_create_radio_entry (   self)
private
Re-implementation of the base flow's final step to update the config.

Reimplemented from homeassistant.components.zha.config_flow.BaseZhaFlow.

Definition at line 785 of file config_flow.py.

◆ async_remove()

def homeassistant.components.zha.config_flow.ZhaOptionsFlowHandler.async_remove (   self)
Maybe reload ZHA if the flow is aborted.

Reimplemented from homeassistant.data_entry_flow.FlowHandler.

Definition at line 808 of file config_flow.py.

◆ async_step_init()

ConfigFlowResult homeassistant.components.zha.config_flow.ZhaOptionsFlowHandler.async_step_init (   self,
dict[str, Any] | None   user_input = None 
)
Launch the options flow.

Definition at line 730 of file config_flow.py.

◆ async_step_instruct_unplug()

ConfigFlowResult homeassistant.components.zha.config_flow.ZhaOptionsFlowHandler.async_step_instruct_unplug (   self,
dict[str, Any] | None   user_input = None 
)
Instruct the user to unplug the current radio, if possible.

Definition at line 774 of file config_flow.py.

◆ async_step_intent_migrate()

ConfigFlowResult homeassistant.components.zha.config_flow.ZhaOptionsFlowHandler.async_step_intent_migrate (   self,
dict[str, Any] | None   user_input = None 
)
Confirm the user wants to reset their current radio.

Definition at line 762 of file config_flow.py.

◆ async_step_intent_reconfigure()

ConfigFlowResult homeassistant.components.zha.config_flow.ZhaOptionsFlowHandler.async_step_intent_reconfigure (   self,
dict[str, Any] | None   user_input = None 
)
Virtual step for when the user is reconfiguring the integration.

Definition at line 756 of file config_flow.py.

◆ async_step_prompt_migrate_or_reconfigure()

ConfigFlowResult homeassistant.components.zha.config_flow.ZhaOptionsFlowHandler.async_step_prompt_migrate_or_reconfigure (   self,
dict[str, Any] | None   user_input = None 
)
Confirm if we are migrating adapters or just re-configuring.

Definition at line 743 of file config_flow.py.

Member Data Documentation

◆ _title

homeassistant.components.zha.config_flow.ZhaOptionsFlowHandler._title
private

Definition at line 728 of file config_flow.py.


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