Add documentation for climate.pid.reset_integral_term action (#660)

* Add documentation for climate.pid.reset_integral_term action

* Updated comments on Code

Co-authored-by: Guillermo Ruffino <glm.net@gmail.com>

Co-authored-by: Guillermo Ruffino <glm.net@gmail.com>
This commit is contained in:
Carlos Gustavo Sarmiento 2020-07-09 18:25:39 -05:00 committed by GitHub
parent e0b73ffc91
commit 8a76470a34
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -212,6 +212,23 @@ Configuration variables:
- **negative_output** (*Optional*, float): The positive output power to drive the cool output at. - **negative_output** (*Optional*, float): The positive output power to drive the cool output at.
Defaults to ``-1.0``. Defaults to ``-1.0``.
``climate.pid.reset_integral_term`` Action
------------------------------------------
This action resets the integral term of the PID controller to 0. This might be necessary under certain
conditions to avoid the control loop to overshoot (or undershoot) a target.
.. code-block:: yaml
on_...:
# Basic
- climate.pid.reset_integral_term: pid_climate
Configuration variables:
- **id** (**Required**, :ref:`config-id`): ID of the PID Climate being reset.
PID Climate Sensor PID Climate Sensor
------------------ ------------------