Skip to main content

Built-in intents

The following intents are supported:

  • HassTurnOn, HassTurnOff, HassGetState, HassLightSet

The following intents are deprecated:

  • HassOpenCover, HassCloseCover, HassToggle, HassHumidifierSetpoint, HassHumidifierMode, HassShoppingListAddItem, 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

Slots
  • 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

Provided by the homeassistant integration.

HassTurnOff

Turns off a device or entity

Slots
  • 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

Provided by the homeassistant integration.

HassGetState

Gets or checks the state of an entity

Slots
  • 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
  • state - Device class of devices/entities in an area

Provided by the homeassistant integration.

HassLightSet

Sets the brightness or color of a light

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

Provided by the light integration.

HassShoppingListAddItem

Adds an item to the shopping list

Slots
  • item - Item to add

Provided by the shopping_list 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 nameTypeRequiredDescription
namestringYesName of the cover entity to open.

HassCloseCover

Deprecated; use HassTurnOff instead.

Close a cover.

Slot nameTypeRequiredDescription
namestringYesName of the cover entity to close.

HassToggle

Toggle the state of an entity.

Slot nameTypeRequiredDescription
namestringYesName of the entity to toggle.

HassHumidifierSetpoint

Set target humidity.

Slot nameTypeRequiredDescription
namestringYesName of the entity to control.
humidityinteger, 0-100YesTarget humidity to set.

HassHumidifierMode

Set humidifier mode if supported by the humidifier.

Slot nameTypeRequiredDescription
namestringYesName of the entity to control.
modestringYesThe mode to switch to.

HassShoppingListAddItem

Add an item to the shopping list.

Slot nameTypeRequiredDescription
itemstringYesName of item to add to the list.

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.