From 72ca8613d79718c005faf3b2499367ac0211b613 Mon Sep 17 00:00:00 2001 From: Dermot Duffy Date: Fri, 20 Aug 2021 21:43:19 -0700 Subject: [PATCH] Update README with examples. --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index c1fa9dc7..c5176426 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,7 @@ lovelace: | `frigate_camera_name` | By default, the Frigate camera name is assumed to be the string after the `camera.` in the entity name. This parameter allows that heuristic to be overriden for cases where the entity name does not cleanly map to the Frigate camera name.| | `view_default` | The view to show by default. See [views](#views) below.| | `view_timeout` | A numbers of seconds of inactivity after which the card will reset to the default configured view. Inactivity is defined as lack of interaction with the Frigate menu.| +| `autoplay_clip` | Whether or not to autoplay clips in the 'clip' [view](#views). Clips manually chosen in the clips gallery will still autoplay.| ### Advanced @@ -104,8 +105,11 @@ Note: WebRTC must be installed and configured separately (see [details](https:// For the `clip` or `snapshot` view, the most recent clip/snapshot is rendered. This will automatically update whenever the state of the `camera_entity` or `motion_entity` changes. In particular, if the desire is to have a live view of the most recent event, you should configure `motion_entity` to a Frigate binary sensor associated with that camera in order to trigger updates more regularly (the underlying camera entity state does not change often, the motion binary sensors do). + ### Example YAML Configuration +A configuration that uses WebRTC for live: + ```yaml - type: 'custom:frigate-card' camera_entity: camera.front_door @@ -115,6 +119,18 @@ For the `clip` or `snapshot` view, the most recent clip/snapshot is rendered. Th webrtc: entity: camera.front_door_rtsp ``` + +A configuration that shows the latest clip on load, but does not automatically play it: + +```yaml +- type: 'custom:frigate-card' + camera_entity: camera.front_door + frigate_url: http://frigate + motion_entity: binary_sensor.front_door_person_motion + view_default: clip + autoplay_clip: false +``` + ### Screenshot: Snapshot / Clip Gallery Full viewing of clips