esphome-docs/components/sensor/homeassistant.rst

46 lines
1.7 KiB
ReStructuredText
Raw Normal View History

2020-05-10 21:27:59 +02:00
Home Assistant 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 sensors with ESPHome that import states from your Home Assistant instance.
2019-01-06 18:56:14 +01:00
:image: home-assistant.png
The ``homeassistant`` sensor platform allows you to create 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
sensor:
- platform: homeassistant
name: "Temperature Sensor From Home Assistant"
entity_id: sensor.temperature_sensor
.. note::
This component is only for numeral states. If you want to import arbitrary text states
from Home Assistant, use the :doc:`Home Assistant Text Sensor </components/text_sensor/homeassistant>`.
Albeit you might not plan to __export__ states from the node and you do not need an entity of the node
in Home Assistant, this component still requires you to register the node under Home Assistant. See:
:doc:`Getting started with Hassio </guides/getting_started_hassio>`
2019-01-06 18:56:14 +01:00
Importing attributes is currently not supported, but you can create template sensors in Home Assistant
that return the attribute of a sensor and then import the template sensor here.
Configuration variables:
------------------------
- **name** (**Required**, string): The name of the 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:`Sensor <config-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/sensor/homeassistant_sensor.h`
- :ghedit:`Edit`