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.
|
2021-11-16 03:19:33 +01:00
|
|
|
:image: home-assistant.svg
|
2019-01-06 18:56:14 +01:00
|
|
|
|
2019-04-07 21:48:35 +02:00
|
|
|
The ``homeassistant`` sensor platform allows you to create sensors that import
|
2019-02-07 13:54:45 +01:00
|
|
|
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
|
|
|
|
|
|
2022-11-14 14:17:55 +01:00
|
|
|
Entity state attributes can also be imported:
|
2021-05-17 01:16:33 +02:00
|
|
|
|
|
|
|
|
.. code-block:: yaml
|
|
|
|
|
|
|
|
|
|
# Example configuration entry
|
|
|
|
|
sensor:
|
|
|
|
|
- platform: homeassistant
|
|
|
|
|
id: current_temperature
|
|
|
|
|
entity_id: climate.living_room
|
|
|
|
|
attribute: current_temperature
|
|
|
|
|
|
2019-01-06 18:56:14 +01:00
|
|
|
.. note::
|
|
|
|
|
|
|
|
|
|
This component is only for numeral states. If you want to import arbitrary text states
|
2019-02-07 13:54:45 +01:00
|
|
|
from Home Assistant, use the :doc:`Home Assistant Text Sensor </components/text_sensor/homeassistant>`.
|
2020-12-21 01:55:44 +01:00
|
|
|
|
2023-04-13 16:08:10 +02:00
|
|
|
Although you might not plan to *export* states from the node and you do not need an entity of the node
|
2020-12-21 01:55:44 +01:00
|
|
|
in Home Assistant, this component still requires you to register the node under Home Assistant. See:
|
2021-05-20 16:36:42 +02:00
|
|
|
:doc:`Getting started with Home Assistant </guides/getting_started_hassio>`
|
2019-01-06 18:56:14 +01:00
|
|
|
|
|
|
|
|
Configuration variables:
|
|
|
|
|
------------------------
|
|
|
|
|
|
|
|
|
|
- **name** (**Required**, string): The name of the sensor.
|
|
|
|
|
- **entity_id** (**Required**, string): The entity ID to import from Home Assistant.
|
2021-05-17 01:16:33 +02:00
|
|
|
- **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:`Sensor <config-sensor>`.
|
2019-01-06 18:56:14 +01:00
|
|
|
|
2022-11-14 14:17:55 +01:00
|
|
|
|
|
|
|
|
.. note::
|
|
|
|
|
|
2023-04-13 16:08:10 +02:00
|
|
|
The sensors implemented by this component are by default ``internal``, to avoid exporting them back to
|
2022-11-14 14:17:55 +01:00
|
|
|
Home Assistant. Should you still want to do that (eg. because you use ESPHome's very efficient filters
|
|
|
|
|
on them) you need to specifically configure ``internal: false``. Also, ``state_class``, ``unit_of_measurement``
|
|
|
|
|
are not inherited from the imported sensor so you need to set them manually.
|
|
|
|
|
|
|
|
|
|
|
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`
|
2019-02-07 13:54:45 +01:00
|
|
|
- :ghedit:`Edit`
|
