Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Homeassistant cover #4005

Open
wants to merge 3 commits into
base: next
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions components/cover/homeassistant.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
Home Assistant Cover
====================

.. seo::
:description: Instructions for setting up Home Assistant Cover with ESPHome that import states and allows control via your Home Assistant instance.
:image: home-assistant.svg

The ``homeassistant`` Cover platform allows you to create Cover that **import**
states and allow **control** via your Home Assistant instance using the :doc:`native API </components/api>`.

.. code-block:: yaml

# Example configuration entry
cover:
- platform: homeassistant
name: "Input Boolean From Home Assistant"
entity_id: cover.my_cool_cover

Configuration variables:
------------------------

- **name** (**Required**, string): The name of the binary sensor.
- **entity_id** (**Required**, string): The entity ID to import / control from Home Assistant.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Binary Sensor <config-cover>`.

See Also
--------

- :ref:`automation`
- :apiref:`homeassistant/cover/homeassistant_cover.h`
- :ghedit:`Edit`
2 changes: 2 additions & 0 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -907,6 +907,7 @@ Cover Components
HE60R Cover, components/cover/he60r, he60r.jpg
Time-Based Cover, components/cover/time_based, timer.svg, dark-invert
Tuya Cover, components/cover/tuya, tuya.png
Home Assistant, components/cover/homeassistant, home-assistant.svg, dark-invert

Text Components
---------------
Expand Down Expand Up @@ -1046,6 +1047,7 @@ Components specifically for interacting with Home Assistant.
Switch, components/switch/homeassistant, home-assistant.svg, dark-invert
Text Sensor, components/text_sensor/homeassistant, home-assistant.svg, dark-invert
Voice Assistant, components/voice_assistant, voice-assistant.svg, dark-invert
Cover, components/cover/homeassistant, home-assistant.svg, dark-invert


Alarm Control Panel Components
Expand Down