homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow Class Reference

Inheritance diagram for homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow:

Collaboration diagram for homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow:

Public Member Functions
None	__init__ (self)
None	async_remove (self)
ConfigFlowResult	async_step_authorize (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_bluetooth (self, bluetooth.BluetoothServiceInfoBleak discovery_info)
ConfigFlowResult	async_step_bluetooth_confirm (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_do_provision (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_identify (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_main_menu (self, None _=None)
ConfigFlowResult	async_step_provision (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_provision_done (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_start_improv (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_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
	unique_id
Public Attributes inherited from homeassistant.config_entries.ConfigFlow
	source
Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
	deprecated_show_progress

Static Public Attributes
	None
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	_abort_if_provisioned (self)
None	_async_update_ble (self, bluetooth.BluetoothServiceInfoBleak service_info, bluetooth.BluetoothChange change)
None	_unregister_bluetooth_callback (self)

Static Private Member Functions
_T	_T (Coroutine[Any, Any, _T] func)

Private Attributes
	_authorize_task
	_can_identify
	_credentials
	_device
	_discovery_info
	_provision_result
	_provision_task
	_remove_bluetooth_callback
	_unsub

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 config flow for Improv via BLE.

Definition at line 49 of file config_flow.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow.__init__

(

self

)

Initialize the config flow.

Definition at line 63 of file config_flow.py.

Member Function Documentation

_abort_if_provisioned()

None homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow._abort_if_provisioned (   self )

private

Check improv state and abort flow if needed.

Definition at line 117 of file config_flow.py.

_async_update_ble()

None homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow._async_update_ble (   self, bluetooth.BluetoothServiceInfoBleak  service_info, bluetooth.BluetoothChange  change  )

private

Update from a ble callback.

Definition at line 144 of file config_flow.py.

_T()

_T homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow._T ( Coroutine[Any, Any, _T]  func )

staticprivate

Call the library and abort flow on common errors.

Definition at line 403 of file config_flow.py.

_unregister_bluetooth_callback()

None homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow._unregister_bluetooth_callback (   self )

private

Unregister bluetooth callbacks.

Definition at line 161 of file config_flow.py.

async_remove()

None homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow.async_remove

(

self

)

Notification that the flow has been removed.

Reimplemented from homeassistant.data_entry_flow.FlowHandler.

Definition at line 420 of file config_flow.py.

async_step_authorize()

ConfigFlowResult homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow.async_step_authorize	(		self,
		dict[str, Any] | None	user_input = None
	)

Handle authorize step.

Definition at line 362 of file config_flow.py.

async_step_bluetooth()

ConfigFlowResult homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow.async_step_bluetooth	(		self,
		bluetooth.BluetoothServiceInfoBleak	discovery_info
	)

Handle the Bluetooth discovery step.

Definition at line 168 of file config_flow.py.

async_step_bluetooth_confirm()

ConfigFlowResult homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow.async_step_bluetooth_confirm	(		self,
		dict[str, Any] | None	user_input = None
	)

Handle bluetooth confirm step.

Definition at line 191 of file config_flow.py.

async_step_do_provision()

ConfigFlowResult homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow.async_step_do_provision	(		self,
		dict[str, Any] | None	user_input = None
	)

Execute provisioning.

Definition at line 282 of file config_flow.py.

async_step_identify()

ConfigFlowResult homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow.async_step_identify	(		self,
		dict[str, Any] | None	user_input = None
	)

Handle identify step.

Definition at line 242 of file config_flow.py.

async_step_main_menu()

ConfigFlowResult homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow.async_step_main_menu	(		self,
		None	_ = None
	)

Show the main menu.

Definition at line 232 of file config_flow.py.

async_step_provision()

ConfigFlowResult homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow.async_step_provision	(		self,
		dict[str, Any] | None	user_input = None
	)

Handle provision step.

Definition at line 257 of file config_flow.py.

async_step_provision_done()

ConfigFlowResult homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow.async_step_provision_done	(		self,
		dict[str, Any] | None	user_input = None
	)

Show the result of the provision step.

Definition at line 351 of file config_flow.py.

async_step_start_improv()

ConfigFlowResult homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow.async_step_start_improv	(		self,
		dict[str, Any] | None	user_input = None
	)

Start improv flow.

If the device supports identification, show a menu, if it does not,
ask for WiFi credentials.

Definition at line 208 of file config_flow.py.

async_step_user()

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

Handle the user step to pick discovered device.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 71 of file config_flow.py.

Member Data Documentation

_authorize_task

homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow._authorize_task

private

Definition at line 385 of file config_flow.py.

_can_identify

homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow._can_identify

private

Definition at line 225 of file config_flow.py.

_credentials

homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow._credentials

private

Definition at line 269 of file config_flow.py.

_device

homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow._device

private

Definition at line 220 of file config_flow.py.

_discovery_info

homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow._discovery_info

private

Definition at line 83 of file config_flow.py.

_provision_result

homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow._provision_result

private

Definition at line 300 of file config_flow.py.

_provision_task

homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow._provision_task

private

Definition at line 337 of file config_flow.py.

_remove_bluetooth_callback

homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow._remove_bluetooth_callback

private

Definition at line 166 of file config_flow.py.

_unsub

homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow._unsub

private

Definition at line 379 of file config_flow.py.

None

homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow.None

static

Definition at line 54 of file config_flow.py.

unique_id

homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow.unique_id

Definition at line 320 of file config_flow.py.

VERSION

int homeassistant.components.improv_ble.config_flow.ImprovBLEConfigFlow.VERSION = 1

static

Definition at line 52 of file config_flow.py.

---

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

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