Skip to content

Document include filename with substitutions #5706

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jpeletier wants to merge 1 commit into
base: next
Choose a base branch
from
Open

Document include filename with substitutions #5706

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions content/components/packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,29 @@ switch:
# ...
```

It is also possible to use substitutions/Jinja in include filenames, allowing to dynamically select what file is loaded:

```yaml
substitutions:
platform: esp32

packages:
hardware: !include device-${platform}.yaml

light:
- platform: status_led
name: "Board Status"
pin: LED_GPIO
```

```yaml
# device-esp32.yaml
substitutions:
LED_GPIO: 2
esp32:
board: esp32dev
```

{{< anchor "config-packages_extend" >}}

## Extend
Expand Down
37 changes: 27 additions & 10 deletions content/components/substitutions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ In the above example, the value of the `text` property will be, literally, `This

## Substitute !include variables

ESPHome's `!include` accepts a list of variables that can be substituted within the included file.
ESPHome's `!include` accepts a list of variables that can be substituted within the included file. The file path may itself be constructed out of any expression that evaluates to a valid path.

```yaml
binary_sensor:
Expand All @@ -180,14 +180,13 @@ binary_sensor:
- platform: gpio
id: button2
pin: GPIOXX
on_multi_click: !include
# multi-line syntax
on_multi_click: !include # multi-line syntax
file: on-multi-click.yaml
vars:
id: 2
```

`on-multi-click.yaml` :
`on-multi-click.yaml` :

```yaml
- timing: !include click-single.yaml
Expand All @@ -202,6 +201,22 @@ binary_sensor:
payload: double
```

You can also use substitutions to build the path of the file to be loaded:

```yaml
substitutions:
platform: esp32

binary_sensor:
- platform: gpio
id: button2
pin: GPIOXX
on_multi_click: !include
file: on-multi-click-${platform}.yaml
vars:
id: 2
```

{{< anchor "command-line-substitutions" >}}

## Command line substitutions
Expand Down Expand Up @@ -253,12 +268,12 @@ esphome:
# ...

sensor:
- platform: dht
# ...
temperature:
name: Temperature
humidity:
name: Humidity
- platform: dht
# ...
temperature:
name: Temperature
humidity:
name: Humidity
```

```yaml
Expand All @@ -269,6 +284,8 @@ substitutions:
<<: !include common.yaml
```

NOTE: using substitutions in the `!include` filename of a YAML insertion operator is not supported yet.

> [!TIP]
> To hide these base files from the dashboard, you can
>
Expand Down