diff --git a/docs/intent_builtin.md b/docs/intent_builtin.md new file mode 100644 index 00000000..93260694 --- /dev/null +++ b/docs/intent_builtin.md @@ -0,0 +1,77 @@ +--- +title: "Built-in intents" +--- + +Home Assistant comes with a couple of built-in intents. These intents aim to offer similar functionality as exposed via the services. All built-in intents are prefixed with "Hass" to avoid collision with user defined intents. + +## Core + +### HassTurnOff + +Turn an entity off. + +| Slot name | Type | Required | Description +| --------- | ---- | -------- | ----------- +| name | string | Yes | Name of the entity to turn off. + +### HassTurnOn + +Turn an entity on. + +| Slot name | Type | Required | Description +| --------- | ---- | -------- | ----------- +| name | string | Yes | Name of the entity to turn on. + +### HassToggle + +Toggle the state of an entity. + +| Slot name | Type | Required | Description +| --------- | ---- | -------- | ----------- +| name | string | Yes | Name of the entity to toggle. + +## Cover + +### HassOpenCover + +Open a cover. + +| Slot name | Type | Required | Description +| --------- | ---- | -------- | ----------- +| name | string | Yes | Name of the cover entity to open. + +### HassCloseCover + +Close a cover. + +| Slot name | Type | Required | Description +| --------- | ---- | -------- | ----------- +| name | string | Yes | Name of the cover entity to close. + +## Light + +### HassLightSet + +Set the state of a light. + +| Slot name | Type | Required | Description +| --------- | ---- | -------- | ----------- +| name | string | Yes | Name of the entity to toggle. +| color | string, name of valid color | No | Color to change the light to. +| brightness | integer, 0-100 | No | Brightness to change the light to. + +## Shopping List + +### HassShoppingListAddItem + +Add an item to the shopping list. + +| Slot name | Type | Required | Description +| --------- | ---- | -------- | ----------- +| item | string | Yes | Name of item to add to the list. + +### HassShoppingListLastItems + +List the last 5 items on the shopping list. + +_This intent has no slots._ diff --git a/website/i18n/en.json b/website/i18n/en.json index 4f4e1181..3d2bb444 100644 --- a/website/i18n/en.json +++ b/website/i18n/en.json @@ -102,6 +102,7 @@ "hassio_debugging": "Debugging Hass.io", "hassio_hass": "Hass.io <> Home Assitant integration development", "HASS Integration development": "HASS Integration development", + "intent_builtin": "Built-in intents", "intent_conversation": "Registering sentences", "intent_firing": "Firing intents", "intent_handling": "Handling intents", diff --git a/website/sidebars.json b/website/sidebars.json index 0ded4b36..19d7b8ff 100644 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -112,7 +112,8 @@ "intent_index", "intent_firing", "intent_handling", - "intent_conversation" + "intent_conversation", + "intent_builtin" ], "asyncio": [ "asyncio_index",