homeassistant.components.konnected.config_flow.KonnectedFlowHandler Class Reference

Inheritance diagram for homeassistant.components.konnected.config_flow.KonnectedFlowHandler:

Collaboration diagram for homeassistant.components.konnected.config_flow.KonnectedFlowHandler:

Public Member Functions
None	__init__ (self)
def	async_gen_config (self, host, port)
ConfigFlowResult	async_step_confirm (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_import (self, dict[str, Any] import_data)
ConfigFlowResult	async_step_import_confirm (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_ssdp (self, ssdp.SsdpServiceInfo discovery_info)
ConfigFlowResult	async_step_user (self, dict[str, Any]|None user_input=None)
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_hassio (self, HassioServiceInfo 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)
ConfigFlowResult	async_step_zeroconf (self, ZeroconfServiceInfo 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)

Static Public Member Functions
OptionsFlowHandler	async_get_options_flow (ConfigEntry config_entry)
Static Public Member Functions inherited from homeassistant.data_entry_flow.FlowHandler
None	async_setup_preview (HomeAssistant hass)

Public Attributes
	options
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

Detailed Description

Handle a config flow for Konnected Panels.

Definition at line 174 of file config_flow.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.konnected.config_flow.KonnectedFlowHandler.__init__

(

self

)

Initialize the Konnected flow.

Definition at line 184 of file config_flow.py.

Member Function Documentation

async_gen_config()

def homeassistant.components.konnected.config_flow.KonnectedFlowHandler.async_gen_config	(		self,
			host,
			port
	)

Populate self.data based on panel status.

This will raise CannotConnect if an error occurs

Definition at line 189 of file config_flow.py.

async_get_options_flow()

OptionsFlowHandler homeassistant.components.konnected.config_flow.KonnectedFlowHandler.async_get_options_flow ( ConfigEntry  config_entry )

static

Return the Options Flow.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 393 of file config_flow.py.

async_step_confirm()

ConfigFlowResult homeassistant.components.konnected.config_flow.KonnectedFlowHandler.async_step_confirm	(		self,
		dict[str, Any] | None	user_input = None
	)

Attempt to link with the Konnected panel.

Given a configured host, will ask the user to confirm and finalize
the connection.

Definition at line 356 of file config_flow.py.

async_step_import()

ConfigFlowResult homeassistant.components.konnected.config_flow.KonnectedFlowHandler.async_step_import	(		self,
		dict[str, Any]	import_data
	)

Import a configuration.yaml config.

This flow is triggered by `async_setup` for configured panels.

Definition at line 207 of file config_flow.py.

async_step_import_confirm()

ConfigFlowResult homeassistant.components.konnected.config_flow.KonnectedFlowHandler.async_step_import_confirm	(		self,
		dict[str, Any] | None	user_input = None
	)

Confirm the user wants to import the config entry.

Definition at line 232 of file config_flow.py.

async_step_ssdp()

ConfigFlowResult homeassistant.components.konnected.config_flow.KonnectedFlowHandler.async_step_ssdp	(		self,
		ssdp.SsdpServiceInfo	discovery_info
	)

Handle a discovered konnected panel.

This flow is triggered by the SSDP component. It will check if the
device is already configured and attempt to finish the config if not.

Definition at line 256 of file config_flow.py.

async_step_user()

ConfigFlowResult homeassistant.components.konnected.config_flow.KonnectedFlowHandler.async_step_user	(		self,
		dict[str, Any] | None	user_input = None
	)

Connect to panel and get config.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 310 of file config_flow.py.

Member Data Documentation

options

homeassistant.components.konnected.config_flow.KonnectedFlowHandler.options

Definition at line 187 of file config_flow.py.

VERSION

int homeassistant.components.konnected.config_flow.KonnectedFlowHandler.VERSION = 1

static

Definition at line 177 of file config_flow.py.

---

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

• core/homeassistant/components/konnected/config_flow.py