From b8523b89fbf3a29c32ecbec928f8d41ef402ba27 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Tue, 23 Apr 2024 16:46:47 +1200 Subject: [PATCH] Remove "Required Home Assistant XXXX.X" messages for older versions (#3788) --- components/binary_sensor/homeassistant.rst | 1 - components/binary_sensor/index.rst | 4 ++-- components/bluetooth_proxy.rst | 8 ++------ components/climate/index.rst | 4 ++-- components/cover/index.rst | 4 ++-- components/datetime/index.rst | 4 ++-- components/esp32_camera.rst | 6 +++--- components/fan/index.rst | 4 ++-- components/light/index.rst | 4 ++-- components/lock/index.rst | 4 ---- components/number/index.rst | 8 ++++---- components/select/index.rst | 4 ++-- components/sensor/homeassistant.rst | 7 +++---- components/sensor/index.rst | 4 ++-- components/switch/index.rst | 6 +++--- components/text_sensor/index.rst | 4 ++-- 16 files changed, 33 insertions(+), 43 deletions(-) diff --git a/components/binary_sensor/homeassistant.rst b/components/binary_sensor/homeassistant.rst index f98924abd..2628c5d58 100644 --- a/components/binary_sensor/homeassistant.rst +++ b/components/binary_sensor/homeassistant.rst @@ -34,7 +34,6 @@ Configuration variables: - **entity_id** (**Required**, string): The entity ID to import from Home Assistant. - **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. - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Binary Sensor `. diff --git a/components/binary_sensor/index.rst b/components/binary_sensor/index.rst index 0573e2f42..7cab5120d 100644 --- a/components/binary_sensor/index.rst +++ b/components/binary_sensor/index.rst @@ -66,12 +66,12 @@ Advanced options: a ``name`` will implicitly set this to true. - **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend, (usually Home Assistant) without the user manually enabling it (via the Home Assistant UI). - Requires Home Assistant 2021.9 or newer. Defaults to ``false``. + Defaults to ``false``. - **publish_initial_state** (*Optional*, boolean): If true, then the sensor will publish its initial state at boot or when HA first connects, depending on the platform. This means that any applicable triggers will be run. Defaults to ``false``. - **entity_category** (*Optional*, string): The category of the entity. See https://developers.home-assistant.io/docs/core/entity/#generic-properties - for a list of available options. Requires Home Assistant 2021.11 or newer. + for a list of available options. Set to ``""`` to remove the default entity category. - If MQTT enabled, all other options from :ref:`MQTT Component `. diff --git a/components/bluetooth_proxy.rst b/components/bluetooth_proxy.rst index b976d10be..10c38bb32 100644 --- a/components/bluetooth_proxy.rst +++ b/components/bluetooth_proxy.rst @@ -32,7 +32,7 @@ our `Bluetooth Proxy installer `__ The :doc:`web_server` component should be disabled as the device is likely to run out of memory and will malfunction when both components are enabled simultaneously. - + Not all devices are supported and ESPHome does not decode or keep a list. To find out if your device is supported, please search for it in the `Home Assistant Integrations `__ list. @@ -43,15 +43,11 @@ Configuration: bluetooth_proxy: -- **active** (*Optional*, boolean): Enables proxying active connections. Defaults to ``false``. Requires Home Assistant 2022.10 or later. +- **active** (*Optional*, boolean): Enables proxying active connections. Defaults to ``false``. - **cache_services** (*Optional*, boolean): Enables caching GATT services in NVS flash storage which significantly speeds up active connections. Defaults to ``true`` when using the ESP-IDF framework. The Bluetooth proxy depends on :doc:`esp32_ble_tracker` so make sure to add that to your configuration. -.. note:: - - Bluetooth proxy requires Home Assistant 2022.9 or later. ESPHome 2022.12.0 and Home Assistant 2022.12.6 or later is recommended. - Improving reception performance ------------------------------- diff --git a/components/climate/index.rst b/components/climate/index.rst index dde76b23b..263913e73 100644 --- a/components/climate/index.rst +++ b/components/climate/index.rst @@ -80,10 +80,10 @@ Advanced options: a ``name`` will implicitly set this to true. - **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend, (usually Home Assistant) without the user manually enabling it (via the Home Assistant UI). - Requires Home Assistant 2021.9 or newer. Defaults to ``false``. + Defaults to ``false``. - **entity_category** (*Optional*, string): The category of the entity. See https://developers.home-assistant.io/docs/core/entity/#generic-properties - for a list of available options. Requires Home Assistant 2021.11 or newer. + for a list of available options. Set to ``""`` to remove the default entity category. MQTT options: diff --git a/components/cover/index.rst b/components/cover/index.rst index abc95bec2..146f4db9e 100644 --- a/components/cover/index.rst +++ b/components/cover/index.rst @@ -46,10 +46,10 @@ Advanced options: a ``name`` will implicitly set this to true. - **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend, (usually Home Assistant) without the user manually enabling it (via the Home Assistant UI). - Requires Home Assistant 2021.9 or newer. Defaults to ``false``. + Defaults to ``false``. - **entity_category** (*Optional*, string): The category of the entity. See https://developers.home-assistant.io/docs/core/entity/#generic-properties - for a list of available options. Requires Home Assistant 2021.11 or newer. + for a list of available options. Set to ``""`` to remove the default entity category. MQTT options: diff --git a/components/datetime/index.rst b/components/datetime/index.rst index 26ff54eea..57636918e 100644 --- a/components/datetime/index.rst +++ b/components/datetime/index.rst @@ -42,10 +42,10 @@ Configuration variables: a ``name`` will implicitly set this to true. - **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend, (usually Home Assistant) without the user manually enabling it (via the Home Assistant UI). - Requires Home Assistant 2021.9 or newer. Defaults to ``false``. + Defaults to ``false``. - **entity_category** (*Optional*, string): The category of the entity. See https://developers.home-assistant.io/docs/core/entity/#generic-properties - for a list of available options. Requires Home Assistant 2021.11 or newer. + for a list of available options. Set to ``""`` to remove the default entity category. MQTT Options: diff --git a/components/esp32_camera.rst b/components/esp32_camera.rst index 793e08887..0981c25fc 100644 --- a/components/esp32_camera.rst +++ b/components/esp32_camera.rst @@ -37,10 +37,10 @@ Configuration variables: a ``name`` will implicitly set this to true. - **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend, (usually Home Assistant) without the user manually enabling it (via the Home Assistant UI). - Requires Home Assistant 2021.9 or newer. Defaults to ``false``. + Defaults to ``false``. - **entity_category** (*Optional*, string): The category of the entity. See https://developers.home-assistant.io/docs/core/entity/#generic-properties - for a list of available options. Requires Home Assistant 2021.11 or newer. + for a list of available options. Set to ``""`` to remove the default entity category. Connection Options: @@ -179,7 +179,7 @@ Configuration for Ai-Thinker Camera .. warning:: - GPIO16 on this board (and possibly other boards below) is connected to onboard PSRAM. + GPIO16 on this board (and possibly other boards below) is connected to onboard PSRAM. Using this GPIO for other purposes (eg as a button) will trigger the watchdog. Further information on pin notes can be found here: https://github.com/raphaelbs/esp32-cam-ai-thinker/blob/master/docs/esp32cam-pin-notes.md diff --git a/components/fan/index.rst b/components/fan/index.rst index 415e3d562..08039308a 100644 --- a/components/fan/index.rst +++ b/components/fan/index.rst @@ -49,10 +49,10 @@ Configuration variables: a ``name`` will implicitly set this to true. - **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend (usually Home Assistant) without the user manually enabling it (via the Home Assistant UI). - Requires Home Assistant 2021.9 or newer. Defaults to ``false``. + Defaults to ``false``. - **entity_category** (*Optional*, string): The category of the entity. See https://developers.home-assistant.io/docs/core/entity/#generic-properties - for a list of available options. Requires Home Assistant 2021.11 or newer. + for a list of available options. Set to ``""`` to remove the default entity category. MQTT options: diff --git a/components/light/index.rst b/components/light/index.rst index c57c9470a..ee9a31d9f 100644 --- a/components/light/index.rst +++ b/components/light/index.rst @@ -77,10 +77,10 @@ Advanced options: a ``name`` will implicitly set this to true. - **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend, (usually Home Assistant) without the user manually enabling it (via the Home Assistant UI). - Requires Home Assistant 2021.9 or newer. Defaults to ``false``. + Defaults to ``false``. - **entity_category** (*Optional*, string): The category of the entity. See https://developers.home-assistant.io/docs/core/entity/#generic-properties - for a list of available options. Requires Home Assistant 2021.11 or newer. + for a list of available options. Set to ``""`` to remove the default entity category. - If MQTT enabled, all other options from :ref:`MQTT Component `. diff --git a/components/lock/index.rst b/components/lock/index.rst index 0428510cb..ac15894c3 100644 --- a/components/lock/index.rst +++ b/components/lock/index.rst @@ -8,10 +8,6 @@ Lock Component The ``lock`` domain includes all platforms that should function like a lock with lock/unlock actions. -.. note:: - - ESPHome lock components requires Home Assistant 2022.3 or newer - .. _config-lock: Base Lock Configuration diff --git a/components/number/index.rst b/components/number/index.rst index d32079576..9cdb03526 100644 --- a/components/number/index.rst +++ b/components/number/index.rst @@ -43,16 +43,16 @@ Configuration variables: a ``name`` will implicitly set this to true. - **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend, (usually Home Assistant) without the user manually enabling it (via the Home Assistant UI). - Requires Home Assistant 2021.9 or newer. Defaults to ``false``. + Defaults to ``false``. - **entity_category** (*Optional*, string): The category of the entity. See https://developers.home-assistant.io/docs/core/entity/#generic-properties - for a list of available options. Requires Home Assistant 2021.11 or newer. + for a list of available options. Set to ``""`` to remove the default entity category. - **unit_of_measurement** (*Optional*, string): Manually set the unit - of measurement for the number. Requires Home Assistant Core 2021.12 or newer. + of measurement for the number. - **mode** (*Optional*, string): Defines how the number should be displayed in the frontend. See https://developers.home-assistant.io/docs/core/entity/number/#properties - for a list of available options. Requires Home Assistant Core 2021.12 or newer. + for a list of available options. Defaults to ``"auto"``. - **device_class** (*Optional*, string): The device class for the number. See https://www.home-assistant.io/integrations/number/#device-class diff --git a/components/select/index.rst b/components/select/index.rst index a79c4d926..77fc53891 100644 --- a/components/select/index.rst +++ b/components/select/index.rst @@ -43,10 +43,10 @@ Configuration variables: a ``name`` will implicitly set this to true. - **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend, (usually Home Assistant) without the user manually enabling it (via the Home Assistant UI). - Requires Home Assistant 2021.9 or newer. Defaults to ``false``. + Defaults to ``false``. - **entity_category** (*Optional*, string): The category of the entity. See https://developers.home-assistant.io/docs/core/entity/#generic-properties - for a list of available options. Requires Home Assistant 2021.11 or newer. + for a list of available options. Set to ``""`` to remove the default entity category. Automations: diff --git a/components/sensor/homeassistant.rst b/components/sensor/homeassistant.rst index fd2096fa1..b8d0ea0e9 100644 --- a/components/sensor/homeassistant.rst +++ b/components/sensor/homeassistant.rst @@ -31,7 +31,7 @@ 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 ` @@ -43,16 +43,15 @@ Configuration variables: - **entity_id** (**Required**, string): The entity ID to import from Home Assistant. - **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. - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Sensor `. .. note:: - The sensors implemented by this component are by default ``internal``, to avoid exporting them back to + The sensors implemented by this component are by default ``internal``, to avoid exporting them back to 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`` + 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. diff --git a/components/sensor/index.rst b/components/sensor/index.rst index 9be1a5869..05df0921d 100644 --- a/components/sensor/index.rst +++ b/components/sensor/index.rst @@ -68,10 +68,10 @@ Configuration variables: significantly increase the database size. Defaults to ``false``. - **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend, (usually Home Assistant) without the user manually enabling it (via the Home Assistant UI). - Requires Home Assistant 2021.9 or newer. Defaults to ``false``. + Defaults to ``false``. - **entity_category** (*Optional*, string): The category of the entity. See https://developers.home-assistant.io/docs/core/entity/#generic-properties - for a list of available options. Requires Home Assistant 2021.11 or newer. + for a list of available options. Set to ``""`` to remove the default entity category. Automations: diff --git a/components/switch/index.rst b/components/switch/index.rst index 88c739be6..eca9a1bed 100644 --- a/components/switch/index.rst +++ b/components/switch/index.rst @@ -59,14 +59,14 @@ Configuration variables: when the switch is turned off. See :ref:`switch-on_turn_on_off_trigger`. - **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend, (usually Home Assistant) without the user manually enabling it (via the Home Assistant UI). - Requires Home Assistant 2021.9 or newer. Defaults to ``false``. + Defaults to ``false``. - **entity_category** (*Optional*, string): The category of the entity. See https://developers.home-assistant.io/docs/core/entity/#generic-properties - for a list of available options. Requires Home Assistant 2021.11 or newer. + for a list of available options. Set to ``""`` to remove the default entity category. - **device_class** (*Optional*, string): The device class for the switch. See https://www.home-assistant.io/integrations/switch/#device-class - for a list of available options. Requires Home Assistant 2022.3 or newer. + for a list of available options. - If MQTT enabled, All other options from :ref:`MQTT Component `. .. _switch-toggle_action: diff --git a/components/text_sensor/index.rst b/components/text_sensor/index.rst index 9638ced99..ad909ecb2 100644 --- a/components/text_sensor/index.rst +++ b/components/text_sensor/index.rst @@ -41,10 +41,10 @@ Configuration variables: a ``name`` will implicitly set this to true. - **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend, (usually Home Assistant) without the user manually enabling it (via the Home Assistant UI). - Requires Home Assistant 2021.9 or newer. Defaults to ``false``. + Defaults to ``false``. - **entity_category** (*Optional*, string): The category of the entity. See https://developers.home-assistant.io/docs/core/entity/#generic-properties - for a list of available options. Requires Home Assistant 2021.11 or newer. + for a list of available options. Set to ``""`` to remove the default entity category. - If MQTT enabled, All other options from :ref:`MQTT Component `.