homeassistant.components.zwave_js.config_flow.OptionsFlowHandler Class Reference

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

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

Public Member Functions
None	__init__ (self)
ConfigFlowResult	async_revert_addon_config (self, str reason)
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_init (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_start_failed (self, dict[str, Any]|None user_input=None)
OptionsFlowManager	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)
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 Member Functions inherited from homeassistant.config_entries.OptionsFlow
ConfigEntry	config_entry (self)
None	config_entry (self, ConfigEntry value)

Public Attributes
	lr_s2_access_control_key
	lr_s2_authenticated_key
	original_addon_config
	restart_addon
	revert_reason
	s0_legacy_key
	s2_access_control_key
	s2_authenticated_key
	s2_unauthenticated_key
	usb_path
	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

Private Member Functions
None	_async_update_entry (self, dict[str, Any] data)

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

Handle an options flow for Z-Wave JS.

Definition at line 725 of file config_flow.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.zwave_js.config_flow.OptionsFlowHandler.__init__

(

self

)

Set up the options flow.

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

Definition at line 728 of file config_flow.py.

Member Function Documentation

_async_update_entry()

None homeassistant.components.zwave_js.config_flow.OptionsFlowHandler._async_update_entry (   self, dict[str, Any]  data  )

private

Update the config entry with new data.

Definition at line 740 of file config_flow.py.

async_revert_addon_config()

ConfigFlowResult homeassistant.components.zwave_js.config_flow.OptionsFlowHandler.async_revert_addon_config	(		self,
		str	reason
	)

Abort the options flow.

If the add-on options have been changed, revert those and restart add-on.

Definition at line 975 of file config_flow.py.

async_step_configure_addon()

ConfigFlowResult homeassistant.components.zwave_js.config_flow.OptionsFlowHandler.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 817 of file config_flow.py.

async_step_finish_addon_setup()

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

Prepare info needed to complete the config entry update.

Get add-on discovery info and server version info.
Check for same unique id and abort if not the same unique id.

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

Definition at line 927 of file config_flow.py.

async_step_init()

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

Manage the options.

Definition at line 744 of file config_flow.py.

async_step_manual()

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

Handle a manual configuration.

Definition at line 753 of file config_flow.py.

async_step_on_supervisor()

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

Handle logic when on Supervisor host.

Definition at line 796 of file config_flow.py.

async_step_start_failed()

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

Add-on start failed.

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

Definition at line 921 of file config_flow.py.

flow_manager()

OptionsFlowManager homeassistant.components.zwave_js.config_flow.OptionsFlowHandler.flow_manager

(

self

)

Return the correct flow manager.

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

Definition at line 735 of file config_flow.py.

Member Data Documentation

lr_s2_access_control_key

homeassistant.components.zwave_js.config_flow.OptionsFlowHandler.lr_s2_access_control_key

Definition at line 829 of file config_flow.py.

lr_s2_authenticated_key

homeassistant.components.zwave_js.config_flow.OptionsFlowHandler.lr_s2_authenticated_key

Definition at line 830 of file config_flow.py.

original_addon_config

homeassistant.components.zwave_js.config_flow.OptionsFlowHandler.original_addon_config

Definition at line 852 of file config_flow.py.

restart_addon

homeassistant.components.zwave_js.config_flow.OptionsFlowHandler.restart_addon

Definition at line 850 of file config_flow.py.

revert_reason

homeassistant.components.zwave_js.config_flow.OptionsFlowHandler.revert_reason

Definition at line 938 of file config_flow.py.

s0_legacy_key

homeassistant.components.zwave_js.config_flow.OptionsFlowHandler.s0_legacy_key

Definition at line 825 of file config_flow.py.

s2_access_control_key

homeassistant.components.zwave_js.config_flow.OptionsFlowHandler.s2_access_control_key

Definition at line 826 of file config_flow.py.

s2_authenticated_key

homeassistant.components.zwave_js.config_flow.OptionsFlowHandler.s2_authenticated_key

Definition at line 827 of file config_flow.py.

s2_unauthenticated_key

homeassistant.components.zwave_js.config_flow.OptionsFlowHandler.s2_unauthenticated_key

Definition at line 828 of file config_flow.py.

usb_path

homeassistant.components.zwave_js.config_flow.OptionsFlowHandler.usb_path

Definition at line 831 of file config_flow.py.

version_info

homeassistant.components.zwave_js.config_flow.OptionsFlowHandler.version_info

Definition at line 947 of file config_flow.py.

ws_address

homeassistant.components.zwave_js.config_flow.OptionsFlowHandler.ws_address

Definition at line 943 of file config_flow.py.

---

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

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