From b28c0abbdf40ea64b8829438e7902896ac410e52 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Tue, 14 May 2024 13:57:41 +0200 Subject: [PATCH 001/103] c-integrations: add glossary reference to config file (#32752) --- source/_integrations/camera.ffmpeg.markdown | 2 +- source/_integrations/camera.markdown | 4 +-- source/_integrations/camera.mqtt.markdown | 2 +- source/_integrations/clicksend_tts.markdown | 2 +- source/_integrations/climate.mqtt.markdown | 3 +- source/_integrations/cloud.markdown | 2 +- source/_integrations/comfoconnect.markdown | 5 +-- source/_integrations/command_line.markdown | 18 +++++------ source/_integrations/concord232.markdown | 2 +- source/_integrations/conversation.markdown | 4 +-- source/_integrations/counter.markdown | 34 ++++++++++---------- source/_integrations/cover.mqtt.markdown | 2 +- source/_integrations/cover.rflink.markdown | 2 +- source/_integrations/cover.template.markdown | 20 ++++++------ 14 files changed, 52 insertions(+), 50 deletions(-) diff --git a/source/_integrations/camera.ffmpeg.markdown b/source/_integrations/camera.ffmpeg.markdown index 603ee64b893..b4d74bb1a1d 100644 --- a/source/_integrations/camera.ffmpeg.markdown +++ b/source/_integrations/camera.ffmpeg.markdown @@ -12,7 +12,7 @@ The `ffmpeg` platform allows you to use any video feed as a camera in Home Assis ## 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 # Example configuration.yaml entry diff --git a/source/_integrations/camera.markdown b/source/_integrations/camera.markdown index d7e0c7bb9a0..4704d1e46d3 100644 --- a/source/_integrations/camera.markdown +++ b/source/_integrations/camera.markdown @@ -85,7 +85,7 @@ Both `duration` and `lookback` options are suggestions, but should be consistent | `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 | -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. @@ -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`. | | `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. diff --git a/source/_integrations/camera.mqtt.markdown b/source/_integrations/camera.mqtt.markdown index d7a1ba78202..cf9b228e6c0 100644 --- a/source/_integrations/camera.mqtt.markdown +++ b/source/_integrations/camera.mqtt.markdown @@ -14,7 +14,7 @@ This can be used with an application or a service capable of sending images thro ## 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 # Example configuration.yaml entry diff --git a/source/_integrations/clicksend_tts.markdown b/source/_integrations/clicksend_tts.markdown index 1a368bc74a6..893c232d02a 100644 --- a/source/_integrations/clicksend_tts.markdown +++ b/source/_integrations/clicksend_tts.markdown @@ -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). -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 notify: diff --git a/source/_integrations/climate.mqtt.markdown b/source/_integrations/climate.mqtt.markdown index 89151e88934..9f9dad0f893 100644 --- a/source/_integrations/climate.mqtt.markdown +++ b/source/_integrations/climate.mqtt.markdown @@ -12,7 +12,8 @@ The `mqtt` climate platform lets you control your MQTT enabled HVAC devices. ## 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 # Example configuration.yaml entry diff --git a/source/_integrations/cloud.markdown b/source/_integrations/cloud.markdown index de106cb42ec..a3dc3111ea5 100644 --- a/source/_integrations/cloud.markdown +++ b/source/_integrations/cloud.markdown @@ -29,7 +29,7 @@ cloud: 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 config: diff --git a/source/_integrations/comfoconnect.markdown b/source/_integrations/comfoconnect.markdown index aaec51cd3f6..9d08628d0e3 100644 --- a/source/_integrations/comfoconnect.markdown +++ b/source/_integrations/comfoconnect.markdown @@ -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). -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 comfoconnect: @@ -58,7 +59,7 @@ pin: type: integer {% 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 sensor: diff --git a/source/_integrations/command_line.markdown b/source/_integrations/command_line.markdown index 5ded7287b20..152a5913da1 100644 --- a/source/_integrations/command_line.markdown +++ b/source/_integrations/command_line.markdown @@ -286,7 +286,7 @@ command_line: ## 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 %} ```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. -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 %} ```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. -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 %} ```yaml @@ -336,7 +336,7 @@ To use notifications, please see the [getting started with automation page](/get ## 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 %} ```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 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 %} ```yaml @@ -497,7 +497,7 @@ In this section you find some real-life examples of how to use this sensor. ### 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 %} ```yaml @@ -514,7 +514,7 @@ command_line: ### 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 %} ```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 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 %} ```bash @@ -588,7 +588,7 @@ print(response.json()["return_value"]) ``` {% 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 %} ```yaml diff --git a/source/_integrations/concord232.markdown b/source/_integrations/concord232.markdown index 6d19f47f983..89d8b926d47 100644 --- a/source/_integrations/concord232.markdown +++ b/source/_integrations/concord232.markdown @@ -57,7 +57,7 @@ mode: ## 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 # Example configuration.yaml entry diff --git a/source/_integrations/conversation.markdown b/source/_integrations/conversation.markdown index 9c7e353bd94..4531739927c 100644 --- a/source/_integrations/conversation.markdown +++ b/source/_integrations/conversation.markdown @@ -52,7 +52,7 @@ intents: {% 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 %} @@ -173,6 +173,6 @@ This service is able to return [response data](/docs/scripts/service-calls/#use- ## Service `conversation.reload` | Service data attribute | Optional | Description | -|------------------------|----------|--------------------------------------------------------------------------| +| ---------------------- | -------- | ------------------------------------------------------------------------ | | `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. | diff --git a/source/_integrations/counter.markdown b/source/_integrations/counter.markdown index 485d936fa53..7afbad9f131 100644 --- a/source/_integrations/counter.markdown +++ b/source/_integrations/counter.markdown @@ -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. 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 -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. -Counters can also be configured via `configuration.yaml`: +Counters can also be configured via {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry @@ -91,34 +91,34 @@ Available services: `increment`, `decrement`, `reset`, and `set_value`. Increments the counter with 1 or the given value for the steps. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | --------------------------------------------------------------------- | +| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. | ### Service `counter.decrement` Decrements the counter with 1 or the given value for the steps. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | --------------------------------------------------------------------- | +| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. | ### Service `counter.reset` With this service the counter is reset to its initial value. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | --------------------------------------------------------------------- | +| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. | ### Service `counter.set_value` This service allows setting the counter to a specific value. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `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. | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | --------------------------------------------------------------------- | +| `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. | ### Use the service @@ -134,7 +134,7 @@ Select the **Services** tab from within **Developer Tools**. Choose **counter** ### 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 # Example configuration.yaml entry diff --git a/source/_integrations/cover.mqtt.markdown b/source/_integrations/cover.mqtt.markdown index 5f06b361b76..b11c5ec6458 100644 --- a/source/_integrations/cover.mqtt.markdown +++ b/source/_integrations/cover.mqtt.markdown @@ -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. -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 # Example configuration.yaml entry diff --git a/source/_integrations/cover.rflink.markdown b/source/_integrations/cover.rflink.markdown index 0e9fbe14803..9655c399107 100644 --- a/source/_integrations/cover.rflink.markdown +++ b/source/_integrations/cover.rflink.markdown @@ -50,7 +50,7 @@ RTS Record: 14 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`. diff --git a/source/_integrations/cover.template.markdown b/source/_integrations/cover.template.markdown index 58859db86ea..5349c3cbb08 100644 --- a/source/_integrations/cover.template.markdown +++ b/source/_integrations/cover.template.markdown @@ -16,7 +16,7 @@ close, stop, position and tilt commands of a cover. ## Configuration 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 %} @@ -146,15 +146,15 @@ 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. -| value_template output | result | -| ------------- |-------------| -| open | state defined by `position_template` | -| closed | state defined by `position_template` | -| true | state defined by `position_template` | -| false | state defined by `position_template` | -| opening | state set to `opening` | -| closing | state set to `closing` | -| | No change of state or position | +| value_template output | result | +| --------------------- | ------------------------------------ | +| open | state defined by `position_template` | +| closed | state defined by `position_template` | +| true | state defined by `position_template` | +| false | state defined by `position_template` | +| opening | state set to `opening` | +| closing | state set to `closing` | +| | No change of state or position | ## Examples From 88b471a62b0929be399cc8d096b1c07716b1f22c Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Tue, 14 May 2024 15:08:10 +0200 Subject: [PATCH 002/103] g-h-integrations: add glossary reference to config file (#32756) --- source/_integrations/garadget.markdown | 2 +- source/_integrations/gc100.markdown | 2 +- source/_integrations/geniushub.markdown | 2 +- .../_integrations/google_assistant.markdown | 6 +- source/_integrations/google_cloud.markdown | 16 ++--- source/_integrations/greenwave.markdown | 2 +- source/_integrations/group.markdown | 2 +- source/_integrations/harmony.markdown | 44 ++++++------ source/_integrations/heatmiser.markdown | 2 +- source/_integrations/heos.markdown | 64 ++++++++--------- source/_integrations/hikvision.markdown | 6 +- source/_integrations/history_stats.markdown | 2 +- source/_integrations/homekit.markdown | 68 +++++++++---------- .../_integrations/homekit_controller.markdown | 2 +- source/_integrations/homematic.markdown | 2 +- .../_integrations/homematicip_cloud.markdown | 2 +- source/_integrations/hp_ilo.markdown | 2 +- source/_integrations/humidifier.mqtt.markdown | 2 +- 18 files changed, 114 insertions(+), 114 deletions(-) diff --git a/source/_integrations/garadget.markdown b/source/_integrations/garadget.markdown index b1c5d1115b6..a8b8c86e954 100644 --- a/source/_integrations/garadget.markdown +++ b/source/_integrations/garadget.markdown @@ -114,7 +114,7 @@ customize: {% endraw %} -Some of the Garadget sensors can create a lot of clutter in the logbook. Use this section of code in your `configuration.yaml` to exclude those entries. +Some of the Garadget sensors can create a lot of clutter in the logbook. Use this section of code in your{% term "`configuration.yaml`" %} to exclude those entries. ```yaml logbook: diff --git a/source/_integrations/gc100.markdown b/source/_integrations/gc100.markdown index 147631cb25c..cb7107f8fd3 100644 --- a/source/_integrations/gc100.markdown +++ b/source/_integrations/gc100.markdown @@ -53,7 +53,7 @@ port: ## Binary sensor -To enable this sensor, you first have to set up [gc100](#configuration), and add the following lines to your `configuration.yaml` file: +To enable this sensor, you first have to set up [gc100](#configuration), and add the following lines to your{% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/geniushub.markdown b/source/_integrations/geniushub.markdown index b6ad825d9c5..a175c48be9c 100644 --- a/source/_integrations/geniushub.markdown +++ b/source/_integrations/geniushub.markdown @@ -179,7 +179,7 @@ value_template: "{{ state_attr('climate.genius_zone_12', 'status').occupied }}" ## Configuration -To set up this integration, add one of the following to your `configuration.yaml` file. +To set up this integration, add one of the following to your{% term "`configuration.yaml`" %}on.yaml`" %} file. If required, you can switch between one Option and the other and, as the `unique_id` remains consistent, state history will be preserved. This assumes that the correct MAC address is provided for Option 2, below. If a wrong MAC address was provided for Option 1, then the MAC address can be overridden for Option 1 to maintain these links within the entity registry. diff --git a/source/_integrations/google_assistant.markdown b/source/_integrations/google_assistant.markdown index 51eb1fee5f5..df95fa3648b 100644 --- a/source/_integrations/google_assistant.markdown +++ b/source/_integrations/google_assistant.markdown @@ -82,13 +82,13 @@ To use Google Assistant, your Home Assistant configuration has to be [externally 9. Create a private key in JSON format. 10. This will start a download of a JSON file. 1. Rename the file to `SERVICE_ACCOUNT.JSON`. - 2. Add this file to your config-folder. This will be the same folder as your `configuration.yaml`. + 2. Add this file to your config-folder. This will be the same folder as your{% term "`configuration.yaml`" %}. 11. Go back to [Google Cloud Platform](https://console.cloud.google.com/) and select **Close**. 12. Then select **Save**. 13. Go to the **Search products and resources** and search for **Homegraph API** and select it. 14. Enable the HomeGraph API. -5. Add the `google_assistant` integration configuration to your `configuration.yaml` file and restart Home Assistant following the [configuration guide](#yaml-configuration) below. +5. Add the `google_assistant` integration configuration to your{% term "`configuration.yaml`" %} file and restart Home Assistant following the [configuration guide](#yaml-configuration) below. 6. Add services in the Google Home App (note that app versions may be slightly different). 1. Open the Google Home app. 2. Select the `+` button on the top left corner, select **Set up device**. In the **Set up a device** screen, select **Works with Google**. You should have `[test] ` listed under **Add new**. Selecting that should lead you to a browser to login your Home Assistant instance, then redirect back to a screen where you can set rooms and nicknames for your devices if you wish. @@ -167,7 +167,7 @@ You can debug the setup by following [these instructions](https://developers.hom ### YAML configuration -Now add your setup to your `configuration.yaml` file, such as: +Now add your setup to your {% term "`configuration.yaml`" %} file, such as: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/google_cloud.markdown b/source/_integrations/google_cloud.markdown index 0a08a611fc8..d0428de15c0 100644 --- a/source/_integrations/google_cloud.markdown +++ b/source/_integrations/google_cloud.markdown @@ -17,7 +17,7 @@ The `google_cloud` platform allows you to use [Google Cloud Platform](https://cl ## Configuration -To use Google Cloud Platform, you need to provide `config` directory relative path of [`API key`](#obtaining-an-api-key) file you are going to use. Place it under `config` folder and set `key_file` parameter in `configuration.yaml`: +To use Google Cloud Platform, you need to provide `config` directory relative path of [`API key`](#obtaining-an-api-key) file you are going to use. Place it under `config` folder and set `key_file` parameter in {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry @@ -71,13 +71,13 @@ Basic instruction for all APIs: The Cloud text-to-speech API is priced monthly based on the amount of characters to synthesize into audio sent to the service. -| Voice | Monthly free tier | Paid usage | -| ----------------------------- | ------------------------- | --------------------------------- | -| Neural2 | 0 to 1 million bytes | $16.00 USD / 1 million bytes | -| Polyglot (Preview) | 0 to 1 million bytes | $16.00 USD / 1 million bytes | -| Studio (Preview) | 0 to 100 thousand bytes | $160.00 USD / 1 million bytes | -| Standard | 0 to 4 million characters | $4.00 USD / 1 million characters | -| WaveNet | 0 to 1 million characters | $16.00 USD / 1 million characters | +| Voice | Monthly free tier | Paid usage | +| ------------------ | ------------------------- | --------------------------------- | +| Neural2 | 0 to 1 million bytes | $16.00 USD / 1 million bytes | +| Polyglot (Preview) | 0 to 1 million bytes | $16.00 USD / 1 million bytes | +| Studio (Preview) | 0 to 100 thousand bytes | $160.00 USD / 1 million bytes | +| Standard | 0 to 4 million characters | $4.00 USD / 1 million characters | +| WaveNet | 0 to 1 million characters | $16.00 USD / 1 million characters | ### Text-to-speech configuration diff --git a/source/_integrations/greenwave.markdown b/source/_integrations/greenwave.markdown index 2191bf2891c..8cc60322e96 100644 --- a/source/_integrations/greenwave.markdown +++ b/source/_integrations/greenwave.markdown @@ -17,7 +17,7 @@ This integration has been tested on firmware revisions: - 2.0.105 -To configure the connection to the gateway, add the following to your `configuration.yaml` file: +To configure the connection to the gateway, add the following to your {% term "`configuration.yaml`" %} file: ```yaml light: diff --git a/source/_integrations/group.markdown b/source/_integrations/group.markdown index 2ae28d74fd7..11c8292311b 100644 --- a/source/_integrations/group.markdown +++ b/source/_integrations/group.markdown @@ -129,7 +129,7 @@ To add or remove entities from an existing group, click on `Group options`, all ## YAML configuration Alternatively, this integration can be configured and set up manually via YAML -instead. Here are example of how to configure groups when using the `configuration.yaml` file. +instead. Here are example of how to configure groups when using the {% term "`configuration.yaml`" %} file. Example YAML configuration of a binary sensor group: diff --git a/source/_integrations/harmony.markdown b/source/_integrations/harmony.markdown index 8471327d2b9..e89ddfb5a74 100644 --- a/source/_integrations/harmony.markdown +++ b/source/_integrations/harmony.markdown @@ -51,18 +51,18 @@ This file will be overwritten whenever the Harmony HUB has a new configuration, Turn off all devices that were switched on from the start of the current activity. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | no | Entity ID to target. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | -------------------- | +| `entity_id` | no | Entity ID to target. | ### Service `remote.turn_on` -Start an activity. Will start the default `activity` from `configuration.yaml` if no activity is specified. The specified activity can either be the activity name or the activity ID from the configuration file written to your [Home Assistant configuration directory](/docs/configuration/). +Start an activity. Will start the default `activity` from {% term "`configuration.yaml`" %} if no activity is specified. The specified activity can either be the activity name or the activity ID from the configuration file written to your [Home Assistant configuration directory](/docs/configuration/). -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | no | Entity ID to target. -| `activity` | yes | Activity ID or Activity Name to start. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | -------------------------------------- | +| `entity_id` | no | Entity ID to target. | +| `activity` | yes | Activity ID or Activity Name to start. | #### Example @@ -94,13 +94,13 @@ action: Send a single command or a set of commands to one device, device ID and available commands are written to the configuration file at startup. You can optionally specify the number of times you wish to repeat the command(s) and delay you want between repeated command(s). -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | no | Entity ID to target. -| `device` | no | Device ID or Device Name to send the command to. -| `command` | no | A single command or a list of commands to send. -| `num_repeats` | yes | The number of times to repeat the command(s). -| `delay_secs` | yes | The number of seconds between sending each command. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | --------------------------------------------------- | +| `entity_id` | no | Entity ID to target. | +| `device` | no | Device ID or Device Name to send the command to. | +| `command` | no | A single command or a list of commands to send. | +| `num_repeats` | yes | The number of times to repeat the command(s). | +| `delay_secs` | yes | The number of seconds between sending each command. | In the file 'harmony_REMOTENAME.conf' you can find the available devices and commands, for example: @@ -158,10 +158,10 @@ data: Sends the change channel command to the Harmony HUB -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | no | Entity ID to target. -| `channel` | no | Channel number to change to +| Service data attribute | Optional | Description | +| ---------------------- | -------- | --------------------------- | +| `entity_id` | no | Entity ID to target. | +| `channel` | no | Channel number to change to | A typical service call for changing the channel would be:: @@ -177,9 +177,9 @@ data: Force synchronization between the Harmony device and the Harmony cloud. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | no | Entity ID to target. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | -------------------- | +| `entity_id` | no | Entity ID to target. | ### Examples diff --git a/source/_integrations/heatmiser.markdown b/source/_integrations/heatmiser.markdown index 3052e54f036..d4ca1763ac7 100644 --- a/source/_integrations/heatmiser.markdown +++ b/source/_integrations/heatmiser.markdown @@ -17,7 +17,7 @@ The `heatmiser` climate platform lets you control [Heatmiser DT/DT-E/PRT/PRT-E]( Further work would be required to get this setup to connect over Wi-Fi, but the HeatmiserV3 Python module being used is a full implementation of the V3 protocol. -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: ```yaml climate: diff --git a/source/_integrations/heos.markdown b/source/_integrations/heos.markdown index 8fba4803b74..84abe6d82c1 100644 --- a/source/_integrations/heos.markdown +++ b/source/_integrations/heos.markdown @@ -41,10 +41,10 @@ username: "example@example.com" password: "password" ``` -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `username` | no | The username or email of the HEOS account. -| `password` | no | The password of the HEOS account. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ------------------------------------------ | +| `username` | no | The username or email of the HEOS account. | +| `password` | no | The password of the HEOS account. | ### Service `heos.sign_out` @@ -62,11 +62,11 @@ media_content_type: "favorite" media_content_id: "1" ``` -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | yes | `entity_id` of the player(s) -| `media_content_type` | no | Set to the value `favorite` -| `media_content_id` | no | (i.e., `1`) or name (i.e., `Thumbprint Radio`) of the HEOS favorite +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ------------------------------------------------------------------- | +| `entity_id` | yes | `entity_id` of the player(s) | +| `media_content_type` | no | Set to the value `favorite` | +| `media_content_id` | no | (i.e., `1`) or name (i.e., `Thumbprint Radio`) of the HEOS favorite | #### Play playlist @@ -78,11 +78,11 @@ media_content_type: "playlist" media_content_id: "Awesome Music" ``` -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | yes | `entity_id` of the player(s) -| `media_content_type` | no | Set to the value `playlist` -| `media_content_id` | no | The name of the HEOS playlist +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------------------------- | +| `entity_id` | yes | `entity_id` of the player(s) | +| `media_content_type` | no | Set to the value `playlist` | +| `media_content_id` | no | The name of the HEOS playlist | #### Play Quick Select @@ -94,11 +94,11 @@ media_content_type: "quick_select" media_content_id": "1" ``` -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | yes | `entity_id` of the player(s) -| `media_content_type` | no | Set to the value `quick_select` -| `media_content_id` | no | The quick select number (i.e., `1`) or name (i.e., `Quick Select 1`) +| Service data attribute | Optional | Description | +| ---------------------- | -------- | -------------------------------------------------------------------- | +| `entity_id` | yes | `entity_id` of the player(s) | +| `media_content_type` | no | Set to the value `quick_select` | +| `media_content_id` | no | The quick select number (i.e., `1`) or name (i.e., `Quick Select 1`) | #### Play URL @@ -110,11 +110,11 @@ media_content_type: "url" media_content_id: "http://path.to/stream.mp3" ``` -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | yes | `entity_id` of the player(s) to play the URL -| `media_content_type` | no | Set to the value `url` -| `media_content_id` | no | The full URL to the stream +| Service data attribute | Optional | Description | +| ---------------------- | -------- | -------------------------------------------- | +| `entity_id` | yes | `entity_id` of the player(s) to play the URL | +| `media_content_type` | no | Set to the value `url` | +| `media_content_id` | no | The full URL to the stream | ### Service `media_player.join` @@ -127,19 +127,19 @@ group_members: - media_player.bathroom ``` -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | yes | The media player entity whose playback will be expanded to the players specified in `group_members`. -| `group_members` | no | The player entities which will be synced with the playback from `entity_id`. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------- | +| `entity_id` | yes | The media player entity whose playback will be expanded to the players specified in `group_members`. | +| `group_members` | no | The player entities which will be synced with the playback from `entity_id`. | ### Service `media_player.unjoin` For removing a HEOS player from a group you can use the `media_player.unjoin` service. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ---------------------------------------------------- | -| `entity_id` | yes | Unjoin this media player from any player groups. | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ------------------------------------------------ | +| `entity_id` | yes | Unjoin this media player from any player groups. | ## Notes @@ -150,7 +150,7 @@ For removing a HEOS player from a group you can use the `media_player.unjoin` se ### Debugging -The HEOS integration will log additional information about commands, events, and other messages when the log level is set to `debug`. Add the relevant line below to the `configuration.yaml` to enable debug logging: +The HEOS integration will log additional information about commands, events, and other messages when the log level is set to `debug`. Add the relevant line below to the {% term "`configuration.yaml`" %} to enable debug logging: ```yaml logger: diff --git a/source/_integrations/hikvision.markdown b/source/_integrations/hikvision.markdown index 3740c932370..47fbbf54016 100644 --- a/source/_integrations/hikvision.markdown +++ b/source/_integrations/hikvision.markdown @@ -75,7 +75,7 @@ This platform also was confirmed to work with the following Hikvison-based NVRS ## Configuration To enable this sensor, -add the following lines are required in your `configuration.yaml` file: +add the following lines are required in your {% term "`configuration.yaml`" %} file: ```yaml binary_sensor: @@ -166,7 +166,7 @@ Supported sensor/event types are: ## Examples -Example of a configuration in your `configuration.yaml` +Example of a configuration in your {% term "`configuration.yaml`" %} that utilizes the customize options for a camera: ```yaml @@ -184,7 +184,7 @@ binary_sensor: ignored: true ``` -Example of a configuration in your `configuration.yaml` +Example of a configuration in your {% term "`configuration.yaml`" %} that utilizes the customize options for a nvr: ```yaml diff --git a/source/_integrations/history_stats.markdown b/source/_integrations/history_stats.markdown index cbcac3f108f..99bcefc3c4d 100644 --- a/source/_integrations/history_stats.markdown +++ b/source/_integrations/history_stats.markdown @@ -144,7 +144,7 @@ This video tutorial explains how you can use history stats. It also shows how yo ### Examples -Here are some examples of periods you could work with, and what to write in your `configuration.yaml`: +Here are some examples of periods you could work with, and what to write in your {% term "`configuration.yaml`" %}: **Today**: starts at 00:00 of the current day and ends right now. diff --git a/source/_integrations/homekit.markdown b/source/_integrations/homekit.markdown index de40cf9a7c7..e889f36629a 100644 --- a/source/_integrations/homekit.markdown +++ b/source/_integrations/homekit.markdown @@ -38,7 +38,7 @@ some trouble later. However, if you do encounter issues, check out the If you want make specific changes to the way entities are published to HomeKit, override the IP address the HomeKit integration uses to communicate with your network or change the IP address the HomeKit uses to advertise itself to the network, then you will need to configure the -HomeKit integration using an entry in your `configuration.yaml` file. +HomeKit integration using an entry in your {% term "`configuration.yaml`" %} file. This is an example entry of how that would look: @@ -318,7 +318,7 @@ The HomeKit Accessory Protocol Specification only allows a maximum of 150 unique ### Multiple HomeKit instances -If you create a HomeKit integration via the UI (i.e., **Settings** > **Devices & Services**), it must be configured via the UI **only**. While the UI only offers limited configuration options at the moment, any attempt to configure a HomeKit instance created in the UI via the `configuration.yaml` file will result in another instance of HomeKit running on a different port. +If you create a HomeKit integration via the UI (i.e., **Settings** > **Devices & Services**), it must be configured via the UI **only**. While the UI only offers limited configuration options at the moment, any attempt to configure a HomeKit instance created in the UI via the {% term "`configuration.yaml`" %} file will result in another instance of HomeKit running on a different port. It is recommended to only edit a HomeKit instance in the UI that was created in the UI, and likewise, only edit a HomeKit instance in YAML that was created in YAML. @@ -391,37 +391,37 @@ If you have a firewall configured on your Home Assistant system, make sure you o The following integrations are currently supported: -| Integration | Type Name | Description | -| --------- | --------- | ----------- | -| alarm_control_panel | SecuritySystem | All security systems. | -| automation / input_boolean / remote / scene / script / vacuum | Switch | All represented as switches. | -| input_select / select | Switch | Represented as a power strip with buttons for each option. | -| binary_sensor | Sensor | Support for `co2`, `door`, `garage_door`, `gas`, `moisture`, `motion`, `occupancy`, `opening`, `smoke` and `window` device classes. Defaults to the `occupancy` device class for everything else. | -| camera | Camera | All camera devices. **HomeKit Secure Video is not supported at this time.** | -| climate | Thermostat | All climate devices. | -| cover | GarageDoorOpener | All covers that support `open` and `close` and have `garage` or `gate` as their `device_class`. | -| cover | WindowCovering | All covers that support `set_cover_position`. | -| cover | Door | All covers that support `set_cover_position` and have `door` as their `device_class`. | -| cover | WindowCovering | All covers that support `open_cover` and `close_cover` through value mapping. (`open` -> `>=50`; `close` -> `<50`) | -| cover | WindowCovering | All covers that support `open_cover`, `stop_cover` and `close_cover` through value mapping. (`open` -> `>70`; `close` -> `<30`; `stop` -> every value in between) | -| device_tracker / person | Sensor | Support for `occupancy` device class. | -| fan | Fan | Support for `on / off`, `direction` and `oscillating`. | -| fan | Fan | All fans that support `speed` and `speed_list` through value mapping: `speed_list` is assumed to contain values in ascending order. The numeric ranges of HomeKit map to a corresponding entry of `speed_list`. The first entry of `speed_list` should be equivalent to `off` to match HomeKit's concept of fan speeds. (Example: `speed_list` = [`off`, `low`, `high`]; `off` -> `<= 33`; `low` -> between `33` and `66`; `high` -> `> 66`) | -| humidifier | HumidifierDehumidifier | Humidifier and Dehumidifier devices. | -| light | Light | Support for `on / off`, `brightness` and `rgb_color`. | -| lock | DoorLock | Support for `lock / unlock`. | -| media_player | MediaPlayer | Represented as a series of switches which control `on / off`, `play / pause`, `play / stop`, or `mute` depending on `supported_features` of entity and the `mode` list specified in `entity_config`. | -| media_player | TelevisionMediaPlayer | All media players that have `tv` as their `device_class`. Represented as Television and Remote accessories in HomeKit to control `on / off`, `play / pause`, `select source`, or `volume increase / decrease`, depending on `supported_features` of entity. Requires iOS 12.2/macOS 10.14.4 or later. | -| media_player | ReceiverMediaPlayer | All media players that have `receiver` as their `device_class`. Represented as Receiver and Remote accessories in HomeKit to control `on / off`, `play / pause`, `select source`, or `volume increase / decrease`, depending on `supported_features` of entity. Requires iOS 12.2/macOS 10.14.4 or later. | -| sensor | TemperatureSensor | All sensors that have `°C` or `°F` as their `unit_of_measurement` and `temperature` as their `device_class`. | -| sensor | HumiditySensor | All sensors that have `%` as their `unit_of_measurement` and `humidity` as their `device_class`. | -| sensor | AirQualitySensor | All sensors that have `gas`/`pm10`/`pm25` as part of their `entity_id` or `gas`/`pm10`/`pm25`/`nitrogen_dioxide`/`volatile_organic_compounds` as their `device_class`. The VOC mappings use the IAQ guidelines for Europe released by the WHO (World Health Organization). | -| sensor | CarbonMonoxideSensor | All sensors that have `co` as their `device_class` | -| sensor | CarbonDioxideSensor | All sensors that have `co2` as part of their `entity_id` or `co2` as their `device_class` | -| sensor | LightSensor | All sensors that have `lm` or `lx` as their `unit_of_measurement` or `illuminance` as their `device_class` | -| switch | Switch | Represented as a switch by default but can be changed by using `type` within `entity_config`. | -| water_heater | WaterHeater | All `water_heater` devices. | -| device_automation | DeviceTriggerAccessory | All devices that support triggers. | +| Integration | Type Name | Description | +| ------------------------------------------------------------- | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| alarm_control_panel | SecuritySystem | All security systems. | +| automation / input_boolean / remote / scene / script / vacuum | Switch | All represented as switches. | +| input_select / select | Switch | Represented as a power strip with buttons for each option. | +| binary_sensor | Sensor | Support for `co2`, `door`, `garage_door`, `gas`, `moisture`, `motion`, `occupancy`, `opening`, `smoke` and `window` device classes. Defaults to the `occupancy` device class for everything else. | +| camera | Camera | All camera devices. **HomeKit Secure Video is not supported at this time.** | +| climate | Thermostat | All climate devices. | +| cover | GarageDoorOpener | All covers that support `open` and `close` and have `garage` or `gate` as their `device_class`. | +| cover | WindowCovering | All covers that support `set_cover_position`. | +| cover | Door | All covers that support `set_cover_position` and have `door` as their `device_class`. | +| cover | WindowCovering | All covers that support `open_cover` and `close_cover` through value mapping. (`open` -> `>=50`; `close` -> `<50`) | +| cover | WindowCovering | All covers that support `open_cover`, `stop_cover` and `close_cover` through value mapping. (`open` -> `>70`; `close` -> `<30`; `stop` -> every value in between) | +| device_tracker / person | Sensor | Support for `occupancy` device class. | +| fan | Fan | Support for `on / off`, `direction` and `oscillating`. | +| fan | Fan | All fans that support `speed` and `speed_list` through value mapping: `speed_list` is assumed to contain values in ascending order. The numeric ranges of HomeKit map to a corresponding entry of `speed_list`. The first entry of `speed_list` should be equivalent to `off` to match HomeKit's concept of fan speeds. (Example: `speed_list` = [`off`, `low`, `high`]; `off` -> `<= 33`; `low` -> between `33` and `66`; `high` -> `> 66`) | +| humidifier | HumidifierDehumidifier | Humidifier and Dehumidifier devices. | +| light | Light | Support for `on / off`, `brightness` and `rgb_color`. | +| lock | DoorLock | Support for `lock / unlock`. | +| media_player | MediaPlayer | Represented as a series of switches which control `on / off`, `play / pause`, `play / stop`, or `mute` depending on `supported_features` of entity and the `mode` list specified in `entity_config`. | +| media_player | TelevisionMediaPlayer | All media players that have `tv` as their `device_class`. Represented as Television and Remote accessories in HomeKit to control `on / off`, `play / pause`, `select source`, or `volume increase / decrease`, depending on `supported_features` of entity. Requires iOS 12.2/macOS 10.14.4 or later. | +| media_player | ReceiverMediaPlayer | All media players that have `receiver` as their `device_class`. Represented as Receiver and Remote accessories in HomeKit to control `on / off`, `play / pause`, `select source`, or `volume increase / decrease`, depending on `supported_features` of entity. Requires iOS 12.2/macOS 10.14.4 or later. | +| sensor | TemperatureSensor | All sensors that have `°C` or `°F` as their `unit_of_measurement` and `temperature` as their `device_class`. | +| sensor | HumiditySensor | All sensors that have `%` as their `unit_of_measurement` and `humidity` as their `device_class`. | +| sensor | AirQualitySensor | All sensors that have `gas`/`pm10`/`pm25` as part of their `entity_id` or `gas`/`pm10`/`pm25`/`nitrogen_dioxide`/`volatile_organic_compounds` as their `device_class`. The VOC mappings use the IAQ guidelines for Europe released by the WHO (World Health Organization). | +| sensor | CarbonMonoxideSensor | All sensors that have `co` as their `device_class` | +| sensor | CarbonDioxideSensor | All sensors that have `co2` as part of their `entity_id` or `co2` as their `device_class` | +| sensor | LightSensor | All sensors that have `lm` or `lx` as their `unit_of_measurement` or `illuminance` as their `device_class` | +| switch | Switch | Represented as a switch by default but can be changed by using `type` within `entity_config`. | +| water_heater | WaterHeater | All `water_heater` devices. | +| device_automation | DeviceTriggerAccessory | All devices that support triggers. | # Device triggers @@ -511,7 +511,7 @@ The following home hubs have been reported to have trouble with a large number o ### Errors during pairing -If you encounter any issues during pairing, make sure to add the following to your `configuration.yaml` to try and identify the issue(s). +If you encounter any issues during pairing, make sure to add the following to your {% term "`configuration.yaml`" %} to try and identify the issue(s). ```yaml logger: diff --git a/source/_integrations/homekit_controller.markdown b/source/_integrations/homekit_controller.markdown index d38ac079152..cca8e9099de 100644 --- a/source/_integrations/homekit_controller.markdown +++ b/source/_integrations/homekit_controller.markdown @@ -62,7 +62,7 @@ The HomeKit Device integration automatically detects HomeKit [compatible devices ### Prerequisites -- If you do not have the [`default_config`](/integrations/default_config/) integration, add [`zeroconf`](/integrations/zeroconf/) to your `configuration.yaml` file. +- If you do not have the [`default_config`](/integrations/default_config/) integration, add [`zeroconf`](/integrations/zeroconf/) to your {% term "`configuration.yaml`" %} file. - Find your HomeKit pairing code. The code is on the device itself, or on the packaging. If your device has a screen, it may be shown on screen. - There is no way to recover this if you do not have it. In this case, you will need to contact the manufacturer to see what options you have. - Make sure your device is powered up. diff --git a/source/_integrations/homematic.markdown b/source/_integrations/homematic.markdown index cbdcf2ddac8..2a67d9a7be6 100644 --- a/source/_integrations/homematic.markdown +++ b/source/_integrations/homematic.markdown @@ -547,7 +547,7 @@ automation: The `homematic` notification platform enables invoking Homematic devices. -To use this notification platform in your installation, add the following to your `configuration.yaml` file: +To use this notification platform in your installation, add the following to your {% term "`configuration.yaml`" %} file: ### Configuration diff --git a/source/_integrations/homematicip_cloud.markdown b/source/_integrations/homematicip_cloud.markdown index 2fdba5f94ee..2c454d0df5b 100644 --- a/source/_integrations/homematicip_cloud.markdown +++ b/source/_integrations/homematicip_cloud.markdown @@ -56,7 +56,7 @@ Generate the authentication token: `hmip_generate_auth_token.py` -Add the information to your `configuration.yaml` file: +Add the information to your {% term "`configuration.yaml`" %} file: ```yaml homematicip_cloud: diff --git a/source/_integrations/hp_ilo.markdown b/source/_integrations/hp_ilo.markdown index 47948af801b..90c443a01ba 100644 --- a/source/_integrations/hp_ilo.markdown +++ b/source/_integrations/hp_ilo.markdown @@ -98,7 +98,7 @@ Valid sensor_types: ## Example -In order to get two sensors reporting CPU fan speed and Ambient Inlet Temperature, as well as a dump of `server_health` on a HP Microserver Gen8, you could use the following in your `configuration.yaml` file +In order to get two sensors reporting CPU fan speed and Ambient Inlet Temperature, as well as a dump of `server_health` on a HP Microserver Gen8, you could use the following in your {% term "`configuration.yaml`" %} file {% raw %} diff --git a/source/_integrations/humidifier.mqtt.markdown b/source/_integrations/humidifier.mqtt.markdown index 4f5a4e5a8a7..609ac859819 100644 --- a/source/_integrations/humidifier.mqtt.markdown +++ b/source/_integrations/humidifier.mqtt.markdown @@ -18,7 +18,7 @@ When a `state_topic` is not available, the humidifier will work in optimistic mo Optimistic mode can be forced even if a `state_topic` is available. Try to enable it if you are experiencing incorrect humidifier operation. -To enable MQTT humidifiers in your installation, add the following to your `configuration.yaml` file: +To enable MQTT humidifiers in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry From 23d49e8fc453956ff17e6e86dc671692a89f640c Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Tue, 14 May 2024 15:08:50 +0200 Subject: [PATCH 003/103] d-integrations: add glossary reference to configuration.yaml (#32753) --- source/_integrations/decora_wifi.markdown | 6 ++- source/_integrations/default_config.markdown | 2 +- source/_integrations/device_tracker.markdown | 46 +++++++++---------- .../device_tracker.mqtt.markdown | 7 ++- .../device_tracker.xiaomi.markdown | 2 +- .../device_trigger.mqtt.markdown | 2 +- source/_integrations/digital_ocean.markdown | 4 +- source/_integrations/dovado.markdown | 9 ++-- source/_integrations/dweet.markdown | 2 +- source/_integrations/dynalite.markdown | 40 ++++++++-------- 10 files changed, 64 insertions(+), 56 deletions(-) diff --git a/source/_integrations/decora_wifi.markdown b/source/_integrations/decora_wifi.markdown index 7b9e20e6a15..e969ea72fd7 100644 --- a/source/_integrations/decora_wifi.markdown +++ b/source/_integrations/decora_wifi.markdown @@ -9,6 +9,9 @@ ha_domain: decora_wifi ha_platforms: - light ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- Support for [Leviton Decora Wi-Fi](https://www.leviton.com/products/residential/automation-smart-home/decora-smart-all/decora-smart-with-wifi-technology) dimmers/switches via the MyLeviton API. @@ -20,7 +23,8 @@ Supported devices (tested): - - [DW15S-1BZ](https://www.leviton.com/products/dw15s-1bz) (Decora Smart Wi-Fi 15A Switch) - [D215S-2RW](https://store.leviton.com/products/decora-smart-wi-fi-switch-2nd-gen-d215s-2rw) (Decora Smart Wi-Fi 15A Switch - 2nd Gen) -To enable these lights, add the following lines to your `configuration.yaml` file: +To enable these lights, add the following lines to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/default_config.markdown b/source/_integrations/default_config.markdown index c579916b7d7..6158eee9346 100644 --- a/source/_integrations/default_config.markdown +++ b/source/_integrations/default_config.markdown @@ -37,7 +37,7 @@ This {% term integration %} is a meta-component and configures a default set of ## Configuration -To integrate this into Home Assistant, add the following section to your `configuration.yaml` file: +To integrate this into Home Assistant, add the following section to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/device_tracker.markdown b/source/_integrations/device_tracker.markdown index 1e09e41f4ec..d43b7dc7bc0 100644 --- a/source/_integrations/device_tracker.markdown +++ b/source/_integrations/device_tracker.markdown @@ -17,7 +17,7 @@ The device tracker allows you to track devices in Home Assistant. This can happe ## Configuring a `device_tracker` platform -To get started add the following lines to your `configuration.yaml` (example for Netgear): +To get started add the following lines to your {% term "`configuration.yaml`" %} (example for Netgear): ```yaml # Example configuration.yaml entry for Netgear device @@ -36,10 +36,10 @@ The following optional parameters can be used with any platform: Device tracker will only look for the following global settings under the configuration of the first configured platform: -| Parameter | Default | Description | -|----------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `interval_seconds` | 12 | Seconds between each scan for new devices. This only applies to local device trackers, not applications that push updates. | -| `consider_home` | 180 | Seconds to wait till marking someone as not home after not being seen. This parameter is most useful for households with Apple iOS devices that go into sleep mode while still at home to conserve battery life. iPhones will occasionally drop off the network and then re-appear. `consider_home` helps prevent false alarms in presence detection when using IP scanners such as Nmap. `consider_home` accepts various time representations, (e.g., the following all represents 3 minutes: `180`, `0:03`, `0:03:00`) | +| Parameter | Default | Description | +| ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `interval_seconds` | 12 | Seconds between each scan for new devices. This only applies to local device trackers, not applications that push updates. | +| `consider_home` | 180 | Seconds to wait till marking someone as not home after not being seen. This parameter is most useful for households with Apple iOS devices that go into sleep mode while still at home to conserve battery life. iPhones will occasionally drop off the network and then re-appear. `consider_home` helps prevent false alarms in presence detection when using IP scanners such as Nmap. `consider_home` accepts various time representations, (e.g., the following all represents 3 minutes: `180`, `0:03`, `0:03:00`) |
@@ -89,15 +89,15 @@ In the example above, `devicename` refers to the detected name of the device. F
-| Parameter | Default | Description | -|----------------|-------------------------------|---------------------------------------------------------------------------------------------------------| -| `name` | Host name or "Unnamed Device" | The friendly name of the device. | -| `mac` | None | The MAC address of the device. Add this if you are using a network device tracker like Nmap or SNMP. | -| `picture` | None | A picture that you can use to easily identify the person or device. You can also save the image file in a folder "www" in the same location (can be obtained from developer tools) where you have your `configuration.yaml` file and just use `picture: /local/favicon-192x192.png`. The path 'local' is mapped to the 'www' folder you create. | -| `icon` | mdi:account | An icon for this device (use as an alternative to `picture`). | -| `gravatar` | None | An email address for the device's owner. If provided, it will override `picture`. | -| `track` | [uses platform setting] | If `yes`/`on`/`true` then the device will be tracked. Otherwise its location and state will not update. | -| `consider_home` | [uses platform setting] | Seconds to wait till marking someone as not home after not being seen. Allows you to override the global `consider_home` setting from the platform configuration on a per device level. | +| Parameter | Default | Description | +| --------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `name` | Host name or "Unnamed Device" | The friendly name of the device. | +| `mac` | None | The MAC address of the device. Add this if you are using a network device tracker like Nmap or SNMP. | +| `picture` | None | A picture that you can use to easily identify the person or device. You can also save the image file in a folder "www" in the same location (can be obtained from developer tools) where you have your `configuration.yaml` file and just use `picture: /local/favicon-192x192.png`. The path 'local' is mapped to the 'www' folder you create. | +| `icon` | mdi:account | An icon for this device (use as an alternative to `picture`). | +| `gravatar` | None | An email address for the device's owner. If provided, it will override `picture`. | +| `track` | [uses platform setting] | If `yes`/`on`/`true` then the device will be tracked. Otherwise its location and state will not update. | +| `consider_home` | [uses platform setting] | Seconds to wait till marking someone as not home after not being seen. Allows you to override the global `consider_home` setting from the platform configuration on a per device level. | ## Device states @@ -107,12 +107,12 @@ The state of your tracked device will be `'home'` if it is in the [home zone](/i The `device_tracker.see` service can be used to manually update the state of a device tracker: -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `dev_id` | no | The `object_id`, for example `tardis` for `device_tracker.tardis` | -| `location_name` | yes | The location, `home`, `not_home`, or the name of the zone | -| `host_name` | yes | The hostname of the device tracker | -| `mac` | yes | The MAC address of the entity (only specify if you're updating a network based tracker) | -| `gps` | yes | If you're providing a location, for example `[51.513845, -0.100539]` | -| `gps_accuracy` | yes | The accuracy of the GPS fix | -| `battery` | yes | The battery level of the device | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | --------------------------------------------------------------------------------------- | +| `dev_id` | no | The `object_id`, for example `tardis` for `device_tracker.tardis` | +| `location_name` | yes | The location, `home`, `not_home`, or the name of the zone | +| `host_name` | yes | The hostname of the device tracker | +| `mac` | yes | The MAC address of the entity (only specify if you're updating a network based tracker) | +| `gps` | yes | If you're providing a location, for example `[51.513845, -0.100539]` | +| `gps_accuracy` | yes | The accuracy of the GPS fix | +| `battery` | yes | The battery level of the device | diff --git a/source/_integrations/device_tracker.mqtt.markdown b/source/_integrations/device_tracker.mqtt.markdown index ee7ad9ef7e2..bff8816e95e 100644 --- a/source/_integrations/device_tracker.mqtt.markdown +++ b/source/_integrations/device_tracker.mqtt.markdown @@ -6,14 +6,17 @@ ha_category: ha_iot_class: Configurable ha_release: 0.7.3 ha_domain: mqtt +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `mqtt` device tracker platform allows you to define new device_trackers through [manual YAML configuration](#yaml-configuration) in `configuration.yaml` and also to automatically discover device_trackers [using the MQTT Discovery protocol](#using-the-discovery-protocol). +The `mqtt` device tracker {% term integration %} allows you to define new device_trackers through [manual YAML configuration](#yaml-configuration) in {% term "`configuration.yaml`" %} and also to automatically discover device_trackers [using the MQTT Discovery protocol](#using-the-discovery-protocol). ## Configuration -To use this device tracker in your installation, add the following to your `configuration.yaml` file: +To use this device tracker in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/device_tracker.xiaomi.markdown b/source/_integrations/device_tracker.xiaomi.markdown index fb558ad8116..f37f831aa00 100644 --- a/source/_integrations/device_tracker.xiaomi.markdown +++ b/source/_integrations/device_tracker.xiaomi.markdown @@ -11,7 +11,7 @@ The `xiaomi` platform offers presence detection by looking at connected devices ## Setup -To use an Xiaomi router in your installation, add the following to your `configuration.yaml` file: +To use an Xiaomi router in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/device_trigger.mqtt.markdown b/source/_integrations/device_trigger.mqtt.markdown index 752312b24c6..1ad3a038e7b 100644 --- a/source/_integrations/device_trigger.mqtt.markdown +++ b/source/_integrations/device_trigger.mqtt.markdown @@ -14,7 +14,7 @@ An MQTT device trigger is a better option than a [binary sensor](/integrations/b ## Configuration -MQTT device triggers are only supported through [MQTT discovery](/integrations/mqtt/#mqtt-discovery), manual setup through `configuration.yaml` is not supported. +MQTT device triggers are only supported through [MQTT discovery](/integrations/mqtt/#mqtt-discovery), manual setup through {% term "`configuration.yaml`" %} is not supported. The discovery topic needs to be: `/device_automation/[/]/config`. Note that only one trigger may be defined per unique discovery topic. Also note that the combination of `type` and `subtype` should be unique for a device. {% configuration %} diff --git a/source/_integrations/digital_ocean.markdown b/source/_integrations/digital_ocean.markdown index 289488149d2..0a26ce8659e 100644 --- a/source/_integrations/digital_ocean.markdown +++ b/source/_integrations/digital_ocean.markdown @@ -54,7 +54,7 @@ The `digital_ocean` binary sensor platform allows you to monitor your Digital Oc ### Configuration -To use your Digital Ocean droplets, you first have to set up your [Digital Ocean hub](/integrations/digital_ocean/) and then add the following to your `configuration.yaml` file: +To use your Digital Ocean droplets, you first have to set up your [Digital Ocean hub](/integrations/digital_ocean/) and then add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -78,7 +78,7 @@ The `digital_ocean` switch platform allows you to control (start/stop) your Digi ### Configuration -To use your Digital Ocean droplets, you first have to set up your [Digital Ocean hub](/integrations/digital_ocean/) and then add the following to your `configuration.yaml` file: +To use your Digital Ocean droplets, you first have to set up your [Digital Ocean hub](/integrations/digital_ocean/) and then add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/dovado.markdown b/source/_integrations/dovado.markdown index c150ed15b11..917759bf0fa 100644 --- a/source/_integrations/dovado.markdown +++ b/source/_integrations/dovado.markdown @@ -17,14 +17,14 @@ related: title: Configuration file --- -The `dovado` {% term integration %} manages communication with the [Dovado](https://www.dovado.com/) router. +The **Dovado** {% term integration %} manages communication with the [Dovado](https://www.dovado.com/) router. There is currently support for the following device types within Home Assistant: - [Notifications](/integrations/dovado/#notifications) - [Sensor](/integrations/dovado/#sensor) -To add a Dovado integration to your installation, add the following to your {% term "`configuration.yaml`" %} file. +To add a Dovado {% term integration %} to your installation, add the following to your {% term "`configuration.yaml`" %} file. {% include integrations/restart_ha_after_config_inclusion.md %} ```yaml @@ -59,7 +59,8 @@ port: The `dovado` notify platform allows you to send SMS from your [Dovado](https://www.dovado.com/) router, if it supports it. -To add the Dovado notify platform to your installation, add the following to your `configuration.yaml` file: +To add the Dovado {% term integration %} to your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry @@ -89,7 +90,7 @@ automation: The `dovado` sensor platform let you monitor your [Dovado](https://www.dovado.com/) router. -To add a Dovado sensor to your installation, add the following to your `configuration.yaml` file: +To add a Dovado sensor to your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/dweet.markdown b/source/_integrations/dweet.markdown index 1fd35fc6f56..8f6e3cff94a 100644 --- a/source/_integrations/dweet.markdown +++ b/source/_integrations/dweet.markdown @@ -62,7 +62,7 @@ The `dweet` sensor platform allows you to get details from your devices which ar ### Configuration -To use Dweet.io sensors in your installation, add the following to your `configuration.yaml` file: +To use Dweet.io sensors in your installation, add the following to your {% term "`configuration.yaml`" %} file: {% raw %} diff --git a/source/_integrations/dynalite.markdown b/source/_integrations/dynalite.markdown index 8e8b23052b4..a9ed3d2b825 100755 --- a/source/_integrations/dynalite.markdown +++ b/source/_integrations/dynalite.markdown @@ -48,7 +48,7 @@ There are global setup parameters and advanced parameters that should normally b Maybe the most difficult thing about a Dynalite system is finding out the areas and channel mapping. If you have them or have access to the Dynalite software and your configuration files, this could be easy, but in the likely case that your system was installed by an integrator, you will have to discover them on your own. -This is where the `autodiscover` option comes handy. If it is on, the component will track the Dynet network and every time a device is used, it will be added to Home Assistant. It will initially show as "Area 123 Channel 7", but you can then add it to your `configuration.yaml` with the correct configuration. +This is where the `autodiscover` option comes handy. If it is on, the component will track the Dynet network and every time a device is used, it will be added to Home Assistant. It will initially show as "Area 123 Channel 7", but you can then add it to your {% term "`configuration.yaml`" %} with the correct configuration. For example, you would go to your kitchen light and turn it on. Now you log into Home Assistant and see what the channel was. If there was more than one discovered (e.g., someone turned off the living room lights), you can try one, turn it on and off in Home Assistant and see which light it affects. @@ -66,11 +66,11 @@ This does not return the area preset. It sends a network command asking the area -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `host` | yes | Which gateway to send the command to. If not specified, sends to all configured gateways. -| `area` | no | Area for the requested channel. -| `channel` | no | Which channel to request. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------------------------------------------------------------------------------------- | +| `host` | yes | Which gateway to send the command to. If not specified, sends to all configured gateways. | +| `area` | no | Area for the requested channel. | +| `channel` | no | Which channel to request. | ### Service `dynalite.request_channel_level` @@ -82,11 +82,11 @@ This does not return the channel level. It sends a network command asking the ch -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `host` | yes | Which gateway to send the command to. If not specified, sends to all configured gateways. -| `area` | no | Which area to request the preset for. -| `channel` | yes | Which channel to use. If not specified, uses the area configuration or system default. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------------------------------------------------------------------------------------- | +| `host` | yes | Which gateway to send the command to. If not specified, sends to all configured gateways. | +| `area` | no | Which area to request the preset for. | +| `channel` | yes | Which channel to use. If not specified, uses the area configuration or system default. | ## Events @@ -94,17 +94,17 @@ This does not return the channel level. It sends a network command asking the ch Event `dynalite_preset` is fired every time a preset is selected in a given Dynalite area. -| Field | Description | -| ----------- | --------------------------------------------------------------------------------------------------- | -| `host` | Host IP of the Dynalite gateway | -| `area` | Area number where preset was selected | -| `preset` | The specific preset that was selected | +| Field | Description | +| -------- | ------------------------------------- | +| `host` | Host IP of the Dynalite gateway | +| `area` | Area number where preset was selected | +| `preset` | The specific preset that was selected | ### Event `dynalite_packet` Event `dynalite_packet` is fired whenever there is a packet on the Dynalite network. -| Field | Description | -| ----------- | --------------------------------------------------------------------------------------------------- | -| `host` | Host IP of the Dynalite gateway | -| `packet` | List of integers representing the 8-byte packet, including the checksum | +| Field | Description | +| -------- | ----------------------------------------------------------------------- | +| `host` | Host IP of the Dynalite gateway | +| `packet` | List of integers representing the 8-byte packet, including the checksum | From 02ee39a27c72edbd866d51f7194aef8b63bee43a Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Tue, 14 May 2024 15:11:25 +0200 Subject: [PATCH 004/103] f-integrations: add glossary reference to config file (#32755) --- source/_integrations/fail2ban.markdown | 6 +++--- source/_integrations/fan.mqtt.markdown | 3 ++- source/_integrations/ffmpeg.markdown | 2 +- source/_integrations/file.markdown | 6 +++--- source/_integrations/fireservicerota.markdown | 2 +- source/_integrations/firmata.markdown | 2 +- source/_integrations/folder.markdown | 2 +- source/_integrations/foobot.markdown | 2 +- source/_integrations/foursquare.markdown | 2 +- source/_integrations/freedns.markdown | 2 +- source/_integrations/frontend.markdown | 8 ++++---- source/_integrations/futurenow.markdown | 2 +- 12 files changed, 20 insertions(+), 19 deletions(-) diff --git a/source/_integrations/fail2ban.markdown b/source/_integrations/fail2ban.markdown index e8481d13f81..76ab10e5677 100644 --- a/source/_integrations/fail2ban.markdown +++ b/source/_integrations/fail2ban.markdown @@ -65,7 +65,7 @@ For those of us using Docker, the above tutorial may not be sufficient. The foll #### Set HTTP logger -In your `configuration.yaml` file, add the following to the `logger` integration to ensure that Home Assistant prints failed login attempts to the log. +In your {% term "`configuration.yaml`" %} file, add the following to the `logger` integration to ensure that Home Assistant prints failed login attempts to the log. ```yaml logger: @@ -161,7 +161,7 @@ server { } ``` -Once that's added to the NGINX configuration, we need to modify the Home Assistant `configuration.yaml` such that the `X-Forwarded-For` header can be parsed. This is done by adding the following to the `http` integration: +Once that's added to the NGINX configuration, we need to modify the Home Assistant {% term "`configuration.yaml`" %} such that the `X-Forwarded-For` header can be parsed. This is done by adding the following to the `http` integration: ```yaml http: @@ -172,7 +172,7 @@ At this point, once the Let's Encrypt and Home Assistant dockers are restarted, #### Add the fail2ban sensor -Now that we've correctly set everything up for Docker, we can add our sensors to `configuration.yaml` with the following: +Now that we've correctly set everything up for Docker, we can add our sensors to {% term "`configuration.yaml`" %} with the following: ```yaml sensor: diff --git a/source/_integrations/fan.mqtt.markdown b/source/_integrations/fan.mqtt.markdown index e6a84090b2c..0433ed81bc9 100644 --- a/source/_integrations/fan.mqtt.markdown +++ b/source/_integrations/fan.mqtt.markdown @@ -18,7 +18,8 @@ When a `state_topic` is not available, the fan will work in optimistic mode. In Optimistic mode can be forced even if a `state_topic` is available. Try to enable it if you are experiencing incorrect fan operation. -To enable MQTT fans in your installation, add the following to your `configuration.yaml` file: +To enable MQTT fans in your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/ffmpeg.markdown b/source/_integrations/ffmpeg.markdown index fc1b56c5551..dacc5224b28 100644 --- a/source/_integrations/ffmpeg.markdown +++ b/source/_integrations/ffmpeg.markdown @@ -20,7 +20,7 @@ you have FFmpeg installed on your system. ## Configuration -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: ```yaml ffmpeg: diff --git a/source/_integrations/file.markdown b/source/_integrations/file.markdown index 458d208aae5..02953330523 100644 --- a/source/_integrations/file.markdown +++ b/source/_integrations/file.markdown @@ -62,7 +62,7 @@ To use notifications, please see the [getting started with automation page](/get The `file` sensor platform reads the entries from a plain-text file and shows the found value. Only the last line of the file is used. This is similar to do `$ tail -n 1 sensor.txt` on the command-line. Note that file paths must be added to [allowlist_external_dirs](/integrations/homeassistant/#allowlist_external_dirs). -To enable the `file` sensor, add the following lines to your `configuration.yaml`: +To enable the `file` sensor, add the following lines to your {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry @@ -105,7 +105,7 @@ Assuming that the log file contains multiple values formatted as JSON like shown {"temperature": 22, "humidity": 36} ``` -This would require the following entry in the `configuration.yaml` file to extract the temperature: +This would require the following entry in the {% term "`configuration.yaml`" %} file to extract the temperature: {% raw %} @@ -131,7 +131,7 @@ timestamp,temperature,humidity 1631472949,22,36 ``` -This would require the following entry in the `configuration.yaml` file to extract the temperature: +This would require the following entry in the {% term "`configuration.yaml`" %} file to extract the temperature: {% raw %} diff --git a/source/_integrations/fireservicerota.markdown b/source/_integrations/fireservicerota.markdown index d4c62376b76..4dd7cb63dc0 100644 --- a/source/_integrations/fireservicerota.markdown +++ b/source/_integrations/fireservicerota.markdown @@ -215,7 +215,7 @@ This screenshot shows what a FireServiceRota dashboard can look like. ## Debugging -The FireServiceRota integration will log additional information about WebSocket incidents received, response and duty status gathered, and other messages when the log level is set to `debug`. Add the relevant lines below to the `configuration.yaml`: +The FireServiceRota integration will log additional information about WebSocket incidents received, response and duty status gathered, and other messages when the log level is set to `debug`. Add the relevant lines below to the {% term "`configuration.yaml`" %}: ```yaml logger: diff --git a/source/_integrations/firmata.markdown b/source/_integrations/firmata.markdown index a72cac55431..fcb3f7ecb6d 100644 --- a/source/_integrations/firmata.markdown +++ b/source/_integrations/firmata.markdown @@ -35,7 +35,7 @@ There is currently support for the following device types within Home Assistant: You will need to upload a [Firmata firmware](https://github.com/firmata/) to your board. Please upload any `StandardFirmata` sketch to your board; please refer to the [Arduino documentation](https://www.arduino.cc/en/Main/Howto) for further information for uploading sketches. Firmata is available in the Arduino Library Manager in the Arduino IDE. You may also use a [Firmata Express](https://github.com/MrYsLab/FirmataExpress). -To integrate Arduino boards with Home Assistant, add the following section to your `configuration.yaml` file: +To integrate Arduino boards with Home Assistant, add the following section to your {% term "`configuration.yaml`" %} file:
Firmata does not store the last state across power cycles. This means that with every powerup the pins are set to off/low and after every initialization, they will be set to the default that you have configured in YAML. diff --git a/source/_integrations/folder.markdown b/source/_integrations/folder.markdown index b9a1763969e..f47e4a52f80 100644 --- a/source/_integrations/folder.markdown +++ b/source/_integrations/folder.markdown @@ -17,7 +17,7 @@ The sensor exposes the number of filtered files in the folder, total size in byt ## Configuration -To enable the `folder` sensor in your installation, add the following to your `configuration.yaml` file: +To enable the `folder` sensor in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml sensor: diff --git a/source/_integrations/foobot.markdown b/source/_integrations/foobot.markdown index baf75ce54b8..3e4b97074d2 100644 --- a/source/_integrations/foobot.markdown +++ b/source/_integrations/foobot.markdown @@ -17,7 +17,7 @@ This sensor requires an API token. Please obtain one at [Foobot API site](https: ## Configuring the Platform -To enable this sensor, add the following lines to your `configuration.yaml` file: +To enable this sensor, add the following lines to your {% term "`configuration.yaml`" %} file: ```yaml sensor: diff --git a/source/_integrations/foursquare.markdown b/source/_integrations/foursquare.markdown index e5567e14225..5f13eee2d23 100644 --- a/source/_integrations/foursquare.markdown +++ b/source/_integrations/foursquare.markdown @@ -47,7 +47,7 @@ https://foursquare.com/oauth2/authenticate?client_id=CLIENT_ID&response_type=tok and change the `CLIENT_ID` and `YOUR_REGISTERED_REDIRECT_URL` to your actual values. You will receive an OAuth request landing page, asking you if you want to connect your Foursquare account to your newly created app. Say "Yes". -After that, you will get redirected to your `REDIRECT_URL` with the `access_token` as an HTTP GET variable. Copy everything after the = and paste it in your `configuration.yaml` as the `access_token`. +After that, you will get redirected to your `REDIRECT_URL` with the `access_token` as an HTTP GET variable. Copy everything after the = and paste it in your {% term "`configuration.yaml`" %} as the `access_token`. ### Real-Time API diff --git a/source/_integrations/freedns.markdown b/source/_integrations/freedns.markdown index 5522c1af716..f6f77adab2e 100644 --- a/source/_integrations/freedns.markdown +++ b/source/_integrations/freedns.markdown @@ -47,7 +47,7 @@ You need to determine your update URL or your access token. ## Configuration (API V2) -To use the integration in your installation, add the following to your `configuration.yaml` file: +To use the integration in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/frontend.markdown b/source/_integrations/frontend.markdown index cdb056af35b..3f47415e916 100644 --- a/source/_integrations/frontend.markdown +++ b/source/_integrations/frontend.markdown @@ -145,7 +145,7 @@ Theme `day_and_night`: This theme has both a `light` and a `dark` mode section. As with all configuration, you can either: -- Directly specify the themes inside your `configuration.yaml` file. +- Directly specify the themes inside your {% term "`configuration.yaml`" %} file. - Put them into a separate file (e.g., `themes.yaml`) and include that in your configuration (`themes: !include themes.yaml`). - Create a dedicated folder (e.g., `my_themes`) and include all files from within this folder (`themes: !include_dir_merge_named my_themes`). @@ -157,7 +157,7 @@ Check our [community forums](https://community.home-assistant.io/c/projects/them There are two themes-related services: -- `frontend.reload_themes`: Reloads theme configuration from your `configuration.yaml` file. +- `frontend.reload_themes`: Reloads theme configuration from your {% term "`configuration.yaml`" %} file. - `frontend.set_theme`: Sets backend-preferred theme name. ### Service `set_theme` @@ -165,14 +165,14 @@ There are two themes-related services: | Service data attribute | Description | | ---------------------- | --------------------------------------------------------------------------------------------------- | | `name` | Name of the theme to set, `default` for the default theme or `none` to restore to the default. | -| `mode` | If the theme should be applied in light or dark mode `light` or `dark` (Optional, default `light`). | +| `mode` | If the theme should be applied in light or dark mode `light` or `dark` (Optional, default `light`). | If no dark mode backend theme is set, the light mode theme will also be used in dark mode. The backend theme settings will be saved and restored on a restart of Home Assistant. ### Manual theme selection -When themes are enabled in the `configuration.yaml` file, a new option will show up in the user profile page (accessed by clicking your user account initials at the bottom of the sidebar). You can then choose any installed theme from the dropdown list and it will be applied immediately. +When themes are enabled in the {% term "`configuration.yaml`" %} file, a new option will show up in the user profile page (accessed by clicking your user account initials at the bottom of the sidebar). You can then choose any installed theme from the dropdown list and it will be applied immediately. This will overrule the theme settings set by the above service calls, and will only be applied to the current device.

diff --git a/source/_integrations/futurenow.markdown b/source/_integrations/futurenow.markdown index 2ccf6263bec..e2b50ac041b 100644 --- a/source/_integrations/futurenow.markdown +++ b/source/_integrations/futurenow.markdown @@ -73,7 +73,7 @@ devices: ### Extended Configuration Sample -The following example `configuration.yaml` has two different FutureNow units with multiple channels: +The following example {% term "`configuration.yaml`" %} has two different FutureNow units with multiple channels: ```yaml # Example configuration.yaml entry From e5d95eeeed2c7dcdabfb303292c21cb38d04bed5 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Tue, 14 May 2024 15:12:13 +0200 Subject: [PATCH 005/103] e-integrations: add glossary reference to config file (#32754) --- source/_integrations/egardia.markdown | 2 +- source/_integrations/elkm1.markdown | 4 ++-- source/_integrations/enocean.markdown | 16 ++++++++-------- source/_integrations/ephember.markdown | 8 ++++++-- source/_integrations/esphome.markdown | 2 +- 5 files changed, 18 insertions(+), 14 deletions(-) diff --git a/source/_integrations/egardia.markdown b/source/_integrations/egardia.markdown index 23f813938d6..221403af725 100644 --- a/source/_integrations/egardia.markdown +++ b/source/_integrations/egardia.markdown @@ -108,7 +108,7 @@ There seem to be multiple versions of software running on GATE-02 devices; we ha 1. Log in to your alarm system's control panel. You will need to access http://[IP of your control panel]. You know this already since you need it in the basic configuration from above. Log in to the control panel with your Egardia/Woonveilig username and password. 2. Once logged in, go to *System Settings*, *Report* and change the Server Address for your primary server to the IP or hostname of your Home Assistant machine. You can leave the port number set to 52010 or change it to anything you like. **Make sure to change the settings of the primary server otherwise the messages will not come through. Note that this will limit (or fully stop) the number of alarm messages you will get through Egardia's / Woonveilig services.** Maybe, that is just what you want. Make sure to save your settings by selecting 'OK'. **If the system support XMPP, disable XMPP by invalidating the configuration in the XMPP menu (for example by changing the user name). This is required for recent firmwares of the GATE-03 system as it does not use the Reporting server at all in the case of a valid XMPP configuration.** 3. The Egardia integration relies on capturing the status codes that your alarm emits when something happens (status change or trigger). These codes will be unique for every situation - i.e., the code emitted by the alarm when a sensor is triggered is unique to that sensor. Also, if you have multiple users or remotes, each remote has unique codes that are emitted by the alarm when status is changed using that remote or by that user. For the Egardia integration to work correctly you will need to capture the codes. To do this, on your Home Assistant machine run `$ sudo python3 egardiaserver.py`. Refer to the [python-egardia repository](https://github.com/jeroenterheerdt/python-egardia) for detailed documentation on parameters. This will receive status codes from your alarm control panel and display them. Record the codes shown as well as the status they relate to (see step 4 below). Make sure to change the status of your alarm to all states (disarm, arm, home) by all means possible (all users, remotes, web login, app) as well as trigger the alarm in all ways possible to get 100% coverage of all the codes the alarm system generates. You will need to run this script once and stop it once you have captured all the possible codes. Also, if you ever add users, remotes or sensors to your alarm system, make sure to re-run the script to capture the extra codes so you can update your configuration (see step 4 below). **For comfort, before triggering the alarm it might be good to disable the siren temporarily (can be done in Panel Settings).** -4. Once you have the codes, update your `configuration.yaml`: +4. Once you have the codes, update your {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry egardia: diff --git a/source/_integrations/elkm1.markdown b/source/_integrations/elkm1.markdown index 8b039efedc6..c1fd76377da 100644 --- a/source/_integrations/elkm1.markdown +++ b/source/_integrations/elkm1.markdown @@ -146,7 +146,7 @@ The complete list of trouble statuses are: ## Manual configuration -Alternatively, configuration through the `configuration.yaml` file +Alternatively, configuration through the {% term "`configuration.yaml`" %} file is supported (example below). Both methods of configuration support "auto configuration". This works by @@ -561,7 +561,7 @@ Speak a word. The list of words is defined in the ElkM1 ASCII Protocol documenta Debug logs are often required to solve an issue. Follow the instructions on [Enabling debug logging](/docs/configuration/troubleshooting/#enabling-debug-logging). Sometimes, for example, a problem can occur while starting Home Assistant. In this case, follow these instructions. -Add the following to your `configuration.yaml` file in your Home Assistant `config` directory: +Add the following to your {% term "`configuration.yaml`" %} file in your Home Assistant `config` directory: ```yaml logger: diff --git a/source/_integrations/enocean.markdown b/source/_integrations/enocean.markdown index 3f6c8bd8c3f..49968bb72e1 100644 --- a/source/_integrations/enocean.markdown +++ b/source/_integrations/enocean.markdown @@ -131,7 +131,7 @@ You can find the `event_data` `id` by going to {% my developer_events title="Dev An EnOcean light can take many forms. Currently only one type has been tested: Eltako FUD61 dimmer. -To use your EnOcean device, you first have to set up your EnOcean hub and then add the following to your `configuration.yaml` file: +To use your EnOcean device, you first have to set up your EnOcean hub and then add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -166,7 +166,7 @@ The EnOcean sensor platform currently supports the following device types: - [temperature sensor](#temperature-sensor) - [window handle](#window-handle) -To use your EnOcean device, you first have to set up your EnOcean hub and then add the following to your `configuration.yaml` file: +To use your EnOcean device, you first have to set up your EnOcean hub and then add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -197,7 +197,7 @@ device_class: This has been tested with a Permundo PSC234 switch, but any device sending EEP **A5-12-01** messages will work. -Add the following to your `configuration.yaml` file: +Add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -217,7 +217,7 @@ The following [EnOcean Equipment Profiles](https://www.enocean-alliance.org/spec - **A5-04-02** - Temp. and Humidity Sensor, Range -20°C to +60°C and 0% to 100% - **A5-10-10** to **A5-10-14** - Room Operating Panels -Add the following to your `configuration.yaml` file: +Add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -246,7 +246,7 @@ The following [EnOcean Equipment Profiles](https://www.enocean-alliance.org/spec Check the manual of your temperature sensor to figure out what EEP it uses. If you do not know, make an educated guess and check the reported values. It's easiest to validate the temperature at the boundaries of the range, so maybe put the sensor into the fridge for a while. -Add the following to your `configuration.yaml` file: +Add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -290,7 +290,7 @@ However, some EEPs have a different, inverted range, which goes from 0 to 250. T - **A5-10-10** to **A5-10-14** - **A5-20-01** - Battery powered actuator (bi-dir) -Adapt the `configuration.yaml` for those sensors: +Adapt the {% term "`configuration.yaml`" %} for those sensors: ```yaml # Example configuration.yaml entry for EEP A5-10-10 @@ -307,7 +307,7 @@ sensor: As of now, the Hoppe SecuSignal window handle from Somfy has been successfully tested. However, any mechanical window handle that follows the EnOcean RPS telegram spec F6 10 00 (Hoppe AG) is supported. -To configure a window handle, add the following code to your `configuration.yaml`: +To configure a window handle, add the following code to your {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry for window handle EEP F6-10-00 @@ -330,7 +330,7 @@ The window handle sensor can have the following states: An EnOcean switch can take many forms. Currently, only a few types have been tested: Permundo PSC234 and Nod On SIN-2-1-01. -To use your EnOcean device, you first have to set up your EnOcean hub and then add the following to your `configuration.yaml` file: +To use your EnOcean device, you first have to set up your EnOcean hub and then add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/ephember.markdown b/source/_integrations/ephember.markdown index ff547ff70d6..4b49f26b053 100644 --- a/source/_integrations/ephember.markdown +++ b/source/_integrations/ephember.markdown @@ -11,11 +11,15 @@ ha_domain: ephember ha_platforms: - climate ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `ephember` climate platform lets you control [EPH Controls](https://emberapp.ephcontrols.com/) thermostats. The module only works if you have a Wi-Fi gateway to control your EPH system and an account on the EMBER app. +The `ephember` {% term integration %} lets you control [EPH Controls](https://emberapp.ephcontrols.com/) thermostats. The module only works if you have a Wi-Fi gateway to control your EPH system and an account on the EMBER app. -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 climate: diff --git a/source/_integrations/esphome.markdown b/source/_integrations/esphome.markdown index 7b9653194c4..dda362e5ab8 100644 --- a/source/_integrations/esphome.markdown +++ b/source/_integrations/esphome.markdown @@ -57,7 +57,7 @@ ESPHome devices can make service calls to any [Home Assistant service](https://e ## Entity naming and IDs -ESPHome uses different naming and entity ID rules based on the configuration of the ESPHome device. It is recommended to set a `friendly_name` in the ESPHome `configuration.yaml` to take advantage of the newer naming structure, which is consistent with Home Assistant naming standards and makes it much easier to tell similar devices apart. The legacy naming rules apply when the `friendly_name` is not set in the `configuration.yaml`. +ESPHome uses different naming and entity ID rules based on the configuration of the ESPHome device. It is recommended to set a `friendly_name` in the ESPHome {% term "`configuration.yaml`" %} to take advantage of the newer naming structure, which is consistent with Home Assistant naming standards and makes it much easier to tell similar devices apart. The legacy naming rules apply when the `friendly_name` is not set in the {% term "`configuration.yaml`" %}. ### Friendly naming From 1998c765c3bf5b1a707f362099e175fe63a7ab7c Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Tue, 14 May 2024 15:16:28 +0200 Subject: [PATCH 006/103] i-k-integrations: add glossary reference to config file (#32757) --- source/_integrations/ifttt.markdown | 4 +-- source/_integrations/image.mqtt.markdown | 6 ++--- source/_integrations/influxdb.markdown | 2 +- source/_integrations/input_boolean.markdown | 6 ++--- source/_integrations/input_button.markdown | 4 +-- source/_integrations/input_datetime.markdown | 28 ++++++++++---------- source/_integrations/input_number.markdown | 4 +-- source/_integrations/input_select.markdown | 4 +-- source/_integrations/input_text.markdown | 4 +-- source/_integrations/integration.markdown | 2 +- source/_integrations/intellifire.markdown | 2 +- source/_integrations/intesishome.markdown | 2 +- source/_integrations/izone.markdown | 2 +- source/_integrations/joaoapps_join.markdown | 2 +- source/_integrations/keba.markdown | 2 +- source/_integrations/keyboard.markdown | 2 +- source/_integrations/kodi.markdown | 6 ++--- 17 files changed, 41 insertions(+), 41 deletions(-) diff --git a/source/_integrations/ifttt.markdown b/source/_integrations/ifttt.markdown index d73d606003d..126e45d4c3d 100644 --- a/source/_integrations/ifttt.markdown +++ b/source/_integrations/ifttt.markdown @@ -64,7 +64,7 @@ ifttt: `key` is your API key which can be obtained by viewing the **Settings** of the [Webhooks applet](https://ifttt.com/maker_webhooks/settings). It's the last part of the URL (e.g., https://maker.ifttt.com/use/MYAPIKEY) you will find under **My Applets** > **Webhooks** > **Settings**. ![Property screen of the Maker Channel.](/images/integrations/ifttt/finding_key.png) -Once you have added your key to your `configuration.yaml` file, restart your Home Assistant instance. This will load up the IFTTT integration and make a service available to trigger events in IFTTT. +Once you have added your key to your {% term "`configuration.yaml`" %} file, restart your Home Assistant instance. This will load up the IFTTT integration and make a service available to trigger events in IFTTT.

After restarting the server, be sure to watch the console for any logging errors that show up in red, white or yellow. @@ -108,7 +108,7 @@ value3: When your screen looks like this, click the 'call service' button. ![Testing service.](/images/integrations/ifttt/testing_service.png) -By default, the trigger is sent to all the API keys from `configuration.yaml`. If you +By default, the trigger is sent to all the API keys from {% term "`configuration.yaml`" %}. If you want to send the trigger to a specific key use the `target` field: | Field | Value | diff --git a/source/_integrations/image.mqtt.markdown b/source/_integrations/image.mqtt.markdown index a63c856045c..366cb11e17d 100644 --- a/source/_integrations/image.mqtt.markdown +++ b/source/_integrations/image.mqtt.markdown @@ -18,7 +18,7 @@ An alternative setup is to use the `url_topic` option to receive an image URL fo ## Configuration -To enable this image in your installation, add the following to your `configuration.yaml` file: +To enable this image in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -176,7 +176,7 @@ url_topic: ### Example receiving images from a URL -Add the configuration below to your `configuration.yaml`. +Add the configuration below to your {% term "`configuration.yaml`" %}. To test it publish an image URL to the topic from the console: @@ -197,7 +197,7 @@ mqtt: ### Example receiving images from a file -Add the configuration below to your `configuration.yaml`. +Add the configuration below to your {% term "`configuration.yaml`" %}. To test it, publish an image URL to the topic from the console: diff --git a/source/_integrations/influxdb.markdown b/source/_integrations/influxdb.markdown index 13420acfe7d..9289c515f4b 100644 --- a/source/_integrations/influxdb.markdown +++ b/source/_integrations/influxdb.markdown @@ -314,7 +314,7 @@ influxdb: ### Configuration -To configure this sensor, you need to define the sensor connection variables and a list of queries to your `configuration.yaml` file. A sensor will be created for each query: +To configure this sensor, you need to define the sensor connection variables and a list of queries to your {% term "`configuration.yaml`" %} file. A sensor will be created for each query: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/input_boolean.markdown b/source/_integrations/input_boolean.markdown index 3ea219ddc1a..d86e1680c65 100644 --- a/source/_integrations/input_boolean.markdown +++ b/source/_integrations/input_boolean.markdown @@ -25,12 +25,12 @@ in which they are known as Toggle Helpers. To add one, go to next choose the **{% my config_flow_start domain="input_boolean" title="Toggle" %}** option. 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 -configuration, you must add `input_boolean:` to your `configuration.yaml` first, +configuration, you must add `input_boolean:` to your {% term "`configuration.yaml`" %} first, then you can use the UI. -Input booleans can also be configured via `configuration.yaml`: +Input booleans can also be configured via {% term "`configuration.yaml`" %}: {% configuration %} input_boolean: diff --git a/source/_integrations/input_button.markdown b/source/_integrations/input_button.markdown index 36ccde14901..6abcad97259 100644 --- a/source/_integrations/input_button.markdown +++ b/source/_integrations/input_button.markdown @@ -23,12 +23,12 @@ To add one, go to **{% my helpers title="Settings -> Devices & Services -> Helpe and click the add button; next choose the **{% my config_flow_start domain="input_button" title="Button" %}** option. 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 configuration, you must add `input_button:` to your `configuration.yaml` first, then you can use the UI. -Input buttons can also be configured via `configuration.yaml`: +Input buttons can also be configured via {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/input_datetime.markdown b/source/_integrations/input_datetime.markdown index b17c1a4dd99..995af13d187 100644 --- a/source/_integrations/input_datetime.markdown +++ b/source/_integrations/input_datetime.markdown @@ -18,12 +18,12 @@ templates. The preferred way to configure input datetime is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Click the add button and then choose the **{% my config_flow_start domain="input_datetime" title="Date and/or time" %}** option. -To be able to add **{% my helpers title="Helpers" %}** via the user interface you should have `default_config:` in your `configuration.yaml`, it should already be there by default unless you removed it. +To be able to add **{% my helpers title="Helpers" %}** via the user interface you should have `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 configuration, you must add `input_datetime:` to your `configuration.yaml` first, then you can use the UI. `input_datetime` can also be configured via YAML. To add three datetime inputs to your installation, one with both date and time, and one with date or time each, -add the following lines to your `configuration.yaml`: +add the following lines to your {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry @@ -78,12 +78,12 @@ input_datetime: A datetime input entity's state exports several attributes that can be useful in automations and templates. -| Attribute | Description | -| ----- | ----- | -| `has_time` | `true` if this entity has a time. -| `has_date` | `true` if this entity has a date. -| `year`
`month`
`day` | The year, month and day of the date.
(only available if `has_date: true`) -| `timestamp` | A timestamp representing the time held in the input.
(only available if `has_time: true`) +| Attribute | Description | +| -------------------------- | -------------------------------------------------------------------------------------------- | +| `has_time` | `true` if this entity has a time. | +| `has_date` | `true` if this entity has a date. | +| `year`
`month`
`day` | The year, month and day of the date.
(only available if `has_date: true`) | +| `timestamp` | A timestamp representing the time held in the input.
(only available if `has_time: true`) | ### Restore state @@ -95,12 +95,12 @@ Available service: `input_datetime.set_datetime` and `input_datetime.reload`. #### input_datetime.set_datetime -Service data attribute | Format String | Description --|-|- -`date` | `%Y-%m-%d` | This can be used to dynamically set the date. -`time` | `%H:%M:%S` | This can be used to dynamically set the time. -`datetime` | `%Y-%m-%d %H:%M:%S` | This can be used to dynamically set both the date & time. -`timestamp` | N/A | This can be used to dynamically set both the date & time using a UNIX timestamp. +| Service data attribute | Format String | Description | +| ---------------------- | ------------------- | -------------------------------------------------------------------------------- | +| `date` | `%Y-%m-%d` | This can be used to dynamically set the date. | +| `time` | `%H:%M:%S` | This can be used to dynamically set the time. | +| `datetime` | `%Y-%m-%d %H:%M:%S` | This can be used to dynamically set both the date & time. | +| `timestamp` | N/A | This can be used to dynamically set both the date & time using a UNIX timestamp. | To set both the date and time in the same call, use `date` and `time` together, or use `datetime` or `timestamp` by itself. Using `datetime` or `timestamp` has the advantage that both can be set using one template. diff --git a/source/_integrations/input_number.markdown b/source/_integrations/input_number.markdown index cc9252568f5..b95f5b4a876 100644 --- a/source/_integrations/input_number.markdown +++ b/source/_integrations/input_number.markdown @@ -16,10 +16,10 @@ The **Input number** {% term integration %} allows the user to define values tha The preferred way to configure an input number is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Click the add button and then choose the **{% my config_flow_start domain="input_number" title="Number" %}** option. -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 unless you removed it. +To be able to add **Helpers** via the user interface you should have `default_config:` in your {% term "`configuration.yaml`" %}, it should already be there by default unless you removed it. If you removed `default_config:` from you configuration, you must add `input_number:` to your `configuration.yaml` first, then you can use the UI. -Input numbers can also be configured via `configuration.yaml`: +Input numbers can also be configured via {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/input_select.markdown b/source/_integrations/input_select.markdown index 72900456e38..442636fda92 100644 --- a/source/_integrations/input_select.markdown +++ b/source/_integrations/input_select.markdown @@ -16,10 +16,10 @@ The **Input select** {% term integration %} allows the user to define a list of The preferred way to configure an input select is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Click the add button and then choose the **{% my config_flow_start domain="input_select" title="Dropdown" %}** option. -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 unless you removed it. +To be able to add **Helpers** via the user interface you should have `default_config:` in your {% term "`configuration.yaml`" %}, it should already be there by default unless you removed it. If you removed `default_config:` from you configuration, you must add `input_select:` to your `configuration.yaml` first, then you can use the UI. -Input selects can also be configured via `configuration.yaml`: +Input selects can also be configured via {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/input_text.markdown b/source/_integrations/input_text.markdown index 8a57b830987..8960f0fa54c 100644 --- a/source/_integrations/input_text.markdown +++ b/source/_integrations/input_text.markdown @@ -16,10 +16,10 @@ The **Input text** {% term integration %} allows the user to define values that The preferred way to configure an input text is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Click the add button and then choose the **{% my config_flow_start domain="input_text" title="Text" %}** option. -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 unless you removed it. +To be able to add **Helpers** via the user interface you should have `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 configuration, you must add `input_text:` to your `configuration.yaml` first, then you can use the UI. -It can also be configured via `configuration.yaml`: +It can also be configured via {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entries diff --git a/source/_integrations/integration.markdown b/source/_integrations/integration.markdown index cecac94a851..8fbe03a870a 100644 --- a/source/_integrations/integration.markdown +++ b/source/_integrations/integration.markdown @@ -48,7 +48,7 @@ Integration time: Alternatively, this integration can be configured and set up manually via YAML as well. To enable the Integration sensor in your installation, add the -following to your `configuration.yaml` file: +following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/intellifire.markdown b/source/_integrations/intellifire.markdown index a8e4a5a5c5e..c7649e1e46b 100644 --- a/source/_integrations/intellifire.markdown +++ b/source/_integrations/intellifire.markdown @@ -121,7 +121,7 @@ The IFT module can suffer a variety of issues that will render it inoperable. So #### Enabling Debugging -To turn on debug logging modify your `configuration.yaml` file in the `/config` directory and add the following: +To turn on debug logging modify your {% term "`configuration.yaml`" %} file in the `/config` directory and add the following: ```yaml diff --git a/source/_integrations/intesishome.markdown b/source/_integrations/intesishome.markdown index 14cec3519bb..0cd50137713 100644 --- a/source/_integrations/intesishome.markdown +++ b/source/_integrations/intesishome.markdown @@ -19,7 +19,7 @@ Note: IntesisHome products are a separate product line to IntesisBox. This platf ## Configuration -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: ```yaml climate: diff --git a/source/_integrations/izone.markdown b/source/_integrations/izone.markdown index afdd454ad12..74c64892a02 100644 --- a/source/_integrations/izone.markdown +++ b/source/_integrations/izone.markdown @@ -71,7 +71,7 @@ In this mode the current control zone that has been selected is reported, as is zone (read-only, set the value via the individual zones). The current temperature will also be that of the control zone. -You can add configure to read these values into sensors (in `configuration.yaml`), +You can add configure to read these values into sensors (in {% term "`configuration.yaml`" %}), along with the supply temperature (use the ID of your unit): {% raw %} diff --git a/source/_integrations/joaoapps_join.markdown b/source/_integrations/joaoapps_join.markdown index 9d869075372..317995a707b 100644 --- a/source/_integrations/joaoapps_join.markdown +++ b/source/_integrations/joaoapps_join.markdown @@ -21,7 +21,7 @@ divided up in two locations, the Join integration, and the Joaoapps Join notify The notify platform allows us to send messages to Joaoapps Join devices, the integration allows us to access the other special features that Joaoapps Join offers. When in doubt, you can reference the [API documentation](https://joaoapps.com/join/api/) this is based on. -In the `configuration.yaml` file you need to provide the API key and device id +In the {% term "`configuration.yaml`" %} file you need to provide the API key and device id or name of the target device. You can find your device id and API key [here](https://joinjoaomgcd.appspot.com/). diff --git a/source/_integrations/keba.markdown b/source/_integrations/keba.markdown index 427e5c62d97..55b4768c0cc 100644 --- a/source/_integrations/keba.markdown +++ b/source/_integrations/keba.markdown @@ -135,7 +135,7 @@ The service `keba.set_failsafe` sets the failsafe mode of the charging station. ## Notifications -Some Keba chargers are equipped with a LED text display. The notification platform may be used to display text on this display. To enable this, add the following to your `configuration.yaml` file: +Some Keba chargers are equipped with a LED text display. The notification platform may be used to display text on this display. To enable this, add the following to your {% term "`configuration.yaml`" %} file: ### Configuration diff --git a/source/_integrations/keyboard.markdown b/source/_integrations/keyboard.markdown index 2bb44b58147..905c9a7e080 100644 --- a/source/_integrations/keyboard.markdown +++ b/source/_integrations/keyboard.markdown @@ -18,7 +18,7 @@ The `keyboard` integration simulates key presses on the host machine. It current - `keyboard/media_next_track` - `keyboard/media_prev_track` -To load this component, add the following lines to your `configuration.yaml`: +To load this component, add the following lines to your {% term "`configuration.yaml`" %}: ```yaml keyboard: diff --git a/source/_integrations/kodi.markdown b/source/_integrations/kodi.markdown index 2998e7e6120..ff019861220 100644 --- a/source/_integrations/kodi.markdown +++ b/source/_integrations/kodi.markdown @@ -29,7 +29,7 @@ There is currently support for the following device types within Home Assistant: {% include integrations/config_flow.md %} -If you previously had Kodi configured through `configuration.yaml`, it's advisable to remove it, and configure from the UI. +If you previously had Kodi configured through {% term "`configuration.yaml`" %}, it's advisable to remove it, and configure from the UI. If you do not remove it, your configuration will be imported with the following limitations: - Your turn on/off actions will not be imported. This functionality is now available through device triggers. - You may have duplicate entities. @@ -107,7 +107,7 @@ The following scripts can be used in automations for turning on/off your Kodi in #### Turn on Kodi with Wake on LAN -With this configuration, when calling `media_player/turn_on` on the Kodi device, a _magic packet_ will be sent to the specified MAC address. To use this service, first you need to configuration the [`wake_on_lan`](/integrations/wake_on_lan) integration in Home Assistant, which is achieved simply by adding `wake_on_lan:` to your `configuration.yaml`. +With this configuration, when calling `media_player/turn_on` on the Kodi device, a _magic packet_ will be sent to the specified MAC address. To use this service, first you need to configuration the [`wake_on_lan`](/integrations/wake_on_lan) integration in Home Assistant, which is achieved simply by adding `wake_on_lan:` to your {% term "`configuration.yaml`" %}. ```yaml script: @@ -307,7 +307,7 @@ script: The `kodi` notifications platform allows you to send messages to your [Kodi](https://kodi.tv/) multimedia system from Home Assistant. -To add Kodi to your installation, add the following to your `configuration.yaml` file: +To add Kodi to your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry From 0073d7a08fef79347ffc3292920084b32e51464d Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Tue, 14 May 2024 15:23:47 +0200 Subject: [PATCH 007/103] l-integrations: add glossary reference to config file (#32758) --- source/_integrations/lacrosse.markdown | 2 +- source/_integrations/lawn_mower.mqtt.markdown | 2 +- source/_integrations/lcn.markdown | 246 +++++++++--------- source/_integrations/lg_netcast.markdown | 2 +- source/_integrations/light.markdown | 54 ++-- source/_integrations/light.mqtt.markdown | 18 +- source/_integrations/linode.markdown | 4 +- source/_integrations/lock.mqtt.markdown | 2 +- source/_integrations/lock.template.markdown | 2 +- source/_integrations/logger.markdown | 4 +- source/_integrations/lutron_caseta.markdown | 2 +- 11 files changed, 169 insertions(+), 169 deletions(-) diff --git a/source/_integrations/lacrosse.markdown b/source/_integrations/lacrosse.markdown index acfe2ba575c..48976ef6c57 100644 --- a/source/_integrations/lacrosse.markdown +++ b/source/_integrations/lacrosse.markdown @@ -110,7 +110,7 @@ sensor: ## Examples -To setup a LaCrosse sensor with multiple sensors, add the following to your `configuration.yaml` file: +To setup a LaCrosse sensor with multiple sensors, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/lawn_mower.mqtt.markdown b/source/_integrations/lawn_mower.mqtt.markdown index d8c58a26742..315bdc45828 100644 --- a/source/_integrations/lawn_mower.mqtt.markdown +++ b/source/_integrations/lawn_mower.mqtt.markdown @@ -12,7 +12,7 @@ The `mqtt` `lawn_mower` platform allows controlling a lawn mower over MQTT. ## Configuration -To enable MQTT lawn mower in your installation, add the following to your `configuration.yaml` file: +To enable MQTT lawn mower in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/lcn.markdown b/source/_integrations/lcn.markdown index 499f22f59c6..eaf16048618 100644 --- a/source/_integrations/lcn.markdown +++ b/source/_integrations/lcn.markdown @@ -51,7 +51,7 @@ There is currently support for the following device types within Home Assistant: ## Configuration -To use your LCN system in your installation, add the following lines to your `configuration.yaml` file. +To use your LCN system in your installation, add the following lines to your {% term "`configuration.yaml`" %} file. You have to specify at least one IP/port with login credentials for a PCHK host. Consider to store your credentials in a [`secrets.yaml`](/docs/configuration/secrets). @@ -370,49 +370,49 @@ The platforms and service calls use several predefined constants as parameters. ### Ports -| Constant | Values | -| -------- | ------ | -| OUTPUT_PORT | `output1`, `output2`, `output3`, `output4` | -| RELAY_PORT | `relay1`, `relay2`, `relay3`, `relay4`, `relay5`, `relay6`, `relay7`, `relay8` | -| MOTOR_PORT | `motor1`, `motor2`, `motor3`, `motor4`, `outputs` | -| LED_PORT | `led1`, `led2`, `led3`, `led4`, `led5`, `led6`, `led7`, `led8`, `led9`, `led10`, `led11`, `led12` | -| LOGICOP_PORT | `logicop1`, `logicop2`, `logicop3`, `logicop4` | +| Constant | Values | +| -------------- | -------------------------------------------------------------------------------------------------------------- | +| OUTPUT_PORT | `output1`, `output2`, `output3`, `output4` | +| RELAY_PORT | `relay1`, `relay2`, `relay3`, `relay4`, `relay5`, `relay6`, `relay7`, `relay8` | +| MOTOR_PORT | `motor1`, `motor2`, `motor3`, `motor4`, `outputs` | +| LED_PORT | `led1`, `led2`, `led3`, `led4`, `led5`, `led6`, `led7`, `led8`, `led9`, `led10`, `led11`, `led12` | +| LOGICOP_PORT | `logicop1`, `logicop2`, `logicop3`, `logicop4` | | BINSENSOR_PORT | `binsensor1`, `binsensor2`, `binsensor3`, `binsensor4`, `binsensor5`, `binsensor6`, `binsensor7`, `binsensor8` | The [MOTOR_PORT](#ports) values specify which hardware relay or outputs configuration will be used: -| Motor | Relay on/off | Relay up/down | +| Motor | Relay on/off | Relay up/down | | :------: | :----------: | :-----------: | -| `motor1` | `relay1` | `relay2` | -| `motor2` | `relay3` | `relay4` | -| `motor3` | `relay5` | `relay6` | -| `motor4` | `relay7` | `relay8` | +| `motor1` | `relay1` | `relay2` | +| `motor2` | `relay3` | `relay4` | +| `motor3` | `relay5` | `relay6` | +| `motor4` | `relay7` | `relay8` | -| Motor | Output up | Output down | +| Motor | Output up | Output down | | :-------: | :-------: | :---------: | -| `outputs` | `output1` | `output2` | +| `outputs` | `output1` | `output2` | ### Variables and Units -| Constant | Values | -| -------- | ------ | -| VARIABLE | `var1`, `var2`, `var3`, `var4`, `var5`, `var6`, `var7`, `var8`, `var9`, `var10`, `var11`, `var12`, `tvar`, `r1var`, `r2var` | -| SETPOINT | `r1varsetpoint`, `r2varsetpoint` | -| THRESHOLD | `thrs1`, `thrs2`, `thrs3`, `thrs4`, `thrs5`, `thrs2_1`, `thrs2_2`, `thrs2_3`, `thrs2_4`, `thrs3_1`, `thrs3_2`, `thrs3_3`, `thrs3_4`, `thrs4_1`, `thrs4_2`, `thrs4_3`, `thrs4_4` | -| S0_INPUT | `s0input1`, `s0input2`, `s0input3`, `s0input4` | -| VAR_UNIT | `native`, `°C`, `°K`, `°F`, `lux_t`, `lux_i`, `m/s`, `%`, `ppm`, `volt`, `ampere`, `degree` | -| TIME_UNIT | `seconds`, `minutes`, `hours`, `days` | -| RELVARREF | `current`, `prog` | -| REVERSE_TIME | `rt70`, `rt600`, `rt1200` | +| Constant | Values | +| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| VARIABLE | `var1`, `var2`, `var3`, `var4`, `var5`, `var6`, `var7`, `var8`, `var9`, `var10`, `var11`, `var12`, `tvar`, `r1var`, `r2var` | +| SETPOINT | `r1varsetpoint`, `r2varsetpoint` | +| THRESHOLD | `thrs1`, `thrs2`, `thrs3`, `thrs4`, `thrs5`, `thrs2_1`, `thrs2_2`, `thrs2_3`, `thrs2_4`, `thrs3_1`, `thrs3_2`, `thrs3_3`, `thrs3_4`, `thrs4_1`, `thrs4_2`, `thrs4_3`, `thrs4_4` | +| S0_INPUT | `s0input1`, `s0input2`, `s0input3`, `s0input4` | +| VAR_UNIT | `native`, `°C`, `°K`, `°F`, `lux_t`, `lux_i`, `m/s`, `%`, `ppm`, `volt`, `ampere`, `degree` | +| TIME_UNIT | `seconds`, `minutes`, `hours`, `days` | +| RELVARREF | `current`, `prog` | +| REVERSE_TIME | `rt70`, `rt600`, `rt1200` | ### States: -| Constant | Values | -| -------- | ------ | -| LED_STATE | `on`, `off`, `blink`, `flicker` | -| LOGICOP_STATE | `none`, `some`, `all` | -| KEY_STATE | `hit`, `make`, `break`, `dontsend` | +| Constant | Values | +| ------------- | ---------------------------------- | +| LED_STATE | `on`, `off`, `blink`, `flicker` | +| LOGICOP_STATE | `none`, `some`, `all` | +| KEY_STATE | `hit`, `make`, `break`, `dontsend` | ### Keys: @@ -577,11 +577,11 @@ Examples are button presses from remote controls (transmitters), transponder fin All events have some common attributes in their `event_data` which identify the sending LCN hardware module (e.g., the module the transponder is connected to): -| Event payload | Description | Values | -| ------------- | ----------- | ------ | -| `device_id` | Internal device id of LCN module | string | -| `segment_id` | Module's segment id | 5..128 | -| `module_id` | Module id | 5..254 | +| Event payload | Description | Values | +| ------------- | -------------------------------- | ------ | +| `device_id` | Internal device id of LCN module | string | +| `segment_id` | Module's segment id | 5..128 | +| `module_id` | Module id | 5..254 | In addition, every event has its own special attributes which are described below. All special attributes are optional and can be used as supplementary filters. @@ -590,12 +590,12 @@ All special attributes are optional and can be used as supplementary filters. The `lcn_transmitter` event is fired if a LCN remote control command is received. -| Special payload | Description | Values | -| --------------- | ----------- | ------ | -| `code` | Transmitter code | string (6 hex values) | -| `level` | Key level | 0..4 | -| `key` | Key | 0..4 | -| `action` | Key action | `hit`, `make`, `break` | +| Special payload | Description | Values | +| --------------- | ---------------- | ---------------------- | +| `code` | Transmitter code | string (6 hex values) | +| `level` | Key level | 0..4 | +| `key` | Key | 0..4 | +| `action` | Key action | `hit`, `make`, `break` | Example: @@ -618,9 +618,9 @@ automation: The `lcn_transponder` event is fired if a LCN transponder command is received. -| Special payload | Description | Values | -| --------------- | ----------- | ------ | -| `code` | Transponder code | string (6 hex values) | +| Special payload | Description | Values | +| --------------- | ---------------- | --------------------- | +| `code` | Transponder code | string (6 hex values) | Example: @@ -640,9 +640,9 @@ automation: The `lcn_fingerprint` event is fired if a LCN fingerprint command is received. -| Special payload | Description | Values | -| --------------- | ----------- | ------ | -| `code` | Fingerprint code | string (6 hex values) | +| Special payload | Description | Values | +| --------------- | ---------------- | --------------------- | +| `code` | Fingerprint code | string (6 hex values) | Example: @@ -662,9 +662,9 @@ automation: The `lcn_codelock` event is fired if a LCN code lock command is received. -| Special payload | Description | Values | -| --------------- | ----------- | ------ | -| `code` | Code lock code | string (6 hex values) | +| Special payload | Description | Values | +| --------------- | -------------- | --------------------- | +| `code` | Code lock code | string (6 hex values) | Example: @@ -684,10 +684,10 @@ automation: The `lcn_send_keys` event is fired if the PCHK host receives a *send keys* command. -| Special payload | Description | Values | -| --------------- | ----------- | ------ | -| `key` | LCN Key | a1..c8 | -| `action` | Key action | `hit`, `make`, `break` | +| Special payload | Description | Values | +| --------------- | ----------- | ---------------------- | +| `key` | LCN Key | a1..c8 | +| `action` | Key action | `hit`, `make`, `break` | Example: @@ -723,12 +723,12 @@ Refer to the [Services Calls](/docs/scripts/service-calls) page for examples on Set absolute brightness of output port in percent. -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `output` | No | Output port of module | [OUTPUT_PORT](#ports) | -| `brightness` | Yes | Absolute brightness in percent | 0..100 | -| `transition` | Yes | Transition (ramp) time in seconds | 0..486 | +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | --------------------------------- | --------------------- | +| `address` | No | [LCN address](#lcn-addresses) | +| `output` | No | Output port of module | [OUTPUT_PORT](#ports) | +| `brightness` | Yes | Absolute brightness in percent | 0..100 | +| `transition` | Yes | Transition (ramp) time in seconds | 0..486 | Example: @@ -745,12 +745,12 @@ data: Set relative brightness of output port in percent. -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `output` | No | Output port of module | [OUTPUT_PORT](#ports) | -| `brightness` | Yes | Relative brightness in percent | -100..100 | -| `transition` | Yes | Transition (ramp) time in seconds | 0..486 | +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | --------------------------------- | --------------------- | +| `address` | No | [LCN address](#lcn-addresses) | +| `output` | No | Output port of module | [OUTPUT_PORT](#ports) | +| `brightness` | Yes | Relative brightness in percent | -100..100 | +| `transition` | Yes | Transition (ramp) time in seconds | 0..486 | Example: @@ -766,11 +766,11 @@ data: Toggle output port. -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `output` | No | Output port of module | [OUTPUT_PORT](#ports) | -| `transition` | Yes | Transition (ramp) time in seconds | 0..486 | +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | --------------------------------- | --------------------- | +| `address` | No | [LCN address](#lcn-addresses) | +| `output` | No | Output port of module | [OUTPUT_PORT](#ports) | +| `transition` | Yes | Transition (ramp) time in seconds | 0..486 | Example: @@ -789,10 +789,10 @@ Each character represents the state change of a relay (1=on, 0=off, t=toggle, -= Example states: `t---001-` -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `state` | No | Relay states as string | +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | ----------------------------- | ------ | +| `address` | No | [LCN address](#lcn-addresses) | +| `state` | No | Relay states as string | Example: @@ -807,10 +807,10 @@ data: Set the LED status. -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `state` | No | LED state as string | [LED_STATE](#states) | +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | ----------------------------- | -------------------- | +| `address` | No | [LCN address](#lcn-addresses) | +| `state` | No | LED state as string | [LED_STATE](#states) | Example: @@ -828,12 +828,12 @@ Set the absolute value of a variable or setpoint. If `value` is not defined, it is assumed to be 0. If `unit_of_measurement` is not defined, it is assumed to be `native`. -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `variable` | No | Variable name | [VARIABLE](#variables-and-units), [SETPOINT](#variables-and-units) | -| `value` | Yes | Variable value | _any positive number_ | -| `unit_of_measurement` | Yes | Variable unit | [VAR_UNIT](#variables-and-units) | +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | ----------------------------- | ------------------------------------------------------------------ | +| `address` | No | [LCN address](#lcn-addresses) | +| `variable` | No | Variable name | [VARIABLE](#variables-and-units), [SETPOINT](#variables-and-units) | +| `value` | Yes | Variable value | _any positive number_ | +| `unit_of_measurement` | Yes | Variable unit | [VAR_UNIT](#variables-and-units) | Example: @@ -857,12 +857,12 @@ Set the relative value of a variable or setpoint. If `value` is not defined, it is assumed to be 0. If `unit_of_measurement` is not defined, it is assumed to be `native`. -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `variable` | No | Variable name | [VARIABLE](#variables-and-units), [SETPOINT](#variables-and-units), [THRESHOLD](#variables-and-units) | -| `value` | Yes | Variable value | _any positive or negative number_ | -| `unit_of_measurement` | Yes | Variable unit | [VAR_UNIT](#variables-and-units) | +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | ----------------------------- | ----------------------------------------------------------------------------------------------------- | +| `address` | No | [LCN address](#lcn-addresses) | +| `variable` | No | Variable name | [VARIABLE](#variables-and-units), [SETPOINT](#variables-and-units), [THRESHOLD](#variables-and-units) | +| `value` | Yes | Variable value | _any positive or negative number_ | +| `unit_of_measurement` | Yes | Variable unit | [VAR_UNIT](#variables-and-units) | Example: @@ -884,10 +884,10 @@ data: Reset value of variable or setpoint. -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `variable` | No | Variable name | [VARIABLE](#variables-and-units), [SETPOINT](#variables-and-units) | +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | ----------------------------- | ------------------------------------------------------------------ | +| `address` | No | [LCN address](#lcn-addresses) | +| `variable` | No | Variable name | [VARIABLE](#variables-and-units), [SETPOINT](#variables-and-units) | Example: @@ -908,11 +908,11 @@ data: Locks a regulator setpoint. If `state` is not defined, it is assumed to be `False`. -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `setpoint` | No | Setpoint name | [SETPOINT](#variables-and-units) | -| `state` | Yes | Lock state | true, false | +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | ----------------------------- | -------------------------------- | +| `address` | No | [LCN address](#lcn-addresses) | +| `setpoint` | No | Setpoint name | [SETPOINT](#variables-and-units) | +| `state` | Yes | Lock state | true, false | Example: @@ -932,13 +932,13 @@ If `state` is not defined, it is assumed to be `hit`. The command allows the sending of keys immediately or deferred. For a deferred sending the attributes `time` and `time_unit` have to be specified. For deferred sending, the only key state allowed is `hit`. If `time_unit` is not defined, it is assumed to be `seconds`. -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `keys` | No | Keys string | -| `state` | Yes | Keys state | [KEY_STATE](#states) | -| `time` | Yes | Deferred time | 0.. | -| `time_unit` | Yes | Time unit | [TIME_UNIT](#variables-and-units) +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | ----------------------------- | --------------------------------- | +| `address` | No | [LCN address](#lcn-addresses) | +| `keys` | No | Keys string | +| `state` | Yes | Keys state | [KEY_STATE](#states) | +| `time` | Yes | Deferred time | 0.. | +| `time_unit` | Yes | Time unit | [TIME_UNIT](#variables-and-units) | Examples: @@ -969,13 +969,13 @@ The key lock states are defined as a string with eight characters. Each characte The command allows the locking of keys for a specified time period. For a time period, the attributes `time` and `time_unit` have to be specified. For a time period, only table `a` is allowed. If `time_unit` is not defined, it is assumed to be `seconds`. -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `table` | Yes | Table with keys to lock | -| `state` | No | Key lock states as string | [KEY_STATE](#states) | -| `time` | Yes | Time period to lock | 0.. | -| `time_unit` | Yes | Time unit | [TIME_UNIT](#variables-and-units) +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | ----------------------------- | --------------------------------- | +| `address` | No | [LCN address](#lcn-addresses) | +| `table` | Yes | Table with keys to lock | +| `state` | No | Key lock states as string | [KEY_STATE](#states) | +| `time` | Yes | Time period to lock | 0.. | +| `time_unit` | Yes | Time unit | [TIME_UNIT](#variables-and-units) | Examples: @@ -1005,11 +1005,11 @@ The displays support four rows for text messages. Each row can be set independently and can store up to 60 characters (encoded in UTF-8). -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `row` | No | Text row 1..4 | -| `text` | No | Text to send for the specified row | +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | ---------------------------------- | ------ | +| `address` | No | [LCN address](#lcn-addresses) | +| `row` | No | Text row 1..4 | +| `text` | No | Text to send for the specified row | Example: @@ -1025,10 +1025,10 @@ data: Send arbitrary PCK command. Only the command part of the PCK command has to be specified in the `pck` string. -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `pck` | No | PCK command | +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | ----------------------------- | ------ | +| `address` | No | [LCN address](#lcn-addresses) | +| `pck` | No | PCK command | Example: diff --git a/source/_integrations/lg_netcast.markdown b/source/_integrations/lg_netcast.markdown index 197b22c3458..54fcb6d7ebd 100644 --- a/source/_integrations/lg_netcast.markdown +++ b/source/_integrations/lg_netcast.markdown @@ -17,7 +17,7 @@ ha_config_flow: true The `lg_netcast` platform allows you to control a LG Smart TV running NetCast 3.0 (LG Smart TV models released in 2012) and NetCast 4.0 (LG Smart TV models released in 2013). For the new LG WebOS TV's use the [webostv](/integrations/webostv#media-player) platform. -To add a LG TV to your installation, add the following to your `configuration.yaml` file: +To add a LG TV to your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/light.markdown b/source/_integrations/light.markdown index 6c530a915a4..e79877da712 100644 --- a/source/_integrations/light.markdown +++ b/source/_integrations/light.markdown @@ -17,7 +17,7 @@ This integration allows you to track and control various light bulbs. Read the i ### Default turn-on values -To set the default color, brightness and transition values when the light is turned on, create a custom `light_profiles.csv`, normally located in the default configuration folder where you find `configuration.yaml`. +To set the default color, brightness and transition values when the light is turned on, create a custom `light_profiles.csv`, normally located in the default configuration folder where you find {% term "`configuration.yaml`" %}. The `light_profiles.csv` has to have a header. The format of the header is: @@ -41,27 +41,27 @@ Turns one light on or multiple lights on using [groups](/integrations/group/). Most lights do not support all attributes. You can check the integration documentation of your particular light for hints, but in general, you will have to try things out and see what works. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | no | String or list of strings that point at `entity_id`s of lights. To target all lights, set `entity_id` to `all`. -| `transition` | yes | Number that represents the time (in seconds) the light should take to transition to the new state. -| `profile` | yes | String with the name of one of the [built-in profiles](https://github.com/home-assistant/core/blob/master/homeassistant/components/light/light_profiles.csv) (relax, energize, concentrate, reading) or one of the custom profiles defined in `light_profiles.csv` in the current working directory. Light profiles define an xy color, brightness and a transition value (if no transition is desired, set to 0 or leave out the column entirely). If a profile is given, and a brightness is set, then the profile brightness will be overwritten. -| `hs_color` | yes | A list containing two floats representing the hue and saturation of the color you want the light to be. Hue is scaled 0-360, and saturation is scaled 0-100. -| `xy_color` | yes | A list containing two floats representing the xy color you want the light to be. Two comma-separated floats that represent the color in XY. -| `rgb_color` | yes | A list containing three integers between 0 and 255 representing the RGB color you want the light to be. Three comma-separated integers that represent the color in RGB, within square brackets. -| `rgbw_color` | yes | A list containing four integers between 0 and 255 representing the RGBW color you want the light to be. Four comma-separated integers that represent the color in RGBW (red, green, blue, white), within square brackets. This attribute will be ignored by lights which do not support RGBW colors. -| `rgbww_color` | yes | A list containing five integers between 0 and 255 representing the RGBWW color you want the light to be. Five comma-separated integers that represent the color in RGBWW (red, green, blue, cold white, warm white), within square brackets. This attribute will be ignored by lights which do not support RGBWW colors. -| `color_temp_kelvin` | yes | An integer in Kelvin representing the color temperature you want the light to be. -| `kelvin` | yes | (Deprecated) Use `color_temp_kelvin` instead. -| `color_temp` | yes | (Deprecated) Alternatively, you can specify the color temperature in Mireds. -| `color_name` | yes | A human-readable string of a color name, such as `blue` or `goldenrod`. All [CSS3 color names](https://www.w3.org/TR/css-color-3/#svg-color) are supported. -| `brightness` | yes | Integer between 0 and 255 for how bright the light should be, where 0 means the light is off, 1 is the minimum brightness and 255 is the maximum brightness supported by the light. -| `brightness_pct`| yes | Alternatively, you can specify brightness in percent (a number between 0 and 100), where 0 means the light is off, 1 is the minimum brightness and 100 is the maximum brightness supported by the light. -| `brightness_step` | yes | Change brightness by an amount. Should be between -255..255. -| `brightness_step_pct` | yes | Change brightness by a percentage. Should be between -100..100. -| `white` | yes | Set the light to white mode by setting this to `True`. Note that `white` does not have a corresponding state attribute, so the `color_mode` state attribute will be set to `white`. -| `flash` | yes | Tell light to flash, can be either value `short` or `long`. -| `effect`| yes | Applies an effect such as `colorloop` or `random`. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `entity_id` | no | String or list of strings that point at `entity_id`s of lights. To target all lights, set `entity_id` to `all`. | +| `transition` | yes | Number that represents the time (in seconds) the light should take to transition to the new state. | +| `profile` | yes | String with the name of one of the [built-in profiles](https://github.com/home-assistant/core/blob/master/homeassistant/components/light/light_profiles.csv) (relax, energize, concentrate, reading) or one of the custom profiles defined in `light_profiles.csv` in the current working directory. Light profiles define an xy color, brightness and a transition value (if no transition is desired, set to 0 or leave out the column entirely). If a profile is given, and a brightness is set, then the profile brightness will be overwritten. | +| `hs_color` | yes | A list containing two floats representing the hue and saturation of the color you want the light to be. Hue is scaled 0-360, and saturation is scaled 0-100. | +| `xy_color` | yes | A list containing two floats representing the xy color you want the light to be. Two comma-separated floats that represent the color in XY. | +| `rgb_color` | yes | A list containing three integers between 0 and 255 representing the RGB color you want the light to be. Three comma-separated integers that represent the color in RGB, within square brackets. | +| `rgbw_color` | yes | A list containing four integers between 0 and 255 representing the RGBW color you want the light to be. Four comma-separated integers that represent the color in RGBW (red, green, blue, white), within square brackets. This attribute will be ignored by lights which do not support RGBW colors. | +| `rgbww_color` | yes | A list containing five integers between 0 and 255 representing the RGBWW color you want the light to be. Five comma-separated integers that represent the color in RGBWW (red, green, blue, cold white, warm white), within square brackets. This attribute will be ignored by lights which do not support RGBWW colors. | +| `color_temp_kelvin` | yes | An integer in Kelvin representing the color temperature you want the light to be. | +| `kelvin` | yes | (Deprecated) Use `color_temp_kelvin` instead. | +| `color_temp` | yes | (Deprecated) Alternatively, you can specify the color temperature in Mireds. | +| `color_name` | yes | A human-readable string of a color name, such as `blue` or `goldenrod`. All [CSS3 color names](https://www.w3.org/TR/css-color-3/#svg-color) are supported. | +| `brightness` | yes | Integer between 0 and 255 for how bright the light should be, where 0 means the light is off, 1 is the minimum brightness and 255 is the maximum brightness supported by the light. | +| `brightness_pct` | yes | Alternatively, you can specify brightness in percent (a number between 0 and 100), where 0 means the light is off, 1 is the minimum brightness and 100 is the maximum brightness supported by the light. | +| `brightness_step` | yes | Change brightness by an amount. Should be between -255..255. | +| `brightness_step_pct` | yes | Change brightness by a percentage. Should be between -100..100. | +| `white` | yes | Set the light to white mode by setting this to `True`. Note that `white` does not have a corresponding state attribute, so the `color_mode` state attribute will be set to `white`. | +| `flash` | yes | Tell light to flash, can be either value `short` or `long`. | +| `effect` | yes | Applies an effect such as `colorloop` or `random`. |
@@ -111,11 +111,11 @@ If no data is sent, and a default profile exists, the default profile will be ap Turns one or multiple lights off. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | no | String or list of strings that point at `entity_id`s of lights. To target all lights, set `entity_id` to `all`. -| `transition` | yes | Integer that represents the time the light should take to transition to the new state in seconds. -| `flash` | yes | Tell light to flash, can be either value `short` or `long`. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------- | +| `entity_id` | no | String or list of strings that point at `entity_id`s of lights. To target all lights, set `entity_id` to `all`. | +| `transition` | yes | Integer that represents the time the light should take to transition to the new state in seconds. | +| `flash` | yes | Tell light to flash, can be either value `short` or `long`. | ### Service `light.toggle` diff --git a/source/_integrations/light.mqtt.markdown b/source/_integrations/light.mqtt.markdown index 31ee29164a1..f59f2413fa4 100644 --- a/source/_integrations/light.mqtt.markdown +++ b/source/_integrations/light.mqtt.markdown @@ -413,7 +413,7 @@ In this section you will find some real-life examples of how to use this sensor. ### Brightness and RGB support -To enable a light with brightness and RGB support in your installation, add the following to your `configuration.yaml` file: +To enable a light with brightness and RGB support in your installation, add the following to your {% term "`configuration.yaml`" %} file: {% raw %} @@ -441,7 +441,7 @@ mqtt: ### Brightness and no RGB support -To enable a light with brightness (no RGB version) in your installation, add the following to your `configuration.yaml` file: +To enable a light with brightness (no RGB version) in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -460,7 +460,7 @@ mqtt: ### Brightness without on commands -To enable a light that sends only brightness topics to turn it on, add the following to your `configuration.yaml` file. The `command_topic` is only used to send an off command in this case: +To enable a light that sends only brightness topics to turn it on, add the following to your {% term "`configuration.yaml`" %} file. The `command_topic` is only used to send an off command in this case: ```yaml # Example configuration.yaml entry @@ -742,7 +742,7 @@ In this section you find some real-life examples of how to use this sensor. ### Brightness and RGB support -To enable a light with brightness and RGB support in your installation, add the following to your `configuration.yaml` file: +To enable a light with brightness and RGB support in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -758,7 +758,7 @@ mqtt: ### Brightness and no RGB support -To enable a light with brightness (but no color support) in your installation, add the following to your `configuration.yaml` file: +To enable a light with brightness (but no color support) in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -827,7 +827,7 @@ Home Assistant expects the hue values to be in the range 0 to 360 and the satura ### Brightness and RGBW support -To enable a light with brightness, RGB support and a separate white channel (RGBW) in your installation, add the following to your `configuration.yaml` file: +To enable a light with brightness, RGB support and a separate white channel (RGBW) in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -1090,7 +1090,7 @@ In this section you find some real-life examples of how to use this light. ### Simple string payload -For a simple string payload with the format `state,brightness,r-g-b,h-s` (e.g., `on,255,255-255-255,360-100`), add the following to your `configuration.yaml` file: +For a simple string payload with the format `state,brightness,r-g-b,h-s` (e.g., `on,255,255-255-255,360-100`), add the following to your {% term "`configuration.yaml`" %} file: {% raw %} @@ -1114,7 +1114,7 @@ mqtt: ### JSON payload -For a JSON payload with the format `{"state": "on", "brightness": 255, "color": [255, 255, 255], "effect": "rainbow"}`, add the following to your `configuration.yaml` file: +For a JSON payload with the format `{"state": "on", "brightness": 255, "color": [255, 255, 255], "effect": "rainbow"}`, add the following to your {% term "`configuration.yaml`" %} file: {% raw %} @@ -1159,7 +1159,7 @@ mqtt: This example comes from a configuration of Shelly RGBW Bulb working in White mode. `max_mireds` and `min_mireds` set color temperature boundaries to 3000K - 6500K. Notice the same limits are applied in `command_on_template`, but in kelvin units this time. It's due to conversion from mired to kelvin which causes exceeding boundary values accepted by the device. The code also ensures bi-directional conversion of brightness scale between 0-100 (required by the device) and 0-255 (required by Home Assistant). -Add the following to your `configuration.yaml` file: +Add the following to your {% term "`configuration.yaml`" %} file: {% raw %} diff --git a/source/_integrations/linode.markdown b/source/_integrations/linode.markdown index 5e18b151220..d3e9d820b9c 100644 --- a/source/_integrations/linode.markdown +++ b/source/_integrations/linode.markdown @@ -56,7 +56,7 @@ linode: The `linode` binary sensor platform allows you to monitor your Linode nodes. -Add the following to your `configuration.yaml` file: +Add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -77,7 +77,7 @@ nodes: The `linode` switch platform allows you to turn your Linode nodes on and off. -Add the following to your `configuration.yaml` file: +Add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/lock.mqtt.markdown b/source/_integrations/lock.mqtt.markdown index ea94daec7fc..83dc4571e03 100644 --- a/source/_integrations/lock.mqtt.markdown +++ b/source/_integrations/lock.mqtt.markdown @@ -21,7 +21,7 @@ Optimistic mode can be forced, even if state topic is available. Try to enable i It's mandatory for locks to support `lock` and `unlock`. A lock may optionally support `open`, (e.g. to open the bolt in addition to the latch), in this case, `payload_open` is required in the configuration. If the lock is in optimistic mode, it will change states to `unlocked` when handling the `open` command. An MQTT lock can also report the intermediate states `unlocking`, `locking` or `jammed` if the motor reports a jammed state. -To enable MQTT locks in your installation, add the following to your `configuration.yaml` file: +To enable MQTT locks in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/lock.template.markdown b/source/_integrations/lock.template.markdown index 341c8680440..db5153e48f2 100644 --- a/source/_integrations/lock.template.markdown +++ b/source/_integrations/lock.template.markdown @@ -19,7 +19,7 @@ In optimistic mode, the lock will immediately change state after every command. ## Configuration -To enable Template Locks in your installation, add the following to your `configuration.yaml` file: +To enable Template Locks in your installation, add the following to your {% term "`configuration.yaml`" %} file: {% raw %} diff --git a/source/_integrations/logger.markdown b/source/_integrations/logger.markdown index 48bf62f3773..6fc27a0e667 100644 --- a/source/_integrations/logger.markdown +++ b/source/_integrations/logger.markdown @@ -15,14 +15,14 @@ The `logger` integration lets you define the level of logging activities in Home Assistant. To enable the `logger` integration in your installation, -add the following to your `configuration.yaml` file: +add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry logger: ``` -The log severity level is `warning` if the logger integration is not enabled in `configuration.yaml`. +The log severity level is `warning` if the logger integration is not enabled in {% term "`configuration.yaml`" %}. To log all messages and ignore events lower than critical for specified integrations: diff --git a/source/_integrations/lutron_caseta.markdown b/source/_integrations/lutron_caseta.markdown index ca13682b775..4ca57f96e97 100644 --- a/source/_integrations/lutron_caseta.markdown +++ b/source/_integrations/lutron_caseta.markdown @@ -69,7 +69,7 @@ To use Lutron Caseta devices in your installation, you must first log in to your If you already have `caseta.key`, `caseta.crt`, `caseta-bridge.crt`, and cannot physically access the bridge to press the button, pairing can be done by utilizing these existing files. -Once you have the three necessary files, place them in your configuration directory and add the following to your `configuration.yaml`: +Once you have the three necessary files, place them in your configuration directory and add the following to your {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry From c0c5be1bfdcc9596a61328abda53838b2e41f051 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Tue, 14 May 2024 15:33:20 +0200 Subject: [PATCH 008/103] n-integrations: add glossary reference to config file (#32760) --- source/_integrations/nest.markdown | 16 +++++++-------- source/_integrations/netdata.markdown | 2 +- source/_integrations/network.markdown | 2 +- source/_integrations/nfandroidtv.markdown | 20 +++++++++---------- source/_integrations/notify.rest.markdown | 2 +- source/_integrations/notify.tts.markdown | 2 +- source/_integrations/notify_events.markdown | 2 +- .../_integrations/nsw_fuel_station.markdown | 2 +- source/_integrations/number.mqtt.markdown | 2 +- source/_integrations/nx584.markdown | 2 +- 10 files changed, 26 insertions(+), 26 deletions(-) diff --git a/source/_integrations/nest.markdown b/source/_integrations/nest.markdown index dd3fb8e3072..2568f640bdb 100644 --- a/source/_integrations/nest.markdown +++ b/source/_integrations/nest.markdown @@ -351,12 +351,12 @@ If you are still not getting notifications, you can read this [troubleshooting g {% details "Google Home App Notification Settings" %} -| Google Home App Setting | Notes | -| ------------------------ | :-----------------------------------------------------------------------------------: | -| Notifications: Push | Required for any detection event to be published | -| Notifications: Away-Only | Events will only be published when a user is detected as away from home | -| Seen: Motion | Required for `Motion` events to be published | -| Seen: Person | Required for `Person` events to be published | +| Google Home App Setting | Notes | +| ------------------------ | :---------------------------------------------------------------------: | +| Notifications: Push | Required for any detection event to be published | +| Notifications: Away-Only | Events will only be published when a user is detected as away from home | +| Seen: Motion | Required for `Motion` events to be published | +| Seen: Person | Required for `Person` events to be published | ![Screenshot of Google Home App Notification Settings](/images/integrations/nest/google_home_notification_settings.png) @@ -586,13 +586,13 @@ The *OAuth Client ID* used must be consistent, so check these: - *Error: invalid_client no application name* means the [OAuth Consent Screen](https://console.developers.google.com/apis/credentials/consent) has not been fully configured for the project. Enter the required fields (App Name, Support Email, Developer Email) and leave everything else as default. -- *Subscriber error* means that `configuration.yaml` has an incorrect `subscriber_id` or the subscription is misconfigured. It is recommended to delete this from the configuration, then delete and re-add the integration to let it create a subscription for you. +- *Subscriber error* means that {% term "`configuration.yaml`" %} has an incorrect `subscriber_id` or the subscription is misconfigured. It is recommended to delete this from the configuration, then delete and re-add the integration to let it create a subscription for you. - *Not receiving updates* typically means a problem with the subscriber configuration. Make sure to check the logs for any error messages. Changes for things like sensors or thermostat temperature set points should be instantly published to a topic and received by the Home Assistant subscriber when everything is configured correctly. - You can see stats about your subscriber in the [Cloud Console](https://console.cloud.google.com/cloudpubsub/subscription/list) which includes counts of messages published by your devices, and how many have been acknowledged by your Home Assistant subscriber. You can also `View Messages` to see examples of published. Many old unacknowledged messages indicate the subscriber is not receiving the messages and working properly or not connected at all. -- To aid in diagnosing subscriber problems or camera stream issues it may help to turn up verbose logging by adding some or all of these to your `configuration.yaml` depending on where you are having trouble: +- To aid in diagnosing subscriber problems or camera stream issues it may help to turn up verbose logging by adding some or all of these to your {% term "`configuration.yaml`" %} depending on where you are having trouble: ```yaml diff --git a/source/_integrations/netdata.markdown b/source/_integrations/netdata.markdown index 42870d67453..28b329a1ff0 100644 --- a/source/_integrations/netdata.markdown +++ b/source/_integrations/netdata.markdown @@ -77,7 +77,7 @@ Once the `data_group` "system.load" and the `element` "load15" have been identif ## Configuration -Add the following to your `configuration.yaml`. +Add the following to your {% term "`configuration.yaml`" %}. ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/network.markdown b/source/_integrations/network.markdown index 038d58736c6..93318f70b8d 100644 --- a/source/_integrations/network.markdown +++ b/source/_integrations/network.markdown @@ -28,7 +28,7 @@ If the next-hop cannot be detected or is a loopback address, auto detection will This integration is by default enabled, unless you've disabled or removed the [`default_config:`](/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually: -Add the following section to your `configuration.yaml` file: +Add the following section to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/nfandroidtv.markdown b/source/_integrations/nfandroidtv.markdown index 9cdc365c46a..ae167eb884b 100644 --- a/source/_integrations/nfandroidtv.markdown +++ b/source/_integrations/nfandroidtv.markdown @@ -74,15 +74,15 @@ interrupt: 1 The following attributes can be placed inside `data` to send images and icons. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `image` | yes | Groups the attributes for image upload. If present, either `url` or `path` have to be provided. -| `icon` | yes | Groups the attributes for icon upload. If present, either `url` or `path` have to be provided. -| `path` | yes | Local path of an image file. Is placed inside `image`, `icon` or both. -| `url` | yes | URL of an image file. Is placed inside `image`, `icon` or both. -| `username` | yes | Username if the URL requires authentication. Is placed inside `image`, `icon` or both`. -| `password` | yes | Password if the URL requires authentication. Is placed inside `image`, `icon` or both. -| `auth` | yes | If set to `digest` HTTP-Digest-Authentication is used. If missing, HTTP-BASIC-Authentication is used and is placed inside `image`, `icon` or both. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | +| `image` | yes | Groups the attributes for image upload. If present, either `url` or `path` have to be provided. | +| `icon` | yes | Groups the attributes for icon upload. If present, either `url` or `path` have to be provided. | +| `path` | yes | Local path of an image file. Is placed inside `image`, `icon` or both. | +| `url` | yes | URL of an image file. Is placed inside `image`, `icon` or both. | +| `username` | yes | Username if the URL requires authentication. Is placed inside `image`, `icon` or both`. | +| `password` | yes | Password if the URL requires authentication. Is placed inside `image`, `icon` or both. | +| `auth` | yes | If set to `digest` HTTP-Digest-Authentication is used. If missing, HTTP-BASIC-Authentication is used and is placed inside `image`, `icon` or both. | Example for posting image from URL: @@ -146,4 +146,4 @@ data: {% endraw %} -Please note that `path` is validated against the `allowlist_external_dirs` in the `configuration.yaml`. +Please note that `path` is validated against the `allowlist_external_dirs` in the {% term "`configuration.yaml`" %}. diff --git a/source/_integrations/notify.rest.markdown b/source/_integrations/notify.rest.markdown index 493a1dea1af..a5ac079ae33 100644 --- a/source/_integrations/notify.rest.markdown +++ b/source/_integrations/notify.rest.markdown @@ -9,7 +9,7 @@ ha_domain: rest The `rest` notification platform allows you to deliver [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) notifications from Home Assistant to another party. -To enable the REST notification in your installation, add the following to your `configuration.yaml` file: +To enable the REST notification in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/notify.tts.markdown b/source/_integrations/notify.tts.markdown index eea95023dc7..490371cc652 100644 --- a/source/_integrations/notify.tts.markdown +++ b/source/_integrations/notify.tts.markdown @@ -15,7 +15,7 @@ In order to use this integration, you must already have a TTS platform installed To enable this platform in your installation, consider the following example using [google_translate](/integrations/google_translate/) and an example `media_player.living_room`. -In your `configuration.yaml` file type: +In your {% term "`configuration.yaml`" %} file type: ```yaml notify: diff --git a/source/_integrations/notify_events.markdown b/source/_integrations/notify_events.markdown index 60ada8c75cc..a7c8bdaa469 100644 --- a/source/_integrations/notify_events.markdown +++ b/source/_integrations/notify_events.markdown @@ -41,7 +41,7 @@ To start getting notifications, you need to follow those simple steps: 1. Sign up to [Notify.Events](https://notify.events/) and create a Channel 2. Add **Home Assistant** source to this channel and get your **token** -3. Add the Notify.Events integration to your installation by adding the following to your `configuration.yaml` file: +3. Add the Notify.Events integration to your installation by adding the following to your {% term "`configuration.yaml`" %} file: ```yaml notify_events: diff --git a/source/_integrations/nsw_fuel_station.markdown b/source/_integrations/nsw_fuel_station.markdown index 28aae749533..6071c5ff867 100644 --- a/source/_integrations/nsw_fuel_station.markdown +++ b/source/_integrations/nsw_fuel_station.markdown @@ -32,7 +32,7 @@ Alternatively: ## Configuration -To add the NSW fuel station price sensor to your installation, add the following to your `configuration.yaml` file: +To add the NSW fuel station price sensor to your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml sensor: diff --git a/source/_integrations/number.mqtt.markdown b/source/_integrations/number.mqtt.markdown index 1e7a5c29a3e..b622572b87c 100644 --- a/source/_integrations/number.mqtt.markdown +++ b/source/_integrations/number.mqtt.markdown @@ -12,7 +12,7 @@ The `mqtt` Number platform allows you to integrate devices that might expose con ## Configuration -To enable MQTT Number in your installation, add the following to your `configuration.yaml` file: +To enable MQTT Number in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/nx584.markdown b/source/_integrations/nx584.markdown index 23a44649cb7..ff801f76e5b 100644 --- a/source/_integrations/nx584.markdown +++ b/source/_integrations/nx584.markdown @@ -56,7 +56,7 @@ port: Enabling this binary sensor platform exposes all of your zones as binary sensors, which provides visibility through the UI as well as the ability to trigger automation actions instantly when something happens like a door opening, or a motion sensor trigger. -To enable this feature, add the following lines to your `configuration.yaml`: +To enable this feature, add the following lines to your {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry From 5e853cf251989636ad9406e5c15aea73dd17ab25 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Tue, 14 May 2024 15:34:09 +0200 Subject: [PATCH 009/103] m-integrations: add glossary reference to config file (#32759) --- source/_integrations/matrix.markdown | 2 +- source/_integrations/media_source.markdown | 2 +- source/_integrations/meteoalarm.markdown | 2 +- source/_integrations/mfi.markdown | 2 +- source/_integrations/microsoft_face.markdown | 2 +- source/_integrations/min_max.markdown | 2 +- source/_integrations/minio.markdown | 2 +- source/_integrations/mochad.markdown | 4 ++-- source/_integrations/motioneye.markdown | 2 +- source/_integrations/msteams.markdown | 10 +++++----- source/_integrations/my.markdown | 2 +- source/_integrations/mycroft.markdown | 2 +- 12 files changed, 17 insertions(+), 17 deletions(-) diff --git a/source/_integrations/matrix.markdown b/source/_integrations/matrix.markdown index 278fe2491fe..a94c3500060 100644 --- a/source/_integrations/matrix.markdown +++ b/source/_integrations/matrix.markdown @@ -163,7 +163,7 @@ This configuration will: The `matrix` platform allows you to deliver notifications from Home Assistant to a [Matrix](https://matrix.org/) room. Rooms can be both direct as well as group chats. -To enable Matrix notifications in your installation, you first need to configure the [Matrix integration](#configuration). Then, add the following to your `configuration.yaml` file: +To enable Matrix notifications in your installation, you first need to configure the [Matrix integration](#configuration). Then, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/media_source.markdown b/source/_integrations/media_source.markdown index e00c857c581..fa6260eabb3 100644 --- a/source/_integrations/media_source.markdown +++ b/source/_integrations/media_source.markdown @@ -42,7 +42,7 @@ for example, the Samba add-on. Users of Home Assistant Container can mount a volume of their choice to `/media`. If you are a Home Assistant Core user, the default directory called is called -`media` under the configuration path (where your `configuration.yaml` is located). +`media` under the configuration path (where your {% term "`configuration.yaml`" %} is located). Files served from `media` are protected by Home Assistant authentication unlike those served from `www`. diff --git a/source/_integrations/meteoalarm.markdown b/source/_integrations/meteoalarm.markdown index 10e8a2e4a6c..1f98c75c204 100644 --- a/source/_integrations/meteoalarm.markdown +++ b/source/_integrations/meteoalarm.markdown @@ -19,7 +19,7 @@ The binary sensor state shows the warning message if applicable. The details are ## Configuration -To enable this binary sensor, add the following lines to your `configuration.yaml`: +To enable this binary sensor, add the following lines to your {% term "`configuration.yaml`" %}: ```yaml binary_sensor: diff --git a/source/_integrations/mfi.markdown b/source/_integrations/mfi.markdown index f1083aa5c8b..c243201875f 100644 --- a/source/_integrations/mfi.markdown +++ b/source/_integrations/mfi.markdown @@ -72,7 +72,7 @@ verify_ssl: The `mfi` switch platform to allow you to control [mFi Controllable Power Outlets](https://www.ubnt.com/mfi/mpower/). -To add this platform to your installation, add the following to your `configuration.yaml` file: +To add this platform to your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/microsoft_face.markdown b/source/_integrations/microsoft_face.markdown index a41fb8d96e1..dd2f6a65a2c 100644 --- a/source/_integrations/microsoft_face.markdown +++ b/source/_integrations/microsoft_face.markdown @@ -27,7 +27,7 @@ Please note that all keys on cognitive services must be recreated every 90 days. ## Configuration To enable the Microsoft Face {% term integration %}, -add the following to your `configuration.yaml` file: +add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/min_max.markdown b/source/_integrations/min_max.markdown index 01fbed157ca..43a830e968b 100644 --- a/source/_integrations/min_max.markdown +++ b/source/_integrations/min_max.markdown @@ -39,7 +39,7 @@ Precision: Alternatively, this integration can be configured and set up manually via YAML instead. To enable the Integration sensor in your installation, add the -following to your `configuration.yaml` file: +following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/minio.markdown b/source/_integrations/minio.markdown index 20ae31afb3f..6932373dd74 100644 --- a/source/_integrations/minio.markdown +++ b/source/_integrations/minio.markdown @@ -18,7 +18,7 @@ To download or upload files, folders must be added to [allowlist_external_dirs]( ## Configuration -To enable the Minio integration in your installation, add the following to your `configuration.yaml` file: +To enable the Minio integration in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml minio: diff --git a/source/_integrations/mochad.markdown b/source/_integrations/mochad.markdown index 92a250b71b4..5fafc926e4e 100644 --- a/source/_integrations/mochad.markdown +++ b/source/_integrations/mochad.markdown @@ -62,7 +62,7 @@ mochad: The `mochad` light platform lets you control an X10 enabled dimmer/light device. -To enable this sensor, you first have to set up the [mochad integration](#configuration) and then add the following to your `configuration.yaml` file: +To enable this sensor, you first have to set up the [mochad integration](#configuration) and then add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -99,7 +99,7 @@ brightness_levels: The `mochad` switch platform lets you control an X10 enabled switch device. -To enable this sensor, you first have to set up the [mochad integration](#configuration) and then add the following to your `configuration.yaml` file: +To enable this sensor, you first have to set up the [mochad integration](#configuration) and then add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/motioneye.markdown b/source/_integrations/motioneye.markdown index 52a32384196..04aca2ec904 100644 --- a/source/_integrations/motioneye.markdown +++ b/source/_integrations/motioneye.markdown @@ -405,7 +405,7 @@ An automation to cast stored movie clips to a TV as they arrive. ### Debug Logging To enable debug logging for both the integration and the underlying client library, -enable the following in your `configuration.yaml` and then restart: +enable the following in your {% term "`configuration.yaml`" %} and then restart: ```yaml logger: diff --git a/source/_integrations/msteams.markdown b/source/_integrations/msteams.markdown index db46b193c49..bbe20e2bef7 100644 --- a/source/_integrations/msteams.markdown +++ b/source/_integrations/msteams.markdown @@ -17,12 +17,12 @@ The `Microsoft Teams` platform allows you to send notifications from Home Assist ## Setup -To send a notification to teams, you need to add the Incoming Webhook app to your team channel. When the app is added, you will receive a webhook URL that needs to be added to your `configuration.yaml`. +To send a notification to teams, you need to add the Incoming Webhook app to your team channel. When the app is added, you will receive a webhook URL that needs to be added to your {% term "`configuration.yaml`" %}. ## Configuration -To add the Microsoft Teams platform to your installation, add the following to your `configuration.yaml` file: +To add the Microsoft Teams platform to your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml notify: @@ -46,9 +46,9 @@ url: The following attributes can be placed inside `data` for extended functionality. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `image_url` | yes | Attach an image to the message. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ------------------------------- | +| `image_url` | yes | Attach an image to the message. | The image must be an HTTPS URL, and as outlined by Microsoft in the [Documentation](https://learn.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-reference#common-properties-for-all-cards), the picture must be on a publicly available location. diff --git a/source/_integrations/my.markdown b/source/_integrations/my.markdown index fc650ba001b..07fb231a475 100644 --- a/source/_integrations/my.markdown +++ b/source/_integrations/my.markdown @@ -19,7 +19,7 @@ My Home Assistant allows the documentation to link you to specific pages in your This integration is by default enabled, unless you've disabled or removed the [`default_config:`](/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually: -Add the following section to your `configuration.yaml` file: +Add the following section to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/mycroft.markdown b/source/_integrations/mycroft.markdown index d1b230be3d0..33c91b31f58 100644 --- a/source/_integrations/mycroft.markdown +++ b/source/_integrations/mycroft.markdown @@ -41,7 +41,7 @@ host: ## Using notifications -To use Mycroft for sending notifications, add the following to your `configuration.yaml` file: +To use Mycroft for sending notifications, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry From 42c3b4524bb270b31f3810a82edf67b0d08170c3 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Tue, 14 May 2024 15:40:15 +0200 Subject: [PATCH 010/103] o-r-integrations: add glossary reference to config file (#32761) --- source/_integrations/opensky.markdown | 2 +- source/_integrations/owntracks.markdown | 2 +- source/_integrations/person.markdown | 4 ++-- source/_integrations/pilight.markdown | 6 ++--- source/_integrations/proliphix.markdown | 2 +- source/_integrations/ps4.markdown | 24 +++++++++---------- source/_integrations/python_script.markdown | 22 ++++++++--------- source/_integrations/raincloud.markdown | 6 ++--- source/_integrations/random.markdown | 6 ++--- source/_integrations/recorder.markdown | 20 ++++++++-------- source/_integrations/remote_rpi_gpio.markdown | 2 +- source/_integrations/rflink.markdown | 2 +- source/_integrations/rfxtrx.markdown | 2 +- source/_integrations/ring.markdown | 2 +- 14 files changed, 51 insertions(+), 51 deletions(-) diff --git a/source/_integrations/opensky.markdown b/source/_integrations/opensky.markdown index 0be281206c7..ecc9199afba 100644 --- a/source/_integrations/opensky.markdown +++ b/source/_integrations/opensky.markdown @@ -52,7 +52,7 @@ Both events have two attributes in common: - **longitude**: Longitude of the flight in decimal. - **icao24**: The ICAO 24-bit address of the aircraft's transponder. -To receive notifications of the entering flights using the [Home Assistant Companion App](https://companion.home-assistant.io/), add the following lines to your `configuration.yaml` file: +To receive notifications of the entering flights using the [Home Assistant Companion App](https://companion.home-assistant.io/), add the following lines to your {% term "`configuration.yaml`" %} file: {% raw %} diff --git a/source/_integrations/owntracks.markdown b/source/_integrations/owntracks.markdown index a4b97ae3578..fe09773b832 100644 --- a/source/_integrations/owntracks.markdown +++ b/source/_integrations/owntracks.markdown @@ -53,7 +53,7 @@ By default, the integration listens for incoming messages from OwnTracks via HTT ## Advanced configuration -OwnTracks allows the user to set advanced configuration by adding a section to your `configuration.yaml`. +OwnTracks allows the user to set advanced configuration by adding a section to your {% term "`configuration.yaml`" %}. ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/person.markdown b/source/_integrations/person.markdown index d098505ed26..ac2de5440e1 100644 --- a/source/_integrations/person.markdown +++ b/source/_integrations/person.markdown @@ -30,7 +30,7 @@ In short, when you're at home, your position is determined first by stationary t **Hint**: When you use multiple device trackers together, especially stationary and GPS trackers, it's advisable to set `consider_home` for stationary trackers as low as possible see [device_tracker](/integrations/device_tracker/#configuring-a-device_tracker-platform)). -You can manage persons {% my people title="via the UI from the person page inside the configuration panel" %} or via `YAML` in your `configuration.yaml` file. +You can manage persons {% my people title="via the UI from the person page inside the configuration panel" %} or via `YAML` in your {% term "`configuration.yaml`" %} file. ## Configuring the `person` integration via the Home Assistant configuration panel @@ -42,7 +42,7 @@ person: ## Configuring the `person` integration via YAML -If you prefer YAML, you can also configure your persons via the `configuration.yaml` file: +If you prefer YAML, you can also configure your persons via the {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/pilight.markdown b/source/_integrations/pilight.markdown index 8d070eb7dd9..948ccc27b04 100644 --- a/source/_integrations/pilight.markdown +++ b/source/_integrations/pilight.markdown @@ -89,7 +89,7 @@ pilight: The `pilight` binary sensor platform implements the [pilight hub](#configuration) binary sensor functionality. There are two types of Pilight binary sensor configuration: a normal sensor which sends the on and off cyclical state and a trigger sensor which sends only a trigger when an event happened (for example lots of cheap PIR motion detectors). -To enable a Pilight binary sensor in your installation, add the following to your `configuration.yaml` file: +To enable a Pilight binary sensor in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -156,7 +156,7 @@ binary_sensor: This `pilight` sensor platform for 433 MHz devices uses a value in the message payload as the sensor value. Unique identifiers (e.g., _uuid_) can be set to distinguish between multiple pilight devices. To use a pilight sensor the pilight Home Assistant hub has to be set up. -To use your sensor via pilight, make sure it is [supported](https://manual.pilight.org/protocols/index.html) and add the following to your `configuration.yaml` file: +To use your sensor via pilight, make sure it is [supported](https://manual.pilight.org/protocols/index.html) and add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -222,7 +222,7 @@ Additionally, RF commands can be defined that trigger this switch to turn on and To be really sure that Home Assistant knows the actual state of your device it is recommended to use the RF remote with codes unknown to any of your 433 MHz devices. Thus you use the remote to trigger this switch to send the correct RF code to the device. -To define a Pilight switch, add the following lines to your `configuration.yaml`: +To define a Pilight switch, add the following lines to your {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/proliphix.markdown b/source/_integrations/proliphix.markdown index 500187b8f9e..ea652055267 100644 --- a/source/_integrations/proliphix.markdown +++ b/source/_integrations/proliphix.markdown @@ -17,7 +17,7 @@ Currently supported and tested thermostats: - NT10e -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: ```yaml climate: diff --git a/source/_integrations/ps4.markdown b/source/_integrations/ps4.markdown index 935361aef43..802fdba083b 100644 --- a/source/_integrations/ps4.markdown +++ b/source/_integrations/ps4.markdown @@ -81,7 +81,7 @@ sudo setcap 'cap_net_bind_service=+ep' /usr/bin/python3.5 To find your system Python path: -- Add the [System Health](/integrations/system_health/) integration to your `configuration.yaml`. In a web browser, access your frontend and navigate to the about/logs page "http:///developer-tools/info). In the System Health box, locate the item **python_version** and note the value that is displayed. Then in a terminal run: +- Add the [System Health](/integrations/system_health/) integration to your {% term "`configuration.yaml`" %}. In a web browser, access your frontend and navigate to the about/logs page "http:///developer-tools/info). In the System Health box, locate the item **python_version** and note the value that is displayed. Then in a terminal run: ```bash whereis python @@ -137,7 +137,7 @@ Occasionally, the integration may fail to get the data at all, or may get incorr ### Formatting -When the integration retrieves data from the PlayStation Store, it stores it in a JSON file named `.ps4-games.json` in the same directory as where your `configuration.yaml` file is located. The first line in the file will be `{` and the last line will be `}`. Between these lines, there will be indented entries for each game or app the integration finds. See the following example and table: +When the integration retrieves data from the PlayStation Store, it stores it in a JSON file named `.ps4-games.json` in the same directory as where your {% term "`configuration.yaml`" %} file is located. The first line in the file will be `{` and the last line will be `}`. Between these lines, there will be indented entries for each game or app the integration finds. See the following example and table: ```json { @@ -156,12 +156,12 @@ When the integration retrieves data from the PlayStation Store, it stores it in } ``` -| Field | Value | Description | -| ----- | ----- | ----------- | -| `locked` | boolean | Must be `true` or `false` -| `media_content_type` | string | Must be `game` or `app` -| `media_image_url` | string | Any valid URL for an image -| `media_title` | string | The title of the game or app +| Field | Value | Description | +| -------------------- | ------- | ---------------------------- | +| `locked` | boolean | Must be `true` or `false` | +| `media_content_type` | string | Must be `game` or `app` | +| `media_image_url` | string | Any valid URL for an image | +| `media_title` | string | The title of the game or app | The data in the example shows 2 entries. @@ -182,10 +182,10 @@ To edit, simply open the file in a text editor, find the game or app you would l Opens new application/game and closes currently running application/game. The game/app must be in the entity's source list. Games will be added automatically when you open them normally. -| Service data attribute | Optional | Example | Description | -| ---------------------- | -------- | -------------------------- | ------------------------------------- | -| `entity_id` | No | `media_player.ps4` | The entity id for your PlayStation 4. | -| `source` | No | `Some Game` or `CUSA00123` | The game/app you want to open. You can use the title or SKU ID. Using the SKU ID will be the most reliable.| +| Service data attribute | Optional | Example | Description | +| ---------------------- | -------- | -------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `entity_id` | No | `media_player.ps4` | The entity id for your PlayStation 4. | +| `source` | No | `Some Game` or `CUSA00123` | The game/app you want to open. You can use the title or SKU ID. Using the SKU ID will be the most reliable. | ### Service `send_command` diff --git a/source/_integrations/python_script.markdown b/source/_integrations/python_script.markdown index 0bb9c2ff22d..66d1a42bb9e 100644 --- a/source/_integrations/python_script.markdown +++ b/source/_integrations/python_script.markdown @@ -11,15 +11,15 @@ ha_integration_type: integration This integration allows you to write Python scripts that are exposed as services in Home Assistant. Each Python file created in the `/python_scripts/` folder will be exposed as a service. The content is not cached so you can easily develop: edit file, save changes, call service. The scripts are run in a sandboxed environment. The following variables are available in the sandbox: -| Name | Description | -| ---- | ----------- | -| `hass` | The Home Assistant object. Access is only allowed to call services, set/remove states and fire events. [API reference][hass-api] -| `data` | The data passed to the Python Script service call. -| `logger` | A logger to allow you to log messages: `logger.info()`, `logger.warning()`, `logger.error()`. [API reference][logger-api] -| `time` | The stdlib `time` available as limited access. -| `datetime` | The stdlib `datetime` available as limited access. -| `dt_util` | The ` homeassistant.util.dt` module. -| `output` | An empty dictionary. Add items to return data as [`response_variable`](/docs/scripts/service-calls#use-templates-to-handle-response-data). +| Name | Description | +| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------ | +| `hass` | The Home Assistant object. Access is only allowed to call services, set/remove states and fire events. [API reference][hass-api] | +| `data` | The data passed to the Python Script service call. | +| `logger` | A logger to allow you to log messages: `logger.info()`, `logger.warning()`, `logger.error()`. [API reference][logger-api] | +| `time` | The stdlib `time` available as limited access. | +| `datetime` | The stdlib `datetime` available as limited access. | +| `dt_util` | The ` homeassistant.util.dt` module. | +| `output` | An empty dictionary. Add items to return data as [`response_variable`](/docs/scripts/service-calls#use-templates-to-handle-response-data). | Other imports like `min`, `max` are available as builtins. See the [python_script](https://github.com/home-assistant/core/blob/dev/homeassistant/components/python_script/__init__.py) source code for up-to-date information on the available objects inside the script. @@ -45,7 +45,7 @@ It is created as a first step, to help with: Start by enabling the Python Scripts integration and create the first script. -- Add to `configuration.yaml`: `python_script:` +- Add to {% term "`configuration.yaml`" %}: `python_script:` - Create the folder `/python_scripts` - Create a file `/python_scripts/hello_world.py` in the folder and give it this content: @@ -69,7 +69,7 @@ data: Running this script show absolutely no output on the screen, but it logs with level `info`. You must have the [Logger](/integrations/logger/) enabled at least for level `info`. - Your `configuration.yaml` should include something like this. + Your {% term "`configuration.yaml`" %} should include something like this. ```yaml logger: diff --git a/source/_integrations/raincloud.markdown b/source/_integrations/raincloud.markdown index 8d4526768db..ee8231dda60 100644 --- a/source/_integrations/raincloud.markdown +++ b/source/_integrations/raincloud.markdown @@ -54,7 +54,7 @@ password: ## Binary sensor -Once you have enabled the [Raincloud integration](#configuration), add the following to your `configuration.yaml` file: +Once you have enabled the [Raincloud integration](#configuration), add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -77,7 +77,7 @@ monitored_conditions: ## Sensor -Once you have enabled the [Raincloud integration](#configuration), add the following to your `configuration.yaml` file: +Once you have enabled the [Raincloud integration](#configuration), add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -104,7 +104,7 @@ monitored_conditions: ## Switch -Once you have enabled the [Raincloud integration](#configuration), add the following to your `configuration.yaml` file: +Once you have enabled the [Raincloud integration](#configuration), add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/random.markdown b/source/_integrations/random.markdown index d823cb77c16..0d5b6d63a14 100644 --- a/source/_integrations/random.markdown +++ b/source/_integrations/random.markdown @@ -25,13 +25,13 @@ The `random` integration simply creates random values or state. This can be usef ## Configuration The preferred way to configure random helpers is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}** and select the add button; next, select 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 `default_config:` in your `configuration.yaml`. It should already be there by default unless you removed it. If you removed `default_config:` from your configuration, you must add `random:` to your `configuration.yaml` first, then you can use the UI. +To be able to add Helpers via the user interface, you should have `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 configuration, you must add `random:` to your {% term "`configuration.yaml`" %} first, then you can use the UI. ## Binary sensor The random binary sensor creates random states (`true`, 1, `on` or `false`, 0, `off`). ### YAML configuration -To create the random binary sensor, add the following lines to your `configuration.yaml` file: +To create the random binary sensor, add the following lines to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -51,7 +51,7 @@ name: The random sensor creates random sensor values (integers) out of a given range. Returned values form a [discrete uniform distribution](https://en.wikipedia.org/wiki/Discrete_uniform_distribution), meaning that each integer value in the range configured is equally likely to be drawn. ### YAML configuration -To create the random sensor, add the following lines to your `configuration.yaml` file: +To create the random sensor, add the following lines to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/recorder.markdown b/source/_integrations/recorder.markdown index d1a46d8fd48..2a217e69b81 100644 --- a/source/_integrations/recorder.markdown +++ b/source/_integrations/recorder.markdown @@ -38,7 +38,7 @@ Changing database used by the recorder may result in losing your existing histor
-To change the defaults for the `recorder` integration in your installation, add the following to your `configuration.yaml` file: +To change the defaults for the `recorder` integration in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -208,21 +208,21 @@ recorder: Call the service `recorder.purge` to start a purge task which deletes events and states older than x days, according to `keep_days` service data. Note that purging will not immediately decrease disk space usage but it will significantly slow down further growth. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `keep_days` | yes | The number of history days to keep in recorder database (defaults to the integration `purge_keep_days` configuration) | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `keep_days` | yes | The number of history days to keep in recorder database (defaults to the integration `purge_keep_days` configuration) | | `repack` | yes | When using SQLite or PostgreSQL this will rewrite the entire database. When using MySQL or MariaDB it will optimize or recreate the events and states tables. This is a heavy operation that can cause slowdowns and increased disk space usage while it runs. Only supported by SQLite, PostgreSQL, MySQL and MariaDB. | -| `apply_filter` | yes | Apply entity_id and event_type filter in addition to time based purge. Useful in combination with `include` / `exclude` filter to remove falsely added states and events. Combine with `repack: true` to reduce database size. | +| `apply_filter` | yes | Apply entity_id and event_type filter in addition to time based purge. Useful in combination with `include` / `exclude` filter to remove falsely added states and events. Combine with `repack: true` to reduce database size. | ### Service `purge_entities` Call the service `recorder.purge_entities` to start a task that purges events and states from the recorder database that match any of the specified `entity_id`, `domains`, and `entity_globs` fields. At least one of the three selection criteria fields must be provided. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `entity_id` | yes | A list of entity_ids that should be purged from the recorder database. | -| `domains` | yes | A list of domains that should be purged from the recorder database. | -| `entity_globs` | yes | A list of regular expressions that identify entities to purge from the recorder database. | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------- | +| `entity_id` | yes | A list of entity_ids that should be purged from the recorder database. | +| `domains` | yes | A list of domains that should be purged from the recorder database. | +| `entity_globs` | yes | A list of regular expressions that identify entities to purge from the recorder database. | | `keep_days` | yes | Number of history days to keep in the database of matching rows. The default of 0 days will remove all matching rows. | #### Example automation to remove data rows for specific entities diff --git a/source/_integrations/remote_rpi_gpio.markdown b/source/_integrations/remote_rpi_gpio.markdown index 11240d92841..23d816ca603 100644 --- a/source/_integrations/remote_rpi_gpio.markdown +++ b/source/_integrations/remote_rpi_gpio.markdown @@ -77,7 +77,7 @@ For more details about the GPIO layout, visit the Wikipedia [article](https://en The `remote_rpi_gpio` switch platform allows you to control the GPIOs of a [Remote Raspberry Pi](https://www.raspberrypi.org/). -To use your remote Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file: +To use your remote Raspberry Pi's GPIO in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/rflink.markdown b/source/_integrations/rflink.markdown index c20d59ebaec..5564ba6f5f9 100644 --- a/source/_integrations/rflink.markdown +++ b/source/_integrations/rflink.markdown @@ -161,7 +161,7 @@ This configuration will ignore the button `1` of the `newkaku` device with ID `0 ### Invert cover -Devices can be configure to work in inverted mode by adding option in `configuration.yaml`: +Devices can be configure to work in inverted mode by adding option in {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry for inverted RTS cover diff --git a/source/_integrations/rfxtrx.markdown b/source/_integrations/rfxtrx.markdown index d9d3a68b6d8..a1c876e043b 100644 --- a/source/_integrations/rfxtrx.markdown +++ b/source/_integrations/rfxtrx.markdown @@ -46,7 +46,7 @@ There is currently support for the following device types within Home Assistant: ## Debug logging -To receive debug logging from the RFXCOM device, add the following lines to `configuration.yaml`: +To receive debug logging from the RFXCOM device, add the following lines to {% term "`configuration.yaml`" %}: ```yaml logger: diff --git a/source/_integrations/ring.markdown b/source/_integrations/ring.markdown index 504d469ecf8..9726760b587 100644 --- a/source/_integrations/ring.markdown +++ b/source/_integrations/ring.markdown @@ -106,7 +106,7 @@ You may consider some modifications in the subdirectory and the filename to suit the above modification will save the video file under `/downloads//YYYY-MM/YYYY-MM-DD-at-HH-MM-SS.mp4`. You can change the date according to your localization format. -If you want to use `python_script`, enable it your `configuration.yaml` file first: +If you want to use `python_script`, enable it your {% term "`configuration.yaml`" %} file first: ```yaml python_script: From d545c0bf861a7d06b9e67708d39a92937236f5c8 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Tue, 14 May 2024 16:28:47 +0200 Subject: [PATCH 011/103] s-integrations: add glossary reference to config file (#32762) --- source/_integrations/scene.markdown | 2 +- source/_integrations/scene.mqtt.markdown | 2 +- source/_integrations/schedule.markdown | 2 +- source/_integrations/scsgate.markdown | 8 ++++---- source/_integrations/select.mqtt.markdown | 2 +- source/_integrations/sensor.mqtt.markdown | 4 ++-- source/_integrations/sensor.rest.markdown | 2 +- source/_integrations/serial_pm.markdown | 2 +- source/_integrations/seven_segments.markdown | 2 +- source/_integrations/shelly.markdown | 2 +- source/_integrations/simulated.markdown | 2 +- source/_integrations/siren.mqtt.markdown | 2 +- source/_integrations/sisyphus.markdown | 4 ++-- source/_integrations/smartthings.markdown | 2 +- source/_integrations/smarty.markdown | 2 +- source/_integrations/smtp.markdown | 2 +- source/_integrations/snips.markdown | 4 ++-- source/_integrations/sony_projector.markdown | 2 +- source/_integrations/sql.markdown | 2 +- source/_integrations/stream.markdown | 4 ++-- source/_integrations/supla.markdown | 2 +- source/_integrations/switch.mqtt.markdown | 2 +- source/_integrations/switch.rest.markdown | 2 +- source/_integrations/switch.template.markdown | 2 +- source/_integrations/switchmate.markdown | 2 +- source/_integrations/system_log.markdown | 2 +- 26 files changed, 33 insertions(+), 33 deletions(-) diff --git a/source/_integrations/scene.markdown b/source/_integrations/scene.markdown index 2edbb771e48..2624c9c0685 100644 --- a/source/_integrations/scene.markdown +++ b/source/_integrations/scene.markdown @@ -33,7 +33,7 @@ Some integrations like [Philips Hue](/integrations/hue), [MQTT](/integrations/mq You can create scenes that capture the states you want certain entities to be. For example, a scene can specify that light A should be turned on and light B should be bright red. -Scenes can be created and managed via the user interface using the [Scene Editor](/docs/scene/editor/). They can also be manually configured via `configuration.yaml`. Note that the entity data is not service call parameters, it's a representation of the wanted state: +Scenes can be created and managed via the user interface using the [Scene Editor](/docs/scene/editor/). They can also be manually configured via {% term "`configuration.yaml`" %}. Note that the entity data is not service call parameters, it's a representation of the wanted state: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/scene.mqtt.markdown b/source/_integrations/scene.mqtt.markdown index cb15888dfcf..a2e7212481c 100644 --- a/source/_integrations/scene.mqtt.markdown +++ b/source/_integrations/scene.mqtt.markdown @@ -12,7 +12,7 @@ The `mqtt` scene platform lets you control your MQTT enabled scenes. ## Configuration -To enable a MQTT scene in your installation, add the following to your `configuration.yaml` file: +To enable a MQTT scene in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/schedule.markdown b/source/_integrations/schedule.markdown index 5108df962df..9c3fd47268b 100644 --- a/source/_integrations/schedule.markdown +++ b/source/_integrations/schedule.markdown @@ -23,7 +23,7 @@ and then choose the **{% my config_flow_start domain=schedule title="Schedule" % {% include integrations/config_flow.md %} To be able to add **{% my helpers title="Helpers" %}** via the user interface you should -have `default_config:` in your `configuration.yaml`, it should already +have `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 configuration, diff --git a/source/_integrations/scsgate.markdown b/source/_integrations/scsgate.markdown index 68ba44a7756..22f6debf8ba 100644 --- a/source/_integrations/scsgate.markdown +++ b/source/_integrations/scsgate.markdown @@ -47,7 +47,7 @@ device: The SCSGate integration relies on the [scsgate](https://github.com/flavio/scsgate) Python module. -This module provides also a command line tool called `scs-monitor`. This program can be used to find the IDs of your lights, switches and roller shutters and produce the YAML snippet to insert into your `configuration.yaml` file. +This module provides also a command line tool called `scs-monitor`. This program can be used to find the IDs of your lights, switches and roller shutters and produce the YAML snippet to insert into your {% term "`configuration.yaml`" %} file. For more information checkout [this](https://scsgate.readthedocs.org/en/latest/?badge=latest#creation-of-a-home-assistant-configuration-file) section of `scsgate`'s documentation. @@ -55,7 +55,7 @@ For more information checkout [this](https://scsgate.readthedocs.org/en/latest/? The SCSGate devices can control motorized covers connected to the BTicino MyHome system. -To enable SCSGate covers in your installation, add the following to your `configuration.yaml` file: +To enable SCSGate covers in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -98,7 +98,7 @@ devices: The SCSGate device can control lights of the BTicino MyHome system. -To enable SCSGate lights in your installation, add the following to your `configuration.yaml` file: +To enable SCSGate lights in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -121,7 +121,7 @@ devices: The SCSGate device can control switches of the BTicino MyHome system. -To enable SCSGate switches in your installation, add the following to your `configuration.yaml` file: +To enable SCSGate switches in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/select.mqtt.markdown b/source/_integrations/select.mqtt.markdown index ea7271dbf5e..45424a1b67f 100644 --- a/source/_integrations/select.mqtt.markdown +++ b/source/_integrations/select.mqtt.markdown @@ -12,7 +12,7 @@ The `mqtt` Select platform allows you to integrate devices that might expose con ## Configuration -To enable MQTT Select in your installation, add the following to your `configuration.yaml` file: +To enable MQTT Select in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/sensor.mqtt.markdown b/source/_integrations/sensor.mqtt.markdown index 416a43eec31..d7efb8ebddc 100644 --- a/source/_integrations/sensor.mqtt.markdown +++ b/source/_integrations/sensor.mqtt.markdown @@ -12,7 +12,7 @@ This `mqtt` sensor platform uses the MQTT message payload as the sensor value. I ## Configuration -To use your MQTT sensor in your installation, add the following to your `configuration.yaml` file: +To use your MQTT sensor in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -443,7 +443,7 @@ mqtt: ### Get sensor value from a device with ESPEasy -Assuming that you have flashed your ESP8266 unit with [ESPEasy](https://github.com/letscontrolit/ESPEasy). Under "Config" set a name ("Unit Name:") for your device (here it's "bathroom"). A "Controller" for MQTT with the protocol "OpenHAB MQTT" is present and the entries ("Controller Subscribe:" and "Controller Publish:") are adjusted to match your needs. In this example the topics are prefixed with "home". Please keep in mind that the ESPEasy default topics start with a `/` and only contain the name when writing your entry for the `configuration.yaml` file. +Assuming that you have flashed your ESP8266 unit with [ESPEasy](https://github.com/letscontrolit/ESPEasy). Under "Config" set a name ("Unit Name:") for your device (here it's "bathroom"). A "Controller" for MQTT with the protocol "OpenHAB MQTT" is present and the entries ("Controller Subscribe:" and "Controller Publish:") are adjusted to match your needs. In this example the topics are prefixed with "home". Please keep in mind that the ESPEasy default topics start with a `/` and only contain the name when writing your entry for the {% term "`configuration.yaml`" %} file. - **Controller Subscribe**: `home/%sysname%/#` (instead of `/%sysname%/#`) - **Controller Publish**: `home/%sysname%/%tskname%/%valname%` (instead of `/%sysname%/%tskname%/%valname%`) diff --git a/source/_integrations/sensor.rest.markdown b/source/_integrations/sensor.rest.markdown index 3e0368918e8..0187568e5fe 100644 --- a/source/_integrations/sensor.rest.markdown +++ b/source/_integrations/sensor.rest.markdown @@ -12,7 +12,7 @@ The `rest` sensor platform is consuming a given endpoint which is exposed by a [ _Tip:_ If you want to create multiple `sensors` using the same endpoint, use the [RESTful](/integrations/rest) configuration instructions. -To enable this sensor, add the following lines to your `configuration.yaml` file for a GET request: +To enable this sensor, add the following lines to your {% term "`configuration.yaml`" %} file for a GET request: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/serial_pm.markdown b/source/_integrations/serial_pm.markdown index 3604453576e..bc11162a1f8 100644 --- a/source/_integrations/serial_pm.markdown +++ b/source/_integrations/serial_pm.markdown @@ -30,7 +30,7 @@ At this time, the following sensors are supported: ## Configuration -To use your PM sensor in your installation, add the following to your `configuration.yaml` file: +To use your PM sensor in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml sensor: diff --git a/source/_integrations/seven_segments.markdown b/source/_integrations/seven_segments.markdown index 3d7c4378e06..e50f76bc5a8 100644 --- a/source/_integrations/seven_segments.markdown +++ b/source/_integrations/seven_segments.markdown @@ -115,7 +115,7 @@ It's suggested that the first attempt to determine the needed parameters is usin ssocr -D erosion crop 390 250 490 280 -t 20 -d 4 seven-seg.png ``` -This would lead to the following entry for the `configuration.yaml` file: +This would lead to the following entry for the {% term "`configuration.yaml`" %} file: ```yaml camera: diff --git a/source/_integrations/shelly.markdown b/source/_integrations/shelly.markdown index d9728a66504..33d1d981fb8 100644 --- a/source/_integrations/shelly.markdown +++ b/source/_integrations/shelly.markdown @@ -304,7 +304,7 @@ The `switch` entity in Home Assistant does not support transition states. For th In some cases, it may be needed to customize the CoAP UDP port (default: `5683`) your Home Assistant instance is listening to. -In order to change it, add the following key to your `configuration.yaml`: +In order to change it, add the following key to your {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/simulated.markdown b/source/_integrations/simulated.markdown index 3f64b38dcf7..8da759c5b2f 100644 --- a/source/_integrations/simulated.markdown +++ b/source/_integrations/simulated.markdown @@ -33,7 +33,7 @@ The output will be limited to 3 decimals. ## Configuration -To add a simulated sensor to your installation, add the following to your `configuration.yaml` file: +To add a simulated sensor to your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml sensor: diff --git a/source/_integrations/siren.mqtt.markdown b/source/_integrations/siren.mqtt.markdown index 38a1877ea46..1abbf7ac44b 100644 --- a/source/_integrations/siren.mqtt.markdown +++ b/source/_integrations/siren.mqtt.markdown @@ -18,7 +18,7 @@ When a `state_topic` is not available, the siren will work in optimistic mode. I Optimistic mode can be forced, even if the `state_topic` is available. Try to enable it, if experiencing incorrect operation. -To enable this siren in your installation, add the following to your `configuration.yaml` file: +To enable this siren in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/sisyphus.markdown b/source/_integrations/sisyphus.markdown index e7c7cba1954..68e3a2c2b81 100644 --- a/source/_integrations/sisyphus.markdown +++ b/source/_integrations/sisyphus.markdown @@ -25,14 +25,14 @@ There is currently support for the following device types within Home Assistant: The light and media players will be automatically added for each of your Sisyphus tables, if the Sisyphus integration is configured. -There are two ways to configure this integration. For the automatic discovery of your table(s), add the following to your `configuration.yaml`: +There are two ways to configure this integration. For the automatic discovery of your table(s), add the following to your {% term "`configuration.yaml`" %}: ```yaml # This will auto-detect all Sisyphus tables on your local network. sisyphus: ``` -Auto-detection can be a little slow, so if your table has a fixed IP address or hostname, you may add a list of tables in your `configuration.yaml`. For example: +Auto-detection can be a little slow, so if your table has a fixed IP address or hostname, you may add a list of tables in your {% term "`configuration.yaml`" %}. For example: ```yaml # This will skip auto-detection and add only the listed tables diff --git a/source/_integrations/smartthings.markdown b/source/_integrations/smartthings.markdown index ae88c313e48..61030e8608c 100644 --- a/source/_integrations/smartthings.markdown +++ b/source/_integrations/smartthings.markdown @@ -361,7 +361,7 @@ If you have completed the checklist above and are still unable to setup the plat ### Debugging -The SmartThings integration will log additional information about push updates received, events fired, and other messages when the log level is set to `debug`. Add the relevant line below to the `configuration.yaml`: +The SmartThings integration will log additional information about push updates received, events fired, and other messages when the log level is set to `debug`. Add the relevant line below to the {% term "`configuration.yaml`" %}: ```yaml logger: diff --git a/source/_integrations/smarty.markdown b/source/_integrations/smarty.markdown index d8627084a65..b364d410787 100644 --- a/source/_integrations/smarty.markdown +++ b/source/_integrations/smarty.markdown @@ -37,7 +37,7 @@ The integration has a fan platform to view and control the ventilation speed, an ## Configuration -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: ```yaml smarty: diff --git a/source/_integrations/smtp.markdown b/source/_integrations/smtp.markdown index a6eec4e2f51..d89b6be3e19 100644 --- a/source/_integrations/smtp.markdown +++ b/source/_integrations/smtp.markdown @@ -13,7 +13,7 @@ ha_integration_type: integration The SMTP platform allows you to deliver notifications from Home Assistant to an email recipient. -To enable notification by email in your installation, add the following to your `configuration.yaml` file: +To enable notification by email in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/snips.markdown b/source/_integrations/snips.markdown index dd16994f07f..ecba5b734d4 100644 --- a/source/_integrations/snips.markdown +++ b/source/_integrations/snips.markdown @@ -95,7 +95,7 @@ followed by a command, e.g. _Set the lights to green in the living room_ -As the Snips Platform parses this query into an intent, it will be published on MQTT, on the `hermes/intent/` topic. The Snips Home Assistant integration subscribes to this topic, and handles the intent according to the rules defined in `configuration.yaml` file, as explained below. +As the Snips Platform parses this query into an intent, it will be published on MQTT, on the `hermes/intent/` topic. The Snips Home Assistant integration subscribes to this topic, and handles the intent according to the rules defined in {% term "`configuration.yaml`" %} file, as explained below. #### Optional: specifying an external MQTT broker @@ -121,7 +121,7 @@ probability_threshold: ### Specifying the MQTT broker -Messages between Snips and Home Assistant are passed via MQTT. We can either point Snips to the MQTT broker used by Home Assistant, as explained above, or tell Home Assistant which [MQTT broker](/integrations/mqtt) to use by adding the following entry to the `configuration.yaml` file: +Messages between Snips and Home Assistant are passed via MQTT. We can either point Snips to the MQTT broker used by Home Assistant, as explained above, or tell Home Assistant which [MQTT broker](/integrations/mqtt) to use by adding the following entry to the {% term "`configuration.yaml`" %} file: ```yaml mqtt: diff --git a/source/_integrations/sony_projector.markdown b/source/_integrations/sony_projector.markdown index 4f1b276a8a7..1080e3cc90c 100644 --- a/source/_integrations/sony_projector.markdown +++ b/source/_integrations/sony_projector.markdown @@ -15,7 +15,7 @@ The `sony_projector` switch platform allows you to control the state of SDCP com ## Configuration -To use your Sony Projector in your installation, add the following to your `configuration.yaml` file: +To use your Sony Projector in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/sql.markdown b/source/_integrations/sql.markdown index 8632b650582..171807c3fa2 100644 --- a/source/_integrations/sql.markdown +++ b/source/_integrations/sql.markdown @@ -28,7 +28,7 @@ This can be used to present statistics about Home Assistant sensors if used with ## Configuration by YAML -To configure this sensor, define the sensor connection variables and a list of queries to your `configuration.yaml` file. A sensor will be created for each query. +To configure this sensor, define the sensor connection variables and a list of queries to your {% term "`configuration.yaml`" %} file. A sensor will be created for each query. To enable it, add the following lines to your {% term "`configuration.yaml`" %} file. {% include integrations/restart_ha_after_config_inclusion.md %} diff --git a/source/_integrations/stream.markdown b/source/_integrations/stream.markdown index fe21afef397..f988ec07dd0 100644 --- a/source/_integrations/stream.markdown +++ b/source/_integrations/stream.markdown @@ -20,7 +20,7 @@ The stream integration provides a way to proxy live streams through Home Assista ## Configuration -The `stream` integration is automatically loaded by `default_config` and enabled by the `camera` platforms that support it. If `default_config` is used, no separate `configuration.yaml` entry is necessary. However, there are some extra options you can configure. +The `stream` integration is automatically loaded by `default_config` and enabled by the `camera` platforms that support it. If `default_config` is used, no separate {% term "`configuration.yaml`" %} entry is necessary. However, there are some extra options you can configure. {% configuration %} ll_hls: @@ -44,7 +44,7 @@ part_duration: LL-HLS reduces the start time and delay for a stream, but it has strict timing and network requirements and opens additional browser connections. To avoid running into browser limits it is strongly recommended to use an HTTP/2 proxy (e.g., NGINX or haproxy) to take advantage of request pipelining. LL-HLS is enabled by default, but when not using HTTP/2, the Home Assistant frontend will revert back to regular HLS if too many streams are open. -You can further adjust LL-HLS settings in `configuration.yaml` as it may perform better or worse with different values depending on your network setup, cameras, or whether or not they are local or cloud. +You can further adjust LL-HLS settings in {% term "`configuration.yaml`" %} as it may perform better or worse with different values depending on your network setup, cameras, or whether or not they are local or cloud. Example configuration: diff --git a/source/_integrations/supla.markdown b/source/_integrations/supla.markdown index ae0d209bcf6..e80c5bc3a13 100644 --- a/source/_integrations/supla.markdown +++ b/source/_integrations/supla.markdown @@ -27,7 +27,7 @@ For more complete Home Assistant support based on MQTT autodiscovery, consider s ## Configuration -To use SUPLA devices in your installation, add the following to your `configuration.yaml`: +To use SUPLA devices in your installation, add the following to your {% term "`configuration.yaml`" %}: ```yaml supla: diff --git a/source/_integrations/switch.mqtt.markdown b/source/_integrations/switch.mqtt.markdown index 09f382a7426..91fee50bf0a 100644 --- a/source/_integrations/switch.mqtt.markdown +++ b/source/_integrations/switch.mqtt.markdown @@ -18,7 +18,7 @@ When a `state_topic` is not available, the switch will work in optimistic mode. Optimistic mode can be forced, even if the `state_topic` is available. Try to enable it, if experiencing incorrect switch operation. -To enable this switch in your installation, add the following to your `configuration.yaml` file: +To enable this switch in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/switch.rest.markdown b/source/_integrations/switch.rest.markdown index 4741bc8a318..17bb503a0e7 100644 --- a/source/_integrations/switch.rest.markdown +++ b/source/_integrations/switch.rest.markdown @@ -12,7 +12,7 @@ The `rest` switch platform allows you to control a given endpoint that supports ## Configuration -To enable this switch, add the following lines to your `configuration.yaml` file: +To enable this switch, add the following lines to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/switch.template.markdown b/source/_integrations/switch.template.markdown index ce922110ae0..c5c067d5e75 100644 --- a/source/_integrations/switch.template.markdown +++ b/source/_integrations/switch.template.markdown @@ -17,7 +17,7 @@ This can simplify the GUI and make it easier to write automations. ## Configuration -To enable Template Switches in your installation, add the following to your `configuration.yaml` file: +To enable Template Switches in your installation, add the following to your {% term "`configuration.yaml`" %} file: {% raw %} diff --git a/source/_integrations/switchmate.markdown b/source/_integrations/switchmate.markdown index f5e3d4c4d02..3ac095cabfc 100644 --- a/source/_integrations/switchmate.markdown +++ b/source/_integrations/switchmate.markdown @@ -18,7 +18,7 @@ This `Switchmate` switch platform allows you to control Switchmate [devices]( ht ## Configuration -To enable it, add the following lines to your `configuration.yaml`: +To enable it, add the following lines to your {% term "`configuration.yaml`" %}: ```yaml switch: diff --git a/source/_integrations/system_log.markdown b/source/_integrations/system_log.markdown index 54b10291d65..14db0ffcf2d 100644 --- a/source/_integrations/system_log.markdown +++ b/source/_integrations/system_log.markdown @@ -13,7 +13,7 @@ The `system_log` integration stores information about all logged errors and warn ## Configuration -This integration is automatically loaded by the `frontend` (so no need to do anything if you are using the frontend). If you are not doing so, or if you wish to change a parameter, add the following section to your `configuration.yaml` file: +This integration is automatically loaded by the `frontend` (so no need to do anything if you are using the frontend). If you are not doing so, or if you wish to change a parameter, add the following section to your {% term "`configuration.yaml`" %} file: ```yaml system_log: From d234271c54109354a2a41188a0d9a1ffe3c503d1 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Tue, 14 May 2024 16:38:47 +0200 Subject: [PATCH 012/103] u-z-integrations: add glossary reference to config file (#32764) --- source/_integrations/ubus.markdown | 4 ++-- source/_integrations/ue_smart_radio.markdown | 2 +- source/_integrations/uk_transport.markdown | 4 ++-- source/_integrations/unifi_direct.markdown | 2 +- source/_integrations/universal.markdown | 2 +- source/_integrations/upb.markdown | 2 +- source/_integrations/upc_connect.markdown | 2 +- source/_integrations/update.mqtt.markdown | 2 +- source/_integrations/usb.markdown | 2 +- source/_integrations/usgs_earthquakes_feed.markdown | 2 +- source/_integrations/utility_meter.markdown | 2 +- source/_integrations/uvc.markdown | 2 +- source/_integrations/valve.mqtt.markdown | 4 ++-- source/_integrations/vizio.markdown | 4 ++-- source/_integrations/vultr.markdown | 10 +++++----- source/_integrations/w800rf32.markdown | 2 +- source/_integrations/wake_on_lan.markdown | 2 +- source/_integrations/water_heater.markdown | 2 +- source/_integrations/water_heater.mqtt.markdown | 2 +- source/_integrations/weather.template.markdown | 2 +- source/_integrations/wirelesstag.markdown | 6 +++--- source/_integrations/xbox.markdown | 2 +- source/_integrations/xiaomi_miio.markdown | 6 +++--- source/_integrations/zabbix.markdown | 2 +- source/_integrations/zestimate.markdown | 2 +- source/_integrations/zha.markdown | 8 ++++---- source/_integrations/zhong_hong.markdown | 2 +- source/_integrations/zone.markdown | 2 +- source/_integrations/zoneminder.markdown | 6 +++--- 29 files changed, 46 insertions(+), 46 deletions(-) diff --git a/source/_integrations/ubus.markdown b/source/_integrations/ubus.markdown index 4571e82e39e..4b915e075c7 100644 --- a/source/_integrations/ubus.markdown +++ b/source/_integrations/ubus.markdown @@ -66,7 +66,7 @@ Check if the `file` namespaces is registered with the RPC server. file ``` -After this is done, add the following to your `configuration.yaml` file: +After this is done, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -106,7 +106,7 @@ If you find that this never creates `known_devices.yaml`, or if you need more in ### Increase log level 1. On your Home Assistant device, stop Home Assistant -2. Adjust `configuration.yaml` to log more detail for the `device_tracker` integration. +2. Adjust {% term "`configuration.yaml`" %} to log more detail for the `device_tracker` integration. ```yaml logger: diff --git a/source/_integrations/ue_smart_radio.markdown b/source/_integrations/ue_smart_radio.markdown index da0cc8d87ce..3f80548b0d6 100644 --- a/source/_integrations/ue_smart_radio.markdown +++ b/source/_integrations/ue_smart_radio.markdown @@ -13,7 +13,7 @@ ha_integration_type: integration The `ue_radio` platform allows you to control a [Logitech UE Smart Radio](https://www.uesmartradio.com) from Home Assistant. This lets you control both Logitech UE Smart Radios and Logitech Squeezebox Radios that have been updated with the UE Smart Radio update. -To add your UE Smart Radio player to your installation, add the following to your `configuration.yaml` file: +To add your UE Smart Radio player to your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/uk_transport.markdown b/source/_integrations/uk_transport.markdown index df549398783..e8f991bd129 100644 --- a/source/_integrations/uk_transport.markdown +++ b/source/_integrations/uk_transport.markdown @@ -23,7 +23,7 @@ Queries are entered as a list, with the two transport modes available being `bus Train departure sensors require three character long `origin` and `destination` station codes which are searchable on the [National Rail enquiries](https://www.nationalrail.co.uk/times_fares/ldb.aspx) website (e.g., `WAT` is London Waterloo). The validity of a route can be checked by performing a GET request to `/uk/train/station/{station_code}/live.json` in the [API reference webpage](https://developer.transportapi.com/docs?raml=https://transportapi.com/v3/raml/transportapi.raml#request_uk_train_station_station_code_live_json). -To add a single train departure sensor add the following to your `configuration.yaml` file: +To add a single train departure sensor add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry for a single sensor @@ -114,7 +114,7 @@ follows: 3. Tick the 'map data' layer, and wait for clickable objects to load. 4. Click the bus stop node to reveal its tags on the left. -The `destination` must be a valid location in the "direction" field returned by a GET query to `/uk/bus/stop/{atcocode}/live.json` as described in the [API reference webpage](https://developer.transportapi.com/docs?raml=https://transportapi.com/v3/raml/transportapi.raml##bus_information). A bus sensor is added in the following `configuration.yaml` file entry: +The `destination` must be a valid location in the "direction" field returned by a GET query to `/uk/bus/stop/{atcocode}/live.json` as described in the [API reference webpage](https://developer.transportapi.com/docs?raml=https://transportapi.com/v3/raml/transportapi.raml##bus_information). A bus sensor is added in the following {% term "`configuration.yaml`" %} file entry: ```yaml # Example configuration.yaml entry for multiple sensors diff --git a/source/_integrations/unifi_direct.markdown b/source/_integrations/unifi_direct.markdown index 44b835b7b6b..f352e1c0836 100644 --- a/source/_integrations/unifi_direct.markdown +++ b/source/_integrations/unifi_direct.markdown @@ -15,7 +15,7 @@ ha_codeowners: This platform allows you to detect presence by looking at devices connected to a [UniFi AP](https://www.ui.com/products/#unifi). This device tracker differs from [Ubiquiti UniFi](/integrations/unifi) because it doesn't require the UniFi Network application. -To use this device tracker in your installation, add the following to your `configuration.yaml` file: +To use this device tracker in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/universal.markdown b/source/_integrations/universal.markdown index b2fb1e6959d..1c0ccc78567 100644 --- a/source/_integrations/universal.markdown +++ b/source/_integrations/universal.markdown @@ -16,7 +16,7 @@ A universal media player can combine multiple existing entities in Home Assistan Multiple media player entities may be controlled from a universal media player. Additionally, the universal media player can enable volume and power commands to be directed to other Home Assistant entities. This enables the media player power and volume commands to control devices like a television, amplifier or audio receiver, for example. -A universal media player is created in `configuration.yaml` as follows. +A universal media player is created in {% term "`configuration.yaml`" %} as follows. ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/upb.markdown b/source/_integrations/upb.markdown index b87d4828a5d..f5c3fc787b6 100644 --- a/source/_integrations/upb.markdown +++ b/source/_integrations/upb.markdown @@ -235,7 +235,7 @@ kitchen_fade_on: ## Debugging -Debug logs are often required to solve an issue. To enable UPB debug logs add the following to your `configuration.yaml` file in your Home Assistant `config` directory: +Debug logs are often required to solve an issue. To enable UPB debug logs add the following to your {% term "`configuration.yaml`" %} file in your Home Assistant `config` directory: ```yaml logger: diff --git a/source/_integrations/upc_connect.markdown b/source/_integrations/upc_connect.markdown index d53eb8e69aa..ed7f39fa541 100644 --- a/source/_integrations/upc_connect.markdown +++ b/source/_integrations/upc_connect.markdown @@ -20,7 +20,7 @@ The `upc_connect` platform offers presence detection by looking at connected dev This integration works by logging into the router with a password. The router can only have one active session at any time, so if you want to access your router settings then stop Home Assistant first.
-To use a Connect Box in your installation, add the following to your `configuration.yaml` file: +To use a Connect Box in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/update.mqtt.markdown b/source/_integrations/update.mqtt.markdown index fbc6b890617..9c2fa161468 100644 --- a/source/_integrations/update.mqtt.markdown +++ b/source/_integrations/update.mqtt.markdown @@ -12,7 +12,7 @@ The `mqtt` Update platform allows you to integrate devices that might expose fir ## Configuration -To enable MQTT Update in your installation, add the following to your `configuration.yaml` file: +To enable MQTT Update in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/usb.markdown b/source/_integrations/usb.markdown index 1345f1d282d..be2896831f0 100644 --- a/source/_integrations/usb.markdown +++ b/source/_integrations/usb.markdown @@ -20,7 +20,7 @@ The **USB Discovery** {% term integration %} will detect newly connected USB dev ## Configuration -This {% term integration %} is part of [`default_config:`](/integrations/default_config/) if you have opted to not use [`default_config:`](/integrations/default_config/)you can add this {% term integration %} by adding the following lines to your `configuration.yaml` +This {% term integration %} is part of [`default_config:`](/integrations/default_config/) if you have opted to not use [`default_config:`](/integrations/default_config/)you can add this {% term integration %} by adding the following lines to your {% term "`configuration.yaml`" %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/usgs_earthquakes_feed.markdown b/source/_integrations/usgs_earthquakes_feed.markdown index 825a7376bae..8eaee34241e 100644 --- a/source/_integrations/usgs_earthquakes_feed.markdown +++ b/source/_integrations/usgs_earthquakes_feed.markdown @@ -29,7 +29,7 @@ The data is updated every 5 minutes. ## Configuration -To integrate the U.S. Geological Survey Earthquake Hazards Program feed, add the following lines to your `configuration.yaml`. +To integrate the U.S. Geological Survey Earthquake Hazards Program feed, add the following lines to your {% term "`configuration.yaml`" %}. ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/utility_meter.markdown b/source/_integrations/utility_meter.markdown index b21a08b2054..10b157114d5 100644 --- a/source/_integrations/utility_meter.markdown +++ b/source/_integrations/utility_meter.markdown @@ -72,7 +72,7 @@ that provide a greater flexibility. Alternatively, this {% term integration %} can be configured and set up manually via YAML instead. To enable the Integration sensor in your installation, add the -following to your `configuration.yaml` file: +following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/uvc.markdown b/source/_integrations/uvc.markdown index d9ec5f8be5b..6722d49b2b8 100644 --- a/source/_integrations/uvc.markdown +++ b/source/_integrations/uvc.markdown @@ -24,7 +24,7 @@ It is recommended that you create a new user for this platform in the NVR softwa ### Configuration -To enable, add the following to your `configuration.yaml` file: +To enable, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/valve.mqtt.markdown b/source/_integrations/valve.mqtt.markdown index 5c546886b98..ec55dd3097f 100644 --- a/source/_integrations/valve.mqtt.markdown +++ b/source/_integrations/valve.mqtt.markdown @@ -18,7 +18,7 @@ A valve entity can be have the following states: `open`, `opening`, `closed` or If a `state_topic` is configured, the entity's state will be updated only after an MQTT message is received on `state_topic` matching `state_open`, `state_opening`, `state_closed` or `state_closing`. Commands configured through `payload_open`, `payload_closed`, and `payload_stop` will be published to `command_topic` to control the valve. -To use your MQTT valve in your installation, add the following to your `configuration.yaml` file: +To use your MQTT valve in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry for a value that is set by open or close command @@ -40,7 +40,7 @@ Example of a JSON state update: The wanted position value or `payload_stop` will be published to `command_topic` to control the valve when the services `valve.open`, `value.close`, or `value.set_position` are called. -To use your MQTT valve in your installation, add the following to your `configuration.yaml` file: +To use your MQTT valve in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry for a valve that reports position diff --git a/source/_integrations/vizio.markdown b/source/_integrations/vizio.markdown index 558f48de7c5..d845eb8ffa8 100644 --- a/source/_integrations/vizio.markdown +++ b/source/_integrations/vizio.markdown @@ -104,7 +104,7 @@ You will need the authentication token returned by this command to configure Hom ## Configuration -To add your VIZIO TV to your installation, add the following to your `configuration.yaml` file: +To add your VIZIO TV to your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -204,7 +204,7 @@ vizio: ### Obtaining an app configuration -If there is an app you want to be able to launch from Home Assistant that isn't detected by default, you will need to specify the app configuration in `configuration.yaml`. This configuration can be obtained from the `app_id` state attribute when an unknown app is running on your device. +If there is an app you want to be able to launch from Home Assistant that isn't detected by default, you will need to specify the app configuration in {% term "`configuration.yaml`" %}. This configuration can be obtained from the `app_id` state attribute when an unknown app is running on your device. ### Obtaining a list of valid apps to include or exclude diff --git a/source/_integrations/vultr.markdown b/source/_integrations/vultr.markdown index 70d9ff34409..abd76fbe334 100644 --- a/source/_integrations/vultr.markdown +++ b/source/_integrations/vultr.markdown @@ -88,7 +88,7 @@ name: ### Full example -Full `configuration.yaml` (produces `binary_sensor.totally_awesome_server`): +Full {% term "`configuration.yaml`" %} (produces `binary_sensor.totally_awesome_server`): ```yaml binary_sensor: @@ -109,7 +109,7 @@ The following examples assume a subscription that has an ID of `123456` and a la
-Minimal `configuration.yaml` (produces `sensor.vultr_web_server_current_bandwidth_used` and `sensor.vultr_web_server_pending_charges`): +Minimal {% term "`configuration.yaml`" %} (produces `sensor.vultr_web_server_current_bandwidth_used` and `sensor.vultr_web_server_pending_charges`): ```yaml sensor: @@ -139,7 +139,7 @@ monitored_conditions: description: The current (invoice period) charges that have built up for this subscription. Value is in US Dollars (US$). {% endconfiguration %} -Full `configuration.yaml` using `{}` to format condition name (produces `sensor.server_current_bandwidth_gb` and `sensor.server_pending_charges`): +Full {% term "`configuration.yaml`" %} using `{}` to format condition name (produces `sensor.server_current_bandwidth_gb` and `sensor.server_pending_charges`): ```yaml sensor: @@ -151,7 +151,7 @@ sensor: - pending_charges ``` -Custom `configuration.yaml` with only one condition monitored (produces `sensor.web_server_bandwidth`): +Custom {% term "`configuration.yaml`" %} with only one condition monitored (produces `sensor.web_server_bandwidth`): ```yaml sensor: @@ -170,7 +170,7 @@ To control your Vultr subscription, you first have to set up your Vultr hub. ### Configuration -Minimal `configuration.yaml` (produces `switch.vultr_web_server`): +Minimal {% term "`configuration.yaml`" %} (produces `switch.vultr_web_server`): ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/w800rf32.markdown b/source/_integrations/w800rf32.markdown index 6d39f942aee..6a339d39ff2 100644 --- a/source/_integrations/w800rf32.markdown +++ b/source/_integrations/w800rf32.markdown @@ -43,7 +43,7 @@ The `w800rf32` platform supports X10 RF binary sensors such as Palm Pad remotes, ## Setting up your devices -Once you have set up your [w800rf32 hub](/integrations/w800rf32/), add the binary sensors to your `configuration.yaml`: +Once you have set up your [w800rf32 hub](/integrations/w800rf32/), add the binary sensors to your {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/wake_on_lan.markdown b/source/_integrations/wake_on_lan.markdown index 2232b1069df..206d51deaca 100644 --- a/source/_integrations/wake_on_lan.markdown +++ b/source/_integrations/wake_on_lan.markdown @@ -70,7 +70,7 @@ The WOL switch can only turn on your computer and monitor the state. There is no It's required that the binary `ping` is in your `$PATH`. -To enable this switch in your installation, add the following to your `configuration.yaml` file: +To enable this switch in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/water_heater.markdown b/source/_integrations/water_heater.markdown index 98ac0686bab..be9c62129d1 100644 --- a/source/_integrations/water_heater.markdown +++ b/source/_integrations/water_heater.markdown @@ -12,7 +12,7 @@ ha_integration_type: entity The **Water heater** {% term integration %} is built for the controlling and monitoring of hot water heaters. -To enable this {% term integration %}, pick one of the platforms, and add it to your `configuration.yaml`: +To enable this {% term integration %}, pick one of the platforms, and add it to your {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/water_heater.mqtt.markdown b/source/_integrations/water_heater.mqtt.markdown index c7d81b811af..bf9eefa8420 100644 --- a/source/_integrations/water_heater.mqtt.markdown +++ b/source/_integrations/water_heater.mqtt.markdown @@ -12,7 +12,7 @@ The `mqtt` water heater platform lets you control your MQTT enabled water heater ## Configuration -To enable this water heater platform in your installation, first add the following to your `configuration.yaml` file: +To enable this water heater platform in your installation, first add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/weather.template.markdown b/source/_integrations/weather.template.markdown index b5c8c7cb655..690843bdc26 100644 --- a/source/_integrations/weather.template.markdown +++ b/source/_integrations/weather.template.markdown @@ -19,7 +19,7 @@ Output will be converted according to the user's unit system or {% term entity % ## Configuration -To enable a Template Weather provider in your installation, add the following to your `configuration.yaml` file: +To enable a Template Weather provider in your installation, add the following to your {% term "`configuration.yaml`" %} file: (Note, be sure to update my_region in the condition and forecast templates to an appropriate value for your setup). diff --git a/source/_integrations/wirelesstag.markdown b/source/_integrations/wirelesstag.markdown index 7774e25fc38..2a11074631f 100644 --- a/source/_integrations/wirelesstag.markdown +++ b/source/_integrations/wirelesstag.markdown @@ -54,7 +54,7 @@ password: ## Binary sensor -To enable the binary sensor platform for your tags, set up with your [wirelesstag.net](https://wirelesstag.net/) account. Add the following to your `configuration.yaml` file: +To enable the binary sensor platform for your tags, set up with your [wirelesstag.net](https://wirelesstag.net/) account. Add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -96,7 +96,7 @@ monitored_conditions: ## Sensor -To enable the sensor platform for your tags, set up with your [wirelesstag.net](https://wirelesstag.net/) account. Add the following to your `configuration.yaml` file: +To enable the sensor platform for your tags, set up with your [wirelesstag.net](https://wirelesstag.net/) account. Add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -127,7 +127,7 @@ monitored_conditions: ## Switch -To enable the switch platform for your tags, set up with your [wirelesstag.net](https://wirelesstag.net/) account. Add the following to your `configuration.yaml` file: +To enable the switch platform for your tags, set up with your [wirelesstag.net](https://wirelesstag.net/) account. Add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/xbox.markdown b/source/_integrations/xbox.markdown index efdc87dda0d..7db8af298f2 100644 --- a/source/_integrations/xbox.markdown +++ b/source/_integrations/xbox.markdown @@ -30,7 +30,7 @@ Note that for the media player and remote entities to be added your Xbox will ne
-Because it uses the Home Assistant Cloud account linking service you **must** have either `cloud:` or `default_config:` in your `configuration.yaml`. +Because it uses the Home Assistant Cloud account linking service you **must** have either `cloud:` or `default_config:` in your {% term "`configuration.yaml`" %}.
diff --git a/source/_integrations/xiaomi_miio.markdown b/source/_integrations/xiaomi_miio.markdown index 436c5e4aca9..c2813807e7d 100644 --- a/source/_integrations/xiaomi_miio.markdown +++ b/source/_integrations/xiaomi_miio.markdown @@ -179,7 +179,7 @@ The `xiaomi_miio` device tracker platform is observing your Xiaomi Mi WiFi Repea Please follow the instructions on [Retrieving the Access Token](/integrations/xiaomi_miio/#retrieving-the-access-token) to get the API token. -To add a Xiaomi Mi WiFi Repeater device tracker to your installation, add the following to your `configuration.yaml` file: +To add a Xiaomi Mi WiFi Repeater device tracker to your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml device_tracker: @@ -1232,11 +1232,11 @@ The `xiaomi miio` remote platform allows you to send IR commands from your Xiaom ### Setup -Please follow the instructions on [Retrieving the Access Token](/integrations/xiaomi_miio/#retrieving-the-access-token) to get the API token to use in the `configuration.yaml` file. +Please follow the instructions on [Retrieving the Access Token](/integrations/xiaomi_miio/#retrieving-the-access-token) to get the API token to use in the {% term "`configuration.yaml`" %} file. ### Configuring the Platform -To add a Xiaomi IR Remote to your installation, add the following to your `configuration.yaml` file: +To add a Xiaomi IR Remote to your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml remote: diff --git a/source/_integrations/zabbix.markdown b/source/_integrations/zabbix.markdown index 4aef704bbcd..fe5ef010379 100644 --- a/source/_integrations/zabbix.markdown +++ b/source/_integrations/zabbix.markdown @@ -148,7 +148,7 @@ The `zabbix` sensor platform let you monitor the current count of active trigger You must have the Zabbix integration configured to use those sensors. -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: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/zestimate.markdown b/source/_integrations/zestimate.markdown index 345614f771b..d05697c03ba 100644 --- a/source/_integrations/zestimate.markdown +++ b/source/_integrations/zestimate.markdown @@ -21,7 +21,7 @@ You will need to sign up for the Zillow API at the following link [Zillow API](h For example, the White House zpid is 84074482 and can be found in its Zillow URL: [https://www.zillow.com/homedetails/1600-Pennsylvania-Ave-NW-Washington-DC-20006/84074482_zpid/](https://www.zillow.com/homedetails/1600-Pennsylvania-Ave-NW-Washington-DC-20006/84074482_zpid/) -To enable this sensor, add the following lines to your `configuration.yaml`. +To enable this sensor, add the following lines to your {% term "`configuration.yaml`" %}. ```yaml sensor: diff --git a/source/_integrations/zha.markdown b/source/_integrations/zha.markdown index 2a16e3f1761..05a15875915 100644 --- a/source/_integrations/zha.markdown +++ b/source/_integrations/zha.markdown @@ -223,7 +223,7 @@ Additional devices in the [Known working Zigbee radio modules](#known-working-zi ## Configuration - YAML -For more advanced configuration, you can modify `configuration.yaml` and restart Home Assistant +For more advanced configuration, you can modify {% term "`configuration.yaml`" %} and restart Home Assistant {% configuration %} database_path: @@ -247,7 +247,7 @@ The ZHA {% term integration %} has the ability to automatically download and per Online OTA providers for firmware updates are currently only available for IKEA, LEDVANCE/OSRAM, SALUS/Computime, and INOVELLI devices. Support for OTA updates from other manufacturers could be supported in the future if they publish their firmware images publicly. -To enable OTA firmware updates for the ZHA {% term integration %} you need to add the following configuration to your `configuration.yaml` and restart Home Assistant: +To enable OTA firmware updates for the ZHA {% term integration %} you need to add the following configuration to your {% term "`configuration.yaml`" %} and restart Home Assistant: ```yaml zha: @@ -308,7 +308,7 @@ The general recommendation is to only use channels 15, 20, or 25 in order to avo As not all device manufacturers follow the Zigbee standard, at times a device can be incorrectly classified. For example, a switch could be classified as a light. -To correct the device type, also called domain, add the following to your `configuration.yaml` and restart Home Assistant: +To correct the device type, also called domain, add the following to your {% term "`configuration.yaml`" %} and restart Home Assistant: ```yaml zha: @@ -632,7 +632,7 @@ Note: Please also make sure you give it your best effort to follow the recommend ### Debug logging -To enable debug logging for the ZHA {% term integration %} and radio libraries, add the following [logger](/integrations/logger/) configuration to `configuration.yaml`: +To enable debug logging for the ZHA {% term integration %} and radio libraries, add the following [logger](/integrations/logger/) configuration to {% term "`configuration.yaml`" %}: ```yaml logger: diff --git a/source/_integrations/zhong_hong.markdown b/source/_integrations/zhong_hong.markdown index f4270bdecc0..aedadb289af 100644 --- a/source/_integrations/zhong_hong.markdown +++ b/source/_integrations/zhong_hong.markdown @@ -13,7 +13,7 @@ ha_integration_type: integration The `zhong_hong` climate platform lets you control Zhonghong HVAC Gateway Controller thermostats through Home Assistant. -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: ```yaml climate: diff --git a/source/_integrations/zone.markdown b/source/_integrations/zone.markdown index 8d7f7d06798..b3411912a37 100644 --- a/source/_integrations/zone.markdown +++ b/source/_integrations/zone.markdown @@ -20,7 +20,7 @@ Zones can be added and managed through the user interface at {% my zones title=" You can add a zone in the user interface by specifying the GPS coordinates or dragging the icon on the map. You can adjust the zone radius (except for the Home zone) by changing the size of the zone circle. -Zones can also be configured via `configuration.yaml`: +Zones can also be configured via {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/zoneminder.markdown b/source/_integrations/zoneminder.markdown index 32e50499bf7..7959118599a 100644 --- a/source/_integrations/zoneminder.markdown +++ b/source/_integrations/zoneminder.markdown @@ -124,7 +124,7 @@ The `zoneminder` camera platform lets you monitor the current stream of your [Zo ### Configuration -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: ```yaml # Example configuration.yaml entry @@ -136,7 +136,7 @@ camera: The `zoneminder` sensor platform lets you monitor the current state of your [ZoneMinder](https://www.zoneminder.com) install including the number of events, the current state of the cameras and ZoneMinder's current run state. -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: ```yaml # Example configuration.yaml entry @@ -178,7 +178,7 @@ You must have the [ZoneMinder integration](/integrations/zoneminder/) configured -To enable this switch, add the following lines to your `configuration.yaml` file: +To enable this switch, add the following lines to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry From 8e5309705e4698f1c0fd5b3eafd189e3291fdfc3 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Tue, 14 May 2024 16:45:09 +0200 Subject: [PATCH 013/103] t-integrations: add glossary reference to config file (#32763) --- source/_integrations/telegram_broadcast.markdown | 2 +- source/_integrations/telegram_polling.markdown | 2 +- source/_integrations/telegram_webhooks.markdown | 2 +- source/_integrations/tellstick.markdown | 8 ++++---- source/_integrations/template.markdown | 2 +- source/_integrations/text.mqtt.markdown | 2 +- source/_integrations/thermoworks_smoke.markdown | 2 +- source/_integrations/thethingsnetwork.markdown | 4 ++-- source/_integrations/thingspeak.markdown | 2 +- source/_integrations/thinkingcleaner.markdown | 4 ++-- source/_integrations/thomson.markdown | 2 +- source/_integrations/threshold.markdown | 2 +- source/_integrations/tikteck.markdown | 2 +- source/_integrations/timer.markdown | 4 ++-- source/_integrations/tmb.markdown | 2 +- source/_integrations/tod.markdown | 2 +- source/_integrations/todoist.markdown | 4 ++-- source/_integrations/tomato.markdown | 2 +- source/_integrations/toon.markdown | 2 +- source/_integrations/torque.markdown | 2 +- source/_integrations/touchline.markdown | 2 +- source/_integrations/tplink_lte.markdown | 2 +- source/_integrations/tradfri.markdown | 2 +- source/_integrations/transport_nsw.markdown | 2 +- source/_integrations/travisci.markdown | 2 +- source/_integrations/trend.markdown | 2 +- source/_integrations/twilio.markdown | 2 +- source/_integrations/twilio_call.markdown | 2 +- source/_integrations/twilio_sms.markdown | 2 +- source/_integrations/twitter.markdown | 2 +- 30 files changed, 37 insertions(+), 37 deletions(-) diff --git a/source/_integrations/telegram_broadcast.markdown b/source/_integrations/telegram_broadcast.markdown index 5b62eeffd2a..483b75a94f3 100644 --- a/source/_integrations/telegram_broadcast.markdown +++ b/source/_integrations/telegram_broadcast.markdown @@ -13,7 +13,7 @@ Information on how to send a message via the service `telegram_bot.send_message` ## Configuration -To integrate this into Home Assistant, add the following section to your `configuration.yaml` file: +To integrate this into Home Assistant, add the following section to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/telegram_polling.markdown b/source/_integrations/telegram_polling.markdown index cd847e40a46..b4a206369c9 100644 --- a/source/_integrations/telegram_polling.markdown +++ b/source/_integrations/telegram_polling.markdown @@ -15,7 +15,7 @@ The other implementation method is [Telegram webhooks](/integrations/telegram_we ## Configuration -To integrate this into Home Assistant, add the following section to your `configuration.yaml` file: +To integrate this into Home Assistant, add the following section to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/telegram_webhooks.markdown b/source/_integrations/telegram_webhooks.markdown index befeaa8a0b8..6e47730e7c2 100644 --- a/source/_integrations/telegram_webhooks.markdown +++ b/source/_integrations/telegram_webhooks.markdown @@ -17,7 +17,7 @@ The other implementation method is [Telegram polling](/integrations/telegram_pol ## Configuration -To integrate this into Home Assistant, add the following section to your `configuration.yaml` file: +To integrate this into Home Assistant, add the following section to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/tellstick.markdown b/source/_integrations/tellstick.markdown index f98ac852a61..7b2303e9fbd 100644 --- a/source/_integrations/tellstick.markdown +++ b/source/_integrations/tellstick.markdown @@ -72,7 +72,7 @@ port: This `tellstick` cover platform allows you to control your [TellStick][tellstick-gateway] covers. -To use your TellStick device, you first have to set up your [Tellstick hub](#configuration) and then add the following to your `configuration.yaml` file: +To use your TellStick device, you first have to set up your [Tellstick hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -84,7 +84,7 @@ cover: This `tellstick` light platform allows you to control your [TellStick][tellstick-gateway] dimmers. -To use your TellStick device, you first have to set up your [Tellstick hub](#configuration) and then add the following to your `configuration.yaml` file: +To use your TellStick device, you first have to set up your [Tellstick hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -96,7 +96,7 @@ light: The `tellstick` sensor platform allows you to get current meteorological data from a [TellStick][tellstick-gateway] device. -To use your TellStick device, you first have to set up your [Tellstick hub](#configuration) and then add the following to your `configuration.yaml` file: +To use your TellStick device, you first have to set up your [Tellstick hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -171,7 +171,7 @@ sensor: This `tellstick` switch platform allows you to control [TellStick][tellstick-gateway] devices. -To use your TellStick device, you first have to set up your [Tellstick hub](#configuration) and then add the following to your `configuration.yaml` file: +To use your TellStick device, you first have to set up your [Tellstick hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/template.markdown b/source/_integrations/template.markdown index 1ed54346405..570377f2a6d 100644 --- a/source/_integrations/template.markdown +++ b/source/_integrations/template.markdown @@ -59,7 +59,7 @@ _For old sensor/binary sensor configuration format, [see below](#legacy-binary-s Sensor template and binary sensor template can be configured using the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Select the **+ Add helper** button and then select the **{% my config_flow_start domain=page.ha_domain title=page.title %}** helper. -To be able to add **{% my helpers title="Helpers" %}** via the user interface, you should have `default_config:` in your `configuration.yaml`. It should already be there by default unless you removed it. +To be able to add **{% my helpers title="Helpers" %}** via the user interface, you should have `default_config:` in your {% term "`configuration.yaml`" %}. It should already be there by default unless you removed it. ## YAML configuration diff --git a/source/_integrations/text.mqtt.markdown b/source/_integrations/text.mqtt.markdown index 06c8b0a8a20..28154b23ab7 100644 --- a/source/_integrations/text.mqtt.markdown +++ b/source/_integrations/text.mqtt.markdown @@ -12,7 +12,7 @@ The `mqtt` Text platform allows you to integrate devices that show text that can ## Configuration -To enable MQTT text platform in your installation, add the following to your `configuration.yaml` file: +To enable MQTT text platform in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/thermoworks_smoke.markdown b/source/_integrations/thermoworks_smoke.markdown index 7c274bc538f..1661f1ec629 100644 --- a/source/_integrations/thermoworks_smoke.markdown +++ b/source/_integrations/thermoworks_smoke.markdown @@ -19,7 +19,7 @@ the email and password you used to in the configuration for this sensor in order ## Configuration -To add the sensors to your installation, add the following to your `configuration.yaml` file: +To add the sensors to your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/thethingsnetwork.markdown b/source/_integrations/thethingsnetwork.markdown index 16ecca77052..b7e055d5f9b 100644 --- a/source/_integrations/thethingsnetwork.markdown +++ b/source/_integrations/thethingsnetwork.markdown @@ -53,7 +53,7 @@ Access keys ## Configuration -To enable this integration, add the following lines to your `configuration.yaml`: +To enable this integration, add the following lines to your {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry @@ -120,7 +120,7 @@ Devices overview ### Configuration -To enable this platform, add the following lines to your `configuration.yaml`: +To enable this platform, add the following lines to your {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/thingspeak.markdown b/source/_integrations/thingspeak.markdown index df5b0b5d95c..e8171cbf885 100644 --- a/source/_integrations/thingspeak.markdown +++ b/source/_integrations/thingspeak.markdown @@ -16,7 +16,7 @@ For now, it records exactly one entity at once, which is great for testing purpo You will have to create a [new channel](https://thingspeak.com/channels/new) on ThingSpeak and grab your Write API Key from the "API Keys" tab of the channel you want to use. -To setup the ThingSpeak integration in your installation, add the following to your `configuration.yaml` file: +To setup the ThingSpeak integration in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/thinkingcleaner.markdown b/source/_integrations/thinkingcleaner.markdown index f049c8f2d3c..e008060e9d3 100644 --- a/source/_integrations/thinkingcleaner.markdown +++ b/source/_integrations/thinkingcleaner.markdown @@ -22,7 +22,7 @@ There is currently support for the following device types within Home Assistant: The `thinkingcleaner` sensor platform simple displays information about your [Thinking Cleaner (archived website)](https://web.archive.org/web/20220802042114/https://www.thinkingcleaner.com/) add-on. -To enable this sensor in your installation, add the following to your `configuration.yaml` file: +To enable this sensor in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml sensor: @@ -43,7 +43,7 @@ This will automatically add sensors for each Thinking Cleaner in your network. The `thinkingcleaner` switch platform allows you to control your [Thinking Cleaner (archived website)](https://web.archive.org/web/20220802042114/https://www.thinkingcleaner.com/) add-on. -To enable this switch in your installation, add the following to your `configuration.yaml` file: +To enable this switch in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml switch: diff --git a/source/_integrations/thomson.markdown b/source/_integrations/thomson.markdown index 85305376800..d7009388d8f 100644 --- a/source/_integrations/thomson.markdown +++ b/source/_integrations/thomson.markdown @@ -15,7 +15,7 @@ Thomson produced networking equipment (under the brand name SpeedTouch) till 201 This platform allows you to detect presence by looking at connected devices to a [Thomson](https://www.technicolor.com/) device. -To use this device tracker in your installation, add the following to your `configuration.yaml` file: +To use this device tracker in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/threshold.markdown b/source/_integrations/threshold.markdown index 5e880d62806..10fd2092f39 100644 --- a/source/_integrations/threshold.markdown +++ b/source/_integrations/threshold.markdown @@ -37,7 +37,7 @@ Upper limit: Alternatively, this integration can be configured and set up manually via YAML instead. To enable the Integration sensor in your installation, add the -following to your `configuration.yaml` file: +following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/tikteck.markdown b/source/_integrations/tikteck.markdown index b78090d7fed..1234327ea0b 100644 --- a/source/_integrations/tikteck.markdown +++ b/source/_integrations/tikteck.markdown @@ -11,7 +11,7 @@ ha_platforms: ha_integration_type: integration --- -Support for the Bluetooth smart bulb from [Tikteck](https://www.tikteck.com/). To enable these lights, add the following lines to your `configuration.yaml` file: +Support for the Bluetooth smart bulb from [Tikteck](https://www.tikteck.com/). To enable these lights, add the following lines to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/timer.markdown b/source/_integrations/timer.markdown index 60acde7ac07..cefa8f42d82 100644 --- a/source/_integrations/timer.markdown +++ b/source/_integrations/timer.markdown @@ -26,10 +26,10 @@ However, automations using the `timer.finished` event **will not** trigger if th The preferred way to configure timer helpers is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}** and click the add button; 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 `default_config:` in your `configuration.yaml`, it should already be there by default unless you removed it. If you removed `default_config:` from your configuration, you must add `timer:` to your `configuration.yaml` first, then you can use the UI. +To be able to add Helpers via the user interface you should have `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 configuration, you must add `timer:` to your `configuration.yaml` first, then you can use the UI. Timers can also be configured via configuration.yaml: -To add a timer to your installation, add the following to your `configuration.yaml` file: +To add a timer to your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/tmb.markdown b/source/_integrations/tmb.markdown index dcc5767f0c0..1b70653784d 100644 --- a/source/_integrations/tmb.markdown +++ b/source/_integrations/tmb.markdown @@ -17,7 +17,7 @@ This sensor will provide you the remaining time, in minutes, for the next bus in You must create an application on [developer.tmb.cat](https://developer.tmb.cat/account/applications/public/new) to obtain the `app_id` and `app_key` values that you will need. -Add the data to your `configuration.yaml` file as shown in the example: +Add the data to your {% term "`configuration.yaml`" %} file as shown in the example: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/tod.markdown b/source/_integrations/tod.markdown index d7a193c03b3..57e458ef019 100644 --- a/source/_integrations/tod.markdown +++ b/source/_integrations/tod.markdown @@ -35,7 +35,7 @@ The time ranges can be provided as absolute local time or using the `sunrise` or In addition for sun position based ranges, the negative or positive offset can be configured. To enable the Times of Day binary sensor in your installation, add the -following to your `configuration.yaml` file: +following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/todoist.markdown b/source/_integrations/todoist.markdown index 127d9401328..6c50a7b9c59 100644 --- a/source/_integrations/todoist.markdown +++ b/source/_integrations/todoist.markdown @@ -42,7 +42,7 @@ You need to determine your Todoist API token. Go to the [**Integrations** > **De ## Custom projects -You can manually configure the Todoist calendar (only) integration using `configuration.yaml` which can specify "custom" projects which match against criteria you set. You should +You can manually configure the Todoist calendar (only) integration using {% term "`configuration.yaml`" %} which can specify "custom" projects which match against criteria you set. You should prefer the above instructions for configuring Todoist from the UI. {% details "Manual custom projects configuration" %} @@ -75,7 +75,7 @@ custom_projects: type: list {% endconfiguration %} -Here's an example of a more advanced `configuration.yaml`: +Here's an example of a more advanced {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/tomato.markdown b/source/_integrations/tomato.markdown index 81582046bbc..300986e4005 100644 --- a/source/_integrations/tomato.markdown +++ b/source/_integrations/tomato.markdown @@ -28,7 +28,7 @@ value can be obtained by logging in to the Tomato admin interface and search for ## Configuration To use this device tracker in your installation, -add the following to your `configuration.yaml` file: +add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/toon.markdown b/source/_integrations/toon.markdown index 57d91555332..298ed953961 100644 --- a/source/_integrations/toon.markdown +++ b/source/_integrations/toon.markdown @@ -56,7 +56,7 @@ In order to be able to use this integration, you'll need to sign up for a free T 4. Click on "Create App" to complete the creation process. 5. Open the "[My Apps](https://developer.toon.eu/user/me/apps)" page again and click on the app that you've just created. 6. You need the codes now shown: "Consumer Key" and "Consumer Secret". -7. Add the following Toon configuration to your `configuration.yaml` and restart Home Assistant. +7. Add the following Toon configuration to your {% term "`configuration.yaml`" %} and restart Home Assistant. ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/torque.markdown b/source/_integrations/torque.markdown index 0315b754782..f446f1db1b6 100644 --- a/source/_integrations/torque.markdown +++ b/source/_integrations/torque.markdown @@ -37,7 +37,7 @@ Under the **Realtime Web Upload** header: ### Configuration -Add the following to your `configuration.yaml` file: +Add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/touchline.markdown b/source/_integrations/touchline.markdown index 1dcf6aa8b69..0f2dc45df46 100644 --- a/source/_integrations/touchline.markdown +++ b/source/_integrations/touchline.markdown @@ -13,7 +13,7 @@ ha_integration_type: integration The `touchline` climate platform let you control [ROTH Touchline](https://www.roth-uk.com/en/roth-touchline.htm) floor heating thermostats from Roth. -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: ```yaml climate: diff --git a/source/_integrations/tplink_lte.markdown b/source/_integrations/tplink_lte.markdown index cf063e03057..68cae3a7c4e 100644 --- a/source/_integrations/tplink_lte.markdown +++ b/source/_integrations/tplink_lte.markdown @@ -18,7 +18,7 @@ The integration provides a notification service that will send an SMS. ## Configuration -To enable the integration, add the following lines to your `configuration.yaml` file: +To enable the integration, add the following lines to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/tradfri.markdown b/source/_integrations/tradfri.markdown index c2dc09c22e8..e3ffea13499 100644 --- a/source/_integrations/tradfri.markdown +++ b/source/_integrations/tradfri.markdown @@ -23,7 +23,7 @@ ha_platforms: ha_integration_type: integration --- -The IKEA TRÅDFRI integration allows you to connect your IKEA Trådfri Gateway to Home Assistant. The gateway can control compatible Zigbee-based lights (certified Zigbee Light Link products) connected to it. Home Assistant will automatically discover the gateway's presence on your local network if `discovery:` is present in your `configuration.yaml` file. +The IKEA TRÅDFRI integration allows you to connect your IKEA Trådfri Gateway to Home Assistant. The gateway can control compatible Zigbee-based lights (certified Zigbee Light Link products) connected to it. Home Assistant will automatically discover the gateway's presence on your local network if `discovery:` is present in your {% term "`configuration.yaml`" %} file. {% include integrations/config_flow.md %} diff --git a/source/_integrations/transport_nsw.markdown b/source/_integrations/transport_nsw.markdown index 29abd108826..399165b7f57 100644 --- a/source/_integrations/transport_nsw.markdown +++ b/source/_integrations/transport_nsw.markdown @@ -25,7 +25,7 @@ As a default the sensor picks up the next mode of transport leaving from a stop ## Configuration -To enable the sensor, add the following lines to your `configuration.yaml` file: +To enable the sensor, add the following lines to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/travisci.markdown b/source/_integrations/travisci.markdown index ae48238c9d5..7886cb21906 100644 --- a/source/_integrations/travisci.markdown +++ b/source/_integrations/travisci.markdown @@ -25,7 +25,7 @@ Create a GitHub [access token](https://github.com/settings/tokens) with the foll ## Configuration -To enable this platform, please add the following to your `configuration.yaml` file: +To enable this platform, please add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/trend.markdown b/source/_integrations/trend.markdown index 776db5da820..dca6ef56421 100644 --- a/source/_integrations/trend.markdown +++ b/source/_integrations/trend.markdown @@ -38,7 +38,7 @@ Invert the result: ### YAML Configuration To enable Trend binary sensors in your installation, -add the following to your `configuration.yaml` file: +add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/twilio.markdown b/source/_integrations/twilio.markdown index 22e8cdf8afe..b9966083c34 100644 --- a/source/_integrations/twilio.markdown +++ b/source/_integrations/twilio.markdown @@ -17,7 +17,7 @@ Calls are limited to 10 minutes and will play a short trial message before your ## Configuration -To use this notification integration in your installation, add the following to your `configuration.yaml` file: +To use this notification integration in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/twilio_call.markdown b/source/_integrations/twilio_call.markdown index 38cee1467fc..5c5a12516f2 100644 --- a/source/_integrations/twilio_call.markdown +++ b/source/_integrations/twilio_call.markdown @@ -18,7 +18,7 @@ The requirement is that you have setup [Twilio](/integrations/twilio/). ## Configuration -To use this notification platform in your installation, add the following to your `configuration.yaml` file: +To use this notification platform in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/twilio_sms.markdown b/source/_integrations/twilio_sms.markdown index f896c924a12..bcfadebe646 100644 --- a/source/_integrations/twilio_sms.markdown +++ b/source/_integrations/twilio_sms.markdown @@ -17,7 +17,7 @@ The requirement is that you have setup [Twilio](/integrations/twilio/). ## Configuration -To use this notification platform in your installation, add the following to your `configuration.yaml` file: +To use this notification platform in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/twitter.markdown b/source/_integrations/twitter.markdown index 1e728e841b5..9d58565e48e 100644 --- a/source/_integrations/twitter.markdown +++ b/source/_integrations/twitter.markdown @@ -37,7 +37,7 @@ It does not matter for the integration what you enter as a callback or website U ## Configuration -To add X to your installation, add the following to your `configuration.yaml` file: +To add X to your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry From a61cc6aa090de94fee4ebbdbfea029ae12f94465 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Tue, 14 May 2024 11:37:21 -0400 Subject: [PATCH 014/103] Updated Abode docs to point to jaraco.abode library (#32722) * Updated Abode docs to point to jaraco.abode library * Add link to the inferred groups and their ranges. * Tiny tweak for the linter --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> --- source/_integrations/abode.markdown | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/source/_integrations/abode.markdown b/source/_integrations/abode.markdown index 840b298fa76..c33bb3a3bec 100644 --- a/source/_integrations/abode.markdown +++ b/source/_integrations/abode.markdown @@ -81,8 +81,10 @@ All {% term events %} have the fields: | `date` | The date of the event in the format `MM/DD/YYYY`. | | `time` | The time of the event in the format `HH:MM AM`. | -There is a unique list of known event_codes that can be found -[here](https://github.com/MisterWil/abodepy/files/1262019/timeline_events.txt). +There is a unique list of known event_codes are defined in +[events.csv](https://github.com/jaraco/jaraco.abode/blob/main/jaraco/abode/helpers/events.csv) +and the inferred groups and their ranges of event codes are defined in +[timeline.py](https://github.com/jaraco/jaraco.abode/blob/main/jaraco/abode/helpers/timeline.py). ## Services @@ -92,7 +94,7 @@ Available {% term services %}: `change_setting`, `capture_image`, `trigger_autom Change settings on your Abode system. For a full list of settings and valid values, consult the -[AbodePy settings section](https://github.com/MisterWil/abodepy/blob/master/README.rst#settings). +[`jaraco.abode` settings section](https://github.com/jaraco/jaraco.abode/blob/main/README.rst#settings). | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | From fffd8c63ee9d661fb7e5b9ccf29d0c39c481cef5 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Tue, 14 May 2024 18:17:43 +0200 Subject: [PATCH 015/103] Docs: add glossary ref to configuration.yaml term definition (#32767) --- source/_docs/authentication/multi-factor-auth.markdown | 4 ++-- source/_docs/authentication/providers.markdown | 6 +++--- source/_docs/automation/editor.markdown | 2 +- source/_docs/automation/using_blueprints.markdown | 2 +- source/_docs/automation/yaml.markdown | 4 ++-- source/_docs/blueprint/tutorial.markdown | 2 +- source/_docs/configuration/packages.markdown | 6 +++--- source/_docs/configuration/secrets.markdown | 6 +++--- source/_docs/configuration/splitting_configuration.markdown | 4 ++-- source/_docs/configuration/troubleshooting.markdown | 6 +++--- source/_docs/energy/faq.markdown | 2 +- source/_docs/quality_scale.markdown | 2 +- source/_docs/tools/check_config.markdown | 2 +- source/_docs/tools/dev-tools.markdown | 2 +- 14 files changed, 25 insertions(+), 25 deletions(-) diff --git a/source/_docs/authentication/multi-factor-auth.markdown b/source/_docs/authentication/multi-factor-auth.markdown index 78cedd3abf7..5aa16847ce9 100644 --- a/source/_docs/authentication/multi-factor-auth.markdown +++ b/source/_docs/authentication/multi-factor-auth.markdown @@ -24,7 +24,7 @@ Home Assistant generates a secret key which is synchronized with an app on your #### Setting up TOTP -Enable TOTP in your `configuration.yaml` like this: +Enable TOTP in your {% term "`configuration.yaml`" %} like this: ```yaml homeassistant: @@ -64,7 +64,7 @@ The Notify MFA module uses the [notify integration](/integrations/notify/) to se #### Setting up MFA notify -Add Notify MFA to your `configuration.yaml` file like this: +Add Notify MFA to your {% term "`configuration.yaml`" %} file like this: ```yaml homeassistant: diff --git a/source/_docs/authentication/providers.markdown b/source/_docs/authentication/providers.markdown index f566a41d5b7..be61e06de72 100644 --- a/source/_docs/authentication/providers.markdown +++ b/source/_docs/authentication/providers.markdown @@ -44,7 +44,7 @@ User details are stored in the `[your config]/.storage` directory. All password Users can be managed in Home Assistant by the owner. Go to the configuration panel and click on _{% my users %}_. -This is the entry in `configuration.yaml` for Home Assistant auth: +This is the entry in {% term "`configuration.yaml`" %} for Home Assistant auth: ```yaml homeassistant: @@ -52,7 +52,7 @@ homeassistant: - type: homeassistant ``` -If you don't specify any `auth_providers` section in the `configuration.yaml` file then this provider will be set up automatically. +If you don't specify any `auth_providers` section in the {% term "`configuration.yaml`" %} file then this provider will be set up automatically. ### Trusted networks @@ -72,7 +72,7 @@ You cannot trust a network that you are using in any [trusted_proxies](/integrat -Here is an example in `configuration.yaml` to set up Trusted Networks: +Here is an example in {% term "`configuration.yaml`" %} to set up Trusted Networks: ```yaml homeassistant: diff --git a/source/_docs/automation/editor.markdown b/source/_docs/automation/editor.markdown index 3107691e192..86335c28166 100644 --- a/source/_docs/automation/editor.markdown +++ b/source/_docs/automation/editor.markdown @@ -39,4 +39,4 @@ Automations created or edited via the user interface are activated immediately a ## Troubleshooting missing automations -When you're creating automations using the GUI and they don't appear in the UI, make sure that you add back `automation: !include automations.yaml` from the default configuration to your `configuration.yaml`. +When you're creating automations using the GUI and they don't appear in the UI, make sure that you add back `automation: !include automations.yaml` from the default configuration to your {% term "`configuration.yaml`" %}. diff --git a/source/_docs/automation/using_blueprints.markdown b/source/_docs/automation/using_blueprints.markdown index 061538244dd..70f6af83cc3 100644 --- a/source/_docs/automation/using_blueprints.markdown +++ b/source/_docs/automation/using_blueprints.markdown @@ -91,4 +91,4 @@ Learn more about blueprints by [reading our tutorial on creating a blueprint](/d ## Troubleshooting missing automations -When you're creating automations using blueprints and they don't appear in the UI, make sure that you add back `automation: !include automations.yaml` from the default configuration to your `configuration.yaml`. +When you're creating automations using blueprints and they don't appear in the UI, make sure that you add back `automation: !include automations.yaml` from the default configuration to your {% term "`configuration.yaml`" %}. diff --git a/source/_docs/automation/yaml.markdown b/source/_docs/automation/yaml.markdown index 2484b3b20e5..48c6233ead7 100644 --- a/source/_docs/automation/yaml.markdown +++ b/source/_docs/automation/yaml.markdown @@ -7,7 +7,7 @@ Automations are created in Home Assistant via the UI, but are stored in a YAML f The UI will write your automations to `automations.yaml`. This file is managed by the UI and should not be edited manually. -It is also possible to write your automations directly inside `configuration.yaml` or other YAML files. You can do this by adding a labeled `automation` block to your `configuration.yaml`: +It is also possible to write your automations directly inside {% term "`configuration.yaml`" %} or other YAML files. You can do this by adding a labeled `automation` block to your `configuration.yaml`: ```yaml # The configuration required for the UI to work @@ -128,7 +128,7 @@ Mode | Description ## YAML example -Example of a YAML based automation that you can add to `configuration.yaml`. +Example of a YAML based automation that you can add to {% term "`configuration.yaml`" %}. {% raw %} diff --git a/source/_docs/blueprint/tutorial.markdown b/source/_docs/blueprint/tutorial.markdown index 98908e5f51e..aa4e3f39f1b 100644 --- a/source/_docs/blueprint/tutorial.markdown +++ b/source/_docs/blueprint/tutorial.markdown @@ -137,7 +137,7 @@ For more information on blueprint inputs, refer to the documentation of the [blu With the bare minimum metadata added, your blueprint is ready to use. -Open your `configuration.yaml` and add the following: +Open your {% term "`configuration.yaml`" %} and add the following: ```yaml automation tutorial: diff --git a/source/_docs/configuration/packages.markdown b/source/_docs/configuration/packages.markdown index 010f4bd5e2b..b5b2126b6bf 100644 --- a/source/_docs/configuration/packages.markdown +++ b/source/_docs/configuration/packages.markdown @@ -19,7 +19,7 @@ The package configuration can include: `switch`, `light`, `automation`, `groups` It can be specified inline or in a separate YAML file using `!include`. -Inline example, main `configuration.yaml`: +Inline example, main {% term "`configuration.yaml`" %}: ```yaml homeassistant: @@ -34,7 +34,7 @@ homeassistant: ... ``` -Include example, main `configuration.yaml`: +Include example, main {% term "`configuration.yaml`" %}: ```yaml homeassistant: @@ -74,7 +74,7 @@ Integrations inside packages can only specify platform entries using configurati ## Create a packages folder -One way to organize packages is to create a folder named "packages" in your Home Assistant configuration directory. In the packages directory, you can store any number of packages in a YAML file. This entry in your `configuration.yaml` will load all YAML-files in this _packages_ folder and its subfolders: +One way to organize packages is to create a folder named "packages" in your Home Assistant configuration directory. In the packages directory, you can store any number of packages in a YAML file. This entry in your {% term "`configuration.yaml`" %} will load all YAML-files in this _packages_ folder and its subfolders: ```yaml homeassistant: diff --git a/source/_docs/configuration/secrets.markdown b/source/_docs/configuration/secrets.markdown index 559f1ff4dc2..08d5af6c153 100644 --- a/source/_docs/configuration/secrets.markdown +++ b/source/_docs/configuration/secrets.markdown @@ -8,13 +8,13 @@ related: title: Splitting the configuration --- -The `configuration.yaml` file is a plain-text file, thus it is readable by anyone who has access to the file. The file contains passwords and API tokens which need to be redacted if you want to share your configuration. By using `!secret` you can remove any private information from your configuration files. This separation can also help you to keep easier track of your passwords and API keys, as they are all stored at one place and no longer spread across the `configuration.yaml` file or even multiple YAML files if you [split up your configuration](/docs/configuration/splitting_configuration/). +The {% term "`configuration.yaml`" %} file is a plain-text file, thus it is readable by anyone who has access to the file. The file contains passwords and API tokens which need to be redacted if you want to share your configuration. By using `!secret` you can remove any private information from your configuration files. This separation can also help you to keep easier track of your passwords and API keys, as they are all stored at one place and no longer spread across the {% term "`configuration.yaml`" %} file or even multiple YAML files if you [split up your configuration](/docs/configuration/splitting_configuration/). ## Using `secrets.yaml` The workflow for moving private information to `secrets.yaml` is very similar to the [splitting of the configuration](/docs/configuration/splitting_configuration/). Create a `secrets.yaml` file in your Home Assistant [configuration directory](/docs/configuration/). -The entries for password and API keys in the `configuration.yaml` file usually looks like the example below. +The entries for password and API keys in the {% term "`configuration.yaml`" %} file usually looks like the example below. ```yaml rest: @@ -45,7 +45,7 @@ rest_password: "YOUR_PASSWORD" When you start splitting your configuration into multiple files, you might end up with configuration in sub folders. Secrets will be resolved in this order: - A `secrets.yaml` located in the same folder as the YAML file referencing the secret, -- next, parent folders will be searched for a `secrets.yaml` file with the secret, stopping at the folder with the main `configuration.yaml`. +- next, parent folders will be searched for a `secrets.yaml` file with the secret, stopping at the folder with the main {% term "`configuration.yaml`" %}. To see where secrets are being loaded from, you can either add an option to your `secrets.yaml` file or use the `check_config` script. The latter is only available for {% term "Home Assistant Core" %} installations given it's available through [`hass`](/docs/tools/hass/). diff --git a/source/_docs/configuration/splitting_configuration.markdown b/source/_docs/configuration/splitting_configuration.markdown index c4f459b03dd..582751ca0dd 100644 --- a/source/_docs/configuration/splitting_configuration.markdown +++ b/source/_docs/configuration/splitting_configuration.markdown @@ -10,7 +10,7 @@ related: title: Using packages to organize configuration files --- -So you've been using Home Assistant for a while now and your `configuration.yaml` file brings people to tears because it has become so large. Or, you simply want to start off with the distributed approach. Here's how to split the `configuration.yaml` into more manageable (read: human-readable) pieces. +So you've been using Home Assistant for a while now and your {% term "`configuration.yaml`" %} file brings people to tears because it has become so large. Or, you simply want to start off with the distributed approach. Here's how to split the {% term "`configuration.yaml`" %} into more manageable (read: human-readable) pieces. ## Example configuration files for inspiration @@ -22,7 +22,7 @@ As commenting code doesn't always happen, please read on to learn in detail how In this section, we are going use some example configuration files and look at their structure and format in more detail. -Now you might think that the `configuration.yaml` will be replaced during the splitting process. However, it will in fact remain, albeit in a much less cluttered form. +Now you might think that the {% term "`configuration.yaml`" %} will be replaced during the splitting process. However, it will in fact remain, albeit in a much less cluttered form. ### The core configuration file diff --git a/source/_docs/configuration/troubleshooting.markdown b/source/_docs/configuration/troubleshooting.markdown index 327d8a8b62e..1300600cc06 100644 --- a/source/_docs/configuration/troubleshooting.markdown +++ b/source/_docs/configuration/troubleshooting.markdown @@ -17,7 +17,7 @@ If you have incorrect entries in your configuration files you can use the config ### Problems with the configuration -One of the most common problems with Home Assistant is an invalid `configuration.yaml` or other configuration file. +One of the most common problems with Home Assistant is an invalid {% term "`configuration.yaml`" %} or other configuration file. - Home Assistant provides a CLI that allows you to see how it interprets them, each installation type has its own section in the common-tasks about this: - [Operating System](/common-tasks/os/#configuration-check) @@ -25,7 +25,7 @@ One of the most common problems with Home Assistant is an invalid `configuration - [Core](/common-tasks/core/#configuration-check) - [Supervised](/common-tasks/supervised/#configuration-check) -- The configuration files, including `configuration.yaml` must be UTF-8 encoded. If you see error like `'utf-8' codec can't decode byte`, edit the offending configuration and re-save it as UTF-8. +- The configuration files, including {% term "`configuration.yaml`" %} must be UTF-8 encoded. If you see error like `'utf-8' codec can't decode byte`, edit the offending configuration and re-save it as UTF-8. - You can verify your configuration's YAML structure using [this online YAML parser](https://yaml-online-parser.appspot.com/) or [YAML Validator](https://codebeautify.org/yaml-validator/). - To learn more about the quirks of YAML, read [YAML IDIOSYNCRASIES](https://docs.saltproject.io/en/latest/topics/troubleshooting/yaml_idiosyncrasies.html) by SaltStack (the examples there are specific to SaltStack, but do explain YAML issues well). @@ -126,7 +126,7 @@ After you download logs, you will also want to download the diagnostics for the ### Handling unexpected restarts or crashes -Suppose you find that Home Assistant unexpectedly restarts or crashes; it's likely that you have a misbehaving integration impacting system stability. Home Assistant has a built-in debug option that can help find implementation errors. It can also block many unsafe thread operations from crashing the system. Enabling debug has a slight performance impact on the system and is not recommended for long-term use. To enable debug, add the following to your `configuration.yaml`: +Suppose you find that Home Assistant unexpectedly restarts or crashes; it's likely that you have a misbehaving integration impacting system stability. Home Assistant has a built-in debug option that can help find implementation errors. It can also block many unsafe thread operations from crashing the system. Enabling debug has a slight performance impact on the system and is not recommended for long-term use. To enable debug, add the following to your {% term "`configuration.yaml`" %}: ```yaml homeassistant: diff --git a/source/_docs/energy/faq.markdown b/source/_docs/energy/faq.markdown index 2cefbaf96ad..2c6a524d865 100644 --- a/source/_docs/energy/faq.markdown +++ b/source/_docs/energy/faq.markdown @@ -31,7 +31,7 @@ To accomplish such, you can use the [utility_meter integration](/integrations/ut ## The energy dashboard is not visible -If you do not see the Energy dashboard in the sidebar, make sure you have not removed [`default_config:`](/integrations/default_config/) from your `configuration.yaml`. If you have, you will need to add the `energy:` integration manually. +If you do not see the Energy dashboard in the sidebar, make sure you have not removed [`default_config:`](/integrations/default_config/) from your {% term "`configuration.yaml`" %}. If you have, you will need to add the `energy:` integration manually. ## Troubleshooting missing entities diff --git a/source/_docs/quality_scale.markdown b/source/_docs/quality_scale.markdown index 4f4b7dd3051..8803e2ce3ae 100644 --- a/source/_docs/quality_scale.markdown +++ b/source/_docs/quality_scale.markdown @@ -9,7 +9,7 @@ The Integration Quality Scale scores each integration based on the code quality ## No score -This integration passes the bare minimum requirements. That's the level of most integrations when they are introduced into Home Assistant. It doesn't mean that they are bad or buggy, just that you need to configure them with an entry in your `configuration.yaml` file. +This integration passes the bare minimum requirements. That's the level of most integrations when they are introduced into Home Assistant. It doesn't mean that they are bad or buggy, just that you need to configure them with an entry in your {% term "`configuration.yaml`" %} file. ## Silver 🥈 diff --git a/source/_docs/tools/check_config.markdown b/source/_docs/tools/check_config.markdown index 4a805d672cd..d9b82771004 100644 --- a/source/_docs/tools/check_config.markdown +++ b/source/_docs/tools/check_config.markdown @@ -6,7 +6,7 @@ related: title: Validating the configuration --- -Test any changes to your `configuration.yaml` file before launching Home Assistant. This script allows you to test changes without the need to restart Home Assistant. +Test any changes to your {% term "`configuration.yaml`" %} file before launching Home Assistant. This script allows you to test changes without the need to restart Home Assistant. ```bash hass --script check_config diff --git a/source/_docs/tools/dev-tools.markdown b/source/_docs/tools/dev-tools.markdown index f33111825d3..bbece8757f5 100644 --- a/source/_docs/tools/dev-tools.markdown +++ b/source/_docs/tools/dev-tools.markdown @@ -32,7 +32,7 @@ It is almost the same as the option under **Settings** > three dot menu (top rig ### Reloading the YAML configuration -For configuration changes to become effective, the configuration must be reloaded. Most integrations in Home Assistant (that do not interact with {% term devices %} or {% term services %}) can reload changes made to their configuration in `configuration.yaml` without needing to restart Home Assistant. +For configuration changes to become effective, the configuration must be reloaded. Most integrations in Home Assistant (that do not interact with {% term devices %} or {% term services %}) can reload changes made to their configuration in {% term "`configuration.yaml`" %} without needing to restart Home Assistant. 1. Go to {% my server_controls title="**Developer Tools** > **YAML**" %} and scroll down to the YAML configuration reloading section (alternatively, hit ["c"](/docs/tools/quick-bar/) anywhere in the UI and search for "reload"). - You are presented with a list of integrations, such as **Automations** or **Conversation**. From 8abaafb32d98c33fd1dcfc5510bb5bf6ce8fbc12 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Wed, 15 May 2024 08:54:56 +0200 Subject: [PATCH 016/103] Docs: add glossary term reference to config file (#32777) --- source/_docs/authentication/providers.markdown | 7 +++++-- source/_docs/configuration/basic.markdown | 4 ++-- source/_docs/configuration/customizing-devices.markdown | 4 ++-- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/source/_docs/authentication/providers.markdown b/source/_docs/authentication/providers.markdown index be61e06de72..8f42cdc1224 100644 --- a/source/_docs/authentication/providers.markdown +++ b/source/_docs/authentication/providers.markdown @@ -1,6 +1,9 @@ --- title: "Authentication providers" description: "Guide on configuring different authentication providers." +related: + - docs: /docs/configuration/ + title: configuration.yaml file ---
@@ -13,13 +16,13 @@ When you log in, an _auth provider_ checks your credentials to make sure you are
-Home Assistant automatically configures the standard auth providers so you don't need to specify `auth_providers` in your `configuration.yaml` file unless you are configuring more than one. Specifying `auth_providers` will disable all auth providers that are not listed, so you could reduce your security or create difficulties logging in if it is not configured correctly. +Home Assistant automatically configures the standard auth providers so you don't need to specify `auth_providers` in your {% term "`configuration.yaml`" %} file unless you are configuring more than one. Specifying `auth_providers` will disable all auth providers that are not listed, so you could reduce your security or create difficulties logging in if it is not configured correctly. If you decide to use `trusted_networks` as your `auth_provider` there won't be a way to authenticate for a device outside of your listed trusted network. To overcome this ensure you add the default `auth_provider` with `type: homeassistant` back in manually. This will then present you with the default auth login screen when trusted network authentication fails as expected from outside your LAN.
-Authentication providers are configured in your `configuration.yaml` under the `homeassistant:` block. +Authentication providers are configured in your {% term "`configuration.yaml`" %} file under the `homeassistant:` block. If you are moving configuration to packages, this particular configuration must stay within 'configuration.yaml'. See Issue 16441 in the warning block at the bottom of this page. diff --git a/source/_docs/configuration/basic.markdown b/source/_docs/configuration/basic.markdown index afac72742f3..c93ab0e1748 100644 --- a/source/_docs/configuration/basic.markdown +++ b/source/_docs/configuration/basic.markdown @@ -23,8 +23,8 @@ To change the general settings that were defined during onboarding, follow these 2. To change network-related configuration, such as the network name, go to {% my network title="**Settings** > **System** > **Network**" %}. 3. If some of the settings are not visible, you may need to enable **Advanced mode**. - In the bottom left, select your user name to go to your {% my profile title="**User profile**" %}, and enable **Advanced mode**. -4. **Troubleshooting**: If any of the settings are grayed out and can't be edited, this is because they are defined in the [`configuration.yaml` file](/docs/configuration/). - - If you prefer editing the settings in the UI, you have to delete these entries from the [`configuration.yaml` file](/docs/configuration/). +4. **Troubleshooting**: If any of the settings are grayed out and can't be edited, this is because they are defined in the {% term "`configuration.yaml`" %} file. + - If you prefer editing the settings in the UI, you have to delete these entries from the {% term "`configuration.yaml`" %} file. - For more information about the general settings in YAML, refer to the [Home Assistant Core integration documentation](/integrations/homeassistant/). ![Setting fields are grayed out because the configuration settings stored in configuration.yaml file](/images/docs/configuration/general-settings-stored-in-config-yaml.png) diff --git a/source/_docs/configuration/customizing-devices.markdown b/source/_docs/configuration/customizing-devices.markdown index 6a2d8e64db8..1c820912887 100644 --- a/source/_docs/configuration/customizing-devices.markdown +++ b/source/_docs/configuration/customizing-devices.markdown @@ -4,7 +4,7 @@ description: "Simple customization for entities." related: - docs: /integrations/homeassistant/ - docs: /docs/configuration/ - title: Home Assistant Core integration documentation + title: configuration.yaml file --- ## Changing entity name and entity ID @@ -30,4 +30,4 @@ To change the entity ID and friendly name of supported entities, follow these st ![Edit entity ID in automation.](/images/docs/configuration/edit_entity-id_in_automation.png) -If your entity is not supported, or you cannot customize what you need via this method, you need to edit the settings in your [`configuration.yaml` file](/docs/configuration/). For a detailed description of the entity configuration variables and device class information, refer to the [Home Assistant Core integration documentation](/integrations/homeassistant/). +If your entity is not supported, or you cannot customize what you need via this method, you need to edit the settings in your {% term "`configuration.yaml`" %} file. For a detailed description of the entity configuration variables and device class information, refer to the [Home Assistant Core integration documentation](/integrations/homeassistant/). From 6e6b4197ccd1f2058c615b30c86d9a6053d8f982 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 15 May 2024 08:55:45 +0200 Subject: [PATCH 017/103] build(deps-dev): bump sorbet-runtime from 0.5.11375 to 0.5.11376 (#32778) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Gemfile.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index 6963928a4fe..6562da3a79d 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -135,7 +135,7 @@ GEM rack-protection (= 4.0.0) rack-session (>= 2.0.0, < 3) tilt (~> 2.0) - sorbet-runtime (0.5.11375) + sorbet-runtime (0.5.11376) stringex (2.8.6) terminal-table (3.0.2) unicode-display_width (>= 1.1.1, < 3) From 8b8c5e37687e28dddc9633a210aa78c7a7cd79fb Mon Sep 17 00:00:00 2001 From: Joost Lekkerkerker Date: Wed, 15 May 2024 09:14:07 +0200 Subject: [PATCH 018/103] Remove empty integration type in remember the milk (#32781) --- source/_integrations/remember_the_milk.markdown | 1 - 1 file changed, 1 deletion(-) diff --git a/source/_integrations/remember_the_milk.markdown b/source/_integrations/remember_the_milk.markdown index 51fc05b9e66..d5731042cf5 100644 --- a/source/_integrations/remember_the_milk.markdown +++ b/source/_integrations/remember_the_milk.markdown @@ -6,7 +6,6 @@ ha_category: ha_iot_class: Cloud Push ha_release: 0.57 ha_domain: remember_the_milk -ha_integration_type: related: - docs: /docs/configuration/ title: Configuration file From ada16a4420b7b19241f371fdd717cfe62a7f3fe4 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Wed, 15 May 2024 11:27:41 +0200 Subject: [PATCH 019/103] Configuration: style and typo fixes (#32788) --- source/_docs/configuration.markdown | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/source/_docs/configuration.markdown b/source/_docs/configuration.markdown index ade0f779d0a..0ac7b292c1a 100644 --- a/source/_docs/configuration.markdown +++ b/source/_docs/configuration.markdown @@ -38,23 +38,23 @@ File access depends on your [installation method](/installation/#advanced-instal 1. To set up file access, follow the steps for your [installation method](/installation/#advanced-installation-methods): - - [Configuring file access on the Operating System](/common-tasks/os/#configuring-access-to-files) + - [Configure file access on the Operating System](/common-tasks/os/#configuring-access-to-files): - If you are unsure which option to choose, install the [file editor add-on](/common-tasks/os/#installing-and-using-the-file-editor-add-on). - Alternatively, use the [VS Code add-on](/common-tasks/os/#installing-and-using-the-visual-studio-code-vsc-add-on). This editor offers live syntax checking and auto-fill of various Home Assistant entities. But it looks more complex than the file editor. - If you prefer to use a file editor on your computer, use the [Samba add-on](/common-tasks/os/#installing-and-using-the-samba-add-on). - - [Configuring file access on Supervised](/common-tasks/supervised/#configuring-access-to-files) - - [File editor add-on](/common-tasks/supervised/#installing-and-using-the-file-editor-add-on). - - [VS Code add-on](/common-tasks/supervised/#installing-and-using-the-visual-studio-code-vsc-add-on). - - [Samba add-on](/common-tasks/supervised/#installing-and-using-the-samba-add-on). + - [Configure file access on Supervised](/common-tasks/supervised/#configuring-access-to-files): + - Using the [File editor add-on](/common-tasks/supervised/#installing-and-using-the-file-editor-add-on). + - Using the [VS Code add-on](/common-tasks/supervised/#installing-and-using-the-visual-studio-code-vsc-add-on). + - Using the [Samba add-on](/common-tasks/supervised/#installing-and-using-the-samba-add-on). -2. To look up the to your configuration directory, go to {% my system_health title="**Settings** > **System** > **Repairs**" %}. +2. To look up the path to your configuration directory, go to {% my system_health title="**Settings** > **System** > **Repairs**" %}. - Select the three dots menu and select **System information**. ![Show system information option](/images/screenshots/System_information_menu.png) 3. Find out the location of the **Configuration directory**. - ![Screenshot showing the top of the system information panel](/images/screenshots/System_information.png) + ![Screenshot showing the top of the system information panel](/images/screenshots/system_information.png) - Unless you changed the file structure, the default is as follows: - - {% term "Home Assistant Operating System" %}: the `configuration.yaml` is in the `/config` folder of the installation. - {% term "Home Assistant Container" %}: the `configuration.yaml` is in the config folder that you mounted in your container. @@ -87,4 +87,4 @@ For configuration changes to become effective, the configuration must be reloade ## Troubleshooting the configuration -If you run into trouble while configuring Home Assistant, refer to the [configuration troubleshooting page](/docs/configuration/troubleshooting/) and the [`configuration.yaml` examples](/examples/#example-configurationyaml). \ No newline at end of file +If you run into trouble while configuring Home Assistant, refer to the [configuration troubleshooting page](/docs/configuration/troubleshooting/) and the [`configuration.yaml` examples](/examples/#example-configurationyaml). From 3f37f2a988b1ef1a55c4b8ef719c8fa6daac4ed4 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Wed, 15 May 2024 11:27:51 +0200 Subject: [PATCH 020/103] Tile card: add section on reordering features (#32785) Co-authored-by: Franck Nijhof --- source/_dashboards/tile.markdown | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/source/_dashboards/tile.markdown b/source/_dashboards/tile.markdown index 7dba42385ef..d950c0df9ae 100644 --- a/source/_dashboards/tile.markdown +++ b/source/_dashboards/tile.markdown @@ -6,7 +6,7 @@ description: "The tile card gives you a quick overview of your entity. The card related: - docs: /dashboards/actions/ title: Card actions - - docs: /dashboards/features + - docs: /dashboards/features/ title: Card features - docs: /dashboards/cards/ title: Dashboard cards @@ -137,3 +137,15 @@ features: You want to colorize the tile card? Choose one of the following colors: `primary`, `accent`, `disabled`, `red`, `pink`, `purple`, `deep-purple`, `indigo`, `blue`, `light-blue`, `cyan`, `teal`, `green`, `light-green`, `lime`, `yellow`, `amber`, `orange`, `deep-orange`, `brown`, `grey`, `blue-grey`, `black` and `white`. +## Reordering features + +Some features of the tile card, such as the presets or the HVAC modes of a +thermostat, can show many buttons. While you can limit the buttons you’d +like to see, they may not be in the desired order. + +For your thermostat, that means you can reorder the HVAC modes or presets. + +

+ Screen recording showing how you can now reorder the HVAC modes on the thermostat shown in a tile card. + You can now reorder the features of the tile card. +

From 2bf1f8b0a3fc8379e33eb532df89d7591a3f898b Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Wed, 15 May 2024 11:31:59 +0200 Subject: [PATCH 021/103] Troubleshooting: restart in safe mode from cmd (#32789) --- source/_docs/troubleshooting_general.markdown | 9 +++++++-- source/_includes/common-tasks/commandline.md | 1 + 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/source/_docs/troubleshooting_general.markdown b/source/_docs/troubleshooting_general.markdown index 9180465edbd..859adac0b23 100644 --- a/source/_docs/troubleshooting_general.markdown +++ b/source/_docs/troubleshooting_general.markdown @@ -8,6 +8,8 @@ related: title: Recovery mode integration - docs: /docs/locked_out/ title: Resetting your password + - docs: /common-tasks/os/#home-assistant-via-the-command-line + title: Home Assistant via command line --- This page provides some information about more generic troubleshooting topics. @@ -39,6 +41,9 @@ You need to identify the issue in the configuration files and fix it there. The ## Restarting Home Assistant in safe mode If your Home Assistant is acting up and you cannot identify a root cause, you can use **Safe mode** to narrow down the number of possible causes. -Safe mode loads Home Assistant Core, but no custom integrations, no custom cards, and no custom themes. If the issue does not persist in Safe mode, the issue is not with Home Assistant Core. Before reporting an issue, check if the issue persists in Safe mode. +**Safe mode** loads Home Assistant Core, but no custom integrations, no custom cards, and no custom themes. If the issue does not persist in **Safe mode**, the issue is not with Home Assistant Core. Before reporting an issue, check if the issue persists in **Safe mode**. + +- To enable Safe mode from the UI, go to **Settings** > **System** > **Restart Home Assistant** (top right) > **Restart Home Assistant in safe mode**. +- If you cannot reach the UI, you can enable **Safe mode** from the [command line](/common-tasks/os/#home-assistant-via-the-command-line): + - ```ha core restart --safe-mode``` -To enable Safe mode, go to **Settings** > **System** > **Restart Home Assistant** (top right) > **Restart Home Assistant in safe mode**. diff --git a/source/_includes/common-tasks/commandline.md b/source/_includes/common-tasks/commandline.md index 8505c66f962..322597c4eec 100644 --- a/source/_includes/common-tasks/commandline.md +++ b/source/_includes/common-tasks/commandline.md @@ -11,6 +11,7 @@ ha core logs ha core options ha core rebuild ha core restart +ha core restart --safe-mode ha core start ha core stats ha core stop From 4d0aaf909f567053764836676c8d2d6534792a41 Mon Sep 17 00:00:00 2001 From: AlCalzone Date: Wed, 15 May 2024 11:46:42 +0200 Subject: [PATCH 022/103] Add HomeSeer SmartStick G8 to supported Z-Wave sticks (#32786) --- source/_docs/z-wave/controllers.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_docs/z-wave/controllers.markdown b/source/_docs/z-wave/controllers.markdown index b5f00710808..0028c908338 100644 --- a/source/_docs/z-wave/controllers.markdown +++ b/source/_docs/z-wave/controllers.markdown @@ -22,6 +22,7 @@ Users should upgrade the firmware on all 700 series controllers to version 7.17. - 800 series controllers (with some caveats, see notes) - Zooz 800 Series Z-Wave Long Range S2 Stick (ZST39 LR) + - HomeSeer SmartStick G8 - 700 series controllers - Aeotec Z-Stick 7 USB stick (ZWA010) (the EU version is not recommended due to RF performance issues) From 2d7c648e52e2955c2316ebe503d0bc660a23e677 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Wed, 15 May 2024 13:50:29 +0200 Subject: [PATCH 023/103] u-integrations: restart HA after changing config (#32727) --- source/_integrations/ubus.markdown | 6 +++- source/_integrations/ue_smart_radio.markdown | 8 +++-- source/_integrations/uk_transport.markdown | 8 +++-- source/_integrations/unifi_direct.markdown | 8 +++-- source/_integrations/unifiled.markdown | 6 ++++ source/_integrations/universal.markdown | 6 +++- source/_integrations/upc_connect.markdown | 8 +++-- .../usgs_earthquakes_feed.markdown | 32 +++++++++++-------- source/_integrations/uvc.markdown | 10 ++++-- 9 files changed, 65 insertions(+), 27 deletions(-) diff --git a/source/_integrations/ubus.markdown b/source/_integrations/ubus.markdown index 4b915e075c7..917632db8ba 100644 --- a/source/_integrations/ubus.markdown +++ b/source/_integrations/ubus.markdown @@ -9,6 +9,9 @@ ha_domain: ubus ha_platforms: - device_tracker ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- This is a presence detection scanner for [OpenWrt](https://openwrt.org/) using [ubus](https://wiki.openwrt.org/doc/techref/ubus). It scans for changes in `hostapd.*`, which will detect and report changes in devices connected to the access point on the router. @@ -66,7 +69,8 @@ Check if the `file` namespaces is registered with the RPC server. file ``` -After this is done, add the following to your {% term "`configuration.yaml`" %} file: +After this is done, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/ue_smart_radio.markdown b/source/_integrations/ue_smart_radio.markdown index 3f80548b0d6..0ef82a723ed 100644 --- a/source/_integrations/ue_smart_radio.markdown +++ b/source/_integrations/ue_smart_radio.markdown @@ -9,11 +9,15 @@ ha_domain: ue_smart_radio ha_platforms: - media_player ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `ue_radio` platform allows you to control a [Logitech UE Smart Radio](https://www.uesmartradio.com) from Home Assistant. This lets you control both Logitech UE Smart Radios and Logitech Squeezebox Radios that have been updated with the UE Smart Radio update. +The `ue_radio` {% term integration %} allows you to control a [Logitech UE Smart Radio](https://www.uesmartradio.com) from Home Assistant. This lets you control both Logitech UE Smart Radios and Logitech Squeezebox Radios that have been updated with the UE Smart Radio update. -To add your UE Smart Radio player to your installation, add the following to your {% term "`configuration.yaml`" %} file: +To add your UE Smart Radio player to your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/uk_transport.markdown b/source/_integrations/uk_transport.markdown index e8f991bd129..720e22c7c76 100644 --- a/source/_integrations/uk_transport.markdown +++ b/source/_integrations/uk_transport.markdown @@ -9,9 +9,12 @@ ha_domain: uk_transport ha_platforms: - sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `uk_transport` sensor will display the time in minutes until the next departure in a specified direction from of a configured train station or bus stop. The sensor uses [transportAPI](https://www.transportapi.com/) to query live departure data and requires a developer application ID and key which can be obtained [here](https://developer.transportapi.com/). The [free tier](https://www.transportapi.com/blog/2022/08/introducing-the-home-use-plan-for-transportapi/) allows 30 requests a day, which is sufficient for a single sensor refreshing every 48 minutes. +The `uk_transport` {% term integration %} will display the time in minutes until the next departure in a specified direction from of a configured train station or bus stop. The sensor uses [transportAPI](https://www.transportapi.com/) to query live departure data and requires a developer application ID and key which can be obtained [here](https://developer.transportapi.com/). The [free tier](https://www.transportapi.com/blog/2022/08/introducing-the-home-use-plan-for-transportapi/) allows 30 requests a day, which is sufficient for a single sensor refreshing every 48 minutes.
@@ -23,7 +26,8 @@ Queries are entered as a list, with the two transport modes available being `bus Train departure sensors require three character long `origin` and `destination` station codes which are searchable on the [National Rail enquiries](https://www.nationalrail.co.uk/times_fares/ldb.aspx) website (e.g., `WAT` is London Waterloo). The validity of a route can be checked by performing a GET request to `/uk/train/station/{station_code}/live.json` in the [API reference webpage](https://developer.transportapi.com/docs?raml=https://transportapi.com/v3/raml/transportapi.raml#request_uk_train_station_station_code_live_json). -To add a single train departure sensor add the following to your {% term "`configuration.yaml`" %} file: +To add a single train departure {% term integration %} add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry for a single sensor diff --git a/source/_integrations/unifi_direct.markdown b/source/_integrations/unifi_direct.markdown index f352e1c0836..2decfc3e17c 100644 --- a/source/_integrations/unifi_direct.markdown +++ b/source/_integrations/unifi_direct.markdown @@ -11,11 +11,15 @@ ha_platforms: ha_integration_type: integration ha_codeowners: - '@tofuSCHNITZEL' +related: + - docs: /docs/configuration/ + title: Configuration file --- -This platform allows you to detect presence by looking at devices connected to a [UniFi AP](https://www.ui.com/products/#unifi). This device tracker differs from [Ubiquiti UniFi](/integrations/unifi) because it doesn't require the UniFi Network application. +This {% term integration %} allows you to detect presence by looking at devices connected to a [UniFi AP](https://www.ui.com/products/#unifi). This device tracker differs from [Ubiquiti UniFi](/integrations/unifi) because it doesn't require the UniFi Network application. -To use this device tracker in your installation, add the following to your {% term "`configuration.yaml`" %} file: +To use this device tracker in your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/unifiled.markdown b/source/_integrations/unifiled.markdown index fb0f18dcb11..9141fede2f0 100644 --- a/source/_integrations/unifiled.markdown +++ b/source/_integrations/unifiled.markdown @@ -11,6 +11,9 @@ ha_domain: unifiled ha_platforms: - light ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- [UniFi LED](https://unifi-led.ui.com/) by [Ubiquiti Networks, inc.](https://www.ui.com/) is a system of controller managed LED light panels and dimmers. @@ -21,6 +24,9 @@ There is currently support for the following device type within Home Assistant: ## Configuration +To use the {% term integration %} in your installation, add it to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} + ```yaml # Example configuration.yaml entry light: diff --git a/source/_integrations/universal.markdown b/source/_integrations/universal.markdown index 1c0ccc78567..2ecac991410 100644 --- a/source/_integrations/universal.markdown +++ b/source/_integrations/universal.markdown @@ -10,13 +10,17 @@ ha_domain: universal ha_platforms: - media_player ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- A universal media player can combine multiple existing entities in Home Assistant into a single media player {% term entity %}. This is used to create a single media player {% term entity %} that can control an entire media center. Multiple media player entities may be controlled from a universal media player. Additionally, the universal media player can enable volume and power commands to be directed to other Home Assistant entities. This enables the media player power and volume commands to control devices like a television, amplifier or audio receiver, for example. -A universal media player is created in {% term "`configuration.yaml`" %} as follows. +To use a universal media player add it to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/upc_connect.markdown b/source/_integrations/upc_connect.markdown index ed7f39fa541..6a7833b9717 100644 --- a/source/_integrations/upc_connect.markdown +++ b/source/_integrations/upc_connect.markdown @@ -12,15 +12,19 @@ ha_iot_class: Local Polling ha_platforms: - device_tracker ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `upc_connect` platform offers presence detection by looking at connected devices to a [Connect Box](https://www.upc.ch/en/internet/learn-about-internet/) from [Liberty Global](https://www.libertyglobal.com) (also known as UPC Cablecom in Switzerland) which is an Internet provider in Switzerland, Austria, the Netherlands (under Ziggo) and Hungary (under Vodafone). +The `upc_connect` {% term integration %} offers presence detection by looking at connected devices to a [Connect Box](https://www.upc.ch/en/internet/learn-about-internet/) from [Liberty Global](https://www.libertyglobal.com) (also known as UPC Cablecom in Switzerland) which is an Internet provider in Switzerland, Austria, the Netherlands (under Ziggo) and Hungary (under Vodafone).
This integration works by logging into the router with a password. The router can only have one active session at any time, so if you want to access your router settings then stop Home Assistant first.
-To use a Connect Box in your installation, add the following to your {% term "`configuration.yaml`" %} file: +To use a Connect Box in your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/usgs_earthquakes_feed.markdown b/source/_integrations/usgs_earthquakes_feed.markdown index 8eaee34241e..2c09b6fd270 100644 --- a/source/_integrations/usgs_earthquakes_feed.markdown +++ b/source/_integrations/usgs_earthquakes_feed.markdown @@ -11,6 +11,9 @@ ha_domain: usgs_earthquakes_feed ha_platforms: - geo_location ha_integration_type: service +related: + - docs: /docs/configuration/ + title: Configuration file --- The `usgs_earthquakes_feed` platform lets you integrate a GeoJSON feed provided by the [U.S. Geological Survey](https://earthquake.usgs.gov/) with information about seismic events like earthquakes. It retrieves incidents from a feed and shows information of those incidents filtered by distance to Home Assistant's location. @@ -29,7 +32,8 @@ The data is updated every 5 minutes. ## Configuration -To integrate the U.S. Geological Survey Earthquake Hazards Program feed, add the following lines to your {% term "`configuration.yaml`" %}. +To integrate the U.S. Geological Survey Earthquake Hazards Program feed, add the following lines to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry @@ -68,7 +72,7 @@ longitude: ### Supported feed types | Description | Feed Type | -|----------------------------------------|--------------------------------------| +| -------------------------------------- | ------------------------------------ | | Past Hour - Significant Earthquakes | `past_hour_significant_earthquakes` | | Past Hour - M4.5+ Earthquakes | `past_hour_m45_earthquakes` | | Past Hour - M2.5+ Earthquakes | `past_hour_m25_earthquakes` | @@ -95,18 +99,18 @@ longitude: The following state attributes are available for each {% term entity %} in addition to the standard ones: -| Attribute | Description | -|--------------------|-------------| -| latitude | Latitude of the earthquake. | -| longitude | Longitude of the earthquake. | -| source | `usgs_earthquakes_feed` to be used in conjunction with `geo_location` automation trigger. | -| external_id | The external ID used in the feed to identify the earthquake in the feed. | -| place | Textual description of named geographic region near to the event. | -| magnitude | Reported magnitude of the earthquake. | -| time | Date and time when this event occurred. | -| updated | Date and time when this event was most recently updated. | -| status | Indicates whether the event has been reviewed by a human: "automatic", "reviewed", "deleted" | -| type | Type of seismic event: "earthquake" or "quarry". | +| Attribute | Description | +| ----------- | -------------------------------------------------------------------------------------------- | +| latitude | Latitude of the earthquake. | +| longitude | Longitude of the earthquake. | +| source | `usgs_earthquakes_feed` to be used in conjunction with `geo_location` automation trigger. | +| external_id | The external ID used in the feed to identify the earthquake in the feed. | +| place | Textual description of named geographic region near to the event. | +| magnitude | Reported magnitude of the earthquake. | +| time | Date and time when this event occurred. | +| updated | Date and time when this event was most recently updated. | +| status | Indicates whether the event has been reviewed by a human: "automatic", "reviewed", "deleted" | +| type | Type of seismic event: "earthquake" or "quarry". | ## Full configuration diff --git a/source/_integrations/uvc.markdown b/source/_integrations/uvc.markdown index 6722d49b2b8..cd44234fc1f 100644 --- a/source/_integrations/uvc.markdown +++ b/source/_integrations/uvc.markdown @@ -9,22 +9,26 @@ ha_domain: uvc ha_platforms: - camera ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `uvc` camera platform allows you to integrate [UniFi Video Camera (UVC)](https://www.ui.com/products/#unifivideo) into Home Assistant. +The `uvc` camera {% term integration %} allows you to integrate [UniFi Video Camera (UVC)](https://www.ui.com/products/#unifivideo) into Home Assistant. The platform connects to the [UniFi NVR software](https://www.ui.com/download/unifi-video) and automatically discovers/adds any camera connected to the NVR. ### Setup -It is recommended that you create a new user for this platform in the NVR software and only give the user the permissions it need to operate. +It is recommended that you create a new user for this {% term integration %} in the NVR software and only give the user the permissions it need to operate. - The API key is found in `User` -> `My account` -> `API Access` in the NVR software. - The camera password is found in `Settings` -> `Camera Settings` -> `Camera Password` in the NVR software. ### Configuration -To enable, add the following to your {% term "`configuration.yaml`" %} file: +To use the {% term integration %} in your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry From 007ea5137433d64f9bf956bd9262a51c3433dcef Mon Sep 17 00:00:00 2001 From: Ramiro Cordero Date: Wed, 15 May 2024 13:28:44 +0000 Subject: [PATCH 024/103] Update freedompro.markdown - Preliminary steps (#32787) * Update freedompro.markdown - Preliminary step Freedompro recently changed the way to obtain an API key. Updating docs accordingly. * Tiny style tweaks --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> --- source/_integrations/freedompro.markdown | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/source/_integrations/freedompro.markdown b/source/_integrations/freedompro.markdown index e5469560f01..16230374a21 100644 --- a/source/_integrations/freedompro.markdown +++ b/source/_integrations/freedompro.markdown @@ -36,11 +36,13 @@ This integration lets you control all [Freedompro](https://freedompro.eu/) acces ## Preliminary steps -You will need to obtain an API key from [Freedompro Cloud](https://home.freedompro.eu/) to use this integration. +You will need to obtain an API key from Freedompro's app to use this integration. -1. Login to [Freedompro Cloud](https://home.freedompro.eu/). -2. Make sure you have at least one accessory paired with the Freedompro Cloud before starting integration. -3. Click on your photo profile. -4. Generate the API key. +1. Download the app on your phone: ([Android](https://play.google.com/store/apps/details?id=eu.freedompro.app&hl=en&gl=US) / [iOS](https://apps.apple.com/en/app/freedompro/id1598082027)). +2. Register and create your first home. +3. Make sure you have at least one accessory paired with the Freedompro Cloud before starting integration. +4. Switch to the **Profile** tab (bottom right corner). +5. Scroll down to the **Developper tools** and tap **Api Key**. +6. Generate an API key. {% include integrations/config_flow.md %} From aaaec45bb5b0b18887e1b9e6f3e231af2ef447cc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20S=C3=B8rensen?= Date: Wed, 15 May 2024 16:12:07 +0200 Subject: [PATCH 025/103] Fix links from includes (#32792) --- source/_includes/feedback.html | 4 ++-- source/_includes/related.html | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/source/_includes/feedback.html b/source/_includes/feedback.html index cf651da824a..2801ad6bd01 100644 --- a/source/_includes/feedback.html +++ b/source/_includes/feedback.html @@ -1,6 +1,6 @@ {% unless page.feedback == false or page.layout == "landingpage" %} -