drfinn15 27832b0ade
Typo in automation.turn_off part (#18378)
Changed "on" to "off", because the service automation.turn_off turns automations off, not on.
2021-07-05 11:13:02 +02:00

2.1 KiB

title description
Automation Services 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 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 triggers, and optionally stops any currently active 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 action of an 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.