Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-09-27 04:13:07 +02:00
Code Issues Projects Releases Wiki Activity

More `homeassistant` platform notes (#4274)

Browse Source
This commit is contained in:
Jesse Hills 2024-09-23 16:40:23 +12:00 committed by GitHub
parent 22bcedbba8
commit 03a7a1cb1f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 38 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
components/binary_sensor/homeassistant.rst
View File

@ -8,6 +8,12 @@ Home Assistant Binary Sensor
The ``homeassistant`` binary sensor platform allows you to create binary sensors that **import**
states from your Home Assistant instance using the :doc:`native API </components/api>`.
.. note::
Although 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:
:ref:`connecting-your-device-to-home-assistant`.
.. code-block:: yaml
# Example configuration entry

6
components/number/homeassistant.rst
View File

@ -8,6 +8,12 @@ Home Assistant Number
The ``homeassistant`` number platform allows you to create a number that is synchronized
with Home Assistant. Min, Max and Step are not configurable for this platform because they are taken from the Home Assistant entity.
.. note::
Although 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:
:ref:`connecting-your-device-to-home-assistant`.
.. code-block:: yaml
# Example configuration entry

9
components/sensor/homeassistant.rst
View File

@ -8,6 +8,12 @@ Home Assistant Sensor
The ``homeassistant`` sensor platform allows you to create sensors that import
states from your Home Assistant instance using the :doc:`native API </components/api>`.
.. note::
Although 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:
:ref:`connecting-your-device-to-home-assistant`.
.. code-block:: yaml
# Example configuration entry
@ -32,9 +38,6 @@ Entity state attributes can also be imported:
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>`.
Although 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 Home Assistant </guides/getting_started_hassio>`
Configuration variables:
------------------------

6
components/switch/homeassistant.rst
View File

@ -8,6 +8,12 @@ Home Assistant Switch
The ``homeassistant`` Switch platform allows you to create Switch that **import**
states and allow **control** via your Home Assistant instance using the :doc:`native API </components/api>`.
.. note::
Although 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:
:ref:`connecting-your-device-to-home-assistant`.
.. code-block:: yaml
# Example configuration entry

6
components/text_sensor/homeassistant.rst
View File

@ -8,6 +8,12 @@ Home Assistant Text Sensor
The ``homeassistant`` text sensor platform allows you to create sensors that import
states from your Home Assistant instance using the :doc:`native API </components/api>`.
.. note::
Although 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:
:ref:`connecting-your-device-to-home-assistant`.
.. code-block:: yaml
# Example configuration entry

6
components/time/homeassistant.rst
View File

@ -5,6 +5,12 @@ The preferred way to get time in ESPHome is using Home Assistant.
With the ``homeassistant`` time platform, the :doc:`native API </components/api>` connection
to Home Assistant will be used to periodically synchronize the current time.
.. note::
Although 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:
:ref:`connecting-your-device-to-home-assistant`.
.. code-block:: yaml
# Example configuration entry

2
guides/getting_started_hassio.rst
View File

@ -105,6 +105,8 @@ to the configuration like this:
In above example, we're simply adding a switch that's called "Living Room Dehumidifier" (could control
anything really, for example lights) and is connected to the pin ``GPIO5``.
.. _connecting-your-device-to-home-assistant:
Connecting your device to Home Assistant
----------------------------------------