From 6c390b7a1d2726a2d048898be5adca28bf5bc7f1 Mon Sep 17 00:00:00 2001 From: Jan Bouwhuis Date: Mon, 3 Jan 2022 19:37:10 +0100 Subject: [PATCH] Add Mqtt encoding parameter (#20745) --- .../alarm_control_panel.mqtt.markdown | 5 +++++ source/_integrations/binary_sensor.mqtt.markdown | 2 +- source/_integrations/button.mqtt.markdown | 5 +++++ source/_integrations/climate.mqtt.markdown | 5 +++++ source/_integrations/cover.mqtt.markdown | 5 +++++ source/_integrations/fan.mqtt.markdown | 5 +++++ source/_integrations/humidifier.mqtt.markdown | 5 +++++ source/_integrations/light.mqtt.markdown | 15 +++++++++++++++ source/_integrations/lock.mqtt.markdown | 5 +++++ source/_integrations/number.mqtt.markdown | 5 +++++ source/_integrations/select.mqtt.markdown | 5 +++++ source/_integrations/sensor.mqtt.markdown | 2 +- source/_integrations/switch.mqtt.markdown | 5 +++++ source/_integrations/vacuum.mqtt.markdown | 10 ++++++++++ 14 files changed, 77 insertions(+), 2 deletions(-) diff --git a/source/_integrations/alarm_control_panel.mqtt.markdown b/source/_integrations/alarm_control_panel.mqtt.markdown index f8e40c0512c..5b5c540f6d3 100644 --- a/source/_integrations/alarm_control_panel.mqtt.markdown +++ b/source/_integrations/alarm_control_panel.mqtt.markdown @@ -148,6 +148,11 @@ enabled_by_default: required: false type: boolean default: true +encoding: + description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload. + required: false + type: string + default: "utf-8" entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false diff --git a/source/_integrations/binary_sensor.mqtt.markdown b/source/_integrations/binary_sensor.mqtt.markdown index cc93b6e9bf7..ef9b3d92de8 100644 --- a/source/_integrations/binary_sensor.mqtt.markdown +++ b/source/_integrations/binary_sensor.mqtt.markdown @@ -118,7 +118,7 @@ enabled_by_default: type: boolean default: true encoding: - description: The encoding of the payload received at `state_topic` and availability topics `availability_topic` and `topic`. Set to `""` to disable decoding. + description: The encoding of the payloads received. Set to `""` to disable decoding of incoming payload. required: false type: string default: "utf-8" diff --git a/source/_integrations/button.mqtt.markdown b/source/_integrations/button.mqtt.markdown index 19c78d42d3c..cbbd310639b 100644 --- a/source/_integrations/button.mqtt.markdown +++ b/source/_integrations/button.mqtt.markdown @@ -111,6 +111,11 @@ enabled_by_default: required: false type: boolean default: true +encoding: + description: The encoding of the published messages. + required: false + type: string + default: "utf-8" entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false diff --git a/source/_integrations/climate.mqtt.markdown b/source/_integrations/climate.mqtt.markdown index 3b91b5d74d1..e33f0027eab 100644 --- a/source/_integrations/climate.mqtt.markdown +++ b/source/_integrations/climate.mqtt.markdown @@ -145,6 +145,11 @@ enabled_by_default: required: false type: boolean default: true +encoding: + description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload. + required: false + type: string + default: "utf-8" entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false diff --git a/source/_integrations/cover.mqtt.markdown b/source/_integrations/cover.mqtt.markdown index a3af3c3cb1d..44aea9c2595 100644 --- a/source/_integrations/cover.mqtt.markdown +++ b/source/_integrations/cover.mqtt.markdown @@ -127,6 +127,11 @@ enabled_by_default: required: false type: boolean default: true +encoding: + description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload. + required: false + type: string + default: "utf-8" entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false diff --git a/source/_integrations/fan.mqtt.markdown b/source/_integrations/fan.mqtt.markdown index f3ddca991f9..3a1ae169fb1 100644 --- a/source/_integrations/fan.mqtt.markdown +++ b/source/_integrations/fan.mqtt.markdown @@ -118,6 +118,11 @@ enabled_by_default: required: false type: boolean default: true +encoding: + description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload. + required: false + type: string + default: "utf-8" entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false diff --git a/source/_integrations/humidifier.mqtt.markdown b/source/_integrations/humidifier.mqtt.markdown index ea6b7a86be8..59d780546cb 100644 --- a/source/_integrations/humidifier.mqtt.markdown +++ b/source/_integrations/humidifier.mqtt.markdown @@ -124,6 +124,11 @@ enabled_by_default: required: false type: boolean default: true +encoding: + description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload. + required: false + type: string + default: "utf-8" entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false diff --git a/source/_integrations/light.mqtt.markdown b/source/_integrations/light.mqtt.markdown index cb9d7bf8774..99d3b5dd68f 100644 --- a/source/_integrations/light.mqtt.markdown +++ b/source/_integrations/light.mqtt.markdown @@ -177,6 +177,11 @@ enabled_by_default: required: false type: boolean default: true +encoding: + description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload. + required: false + type: string + default: "utf-8" entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false @@ -559,6 +564,11 @@ enabled_by_default: required: false type: boolean default: true +encoding: + description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload. + required: false + type: string + default: "utf-8" entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false @@ -918,6 +928,11 @@ enabled_by_default: required: false type: boolean default: true +encoding: + description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload. + required: false + type: string + default: "utf-8" entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false diff --git a/source/_integrations/lock.mqtt.markdown b/source/_integrations/lock.mqtt.markdown index 7a56dfc4f20..8e8e1ab6639 100644 --- a/source/_integrations/lock.mqtt.markdown +++ b/source/_integrations/lock.mqtt.markdown @@ -116,6 +116,11 @@ enabled_by_default: required: false type: boolean default: true +encoding: + description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload. + required: false + type: string + default: "utf-8" entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false diff --git a/source/_integrations/number.mqtt.markdown b/source/_integrations/number.mqtt.markdown index 776cdf4b43d..26ba4e7db6c 100644 --- a/source/_integrations/number.mqtt.markdown +++ b/source/_integrations/number.mqtt.markdown @@ -104,6 +104,11 @@ enabled_by_default: required: false type: boolean default: true +encoding: + description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload. + required: false + type: string + default: "utf-8" entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false diff --git a/source/_integrations/select.mqtt.markdown b/source/_integrations/select.mqtt.markdown index 3a0b5808f0f..cdc9e634860 100644 --- a/source/_integrations/select.mqtt.markdown +++ b/source/_integrations/select.mqtt.markdown @@ -116,6 +116,11 @@ enabled_by_default: required: false type: boolean default: true +encoding: + description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload. + required: false + type: string + default: "utf-8" entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false diff --git a/source/_integrations/sensor.mqtt.markdown b/source/_integrations/sensor.mqtt.markdown index 305bd6bdd42..c529e87481d 100644 --- a/source/_integrations/sensor.mqtt.markdown +++ b/source/_integrations/sensor.mqtt.markdown @@ -110,7 +110,7 @@ enabled_by_default: type: boolean default: true encoding: - description: The encoding of the payload received at `state_topic` and availability topics `availability_topic` and `topic`. Set to `""` to disable decoding. + description: The encoding of the payloads received. Set to `""` to disable decoding of incoming payload. required: false type: string default: "utf-8" diff --git a/source/_integrations/switch.mqtt.markdown b/source/_integrations/switch.mqtt.markdown index 36a380f6c88..3c401acbeac 100644 --- a/source/_integrations/switch.mqtt.markdown +++ b/source/_integrations/switch.mqtt.markdown @@ -119,6 +119,11 @@ enabled_by_default: required: false type: boolean default: true +encoding: + description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload. + required: false + type: string + default: "utf-8" entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false diff --git a/source/_integrations/vacuum.mqtt.markdown b/source/_integrations/vacuum.mqtt.markdown index ba2c27095c6..84f52d242e6 100644 --- a/source/_integrations/vacuum.mqtt.markdown +++ b/source/_integrations/vacuum.mqtt.markdown @@ -106,6 +106,11 @@ enabled_by_default: required: false type: boolean default: true +encoding: + description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload. + required: false + type: string + default: "utf-8" entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false @@ -398,6 +403,11 @@ device: description: 'Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.' required: false type: string +encoding: + description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload. + required: false + type: string + default: "utf-8" fan_speed_list: description: List of possible fan speeds for the vacuum. required: false