mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-03 00:36:50 +00:00
8d98500d0e
* Docs a-b: apply sentence-style-caps, add term refs * Docs: apply sentence-style-caps, add term refs * Apply suggestions from code review * Glossary: add alias for plural * Apply suggestions from code review Co-authored-by: Joakim Sørensen <joasoe@gmail.com> --------- Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
47 lines
2.2 KiB
Markdown
47 lines
2.2 KiB
Markdown
---
|
|
title: "Automation services"
|
|
description: "How to use the various automation services."
|
|
---
|
|
|
|
The automation integration has services to control automations, like turning automations on and off. This can be useful if you want to disable an automation from another automation.
|
|
|
|
## Service {% my developer_call_service service="automation.turn_on" %}
|
|
|
|
This service enables the automation's {% term triggers %}.
|
|
|
|
Service data attribute | Optional | Description
|
|
-|-|-
|
|
`entity_id` | no | Entity ID of automation to turn on. Can be a list. `none` or `all` are also accepted.
|
|
|
|
## Service {% my developer_call_service service="automation.turn_off" %}
|
|
|
|
This service disables the automation's {% term triggers %}, and optionally stops any currently active {% term actions %}.
|
|
|
|
Service data attribute | Optional | Description
|
|
-|-|-
|
|
`entity_id` | no | Entity ID of automation to turn off. Can be a list. `none` or `all` are also accepted.
|
|
`stop_actions` | yes | Stop any currently active actions (defaults to true).
|
|
|
|
## Service {% my developer_call_service service="automation.toggle" %}
|
|
|
|
This service enables the automation's triggers if they were disabled, or disables the automation's triggers, and stops any currently active actions, if the triggers were enabled.
|
|
|
|
Service data attribute | Optional | Description
|
|
-|-|-
|
|
`entity_id` | no | Entity ID of automation to turn on. Can be a list. `none` or `all` are also accepted.
|
|
|
|
## Service {% my developer_call_service service="automation.trigger" %}
|
|
|
|
This service will trigger the {% term action %} of an {% term automation %}. By default it bypasses any conditions, though that can be changed via the `skip_condition` attribute.
|
|
|
|
Service data attribute | Optional | Description
|
|
-|-|-
|
|
`entity_id` | no | Entity ID of automation to trigger. Can be a list. `none` or `all` are also accepted.
|
|
`skip_condition` | yes | Whether or not the condition will be skipped (defaults to true).
|
|
|
|
## Service {% my developer_call_service service="automation.reload" %}
|
|
|
|
_This service is only required if you create/edit automations in YAML. Automations via the UI do this automatically._
|
|
|
|
This service reloads all automations, stopping all currently active automation actions.
|