Add data descriptions to MQTT config flow. (#105301)

* Add data descriptions to MQTT config flow.

* Remove keep allive, correct text CA cert
This commit is contained in:
Jan Bouwhuis 2023-12-15 16:30:54 +01:00 committed by GitHub
parent af91a54663
commit b4741c2069
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -51,6 +51,24 @@
"transport": "MQTT transport",
"ws_headers": "WebSocket headers in JSON format",
"ws_path": "WebSocket path"
},
"data_description": {
"broker": "The hostname or IP address of your MQTT broker.",
"port": "The port your MQTT broker listens to. For example 1883.",
"username": "The username to login to your MQTT broker.",
"password": "The password to login to your MQTT broker.",
"advanced_options": "Enable and click `next` to set advanced options.",
"certificate": "The custom CA certificate file to validate your MQTT brokers certificate.",
"client_id": "The unique ID to identify the Home Assistant MQTT API as MQTT client. It is recommended to leave this option blank.",
"client_cert": "The client certificate to authenticate against your MQTT broker.",
"client_key": "The private key file that belongs to your client certificate.",
"tls_insecure": "Option to ignore validation of your MQTT broker's certificate.",
"protocol": "The MQTT protocol your broker operates at. For example 3.1.1.",
"set_ca_cert": "Select `Auto` for automatic CA validation or `Custom` and click `next` to set a custom CA certificate to allow validating your MQTT brokers certificate.",
"set_client_cert": "Enable and click `next` to set a client certifificate and private ket to authenticate against your MQTT broker.",
"transport": "The transport to use for the connextion to your MQTT broker.",
"ws_headers": "The WebSocket headers to pass through the WebSocket based connection to your MQTT broker.",
"ws_path": "The WebSocket path to use for the connection to your MQTT broker."
}
},
"hassio_confirm": {
@ -58,6 +76,9 @@
"description": "Do you want to configure Home Assistant to connect to the MQTT broker provided by the add-on {addon}?",
"data": {
"discovery": "Enable discovery"
},
"data_description": {
"discovery": "Option to enable MQTT automatic discovery."
}
}
},
@ -123,6 +144,24 @@
"transport": "[%key:component::mqtt::config::step::broker::data::transport%]",
"ws_headers": "[%key:component::mqtt::config::step::broker::data::ws_headers%]",
"ws_path": "[%key:component::mqtt::config::step::broker::data::ws_path%]"
},
"data_description": {
"broker": "[%key:component::mqtt::config::step::broker::data_description::broker%]",
"port": "[%key:component::mqtt::config::step::broker::data_description::port%]",
"username": "[%key:component::mqtt::config::step::broker::data_description::username%]",
"password": "[%key:component::mqtt::config::step::broker::data_description::password%]",
"advanced_options": "[%key:component::mqtt::config::step::broker::data_description::advanced_options%]",
"certificate": "[%key:component::mqtt::config::step::broker::data_description::certificate%]",
"client_id": "[%key:component::mqtt::config::step::broker::data_description::client_id%]",
"client_cert": "[%key:component::mqtt::config::step::broker::data_description::client_cert%]",
"client_key": "[%key:component::mqtt::config::step::broker::data_description::client_key%]",
"tls_insecure": "[%key:component::mqtt::config::step::broker::data_description::tls_insecure%]",
"protocol": "[%key:component::mqtt::config::step::broker::data_description::protocol%]",
"set_ca_cert": "[%key:component::mqtt::config::step::broker::data_description::set_ca_cert%]",
"set_client_cert": "[%key:component::mqtt::config::step::broker::data_description::set_client_cert%]",
"transport": "[%key:component::mqtt::config::step::broker::data_description::transport%]",
"ws_headers": "[%key:component::mqtt::config::step::broker::data_description::ws_headers%]",
"ws_path": "[%key:component::mqtt::config::step::broker::data_description::ws_path%]"
}
},
"options": {
@ -141,6 +180,20 @@
"will_payload": "Will message payload",
"will_qos": "Will message QoS",
"will_retain": "Will message retain"
},
"data_description": {
"discovery": "Option to enable MQTT automatic discovery.",
"discovery_prefix": "The prefix of configuration topics the MQTT interation will subscribe to.",
"birth_enable": "When set, Home Assistant will publish an online message to your MQTT broker when MQTT is ready.",
"birth_topic": "The MQTT topic where Home Assistant will publish a birth message.",
"birth_payload": "The birth message that is published when MQTT is ready and connected.",
"birth_qos": "The quality of service of the birth message that is published when MQTT is ready and connected",
"birth_retain": "When set, Home Assistant will retain the birth message published to your MQTT broker.",
"will_enable": "When set, Home Assistant will ask your broker to publish a will message when MQTT is stopped or looses the connection to your broker.",
"will_topic": "The MQTT topic your MQTT broker will publish a will message to.",
"will_payload": "The message your MQTT broker will publish when the connection is lost.",
"will_qos": "The quality of service of the will message that is published by your MQTT broker.",
"will_retain": "When set, your MQTT broker will retain the will message."
}
}
},