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