homeassistant.components.hue.config_flow.HueFlowHandler Class Reference

Inheritance diagram for homeassistant.components.hue.config_flow.HueFlowHandler:

Collaboration diagram for homeassistant.components.hue.config_flow.HueFlowHandler:

Public Member Functions
None	__init__ (self)
ConfigFlowResult	async_step_homekit (self, zeroconf.ZeroconfServiceInfo discovery_info)
ConfigFlowResult	async_step_import (self, dict[str, Any] import_data)
ConfigFlowResult	async_step_init (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_link (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_manual (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_user (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_zeroconf (self, zeroconf.ZeroconfServiceInfo discovery_info)
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
HueV1OptionsFlowHandler|HueV2OptionsFlowHandler	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
	bridge
	discovered_bridges
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

Private Member Functions
DiscoveredHueBridge	_get_bridge (self, str host, str|None bridge_id=None)

Detailed Description

Handle a Hue config flow.

Definition at line 48 of file config_flow.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.hue.config_flow.HueFlowHandler.__init__

(

self

)

Initialize the Hue flow.

Definition at line 63 of file config_flow.py.

Member Function Documentation

_get_bridge()

DiscoveredHueBridge homeassistant.components.hue.config_flow.HueFlowHandler._get_bridge (   self, str  host, str | None   bridge_id = None  )

private

Return a DiscoveredHueBridge object.

Definition at line 75 of file config_flow.py.

async_get_options_flow()

HueV1OptionsFlowHandler | HueV2OptionsFlowHandler homeassistant.components.hue.config_flow.HueFlowHandler.async_get_options_flow ( ConfigEntry  config_entry )

static

Get the options flow for this handler.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 55 of file config_flow.py.

async_step_homekit()

ConfigFlowResult homeassistant.components.hue.config_flow.HueFlowHandler.async_step_homekit	(		self,
		zeroconf.ZeroconfServiceInfo	discovery_info
	)

Handle a discovered Hue bridge on HomeKit.

The bridge ID communicated over HomeKit differs, so we cannot use that
as the unique identifier. Therefore, this method uses discovery without
a unique ID.

Definition at line 245 of file config_flow.py.

async_step_import()

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

Import a new bridge as a config entry.

This flow is triggered by `async_setup` for both configured and
discovered bridges. Triggered for any bridge that does not have a
config entry yet (based on host).

This flow is also triggered by `async_step_discovery`.

Definition at line 261 of file config_flow.py.

async_step_init()

ConfigFlowResult homeassistant.components.hue.config_flow.HueFlowHandler.async_step_init	(		self,
		dict[str, Any] | None	user_input = None
	)

Handle a flow start.

Definition at line 96 of file config_flow.py.

async_step_link()

ConfigFlowResult homeassistant.components.hue.config_flow.HueFlowHandler.async_step_link	(		self,
		dict[str, Any] | None	user_input = None
	)

Attempt to link with the Hue bridge.

Given a configured host, will ask the user to press the link button
to connect to the bridge.

Definition at line 163 of file config_flow.py.

async_step_manual()

ConfigFlowResult homeassistant.components.hue.config_flow.HueFlowHandler.async_step_manual	(		self,
		dict[str, Any] | None	user_input = None
	)

Handle manual bridge setup.

Definition at line 147 of file config_flow.py.

async_step_user()

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

Handle a flow initialized by the user.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 68 of file config_flow.py.

async_step_zeroconf()

ConfigFlowResult homeassistant.components.hue.config_flow.HueFlowHandler.async_step_zeroconf	(		self,
		zeroconf.ZeroconfServiceInfo	discovery_info
	)

Handle a discovered Hue bridge.

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

Definition at line 216 of file config_flow.py.

Member Data Documentation

bridge

homeassistant.components.hue.config_flow.HueFlowHandler.bridge

Definition at line 109 of file config_flow.py.

discovered_bridges

homeassistant.components.hue.config_flow.HueFlowHandler.discovered_bridges

Definition at line 128 of file config_flow.py.

VERSION

int homeassistant.components.hue.config_flow.HueFlowHandler.VERSION = 1

static

Definition at line 51 of file config_flow.py.

---

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

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