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

Public Member Functions

None __init__ (self, ConfigEntry config_entry)
 
ConfigFlowResult async_step_communication_settings (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_init (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult finish_flow (self)
 
- Public Member Functions inherited from homeassistant.components.knx.config_flow.KNXCommonFlow
None __init__ (self, KNXConfigEntryData initial_data)
 
ConfigFlowResult async_step_connection_type (self, dict|None user_input=None)
 
ConfigFlowResult async_step_knxkeys_tunnel_select (self, dict|None user_input=None)
 
ConfigFlowResult async_step_manual_tunnel (self, dict|None user_input=None)
 
ConfigFlowResult async_step_routing (self, dict|None user_input=None)
 
ConfigFlowResult async_step_secure_key_source_menu_routing (self, dict|None user_input=None)
 
ConfigFlowResult async_step_secure_key_source_menu_tunnel (self, dict|None user_input=None)
 
ConfigFlowResult async_step_secure_knxkeys (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_secure_routing_manual (self, dict|None user_input=None)
 
ConfigFlowResult async_step_secure_tunnel_manual (self, dict|None user_input=None)
 
ConfigFlowResult async_step_tunnel (self, dict|None user_input=None)
 
str connection_type (self)
 
str|None tunnel_endpoint_ia (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)
 
_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)
 
- Public Member Functions inherited from homeassistant.config_entries.OptionsFlow
ConfigEntry config_entry (self)
 
None config_entry (self, ConfigEntry value)
 

Public Attributes

 new_entry_data
 
- Public Attributes inherited from homeassistant.components.knx.config_flow.KNXCommonFlow
 initial_data
 
 new_entry_data
 
 new_title
 
- Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
 deprecated_show_progress
 

Additional Inherited Members

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

Definition at line 766 of file config_flow.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.knx.config_flow.KNXOptionsFlow.__init__ (   self,
ConfigEntry  config_entry 
)
Initialize KNX options flow.

Definition at line 771 of file config_flow.py.

Member Function Documentation

◆ async_step_communication_settings()

ConfigFlowResult homeassistant.components.knx.config_flow.KNXOptionsFlow.async_step_communication_settings (   self,
dict[str, Any] | None   user_input = None 
)
Manage KNX communication settings.

Definition at line 799 of file config_flow.py.

◆ async_step_init()

ConfigFlowResult homeassistant.components.knx.config_flow.KNXOptionsFlow.async_step_init (   self,
dict[str, Any] | None   user_input = None 
)
Manage KNX options.

Definition at line 786 of file config_flow.py.

◆ finish_flow()

ConfigFlowResult homeassistant.components.knx.config_flow.KNXOptionsFlow.finish_flow (   self)
Update the ConfigEntry and finish the flow.

Reimplemented from homeassistant.components.knx.config_flow.KNXCommonFlow.

Definition at line 776 of file config_flow.py.

Member Data Documentation

◆ new_entry_data

homeassistant.components.knx.config_flow.KNXOptionsFlow.new_entry_data

Definition at line 804 of file config_flow.py.


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