3.2 KiB
3.2 KiB
URL Actions
It is possible to pass the Frigate card one or more actions from the URL (e.g. select a particular camera, open the live view in expanded mode, etc).
When actions are executed
The Frigate card will execute these actions in the following circumstances:
- On initial card load.
- On 'tab' change in a dashboard.
- When a
navigateaction is called on the dashboard (e.g. a button click requests navigation). - When the user uses the
back/forwardbrowser buttons whilst viewing a dashboard.
Instructions
To send an action to all Frigate Cards on a dashboard:
[PATH_TO_YOUR_HA_DASHBOARD]?frigate-card-action.[ACTION]=[VALUE]
To send an action to a specific named Frigate Card:
[PATH_TO_YOUR_HA_DASHBOARD]?frigate-card-action.[CARD_ID].[ACTION]=[VALUE]
| Parameter | Description |
|---|---|
ACTION |
One of the supported Frigate Card custom actions. See below. |
CARD_ID |
When specified only cards that have a card_id parameter will act. |
VALUE |
An optional value to use with the camera_select and live_substream_select actions. |
?> Both . and : may be used as the delimiter. If you use : some
browsers may require it be escaped to %3A.
!> If a dashboard has multiple Frigate cards on it, even if they are on
different 'tabs' within that dashboard, they will all respond to the actions
unless the action is targeted with a CARD_ID as shown above.
Supported Actions
Only a subset of all actions are supported in URL form.
| Action | Supported in URL | Explanation |
|---|---|---|
camera_select |
✅ | |
camera_ui |
✅ | |
clip |
✅ | |
clips |
✅ | |
default |
✅ | |
download |
✖️ | Latest media information is not available on initial render. |
expand |
✅ | |
fullscreen |
✖️ | Javascript does not support activating fullscreen without direct human interaction. Use expand as an alternative. |
image |
✅ | |
live_substream_select |
✅ | |
live |
✅ | |
media_player |
✖️ | Please request if you need this. |
menu_toggle |
✅ | |
microphone_mute, microphone_unmute |
✖️ | |
mute, unmute |
✖️ | |
play, pause |
✖️ | |
ptz |
✖️ | Please request if you need this. |
recording |
✅ | |
recordings |
✅ | |
screenshot |
✖️ | Latest media information is not available on initial render. |
show_ptz |
✖️ | Please request if you need this. |
snapshot |
✅ | |
snapshots |
✅ |
Examples
See URL actions examples.