jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-20 07:46:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

MQTT climate config to integration key (#22826)

Browse Source
This commit is contained in:
Jan Bouwhuis 2022-05-23 13:02:28 +02:00 committed by GitHub
parent e7189e6c56
commit 6949cf068f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 57 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
source/_integrations/climate.mqtt.markdown
View File

@ -16,10 +16,32 @@ To enable this climate platform in your installation, first add the following to
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
mqtt:
climate:
- name: Study
mode_command_topic: "study/ac/mode/set"
```
<a id='new_format'></a>
{% details "Previous configuration format" %}
The configuration format of manual configured MQTT items has changed.
The old format that places configurations under the `climate` platform key
should no longer be used and is deprecated.
The above example shows the new and modern way,
this is the previous/old example:
```yaml
climate: climate:
- platform: mqtt - platform: mqtt
name: Study
mode_command_topic: "study/ac/mode/set"
``` ```
{% enddetails %}
{% configuration %} {% configuration %}
action_template: action_template:
description: A template to render the value received on the `action_topic` with. description: A template to render the value received on the `action_topic` with.
@ -380,16 +402,16 @@ Say you receive the operation mode `"auto"` via your `mode_state_topic`, but the
{% raw %} {% raw %}
```yaml ```yaml
climate: mqtt:
- platform: mqtt climate:
name: Study - name: Study
modes: modes:
- "off" - "off"
- "heat" - "heat"
- "auto" - "auto"
mode_command_topic: "study/ac/mode/set" mode_command_topic: "study/ac/mode/set"
mode_state_topic: "study/ac/mode/state" mode_state_topic: "study/ac/mode/state"
mode_state_template: "{{ value_json }}" mode_state_template: "{{ value_json }}"
``` ```
{% endraw %} {% endraw %}
@ -404,29 +426,29 @@ A full configuration example looks like the one below.
```yaml ```yaml
# Full example configuration.yaml entry # Full example configuration.yaml entry
climate: mqtt:
- platform: mqtt climate:
name: Study - name: Study
modes: modes:
- "off" - "off"
- "cool" - "cool"
- "fan_only" - "fan_only"
swing_modes: swing_modes:
- "on" - "on"
- "off" - "off"
fan_modes: fan_modes:
- "high" - "high"
- "medium" - "medium"
- "low" - "low"
preset_modes: preset_modes:
- "eco" - "eco"
- "sleep" - "sleep"
- "activity" - "activity"
power_command_topic: "study/ac/power/set" power_command_topic: "study/ac/power/set"
preset_mode_command_topic: "study/ac/preset_mode/set" preset_mode_command_topic: "study/ac/preset_mode/set"
mode_command_topic: "study/ac/mode/set" mode_command_topic: "study/ac/mode/set"
temperature_command_topic: "study/ac/temperature/set" temperature_command_topic: "study/ac/temperature/set"
fan_mode_command_topic: "study/ac/fan/set" fan_mode_command_topic: "study/ac/fan/set"
swing_mode_command_topic: "study/ac/swing/set" swing_mode_command_topic: "study/ac/swing/set"
precision: 1.0 precision: 1.0
``` ```