Merge branch 'current' into yaml-insertion
This commit is contained in:
commit
0aebea8d83
|
@ -7,7 +7,7 @@ Climate Component
|
|||
|
||||
ESPHome has support for climate devices. Climate devices can represent different types of
|
||||
hardware, but the defining factor is that climate devices have a settable target temperature
|
||||
and can be put in different modes like HEAT, COOL, HEAT_COOL or OFF.
|
||||
and can be put in different modes like ``HEAT``, ``COOL``, ``HEAT_COOL`` or ``OFF``.
|
||||
|
||||
.. figure:: images/climate-ui.png
|
||||
:align: center
|
||||
|
@ -58,42 +58,6 @@ Advanced options:
|
|||
for a list of available options. Requires Home Assistant 2021.11 or newer.
|
||||
Set to ``""`` to remove the default entity category.
|
||||
|
||||
MQTT options:
|
||||
|
||||
- **action_state_topic** (*Optional*, string): The topic to publish
|
||||
climate device action changes to.
|
||||
- **away_state_topic** (*Optional*, string): The topic to publish
|
||||
away mode changes on.
|
||||
- **away_command_topic** (*Optional*, string): The topic to receive
|
||||
away mode commands on.
|
||||
- **current_temperature_state_topic** (*Optional*, string): The topic to publish
|
||||
current temperature changes to.
|
||||
- **fan_mode_state_topic** (*Optional*, string): The topic to publish
|
||||
fan mode changes to.
|
||||
- **fan_mode_command_topic** (*Optional*, string): The topic to receive
|
||||
fan mode commands on.
|
||||
- **mode_state_topic** (*Optional*, string): The topic to publish
|
||||
climate device mode changes to.
|
||||
- **mode_command_topic** (*Optional*, string): The topic to receive
|
||||
climate device mode commands on.
|
||||
- **swing_mode_state_topic** (*Optional*, string): The topic to publish
|
||||
swing mode changes to.
|
||||
- **swing_mode_command_topic** (*Optional*, string): The topic to receive
|
||||
swing mode commands on.
|
||||
- **target_temperature_state_topic** (*Optional*, string): The topic to publish
|
||||
target temperature changes to.
|
||||
- **target_temperature_command_topic** (*Optional*, string): The topic to receive
|
||||
target temperature commands on.
|
||||
- **target_temperature_high_state_topic** (*Optional*, string): The topic to publish
|
||||
higher target temperature changes to.
|
||||
- **target_temperature_high_command_topic** (*Optional*, string): The topic to receive
|
||||
higher target temperature commands on.
|
||||
- **target_temperature_low_state_topic** (*Optional*, string): The topic to publish
|
||||
lower target temperature changes to.
|
||||
- **target_temperature_low_command_topic** (*Optional*, string): The topic to receive
|
||||
lower target temperature commands on.
|
||||
- All other options from :ref:`MQTT Component <config-mqtt-component>`.
|
||||
|
||||
Climate Automation
|
||||
------------------
|
||||
|
||||
|
@ -189,7 +153,7 @@ advanced stuff.
|
|||
.. _climate-on_state_trigger:
|
||||
|
||||
``climate.on_state`` Trigger
|
||||
******************************************************
|
||||
****************************
|
||||
|
||||
This trigger is activated each time the state of the climate device is updated
|
||||
(for example, if the current temperature measurement or the mode set by the users changes).
|
||||
|
@ -202,6 +166,43 @@ This trigger is activated each time the state of the climate device is updated
|
|||
on_state:
|
||||
- logger.log: "State updated!"
|
||||
|
||||
MQTT options:
|
||||
|
||||
- **action_state_topic** (*Optional*, string): The topic to publish
|
||||
climate device action changes to.
|
||||
- **away_state_topic** (*Optional*, string): The topic to publish
|
||||
away mode changes on.
|
||||
- **away_command_topic** (*Optional*, string): The topic to receive
|
||||
away mode commands on.
|
||||
- **current_temperature_state_topic** (*Optional*, string): The topic to publish
|
||||
current temperature changes to.
|
||||
- **fan_mode_state_topic** (*Optional*, string): The topic to publish
|
||||
fan mode changes to.
|
||||
- **fan_mode_command_topic** (*Optional*, string): The topic to receive
|
||||
fan mode commands on.
|
||||
- **mode_state_topic** (*Optional*, string): The topic to publish
|
||||
climate device mode changes to.
|
||||
- **mode_command_topic** (*Optional*, string): The topic to receive
|
||||
climate device mode commands on.
|
||||
- **swing_mode_state_topic** (*Optional*, string): The topic to publish
|
||||
swing mode changes to.
|
||||
- **swing_mode_command_topic** (*Optional*, string): The topic to receive
|
||||
swing mode commands on.
|
||||
- **target_temperature_state_topic** (*Optional*, string): The topic to publish
|
||||
target temperature changes to.
|
||||
- **target_temperature_command_topic** (*Optional*, string): The topic to receive
|
||||
target temperature commands on.
|
||||
- **target_temperature_high_state_topic** (*Optional*, string): The topic to publish
|
||||
higher target temperature changes to.
|
||||
- **target_temperature_high_command_topic** (*Optional*, string): The topic to receive
|
||||
higher target temperature commands on.
|
||||
- **target_temperature_low_state_topic** (*Optional*, string): The topic to publish
|
||||
lower target temperature changes to.
|
||||
- **target_temperature_low_command_topic** (*Optional*, string): The topic to receive
|
||||
lower target temperature commands on.
|
||||
- All other options from :ref:`MQTT Component <config-mqtt-component>`.
|
||||
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
|
|
|
@ -6,10 +6,10 @@ Thermostat Climate Controller
|
|||
:image: air-conditioner.svg
|
||||
|
||||
The ``thermostat`` climate platform allows you to control a climate control system in much the same manner as a
|
||||
physical thermostat. Its operation is similar to the :doc:`bang-bang <bang_bang>` controller; a sensor measures a value
|
||||
physical thermostat. Its operation is similar to the :doc:`Bang-Bang <bang_bang>` controller; a sensor measures a value
|
||||
(the air temperature) and the controller will try to keep this value within a range defined by the set point(s). To do this,
|
||||
the controller can activate devices like a heating unit and/or a cooling unit to change the value observed by the sensor.
|
||||
When configured for both heating and cooling, it is essentially two :doc:`bang-bang <bang_bang>` controllers in one; it
|
||||
When configured for both heating and cooling, it is essentially two :doc:`Bang-Bang <bang_bang>` controllers in one; it
|
||||
differs, however, in that interaction with the thermostat component is nearly identical to that of a real thermostat.
|
||||
|
||||
This component can operate in one of two ways:
|
||||
|
@ -169,45 +169,6 @@ The thermostat controller uses the sensor to determine whether it should heat or
|
|||
|
||||
- **sensor** (**Required**, :ref:`config-id`): The sensor that is used to measure the current temperature.
|
||||
|
||||
Default Target Temperatures and Mode
|
||||
************************************
|
||||
|
||||
These configuration items determine default values the thermostat controller should use when it starts.
|
||||
|
||||
- **default_mode** (*Optional*, *Deprecated*, climate mode): The default climate mode the controller should
|
||||
use if it is unable to restore it from memory. One of:
|
||||
|
||||
- ``off`` (default)
|
||||
- ``heat_cool``
|
||||
- ``cool``
|
||||
- ``heat``
|
||||
- ``dry``
|
||||
- ``fan_only``
|
||||
- ``auto``
|
||||
|
||||
This value is used the first time your device starts after ESPHome is initially installed onto it. Add
|
||||
this option into your configuration if you want your thermostat component to start in a climate mode other
|
||||
than ``off``. If this option is not configured, you'll need to manually change the climate mode later via
|
||||
the front end (Home Assistant), an ESPHome action, automation, or from within a lambda elsewhere in your
|
||||
device's configuration.
|
||||
|
||||
- **default_target_temperature_low** (*Optional*, float): The default low target
|
||||
temperature for the control algorithm. This can be dynamically set in the frontend later.
|
||||
- **default_target_temperature_high** (*Optional*, float): The default high target
|
||||
temperature for the control algorithm. This can be dynamically set in the frontend later.
|
||||
|
||||
**At least one of** ``default_target_temperature_low`` **and** ``default_target_temperature_high``
|
||||
**must be specified.**
|
||||
|
||||
.. note::
|
||||
|
||||
**default_mode**, **default_target_temperature_low**, and **default_target_temperature_high** are
|
||||
being removed in a future release. In the future you will need to migrate your configuration to using
|
||||
a :ref:`preset <thermostat-preset>` which will allow for more flexibility and customisation
|
||||
|
||||
Note that ``min_temperature`` and ``max_temperature`` from the base climate component are used to define
|
||||
the range of allowed temperature values in the thermostat component. See :doc:`/components/climate/index`.
|
||||
|
||||
Heating and Cooling Actions
|
||||
***************************
|
||||
|
||||
|
@ -527,6 +488,9 @@ Additional Actions/Behavior
|
|||
- **min_fan_mode_switching_time** (*Required with any* ``fan_mode`` *action*, :ref:`config-time`): Minimum duration
|
||||
any given fan mode must be active before it may be changed.
|
||||
|
||||
Note that ``min_temperature`` and ``max_temperature`` from the base climate component are used to define
|
||||
the range of allowed temperature values in the thermostat component. See :doc:`/components/climate/index`.
|
||||
|
||||
Hysteresis Values
|
||||
*****************
|
||||
|
||||
|
@ -547,15 +511,16 @@ Hysteresis Values
|
|||
adjustability and the defaults will probably not make sense for control of things like humidity. See
|
||||
:doc:`/components/climate/index`.
|
||||
|
||||
Bang-bang vs. Thermostat
|
||||
Bang-Bang vs. Thermostat
|
||||
------------------------
|
||||
|
||||
Please see the :doc:`Bang-bang <bang_bang>` component's documentation for a detailed comparison of these two components.
|
||||
Please see the :doc:`Bang-Bang <bang_bang>` component's documentation for a detailed comparison of these two components.
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
- :doc:`/components/climate/index`
|
||||
- :doc:`/components/sensor/index`
|
||||
- :doc:`Bang-Bang <bang_bang>`
|
||||
- :ref:`config-action`
|
||||
- :ghedit:`Edit`
|
||||
|
|
|
@ -152,7 +152,7 @@ From :ref:`lambdas <config-lambda>`, you can interact with the sensor in various
|
|||
|
||||
.. code-block:: cpp
|
||||
|
||||
id(ph_ezo).set_calibration_point_low(10.00);
|
||||
id(ph_ezo).set_calibration_point_high(10.00);
|
||||
|
||||
|
||||
- ``clear_calibration()``: Clears all calibration points.
|
||||
|
|
|
@ -76,6 +76,10 @@ The configuration files for ESPHome can be found and edited under ``<HOME_ASSIST
|
|||
For example the configuration for the ``garage-door`` node in the picture above can be found
|
||||
in ``/config/esphome/garage-door.yaml``.
|
||||
|
||||
.. note::
|
||||
|
||||
Since Home Assistant add-ons run as indvidual containers, accessing these through command line is not very straightforward, but it's possible. To do that, install Home Assistant's SSH addon, configure a username and a password, and disable `Protection Mode` (please assess the risks you take with that). Then, for example to access the logs form a device through an SSH client, log in, and you can use a command like `docker exec -it addon_15ef4d2f_esphome esphome logs /config/esphome/garage-door.yaml`. See :doc:`getting_started_command_line` for more.
|
||||
|
||||
Now go ahead and use one of the :ref:`devices guides <devices>` to extend your configuration.
|
||||
|
||||
Adding some (basic) features
|
||||
|
|
Loading…
Reference in New Issue