mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-12-27 17:37:45 +01:00
31 lines
923 B
ReStructuredText
31 lines
923 B
ReStructuredText
|
Home Assistant Switch
|
||
|
|
=====================
|
||
|
|
|
||
|
|
.. seo::
|
||
|
|
:description: Instructions for setting up Home Assistant Switch with ESPHome that import states and allows control via your Home Assistant instance.
|
||
|
|
:image: home-assistant.svg
|
||
|
|
|
||
|
|
The ``homeassistant`` Switch platform allows you to create Switch that **import**
|
||
|
|
states and allow **control** via your Home Assistant instance using the :doc:`native API </components/api>`.
|
||
|
|
|
||
|
|
.. code-block:: yaml
|
||
|
|
|
||
|
|
# Example configuration entry
|
||
|
|
switch:
|
||
|
|
- platform: homeassistant
|
||
|
|
id: my_cool_switch_from_ha
|
||
|
|
entity_id: switch.my_cool_switch
|
||
|
|
|
||
|
|
Configuration variables:
|
||
|
|
------------------------
|
||
|
|
|
||
|
|
- **entity_id** (**Required**, string): The entity ID to import / control from Home Assistant.
|
||
|
|
- All other options from :ref:`Switch <config-switch>`.
|
||
|
|
|
||
|
|
See Also
|
||
|
|
--------
|
||
|
|
|
||
|
|
- :ref:`automation`
|
||
|
|
- :apiref:`homeassistant/switch/homeassistant_switch.h`
|
||
|
|
- :ghedit:`Edit`
|