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-15 13:26:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add termref to configuration.yaml (#34275)

Browse Source 
- to make it clearer that the example yaml snipped belongs there
This commit is contained in:
c0ffeeca7 2024-08-13 09:26:20 +02:00 committed by GitHub
parent 49a923a061
commit dc75f93bc7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
16 changed files with 60 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
source/_integrations/bluetooth.markdown
View File

@ -13,6 +13,13 @@ ha_integration_type: integration
ha_config_flow: true ha_config_flow: true
ha_platforms: ha_platforms:
- diagnostics - diagnostics
related:
- docs: /docs/configuration/
title: Configuration file
- docs: /integrations/default_config/
title: Default config
- url: https://esphome.io/projects/?type=bluetooth
title: Bluetooth proxy page
--- ---
The **Bluetooth** {% term integration %} will detect nearby Bluetooth devices. Discovered devices will show up in the discovered section on the integrations page in the configuration panel. The **Bluetooth** {% term integration %} will detect nearby Bluetooth devices. Discovered devices will show up in the discovered section on the integrations page in the configuration panel.

5
source/_integrations/config.markdown
View File

@ -11,11 +11,14 @@ ha_domain: config
ha_platforms: ha_platforms:
- scene - scene
ha_integration_type: system ha_integration_type: system
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
The `config` integration is designed to display panels in the frontend to configure and manage parts of Home Assistant. The `config` integration is designed to display panels in the frontend to configure and manage parts of Home Assistant.
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: This integration is by default enabled, unless you've disabled or removed the [`default_config:`](/integrations/default_config/) line from your {% term "`configuration.yaml`" %} file. If that is the case, the following example shows you how to enable this integration manually:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

2
source/_integrations/device_tracker.markdown
View File

@ -47,7 +47,7 @@ Note that setting `track_new_devices: false` will still result in new devices be
{% endnote %} {% endnote %}
The extended example from above would look like the following sample: In the {% term "`configuration.yaml`" %}, the extended example from above would look like the following sample:
```yaml ```yaml
# Example configuration.yaml entry for Netgear device # Example configuration.yaml entry for Netgear device

2
source/_integrations/dhcp.markdown
View File

@ -16,7 +16,7 @@ The **DHCP discovery** {% term integration %} will watch the network for DHCP re
## Configuration ## Configuration
This {% term 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: This {% term 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 in the {% term "`configuration.yaml`" %} file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

2
source/_integrations/emulated_hue.markdown
View File

@ -122,7 +122,7 @@ entities:
type: list type: list
{% endconfiguration %} {% endconfiguration %}
A full configuration sample looks like the one below. A full configuration sample looks like the one below. Configuration entries are added to the {% term "`configuration.yaml`" %} file.
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

2
source/_integrations/fan.template.markdown
View File

@ -25,7 +25,7 @@ ability to run scripts or invoke actions for each of the `turn_on`, `turn_off`,
## Configuration ## Configuration
To enable template fans in your installation, add the following to your To enable template fans in your installation, add the following to your
`configuration.yaml` file: {% term "`configuration.yaml`" %} file:
{% raw %} {% raw %}

2
source/_integrations/flux.markdown
View File

@ -104,7 +104,7 @@ unique_id:
type: string type: string
{% endconfiguration %} {% endconfiguration %}
Full example: Full example of an entry in the {% term "`configuration.yaml`" %} file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

9
source/_integrations/frontend.markdown
View File

@ -11,7 +11,7 @@ ha_domain: frontend
ha_integration_type: system ha_integration_type: system
--- ---
This offers the official frontend to control Home Assistant. This integration is enabled by default 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: This offers the official frontend to control Home Assistant. This integration is enabled by default unless you've disabled or removed the [`default_config:`](/integrations/default_config/) line from your {% term "`configuration.yaml`" %} file. If that is the case, the following example shows you how to enable this integration manually in the {% term "`configuration.yaml`" %} file.
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -52,6 +52,7 @@ frontend:
### Theme format ### Theme format
The frontend integration allows you to create custom themes to influence the look and feel of the user interface. The frontend integration allows you to create custom themes to influence the look and feel of the user interface.
Example of a configuration entry in the {% term "`configuration.yaml`" %} file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -163,9 +164,9 @@ There are two themes-related actions:
### Action `set_theme` ### Action `set_theme`
| Data attribute | Description | | Data attribute | Description |
| ---------------------- | --------------------------------------------------------------------------------------------------- | | -------------- | --------------------------------------------------------------------------------------------------- |
| `name` | Name of the theme to set, `default` for the default theme or `none` to restore to the default. | | `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. 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. The backend theme settings will be saved and restored on a restart of Home Assistant.

4
source/_integrations/generic_hygrostat.markdown
View File

@ -33,7 +33,7 @@ If you need more specific features for your use case, the manual [YAML-configura
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 generic hygrostat in your installation, add the as well. To enable the generic hygrostat 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
@ -122,6 +122,8 @@ Time for `min_cycle_duration` and `keep_alive` must be set as "hh:mm:ss" or it m
## Full YAML configuration example ## Full YAML configuration example
To be added to the {% term "`configuration.yaml`" %} file.
```yaml ```yaml
generic_hygrostat: generic_hygrostat:
- name: Bedroom - name: Bedroom

42
source/_integrations/homeassistant.markdown
View File

@ -24,7 +24,7 @@ The **Home Assistant Core** {% term integration %} provides generic implementati
The Home Assistant Core integration is also responsible for the general settings. These settings are defined during onboarding, but you can change them later under {% my general title="**Settings** > **System** > **General**" %}. For the detailed steps, refer to [Basic settings](/docs/configuration/basic/). The Home Assistant Core integration is also responsible for the general settings. These settings are defined during onboarding, but you can change them later under {% my general title="**Settings** > **System** > **General**" %}. For the detailed steps, refer to [Basic settings](/docs/configuration/basic/).
If you prefer editing in YAML, you can define your general settings in the [`configuration.yaml` file](/docs/configuration/). If you prefer editing in YAML, you can define your general settings in the {% term "`configuration.yaml`" %} file.
Note that for some of the settings, these can't be edited from the UI if they were defined in YAML. They will be grayed out or inaccessible. Note that for some of the settings, these can't be edited from the UI if they were defined in YAML. They will be grayed out or inaccessible.
<p class='img'> <p class='img'>
@ -34,7 +34,7 @@ Note that for some of the settings, these can't be edited from the UI if they we
To get started with the general settings in YAML, follow these steps: To get started with the general settings in YAML, follow these steps:
1. Copy the following information to your [`configuration.yaml` file](/docs/configuration/). 1. Copy the following information to your {% term "`configuration.yaml`" %} file.
```yaml ```yaml
homeassistant: homeassistant:
@ -150,7 +150,7 @@ By default, all of your devices will be visible and have a default icon determin
Most of these settings can be changed from the UI. For the detailed steps, refer to [Customizing entities](/docs/configuration/customizing-devices/). Most of these settings can be changed from the UI. For the detailed steps, refer to [Customizing entities](/docs/configuration/customizing-devices/).
If you prefer editing in YAML, you can define your general settings in the [`configuration.yaml` file](/docs/configuration/). If you prefer editing in YAML, you can define your general settings in the {% term "`configuration.yaml`" %} file.
### Possible values ### Possible values
@ -212,7 +212,7 @@ For a list of the supported device classes, refer to the documentation of the pl
### Manual customization ### Manual customization
{% important %} {% important %}
If you implement `customize`, `customize_domain`, or `customize_glob` you must make sure it is done inside of `homeassistant:` or it will fail. If you implement `customize`, `customize_domain`, or `customize_glob`, in your {% term "`configuration.yaml`" %} file, you must make sure it is done inside of `homeassistant:` or it will fail.
{% endimportant %} {% endimportant %}
```yaml ```yaml
@ -280,11 +280,11 @@ will take effect the next time an importing template is rendered.
Reloads an integration config entry. Reloads an integration config entry.
| Data attribute | Description | | Data attribute | Description |
| ---------------------- | ---------------------------------------------------------- | | -------------- | ---------------------------------------------------------- |
| `entity_id` | List of entity ids used to reference a config entry. | | `entity_id` | List of entity ids used to reference a config entry. |
| `area_id` | List of area ids used to reference a config entry. | | `area_id` | List of area ids used to reference a config entry. |
| `device_id` | List of device ids used to reference a config entry. | | `device_id` | List of device ids used to reference a config entry. |
| `entry_id` | A single config entry id used to reference a config entry. | | `entry_id` | A single config entry id used to reference a config entry. |
### Action `homeassistant.reload_core_config` ### Action `homeassistant.reload_core_config`
@ -305,10 +305,10 @@ Stops the Home Assistant instance. Home Assistant must be restarted from the Hos
Update the location of the Home Assistant default zone (usually "Home"). Update the location of the Home Assistant default zone (usually "Home").
| Data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------- | | -------------- | -------- | --------------------------- |
| `latitude` | no | Latitude of your location. | | `latitude` | no | Latitude of your location. |
| `longitude` | no | Longitude of your location. | | `longitude` | no | Longitude of your location. |
| `elevation` | yes | Elevation of your location. | | `elevation` | yes | Elevation of your location. |
#### Example #### Example
@ -329,8 +329,8 @@ action compared the others, is that is can be used to mix different domains,
for example, a light and a switch can be toggled in a single action. for example, a light and a switch can be toggled in a single action.
| Data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------- | | -------------- | -------- | --------------------------------------------- |
| `entity_id` | yes | The entity_id of the device to toggle on/off. | | `entity_id` | yes | The entity_id of the device to toggle on/off. |
#### Example #### Example
@ -351,8 +351,8 @@ action compared the others, is that is can be used to mix different domains,
for example, a light and a switch can be turned on in a single action. for example, a light and a switch can be turned on in a single action.
| Data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------- | | -------------- | -------- | --------------------------------------- |
| `entity_id` | yes | The entity_id of the device to turn on. | | `entity_id` | yes | The entity_id of the device to turn on. |
#### Example #### Example
@ -373,8 +373,8 @@ action compared the others, is that is can be used to mix different domains,
for example, a light and a switch can be turned off in a single action. for example, a light and a switch can be turned off in a single action.
| Data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------- | | -------------- | -------- | ---------------------------------------- |
| `entity_id` | yes | The entity_id of the device to turn off. | | `entity_id` | yes | The entity_id of the device to turn off. |
#### Example #### Example
@ -392,8 +392,8 @@ action:
Force one or more entities to update its data rather than wait for the next scheduled update. Force one or more entities to update its data rather than wait for the next scheduled update.
| Data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------- | | -------------- | -------- | ------------------------------------------------------- |
| `entity_id` | no | One or multiple entity_ids to update. It can be a list. | | `entity_id` | no | One or multiple entity_ids to update. It can be a list. |
#### Example #### Example

2
source/_integrations/homeassistant_alerts.markdown
View File

@ -22,7 +22,7 @@ dashboard if an alert is found that impacts your system.
## Configuration ## Configuration
This integration is by default enabled unless you've disabled or removed the This integration is by default enabled unless you've disabled or removed the
[`default_config:`](/integrations/default_config/) line from your configuration. [`default_config:`](/integrations/default_config/) line from your {% term "`configuration.yaml`" %} file.
If that is the case, the following example shows you how to enable this If that is the case, the following example shows you how to enable this
integration manually: integration manually:

2
source/_integrations/http.markdown
View File

@ -86,7 +86,7 @@ ssl_profile:
default: modern default: modern
{% endconfiguration %} {% endconfiguration %}
The sample below shows a configuration entry with possible values: The sample below shows a configuration entry in the {% term "`configuration.yaml`" %} file with possible values:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

2
source/_integrations/input_boolean.markdown
View File

@ -30,7 +30,7 @@ default unless you removed it. If you removed `default_config:` from your
configuration, you must add `input_boolean:` to your {% term "`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 {% term "`configuration.yaml`" %}: Input booleans can also be configured via {% term "`configuration.yaml`" %} file:
{% configuration %} {% configuration %}
input_boolean: input_boolean:

12
source/_integrations/input_datetime.markdown
View File

@ -19,7 +19,7 @@ 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 {% term "`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 {% term "`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,
@ -96,11 +96,11 @@ Available actions: `input_datetime.set_datetime` and `input_datetime.reload`.
#### input_datetime.set_datetime #### input_datetime.set_datetime
| Data attribute | Format String | Description | | 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.

2
source/_integrations/light.template.markdown
View File

@ -23,7 +23,7 @@ ability to run scripts or invoke actions for each of the on, off, and
brightness commands of a light. brightness commands of a light.
To enable Template Lights in your installation, add the following to your To enable Template Lights in your installation, add the following to your
`configuration.yaml` file: {% term "`configuration.yaml`" %} file:
{% raw %} {% raw %}

7
source/_integrations/logbook.markdown
View File

@ -9,11 +9,14 @@ ha_quality_scale: internal
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: system ha_integration_type: system
related:
- docs: /docs/configuration/
title: Configuration file
--- ---
<img src='/images/screenshots/logbook.png' style='margin-left:10px; float: right;' height="100" /> <img src='/images/screenshots/logbook.png' style='margin-left:10px; float: right;' height="100" />
The logbook integration provides a different perspective on the history of your The logbook {% term integration %} provides a different perspective on the history of your
house by showing all the changes that happened to your house in reverse house by showing all the changes that happened to your house in reverse
chronological order. It depends on chronological order. It depends on
the [`recorder`](/integrations/recorder/) integration for storing the data. This means that if the the [`recorder`](/integrations/recorder/) integration for storing the data. This means that if the
@ -21,7 +24,7 @@ the [`recorder`](/integrations/recorder/) integration for storing the data. This
PostgreSQL as data store, the `logbook` integration does not use the default PostgreSQL as data store, the `logbook` integration does not use the default
SQLite database to store data. SQLite database to store data.
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: This integration is by default enabled, unless you've disabled or removed the [`default_config:`](/integrations/default_config/) line from your {% term "`configuration.yaml`" %} file. If that is the case, the following example shows you how to enable this integration manually, by adding it to your {% term "`configuration.yaml`" %} file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry