esphome-docs/components/text_sensor/homeassistant.rst

34 lines
1.1 KiB
ReStructuredText
Raw Normal View History

2019-01-06 18:56:14 +01:00
Homeassistant Text Sensor
=========================
.. seo::
2019-02-16 23:25:23 +01:00
:description: Instructions for setting up homeassistant text sensors with ESPHome that import states from your homeassistant instance.
2019-01-06 18:56:14 +01:00
:image: home-assistant.png
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
Configuration variables:
------------------------
- **name** (**Required**, string): The name of the text sensor.
- **entity_id** (**Required**, string): The entity ID to import from Home Assistant.
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`
- :apiref:`text_sensor/homeassistant_text_sensor.h`
- :ghedit:`Edit`