Built-in intents

The following intents are supported:

• HassTurnOn, HassTurnOff, HassGetState, HassNevermind, HassRespond, HassBroadcast, HassSetPosition, HassGetCurrentDate, HassGetCurrentTime, HassLightSet, HassClimateSetTemperature, HassClimateGetTemperature, HassShoppingListAddItem, HassGetWeather, HassListAddItem, HassListCompleteItem, HassVacuumStart, HassVacuumReturnToBase, HassMediaPause, HassMediaUnpause, HassMediaNext, HassMediaPrevious, HassSetVolume, HassSetVolumeRelative, HassMediaSearchAndPlay, HassStartTimer, HassCancelAllTimers, HassCancelTimer, HassIncreaseTimer, HassDecreaseTimer, HassPauseTimer, HassUnpauseTimer, HassTimerStatus, HassLawnMowerStartMowing, HassLawnMowerDock

The following intents are deprecated:

• HassOpenCover, HassCloseCover, HassToggle, HassHumidifierSetpoint, HassHumidifierMode, HassShoppingListLastItems

Slots

For HassTurnOn and HassTurnOff, the slots are optional.

Possible slot combinations are:

Slot combination	Example
name only	table light
area only	kitchen
area and name	living room reading light
area and domain	kitchen lights
area and device class	bathroom humidity
device class and domain	carbon dioxide sensors

Supported intents

HassTurnOn

Turns on a device or entity

• name - Name of a device or entity
• area - Name of an area
• floor - Name of a floor
• domain - Domain of devices/entities in an area
• device_class - Device class of devices/entities in an area

Provided by the homeassistant integration.

HassTurnOff

Turns off a device or entity

• name - Name of a device or entity
• area - Name of an area
• floor - Name of a floor
• domain - Domain of devices/entities in an area
• device_class - Device class of devices/entities in an area

Provided by the homeassistant integration.

HassGetState

Gets or checks the state of an entity

• name - Name of a device or entity
• area - Name of an area
• floor - Name of a floor
• domain - Domain of devices/entities in an area
• device_class - Device class of devices/entities in an area
• state - Name of state to match

Provided by the homeassistant integration.

HassNevermind

Does nothing. Used to cancel a request

Provided by the homeassistant integration.

HassRespond

Returns response but takes no action

• response - Text to respond with

Provided by the homeassistant integration.

HassBroadcast

Announces a message on other satellites

• message - Message to broadcast (required)

Provided by the assist_satellite integration.

HassSetPosition

Sets the position of an entity

• name - Name of a device or entity
• area - Name of an area
• floor - Name of a floor
• domain - Domain of devices/entities in an area
• device_class - Device class of devices/entities in an area
• position - Position from 0 to 100 (required)

Provided by the homeassistant integration.

HassGetCurrentDate

Gets the current date

Provided by the homeassistant integration.

HassGetCurrentTime

Gets the current time

Provided by the homeassistant integration.

HassLightSet

Sets the brightness or color of a light

• name - Name of a device or entity
• area - Name of an area
• floor - Name of a floor
• brightness - Brightness percentage from 0 to 100
• color - Name of color

Provided by the light integration.

HassClimateSetTemperature

Sets the desired indoor temperature

• name - Name of a device or entity
• area - Name of an area
• floor - Name of a floor
• temperature - Temperature in degrees (required)

Provided by the climate integration.

HassClimateGetTemperature

Gets the actual indoor temperature (not the desired indoor temperature as set by HassClimateSetTemperature)

• name - Name of a device or entity
• area - Name of an area
• floor - Name of a floor

Provided by the climate integration.

HassShoppingListAddItem

Adds an item to the shopping list

• item - Item to add (required)

Provided by the shopping_list integration.

HassGetWeather

Gets the current weather

• name - Name of the weather entity to use

Provided by the weather integration.

HassListAddItem

Adds an item to a todo list

• item - Item to add (required)
• name - Name of the list (required)

Provided by the todo integration.

HassListCompleteItem

Checks off an item from a todo list

• item - Item to check off (required)
• name - Name of the list (required)

Provided by the todo integration.

HassVacuumStart

Starts a vacuum

• name - Name of a device or entity
• area - Name of an area
• floor - Name of a floor

Provided by the vacuum integration.

HassVacuumReturnToBase

Returns a vacuum to base

• name - Name of a device or entity
• area - Name of an area

Provided by the vacuum integration.

HassMediaPause

Pauses a media player

• name - Name of a device or entity
• area - Name of an area

Provided by the media_player integration.

HassMediaUnpause

Unpauses a media player

• name - Name of a device or entity
• area - Name of an area

Provided by the media_player integration.

