114 lines
2.3 KiB
ReStructuredText
114 lines
2.3 KiB
ReStructuredText
Cover Component
|
|
===============
|
|
|
|
.. seo::
|
|
:description: Instructions for setting up base covers in esphomelib.
|
|
:image: folder-opn.svg
|
|
|
|
The ``cover`` component is a generic representation of covers in esphomelib/yaml.
|
|
A cover can (currently) either be *closed* or *open* and supports three types of
|
|
commands: *open*, *close* and *stop*.
|
|
|
|
.. _cover-open_action:
|
|
|
|
``cover.open`` Action
|
|
---------------------
|
|
|
|
This action opens the cover with the given ID when executed.
|
|
|
|
.. code:: yaml
|
|
|
|
on_...:
|
|
then:
|
|
- cover.open: cover_1
|
|
|
|
.. note::
|
|
|
|
This action can also be expressed in :ref:`lambdas <config-lambda>`:
|
|
|
|
.. code:: cpp
|
|
|
|
id(cover_1).open();
|
|
|
|
.. _cover-close_action:
|
|
|
|
``cover.close`` Action
|
|
----------------------
|
|
|
|
This action closes the cover with the given ID when executed.
|
|
|
|
.. code:: yaml
|
|
|
|
on_...:
|
|
then:
|
|
- cover.close: cover_1
|
|
|
|
.. note::
|
|
|
|
This action can also be expressed in :ref:`lambdas <config-lambda>`:
|
|
|
|
.. code:: cpp
|
|
|
|
id(cover_1).close();
|
|
|
|
.. _cover-stop_action:
|
|
|
|
``cover.stop`` Action
|
|
---------------------
|
|
|
|
This action stops the cover with the given ID when executed.
|
|
|
|
.. code:: yaml
|
|
|
|
on_...:
|
|
then:
|
|
- cover.stop: cover_1
|
|
|
|
.. note::
|
|
|
|
This action can also be expressed in :ref:`lambdas <config-lambda>`:
|
|
|
|
.. code:: cpp
|
|
|
|
id(cover_1).stop();
|
|
|
|
|
|
lambda calls
|
|
------------
|
|
|
|
From :ref:`lambdas <config-lambda>`, you can call several methods on all covers to do some
|
|
advanced stuff (see the full :doc:`API Reference </api/cover/index>` for more info).
|
|
|
|
- ``publish_state()``: Manually cause the cover to publish a new state and store it internally.
|
|
If it's different from the last internal state, it's additionally published to the frontend.
|
|
|
|
.. code:: yaml
|
|
|
|
// Within lambda, make the cover report a specific state
|
|
id(my_cover).publish_state(cover::COVER_OPEN);
|
|
id(my_cover).publish_state(cover::COVER_CLOSED);
|
|
|
|
- ``state``: Retrieve the current state of the cover.
|
|
|
|
.. code:: yaml
|
|
|
|
if (id(my_cover).state == cover::COVER_OPEN) {
|
|
// Cover is open
|
|
} else {
|
|
// Cover is closed
|
|
}
|
|
|
|
See Also
|
|
--------
|
|
|
|
- :doc:`API Reference </api/cover/index>`
|
|
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/cover/index.rst>`__
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:glob:
|
|
|
|
*
|
|
|
|
.. disqus::
|