esphome-docs/components/binary_sensor/homeassistant.rst

47 lines
1.6 KiB
ReStructuredText
Raw Normal View History

2020-05-10 21:27:59 +02:00
Home Assistant Binary Sensor
============================
2019-02-16 23:24:32 +01:00
.. seo::
2020-05-10 21:27:59 +02:00
:description: Instructions for setting up Home Assistant binary sensors with ESPHome that import states from your Home Assistant instance.
2019-02-16 23:24:32 +01:00
: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
With Home Assistant 2021.6 or newer, entity state attributes can also be imported.
.. code-block:: yaml
# Example configuration entry
binary_sensor:
- platform: homeassistant
id: muted
entity_id: media_player.mega_speakers
attribute: is_volume_muted
2019-02-16 23:24:32 +01:00
Configuration variables:
------------------------
- **name** (**Required**, string): The name of the binary sensor.
- **entity_id** (**Required**, string): The entity ID to import from Home Assistant.
- **attribute** (*Optional*, string): The name of the state attribute to import from the
specified entity. The entity state is used when this option is omitted.
Requires Home Assistant 2021.6 or newer.
2019-02-16 23:24:32 +01:00
- **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`
2019-05-12 22:44:59 +02:00
- :apiref:`homeassistant/binary_sensor/homeassistant_binary_sensor.h`
2019-02-16 23:24:32 +01:00
- :ghedit:`Edit`