Skip to content

Fix automation links #5490

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
wants to merge 2 commits into
base: current
Choose a base branch
from
Open

Fix automation links #5490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
695d366
Fix automation link
edenhaus Oct 16, 2025
698d657
Fix automation links
edenhaus Oct 16, 2025
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
4 changes: 2 additions & 2 deletions content/changelog/v1.7.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ be travelling a lot (and enjoying my vacation 😎), so don't expect too many aw

## New Features

- While all [automations](#automation) were previously already performed on the ESP itself, they only
- While all [automations](/automations) were previously already performed on the ESP itself, they only
triggered when an active WiFi and MQTT connection existed. Large parts of the WiFi and MQTT clients has now
been rewritten to allow for automations to be executed asynchronously, while the device is still connecting to WiFi.

Expand All @@ -64,7 +64,7 @@ be travelling a lot (and enjoying my vacation 😎), so don't expect too many aw
complicated actions using lambdas. See [Binary Sensor Filters](#binary_sensor-filters). ⛹️‍

- All components can now be flagged `internal`. Doing so will prevent them from being represented in the front-end
(like MQTT). Useful for [on-device automations](#automation). See 😎
(like MQTT). Useful for [on-device automations](/automations). See 😎

- The {{< docref "/components/deep_sleep" >}} now has a `wakeup_pin_mode` option for the ESP32. This option
can be used to tell esphomelib what to do if the wakeup pin is already in the wakeup level when attempting
Expand Down
10 changes: 5 additions & 5 deletions content/components/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ Then:
> your device to perform actions.

When using the native API with Home Assistant, you can create events in the Home Assistant event bus
straight from ESPHome [Automations](#automation).
straight from ESPHome [Automations](/automations).

```yaml
# In some trigger
Expand Down Expand Up @@ -172,7 +172,7 @@ on_...:
> Be sure to [follow the instructions above](#api-actions) to tell Home Assistant to allow
> your device to perform actions.

When using the native API with Home Assistant, you can perform Home Assistant actions straight from ESPHome [Automations](#automation).
When using the native API with Home Assistant, you can perform Home Assistant actions straight from ESPHome [Automations](/automations).

```yaml
# In some trigger
Expand Down Expand Up @@ -213,11 +213,11 @@ on_...:
the action response data. This template is evaluated on the Home Assistant side with Home Assistant's templating engine.
Requires `capture_response: true`.

- **on_success** (*Optional*, [Automation](#automation)): Optional automation to execute when the Home Assistant action
- **on_success** (*Optional*, [Automation](/automations)): Optional automation to execute when the Home Assistant action
call succeeds. When `capture_response: true`, the response data is available as a `response` variable of type `JsonObjectConst`.
See [Action Response Handling](#action-response-handling).

- **on_error** (*Optional*, [Automation](#automation)): Optional automation to execute when the Home Assistant action
- **on_error** (*Optional*, [Automation](/automations)): Optional automation to execute when the Home Assistant action
call fails. See [Action Response Handling](#action-response-handling).

Data structures are not possible, but you can create a script in Home Assistant and call with all
Expand Down Expand Up @@ -330,7 +330,7 @@ When `response_template` is used, the processed result is available in `response
> your device to make action calls.

When using the native API with Home Assistant, you can push tag_scanned to Home Assistant
straight from ESPHome [Automations](#automation).
straight from ESPHome [Automations](/automations).

```yaml
# In some trigger
Expand Down
26 changes: 13 additions & 13 deletions content/components/binary_sensor/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,24 +44,24 @@ Configuration variables:

Automations:

- **on_press** (*Optional*, [Automation](#automation)): An automation to perform
- **on_press** (*Optional*, [Automation](/automations)): An automation to perform
when the button is pressed. See [`on_press`](#binary_sensor-on_press).

- **on_release** (*Optional*, [Automation](#automation)): An automation to perform
- **on_release** (*Optional*, [Automation](/automations)): An automation to perform
when the button is released. See [`on_release`](#binary_sensor-on_release).

- **on_state** (*Optional*, [Automation](#automation)): An automation to perform
- **on_state** (*Optional*, [Automation](/automations)): An automation to perform
when a state change is published. See [`on_state`](#binary_sensor-on_state).

- **on_click** (*Optional*, [Automation](#automation)): An automation to perform
- **on_click** (*Optional*, [Automation](/automations)): An automation to perform
when the button is held down for a specified period of time.
See [`on_click`](#binary_sensor-on_click).

- **on_double_click** (*Optional*, [Automation](#automation)): An automation to perform
- **on_double_click** (*Optional*, [Automation](/automations)): An automation to perform
when the button is pressed twice for specified periods of time.
See [`on_double_click`](#binary_sensor-on_double_click).

- **on_multi_click** (*Optional*, [Automation](#automation)): An automation to perform
- **on_multi_click** (*Optional*, [Automation](/automations)): An automation to perform
when the button is pressed in a specific sequence.
See [`on_multi_click`](#binary_sensor-on_multi_click).

Expand Down Expand Up @@ -266,7 +266,7 @@ binary_sensor:
- switch.turn_on: relay_1
```

Configuration variables: See [Automation](#automation).
Configuration variables: See [Automation](/automations).

{{< anchor "binary_sensor-on_release" >}}

Expand All @@ -284,7 +284,7 @@ binary_sensor:
- switch.turn_off: relay_1
```

Configuration variables: See [Automation](#automation).
Configuration variables: See [Automation](/automations).

{{< anchor "binary_sensor-on_state" >}}

Expand All @@ -304,7 +304,7 @@ binary_sensor:
- switch.turn_off: relay_1
```

Configuration variables: See [Automation](#automation).
Configuration variables: See [Automation](/automations).

{{< anchor "binary_sensor-on_state_change" >}}

Expand All @@ -328,7 +328,7 @@ binary_sensor:
args: ['x.has_value() ? ONOFF(x) : "Unknown"']
```

Configuration variables: See [Automation](#automation).
Configuration variables: See [Automation](/automations).

{{< anchor "binary_sensor-on_click" >}}

Expand All @@ -353,7 +353,7 @@ Configuration variables:

- **min_length** (*Optional*, [Time](#config-time)): The minimum duration the click should last. Defaults to `50ms`.
- **max_length** (*Optional*, [Time](#config-time)): The maximum duration the click should last. Defaults to `350ms`.
- See [Automation](#automation).
- See [Automation](/automations).

> [!NOTE]
> Multiple `on_click` entries can be defined like this (see also [`on_multi_click`](#binary_sensor-on_multi_click)
Expand Down Expand Up @@ -397,7 +397,7 @@ Configuration variables:

- **min_length** (*Optional*, [Time](#config-time)): The minimum duration the click should last. Defaults to `50ms`.
- **max_length** (*Optional*, [Time](#config-time)): The maximum duration the click should last. Defaults to `350ms`.
- See [Automation](#automation).
- See [Automation](/automations).

{{< anchor "binary_sensor-on_multi_click" >}}

Expand Down Expand Up @@ -432,7 +432,7 @@ Configuration variables:
set in `timing` does not match, a "cool down" period will be activated during which no timing
will be matched. Defaults to `1s`.

- See [Automation](#automation).
- See [Automation](/automations).

> [!NOTE]
> Getting the timing right for your use-case can sometimes be a bit difficult. If you set the
Expand Down
2 changes: 1 addition & 1 deletion content/components/binary_sensor/analog_threshold.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,5 +49,5 @@ binary_sensor:

- {{< docref "/components/binary_sensor" >}}
- {{< docref "/components/sensor" >}}
- [Automation](#automation)
- [Automation](/automations)
- {{< apiref "analog_threshold/analog_threshold_binary_sensor.h" "analog_threshold/analog_threshold_binary_sensor.h" >}}
2 changes: 1 addition & 1 deletion content/components/binary_sensor/homeassistant.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,5 +44,5 @@ binary_sensor:

## See Also

- [Automation](#automation)
- [Automation](/automations)
- {{< apiref "homeassistant/binary_sensor/homeassistant_binary_sensor.h" "homeassistant/binary_sensor/homeassistant_binary_sensor.h" >}}
2 changes: 1 addition & 1 deletion content/components/binary_sensor/packet_transport.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ configured.

- {{< docref "/components/packet_transport" >}}
- {{< docref "/components/sensor" >}}
- [Automation](#automation)
- [Automation](/automations)
6 changes: 3 additions & 3 deletions content/components/binary_sensor/pn532.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,10 @@ binary_sensor:
duration that the individual binary sensors stay active when they're found.
If a device is not found within this time window, it will be marked as not present. Defaults to 1s.

- **on_tag** (*Optional*, [Automation](#automation)): An automation to perform
- **on_tag** (*Optional*, [Automation](/automations)): An automation to perform
when a tag is read. See [pn532-on_tag](#pn532-on_tag).

- **on_tag_removed** (*Optional*, [Automation](#automation)): An automation to perform
- **on_tag_removed** (*Optional*, [Automation](/automations)): An automation to perform
when a tag is removed. See [`on_tag_removed`](#pn532-on_tag_removed).

- **spi_id** (*Optional*, [ID](#config-id)): Manually specify the ID of the [SPI Component](#spi) if you want
Expand Down Expand Up @@ -93,7 +93,7 @@ binary_sensor:
duration that the individual binary sensors stay active when they're found.
If a device is not found within this time window, it will be marked as not present. Defaults to 1s.

- **on_tag** (*Optional*, [Automation](#automation)): An automation to perform
- **on_tag** (*Optional*, [Automation](/automations)): An automation to perform
when a tag is read. See [pn532-on_tag](#pn532-on_tag).

- **i2c_id** (*Optional*, [ID](#config-id)): Manually specify the ID of the [I²C Component](#i2c) if you want
Expand Down
8 changes: 4 additions & 4 deletions content/components/binary_sensor/rc522.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,10 @@ binary_sensor:
to use multiple SPI buses.

- **id** (*Optional*, [ID](#config-id)): Manually specify the ID for this component.
- **on_tag** (*Optional*, [Automation](#automation)): An automation to perform when a tag is read. See
- **on_tag** (*Optional*, [Automation](/automations)): An automation to perform when a tag is read. See
[`on_tag` Trigger](#rc522-on_tag).

- **on_tag_removed** (*Optional*, [Automation](#automation)): An automation to perform after a tag is removed. See
- **on_tag_removed** (*Optional*, [Automation](/automations)): An automation to perform after a tag is removed. See
[`on_tag_removed` Trigger](#rc522-on_tag_removed).

## Over I²C
Expand Down Expand Up @@ -100,10 +100,10 @@ binary_sensor:
to use multiple I²C buses.

- **id** (*Optional*, [ID](#config-id)): Manually specify the ID for this component.
- **on_tag** (*Optional*, [Automation](#automation)): An automation to perform when a tag is read. See
- **on_tag** (*Optional*, [Automation](/automations)): An automation to perform when a tag is read. See
[`on_tag` Trigger](#rc522-on_tag).

- **on_tag_removed** (*Optional*, [Automation](#automation)): An automation to perform after a tag is removed. See
- **on_tag_removed** (*Optional*, [Automation](/automations)): An automation to perform after a tag is removed. See
[`on_tag_removed` Trigger](#rc522-on_tag_removed).

## Triggers
Expand Down
2 changes: 1 addition & 1 deletion content/components/binary_sensor/rdm6300.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ binary_sensor:
- **uart_id** (*Optional*, [ID](#config-id)): Manually specify the ID of the [UART Component](#uart) if you want
to use multiple UART buses.

- **on_tag** (*Optional*, [Automation](#automation)): An automation to perform
- **on_tag** (*Optional*, [Automation](/automations)): An automation to perform
when a tag is read. See [`on_tag`](#rdm6300-on_tag).

- **id** (*Optional*, [ID](#config-id)): Manually specify the ID for this component.
Expand Down
2 changes: 1 addition & 1 deletion content/components/binary_sensor/template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,5 +98,5 @@ Configuration options:

- {{< docref "/components/binary_sensor" >}}
- {{< docref "/components/sensor/template" >}}
- [Automation](#automation)
- [Automation](/automations)
- {{< apiref "template/binary_sensor/template_binary_sensor.h" "template/binary_sensor/template_binary_sensor.h" >}}
12 changes: 6 additions & 6 deletions content/components/ble_client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,19 +48,19 @@ ble_client:

Automations:

- **on_connect** (*Optional*, [Automation](#automation)): An automation to perform
- **on_connect** (*Optional*, [Automation](/automations)): An automation to perform
when the client connects to a device. See [`on_connect`](#ble_client-on_connect).

- **on_disconnect** (*Optional*, [Automation](#automation)): An automation to perform
- **on_disconnect** (*Optional*, [Automation](/automations)): An automation to perform
when the client disconnects from a device. See [`on_disconnect`](#ble_client-on_disconnect).

- **on_passkey_request** (*Optional*, [Automation](#automation)): An automation to enter
- **on_passkey_request** (*Optional*, [Automation](/automations)): An automation to enter
the passkey required by the other BLE device. See [`on_passkey_request`](#ble_client-on_passkey_request).

- **on_passkey_notification** (*Optional*, [Automation](#automation)): An automation to
- **on_passkey_notification** (*Optional*, [Automation](/automations)): An automation to
display the passkey to the user. See [`on_passkey_notification`](#ble_client-on_passkey_notification).

- **on_numeric_comparison_request** (*Optional*, [Automation](#automation)): An automation to
- **on_numeric_comparison_request** (*Optional*, [Automation](/automations)): An automation to
compare the passkeys shown on the two BLE devices. See [`on_numeric_comparison_request`](#ble_client-on_numeric_comparison_request).

## BLE Client Automation
Expand Down Expand Up @@ -494,5 +494,5 @@ ble_client:
## See Also

- {{< docref "/components/sensor/ble_client" >}}
- [Automation](#automation)
- [Automation](/automations)
- {{< apiref "ble_client/ble_client.h" "ble_client/ble_client.h" >}}
4 changes: 2 additions & 2 deletions content/components/button/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Configuration variables:

Automations:

- **on_press** (*Optional*, [Automation](#automation)): An automation to perform
- **on_press** (*Optional*, [Automation](/automations)): An automation to perform
when the button is pressed. See [`on_press`](#button-on_press).

MQTT options:
Expand All @@ -90,7 +90,7 @@ button:
- logger.log: Button Pressed
```

Configuration variables: see [Automation](#automation).
Configuration variables: see [Automation](/automations).

{{< anchor "button-press_action" >}}

Expand Down
2 changes: 1 addition & 1 deletion content/components/canbus/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ canbus:
- `500KBPS`
- `1000KBPS`

- **on_frame** (*Optional*, [Automation](#automation)): An automation to perform when a
- **on_frame** (*Optional*, [Automation](/automations)): An automation to perform when a
CAN frame is received. See [`on_frame` Trigger](#canbus-on-frame).

{{< anchor "platforms-canbus" >}}
Expand Down
2 changes: 1 addition & 1 deletion content/components/climate/bedjet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ sensor:
> and toggle those off while performing the installation. This will free up resources
> on the ESP and allow the installation to complete.
>
> Additionally, you may use an [ota.on_begin](#ota-on_begin) [Automation](#automation)
> Additionally, you may use an [ota.on_begin](#ota-on_begin) [Automation](/automations)
> to do this automatically:
>
> ```yaml
Expand Down
6 changes: 3 additions & 3 deletions content/components/climate/haier.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,9 @@ climate:
- **supported_modes** (*Optional*, list): Can be used to disable some of AC modes. Possible values: `'OFF'`, `HEAT_COOL`, `COOL`, `HEAT`, `DRY`, `FAN_ONLY`.
- **supported_swing_modes** (*Optional*, list): Can be used to disable some swing modes if your AC does not support it. Possible values: `'OFF'`, `VERTICAL`, `HORIZONTAL`, `BOTH`.
- **supported_presets** (*Optional*, list): Can be used to disable some presets. Possible values for smartair2 are: `AWAY`, `BOOST`, `COMFORT`. Possible values for hOn are: `AWAY`, `BOOST`, `SLEEP`. `AWAY` preset can be enabled only in `HEAT` mode, it is disabled by default.
- **on_alarm_start** (*Optional*, [Automation](#automation)): (supported only by hOn) Automation to perform when AC activates a new alarm. See [`on_alarm_start` Trigger](#haier-on_alarm_start).
- **on_alarm_end** (*Optional*, [Automation](#automation)): (supported only by hOn) Automation to perform when AC deactivates a new alarm. See [`on_alarm_end` Trigger](#haier-on_alarm_end).
- **on_status_message** (*Optional*, [Automation](#automation)): Automation to perform when status message received from AC. See [`on_status_message` Trigger](#haier-on_status_message).
- **on_alarm_start** (*Optional*, [Automation](/automations)): (supported only by hOn) Automation to perform when AC activates a new alarm. See [`on_alarm_start` Trigger](#haier-on_alarm_start).
- **on_alarm_end** (*Optional*, [Automation](/automations)): (supported only by hOn) Automation to perform when AC deactivates a new alarm. See [`on_alarm_end` Trigger](#haier-on_alarm_end).
- **on_status_message** (*Optional*, [Automation](/automations)): Automation to perform when status message received from AC. See [`on_status_message` Trigger](#haier-on_status_message).
- All other options from [Climate](#config-climate).

## Automations
Expand Down
2 changes: 1 addition & 1 deletion content/components/cover/am43.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,5 +65,5 @@ To make use of the battery and light level sensors, see the
## See Also

- {{< docref "index/" >}}
- [Automation](#automation)
- [Automation](/automations)
- {{< apiref "am43/am43_cover.h" "am43/am43_cover.h" >}}
2 changes: 1 addition & 1 deletion content/components/cover/current_based.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,5 +255,5 @@ status_led:
- {{< docref "index/" >}}
- {{< docref "/components/cover/template" >}}
- {{< docref "/components/sensor/ade7953" >}}
- [Automation](#automation)
- [Automation](/automations)
- {{< apiref "current_based/current_based_cover.h" "current_based/current_based_cover.h" >}}
2 changes: 1 addition & 1 deletion content/components/cover/endstop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,5 +74,5 @@ cover:
## See Also

- {{< docref "index/" >}}
- [Automation](#automation)
- [Automation](/automations)
- {{< apiref "endstop/endstop_cover.h" "endstop/endstop_cover.h" >}}
2 changes: 1 addition & 1 deletion content/components/cover/feedback.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,5 +261,5 @@ Most options can be left untouched, but some modifications are needed:
## See Also

- {{< docref "index/" >}}
- [Automation](#automation)
- [Automation](/automations)
- {{< apiref "feedback/feedback_cover.h" "feedback/feedback_cover.h" >}}
2 changes: 1 addition & 1 deletion content/components/cover/he60r.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,5 +96,5 @@ binary_sensor:
## See Also

- {{< docref "index/" >}}
- [Automation](#automation)
- [Automation](/automations)
- [GPIO Binary Sensor](#gpio-binary-sensor)
2 changes: 1 addition & 1 deletion content/components/cover/template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,6 @@ Configuration options:
## See Also

- {{< docref "/components/cover" >}}
- [Automation](#automation)
- [Automation](/automations)
- {{< docref "/cookbook/garage-door" >}}
- {{< apiref "template/cover/template_cover.h" "template/cover/template_cover.h" >}}
2 changes: 1 addition & 1 deletion content/components/cover/time_based.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,5 +94,5 @@ stop_action:
## See Also

- {{< docref "index/" >}}
- [Automation](#automation)
- [Automation](/automations)
- {{< apiref "time_based/time_based_cover.h" "time_based/time_based_cover.h" >}}
2 changes: 1 addition & 1 deletion content/components/cover/tormatic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,5 +96,5 @@ can be bent 90 degrees to sit parallel to the PCB, keeping a low profile.
## See Also

* {{< docref "index/" >}}
* [Automation](#automation)
* [Automation](/automations)
* {{< apiref "tormatic/tormatic_cover.h" "tormatic/tormatic_cover.h" >}}
4 changes: 2 additions & 2 deletions content/components/datetime/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ MQTT Options:

Time and DateTime Options:

- **on_time** (*Optional*, [Automation](#automation)): Automation to run when the current datetime or time matches the current state.
- **on_time** (*Optional*, [Automation](/automations)): Automation to run when the current datetime or time matches the current state.
Only valid on `time` or `datetime` types. Use of `on_time` causes `time_id` to be required, `time_id` will be automatically assigned if a time source exists in the config, and will cause an invalid configuration if there is no {{< docref "/components/time" >}} configured.

## Automation
Expand Down Expand Up @@ -89,7 +89,7 @@ datetime:
}
```

Configuration variables: See [Automation](#automation).
Configuration variables: See [Automation](/automations).

## Date Automation

Expand Down
2 changes: 1 addition & 1 deletion content/components/datetime/template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,5 +106,5 @@ datetime:

## See Also

- [Automation](#automation)
- [Automation](/automations)
- {{< apiref "template/datetime/template_date.h" "template/datetime/template_date.h" >}}
Loading