Document more building block entities (#29185)

add info that integration is a building block for other integrations
This commit is contained in:
c0ffeeca7 2023-10-05 13:41:00 +02:00 committed by GitHub
parent 0c42baf471
commit a149e897a3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 27 additions and 16 deletions

View File

@ -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

View File

@ -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,

View File

@ -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

View File

@ -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

View File

@ -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:

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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.
<div class='note'>
{% 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.
</div>
For a list of integrations offering update entities, on the integrations page, select the ["Update" category](/integrations/#update).
## The state of an update entity

View File

@ -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`.

View File

@ -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 %}

View File

@ -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.