Skip to content

Commit bb927ab

Browse files
authored
[thermostat] Add humidity support documentation (#5488)
1 parent 0164fca commit bb927ab

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

content/components/climate/thermostat.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,8 +161,8 @@ Got all that? Great. Let's take a closer look at some configuration.
161161
The thermostat controller uses the sensor to determine whether it should heat or cool.
162162

163163
- **sensor** (**Required**, [ID](#config-id)): The sensor that is used to measure the current temperature.
164-
- **humidity_sensor** (*Optional*, [ID](#config-id)): If specified, this sensor is used to measure the current humidity.
165-
This is used for information only and does not influence temperature control.
164+
- **humidity_sensor** (*Optional*, [ID](#config-id)): The sensor that is used to measure the current humidity.
165+
This may be used for humidity control; see [Humidity Control Actions](#humidity-control-actions).
166166

167167
### Heating and Cooling Actions
168168

@@ -296,6 +296,20 @@ These should be used to control the fan only, if available.
296296
- **swing_both_action** (*Optional*, [Action](#config-action)): The action to call when the fan
297297
should oscillate in horizontal and vertical directions.
298298

299+
### Humidity Control Actions
300+
301+
These are triggered when the humidity control action is changed by the thermostat controller. It can trigger actions
302+
to activate humidification **or** dehumidification.
303+
304+
- **humidity_control_dehumidify_action** (*Optional*, [Action](#config-action)): The action to call when
305+
dehumidification is required.
306+
307+
- **humidity_control_humidify_action** (*Optional*, [Action](#config-action)): The action to call when
308+
humidification is required.
309+
310+
- **humidity_control_off_action** (*Optional*, [Action](#config-action)): The action to call when
311+
(de)humidification should stop. This action is **required** when either of the above actions are configured.
312+
299313
## Advanced Configuration/Behavior
300314

301315
### Set Point Options/Behavior
@@ -467,6 +481,9 @@ climate:
467481

468482
### Additional Actions/Behavior
469483

484+
- **target_humidity_change_action** (*Optional*, [Action](#config-action)): The action to call when the
485+
thermostat's target humidity is changed.
486+
470487
- **target_temperature_change_action** (*Optional*, [Action](#config-action)): The action to call when the
471488
thermostat's target temperature(s) is/are changed.
472489

@@ -544,6 +561,9 @@ the range of allowed temperature values in the thermostat component. See {{< doc
544561
- **heat_overrun** (*Optional*, float): The minimum temperature differential (heating beyond the set point)
545562
before calling the idle [action](#config-action). Defaults to 0.5 °C.
546563

564+
- **humidity_hysteresis** (*Optional*, float): The maximum humidity differential (above/below the set point)
565+
before calling the respective humidity control [action](#config-action). Defaults to 1%.
566+
547567
> [!NOTE]
548568
>
549569
> - While this platform uses the term temperature everywhere, it can also be used to regulate other values.

0 commit comments

Comments
 (0)