homeassistant.components.upnp.config_flow.UpnpFlowHandler Class Reference

Inheritance diagram for homeassistant.components.upnp.config_flow.UpnpFlowHandler:

Collaboration diagram for homeassistant.components.upnp.config_flow.UpnpFlowHandler:

Public Member Functions
ConfigFlowResult	async_step_ignore (self, dict[str, Any] user_input)
ConfigFlowResult	async_step_ssdp (self, ssdp.SsdpServiceInfo discovery_info)
ConfigFlowResult	async_step_ssdp_confirm (self, Mapping[str, Any]|None user_input=None)
ConfigFlowResult	async_step_user (self, Mapping[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_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_user (self, dict[str, Any]|None user_input=None)
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
UpnpOptionsFlowHandler	async_get_options_flow (ConfigEntry config_entry)
Static Public Member Functions inherited from homeassistant.data_entry_flow.FlowHandler
None	async_setup_preview (HomeAssistant hass)

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

Private Member Functions
None	_add_discovery (self, SsdpServiceInfo discovery)
ConfigFlowResult	_async_create_entry_from_discovery (self, SsdpServiceInfo discovery)
dict[str, SsdpServiceInfo]	_discoveries (self)
SsdpServiceInfo	_remove_discovery (self, str usn)

Additional Inherited Members
Public Attributes inherited from homeassistant.config_entries.ConfigFlow
	source
Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
	deprecated_show_progress

Detailed Description

Handle a UPnP/IGD config flow.

Definition at line 85 of file config_flow.py.

Member Function Documentation

_add_discovery()

None homeassistant.components.upnp.config_flow.UpnpFlowHandler._add_discovery (   self, SsdpServiceInfo  discovery  )

private

Add a discovery.

Definition at line 108 of file config_flow.py.

_async_create_entry_from_discovery()

ConfigFlowResult homeassistant.components.upnp.config_flow.UpnpFlowHandler._async_create_entry_from_discovery (   self, SsdpServiceInfo  discovery  )

private

Create an entry from discovery.

Definition at line 277 of file config_flow.py.

_discoveries()

dict[str, SsdpServiceInfo] homeassistant.components.upnp.config_flow.UpnpFlowHandler._discoveries (   self )

private

Get current discoveries.

Definition at line 103 of file config_flow.py.

_remove_discovery()

SsdpServiceInfo homeassistant.components.upnp.config_flow.UpnpFlowHandler._remove_discovery (   self, str  usn  )

private

Remove a discovery by its USN/unique_id.

Definition at line 112 of file config_flow.py.

async_get_options_flow()

UpnpOptionsFlowHandler homeassistant.components.upnp.config_flow.UpnpFlowHandler.async_get_options_flow ( ConfigEntry  config_entry )

static

Get the options flow for this handler.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 96 of file config_flow.py.

async_step_ignore()

ConfigFlowResult homeassistant.components.upnp.config_flow.UpnpFlowHandler.async_step_ignore	(		self,
		dict[str, Any]	user_input
	)

Ignore this config flow.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 255 of file config_flow.py.

async_step_ssdp()

ConfigFlowResult homeassistant.components.upnp.config_flow.UpnpFlowHandler.async_step_ssdp	(		self,
		ssdp.SsdpServiceInfo	discovery_info
	)

Handle a discovered UPnP/IGD device.

This flow is triggered by the SSDP component. It will check if the
host is already configured and delegate to the import step if not.

Definition at line 169 of file config_flow.py.

async_step_ssdp_confirm()

ConfigFlowResult homeassistant.components.upnp.config_flow.UpnpFlowHandler.async_step_ssdp_confirm	(		self,
		Mapping[str, Any] | None	user_input = None
	)

Confirm integration via SSDP.

Definition at line 243 of file config_flow.py.

async_step_user()

ConfigFlowResult homeassistant.components.upnp.config_flow.UpnpFlowHandler.async_step_user	(		self,
		Mapping[str, Any] | None	user_input = None
	)

Handle a flow start.

Definition at line 116 of file config_flow.py.

Member Data Documentation

VERSION

int homeassistant.components.upnp.config_flow.UpnpFlowHandler.VERSION = 1

static

Definition at line 88 of file config_flow.py.

---

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

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