Turn off script

Use this action to stop a script that is currently running. The script stops where it is, and the remaining actions in its sequence are skipped.

If the script isn’t running, nothing happens.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To stop a script from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
4. In the Then do section, select Add action.
5. Select what you want to control. Under By target (see Targets), select the script you want to stop.
6. From the actions shown for that target, select Turn off script.
7. Select Save.

Options in the UI

This action has no additional options beyond the target.

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as script.turn_off. A basic example looks like this:

action: script.turn_off
target:
  entity_id: script.wake_up_lights

This stops the script.wake_up_lights script.

Options in YAML

This action has no additional YAML options beyond the target.

Targets of the action

This action requires a target. The target is the object of the action. You can point the action at a single entityAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more], a device, an area, a floor, or a label, and Home Assistant will run the action on every matching script entity behind that target.

• Entity: one specific script entity, such as script.living_room.
• Device: every script entity that belongs to a device.
• Area: every script entity in a room or area.
• Floor: every script entity on a floor.
• Label: every script entity that shares a label.

You can also select different target types in one action. For example, you can add a specific entity and an area as targets in the same action to run the action on both of them at once.

Good to know

• Stopping a script does not undo what it already did. Lights it turned on stay on.
• A script that is waiting, for example on a delay or on a Wait for a trigger step, stops as well.
• If the script runs in a mode that allows several runs at the same time, all of its runs are stopped.

Try it yourself

Ready to test this? Open Settings > Tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

More examples

Real scenarios where this action shows up in automations and scripts. Copy any example and adapt it to your setup.

Automation: stop the wake-up script when you get up early

Cancel a gradual wake-up light script as soon as motion is detected in the bedroom.

• Trigger: Motion detected
  • Target: Bedroom motion
• Action: Turn off script
  • Target: Wake up lights

- alias: "Stop the wake-up script when you get up"
  triggers:
    - trigger: motion.detected
      target:
        entity_id: binary_sensor.bedroom_motion
  actions:
    - action: script.turn_off
      target:
        entity_id: script.wake_up_lights

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.

Related actions

These actions work well alongside this one:

• Turn on script: Runs the sequence of actions defined in a script.

• Toggle script: Starts a script if it isn’t running, and stops it otherwise.