Home Assistant Unofficial Reference 2024.12.1
Public Member Functions | Public Attributes | Private Attributes | List of all members
homeassistant.components.knx.config_flow.KNXCommonFlow Class Reference
Inheritance diagram for homeassistant.components.knx.config_flow.KNXCommonFlow:
[legend]
Collaboration diagram for homeassistant.components.knx.config_flow.KNXCommonFlow:
[legend]

Public Member Functions

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)
 
ConfigFlowResult finish_flow (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 Attributes

 initial_data
 
 new_entry_data
 
 new_title
 
- Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
 deprecated_show_progress
 

Private Attributes

 _async_scan_gen
 
 _found_gateways
 
 _found_tunnels
 
 _gatewayscanner
 
 _keyring
 
 _selected_tunnel
 
 _tunnel_endpoints
 

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

Base class for KNX flows.

Definition at line 106 of file config_flow.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.knx.config_flow.KNXCommonFlow.__init__ (   self,
KNXConfigEntryData  initial_data 
) 
Initialize KNXCommonFlow.

Definition at line 109 of file config_flow.py.

Member Function Documentation

◆ async_step_connection_type()

ConfigFlowResult homeassistant.components.knx.config_flow.KNXCommonFlow.async_step_connection_type (   self,
dict | None   user_input = None 
) 
Handle connection type configuration.

Definition at line 144 of file config_flow.py.

◆ async_step_knxkeys_tunnel_select()

ConfigFlowResult homeassistant.components.knx.config_flow.KNXCommonFlow.async_step_knxkeys_tunnel_select (   self,
dict | None   user_input = None 
) 
Select if a specific tunnel should be used from knxkeys file.

Definition at line 546 of file config_flow.py.

◆ async_step_manual_tunnel()

ConfigFlowResult homeassistant.components.knx.config_flow.KNXCommonFlow.async_step_manual_tunnel (   self,
dict | None   user_input = None 
) 
Manually configure tunnel connection parameters. Fields default to preselected gateway if one was found.

Definition at line 270 of file config_flow.py.

◆ async_step_routing()

ConfigFlowResult homeassistant.components.knx.config_flow.KNXCommonFlow.async_step_routing (   self,
dict | None   user_input = None 
) 
Routing setup.

Definition at line 633 of file config_flow.py.

◆ async_step_secure_key_source_menu_routing()

ConfigFlowResult homeassistant.components.knx.config_flow.KNXCommonFlow.async_step_secure_key_source_menu_routing (   self,
dict | None   user_input = None 
) 
Show the key source menu.

Definition at line 727 of file config_flow.py.

◆ async_step_secure_key_source_menu_tunnel()

ConfigFlowResult homeassistant.components.knx.config_flow.KNXCommonFlow.async_step_secure_key_source_menu_tunnel (   self,
dict | None   user_input = None 
) 
Show the key source menu.

Definition at line 718 of file config_flow.py.

◆ async_step_secure_knxkeys()

ConfigFlowResult homeassistant.components.knx.config_flow.KNXCommonFlow.async_step_secure_knxkeys (   self,
dict[str, Any] | None   user_input = None 
) 
Manage upload of new KNX Keyring file.

Definition at line 494 of file config_flow.py.

◆ async_step_secure_routing_manual()

ConfigFlowResult homeassistant.components.knx.config_flow.KNXCommonFlow.async_step_secure_routing_manual (   self,
dict | None   user_input = None 
) 
Configure ip secure routing manually.

Definition at line 441 of file config_flow.py.

◆ async_step_secure_tunnel_manual()

ConfigFlowResult homeassistant.components.knx.config_flow.KNXCommonFlow.async_step_secure_tunnel_manual (   self,
dict | None   user_input = None 
) 
Configure ip secure tunnelling manually.

Definition at line 393 of file config_flow.py.

◆ async_step_tunnel()

ConfigFlowResult homeassistant.components.knx.config_flow.KNXCommonFlow.async_step_tunnel (   self,
dict | None   user_input = None 
) 
Select a tunnel from a list.

Will be skipped if the gateway scan was unsuccessful
or if only one gateway was found.

Definition at line 214 of file config_flow.py.

◆ connection_type()

str homeassistant.components.knx.config_flow.KNXCommonFlow.connection_type (   self) 
Return the configured connection type.

Definition at line 129 of file config_flow.py.

◆ finish_flow()

ConfigFlowResult homeassistant.components.knx.config_flow.KNXCommonFlow.finish_flow (   self) 
Finish the flow.

Reimplemented in homeassistant.components.knx.config_flow.KNXOptionsFlow, and homeassistant.components.knx.config_flow.KNXConfigFlow.

Definition at line 125 of file config_flow.py.

◆ tunnel_endpoint_ia()

str | None homeassistant.components.knx.config_flow.KNXCommonFlow.tunnel_endpoint_ia (   self) 
Return the configured tunnel endpoint individual address.

Definition at line 137 of file config_flow.py.

Member Data Documentation

◆ _async_scan_gen

homeassistant.components.knx.config_flow.KNXCommonFlow._async_scan_gen
private

Definition at line 151 of file config_flow.py.

◆ _found_gateways

homeassistant.components.knx.config_flow.KNXCommonFlow._found_gateways
private

Definition at line 153 of file config_flow.py.

◆ _found_tunnels

homeassistant.components.knx.config_flow.KNXCommonFlow._found_tunnels
private

Definition at line 161 of file config_flow.py.

◆ _gatewayscanner

homeassistant.components.knx.config_flow.KNXCommonFlow._gatewayscanner
private

Definition at line 192 of file config_flow.py.

◆ _keyring

homeassistant.components.knx.config_flow.KNXCommonFlow._keyring
private

Definition at line 503 of file config_flow.py.

◆ _selected_tunnel

homeassistant.components.knx.config_flow.KNXCommonFlow._selected_tunnel
private

Definition at line 225 of file config_flow.py.

◆ _tunnel_endpoints

homeassistant.components.knx.config_flow.KNXCommonFlow._tunnel_endpoints
private

Definition at line 590 of file config_flow.py.

◆ initial_data

homeassistant.components.knx.config_flow.KNXCommonFlow.initial_data

Definition at line 111 of file config_flow.py.

◆ new_entry_data

homeassistant.components.knx.config_flow.KNXCommonFlow.new_entry_data

Definition at line 112 of file config_flow.py.

◆ new_title

homeassistant.components.knx.config_flow.KNXCommonFlow.new_title

Definition at line 178 of file config_flow.py.

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