Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Intent_script component configuration #7154

Merged
merged 5 commits into from
Jan 15, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 48 additions & 6 deletions source/_components/intent_script.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,54 @@ intent_script:
data_template:
message: Hello from an intent!
```
Configuration variables:

Inside an intent we can define these variables:

- **intent** (*Required*): Name of the intent. Multiple entries are possible.
- **speech** (*Optional*): Text or template to return.
- **action** (*Optional*): [Script syntax](/docs/scripts/).
- **async_action** (*Optional*): Set to True to have Home Assistant not wait for the script to finish before returning the intent response.

{% configuration %}
intent:
description: Name of the intent. Multiple entries are possible.
required: true
type: map
keys:
action:
description: Defines an action to run to intents.
required: false
type: action
async_action:
description: Set to True to have Home Assistant not wait for the script to finish before returning the intent response.
required: false
default: false
type: boolean
card:
description: Card to display.
required: false
type: map
keys:
type:
description: Type of card to display.
required: false
default: simple
type: string
title:
description: Title of the card to display.
required: true
type: template
content:
description: Contents of the card to display.
required: true
type: template
speech:
description: Text or template to return.
required: false
type: map
keys:
type:
description: Type of speech.
required: false
default: plain
type: string
text:
description: Text to speech.
required: true
type: template
{% endconfiguration %}