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 21:36:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

automation services: rename 'service' to 'action' (#33795)

Browse Source
This commit is contained in:
c0ffeeca7 2024-07-16 15:21:39 +02:00 committed by GitHub
parent c4d1d89ea6
commit a9a0d917e2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
source/_docs/automation/services.markdown
View File

@ -1,46 +1,46 @@
---
title: "Automation services"
description: "How to use the various automation services."
title: "Automation actions"
description: "How to use the various automation actions."
---
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.
The automation integration has actions 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" %}
## Action {% my developer_call_service service="automation.turn_on" %}
This service enables the automation's {% term triggers %}.
This action enables the automation's {% term triggers %}.
Service data attribute | Optional | Description
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" %}
## Action {% my developer_call_service service="automation.turn_off" %}
This service disables the automation's {% term triggers %}, and optionally stops any currently active {% term actions %}.
This action disables the automation's {% term triggers %}, and optionally stops any currently active {% term actions %}.
Service data attribute | Optional | Description
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" %}
## Action {% 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.
This action 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
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" %}
## Action {% 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.
This action 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
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" %}
## Action {% 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 action 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.
This action reloads all automations, stopping all currently active automation actions.