HassMediaNext

Skips a media player to the next item

• name - Name of a device or entity
• area - Name of an area

Provided by the media_player integration.

HassMediaPrevious

Skips a media player back to the previous item

• name - Name of a device or entity
• area - Name of an area

Provided by the media_player integration.

HassSetVolume

Sets the volume of a media player

• name - Name of a device or entity
• area - Name of an area
• volume_level - Volume level from 0 to 100 (required)

Provided by the media_player integration.

HassSetVolumeRelative

Increases or decreases the volume of a media player

• volume_step - up, down, or the percentage to change from -100 to 100 (required)
• name - Name of a device or entity
• area - Name of an area
• floor - Name of a floor

Provided by the media_player integration.

HassMediaSearchAndPlay

Searched for a media item and plays it

• name - Name of a device or entity
• area - Name of an area
• search_query - Media to search for and play (required)
• media_class - Type of media to search for (album, app, artist, channel, composer, contributing_artist, directory, episode, game, genre, image, movie, music, playlist, podcast, season, track, tv_show, url, video)

Provided by the media_player integration.

HassStartTimer

Starts a timer

• hours - Number of hours
• minutes - Number of minutes
• seconds - Number of seconds
• name - Name attached to the timer
• conversation_command - Command to execute when timer finishes

Provided by the homeassistant integration.

HassCancelAllTimers

Cancels all timers

• area - Area of the device used to start the timer

Provided by the homeassistant integration.

HassCancelTimer

Cancels a timer

• start_hours - Hours the timer was started with
• start_minutes - Minutes the timer was started with
• start_seconds - Seconds the timer was started with
• name - Name attached to the timer
• area - Area of the device used to start the timer

Provided by the homeassistant integration.

HassIncreaseTimer

Adds time to a timer

• hours - Number of hours
• minutes - Number of minutes
• seconds - Number of seconds
• start_hours - Hours the timer was started with
• start_minutes - Minutes the timer was started with
• start_seconds - Seconds the timer was started with
• name - Name attached to the timer
• area - Area of the device used to start the timer

Provided by the homeassistant integration.

HassDecreaseTimer

Removes time from a timer

• hours - Number of hours
• minutes - Number of minutes
• seconds - Number of seconds
• start_hours - Hours the timer was started with
• start_minutes - Minutes the timer was started with
• start_seconds - Seconds the timer was started with
• name - Name attached to the timer
• area - Area of the device used to start the timer

Provided by the homeassistant integration.

HassPauseTimer

Pauses a running timer

• start_hours - Hours the timer was started with
• start_minutes - Minutes the timer was started with
• start_seconds - Seconds the timer was started with
• name - Name attached to the timer
• area - Area of the device used to start the timer

Provided by the homeassistant integration.

HassUnpauseTimer

Resumes a paused timer

• start_hours - Hours the timer was started with
• start_minutes - Minutes the timer was started with
• start_seconds - Seconds the timer was started with
• name - Name attached to the timer
• area - Area of the device used to start the timer

Provided by the homeassistant integration.

HassTimerStatus

Reports status of one or more timers

• start_hours - Hours the timer was started with
• start_minutes - Minutes the timer was started with
• start_seconds - Seconds the timer was started with
• name - Name attached to the timer
• area - Area of the device used to start the timer

Provided by the homeassistant integration.

HassLawnMowerStartMowing

Starts a lawn mower

• name - Name of a device or entity

Provided by the lawn_mower integration.

HassLawnMowerDock

Sends a lawn mower to dock

• name - Name of a device or entity

Provided by the lawn_mower integration.

Deprecated intents

These are old intents that are not supported by template matching sentences and are planned to be removed or replaced.

HassOpenCover

Deprecated; use HassTurnOn instead.

Open a cover.

Slot name	Type	Required	Description
name	string	Yes	Name of the cover entity to open.

HassCloseCover

Deprecated; use HassTurnOff instead.

Close a cover.

Slot name	Type	Required	Description
name	string	Yes	Name of the cover entity to close.

HassToggle

Toggle the state of an entity.

Slot name	Type	Required	Description
name	string	Yes	Name of the entity to toggle.

HassHumidifierSetpoint

Set target humidity.

Slot name	Type	Required	Description
name	string	Yes	Name of the entity to control.
humidity	integer, 0-100	Yes	Target humidity to set.

HassHumidifierMode

Set humidifier mode if supported by the humidifier.

Slot name	Type	Required	Description
name	string	Yes	Name of the entity to control.
mode	string	Yes	The mode to switch to.

HassShoppingListLastItems

List the last 5 items on the shopping list.

This intent has no slots.

This page is automatically generated based on the Intents repository.