homeassistant.components.broadlink.config_flow.BroadlinkFlowHandler Class Reference

Inheritance diagram for homeassistant.components.broadlink.config_flow.BroadlinkFlowHandler:

Collaboration diagram for homeassistant.components.broadlink.config_flow.BroadlinkFlowHandler:

Public Member Functions
None	async_set_device (self, blk.Device device, bool raise_on_progress=True)
ConfigFlowResult	async_step_auth (self)
ConfigFlowResult	async_step_dhcp (self, dhcp.DhcpServiceInfo discovery_info)
ConfigFlowResult	async_step_finish (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_import (self, dict[str, Any] import_data)
ConfigFlowResult	async_step_reauth (self, Mapping[str, Any] entry_data)
ConfigFlowResult	async_step_reset (self, dict[str, Any]|None user_input=None, dict[str, str]|None errors=None)
ConfigFlowResult	async_step_unlock (self, dict[str, Any]|None user_input=None)
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)

Public Attributes
	device
	source
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

Additional Inherited Members
Static Public Member Functions inherited from homeassistant.config_entries.ConfigFlow
OptionsFlow	async_get_options_flow (ConfigEntry config_entry)
Static Public Member Functions inherited from homeassistant.data_entry_flow.FlowHandler
None	async_setup_preview (HomeAssistant hass)

Detailed Description

Handle a Broadlink config flow.

Definition at line 35 of file config_flow.py.

Member Function Documentation

async_set_device()

None homeassistant.components.broadlink.config_flow.BroadlinkFlowHandler.async_set_device	(		self,
		blk.Device	device,
		bool	raise_on_progress = True
	)

Define a device for the config flow.

Definition at line 42 of file config_flow.py.

async_step_auth()

ConfigFlowResult homeassistant.components.broadlink.config_flow.BroadlinkFlowHandler.async_step_auth

(

self

)

Authenticate to the device.

Definition at line 157 of file config_flow.py.

async_step_dhcp()

ConfigFlowResult homeassistant.components.broadlink.config_flow.BroadlinkFlowHandler.async_step_dhcp	(		self,
		dhcp.DhcpServiceInfo	discovery_info
	)

Handle dhcp discovery.

Definition at line 67 of file config_flow.py.

async_step_finish()

ConfigFlowResult homeassistant.components.broadlink.config_flow.BroadlinkFlowHandler.async_step_finish	(		self,
		dict[str, Any] | None	user_input = None
	)

Choose a name for the device and create config entry.

Definition at line 293 of file config_flow.py.

async_step_import()

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

Import a device.

Definition at line 321 of file config_flow.py.

async_step_reauth()

ConfigFlowResult homeassistant.components.broadlink.config_flow.BroadlinkFlowHandler.async_step_reauth	(		self,
		Mapping[str, Any]	entry_data
	)

Reauthenticate to the device.

Definition at line 326 of file config_flow.py.

async_step_reset()

ConfigFlowResult homeassistant.components.broadlink.config_flow.BroadlinkFlowHandler.async_step_reset	(		self,
		dict[str, Any] | None	user_input = None,
		dict[str, str] | None	errors = None
	)

Guide the user to unlock the device manually.

We are unable to authenticate because the device is locked.
The user needs to open the Broadlink app and unlock the device.

Definition at line 210 of file config_flow.py.

async_step_unlock()

ConfigFlowResult homeassistant.components.broadlink.config_flow.BroadlinkFlowHandler.async_step_unlock	(		self,
		dict[str, Any] | None	user_input = None
	)

Unlock the device.

The authentication succeeded, but the device is locked.
We can offer an unlock to prevent authorization errors.

Definition at line 237 of file config_flow.py.

async_step_user()

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

Handle a flow initiated by the user.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 93 of file config_flow.py.

Member Data Documentation

device

homeassistant.components.broadlink.config_flow.BroadlinkFlowHandler.device

Definition at line 59 of file config_flow.py.

source

homeassistant.components.broadlink.config_flow.BroadlinkFlowHandler.source

Definition at line 144 of file config_flow.py.

VERSION

int homeassistant.components.broadlink.config_flow.BroadlinkFlowHandler.VERSION = 1

static

Definition at line 38 of file config_flow.py.

---

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

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