Classes
class	BaseZwaveJSFlow

class	CannotConnect

class	InvalidInput

class	OptionsFlowHandler

class	ZWaveJSConfigFlow

Functions
dict[str, str]	async_get_usb_ports (HomeAssistant hass)

VersionInfo	async_get_version_info (HomeAssistant hass, str ws_address)

vol.Schema	get_manual_schema (dict[str, Any] user_input)

vol.Schema	get_on_supervisor_schema (dict[str, Any] user_input)

dict[str, str]	get_usb_ports ()

VersionInfo	validate_input (HomeAssistant hass, dict user_input)

Variables
	_LOGGER = logging.getLogger(__name__)

dictionary	ADDON_LOG_LEVELS

int	ADDON_SETUP_TIMEOUT = 5

int	ADDON_SETUP_TIMEOUT_ROUNDS = 40

dictionary	ADDON_USER_INPUT_MAP

string	CONF_EMULATE_HARDWARE = "emulate_hardware"

string	CONF_LOG_LEVEL = "log_level"

string	DEFAULT_URL = "ws://localhost:3000"

	ON_SUPERVISOR_SCHEMA = vol.Schema({vol.Optional(CONF_USE_ADDON, default=True): bool})

int	SERVER_VERSION_TIMEOUT = 10

string	TITLE = "Z-Wave JS"

Detailed Description

Config flow for Z-Wave JS integration.

Function Documentation

◆ async_get_usb_ports()

dict[str, str] homeassistant.components.zwave_js.config_flow.async_get_usb_ports ( HomeAssistant hass )

Return a dict of USB ports and their friendly names.

Definition at line 169 of file config_flow.py.

◆ async_get_version_info()

VersionInfo homeassistant.components.zwave_js.config_flow.async_get_version_info	(	HomeAssistant	hass,
		str	ws_address
	)

Return Z-Wave JS version info.

Definition at line 129 of file config_flow.py.

◆ get_manual_schema()

vol.Schema homeassistant.components.zwave_js.config_flow.get_manual_schema ( dict[str, Any] user_input )

Return a schema for the manual step.

Definition at line 104 of file config_flow.py.

◆ get_on_supervisor_schema()

vol.Schema homeassistant.components.zwave_js.config_flow.get_on_supervisor_schema ( dict[str, Any] user_input )

Return a schema for the on Supervisor step.

Definition at line 110 of file config_flow.py.

◆ get_usb_ports()

dict[str, str] homeassistant.components.zwave_js.config_flow.get_usb_ports ( )

Return a dict of USB ports and their friendly names.

Definition at line 145 of file config_flow.py.

◆ validate_input()

VersionInfo homeassistant.components.zwave_js.config_flow.validate_input	(	HomeAssistant	hass,
		dict	user_input
	)

Validate if the user input allows us to connect.

Definition at line 116 of file config_flow.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.zwave_js.config_flow._LOGGER = logging.getLogger(__name__)

private

Definition at line 70 of file config_flow.py.

◆ ADDON_LOG_LEVELS

dictionary homeassistant.components.zwave_js.config_flow.ADDON_LOG_LEVELS

Initial value:

 =  {
     "error": "Error",
     "warn": "Warn",
     "info": "Info",
     "verbose": "Verbose",
     "debug": "Debug",
     "silly": "Silly",
 }

Definition at line 81 of file config_flow.py.

◆ ADDON_SETUP_TIMEOUT

int homeassistant.components.zwave_js.config_flow.ADDON_SETUP_TIMEOUT = 5

Definition at line 75 of file config_flow.py.

◆ ADDON_SETUP_TIMEOUT_ROUNDS

int homeassistant.components.zwave_js.config_flow.ADDON_SETUP_TIMEOUT_ROUNDS = 40

Definition at line 76 of file config_flow.py.

◆ ADDON_USER_INPUT_MAP

dictionary homeassistant.components.zwave_js.config_flow.ADDON_USER_INPUT_MAP

Initial value:

 =  {
     CONF_ADDON_DEVICE: CONF_USB_PATH,
     CONF_ADDON_S0_LEGACY_KEY: CONF_S0_LEGACY_KEY,
     CONF_ADDON_S2_ACCESS_CONTROL_KEY: CONF_S2_ACCESS_CONTROL_KEY,
     CONF_ADDON_S2_AUTHENTICATED_KEY: CONF_S2_AUTHENTICATED_KEY,
     CONF_ADDON_S2_UNAUTHENTICATED_KEY: CONF_S2_UNAUTHENTICATED_KEY,
     CONF_ADDON_LR_S2_ACCESS_CONTROL_KEY: CONF_LR_S2_ACCESS_CONTROL_KEY,
     CONF_ADDON_LR_S2_AUTHENTICATED_KEY: CONF_LR_S2_AUTHENTICATED_KEY,
     CONF_ADDON_LOG_LEVEL: CONF_LOG_LEVEL,
     CONF_ADDON_EMULATE_HARDWARE: CONF_EMULATE_HARDWARE,
 }

Definition at line 89 of file config_flow.py.

◆ CONF_EMULATE_HARDWARE

string homeassistant.components.zwave_js.config_flow.CONF_EMULATE_HARDWARE = "emulate_hardware"

Definition at line 77 of file config_flow.py.

◆ CONF_LOG_LEVEL

string homeassistant.components.zwave_js.config_flow.CONF_LOG_LEVEL = "log_level"

Definition at line 78 of file config_flow.py.

◆ DEFAULT_URL

string homeassistant.components.zwave_js.config_flow.DEFAULT_URL = "ws://localhost:3000"

Definition at line 72 of file config_flow.py.

◆ ON_SUPERVISOR_SCHEMA

homeassistant.components.zwave_js.config_flow.ON_SUPERVISOR_SCHEMA = vol.Schema({vol.Optional(CONF_USE_ADDON, default=True): bool})

Definition at line 101 of file config_flow.py.

◆ SERVER_VERSION_TIMEOUT

int homeassistant.components.zwave_js.config_flow.SERVER_VERSION_TIMEOUT = 10

Definition at line 79 of file config_flow.py.

◆ TITLE

string homeassistant.components.zwave_js.config_flow.TITLE = "Z-Wave JS"

Definition at line 73 of file config_flow.py.

Home Assistant Unofficial Reference 2024.12.1

Classes

Functions

Variables