Built-in intents
The following intents are supported:
- HassTurnOn, HassTurnOff, HassGetState, HassNevermind, HassSetPosition, HassGetCurrentDate, HassGetCurrentTime, HassLightSet, HassClimateGetTemperature, HassShoppingListAddItem, HassGetWeather, HassListAddItem, HassVacuumStart, HassVacuumReturnToBase, HassMediaPause, HassMediaUnpause, HassMediaNext, HassMediaPrevious, HassSetVolume, HassStartTimer, HassCancelTimer, HassIncreaseTimer, HassDecreaseTimer, HassPauseTimer, HassUnpauseTimer, HassTimerStatus
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.
HassSetPosition
Sets the position of an entity
- name - Name of a device or entity
- area - Name of an area
- 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.
HassClimateGetTemperature
Gets the current temperature of a climate device or entity
- name - Name of a device or entity
- area - Name of an area
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.
HassVacuumStart
Starts a vacuum
- name - Name of a device or entity
- area - Name of an area
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.
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 intent 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 intent 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 intent 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 intent 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 intent 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 intent 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 intent 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.