From 03a7a1cb1f6549b692a47e4ad418deaf9ecbafec Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Mon, 23 Sep 2024 16:40:23 +1200 Subject: [PATCH] More ``homeassistant`` platform notes (#4274) --- components/binary_sensor/homeassistant.rst | 6 ++++++ components/number/homeassistant.rst | 6 ++++++ components/sensor/homeassistant.rst | 9 ++++++--- components/switch/homeassistant.rst | 6 ++++++ components/text_sensor/homeassistant.rst | 6 ++++++ components/time/homeassistant.rst | 6 ++++++ guides/getting_started_hassio.rst | 2 ++ 7 files changed, 38 insertions(+), 3 deletions(-) diff --git a/components/binary_sensor/homeassistant.rst b/components/binary_sensor/homeassistant.rst index b822a075b..e972fc8dc 100644 --- a/components/binary_sensor/homeassistant.rst +++ b/components/binary_sensor/homeassistant.rst @@ -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 `. +.. 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 diff --git a/components/number/homeassistant.rst b/components/number/homeassistant.rst index 3a657c513..d1eafcb30 100644 --- a/components/number/homeassistant.rst +++ b/components/number/homeassistant.rst @@ -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 diff --git a/components/sensor/homeassistant.rst b/components/sensor/homeassistant.rst index 631615702..e04516824 100644 --- a/components/sensor/homeassistant.rst +++ b/components/sensor/homeassistant.rst @@ -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 `. +.. 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 `. - 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 ` Configuration variables: ------------------------ diff --git a/components/switch/homeassistant.rst b/components/switch/homeassistant.rst index 502ae3a1d..abc0cf1d7 100644 --- a/components/switch/homeassistant.rst +++ b/components/switch/homeassistant.rst @@ -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 `. +.. 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 diff --git a/components/text_sensor/homeassistant.rst b/components/text_sensor/homeassistant.rst index 35d2bd625..be918ffc3 100644 --- a/components/text_sensor/homeassistant.rst +++ b/components/text_sensor/homeassistant.rst @@ -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 `. +.. 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 diff --git a/components/time/homeassistant.rst b/components/time/homeassistant.rst index 50cece7ec..901f743ca 100644 --- a/components/time/homeassistant.rst +++ b/components/time/homeassistant.rst @@ -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 ` 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 diff --git a/guides/getting_started_hassio.rst b/guides/getting_started_hassio.rst index 8e18d2fb0..209425977 100644 --- a/guides/getting_started_hassio.rst +++ b/guides/getting_started_hassio.rst @@ -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 ----------------------------------------