esphome-docs/components/text_sensor/homeassistant.rst

Homeassistant Text Sensor
=========================

.. seo::
    :description: Instructions for setting up homeassistant text sensors with ESPHome that import states from your homeassistant instance.
    :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>`.

.. 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.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Text Sensor <config-text_sensor>` and :ref:`MQTT Component <config-mqtt-component>`.

See Also
--------

- :ref:`sensor-filters`
- :ref:`automation`
- :apiref:`text_sensor/homeassistant_text_sensor.h`
- :ghedit:`Edit`

.. disqus::