Merge pull request #1498 from dermotduffy/status-bar

Add configurable status bar
dermotduffy · Aug 17, 2024 · 5a1d08f · 5a1d08f
2 parents db9303c + dc3ff62
commit 5a1d08f
Show file tree

Hide file tree

Showing 77 changed files with 3,093 additions and 1,064 deletions.
diff --git a/docs/configuration/README.md b/docs/configuration/README.md
@@ -23,7 +23,7 @@ Only the `cameras` option is required, all other parameters are optional.
 | [`cameras_global`](cameras/README.md) | Global defaults that apply to all cameras from the `cameras` section.                                                                                                                                   |
 | `card_id`                             | An optional ID to uniquely identify this card. For use when actions are being sent to card(s) via [URL actions](../usage/url-actions.md). Must exclusively consist of these characters: `[a-zA-Z0-9_]`. |
 | [`dimensions`](dimensions.md)         | Configures the overall card dimensions.                                                                                                                                                                 |
-| [`elements`](elements.md)             | Add custom elements to the card.                                                                                                                                                                        |
+| [`elements`](elements/README.md)      | Add custom elements to the card.                                                                                                                                                                        |
 | [`image`](image.md)                   | Configures the `image` view.                                                                                                                                                                            |
 | [`live`](live.md)                     | Configures the `live` view.                                                                                                                                                                             |
 | [`media_gallery`](media-gallery.md)   | Configures the media gallery.                                                                                                                                                                           |

diff --git a/docs/configuration/_sidebar.md b/docs/configuration/_sidebar.md
@@ -5,7 +5,7 @@
   - [`cameras`](cameras/README.md)
   - [`conditions`](conditions.md)
   - [`dimensions`](dimensions.md)
-  - [`elements`](elements.md)
+  - [`elements`](elements/README.md)
   - [`image`](image.md)
   - [`live`](live.md)
   - [`media_gallery`](media-gallery.md)
@@ -14,6 +14,7 @@
   - [`overrides`](overrides.md)
   - [`performance`](performance.md)
   - [`profiles`](profiles.md)
+  - [`status_bar`](status-bar.md)
   - [`timeline`](timeline.md)
   - [`view`](view.md)
 - [Examples](../examples.md)

