jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

c-integrations: add glossary reference to config file (#32752)

Browse Source
This commit is contained in:
c0ffeeca7 2024-05-14 13:57:41 +02:00 committed by GitHub
parent aceb0e40a8
commit b28c0abbdf
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
14 changed files with 52 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
source/_integrations/camera.ffmpeg.markdown
View File

@ -12,7 +12,7 @@ The `ffmpeg` platform allows you to use any video feed as a camera in Home Assis
## Configuration ## Configuration
To enable your FFmpeg feed in your installation you must first configure the [FFmpeg integration](/integrations/ffmpeg/), then add the following to your `configuration.yaml` file: To enable your FFmpeg feed in your installation you must first configure the [FFmpeg integration](/integrations/ffmpeg/), then add the following to your {% term "`configuration.yaml`" %} file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

4
source/_integrations/camera.markdown
View File

@ -85,7 +85,7 @@ Both `duration` and `lookback` options are suggestions, but should be consistent
| `duration` | yes | Target recording length (in seconds). Default: 30 | | `duration` | yes | Target recording length (in seconds). Default: 30 |
| `lookback` | yes | Target lookback period (in seconds) to include in addition to duration. Only available if there is currently an active HLS stream. Default: 0 | | `lookback` | yes | Target lookback period (in seconds) to include in addition to duration. Only available if there is currently an active HLS stream. Default: 0 |
The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/integrations/homeassistant/#allowlist_external_dirs) section of your `configuration.yaml` file. The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/integrations/homeassistant/#allowlist_external_dirs) section of your {% term "`configuration.yaml`" %} file.
For example, the following action in an automation would take a recording from "yourcamera" and save it to /tmp with a timestamped filename. For example, the following action in an automation would take a recording from "yourcamera" and save it to /tmp with a timestamped filename.
@ -111,7 +111,7 @@ Take a snapshot from a camera.
| `entity_id` | no | Name(s) of entities to create a snapshot from, e.g., `camera.living_room_camera`. | | `entity_id` | no | Name(s) of entities to create a snapshot from, e.g., `camera.living_room_camera`. |
| `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id.name }}`{% endraw %}. | | `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id.name }}`{% endraw %}. |
The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/integrations/homeassistant/) section of your `configuration.yaml` file. The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/integrations/homeassistant/) section of your {% term "`configuration.yaml`" %} file.
For example, the following action in an automation would take a snapshot from "yourcamera" and save it to /tmp with a timestamped filename. For example, the following action in an automation would take a snapshot from "yourcamera" and save it to /tmp with a timestamped filename.

2
source/_integrations/camera.mqtt.markdown
View File

@ -14,7 +14,7 @@ This can be used with an application or a service capable of sending images thro
## Configuration ## Configuration
To enable this camera in your installation, add the following to your `configuration.yaml` file: To enable this camera in your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

2
source/_integrations/clicksend_tts.markdown
View File

