home-assistant/core
1
0
Fork 1
mirror of https://github.com/home-assistant/core.git synced 2025-09-11 15:51:47 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improve Z-Wave manual config flow step description (#150479)

Browse Source
This commit is contained in:
Martin Hjelmare
2025-08-12 13:47:11 +02:00
committed by GitHub
parent 08aae4bf49
commit 66ff1cf005
2 changed files with 34 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
homeassistant/components/zwave_js/config_flow.py
View File

@@ -88,11 +88,16 @@ ADDON_USER_INPUT_MAP = {
CONF_ADDON_LR_S2_AUTHENTICATED_KEY: CONF_LR_S2_AUTHENTICATED_KEY,
}
EXAMPLE_SERVER_URL = "ws://localhost:3000"
ON_SUPERVISOR_SCHEMA = vol.Schema({vol.Optional(CONF_USE_ADDON, default=True): bool})
MIN_MIGRATION_SDK_VERSION = AwesomeVersion("6.61")
NETWORK_TYPE_NEW = "new"
NETWORK_TYPE_EXISTING = "existing"
ZWAVE_JS_SERVER_INSTRUCTIONS = (
"https://www.home-assistant.io/integrations/zwave_js/"
"#advanced-installation-instructions"
)
ZWAVE_JS_UI_MIGRATION_INSTRUCTIONS = (
"https://www.home-assistant.io/integrations/zwave_js/"
"#how-to-migrate-from-one-adapter-to-a-new-adapter-using-z-wave-js-ui"
@@ -529,7 +534,12 @@ class ZWaveJSConfigFlow(ConfigFlow, domain=DOMAIN):
"""Handle a manual configuration."""
if user_input is None:
return self.async_show_form(
step_id="manual", data_schema=get_manual_schema({})
step_id="manual",
data_schema=get_manual_schema({}),
description_placeholders={
"example_server_url": EXAMPLE_SERVER_URL,
"server_instructions": ZWAVE_JS_SERVER_INSTRUCTIONS,
},
)
errors = {}
@@ -558,7 +568,13 @@ class ZWaveJSConfigFlow(ConfigFlow, domain=DOMAIN):
return self._async_create_entry_from_vars()
return self.async_show_form(
step_id="manual", data_schema=get_manual_schema(user_input), errors=errors
step_id="manual",
data_schema=get_manual_schema(user_input),
description_placeholders={
"example_server_url": EXAMPLE_SERVER_URL,
"server_instructions": ZWAVE_JS_SERVER_INSTRUCTIONS,
},
errors=errors,
)
async def async_step_hassio(
@@ -1016,6 +1032,10 @@ class ZWaveJSConfigFlow(ConfigFlow, domain=DOMAIN):
return self.async_show_form(
step_id="manual_reconfigure",
data_schema=get_manual_schema({CONF_URL: config_entry.data[CONF_URL]}),
description_placeholders={
"example_server_url": EXAMPLE_SERVER_URL,
"server_instructions": ZWAVE_JS_SERVER_INSTRUCTIONS,
},
)
errors = {}
@@ -1046,6 +1066,10 @@ class ZWaveJSConfigFlow(ConfigFlow, domain=DOMAIN):
return self.async_show_form(
step_id="manual_reconfigure",
data_schema=get_manual_schema(user_input),
description_placeholders={
"example_server_url": EXAMPLE_SERVER_URL,
"server_instructions": ZWAVE_JS_SERVER_INSTRUCTIONS,
},
errors=errors,
)

8
homeassistant/components/zwave_js/strings.json
View File

@@ -82,13 +82,21 @@
"title": "Installing add-on"
},
"manual": {
"description": "The Z-Wave integration requires a running Z-Wave Server. If you don't already have that set up, please read the [instructions]({server_instructions}) in our documentation.\n\nWhen you have a Z-Wave Server running, enter its URL below to allow the integration to connect.",
"data": {
"url": "[%key:common::config_flow::data::url%]"
},
"data_description": {
"url": "The URL of the Z-Wave Server WebSocket API, e.g. {example_server_url}"
}
},
"manual_reconfigure": {
"description": "[%key:component::zwave_js::config::step::manual::description%]",
"data": {
"url": "[%key:common::config_flow::data::url%]"
},
"data_description": {
"url": "[%key:component::zwave_js::config::step::manual::data_description::url%]"
}
},
"on_supervisor": {