homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow Class Reference

Inheritance diagram for homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow:

Collaboration diagram for homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow:

Public Member Functions
None	__init__ (self)
ConfigFlowResult	async_step_configure_addon (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_finish_addon_setup (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_hassio (self, HassioServiceInfo discovery_info)
ConfigFlowResult	async_step_hassio_confirm (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_manual (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_on_supervisor (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_usb (self, usb.UsbServiceInfo discovery_info)
ConfigFlowResult	async_step_usb_confirm (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, ZeroconfServiceInfo discovery_info)
ConfigFlowResult	async_step_zeroconf_confirm (self, dict|None user_input=None)
ConfigEntriesFlowManager	flow_manager (self)
Public Member Functions inherited from homeassistant.components.zwave_js.config_flow.BaseZwaveJSFlow
ConfigFlowResult	async_step_install_addon (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_install_failed (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_start_addon (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_start_failed (self, dict[str, Any]|None user_input=None)
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 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_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)
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)

Static Public Member Functions
OptionsFlowHandler	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
	lr_s2_access_control_key
	lr_s2_authenticated_key
	s0_legacy_key
	s2_access_control_key
	s2_authenticated_key
	s2_unauthenticated_key
	usb_path
	use_addon
	version_info
	ws_address
Public Attributes inherited from homeassistant.components.zwave_js.config_flow.BaseZwaveJSFlow
	install_task
	integration_created_addon
	start_task
	version_info
	ws_address
Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
	deprecated_show_progress
Public Attributes inherited from homeassistant.config_entries.ConfigFlow
	source

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
ConfigFlowResult	_async_create_entry_from_vars (self)

Private Attributes
	_title
	_usb_discovery

Detailed Description

Handle a config flow for Z-Wave JS.

Definition at line 345 of file config_flow.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.__init__

(

self

)

Set up flow instance.

Reimplemented from homeassistant.components.zwave_js.config_flow.BaseZwaveJSFlow.

Definition at line 352 of file config_flow.py.

Member Function Documentation

_async_create_entry_from_vars()

ConfigFlowResult homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow._async_create_entry_from_vars (   self )

private

Return a config entry for the flow.

Definition at line 702 of file config_flow.py.

async_get_options_flow()

OptionsFlowHandler homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.async_get_options_flow ( ConfigEntry  config_entry )

static

Return the options flow.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 365 of file config_flow.py.

async_step_configure_addon()

ConfigFlowResult homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.async_step_configure_addon	(		self,
		dict[str, Any] | None	user_input = None
	)

Ask for config for Z-Wave JS add-on.

Reimplemented from homeassistant.components.zwave_js.config_flow.BaseZwaveJSFlow.

Definition at line 581 of file config_flow.py.

async_step_finish_addon_setup()

ConfigFlowResult homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.async_step_finish_addon_setup	(		self,
		dict[str, Any] | None	user_input = None
	)

Prepare info needed to complete the config entry.

Get add-on discovery info and server version info.
Set unique id and abort if already configured.

Reimplemented from homeassistant.components.zwave_js.config_flow.BaseZwaveJSFlow.

Definition at line 662 of file config_flow.py.

async_step_hassio()

ConfigFlowResult homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.async_step_hassio	(		self,
		HassioServiceInfo	discovery_info
	)

Receive configuration from add-on discovery info.

This flow is triggered by the Z-Wave JS add-on.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 503 of file config_flow.py.

async_step_hassio_confirm()

ConfigFlowResult homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.async_step_hassio_confirm	(		self,
		dict[str, Any] | None	user_input = None
	)

Confirm the add-on discovery.

Definition at line 529 of file config_flow.py.

async_step_manual()

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

Handle a manual configuration.

Definition at line 465 of file config_flow.py.

async_step_on_supervisor()

ConfigFlowResult homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.async_step_on_supervisor	(		self,
		dict[str, Any] | None	user_input = None
	)

Handle logic when on Supervisor host.

Definition at line 540 of file config_flow.py.

async_step_usb()

ConfigFlowResult homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.async_step_usb	(		self,
		usb.UsbServiceInfo	discovery_info
	)

Handle USB Discovery.

Definition at line 408 of file config_flow.py.

async_step_usb_confirm()

ConfigFlowResult homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.async_step_usb_confirm	(		self,
		dict[str, Any] | None	user_input = None
	)

Handle USB Discovery confirmation.

Definition at line 451 of file config_flow.py.

async_step_user()

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

Handle the initial step.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 371 of file config_flow.py.

async_step_zeroconf()

ConfigFlowResult homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.async_step_zeroconf	(		self,
		ZeroconfServiceInfo	discovery_info
	)

Handle zeroconf discovery.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 380 of file config_flow.py.

async_step_zeroconf_confirm()

ConfigFlowResult homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.async_step_zeroconf_confirm	(		self,
		dict | None	user_input = None
	)

Confirm the setup.

Definition at line 391 of file config_flow.py.

flow_manager()

ConfigEntriesFlowManager homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.flow_manager

(

self

)

Return the correct flow manager.

Reimplemented from homeassistant.components.zwave_js.config_flow.BaseZwaveJSFlow.

Definition at line 359 of file config_flow.py.

Member Data Documentation

_title

homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow._title

private

Definition at line 438 of file config_flow.py.

_usb_discovery

homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow._usb_discovery

private

Definition at line 356 of file config_flow.py.

lr_s2_access_control_key

homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.lr_s2_access_control_key

Definition at line 568 of file config_flow.py.

lr_s2_authenticated_key

homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.lr_s2_authenticated_key

Definition at line 571 of file config_flow.py.

s0_legacy_key

homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.s0_legacy_key

Definition at line 558 of file config_flow.py.

s2_access_control_key

homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.s2_access_control_key

Definition at line 559 of file config_flow.py.

s2_authenticated_key

homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.s2_authenticated_key

Definition at line 562 of file config_flow.py.

s2_unauthenticated_key

homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.s2_unauthenticated_key

Definition at line 565 of file config_flow.py.

usb_path

homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.usb_path

Definition at line 437 of file config_flow.py.

use_addon

homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.use_addon

Definition at line 355 of file config_flow.py.

VERSION

int homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.VERSION = 1

static

Definition at line 348 of file config_flow.py.

version_info

homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.version_info

Definition at line 677 of file config_flow.py.

ws_address

homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.ws_address

Definition at line 387 of file config_flow.py.

---

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

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