From a149e897a35a244c5f4a51a17a8893c6ef38f7b3 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Thu, 5 Oct 2023 13:41:00 +0200 Subject: [PATCH] Document more building block entities (#29185) add info that integration is a building block for other integrations --- source/_integrations/scene.markdown | 2 ++ source/_integrations/select.markdown | 2 ++ source/_integrations/siren.markdown | 2 +- source/_integrations/stt.markdown | 2 +- source/_integrations/switch.markdown | 2 ++ source/_integrations/text.markdown | 4 +++- source/_integrations/time.markdown | 4 +++- source/_integrations/tts.markdown | 2 ++ source/_integrations/update.markdown | 11 ++--------- source/_integrations/vacuum.markdown | 2 ++ source/_integrations/wake_word.markdown | 2 -- source/_integrations/weather.markdown | 8 +++++++- 12 files changed, 27 insertions(+), 16 deletions(-) diff --git a/source/_integrations/scene.markdown b/source/_integrations/scene.markdown index 2d334127b13..a4f2b526d90 100644 --- a/source/_integrations/scene.markdown +++ b/source/_integrations/scene.markdown @@ -14,6 +14,8 @@ ha_integration_type: entity A scene entity is an entity that can restore the state of a group of entities. Scenes can be user-defined or can be provided through an integration. +{% include integrations/building_block_integration.md %} + ## The state of a scene The scene entity is stateless, as in, it cannot have a state like the `on` or diff --git a/source/_integrations/select.markdown b/source/_integrations/select.markdown index ab9e125b9a0..1c1f0651027 100644 --- a/source/_integrations/select.markdown +++ b/source/_integrations/select.markdown @@ -15,6 +15,8 @@ Keeps track on `select` entities in your environment, their state, and allows you to control them. This integration allows other integrations to offer a limited set of selectable options for the entity. +{% include integrations/building_block_integration.md %} + ## Services The select entity exposes additional services to control the entity in, for example, diff --git a/source/_integrations/siren.markdown b/source/_integrations/siren.markdown index 7c74ec7a537..617cf044e10 100644 --- a/source/_integrations/siren.markdown +++ b/source/_integrations/siren.markdown @@ -14,7 +14,7 @@ ha_integration_type: entity The Siren integration is built for the controlling and monitoring of siren/chime devices. -Siren entities are created automatically by integrations that support them. +{% include integrations/building_block_integration.md %} ## Services diff --git a/source/_integrations/stt.markdown b/source/_integrations/stt.markdown index 5fcd4d483f1..bb6c40df04d 100644 --- a/source/_integrations/stt.markdown +++ b/source/_integrations/stt.markdown @@ -13,7 +13,7 @@ ha_integration_type: entity A speech-to-text (STT) entity allows other integrations or applications to stream speech data to the STT API and get text back. -The speech-to-text entities cannot be implemented manually, but can be provided by integrations. +{% include integrations/building_block_integration.md %} ## The state of a speech-to-text entity diff --git a/source/_integrations/switch.markdown b/source/_integrations/switch.markdown index b5a847ddf31..ba6ceba41f2 100644 --- a/source/_integrations/switch.markdown +++ b/source/_integrations/switch.markdown @@ -18,6 +18,8 @@ Keeps track which switches are in your environment, their state and allows you t - Maintains a state per switch and a combined state `all_switches`. - Registers services `switch.turn_on`, `switch.turn_off`, and `switch.toggle` to control switches. +{% include integrations/building_block_integration.md %} + ## Device Class The way these switches are displayed in the frontend can be modified in the [customize section](/docs/configuration/customizing-devices/). The following device classes are supported for switches: diff --git a/source/_integrations/text.markdown b/source/_integrations/text.markdown index 79c2fe94a8c..f0f1d21390f 100644 --- a/source/_integrations/text.markdown +++ b/source/_integrations/text.markdown @@ -13,7 +13,9 @@ ha_integration_type: entity The Text integration is built for the controlling and monitoring of text values on devices. -Text entities cannot be implemented manually, but can be provided by other integrations. If you are looking for a way to create a text entity, please take a look at the [Text helper](/integrations/input_text). +{% include integrations/building_block_integration.md %} + +If you are looking for a way to create a text entity, please take a look at the [Text helper](/integrations/input_text). ## Services diff --git a/source/_integrations/time.markdown b/source/_integrations/time.markdown index 0447f3513ba..ae448329bfd 100644 --- a/source/_integrations/time.markdown +++ b/source/_integrations/time.markdown @@ -13,7 +13,9 @@ ha_integration_type: entity The Time integration is built for the controlling and monitoring of times on devices. -Time entities cannot be implemented manually, but can be provided by other integrations. If you are looking for a way to create a similar entity, please take a look at the [Date/Time helper](/integrations/input_datetime). +{% include integrations/building_block_integration.md %} + +If you are looking for a way to create a similar entity, please take a look at the [Date/Time helper](/integrations/input_datetime). ## Services diff --git a/source/_integrations/tts.markdown b/source/_integrations/tts.markdown index d6fc8fd75da..d8b6f33cea9 100644 --- a/source/_integrations/tts.markdown +++ b/source/_integrations/tts.markdown @@ -17,6 +17,8 @@ ha_integration_type: entity Text-to-speech (TTS) enables Home Assistant to speak to you. +{% include integrations/building_block_integration.md %} + ## Services ### Service speak diff --git a/source/_integrations/update.markdown b/source/_integrations/update.markdown index 8b29b2eed39..5d243ff470d 100644 --- a/source/_integrations/update.markdown +++ b/source/_integrations/update.markdown @@ -26,16 +26,9 @@ made available by the integration providing the update entity, triggering the actual update from Home Assistant. The other service exposed allows for skipping the offered update. -
+{% include integrations/building_block_integration.md %} -Update entities are here to be consumed and provided by other integrations and -are are not designed to be created manually directly. - -This page, therefore, does not provide instructions on how to create update -entities. Please see the ["Update" category](/integrations/#update) on the -integrations page to find integration offering update entities. - -
+For a list of integrations offering update entities, on the integrations page, select the ["Update" category](/integrations/#update). ## The state of an update entity diff --git a/source/_integrations/vacuum.markdown b/source/_integrations/vacuum.markdown index 7e65a41f08e..82ba32360fe 100644 --- a/source/_integrations/vacuum.markdown +++ b/source/_integrations/vacuum.markdown @@ -13,6 +13,8 @@ ha_integration_type: entity The `vacuum` integration enables the ability to control home cleaning robots within Home Assistant. +{% include integrations/building_block_integration.md %} + ## Services Available services: `start`, `pause`, `stop`, `return_to_base`, `locate`, `clean_spot`, `set_fan_speed` and `send_command`. diff --git a/source/_integrations/wake_word.markdown b/source/_integrations/wake_word.markdown index d10e861aa65..64c8fba04e5 100644 --- a/source/_integrations/wake_word.markdown +++ b/source/_integrations/wake_word.markdown @@ -15,6 +15,4 @@ A wake-word-detection entity allows other integrations or applications to detect The wake-word-detection entities cannot be implemented manually, but can be provided by integrations such as [Wyoming](/integrations/wyoming). The API in [Assist Pipelines](https://developers.home-assistant.io/docs/voice/pipelines/) enables wake-word-detection as part of [Assist](/voice_control/). - - {% include integrations/building_block_integration.md %} diff --git a/source/_integrations/weather.markdown b/source/_integrations/weather.markdown index 1612ea56e7a..38f14ef19de 100644 --- a/source/_integrations/weather.markdown +++ b/source/_integrations/weather.markdown @@ -11,7 +11,13 @@ ha_domain: weather ha_integration_type: entity --- -The `weather` platforms gather meteorological information from web services and display the conditions and other details about the weather at the given location. Read the integration documentation for your particular weather provider to learn how to set it up. +The `weather` platforms gather meteorological information from web services and display the conditions and other details about the weather at the given location. + +{% include integrations/building_block_integration.md %} + +For a list of weather integrations, on the integrations page, select the [weather category](/integrations/#weather). + +Read the integration documentation for your particular weather provider to learn how to set it up. Home Assistant currently supports free web services some of which require registration.