homeassistant.helpers.config_entry_flow Namespace Reference

Classes
class	DiscoveryFlowHandler
class	WebhookFlowHandler

Functions
None	__init__ (self, str domain, str title, DiscoveryFunctionType[_R] discovery_function)
config_entries.ConfigFlowResult	async_step_bluetooth (self, BluetoothServiceInfoBleak discovery_info)
config_entries.ConfigFlowResult	async_step_confirm (self, dict[str, Any]|None user_input=None)
config_entries.ConfigFlowResult	async_step_dhcp (self, DhcpServiceInfo discovery_info)
config_entries.ConfigFlowResult	async_step_discovery (self, DiscoveryInfoType discovery_info)
config_entries.ConfigFlowResult	async_step_homekit (self, ZeroconfServiceInfo discovery_info)
config_entries.ConfigFlowResult	async_step_import (self, dict[str, Any]|None _)
config_entries.ConfigFlowResult	async_step_mqtt (self, MqttServiceInfo discovery_info)
config_entries.ConfigFlowResult	async_step_ssdp (self, SsdpServiceInfo discovery_info)
config_entries.ConfigFlowResult	async_step_user (self, dict[str, Any]|None user_input=None)
config_entries.ConfigFlowResult	async_step_zeroconf (self, ZeroconfServiceInfo discovery_info)
None	register_discovery_flow (str domain, str title, DiscoveryFunctionType[Awaitable[bool]|bool] discovery_function)
None	register_webhook_flow (str domain, str title, dict description_placeholder, bool allow_multiple=False)
None	webhook_async_remove_entry (HomeAssistant hass, config_entries.ConfigEntry entry)

Variables
	_discovery_function
	_domain
	_LOGGER = logging.getLogger(__name__)
	_title
	source
int	VERSION = 1

Detailed Description

Helpers for data entry flows for config entries.

Function Documentation

__init__()

None homeassistant.helpers.config_entry_flow.__init__	(		self,
		str	domain,
		str	title,
		DiscoveryFunctionType[_R]	discovery_function
	)

Initialize the discovery config flow.

Definition at line 35 of file config_entry_flow.py.

async_step_bluetooth()

config_entries.ConfigFlowResult homeassistant.helpers.config_entry_flow.async_step_bluetooth	(		self,
		BluetoothServiceInfoBleak	discovery_info
	)

Handle a flow initialized by bluetooth discovery.

Definition at line 97 of file config_entry_flow.py.

async_step_confirm()

config_entries.ConfigFlowResult homeassistant.helpers.config_entry_flow.async_step_confirm	(		self,
		dict[str, Any] | None	user_input = None
	)

Confirm setup.

Definition at line 57 of file config_entry_flow.py.

async_step_dhcp()

config_entries.ConfigFlowResult homeassistant.helpers.config_entry_flow.async_step_dhcp	(		self,
		DhcpServiceInfo	discovery_info
	)

Handle a flow initialized by dhcp discovery.

Definition at line 108 of file config_entry_flow.py.

async_step_discovery()

config_entries.ConfigFlowResult homeassistant.helpers.config_entry_flow.async_step_discovery	(		self,
		DiscoveryInfoType	discovery_info
	)

Handle a flow initialized by discovery.

Definition at line 86 of file config_entry_flow.py.

async_step_homekit()

config_entries.ConfigFlowResult homeassistant.helpers.config_entry_flow.async_step_homekit	(		self,
		ZeroconfServiceInfo	discovery_info
	)

Handle a flow initialized by Homekit discovery.

Definition at line 119 of file config_entry_flow.py.

async_step_import()

config_entries.ConfigFlowResult homeassistant.helpers.config_entry_flow.async_step_import	(		self,
		dict[str, Any] | None	_
	)

Handle a flow initialized by import.

Definition at line 163 of file config_entry_flow.py.

async_step_mqtt()

config_entries.ConfigFlowResult homeassistant.helpers.config_entry_flow.async_step_mqtt	(		self,
		MqttServiceInfo	discovery_info
	)

Handle a flow initialized by mqtt discovery.

Definition at line 130 of file config_entry_flow.py.

async_step_ssdp()

config_entries.ConfigFlowResult homeassistant.helpers.config_entry_flow.async_step_ssdp	(		self,
		SsdpServiceInfo	discovery_info
	)

Handle a flow initialized by Ssdp discovery.

Definition at line 152 of file config_entry_flow.py.

async_step_user()

config_entries.ConfigFlowResult homeassistant.helpers.config_entry_flow.async_step_user	(		self,
		dict[str, Any] | None	user_input = None
	)

Handle a flow initialized by the user.

Definition at line 46 of file config_entry_flow.py.

async_step_zeroconf()

config_entries.ConfigFlowResult homeassistant.helpers.config_entry_flow.async_step_zeroconf	(		self,
		ZeroconfServiceInfo	discovery_info
	)

Handle a flow initialized by Zeroconf discovery.

Definition at line 141 of file config_entry_flow.py.

register_discovery_flow()

None homeassistant.helpers.config_entry_flow.register_discovery_flow	(	str	domain,
		str	title,
		DiscoveryFunctionType[Awaitable[bool] | bool]	discovery_function
	)

Register flow for discovered integrations that not require auth.

Definition at line 178 of file config_entry_flow.py.

register_webhook_flow()

None homeassistant.helpers.config_entry_flow.register_webhook_flow	(	str	domain,
		str	title,
		dict	description_placeholder,
		bool	allow_multiple = False
	)

Register flow for webhook integrations.

Definition at line 260 of file config_entry_flow.py.

webhook_async_remove_entry()

None homeassistant.helpers.config_entry_flow.webhook_async_remove_entry	(	HomeAssistant	hass,
		config_entries.ConfigEntry	entry
	)

Remove a webhook config entry.

Definition at line 274 of file config_entry_flow.py.

Variable Documentation

_discovery_function

homeassistant.helpers.config_entry_flow._discovery_function

private

Definition at line 44 of file config_entry_flow.py.

_domain

homeassistant.helpers.config_entry_flow._domain

private

Definition at line 42 of file config_entry_flow.py.

_LOGGER

homeassistant.helpers.config_entry_flow._LOGGER = logging.getLogger(__name__)

private

Definition at line 27 of file config_entry_flow.py.

_title

homeassistant.helpers.config_entry_flow._title

private

Definition at line 43 of file config_entry_flow.py.

source

homeassistant.helpers.config_entry_flow.source

Definition at line 65 of file config_entry_flow.py.

VERSION

int homeassistant.helpers.config_entry_flow.VERSION = 1

Handle a discovery config flow.

Definition at line 33 of file config_entry_flow.py.