homeassistant.components.zwave_js.config_flow.BaseZwaveJSFlow Class Reference

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

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

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_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)
FlowManager[ConfigFlowContext, ConfigFlowResult]	flow_manager (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)
_FlowResultT	async_abort (self, *str reason, Mapping[str, str]|None description_placeholders=None)
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_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)
_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
	install_task
	integration_created_addon
	start_task
	version_info
	ws_address
Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
	deprecated_show_progress

Private Member Functions
dict	_async_get_addon_discovery_info (self)
AddonInfo	_async_get_addon_info (self)
None	_async_install_addon (self)
None	_async_set_addon_config (self, dict config)
None	_async_start_addon (self)

Additional Inherited Members
Static Public Member Functions inherited from homeassistant.data_entry_flow.FlowHandler
None	async_setup_preview (HomeAssistant hass)
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

Detailed Description

Represent the base config flow for Z-Wave JS.

Definition at line 174 of file config_flow.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.zwave_js.config_flow.BaseZwaveJSFlow.__init__

(

self

)

Set up flow instance.

Reimplemented in homeassistant.components.zwave_js.config_flow.OptionsFlowHandler, and homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.

Definition at line 177 of file config_flow.py.

Member Function Documentation

_async_get_addon_discovery_info()

dict homeassistant.components.zwave_js.config_flow.BaseZwaveJSFlow._async_get_addon_discovery_info (   self )

private

Return add-on discovery info.

Definition at line 333 of file config_flow.py.

_async_get_addon_info()

AddonInfo homeassistant.components.zwave_js.config_flow.BaseZwaveJSFlow._async_get_addon_info (   self )

private

Return and cache Z-Wave JS add-on info.

Definition at line 308 of file config_flow.py.

_async_install_addon()

None homeassistant.components.zwave_js.config_flow.BaseZwaveJSFlow._async_install_addon (   self )

private

Install the Z-Wave JS add-on.

Definition at line 328 of file config_flow.py.

_async_set_addon_config()

None homeassistant.components.zwave_js.config_flow.BaseZwaveJSFlow._async_set_addon_config (   self, dict  config  )

private

Set Z-Wave JS add-on config.

Definition at line 319 of file config_flow.py.

_async_start_addon()

None homeassistant.components.zwave_js.config_flow.BaseZwaveJSFlow._async_start_addon (   self )

private

Start the Z-Wave JS add-on.

Definition at line 261 of file config_flow.py.

async_step_configure_addon()

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

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

Reimplemented in homeassistant.components.zwave_js.config_flow.OptionsFlowHandler, and homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.

Definition at line 293 of file config_flow.py.

async_step_finish_addon_setup()

ConfigFlowResult homeassistant.components.zwave_js.config_flow.BaseZwaveJSFlow.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 in homeassistant.components.zwave_js.config_flow.OptionsFlowHandler, and homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.

Definition at line 299 of file config_flow.py.

async_step_install_addon()

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

Install Z-Wave JS add-on.

Definition at line 199 of file config_flow.py.

async_step_install_failed()

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

Add-on installation failed.

Definition at line 225 of file config_flow.py.

async_step_start_addon()

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

Start Z-Wave JS add-on.

Definition at line 231 of file config_flow.py.

async_step_start_failed()

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

Add-on start failed.

Reimplemented in homeassistant.components.zwave_js.config_flow.OptionsFlowHandler.

Definition at line 255 of file config_flow.py.

flow_manager()

FlowManager[ConfigFlowContext, ConfigFlowResult] homeassistant.components.zwave_js.config_flow.BaseZwaveJSFlow.flow_manager

(

self

)

Return the flow manager of the flow.

Reimplemented in homeassistant.components.zwave_js.config_flow.OptionsFlowHandler, and homeassistant.components.zwave_js.config_flow.ZWaveJSConfigFlow.

Definition at line 196 of file config_flow.py.

Member Data Documentation

install_task

homeassistant.components.zwave_js.config_flow.BaseZwaveJSFlow.install_task

Definition at line 204 of file config_flow.py.

integration_created_addon

homeassistant.components.zwave_js.config_flow.BaseZwaveJSFlow.integration_created_addon

Definition at line 189 of file config_flow.py.

start_task

homeassistant.components.zwave_js.config_flow.BaseZwaveJSFlow.start_task

Definition at line 236 of file config_flow.py.

version_info

homeassistant.components.zwave_js.config_flow.BaseZwaveJSFlow.version_info

Definition at line 264 of file config_flow.py.

ws_address

homeassistant.components.zwave_js.config_flow.BaseZwaveJSFlow.ws_address

Definition at line 275 of file config_flow.py.

---

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

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