@ -15,7 +15,7 @@ The `clicksend_tts` platform uses [ClickSend](https://clicksend.com) to deliver
After creating your account, you should now be able to obtain your `username` and `api_key` [here](https://dashboard.clicksend.com/account/subaccounts). After creating your account, you should now be able to obtain your `username` and `api_key` [here](https://dashboard.clicksend.com/account/subaccounts).
To add ClickSend to your installation, add the following to your Home Assistant `configuration.yaml` file: To add ClickSend to your installation, add the following to your Home Assistant {% term "`configuration.yaml`" %} file:
```yaml ```yaml
notify: notify:

3
source/_integrations/climate.mqtt.markdown
View File

@ -12,7 +12,8 @@ The `mqtt` climate platform lets you control your MQTT enabled HVAC devices.
## Configuration ## Configuration
To enable this climate platform in your installation, first add the following to your `configuration.yaml` file: To enable this climate platform in your installation, first add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

2
source/_integrations/cloud.markdown
View File

@ -29,7 +29,7 @@ cloud:
Documentation of further configuration possibilities are located at [NabuCasa](https://www.nabucasa.com/config/) Documentation of further configuration possibilities are located at [NabuCasa](https://www.nabucasa.com/config/)
Once activated, go to the configuration panel in Home Assistant and create an account and log in. If you are not seeing the **Settings** panel, make sure you have the following option enabled in your `configuration.yaml` file. Once activated, go to the configuration panel in Home Assistant and create an account and log in. If you are not seeing the **Settings** panel, make sure you have the following option enabled in your {% term "`configuration.yaml`" %} file.
```yaml ```yaml
config: config:

5
source/_integrations/comfoconnect.markdown
View File

@ -24,7 +24,8 @@ the unofficial [pycomfoconnect](https://github.com/michaelarnauts/comfoconnect)
The integration has a fan platform to view and control the ventilation speed, and a sensors platform to read out the outdoor temperature and humidity, the indoor temperature and humidity, and the extract and supply air flow (in m³ per hour). The integration has a fan platform to view and control the ventilation speed, and a sensors platform to read out the outdoor temperature and humidity, the indoor temperature and humidity, and the extract and supply air flow (in m³ per hour).
To set it up, add the following information to your `configuration.yaml` file: To set it up, add the following information to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml ```yaml
comfoconnect: comfoconnect:
@ -58,7 +59,7 @@ pin:
type: integer type: integer
{% endconfiguration %} {% endconfiguration %}
To register the sensors, add the following to your `configuration.yaml` file: To register the sensors, add the following to your {% term "`configuration.yaml`" %} file:
```yaml ```yaml
sensor: sensor:

18
source/_integrations/command_line.markdown
View File

@ -286,7 +286,7 @@ command_line:
## Binary sensor ## Binary sensor
To use your Command binary sensor in your installation, add the following to your `configuration.yaml` file: To use your Command binary sensor in your installation, add the following to your {% term "`configuration.yaml`" %} file:
{% raw %} {% raw %}
```yaml ```yaml
@ -303,7 +303,7 @@ command_line:
A `command_line`cover platform that issues specific commands when it is moved up, down and stopped. It allows anyone to integrate any type of cover into Home Assistant that can be controlled from the command line. A `command_line`cover platform that issues specific commands when it is moved up, down and stopped. It allows anyone to integrate any type of cover into Home Assistant that can be controlled from the command line.
To enable a command line cover in your installation, add the following to your `configuration.yaml` file: To enable a command line cover in your installation, add the following to your {% term "`configuration.yaml`" %} file:
{% raw %} {% raw %}
```yaml ```yaml
@ -321,7 +321,7 @@ command_line:
The `command_line` platform allows you to use external tools for notifications from Home Assistant. The message will be passed in as STDIN. The `command_line` platform allows you to use external tools for notifications from Home Assistant. The message will be passed in as STDIN.
To enable those notifications in your installation, add the following to your `configuration.yaml` file: To enable those notifications in your installation, add the following to your {% term "`configuration.yaml`" %} file:
{% raw %} {% raw %}
```yaml ```yaml
@ -336,7 +336,7 @@ To use notifications, please see the [getting started with automation page](/get
## Sensor ## Sensor
To enable it, add the following lines to your `configuration.yaml`: To enable it, add the following lines to your {% term "`configuration.yaml`" %}:
{% raw %} {% raw %}
```yaml ```yaml
@ -356,7 +356,7 @@ and off. This might very well become our most powerful platform as it allows
anyone to integrate any type of switch into Home Assistant that can be anyone to integrate any type of switch into Home Assistant that can be
controlled from the command line, including calling other scripts! controlled from the command line, including calling other scripts!
To enable it, add the following lines to your `configuration.yaml`: To enable it, add the following lines to your {% term "`configuration.yaml`" %}:
{% raw %} {% raw %}
```yaml ```yaml
@ -497,7 +497,7 @@ In this section you find some real-life examples of how to use this sensor.
### CPU temperature ### CPU temperature
Thanks to the [`proc`](https://en.wikipedia.org/wiki/Procfs) file system, various details about a system can be retrieved. Here the CPU temperature is of interest. Add something similar to your `configuration.yaml` file: Thanks to the [`proc`](https://en.wikipedia.org/wiki/Procfs) file system, various details about a system can be retrieved. Here the CPU temperature is of interest. Add something similar to your {% term "`configuration.yaml`" %} file:
{% raw %} {% raw %}
```yaml ```yaml
@ -514,7 +514,7 @@ command_line:
### Monitoring failed login attempts on Home Assistant ### Monitoring failed login attempts on Home Assistant
If you'd like to know how many failed login attempts are made to Home Assistant, add the following to your `configuration.yaml` file: If you'd like to know how many failed login attempts are made to Home Assistant, add the following to your {% term "`configuration.yaml`" %} file:
{% raw %} {% raw %}
```yaml ```yaml
@ -568,7 +568,7 @@ command_line:
The example is doing the same as the [aREST sensor](/integrations/arest#sensor) but with an external Python script. It should give you an idea about interfacing with devices which are exposing a RESTful API. The example is doing the same as the [aREST sensor](/integrations/arest#sensor) but with an external Python script. It should give you an idea about interfacing with devices which are exposing a RESTful API.
The one-line script to retrieve a value is shown below. Of course it would be possible to use this directly in the `configuration.yaml` file but need extra care about the quotation marks. The one-line script to retrieve a value is shown below. Of course it would be possible to use this directly in the {% term "`configuration.yaml`" %} file but need extra care about the quotation marks.
{% raw %} {% raw %}
```bash ```bash
@ -588,7 +588,7 @@ print(response.json()["return_value"])
``` ```
{% endraw%} {% endraw%}
To use the script you need to add something like the following to your `configuration.yaml` file. To use the script you need to add something like the following to your {% term "`configuration.yaml`" %} file.
{% raw %} {% raw %}
```yaml ```yaml

2
source/_integrations/concord232.markdown
View File

@ -57,7 +57,7 @@ mode:
## Binary sensor ## Binary sensor
To enable the binary sensor platform, add the following lines to your `configuration.yaml`: To enable the binary sensor platform, add the following lines to your {% term "`configuration.yaml`" %}:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

4
source/_integrations/conversation.markdown
View File

@ -52,7 +52,7 @@ intents:
{% endraw %} {% endraw %}
To teach Home Assistant how to handle the custom `CustomOutsideHumidity` {% term intent %}, create an `intent_script` entry in your `configuration.yaml` file: To teach Home Assistant how to handle the custom `CustomOutsideHumidity` {% term intent %}, create an `intent_script` entry in your {% term "`configuration.yaml`" %} file:
{% raw %} {% raw %}
@ -173,6 +173,6 @@ This service is able to return [response data](/docs/scripts/service-calls/#use-
## Service `conversation.reload` ## Service `conversation.reload`
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
|------------------------|----------|--------------------------------------------------------------------------| | ---------------------- | -------- | ------------------------------------------------------------------------ |
| `language` | yes | Language to clear intent cache for. No value clears all languages | | `language` | yes | Language to clear intent cache for. No value clears all languages |
| `agent_id` | yes | ID of conversation agent. Defaults to the built-in Home Assistant agent. | | `agent_id` | yes | ID of conversation agent. Defaults to the built-in Home Assistant agent. |

16
source/_integrations/counter.markdown
View File

@ -21,12 +21,12 @@ The preferred way to configure counter helpers is via the user interface. To add
next choose the **{% my config_flow_start domain=page.ha_domain title=page.title %}** option. next choose the **{% my config_flow_start domain=page.ha_domain title=page.title %}** option.
To be able to add **Helpers** via the user interface you should have To be able to add **Helpers** via the user interface you should have
`default_config:` in your `configuration.yaml`, it should already be there by `default_config:` in your {% term "`configuration.yaml`" %}, it should already be there by
default unless you removed it. If you removed `default_config:` from your default unless you removed it. If you removed `default_config:` from your
configuration, you must add `counter:` to your `configuration.yaml` first, configuration, you must add `counter:` to your {% term "`configuration.yaml`" %} first,
then you can use the UI. then you can use the UI.
Counters can also be configured via `configuration.yaml`: Counters can also be configured via {% term "`configuration.yaml`" %}:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -92,7 +92,7 @@ Available services: `increment`, `decrement`, `reset`, and `set_value`.
Increments the counter with 1 or the given value for the steps. Increments the counter with 1 or the given value for the steps.
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | --------------------------------------------------------------------- |
| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. | | `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. |
### Service `counter.decrement` ### Service `counter.decrement`
@ -100,7 +100,7 @@ Increments the counter with 1 or the given value for the steps.
Decrements the counter with 1 or the given value for the steps. Decrements the counter with 1 or the given value for the steps.
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | --------------------------------------------------------------------- |
| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. | | `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. |
### Service `counter.reset` ### Service `counter.reset`
@ -108,7 +108,7 @@ Decrements the counter with 1 or the given value for the steps.
With this service the counter is reset to its initial value. With this service the counter is reset to its initial value.
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | --------------------------------------------------------------------- |
| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. | | `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. |
### Service `counter.set_value` ### Service `counter.set_value`
@ -116,7 +116,7 @@ With this service the counter is reset to its initial value.
This service allows setting the counter to a specific value. This service allows setting the counter to a specific value.
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | --------------------------------------------------------------------- |
| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. | | `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. |
| `value` | yes | Set the counter to the given value. | | `value` | yes | Set the counter to the given value. |
@ -134,7 +134,7 @@ Select the **Services** tab from within **Developer Tools**. Choose **counter**
### Counting Home Assistant errors ### Counting Home Assistant errors
To use a counter to count errors as caught by Home Assistant, you need to add `fire_event: true` to your `configuration.yaml`, like so: To use a counter to count errors as caught by Home Assistant, you need to add `fire_event: true` to your {% term "`configuration.yaml`" %}, like so:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

2
source/_integrations/cover.mqtt.markdown
View File

@ -27,7 +27,7 @@ Optimistic mode can be forced, even if a `state_topic` / `position_topic` is def
The `mqtt` cover platform optionally supports a list of `availability` topics to receive online and offline messages (birth and LWT messages) from the MQTT cover device. During normal operation, if the MQTT cover device goes offline (i.e., publishes a matching `payload_not_available` to any `availability` topic), Home Assistant will display the cover as "unavailable". If these messages are published with the `retain` flag set, the cover will receive an instant update after subscription and Home Assistant will display correct availability state of the cover when Home Assistant starts up. If the `retain` flag is not set, Home Assistant will display the cover as "unavailable" when Home Assistant starts up. The `mqtt` cover platform optionally supports a list of `availability` topics to receive online and offline messages (birth and LWT messages) from the MQTT cover device. During normal operation, if the MQTT cover device goes offline (i.e., publishes a matching `payload_not_available` to any `availability` topic), Home Assistant will display the cover as "unavailable". If these messages are published with the `retain` flag set, the cover will receive an instant update after subscription and Home Assistant will display correct availability state of the cover when Home Assistant starts up. If the `retain` flag is not set, Home Assistant will display the cover as "unavailable" when Home Assistant starts up.
To use your MQTT cover in your installation, add the following to your `configuration.yaml` file: To use your MQTT cover in your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

2
source/_integrations/cover.rflink.markdown
View File

@ -50,7 +50,7 @@ RTS Record: 14 Address: FFFFFF RC: FFFF
RTS Record: 15 Address: FFFFFF RC: FFFF RTS Record: 15 Address: FFFFFF RC: FFFF
``` ```
After configuring the RFLink Somfy RTS you have to add the cover to the `configuration.yaml` file like any other RFlink device. After configuring the RFLink Somfy RTS you have to add the cover to the {% term "`configuration.yaml`" %} file like any other RFlink device.
RFLink cover ID's are composed of: protocol, id, and gateway. For example: `RTS_0100F2_0`. RFLink cover ID's are composed of: protocol, id, and gateway. For example: `RTS_0100F2_0`.

4
source/_integrations/cover.template.markdown
View File

@ -16,7 +16,7 @@ close, stop, position and tilt commands of a cover.
## Configuration ## Configuration
To enable Template Covers in your installation, To enable Template Covers in your installation,
add the following to your `configuration.yaml` file: add the following to your {% term "`configuration.yaml`" %} file:
{% raw %} {% raw %}
@ -147,7 +147,7 @@ There is an equivalent mode for `tilt_position` that is enabled when
If both a [`value_template`](#value_template) and a [`position_template`](#position_template) are specified only `opening` and `closing` states are set directly from the `value_template`, the `open` and `closed` states will instead be derived from the cover position. If both a [`value_template`](#value_template) and a [`position_template`](#position_template) are specified only `opening` and `closing` states are set directly from the `value_template`, the `open` and `closed` states will instead be derived from the cover position.
| value_template output | result | | value_template output | result |
| ------------- |-------------| | --------------------- | ------------------------------------ |
| open | state defined by `position_template` | | open | state defined by `position_template` |
| closed | state defined by `position_template` | | closed | state defined by `position_template` |
| true | state defined by `position_template` | | true | state defined by `position_template` |