jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-21 00:06:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adds Assist action documentation (#28047)

Browse Source 
* Adds assist action documentation

* Apply suggestions

* Fix other actions
This commit is contained in:
Paul Bottein 2023-07-03 19:06:47 +02:00 committed by Franck Nijhof
parent d1ca1a5fa9
commit 336fe1998c
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
1 changed files with 45 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
source/dashboards/actions.markdown
View File

@ -33,27 +33,27 @@ tap_action:
keys: keys:
action: action:
required: true required: true
description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `assist`, `none`)"
type: string type: string
default: "`toggle` (some cards overwrite default to `more-info` if the provided entity cannot be toggled)" default: "`toggle` (some cards overwrite default to `more-info` if the provided entity cannot be toggled)"
navigation_path: navigation_path:
required: false required: false
description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" description: "Path to navigate to (e.g., `/lovelace/0/`) when the `action` is defined as `navigate`"
type: string type: string
default: none default: none
url_path: url_path:
required: false required: false
description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when the `action` is defined as `url`"
type: string type: string
default: none default: none
service: service:
required: false required: false
description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" description: "Service to call (e.g., `media_player.media_play_pause`) when the `action` is defined as `call-service`"
type: string type: string
default: none default: none
data: data:
required: false required: false
description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when the `action` is defined as `call-service`"
type: string type: string
default: none default: none
confirmation: confirmation:
@ -61,6 +61,16 @@ tap_action:
description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" description: "Present a confirmation dialog to confirm the action. See `confirmation` object below"
type: [boolean, map] type: [boolean, map]
default: "false" default: "false"
pipeline_id:
required: false
description: "Assist pipeline id to use when the `action` is defined as `assist`"
type: string
default: none
start_listening:
required: false
description: "If supported, listen for voice commands when opening the assist dialog and the `action` is defined as `assist`"
type: boolean
default: none
{% endconfiguration %} {% endconfiguration %}
## Hold Action ## Hold Action
@ -80,27 +90,27 @@ hold_action:
keys: keys:
action: action:
required: true required: true
description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `assist`, `none`)"
type: string type: string
default: "`more-info`" default: "`more-info`"
navigation_path: navigation_path:
required: false required: false
description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" description: "Path to navigate to (e.g., `/lovelace/0/`) when the `action` is defined as `navigate`"
type: string type: string
default: none default: none
url_path: url_path:
required: false required: false
description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when the `action` is defined as `url`"
type: string type: string
default: none default: none
service: service:
required: false required: false
description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" description: "Service to call (e.g., `media_player.media_play_pause`) when the `action` is defined as `call-service`"
type: string type: string
default: none default: none
data: data:
required: false required: false
description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when the `action` is defined as `call-service`"
type: string type: string
default: none default: none
confirmation: confirmation:
@ -108,6 +118,16 @@ hold_action:
description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" description: "Present a confirmation dialog to confirm the action. See `confirmation` object below"
type: [boolean, map] type: [boolean, map]
default: "false" default: "false"
pipeline_id:
required: false
description: "Assist pipeline id to use when the `action` is defined as `assist`"
type: string
default: none
start_listening:
required: false
description: "If supported, listen for voice commands when opening the assist dialog and the `action` is defined as `assist`"
type: boolean
default: none
{% endconfiguration %} {% endconfiguration %}
## Double-Tap Action ## Double-Tap Action
@ -127,27 +147,27 @@ double_tap_action:
keys: keys:
action: action:
required: true required: true
description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `assist`, `none`)"
type: string type: string
default: "`more-info`" default: "`more-info`"
navigation_path: navigation_path:
required: false required: false
description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" description: "Path to navigate to (e.g., `/lovelace/0/`) when the `action` is defined as `navigate`"
type: string type: string
default: none default: none
url_path: url_path:
required: false required: false
description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when the `action` is defined as `url`"
type: string type: string
default: none default: none
service: service:
required: false required: false
description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" description: "Service to call (e.g., `media_player.media_play_pause`) when the `action` is defined as `call-service`"
type: string type: string
default: none default: none
data: data:
required: false required: false
description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when the `action` is defined as `call-service`"
type: string type: string
default: none default: none
confirmation: confirmation:
@ -155,6 +175,16 @@ double_tap_action:
description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" description: "Present a confirmation dialog to confirm the action. See `confirmation` object below"
type: [boolean, map] type: [boolean, map]
default: "false" default: "false"
pipeline_id:
required: false
description: "Assist pipeline id to use when the `action` is defined as `assist`"
type: string
default: none
start_listening:
required: false
description: "If supported, listen for voice commands when opening the assist dialog and the `action` is defined as `assist`"
type: boolean
default: none
{% endconfiguration %} {% endconfiguration %}
## Options For Confirmation ## Options For Confirmation