List of available actions

Actions are the things Home Assistant can do for you, like turning a light on, setting a thermostat, playing music, or restarting the system. They are the building blocks of automations and scripts.

Browse the full list below, or use the search box to find a specific action by name or description. Each action has its own page with a step-by-step UI walkthrough, examples, and a complete data field reference.

New to actions? Read about actions in automations and scripts to learn how they fit together.

Alarm control panel

Arm alarm away alarm_control_panel.alarm_arm_away Arm an alarm control panel in away mode. Optionally provide a code if your alarm panel requires one.
Arm alarm with custom bypass alarm_control_panel.alarm_arm_custom_bypass Arm an alarm control panel while bypassing specific zones. Optionally provide a code if your alarm panel requires one.
Arm alarm home alarm_control_panel.alarm_arm_home Arm an alarm control panel in home mode. Optionally provide a code if your alarm panel requires one.
Arm alarm night alarm_control_panel.alarm_arm_night Arm an alarm control panel in night mode. Optionally provide a code if your alarm panel requires one.
Arm alarm vacation alarm_control_panel.alarm_arm_vacation Arm an alarm control panel in vacation mode. Optionally provide a code if your alarm panel requires one.
Disarm alarm alarm_control_panel.alarm_disarm Disarm an alarm control panel. Optionally provide a code if your alarm panel requires one.
Trigger alarm alarm_control_panel.alarm_trigger Manually trigger an alarm control panel. Optionally provide a code if your alarm panel requires one.

Fan

Decrease fan speed fan.decrease_speed Decrease the speed of a fan.
Increase fan speed fan.increase_speed Increase the speed of a fan.
Oscillate fan fan.oscillate Control the oscillation of a fan.
Set fan direction fan.set_direction Set a fan's rotation direction.
Set fan speed fan.set_percentage Set the speed of a fan.
Set fan preset mode fan.set_preset_mode Set the preset mode of a fan.
Toggle fan fan.toggle Toggle a fan on or off.
Turn off fan fan.turn_off Turn off a fan.
Turn on fan fan.turn_on Turn on a fan. Optionally set the speed or preset mode at the same time.

Light

Toggle a light light.toggle Flip a light between on and off. If it's off, it turns on. If it's on, it turns off.
Turn off a light light.turn_off Turn a light off. Optionally fade it out with a transition, or have it flash briefly before it goes dark.
Turn on a light light.turn_on Turn a light on. Optionally set brightness, color, color temperature, an effect, or a transition.

Vacuum

Clean area vacuum.clean_area Cleans specific mapped areas using vacuum segments.
Clean spot vacuum.clean_spot Performs a spot cleaning at the vacuum's location.
Locate vacuum vacuum.locate Plays a sound or flashes lights to help you find the vacuum.
Pause cleaning vacuum.pause Pauses the current cleaning task on a vacuum.
Return to base vacuum.return_to_base Sends the vacuum to the charging dock.
Send command vacuum.send_command Send a platform-specific command or advanced function.
Set fan speed vacuum.set_fan_speed Sets the fan/power level for cleaning.
Start cleaning vacuum.start Starts or resumes a cleaning task on a vacuum.
Start or pause cleaning vacuum.start_pause Starts, pauses, or resumes a vacuum cleaner's cleaning task.
Stop vacuum vacuum.stop Stops the current activity of a vacuum.
Toggle vacuum power vacuum.toggle Toggles a vacuum cleaner on or off.
Turn off vacuum vacuum.turn_off Turns off a vacuum cleaner.
Turn on vacuum vacuum.turn_on Turns on a vacuum cleaner.

alarm_control_panel.alarm_arm_away - Arm an alarm control panel in away mode. Optionally provide a code if your alarm panel requires one.

alarm_control_panel.alarm_arm_custom_bypass - Arm an alarm control panel while bypassing specific zones. Optionally provide a code if your alarm panel requires one.

alarm_control_panel.alarm_arm_home - Arm an alarm control panel in home mode. Optionally provide a code if your alarm panel requires one.

alarm_control_panel.alarm_arm_night - Arm an alarm control panel in night mode. Optionally provide a code if your alarm panel requires one.

alarm_control_panel.alarm_arm_vacation - Arm an alarm control panel in vacation mode. Optionally provide a code if your alarm panel requires one.

alarm_control_panel.alarm_disarm - Disarm an alarm control panel. Optionally provide a code if your alarm panel requires one.

alarm_control_panel.alarm_trigger - Manually trigger an alarm control panel. Optionally provide a code if your alarm panel requires one.

fan.decrease_speed - Decrease the speed of a fan.

fan.increase_speed - Increase the speed of a fan.

fan.oscillate - Control the oscillation of a fan.

fan.set_direction - Set a fan's rotation direction.

fan.set_percentage - Set the speed of a fan.

fan.set_preset_mode - Set the preset mode of a fan.

fan.toggle - Toggle a fan on or off.

fan.turn_off - Turn off a fan.

fan.turn_on - Turn on a fan. Optionally set the speed or preset mode at the same time.

light.toggle - Flip a light between on and off. If it's off, it turns on. If it's on, it turns off.

light.turn_off - Turn a light off. Optionally fade it out with a transition, or have it flash briefly before it goes dark.

light.turn_on - Turn a light on. Optionally set brightness, color, color temperature, an effect, or a transition.

vacuum.clean_area - Cleans specific mapped areas using vacuum segments.

vacuum.clean_spot - Performs a spot cleaning at the vacuum's location.

vacuum.locate - Plays a sound or flashes lights to help you find the vacuum.

vacuum.pause - Pauses the current cleaning task on a vacuum.

vacuum.return_to_base - Sends the vacuum to the charging dock.

vacuum.send_command - Send a platform-specific command or advanced function.

vacuum.set_fan_speed - Sets the fan/power level for cleaning.

vacuum.start - Starts or resumes a cleaning task on a vacuum.

vacuum.start_pause - Starts, pauses, or resumes a vacuum cleaner's cleaning task.

vacuum.stop - Stops the current activity of a vacuum.

vacuum.toggle - Toggles a vacuum cleaner on or off.

vacuum.turn_off - Turns off a vacuum cleaner.

vacuum.turn_on - Turns on a vacuum cleaner.