diff --git a/README.md b/README.md index 28b8cfaf..a4172f94 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ [![hacs](https://img.shields.io/badge/HACS-default-orange.svg?style=flat-square)](https://hacs.xyz) [![BuyMeCoffee](https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=flat-square)](https://www.buymeacoffee.com/dermotdu) -Frigate card example +Frigate card example | ♥️ This card is under active development. Be sure to consult the documentation that matches the release of the card you're using, rather than the documentation at head. README for latest stable release: [v3.0](https://github.com/dermotduffy/frigate-hass-card/blob/v3.0.0/README.md) | | - | @@ -514,7 +514,7 @@ See the [fully expanded image configuration example](#config-expanded-image) for | Option | Default | Overridable | Description | | - | - | - | - | -| `mode` | `url` | :white_check_mark: | Mode of the the `image` [view](#views). Value must be one of `url` (to fetch an arbitrary image URL), `camera` (to show a still of the currently selected camera using either `camera_entity` or `webrtc_card.entity` in that order of precedence), or `screensaver` (to show an [embedded stock Frigate card logo](https://github.com/dermotduffy/frigate-hass-card/blob/main/src/images/frigate-bird-in-sky.jpg)). In either `url` or `camera` mode, the `screensaver` content is used as a fallback if a URL is not specified or cannot be derived. | +| `mode` | `url` | :white_check_mark: | Mode of the the `image` [view](#views). Value must be one of `url` (to fetch an arbitrary image URL), `camera` (to show a still of the currently selected camera using either `camera_entity` or `webrtc_card.entity` in that order of precedence), or `screensaver` (to show an [embedded stock Frigate card logo](https://github.com/dermotduffy/frigate-hass-card/blob/release-4.0.0/src/images/frigate-bird-in-sky.jpg)). In either `url` or `camera` mode, the `screensaver` content is used as a fallback if a URL is not specified or cannot be derived. | | `url` | | :white_check_mark: | A static image URL to be used when the `mode` is set to `url` or when a temporary image is required (e.g. may appear momentarily prior to load of a camera snapshot in the `camera` mode). Note that a `_t=[timestsamp]` query parameter will be automatically added to all URLs such that the image will not be cached by the browser.| | `refresh_seconds` | 0 | :white_check_mark: | The image will be refreshed at least every `refresh_seconds` (it may refresh more frequently, e.g. whenever Home Assistant updates its camera security token). `0` implies no refreshing. | | `actions` | | :white_check_mark: | Actions to use for the `image` view. See [actions](#actions) below.| @@ -642,7 +642,7 @@ WebRTC Card support blends the use of the ultra-realtime [WebRTC card live view](https://github.com/AlexxIT/WebRTC) with convenient access to Frigate events/snapshots/UI. A perfect combination! -Live viewing +Live viewing **Note**: AlexxIT's WebRTC Integration/Card must be installed and configured separately (see [details](https://github.com/AlexxIT/WebRTC)) before it can be used with this card. @@ -939,11 +939,11 @@ This card supports several menu styles. | Key | Description | Screenshot | | ------------- | --------------------------------------------- | - | -|`hidden`| Hide the menu by default, expandable upon clicking the Frigate button. | Menu hidden | -|`overlay`| Overlay the menu over the card contents. The Frigate button shows the default view. | Menu overlaid | -|`hover`| Overlay the menu over the card contents when the mouse is over the menu, otherwise it is not shown. The Frigate button shows the default view. | Menu overlaid | -|`outside`| Render the menu outside the card (i.e. above it if `position` is `top`, or below it if `position` is `bottom`). The Frigate button shows the default view. | Menu above | -|`none`| No menu is shown. | No Menu | +|`hidden`| Hide the menu by default, expandable upon clicking the Frigate button. | Menu hidden | +|`overlay`| Overlay the menu over the card contents. The Frigate button shows the default view. | Menu overlaid | +|`hover`| Overlay the menu over the card contents when the mouse is over the menu, otherwise it is not shown. The Frigate button shows the default view. | Menu overlaid | +|`outside`| Render the menu outside the card (i.e. above it if `position` is `top`, or below it if `position` is `bottom`). The Frigate button shows the default view. | Menu above | +|`none`| No menu is shown. | No Menu | @@ -954,83 +954,83 @@ This card supports several menu styles. Scroll through your live cameras, or choose from a menu. Seamlessly supports cameras of different dimensions, and custom submenus per camera. -Gallery +Gallery ### Full Viewing Of Events -Gallery +Gallery ### Live Viewing With Thumbnail Carousel -Live view with event thumbnails +Live view with event thumbnails ### Clip Viewing With Thumbnail Carousel -Viewer with event thumbnails +Viewer with event thumbnails ### Hover Menu / Thumbnail Next & Previous Controls -Viewer with event thumbnails +Viewer with event thumbnails ### Card Editing This card supports full editing via the Lovelace card editor. Additional arbitrary configuration for WebRTC Card may be specified in YAML mode. -Live viewing +Live viewing ### Configurable Submenus This card supports fully configurable submenus. -Configurable submenus +Configurable submenus ### Select Entity Submenus Automatically generate submenus from `select` entities. -Select based submenus +Select based submenus ### Cast media from the card Cast media from the card to a local player. -Cast media +Cast media ### Scan Mode Automatically choose the camera with the action! -Cast media +Cast media ### Thumbnail Drawers View thumbnails in side-drawers. -Thumbnail drawers +Thumbnail drawers ### Event Timeline View events in the timeline. -Event Timeline +Event Timeline ### Single Camera Recordings View recordings for a camera across time: -Recording for single camera +Recording for single camera ### Multiple Camera Recordings View recordings for multiple cameras at a given time: -Recording for multiple cameras +Recording for multiple cameras ### Dark Mode Dim the card when not used. -Card dark mode +Card dark mode @@ -1038,7 +1038,7 @@ Dim the card when not used. A dashboard with the card can be cast onto a suitable device (such as the Nest Hub shown below). -Card on Nest Hub +Card on Nest Hub ## Examples @@ -2040,7 +2040,7 @@ elements: opacity: 0.5 ``` -Picture elements temperature example +Picture elements temperature example ### Adding State Badges