esphome-docs/components/text_sensor/homeassistant.rst

48 lines
1.6 KiB
ReStructuredText
Raw Normal View History

2020-05-10 21:27:59 +02:00
Home Assistant Text Sensor
==========================
2019-01-06 18:56:14 +01:00
.. seo::
2020-05-10 21:27:59 +02:00
:description: Instructions for setting up Home Assistant text sensors with ESPHome that import states from your Home Assistant instance.
:image: home-assistant.svg
2019-01-06 18:56:14 +01:00
The ``homeassistant`` text sensor platform allows you to create a sensors that import
states from your Home Assistant instance using the :doc:`native API </components/api>`.
2019-01-06 18:56:14 +01:00
.. code-block:: yaml
# Example configuration entry
text_sensor:
- platform: homeassistant
name: "Weather Forecast From Home Assistant"
entity_id: sensor.weather_forecast
With Home Assistant 2021.6 or newer, entity state attributes can also be imported.
.. code-block:: yaml
# Example configuration entry
text_sensor:
- platform: homeassistant
id: effect
entity_id: light.led_strip
attribute: effect
2019-01-06 18:56:14 +01:00
Configuration variables:
------------------------
- **name** (**Required**, string): The name of the text 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-07 18:07:16 +01:00
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
2019-02-17 12:28:17 +01:00
- All other options from :ref:`Text Sensor <config-text_sensor>`.
2019-01-06 18:56:14 +01:00
See Also
--------
- :ref:`sensor-filters`
- :ref:`automation`
2019-05-12 22:44:59 +02:00
- :apiref:`homeassistant/text_sensor/homeassistant_text_sensor.h`
- :ghedit:`Edit`