From 8ad6f269e141edaaeee102a7ec32529ff67789c6 Mon Sep 17 00:00:00 2001 From: radovanbauer Date: Tue, 26 Jan 2021 07:15:08 -0800 Subject: [PATCH] Add documentation for mqtt climate command templates (#16226) --- source/_integrations/climate.mqtt.markdown | 30 ++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/source/_integrations/climate.mqtt.markdown b/source/_integrations/climate.mqtt.markdown index 967e73d8727..448ac310a3c 100644 --- a/source/_integrations/climate.mqtt.markdown +++ b/source/_integrations/climate.mqtt.markdown @@ -124,6 +124,10 @@ 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 +fan_mode_command_template: + description: A template to render the value sent to the `fan_mode_command_topic` with. + required: false + type: template fan_mode_command_topic: description: The MQTT topic to publish commands to change the fan mode. required: false @@ -141,6 +145,10 @@ fan_modes: required: false default: ['auto', 'low', 'medium', 'high'] type: list +hold_command_template: + description: A template to render the value sent to the `hold_command_topic` with. + required: false + type: template hold_command_topic: description: The MQTT topic to publish commands to change the hold mode. required: false @@ -178,6 +186,10 @@ min_temp: description: Minimum set point available. type: float required: false +mode_command_template: + description: A template to render the value sent to the `mode_command_topic` with. + required: false + type: template mode_command_topic: description: The MQTT topic to publish commands to change the HVAC operation mode. required: false @@ -244,6 +256,10 @@ send_if_off: required: false type: boolean default: true +swing_mode_command_template: + description: A template to render the value sent to the `swing_mode_command_topic` with. + required: false + type: template swing_mode_command_topic: description: The MQTT topic to publish commands to change the swing mode. required: false @@ -261,10 +277,18 @@ swing_modes: required: false default: ['on', 'off'] type: list +temperature_command_template: + description: A template to render the value sent to the `temperature_command_topic` with. + required: false + type: template temperature_command_topic: description: The MQTT topic to publish commands to change the target temperature. required: false type: string +temperature_high_command_template: + description: A template to render the value sent to the `temperature_high_command_topic` with. + required: false + type: template temperature_high_command_topic: description: The MQTT topic to publish commands to change the high target temperature. required: false @@ -277,6 +301,10 @@ temperature_high_state_topic: description: The MQTT topic to subscribe for changes in the target high temperature. If this is not set, the target high temperature works in optimistic mode (see below). required: false type: string +temperature_low_command_template: + description: A template to render the value sent to the `temperature_low_command_topic` with. + required: false + type: template temperature_low_command_topic: description: The MQTT topic to publish commands to change the target low temperature. required: false @@ -345,6 +373,8 @@ climate: This will parse the incoming `"auto"` as JSON, resulting in `auto`. Obviously, in this case you could also just set `value_template: {% raw %}"{{ value_json }}"{% endraw %}`. +Similarly for `*_command_topic`s, a template can be specified to render the outgoing payloads on these topics. + ### Example A full configuration example looks like the one below.