diff --git a/docs/configuration/actions/README.md b/docs/configuration/actions/README.md
@@ -7,7 +7,7 @@ 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
+[element](../elements/README.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

diff --git a/docs/configuration/actions/_sidebar.md b/docs/configuration/actions/_sidebar.md
@@ -7,7 +7,7 @@
   - [`cameras`](../cameras/README.md)
   - [`conditions`](../conditions.md)
   - [`dimensions`](../dimensions.md)
-  - [`elements`](../elements.md)
+  - [`elements`](../elements/README.md)
   - [`image`](../image.md)
   - [`live`](../live.md)
   - [`media_gallery`](../media-gallery.md)
@@ -16,8 +16,10 @@
   - [`overrides`](../overrides.md)
   - [`performance`](../performance.md)
   - [`profiles`](../profiles.md)
+  - [`status_bar`](../status-bar.md)
   - [`timeline`](../timeline.md)
   - [`view`](../view.md)
+- [Examples](../../examples.md)
 - [Screenshots](../../screenshots.md)
 - [Troubleshooting](../../troubleshooting.md)
 - [Usage](../../usage/README.md)

diff --git a/docs/configuration/actions/custom/README.md b/docs/configuration/actions/custom/README.md
@@ -450,15 +450,25 @@ action: custom:frigate-card-action
 frigate_card_action: snapshot
 ```
 
-## `snapshots`
+## `status_bar`
 
-Change to the `snapshots` view.
+Add or remove items from the status bar.
 
 ```yaml
 action: custom:frigate-card-action
-frigate_card_action: snapshots
+frigate_card_action: status_bar
+# [...]
 ```
 
+| Parameter           | Default | Description                                                                                                                                             |
+| ------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `status_bar_action` |         | If `add` adds `items` to the status bar, if `remove` removes items and if `reset` resets the status bar entirely (removes all dynamically added items). |
+| `items`             |         | The items to `add` or `remove`. See below.                                                                                                              |
+
+### `items`
+
+The items parameter is a list of items to `add` or `remove`. See [`custom:frigate-card-status-bar-icon`](../../elements/custom/README.md?id=status-bar-icon), [`custom:frigate-card-status-bar-image`](../../elements/custom/README.md?id=status-bar-image), [`custom:frigate-card-status-bar-string`](../../elements/custom/README.md?id=status-bar-string) for the allowable items and their parameters. See the [fully expanded reference](./README.md?fully-expanded-reference) below for a complete example.
+
 ## `timeline`
 
 Change to the `timeline` view.
@@ -732,4 +742,69 @@ elements:
     tap_action:
       action: custom:frigate-card-action
       frigate_card_action: unmute
+  - type: custom:frigate-card-menu-icon
+    icon: mdi:alpha-h-circle-outline
+    title: Add status bar contents
+    tap_action:
+      - action: custom:frigate-card-action
+        frigate_card_action: status_bar
+        status_bar_action: add
+        items:
+          - type: custom:frigate-card-status-bar-string
+            enabled: true
+            exclusive: false
+            expand: false
+            string: 'Intruder alert!'
+            priority: 50
+            sufficient: false
+          - type: custom:frigate-card-status-bar-icon
+            enabled: true
+            exclusive: false
+            expand: false
+            icon: 'mdi:cow'
+            priority: 50
+            sufficient: false
+          - type: custom:frigate-card-status-bar-image
+            enabled: true
+            exclusive: false
+            expand: false
+            image: https://my.site.com/status.png
+            priority: 50
+            sufficient: false
+  - type: custom:frigate-card-menu-icon
+    icon: mdi:alpha-i-circle-outline
+    title: Remove status bar contents
+    tap_action:
+      - action: custom:frigate-card-action
+        frigate_card_action: status_bar
+        status_bar_action: remove
+        items:
+          - type: custom:frigate-card-status-bar-string
+            enabled: true
+            exclusive: false
+            expand: false
+            string: 'Intruder alert!'
+            priority: 50
+            sufficient: false
+          - type: custom:frigate-card-status-bar-icon
+            enabled: true
+            exclusive: false
+            expand: false
+            icon: 'mdi:cow'
+            priority: 50
+            sufficient: false
+          - type: custom:frigate-card-status-bar-image
+            enabled: true
+            exclusive: false
+            expand: false
+            image: https://my.site.com/status.png
+            priority: 50
+            sufficient: false
+  - type: custom:frigate-card-menu-icon
+    icon: mdi:alpha-i-circle-outline
+    title: Reset status bar contents
+    tap_action:
+      - action: custom:frigate-card-action
+        frigate_card_action: status_bar
+        status_bar_action: reset
 ```
diff --git a/docs/configuration/actions/custom/_sidebar.md b/docs/configuration/actions/custom/_sidebar.md
@@ -7,7 +7,7 @@
   - [`cameras`](../../cameras/README.md)
   - [`conditions`](../../conditions.md)
   - [`dimensions`](../../dimensions.md)
-  - [`elements`](../../elements.md)
+  - [`elements`](../../elements/README.md)
   - [`image`](../../image.md)
   - [`live`](../../live.md)
   - [`media_gallery`](../../media-gallery.md)
@@ -16,8 +16,10 @@
   - [`overrides`](../../overrides.md)
   - [`performance`](../../performance.md)
   - [`profiles`](../../profiles.md)
+  - [`status_bar`](../../status-bar.md)
   - [`timeline`](../../timeline.md)
   - [`view`](../../view.md)
+- [Examples](../../../examples.md)
 - [Screenshots](../../../screenshots.md)
 - [Troubleshooting](../../../troubleshooting.md)
 - [Usage](../../../usage/README.md)

diff --git a/docs/configuration/actions/stock/_sidebar.md b/docs/configuration/actions/stock/_sidebar.md
@@ -7,7 +7,7 @@
   - [`cameras`](../../cameras/README.md)
   - [`conditions`](../../conditions.md)
   - [`dimensions`](../../dimensions.md)
-  - [`elements`](../../elements.md)
+  - [`elements`](../../elements/README.md)
   - [`image`](../../image.md)
   - [`live`](../../live.md)
   - [`media_gallery`](../../media-gallery.md)
@@ -16,8 +16,10 @@
   - [`overrides`](../../overrides.md)
   - [`performance`](../../performance.md)
   - [`profiles`](../../profiles.md)
+  - [`status_bar`](../../status-bar.md)
   - [`timeline`](../../timeline.md)
   - [`view`](../../view.md)
+- [Examples](../../../examples.md)
 - [Screenshots](../../../screenshots.md)
 - [Troubleshooting](../../../troubleshooting.md)
 - [Usage](../../../usage/README.md)

diff --git a/docs/configuration/cameras/_sidebar.md b/docs/configuration/cameras/_sidebar.md
@@ -7,7 +7,7 @@
     - [`engine`](engine.md)
   - [`conditions`](../conditions.md)
   - [`dimensions`](../dimensions.md)
-  - [`elements`](../elements.md)
+  - [`elements`](../elements/README.md)
   - [`image`](../image.md)
   - [`live`](../live.md)
   - [`media_gallery`](../media-gallery.md)
@@ -16,8 +16,10 @@
   - [`overrides`](../overrides.md)
   - [`performance`](../performance.md)
   - [`profiles`](../profiles.md)
+  - [`status_bar`](../status-bar.md)
   - [`timeline`](../timeline.md)
   - [`view`](../view.md)
+- [Examples](../../examples.md)
 - [Screenshots](../../screenshots.md)
 - [Troubleshooting](../../troubleshooting.md)
 - [Usage](../../usage/README.md)