esphome-docs/components/output/index.rst

137 lines
3.2 KiB
ReStructuredText
Raw Normal View History

.. _output:
2018-05-13 11:37:02 +02:00
Output Component
================
2018-11-14 22:12:27 +01:00
.. seo::
2019-02-16 23:25:23 +01:00
:description: Instructions for setting up generic outputs in ESPHome
:image: folder-open.png
2018-11-14 22:12:27 +01:00
2018-05-13 11:37:02 +02:00
Each platform of the ``output`` domain exposes some output to
2019-02-16 23:25:23 +01:00
ESPHome. These are grouped into two categories: ``binary`` outputs
2018-05-13 11:37:02 +02:00
(that can only be ON/OFF) and ``float`` outputs (like PWM, can output
any rational value between 0 and 1).
2018-06-01 18:10:00 +02:00
.. _config-output:
2018-05-13 11:37:02 +02:00
Base Output Configuration
2018-10-12 16:33:22 +02:00
-------------------------
2018-05-13 11:37:02 +02:00
Each output platform extends this configuration schema.
.. code-block:: yaml
2018-05-13 11:37:02 +02:00
# Example configuration entry
output:
- platform: ...
2018-10-20 15:10:26 +02:00
id: my_output_id
2018-05-13 11:37:02 +02:00
power_supply: power_supply_id
inverted: False
min_power: 0.01
2018-05-13 11:37:02 +02:00
max_power: 0.75
Configuration variables:
2018-06-01 18:10:00 +02:00
- **id** (**Required**, :ref:`config-id`): The id to use for this output component.
- **power_supply** (*Optional*, :ref:`config-id`): The :doc:`power
supply </components/power_supply>` to connect to
2018-06-01 18:10:00 +02:00
this output. When the output is enabled, the power supply will
automatically be switched on too.
- **inverted** (*Optional*, boolean): If the output should be treated
as inverted. Defaults to ``False``.
Float outputs only:
- **min_power** (*Optional*, float): Sets the minimum output value of this output platform.
Must be in range from 0 to max_power. Defaults to ``0``.
- **max_power** (*Optional*, float): Sets the maximum output value of this output platform.
Must be in range from min_power to 1. Defaults to ``1``.
2018-06-01 18:10:00 +02:00
.. _output-turn_on_action:
``output.turn_on`` Action
2018-10-12 16:33:22 +02:00
*************************
This action turns the output with the given ID on when executed.
.. code-block:: yaml
on_...:
then:
- output.turn_on: relay_1
.. note::
This action can also be expressed in :ref:`lambdas <config-lambda>`:
.. code-block:: cpp
id(relay_1).turn_on();
.. _output-turn_off_action:
``output.turn_off`` Action
2018-10-12 16:33:22 +02:00
**************************
This action turns the output with the given ID off when executed.
.. code-block:: yaml
on_...:
then:
- output.turn_off: relay_1
.. note::
This action can also be expressed in :ref:`lambdas <config-lambda>`:
.. code-block:: cpp
id(relay_1).turn_off();
.. _output-set_level_action:
``output.set_level`` Action
2018-10-12 16:33:22 +02:00
***************************
This action sets the float output to the given level when executed. Note: This only
works with floating point outputs like ESP8266 PWM or LEDC.
.. code-block:: yaml
on_...:
then:
- output.set_level:
id: output_1
level: 50%
.. note::
This action can also be expressed in :ref:`lambdas <config-lambda>`:
.. code-block:: cpp
// range is 0.0 (off) to 1.0 (on)
id(relay_1).set_level(0.5);
2018-06-01 18:10:00 +02:00
Full Output Index
2018-10-12 16:33:22 +02:00
-----------------
2018-06-01 18:10:00 +02:00
- :doc:`/components/switch/output`
- :doc:`/components/power_supply`
- :doc:`/components/light/binary`
- :doc:`/components/light/monochromatic`
- :doc:`/components/light/rgb`
- :doc:`/components/fan/binary`
- :doc:`/components/fan/speed`
2019-05-12 22:44:59 +02:00
- :apiref:`binary_output.h <output/binary_output.h>`,
:apiref:`float_output.h <output/float_output.h>`
- :ghedit:`Edit`
2018-06-01 18:10:00 +02:00
.. toctree::
:maxdepth: 1
:glob:
2018-06-01 18:10:00 +02:00
*