Fix KNX config flow translations and add data descriptions (#134078)

* Fix KNX config flow translations and add data descriptions

* Update strings.json

* typo
pull/134014/merge
Matthias Alphart 2024-12-27 12:59:52 +01:00 committed by GitHub
parent ad89004189
commit 415fdf4956
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 56 additions and 28 deletions

View File

@ -3,23 +3,30 @@
"step": { "step": {
"connection_type": { "connection_type": {
"title": "KNX connection", "title": "KNX connection",
"description": "Please enter the connection type we should use for your KNX connection. \n AUTOMATIC - The integration takes care of the connectivity to your KNX Bus by performing a gateway scan. \n TUNNELING - The integration will connect to your KNX bus via tunneling. \n ROUTING - The integration will connect to your KNX bus via routing.", "description": "'Automatic' performs a gateway scan on start, to find a KNX IP interface. It will connect via a tunnel. (Not available if a gateway scan was not successful.) \n\n 'Tunneling' will connect to a specific KNX IP interface over a tunnel. \n\n 'Routing' will use Multicast to communicate with KNX IP routers.",
"data": { "data": {
"connection_type": "KNX Connection Type" "connection_type": "KNX Connection Type"
},
"data_description": {
"connection_type": "Please select the connection type you want to use for your KNX connection."
} }
}, },
"tunnel": { "tunnel": {
"title": "Tunnel", "title": "Tunnel",
"description": "Please select a gateway from the list.",
"data": { "data": {
"gateway": "KNX Tunnel Connection" "gateway": "Please select a gateway from the list."
},
"data_description": {
"gateway": "Select a KNX tunneling interface you want use for the connection."
} }
}, },
"tcp_tunnel_endpoint": { "tcp_tunnel_endpoint": {
"title": "[%key:component::knx::config::step::knxkeys_tunnel_select::title%]", "title": "Tunnel endpoint",
"description": "[%key:component::knx::config::step::knxkeys_tunnel_select::description%]",
"data": { "data": {
"tunnel_endpoint_ia": "[%key:component::knx::config::step::knxkeys_tunnel_select::data::user_id%]" "tunnel_endpoint_ia": "Select the tunnel endpoint used for the connection."
},
"data_description": {
"tunnel_endpoint_ia": "'Automatic' selects a free tunnel endpoint for you when connecting. If you're unsure, this is the best option."
} }
}, },
"manual_tunnel": { "manual_tunnel": {
@ -27,23 +34,24 @@
"description": "Please enter the connection information of your tunneling device.", "description": "Please enter the connection information of your tunneling device.",
"data": { "data": {
"tunneling_type": "KNX Tunneling Type", "tunneling_type": "KNX Tunneling Type",
"port": "[%key:common::config_flow::data::port%]",
"host": "[%key:common::config_flow::data::host%]", "host": "[%key:common::config_flow::data::host%]",
"port": "[%key:common::config_flow::data::port%]",
"route_back": "Route back / NAT mode", "route_back": "Route back / NAT mode",
"local_ip": "Local IP interface" "local_ip": "Local IP interface"
}, },
"data_description": { "data_description": {
"port": "Port of the KNX/IP tunneling device.", "tunneling_type": "Select the tunneling type of your KNX/IP tunneling device. Older interfaces may only support `UDP`.",
"host": "IP address or hostname of the KNX/IP tunneling device.", "host": "IP address or hostname of the KNX/IP tunneling device.",
"port": "Port used by the KNX/IP tunneling device.",
"route_back": "Enable if your KNXnet/IP tunneling server is behind NAT. Only applies for UDP connections.", "route_back": "Enable if your KNXnet/IP tunneling server is behind NAT. Only applies for UDP connections.",
"local_ip": "Local IP or interface name used for the connection from Home Assistant. Leave blank to use auto-discovery." "local_ip": "Local IP or interface name used for the connection from Home Assistant. Leave blank to use auto-discovery."
} }
}, },
"secure_key_source_menu_tunnel": { "secure_key_source_menu_tunnel": {
"title": "KNX IP-Secure", "title": "KNX IP-Secure",
"description": "Select how you want to configure KNX/IP Secure.", "description": "How do you want to configure KNX/IP Secure?",
"menu_options": { "menu_options": {
"secure_knxkeys": "Use a `.knxkeys` file containing IP secure keys", "secure_knxkeys": "Use a `.knxkeys` file providing IP secure keys",
"secure_tunnel_manual": "Configure IP secure credentials manually" "secure_tunnel_manual": "Configure IP secure credentials manually"
} }
}, },
@ -57,20 +65,23 @@
}, },
"secure_knxkeys": { "secure_knxkeys": {
"title": "Import KNX Keyring", "title": "Import KNX Keyring",
"description": "Please select a `.knxkeys` file to import.", "description": "The Keyring is used to encrypt and decrypt KNX IP Secure communication.",
"data": { "data": {
"knxkeys_file": "Keyring file", "knxkeys_file": "Keyring file",
"knxkeys_password": "The password to decrypt the `.knxkeys` file" "knxkeys_password": "Keyring password"
}, },
"data_description": { "data_description": {
"knxkeys_password": "This was set when exporting the file from ETS." "knxkeys_file": "Select a `.knxkeys` file. This can be exported from ETS.",
"knxkeys_password": "The password to open the `.knxkeys` file was set when exporting."
} }
}, },
"knxkeys_tunnel_select": { "knxkeys_tunnel_select": {
"title": "Tunnel endpoint", "title": "[%key:component::knx::config::step::tcp_tunnel_endpoint::title%]",
"description": "Select the tunnel endpoint used for the connection.",
"data": { "data": {
"user_id": "'Automatic' selects a free tunnel endpoint for you when connecting. If you're unsure, this is the best option." "tunnel_endpoint_ia": "[%key:component::knx::config::step::tcp_tunnel_endpoint::data::tunnel_endpoint_ia%]"
},
"data_description": {
"tunnel_endpoint_ia": "[%key:component::knx::config::step::tcp_tunnel_endpoint::data_description::tunnel_endpoint_ia%]"
} }
}, },
"secure_tunnel_manual": { "secure_tunnel_manual": {
@ -82,7 +93,7 @@
"device_authentication": "Device authentication password" "device_authentication": "Device authentication password"
}, },
"data_description": { "data_description": {
"user_id": "This is often tunnel number +1. So 'Tunnel 2' would have User-ID '3'.", "user_id": "This usually is tunnel number +1. So first tunnel in the list presented in ETS would have User-ID `2`.",
"user_password": "Password for the specific tunnel connection set in the 'Properties' panel of the tunnel in ETS.", "user_password": "Password for the specific tunnel connection set in the 'Properties' panel of the tunnel in ETS.",
"device_authentication": "This is set in the 'IP' panel of the interface in ETS." "device_authentication": "This is set in the 'IP' panel of the interface in ETS."
} }
@ -95,8 +106,8 @@
"sync_latency_tolerance": "Network latency tolerance" "sync_latency_tolerance": "Network latency tolerance"
}, },
"data_description": { "data_description": {
"backbone_key": "Can be seen in the 'Security' report of an ETS project. Eg. '00112233445566778899AABBCCDDEEFF'", "backbone_key": "Can be seen in the 'Security' report of your ETS project. Eg. `00112233445566778899AABBCCDDEEFF`",
"sync_latency_tolerance": "Default is 1000." "sync_latency_tolerance": "Should be equal to the backbone configuration of your ETS project. Default is `1000`"
} }
}, },
"routing": { "routing": {
@ -104,13 +115,16 @@
"description": "Please configure the routing options.", "description": "Please configure the routing options.",
"data": { "data": {
"individual_address": "Individual address", "individual_address": "Individual address",
"routing_secure": "Use KNX IP Secure", "routing_secure": "KNX IP Secure Routing",
"multicast_group": "Multicast group", "multicast_group": "Multicast group",
"multicast_port": "Multicast port", "multicast_port": "Multicast port",
"local_ip": "[%key:component::knx::config::step::manual_tunnel::data::local_ip%]" "local_ip": "[%key:component::knx::config::step::manual_tunnel::data::local_ip%]"
}, },
"data_description": { "data_description": {
"individual_address": "KNX address to be used by Home Assistant, e.g. `0.0.4`", "individual_address": "KNX address to be used by Home Assistant, e.g. `0.0.4`",
"routing_secure": "Select if your installation uses encrypted communication according to the KNX IP Secure standard. This setting requires compatible devices and configuration. You'll be prompted for credentials in the next step.",
"multicast_group": "Multicast group used by your installation. Default is `224.0.23.12`",
"multicast_port": "Multicast port used by your installation. Default is `3671`",
"local_ip": "[%key:component::knx::config::step::manual_tunnel::data_description::local_ip%]" "local_ip": "[%key:component::knx::config::step::manual_tunnel::data_description::local_ip%]"
} }
} }
@ -148,7 +162,7 @@
}, },
"data_description": { "data_description": {
"state_updater": "Set default for reading states from the KNX Bus. When disabled, Home Assistant will not actively retrieve entity states from the KNX Bus. Can be overridden by `sync_state` entity options.", "state_updater": "Set default for reading states from the KNX Bus. When disabled, Home Assistant will not actively retrieve entity states from the KNX Bus. Can be overridden by `sync_state` entity options.",
"rate_limit": "Maximum outgoing telegrams per second.\n`0` to disable limit. Recommended: 0 or 20 to 40", "rate_limit": "Maximum outgoing telegrams per second.\n`0` to disable limit. Recommended: `0` or between `20` and `40`",
"telegram_log_size": "Telegrams to keep in memory for KNX panel group monitor. Maximum: {telegram_log_size_max}" "telegram_log_size": "Telegrams to keep in memory for KNX panel group monitor. Maximum: {telegram_log_size_max}"
} }
}, },
@ -157,20 +171,27 @@
"description": "[%key:component::knx::config::step::connection_type::description%]", "description": "[%key:component::knx::config::step::connection_type::description%]",
"data": { "data": {
"connection_type": "[%key:component::knx::config::step::connection_type::data::connection_type%]" "connection_type": "[%key:component::knx::config::step::connection_type::data::connection_type%]"
},
"data_description": {
"connection_type": "[%key:component::knx::config::step::connection_type::data_description::connection_type%]"
} }
}, },
"tunnel": { "tunnel": {
"title": "[%key:component::knx::config::step::tunnel::title%]", "title": "[%key:component::knx::config::step::tunnel::title%]",
"description": "[%key:component::knx::config::step::tunnel::description%]",
"data": { "data": {
"gateway": "[%key:component::knx::config::step::tunnel::data::gateway%]" "gateway": "[%key:component::knx::config::step::tunnel::data::gateway%]"
},
"data_description": {
"gateway": "[%key:component::knx::config::step::tunnel::data_description::gateway%]"
} }
}, },
"tcp_tunnel_endpoint": { "tcp_tunnel_endpoint": {
"title": "[%key:component::knx::config::step::knxkeys_tunnel_select::title%]", "title": "[%key:component::knx::config::step::tcp_tunnel_endpoint::title%]",
"description": "[%key:component::knx::config::step::knxkeys_tunnel_select::description%]",
"data": { "data": {
"tunnel_endpoint_ia": "[%key:component::knx::config::step::knxkeys_tunnel_select::data::user_id%]" "tunnel_endpoint_ia": "[%key:component::knx::config::step::tcp_tunnel_endpoint::data::tunnel_endpoint_ia%]"
},
"data_description": {
"tunnel_endpoint_ia": "[%key:component::knx::config::step::tcp_tunnel_endpoint::data_description::tunnel_endpoint_ia%]"
} }
}, },
"manual_tunnel": { "manual_tunnel": {
@ -184,6 +205,7 @@
"local_ip": "[%key:component::knx::config::step::manual_tunnel::data::local_ip%]" "local_ip": "[%key:component::knx::config::step::manual_tunnel::data::local_ip%]"
}, },
"data_description": { "data_description": {
"tunneling_type": "[%key:component::knx::config::step::manual_tunnel::data_description::tunneling_type%]",
"port": "[%key:component::knx::config::step::manual_tunnel::data_description::port%]", "port": "[%key:component::knx::config::step::manual_tunnel::data_description::port%]",
"host": "[%key:component::knx::config::step::manual_tunnel::data_description::host%]", "host": "[%key:component::knx::config::step::manual_tunnel::data_description::host%]",
"route_back": "[%key:component::knx::config::step::manual_tunnel::data_description::route_back%]", "route_back": "[%key:component::knx::config::step::manual_tunnel::data_description::route_back%]",
@ -214,14 +236,17 @@
"knxkeys_password": "[%key:component::knx::config::step::secure_knxkeys::data::knxkeys_password%]" "knxkeys_password": "[%key:component::knx::config::step::secure_knxkeys::data::knxkeys_password%]"
}, },
"data_description": { "data_description": {
"knxkeys_file": "[%key:component::knx::config::step::secure_knxkeys::data_description::knxkeys_file%]",
"knxkeys_password": "[%key:component::knx::config::step::secure_knxkeys::data_description::knxkeys_password%]" "knxkeys_password": "[%key:component::knx::config::step::secure_knxkeys::data_description::knxkeys_password%]"
} }
}, },
"knxkeys_tunnel_select": { "knxkeys_tunnel_select": {
"title": "[%key:component::knx::config::step::knxkeys_tunnel_select::title%]", "title": "[%key:component::knx::config::step::tcp_tunnel_endpoint::title%]",
"description": "[%key:component::knx::config::step::knxkeys_tunnel_select::description%]",
"data": { "data": {
"user_id": "[%key:component::knx::config::step::knxkeys_tunnel_select::data::user_id%]" "tunnel_endpoint_ia": "[%key:component::knx::config::step::tcp_tunnel_endpoint::data::tunnel_endpoint_ia%]"
},
"data_description": {
"tunnel_endpoint_ia": "[%key:component::knx::config::step::tcp_tunnel_endpoint::data_description::tunnel_endpoint_ia%]"
} }
}, },
"secure_tunnel_manual": { "secure_tunnel_manual": {
@ -262,6 +287,9 @@
}, },
"data_description": { "data_description": {
"individual_address": "[%key:component::knx::config::step::routing::data_description::individual_address%]", "individual_address": "[%key:component::knx::config::step::routing::data_description::individual_address%]",
"routing_secure": "[%key:component::knx::config::step::routing::data_description::routing_secure%]",
"multicast_group": "[%key:component::knx::config::step::routing::data_description::multicast_group%]",
"multicast_port": "[%key:component::knx::config::step::routing::data_description::multicast_port%]",
"local_ip": "[%key:component::knx::config::step::manual_tunnel::data_description::local_ip%]" "local_ip": "[%key:component::knx::config::step::manual_tunnel::data_description::local_ip%]"
} }
} }