Add initial keyboard shortcut support.
This commit is contained in:
Dermot Duffy
@@ -0,0 +1,73 @@
|
||||
# `actions`
|
||||
|
||||
## Introduction to actions <!-- {docsify-ignore} -->
|
||||
|
||||
`actions` is not a top-level configuration block, but can be used as part of
|
||||
multiple other blocks.
|
||||
|
||||
Actions are pre-configured activities that can be triggered in response to a
|
||||
variety of circumstances (e.g. tapping on a menu icon, double tapping on an
|
||||
[element](../elements.md) or holding the mouse/tap down on a particular
|
||||
[view](../view.md?id=supported-views)).
|
||||
|
||||
### Differences in actions between Frigate Card and Home Assistant
|
||||
|
||||
Both the Home Assistant frontend and the Frigate card cooperate to provide
|
||||
action functionality. In general, the Frigate Card functionality is a superset
|
||||
of that offered by stock Home Assistant.
|
||||
|
||||
Stock action functionality is used for Stock [Home Assistant picture
|
||||
elements](https://www.home-assistant.io/lovelace/picture-elements/). Extended
|
||||
Frigate card behavior covers all other interactions on the Frigate card (e.g.
|
||||
menu icon elements, submenus and actions on the card or views).
|
||||
|
||||
#### Custom action types: `start_tap` and `end_tap`
|
||||
|
||||
The card has partial support for two special action types `start_tap` and
|
||||
`end_tap` which occur when a tap is started (e.g. mouse is pressed down /
|
||||
touch begins), and ended (e.g. mouse released / touch ends) respectively. This
|
||||
might be useful for PTZ cameras cameras to start/stop movement on touch. Network
|
||||
latency may introduce unavoidable imprecision between `end_tap` and action
|
||||
actually occurring.
|
||||
|
||||
#### Multiple actions
|
||||
|
||||
Extended Frigate card behavior supports a list of actions instead of a single
|
||||
action, all of which will be handled. See [an example of multiple
|
||||
actions](../../examples.md?id=multiple-actions).
|
||||
|
||||
## Card and view actions <!-- {docsify-ignore} -->
|
||||
|
||||
Actions may be attached to the card itself, to trigger action when the card
|
||||
experiences a `tap`, `double_tap`, `hold`, `start_tap` or `end_tap` event.
|
||||
Alternatively they can be configured on a per group-of-views basis, e.g. only
|
||||
when `live` view is tapped.
|
||||
|
||||
| Configuration path | Views to which it refers |
|
||||
| ----------------------- | ---------------------------------- |
|
||||
| `image.actions` | `image` |
|
||||
| `live.actions` | `live` |
|
||||
| `media_gallery.actions` | `clips`, `snapshots`, `recordings` |
|
||||
| `media_viewer.actions` | `clip`, `snapshot`, `recording` |
|
||||
| `view.actions` | All except `timeline` and `diagnostic` |
|
||||
|
||||
If an action is configured for both the whole card (`view.actions`) and a more
|
||||
specific view (e.g. `live.actions`) then the actions are merged, with the more
|
||||
specific overriding the less specific.
|
||||
|
||||
!> The card itself relies on user interactions to function (e.g. `tap` on
|
||||
the menu should activate that button). Card or View actions are prevented from
|
||||
being activated through standard interaction with menu buttons, next/previous
|
||||
controls, thumbnails, etc, but in some cases this prevention is not possible
|
||||
(e.g. embedded WebRTC card controls) -- in these cases duplicate actions may
|
||||
occur with certain configurations (e.g. `tap`).
|
||||
|
||||
!> Card-wide actions are not supported on the `timeline` view, `diagnostics`
|
||||
view nor when a info/error message is being displayed.
|
||||
|
||||
## Actions <!-- {docsify-ignore} -->
|
||||
|
||||
| Option | Description |
|
||||
| ------------------------------------ | ----------------------------------- |
|
||||
| [Custom Actions](./custom/README.md) | Custom actions to control the card. |
|
||||
| [Stock Actions](./stock/README.md) | Standard Home Assistant actions. |
|
||||
@@ -0,0 +1,27 @@
|
||||
* [Getting Started](../../README.md)
|
||||
* [Configuration](../README.md)
|
||||
* [`actions`](README.md)
|
||||
* [Custom Actions](./custom/README.md)
|
||||
* [Stock Actions](./stock/README.md)
|
||||
* [`automations`](../automations.md)
|
||||
* [`cameras`](../cameras/README.md)
|
||||
* [`conditions`](../conditions.md)
|
||||
* [`dimensions`](../dimensions.md)
|
||||
* [`elements`](../elements.md)
|
||||
* [`image`](../image.md)
|
||||
* [`live`](../live.md)
|
||||
* [`media_gallery`](../media-gallery.md)
|
||||
* [`media_viewer`](../media-viewer.md)
|
||||
* [`menu`](../menu.md)
|
||||
* [`overrides`](../overrides.md)
|
||||
* [`performance`](../performance.md)
|
||||
* [`profiles`](../profiles.md)
|
||||
* [`timeline`](../timeline.md)
|
||||
* [`view`](../view.md)
|
||||
* [Screenshots](../../screenshots.md)
|
||||
* [Troubleshooting](../../troubleshooting.md)
|
||||
* [Usage](../../usage/README.md)
|
||||
|
||||
---
|
||||
|
||||
* [Developing](../../developing.md)
|
||||
@@ -0,0 +1,737 @@
|
||||
# `custom:frigate-card-action`
|
||||
|
||||
Execute a Frigate Card action.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
[...]
|
||||
```
|
||||
|
||||
| Parameter | Description |
|
||||
| - | - |
|
||||
| `action` | Must be `custom:frigate-card-action`. |
|
||||
| `frigate_card_action` | A supported Frigate Card action. See below. |
|
||||
|
||||
## `camera_select`
|
||||
|
||||
Select a given camera.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: camera_select
|
||||
[...]
|
||||
```
|
||||
|
||||
| Parameter | Description |
|
||||
| - | - |
|
||||
| `action` | Must be `custom:frigate-card-action`. |
|
||||
| `frigate_card_action` | Must be `camera_select`. |
|
||||
| `camera` | The [camera ID](../../cameras/README.md?id=cameras) of the camera to select. |
|
||||
| `triggered` | If `true` instead of `camera` being specified then a triggered camera (if any) is selected instead. |
|
||||
|
||||
This action will respect the value of the `view.camera_select` to choose the appropriate view on the new camera. See [`view` configuration](../../view.md).
|
||||
|
||||
## `camera_ui`
|
||||
|
||||
Download the displayed media.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: camera_ui
|
||||
```
|
||||
|
||||
Open the UI for the selected camera engine (e.g. the Frigate UI).
|
||||
|
||||
## `change_zoom`
|
||||
|
||||
Zoom in and/or pan for a given camera.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: change_zoom
|
||||
[...]
|
||||
```
|
||||
|
||||
| Parameter | Description |
|
||||
| - | - |
|
||||
| `action` | Must be `custom:frigate-card-action`. |
|
||||
| `frigate_card_action` | Must be `change_zoom`. |
|
||||
| `target_id` | The [camera ID](../../cameras/README.md?id=cameras) or a media ID (e.g. `frigate` event ID) to change zoom/pam settings for. |
|
||||
| `zoom` | Optional parameter that controls how much to zoom-in. See the [camera zoom parameter](../../cameras/README.md?id=layout-configuration). |
|
||||
| `pan` | Optional parameter that controls how much to pan-x/y. See the [camera pan parameter](../../cameras/README.md?id=layout-configuration). |
|
||||
|
||||
?> If neither `zoom` nor `pan` are specified the camera will return to its default zoom and pan settings.
|
||||
|
||||
See [example of automatically zoom/panning based on state](../../../examples.md?id=automatically-zoom-based-on-state).
|
||||
|
||||
## `clip`
|
||||
|
||||
Change to the `clip` view.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: clip
|
||||
```
|
||||
|
||||
## `clips`
|
||||
|
||||
Change to the `clips` view.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: clips
|
||||
```
|
||||
|
||||
## `default`
|
||||
|
||||
Change to the default view.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: default
|
||||
```
|
||||
|
||||
## `diagnostics`
|
||||
|
||||
Show the card diagnostics.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: diagnostics
|
||||
```
|
||||
|
||||
## `display_mode_select`
|
||||
|
||||
Select a display mode (e.g. view a `single` camera or a `grid` of cameras).
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: display_mode_select
|
||||
[...]
|
||||
```
|
||||
|
||||
| Parameter | Description |
|
||||
| - | - |
|
||||
| `action` | Must be `custom:frigate-card-action`. |
|
||||
| `frigate_card_action` | Must be `display_mode_select`. |
|
||||
| `display_mode` | `single` to show a single camera at a time in a carousel, or `grid` to show a grid of cameras. |
|
||||
|
||||
## `download`
|
||||
|
||||
Download the displayed media.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: download
|
||||
```
|
||||
|
||||
## `expand`
|
||||
|
||||
Expand the card into a dialog/popup.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: expand
|
||||
```
|
||||
|
||||
## `fullscreen`
|
||||
|
||||
Toggle fullscreen.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: fullscreen
|
||||
```
|
||||
|
||||
## `image`
|
||||
|
||||
Change to the `image` view.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: image
|
||||
```
|
||||
|
||||
## `live`
|
||||
|
||||
Change to the `live` view.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: live
|
||||
```
|
||||
|
||||
## `live_substream_off`
|
||||
|
||||
Turn off the substream (if on).
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: live_substream_on
|
||||
```
|
||||
|
||||
| Parameter | Description |
|
||||
| - | - |
|
||||
| `action` | Must be `custom:frigate-card-action`. |
|
||||
| `frigate_card_action` | Must be `live_substream_on`. |
|
||||
|
||||
## `live_substream_on`
|
||||
|
||||
Turn on the first available substream. Use [Camera dependency configuration](../../cameras/README.md?id=dependencies) to configure substreams.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: live_substream_on
|
||||
```
|
||||
|
||||
| Parameter | Description |
|
||||
| - | - |
|
||||
| `action` | Must be `custom:frigate-card-action`. |
|
||||
| `frigate_card_action` | Must be `live_substream_on`. |
|
||||
|
||||
|
||||
|
||||
## `live_substream_select`
|
||||
|
||||
Select a substream. Use [Camera dependency configuration](../../cameras/README.md?id=dependencies) to configure substreams.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: live_substream_select
|
||||
[...]
|
||||
```
|
||||
|
||||
| Parameter | Description |
|
||||
| - | - |
|
||||
| `action` | Must be `custom:frigate-card-action`. |
|
||||
| `frigate_card_action` | Must be `live_substream_select`. |
|
||||
| `camera` | The [camera ID](../../cameras/README.md?id=cameras) of the substream to select. |
|
||||
|
||||
## `log`
|
||||
|
||||
Log a message to the Javascript console.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: log
|
||||
[...]
|
||||
```
|
||||
|
||||
| Parameter | Default | Description |
|
||||
| - | - | - |
|
||||
| `action` | | Must be `custom:frigate-card-action`. |
|
||||
| `frigate_card_action` | | Must be `log`. |
|
||||
| `message` | | The message to log. |
|
||||
| `level` | `info` | The console logging level to use. One of `['debug', 'info', 'warn', 'error']`. |
|
||||
|
||||
## `media_player`
|
||||
|
||||
Perform a media player action.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: media_player
|
||||
[...]
|
||||
```
|
||||
|
||||
| Parameter | Description |
|
||||
| - | - |
|
||||
| `action` | Must be `custom:frigate-card-action`. |
|
||||
| `frigate_card_action` | Must be `media_player`. |
|
||||
| `media_player` | The entity ID of the media_player on which to perform the action. |
|
||||
| `media_player_action` | Either `play` or `stop` to play or stop the media in question. |
|
||||
|
||||
## `menu_toggle`
|
||||
|
||||
Show/hide the menu (for the `hidden` mode style).
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: menu_toggle
|
||||
```
|
||||
|
||||
## `microphone_mute`
|
||||
|
||||
Mute the microphone during [2-way audio](../../../usage/2-way-audio.md).
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: microphone_mute
|
||||
```
|
||||
|
||||
## `microphone_unmute`
|
||||
|
||||
Unmute the microphone during [2-way audio](../../../usage/2-way-audio.md).
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: microphone_unmute
|
||||
```
|
||||
|
||||
## `mute`
|
||||
|
||||
Mute the selected media.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: mute
|
||||
```
|
||||
|
||||
## `pause`
|
||||
|
||||
Pause the selected media.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: pause
|
||||
```
|
||||
|
||||
## `play`
|
||||
|
||||
Play the selected media.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: play
|
||||
```
|
||||
|
||||
## `ptz`
|
||||
|
||||
Execute a real PTZ action, whether configured manually (see [Camera PTZ configuration](../../cameras/README.md?id=ptz)) or auto-detected.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: ptz
|
||||
[...]
|
||||
```
|
||||
|
||||
| Parameter | | Description |
|
||||
| - | - | - |
|
||||
| `action` | | Must be `custom:frigate-card-action`. |
|
||||
| `frigate_card_action` | | Must be `ptz`. |
|
||||
| `camera` | Currently selected camera | An optional camera ID to execute the action on. |
|
||||
| `ptz_action` | | Optional action that is of `left`, `right`, `up`, `down`, `zoom_in`, `zoom_out` or `preset`. |
|
||||
| `ptz_phase` | | Optional parameter that is one of `start` or `stop` to start or stop the movement separately. |
|
||||
| `ptz_preset` | | Optional preset to execute when the `ptz_action` is `preset`. |
|
||||
|
||||
?> If no `ptz_action` is specified, the camera returns to its "home" position. For a real PTZ camera, the "home" position is the first available preset. If there are no presets, there is no home position.
|
||||
|
||||
## `ptz_controls`
|
||||
|
||||
Show or hide the PTZ controls.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: ptz_controls
|
||||
[...]
|
||||
```
|
||||
|
||||
| Parameter | Description |
|
||||
| - | - |
|
||||
| `action` | Must be `custom:frigate-card-action`. |
|
||||
| `frigate_card_action` | Must be `ptz_controls`. |
|
||||
| `show` | If `true` shows the PTZ controls, if `false` hides them. |
|
||||
|
||||
## `ptz_digital`
|
||||
|
||||
Execute a digital PTZ action.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: ptz-digital
|
||||
[...]
|
||||
```
|
||||
|
||||
| Parameter | Default | Description |
|
||||
| - | - | - |
|
||||
| `action` | | Must be `custom:frigate-card-action`. |
|
||||
| `frigate_card_action` | | Must be `ptz-digital`. |
|
||||
| `target_id` | The currently selected camera or media | The target (camera or media) to execute a digital PTZ action on. Can be a camera ID, or another media ID (e.g. for Frigate, can specify a media/event ID). |
|
||||
| `ptz_action` | Optional action that is one of `left`, `right`, `up`, `down`, `zoom_in` or `zoom_out`. |
|
||||
| `ptz_phase` | Optional parameter that is one of `start` or `stop` to start or stop the movement separately. |
|
||||
| `absolute` | Optional parameter to specify exact absolute pan and zoom settings. See below. |
|
||||
|
||||
?> If no `ptz_action` is specified and no `absolute` value is specified, the camera returns to its "home" position. See [Camera layout configuration](../../cameras/README.md?id=layout-configuration) to configure the default "home" position for digital PTZ.
|
||||
|
||||
### `absolute`
|
||||
|
||||
Set exact digital PTZ pan and zoom parameters.
|
||||
|
||||
| Parameter | Description |
|
||||
| - | - |
|
||||
| `pan` | Control camera digital pan. See the `pan` parameter in [Camera layout configuration](../../cameras/README.md?id=layout-configuration). |
|
||||
| `zoom` | Control camera digital zoom. See the `zoom` parameter in [Camera layout configuration](../../cameras/README.md?id=layout-configuration). |
|
||||
|
||||
## `ptz_multi`
|
||||
|
||||
Execute a PTZ action that intelligently chooses between a real and digital PTZ
|
||||
action. If the media in question is a live camera with real PTZ support, a real
|
||||
PTZ action will execute (equivalent to using the [`ptz`](README.md?id=ptz)
|
||||
action), otherwise a digital PTZ action will be run (equivalent to using the
|
||||
[`ptz_digital`](README.md?id=ptz_digital) action).
|
||||
|
||||
?> If the camera supports _any_ real PTZ action, _all_ actions will attempt to make real PTZ calls.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: ptz-multi
|
||||
[...]
|
||||
```
|
||||
|
||||
| Parameter | Description |
|
||||
| - | - |
|
||||
| `action` | Must be `custom:frigate-card-action`. |
|
||||
| `frigate_card_action` | Must be `ptz-digital`. |
|
||||
| `ptz_action` | Optional action that is one of `left`, `right`, `up`, `down`, `zoom_in` or `zoom_out`. |
|
||||
| `ptz_phase` | Optional parameter that is one of `start` or `stop` to start or stop the movement separately. |
|
||||
| `ptz_preset` | Optional preset to execute when the `ptz_action` is `preset`. |
|
||||
|
||||
?> If no `ptz_action` is specified, the camera returns to its "home" position.
|
||||
|
||||
## `recording`
|
||||
|
||||
Change to the `recording` view.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: recording
|
||||
```
|
||||
|
||||
## `recordings`
|
||||
|
||||
Change to the `recordings` view.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: recordings
|
||||
```
|
||||
|
||||
## `screenshot`
|
||||
|
||||
Take a screenshot of the selected media (e.g. a still from a video).
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: screenshot
|
||||
```
|
||||
|
||||
## `sleep`
|
||||
|
||||
Take no action for a given duration. Useful to pause between multiple other actions.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: sleep
|
||||
```
|
||||
|
||||
| Parameter | Description |
|
||||
| - | - |
|
||||
| `action` | Must be `custom:frigate-card-action`. |
|
||||
| `frigate_card_action` | Must be `sleep`. |
|
||||
| `duration` | A duration object. See below. |
|
||||
|
||||
### `duration`
|
||||
|
||||
The `duration` block configures how long the `sleep` should last.
|
||||
|
||||
| Parameter | Description |
|
||||
| - | - |
|
||||
| `h` | Hours to sleep for. |
|
||||
| `m` | Minutes to sleep for. |
|
||||
| `s` | Seconds to sleep for. |
|
||||
| `ms` | Milliseconds to sleep for. |
|
||||
|
||||
?> Multiple values can be combined, e.g. `{ m: 2, s: 30}` will sleep for `2.5` minutes.
|
||||
|
||||
## `snapshot`
|
||||
|
||||
Change to the `snapshot` view.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: snapshot
|
||||
```
|
||||
|
||||
## `snapshots`
|
||||
|
||||
Change to the `snapshots` view.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: snapshots
|
||||
```
|
||||
|
||||
## `timeline`
|
||||
|
||||
Change to the `timeline` view.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: timeline
|
||||
```
|
||||
|
||||
## `unmute`
|
||||
|
||||
Unmute the selected media.
|
||||
|
||||
```yaml
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: unmute
|
||||
```
|
||||
|
||||
## Fully expanded reference
|
||||
|
||||
[](../../common/expanded-warning.md ':include')
|
||||
|
||||
```yaml
|
||||
elements:
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-a-circle
|
||||
title: Select Front Door
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: camera_select
|
||||
camera: camera.front_door
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-b-circle
|
||||
title: Open Camera UI
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: camera_ui
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-c-circle
|
||||
title: Change Zoom
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: change_zoom
|
||||
pan:
|
||||
x: 50
|
||||
y: 50
|
||||
zoom: 1
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-d-circle
|
||||
title: Show most recent clip
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: clip
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-e-circle
|
||||
title: Show clips
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: clips
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-f-circle
|
||||
title: Show default view
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: default
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-g-circle
|
||||
title: Show diagnostics
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: diagnostics
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-h-circle
|
||||
title: Show grid
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: display_mode_select
|
||||
display_mode: grid
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-i-circle
|
||||
title: Download media
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: download
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-j-circle
|
||||
title: Expand
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: expand
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-k-circle
|
||||
title: Fullscreen
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: fullscreen
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-l-circle
|
||||
title: Show image view
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: image
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-m-circle
|
||||
title: Show live view
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: live
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-n-circle
|
||||
title: Turn off substream
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: live_substream_off
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-o-circle
|
||||
title: Turn on substream
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: live_substream_on
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-n-circle
|
||||
title: Select HD substream
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: live_substream_select
|
||||
camera: camera.front_door_hd
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-o-circle
|
||||
title: Log to console
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: log
|
||||
message: "Hello, world!"
|
||||
level: debug
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-m-circle
|
||||
title: Media player play
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: media_player
|
||||
media_player: media_player.nesthub50be
|
||||
media_player_action: play
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-n-circle
|
||||
title: Media player stop
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: media_player
|
||||
media_player: media_player.nesthub
|
||||
media_player_action: stop
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-o-circle
|
||||
title: Toggle hidden menu
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: menu_toggle
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-p-circle
|
||||
title: Microphone mute
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: microphone_mute
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-q-circle
|
||||
title: Microphone unmute
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: microphone_unmute
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-r-circle
|
||||
title: Mute
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: mute
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-s-circle
|
||||
title: Pause
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: pause
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-t-circle
|
||||
title: Play
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: play
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-u-circle
|
||||
title: Real PTZ Preset
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: ptz
|
||||
ptz_action: preset
|
||||
ptz_preset: doorway
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-v-circle
|
||||
title: Show PTZ Controls
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: ptz_controls
|
||||
enabled: true
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-w-circle
|
||||
title: Go to precise digital location
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: ptz_digital
|
||||
absolute:
|
||||
zoom: 5
|
||||
pan:
|
||||
x: 58
|
||||
y: 14
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-x-circle
|
||||
title: Smart select between real and digital PTZ
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: ptz_multi
|
||||
ptz_action: left
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-y-circle
|
||||
title: Show most recent recording
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: recording
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-a-circle-outline
|
||||
title: Show recordings
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: recordings
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-b-circle-outline
|
||||
title: Screenshot
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: screenshot
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-c-circle-outline
|
||||
title: Sleep
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: sleep
|
||||
duration:
|
||||
h: 1
|
||||
m: 20
|
||||
s: 56
|
||||
ms: 422
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-d-circle-outline
|
||||
title: Show most recent snapshot
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: snapshot
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-e-circle-outline
|
||||
title: Show snapshots
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: snapshots
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-f-circle-outline
|
||||
title: Show timeline
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: timeline
|
||||
- type: custom:frigate-card-menu-icon
|
||||
icon: mdi:alpha-g-circle-outline
|
||||
title: Unmute
|
||||
tap_action:
|
||||
action: custom:frigate-card-action
|
||||
frigate_card_action: unmute
|
||||
```
|
||||
@@ -0,0 +1,27 @@
|
||||
* [Getting Started](../../../README.md)
|
||||
* [Configuration](../../README.md)
|
||||
* [`actions`](../README.md)
|
||||
* [Custom Actions](README.md)
|
||||
* [Stock Actions](../stock/README.md)
|
||||
* [`automations`](../../automations.md)
|
||||
* [`cameras`](../../cameras/README.md)
|
||||
* [`conditions`](../../conditions.md)
|
||||
* [`dimensions`](../../dimensions.md)
|
||||
* [`elements`](../../elements.md)
|
||||
* [`image`](../../image.md)
|
||||
* [`live`](../../live.md)
|
||||
* [`media_gallery`](../../media-gallery.md)
|
||||
* [`media_viewer`](../../media-viewer.md)
|
||||
* [`menu`](../../menu.md)
|
||||
* [`overrides`](../../overrides.md)
|
||||
* [`performance`](../../performance.md)
|
||||
* [`profiles`](../../profiles.md)
|
||||
* [`timeline`](../../timeline.md)
|
||||
* [`view`](../../view.md)
|
||||
* [Screenshots](../../../screenshots.md)
|
||||
* [Troubleshooting](../../../troubleshooting.md)
|
||||
* [Usage](../../../usage/README.md)
|
||||
|
||||
---
|
||||
|
||||
* [Developing](../../../developing.md)
|
||||
@@ -0,0 +1,120 @@
|
||||
# Stock Actions
|
||||
|
||||
## `call-service`
|
||||
|
||||
Call a service. See [Home Assistant actions documentation](https://www.home-assistant.io/dashboards/actions/).
|
||||
|
||||
```yaml
|
||||
action: call-service
|
||||
[...]
|
||||
```
|
||||
|
||||
## `more-info`
|
||||
|
||||
Open the "more-info" dialog for an entity. See [Home Assistant actions documentation](https://www.home-assistant.io/dashboards/actions/).
|
||||
|
||||
```yaml
|
||||
action: more-info
|
||||
[...]
|
||||
```
|
||||
|
||||
## `navigate`
|
||||
|
||||
Navigate to a particular dashboard path. See [Home Assistant actions documentation](https://www.home-assistant.io/dashboards/actions/).
|
||||
|
||||
```yaml
|
||||
action: navigate
|
||||
[...]
|
||||
```
|
||||
|
||||
## `toggle`
|
||||
|
||||
Toggle an entity. See [Home Assistant actions documentation](https://www.home-assistant.io/dashboards/actions/).
|
||||
|
||||
```yaml
|
||||
action: toggle
|
||||
[...]
|
||||
```
|
||||
|
||||
## `url`
|
||||
|
||||
Navigate to an arbitrary URL. See [Home Assistant actions documentation](https://www.home-assistant.io/dashboards/actions/).
|
||||
|
||||
```yaml
|
||||
action: url
|
||||
[...]
|
||||
```
|
||||
|
||||
## Fully expanded reference
|
||||
|
||||
[](../../common/expanded-warning.md ':include')
|
||||
|
||||
Reference: [Home Assistant Actions](https://www.home-assistant.io/dashboards/actions/).
|
||||
|
||||
```yaml
|
||||
elements:
|
||||
- type: icon
|
||||
icon: mdi:numeric-1-box
|
||||
title: More info action
|
||||
style:
|
||||
left: 200px
|
||||
top: 50px
|
||||
entity: light.office_main_lights
|
||||
tap_action:
|
||||
action: more-info
|
||||
- type: icon
|
||||
icon: mdi:numeric-2-box
|
||||
title: Toggle action
|
||||
style:
|
||||
left: 200px
|
||||
top: 100px
|
||||
entity: light.office_main_lights
|
||||
tap_action:
|
||||
action: toggle
|
||||
- type: icon
|
||||
icon: mdi:numeric-3-box
|
||||
title: Call Service action
|
||||
style:
|
||||
left: 200px
|
||||
top: 150px
|
||||
tap_action:
|
||||
action: call-service
|
||||
service: homeassistant.toggle
|
||||
data:
|
||||
entity_id: light.office_main_lights
|
||||
- type: icon
|
||||
icon: mdi:numeric-4-box
|
||||
title: Navigate action
|
||||
style:
|
||||
left: 200px
|
||||
top: 200px
|
||||
tap_action:
|
||||
action: navigate
|
||||
navigation_path: /lovelace/2
|
||||
- type: icon
|
||||
icon: mdi:numeric-5-box
|
||||
title: URL action
|
||||
style:
|
||||
left: 200px
|
||||
top: 250px
|
||||
tap_action:
|
||||
action: url
|
||||
url_path: https://www.home-assistant.io/
|
||||
- type: icon
|
||||
icon: mdi:numeric-6-box
|
||||
title: None action
|
||||
style:
|
||||
left: 200px
|
||||
top: 300px
|
||||
tap_action:
|
||||
action: none
|
||||
- type: icon
|
||||
icon: mdi:numeric-7-box
|
||||
title: Custom action
|
||||
style:
|
||||
left: 200px
|
||||
top: 350px
|
||||
tap_action:
|
||||
action: fire-dom-event
|
||||
key: value
|
||||
```
|
||||
@@ -0,0 +1,27 @@
|
||||
* [Getting Started](../../../README.md)
|
||||
* [Configuration](../../README.md)
|
||||
* [`actions`](../README.md)
|
||||
* [Custom Actions](../custom/README.md)
|
||||
* [Stock Actions](README.md)
|
||||
* [`automations`](../../automations.md)
|
||||
* [`cameras`](../../cameras/README.md)
|
||||
* [`conditions`](../../conditions.md)
|
||||
* [`dimensions`](../../dimensions.md)
|
||||
* [`elements`](../../elements.md)
|
||||
* [`image`](../../image.md)
|
||||
* [`live`](../../live.md)
|
||||
* [`media_gallery`](../../media-gallery.md)
|
||||
* [`media_viewer`](../../media-viewer.md)
|
||||
* [`menu`](../../menu.md)
|
||||
* [`overrides`](../../overrides.md)
|
||||
* [`performance`](../../performance.md)
|
||||
* [`profiles`](../../profiles.md)
|
||||
* [`timeline`](../../timeline.md)
|
||||
* [`view`](../../view.md)
|
||||
* [Screenshots](../../../screenshots.md)
|
||||
* [Troubleshooting](../../../troubleshooting.md)
|
||||
* [Usage](../../../usage/README.md)
|
||||
|
||||
---
|
||||
|
||||
* [Developing](../../../developing.md)
|
||||
Reference in New Issue
Block a user