mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-10-18 07:35:40 +02:00
44 lines
1.6 KiB
ReStructuredText
44 lines
1.6 KiB
ReStructuredText
|
Homeassistant Sensor
|
||
|
|
====================
|
||
|
|
|
||
|
|
.. seo::
|
||
|
|
:description: Instructions for setting up homeassistant sensors with esphomelib that import states from your homeassistant instance.
|
||
|
|
:image: home-assistant.png
|
||
|
|
|
||
|
|
The ``homeassistant`` sensor platform allows you to create a sensors that import
|
||
|
|
states from your Home Assistant instance using the :doc:`native API </esphomeyaml/components/api>`.
|
||
|
|
|
||
|
|
.. 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 </esphomeyaml/components/text_sensor/homeassistant>`.
|
||
|
|
|
||
|
|
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.
|
||
|
|
- **id** (*Optional*,:ref:`config-id`): Manually specify the ID used for code generation.
|
||
|
|
- All other options from :ref:`Sensor <config-sensor>` and :ref:`MQTT Component <config-mqtt-component>`.
|
||
|
|
|
||
|
|
See Also
|
||
|
|
--------
|
||
|
|
|
||
|
|
- :ref:`sensor-filters`
|
||
|
|
- :ref:`automation`
|
||
|
|
- :doc:`API Reference </api/core/native-api>`
|
||
|
|
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/homeassistant.rst>`__
|
||
|
|
|
||
|
|
.. disqus::
|