esphome-docs/components/binary_sensor/homeassistant.rst
2020-05-10 16:27:59 -03:00

33 lines
1.1 KiB
ReStructuredText

Home Assistant Binary Sensor
============================
.. seo::
:description: Instructions for setting up Home Assistant binary sensors with ESPHome that import states from your Home Assistant instance.
:image: home-assistant.png
The ``homeassistant`` binary sensor platform allows you to create binary sensors that **import**
states from your Home Assistant instance using the :doc:`native API </components/api>`.
.. code-block:: yaml
# Example configuration entry
binary_sensor:
- platform: homeassistant
name: "Input Boolean From Home Assistant"
entity_id: input_boolean.state_home
Configuration variables:
------------------------
- **name** (**Required**, string): The name of the binary sensor.
- **entity_id** (**Required**, string): The entity ID to import from Home Assistant.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
See Also
--------
- :ref:`automation`
- :apiref:`homeassistant/binary_sensor/homeassistant_binary_sensor.h`
- :ghedit:`Edit`