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

i-k-integrations: add glossary reference to config file (#32757)

Browse Source
This commit is contained in:
c0ffeeca7 2024-05-14 15:16:28 +02:00 committed by GitHub
parent e5d95eeeed
commit 1998c765c3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
17 changed files with 41 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
source/_integrations/ifttt.markdown
View File

@ -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**. `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) ![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.
<div class='note'> <div class='note'>
After restarting the server, be sure to watch the console for any logging errors that show up in red, white or yellow. 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. When your screen looks like this, click the 'call service' button.
![Testing service.](/images/integrations/ifttt/testing_service.png) ![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: want to send the trigger to a specific key use the `target` field:
| Field | Value | | Field | Value |

6
source/_integrations/image.mqtt.markdown
View File

@ -18,7 +18,7 @@ An alternative setup is to use the `url_topic` option to receive an image URL fo
## Configuration ## 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -176,7 +176,7 @@ url_topic:
### Example receiving images from a URL ### 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: To test it publish an image URL to the topic from the console:
@ -197,7 +197,7 @@ mqtt:
### Example receiving images from a file ### 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: To test it, publish an image URL to the topic from the console:

2
source/_integrations/influxdb.markdown
View File

@ -314,7 +314,7 @@ influxdb:
### Configuration ### 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

6
source/_integrations/input_boolean.markdown
View File

@ -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. 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 To be able to add **Helpers** via the user interface you should have
`default_config:` in your `configuration.yaml`, it should already be there by `default_config:` in your {% term "`configuration.yaml`" %}, it should already be there by
default unless you removed it. If you removed `default_config:` from your default unless you removed it. If you removed `default_config:` from your
configuration, you must add `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. 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 %} {% configuration %}
input_boolean: input_boolean:

4
source/_integrations/input_button.markdown
View File

@ -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. 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 To be able to add **Helpers** via the user interface you should have
`default_config:` in your `configuration.yaml`, it should already be there by `default_config:` in your {% term "`configuration.yaml`" %}, it should already be there by
default unless you removed it. If you removed `default_config:` from your default unless you removed it. If you removed `default_config:` from your
configuration, you must add `input_button:` to your `configuration.yaml` first, configuration, you must add `input_button:` to your `configuration.yaml` first,
then you can use the UI. 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

26
source/_integrations/input_datetime.markdown
View File

@ -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. 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. 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, `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, 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -79,11 +79,11 @@ A datetime input entity's state exports several attributes that can be useful in
automations and templates. automations and templates.
| Attribute | Description | | Attribute | Description |
| ----- | ----- | | -------------------------- | -------------------------------------------------------------------------------------------- |
| `has_time` | `true` if this entity has a time. | `has_time` | `true` if this entity has a time. |
| `has_date` | `true` if this entity has a date. | `has_date` | `true` if this entity has a date. |
| `year`<br>`month`<br>`day` | The year, month and day of the date.<br>(only available if `has_date: true`) | `year`<br>`month`<br>`day` | The year, month and day of the date.<br>(only available if `has_date: true`) |
| `timestamp` | A timestamp representing the time held in the input.<br>(only available if `has_time: true`) | `timestamp` | A timestamp representing the time held in the input.<br>(only available if `has_time: true`) |
### Restore state ### Restore state
@ -95,12 +95,12 @@ Available service: `input_datetime.set_datetime` and `input_datetime.reload`.
#### input_datetime.set_datetime #### input_datetime.set_datetime
Service data attribute | Format String | Description | Service data attribute | Format String | Description |
-|-|- | ---------------------- | ------------------- | -------------------------------------------------------------------------------- |
`date` | `%Y-%m-%d` | This can be used to dynamically set the date. | `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. | `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. | `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. | `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. 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.

4
source/_integrations/input_number.markdown
View File

@ -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. 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. 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

4
source/_integrations/input_select.markdown
View File

@ -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. 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. 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

4
source/_integrations/input_text.markdown
View File

@ -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. 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. 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 ```yaml
# Example configuration.yaml entries # Example configuration.yaml entries

2
source/_integrations/integration.markdown
View File

@ -48,7 +48,7 @@ Integration time:
Alternatively, this integration can be configured and set up manually via YAML Alternatively, this integration can be configured and set up manually via YAML
as well. To enable the Integration sensor in your installation, add the 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

2
source/_integrations/intellifire.markdown
View File

@ -121,7 +121,7 @@ The IFT module can suffer a variety of issues that will render it inoperable. So
#### Enabling Debugging #### 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 ```yaml

2
source/_integrations/intesishome.markdown
View File

@ -19,7 +19,7 @@ Note: IntesisHome products are a separate product line to IntesisBox. This platf
## Configuration ## 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 ```yaml
climate: climate:

2
source/_integrations/izone.markdown
View File

@ -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 (read-only, set the value via the individual zones). The current temperature will also be that of the control
zone. 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): along with the supply temperature (use the ID of your unit):
{% raw %} {% raw %}

2
source/_integrations/joaoapps_join.markdown
View File

@ -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 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. 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 or name of the target device. You can find your device id and API key
[here](https://joinjoaomgcd.appspot.com/). [here](https://joinjoaomgcd.appspot.com/).

2
source/_integrations/keba.markdown
View File

@ -135,7 +135,7 @@ The service `keba.set_failsafe` sets the failsafe mode of the charging station.
## Notifications ## 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 ### Configuration

2
source/_integrations/keyboard.markdown
View File

@ -18,7 +18,7 @@ The `keyboard` integration simulates key presses on the host machine. It current
- `keyboard/media_next_track` - `keyboard/media_next_track`
- `keyboard/media_prev_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 ```yaml
keyboard: keyboard:

6
source/_integrations/kodi.markdown
View File

@ -29,7 +29,7 @@ There is currently support for the following device types within Home Assistant:
{% include integrations/config_flow.md %} {% 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: 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. - Your turn on/off actions will not be imported. This functionality is now available through device triggers.
- You may have duplicate entities. - 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 #### 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 ```yaml
script: 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. 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry