From b59b17cb02c435911adcc5c1e3bbf0cfb9a354e6 Mon Sep 17 00:00:00 2001 From: Jan Bouwhuis Date: Mon, 28 Aug 2023 11:01:24 +0200 Subject: [PATCH] Correct and allign description on mqtt qos option (#28708) --- source/_integrations/alarm_control_panel.mqtt.markdown | 2 +- source/_integrations/binary_sensor.mqtt.markdown | 2 +- source/_integrations/button.mqtt.markdown | 2 +- source/_integrations/device_tracker.mqtt.markdown | 2 +- source/_integrations/device_trigger.mqtt.markdown | 2 +- source/_integrations/event.mqtt.markdown | 2 +- source/_integrations/fan.mqtt.markdown | 2 +- source/_integrations/humidifier.mqtt.markdown | 2 +- source/_integrations/light.mqtt.markdown | 6 +++--- source/_integrations/lock.mqtt.markdown | 2 +- source/_integrations/manual_mqtt.markdown | 2 +- source/_integrations/number.mqtt.markdown | 2 +- source/_integrations/scene.mqtt.markdown | 2 +- source/_integrations/select.mqtt.markdown | 2 +- source/_integrations/sensor.mqtt.markdown | 2 +- source/_integrations/siren.mqtt.markdown | 2 +- source/_integrations/switch.mqtt.markdown | 2 +- source/_integrations/text.mqtt.markdown | 2 +- source/_integrations/update.mqtt.markdown | 2 +- source/_integrations/vacuum.mqtt.markdown | 2 +- 20 files changed, 22 insertions(+), 22 deletions(-) diff --git a/source/_integrations/alarm_control_panel.mqtt.markdown b/source/_integrations/alarm_control_panel.mqtt.markdown index da585e18721..faa1bcce205 100644 --- a/source/_integrations/alarm_control_panel.mqtt.markdown +++ b/source/_integrations/alarm_control_panel.mqtt.markdown @@ -231,7 +231,7 @@ payload_trigger: type: string default: TRIGGER qos: - description: The maximum QoS level of the state topic. + description: The maximum QoS level to be used when receiving and publishing messages. required: false type: integer default: 0 diff --git a/source/_integrations/binary_sensor.mqtt.markdown b/source/_integrations/binary_sensor.mqtt.markdown index 26967f0510e..ec345da14a3 100644 --- a/source/_integrations/binary_sensor.mqtt.markdown +++ b/source/_integrations/binary_sensor.mqtt.markdown @@ -188,7 +188,7 @@ payload_on: type: string default: "ON" qos: - description: The maximum QoS level to be used when receiving messages. + description: The maximum QoS level to be used when receiving and publishing messages. required: false type: integer default: 0 diff --git a/source/_integrations/button.mqtt.markdown b/source/_integrations/button.mqtt.markdown index 259746f7b16..36498b26bad 100644 --- a/source/_integrations/button.mqtt.markdown +++ b/source/_integrations/button.mqtt.markdown @@ -169,7 +169,7 @@ payload_press: type: string default: "PRESS" qos: - description: The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages. + description: The maximum QoS level to be used when receiving and publishing messages. required: false type: integer default: 0 diff --git a/source/_integrations/device_tracker.mqtt.markdown b/source/_integrations/device_tracker.mqtt.markdown index b837ae66731..c9fd4343893 100644 --- a/source/_integrations/device_tracker.mqtt.markdown +++ b/source/_integrations/device_tracker.mqtt.markdown @@ -163,7 +163,7 @@ payload_reset: type: string default: "None" qos: - description: The maximum QoS level of the state topic. + description: The maximum QoS level to be used when receiving and publishing messages. required: false type: integer default: 0 diff --git a/source/_integrations/device_trigger.mqtt.markdown b/source/_integrations/device_trigger.mqtt.markdown index 2f62019dbaf..c55012fbc0f 100644 --- a/source/_integrations/device_trigger.mqtt.markdown +++ b/source/_integrations/device_trigger.mqtt.markdown @@ -27,7 +27,7 @@ payload: required: false type: string qos: - description: The maximum QoS level to be used when receiving messages. + description: The maximum QoS level to be used when receiving and publishing messages. required: false type: integer default: 0 diff --git a/source/_integrations/event.mqtt.markdown b/source/_integrations/event.mqtt.markdown index b1ab6fcbdd6..ab01e916815 100644 --- a/source/_integrations/event.mqtt.markdown +++ b/source/_integrations/event.mqtt.markdown @@ -160,7 +160,7 @@ payload_not_available: type: string default: offline qos: - description: The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages. + description: The maximum QoS level to be used when receiving and publishing messages. required: false type: integer default: 0 diff --git a/source/_integrations/fan.mqtt.markdown b/source/_integrations/fan.mqtt.markdown index c6a4f87daf3..06e1fe14e61 100644 --- a/source/_integrations/fan.mqtt.markdown +++ b/source/_integrations/fan.mqtt.markdown @@ -270,7 +270,7 @@ preset_modes: type: [list] default: [] qos: - description: The maximum QoS level of the state topic. + description: The maximum QoS level to be used when receiving and publishing messages. required: false type: integer default: 0 diff --git a/source/_integrations/humidifier.mqtt.markdown b/source/_integrations/humidifier.mqtt.markdown index f0204270dd5..835dfabf64c 100644 --- a/source/_integrations/humidifier.mqtt.markdown +++ b/source/_integrations/humidifier.mqtt.markdown @@ -262,7 +262,7 @@ modes: type: [list] default: [] qos: - description: The maximum QoS level of the state topic. + description: The maximum QoS level to be used when receiving and publishing messages. required: false type: integer default: 0 diff --git a/source/_integrations/light.mqtt.markdown b/source/_integrations/light.mqtt.markdown index 9b3987a16c9..0cd31f78e74 100644 --- a/source/_integrations/light.mqtt.markdown +++ b/source/_integrations/light.mqtt.markdown @@ -295,7 +295,7 @@ payload_on: type: string default: "ON" qos: - description: The maximum QoS level of the state topic. + description: The maximum QoS level to be used when receiving and publishing messages. required: false type: integer default: 0 @@ -692,7 +692,7 @@ payload_not_available: type: string default: offline qos: - description: The maximum QoS level of the state topic. + description: The maximum QoS level to be used when receiving and publishing messages. required: false type: integer default: 0 @@ -1054,7 +1054,7 @@ payload_not_available: type: string default: offline qos: - description: The maximum QoS level of the state topic. + description: The maximum QoS level to be used when receiving and publishing messages. required: false type: integer default: 0 diff --git a/source/_integrations/lock.mqtt.markdown b/source/_integrations/lock.mqtt.markdown index b1d2af6e785..d632a06668b 100644 --- a/source/_integrations/lock.mqtt.markdown +++ b/source/_integrations/lock.mqtt.markdown @@ -193,7 +193,7 @@ payload_open: type: string default: OPEN qos: - description: The maximum QoS level of the state topic. It will also be used for messages published to command topic. + description: The maximum QoS level to be used when receiving and publishing messages. required: false type: integer default: 0 diff --git a/source/_integrations/manual_mqtt.markdown b/source/_integrations/manual_mqtt.markdown index 9180a09df4b..201500c9664 100644 --- a/source/_integrations/manual_mqtt.markdown +++ b/source/_integrations/manual_mqtt.markdown @@ -128,7 +128,7 @@ command_topic: required: true type: string qos: - description: The maximum QoS level for subscribing and publishing to MQTT messages. + description: The maximum QoS level to be used when receiving and publishing messages. required: false type: integer default: 0 diff --git a/source/_integrations/number.mqtt.markdown b/source/_integrations/number.mqtt.markdown index 77e759a8449..65329a9337e 100644 --- a/source/_integrations/number.mqtt.markdown +++ b/source/_integrations/number.mqtt.markdown @@ -172,7 +172,7 @@ payload_reset: type: string default: '"None"' qos: - description: The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages. + description: The maximum QoS level to be used when receiving and publishing messages. required: false type: integer default: 0 diff --git a/source/_integrations/scene.mqtt.markdown b/source/_integrations/scene.mqtt.markdown index c442a0fb44b..ffc3c3bc503 100644 --- a/source/_integrations/scene.mqtt.markdown +++ b/source/_integrations/scene.mqtt.markdown @@ -161,7 +161,7 @@ payload_on: type: string default: "ON" qos: - description: The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages. + description: The maximum QoS level to be used when receiving and publishing messages. required: false type: integer default: 0 diff --git a/source/_integrations/select.mqtt.markdown b/source/_integrations/select.mqtt.markdown index 6527266d3f8..b842a5ce95f 100644 --- a/source/_integrations/select.mqtt.markdown +++ b/source/_integrations/select.mqtt.markdown @@ -162,7 +162,7 @@ options: required: true type: list qos: - description: The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages. + description: The maximum QoS level to be used when receiving and publishing messages. required: false type: integer default: 0 diff --git a/source/_integrations/sensor.mqtt.markdown b/source/_integrations/sensor.mqtt.markdown index 4f293d70f34..66929025f4c 100644 --- a/source/_integrations/sensor.mqtt.markdown +++ b/source/_integrations/sensor.mqtt.markdown @@ -176,7 +176,7 @@ suggested_display_precision: required: false type: integer qos: - description: The maximum QoS level of the state topic. + description: The maximum QoS level to be used when receiving and publishing messages. required: false type: integer default: 0 diff --git a/source/_integrations/siren.mqtt.markdown b/source/_integrations/siren.mqtt.markdown index 2ec96b1b92f..9524be4e68a 100644 --- a/source/_integrations/siren.mqtt.markdown +++ b/source/_integrations/siren.mqtt.markdown @@ -190,7 +190,7 @@ payload_on: type: string default: "ON" qos: - description: The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages. + description: The maximum QoS level to be used when receiving and publishing messages. required: false type: integer default: 0 diff --git a/source/_integrations/switch.mqtt.markdown b/source/_integrations/switch.mqtt.markdown index 525977b99e4..c95f73169b3 100644 --- a/source/_integrations/switch.mqtt.markdown +++ b/source/_integrations/switch.mqtt.markdown @@ -182,7 +182,7 @@ payload_on: type: string default: "ON" qos: - description: The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages. + description: The maximum QoS level to be used when receiving and publishing messages. required: false type: integer default: 0 diff --git a/source/_integrations/text.mqtt.markdown b/source/_integrations/text.mqtt.markdown index 1c765e45fb9..81f03dc4b62 100644 --- a/source/_integrations/text.mqtt.markdown +++ b/source/_integrations/text.mqtt.markdown @@ -163,7 +163,7 @@ pattern: required: false type: string qos: - description: The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages. + description: The maximum QoS level to be used when receiving and publishing messages. required: false type: integer default: 0 diff --git a/source/_integrations/update.mqtt.markdown b/source/_integrations/update.mqtt.markdown index ed6d5535b1c..db85aca9fe9 100644 --- a/source/_integrations/update.mqtt.markdown +++ b/source/_integrations/update.mqtt.markdown @@ -166,7 +166,7 @@ payload_install: required: false type: string qos: - description: The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages. + description: The maximum QoS level to be used when receiving and publishing messages. required: false type: integer default: 0 diff --git a/source/_integrations/vacuum.mqtt.markdown b/source/_integrations/vacuum.mqtt.markdown index 69ad45ef75f..efa7145963e 100644 --- a/source/_integrations/vacuum.mqtt.markdown +++ b/source/_integrations/vacuum.mqtt.markdown @@ -167,7 +167,7 @@ payload_stop: type: string default: stop qos: - description: The maximum QoS level of the state topic. + description: The maximum QoS level to be used when receiving and publishing messages. required: false type: integer default: 0