Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More homeassistant platform notes #4274

Merged
merged 1 commit into from
Sep 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions components/binary_sensor/homeassistant.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions components/number/homeassistant.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 6 additions & 3 deletions components/sensor/homeassistant.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
------------------------
Expand Down
6 changes: 6 additions & 0 deletions components/switch/homeassistant.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions components/text_sensor/homeassistant.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions components/time/homeassistant.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions guides/getting_started_hassio.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------------------------------------

Expand Down