flan/advanced-camera-card
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix some broken formatting in the docs

Browse Source
This commit is contained in:
Felipe Santos
2024-06-10 00:49:57 -03:00
parent fccb4c9afd
commit 91b0909614
17 changed files with 175 additions and 116 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/configuration/actions/custom/README.md
+11 -11
View File
@@ -4,7 +4,7 @@ Execute a Frigate Card action.
```yaml ```yaml
action: custom:frigate-card-action action: custom:frigate-card-action
[...] # [...]
``` ```
| Parameter | Description | | Parameter | Description |
@@ -19,7 +19,7 @@ Select a given camera.
```yaml ```yaml
action: custom:frigate-card-action action: custom:frigate-card-action
frigate_card_action: camera_select frigate_card_action: camera_select
[...] # [...]
``` ```
| Parameter | Description | | Parameter | Description |
@@ -49,7 +49,7 @@ Zoom in and/or pan for a given camera.
```yaml ```yaml
action: custom:frigate-card-action action: custom:frigate-card-action
frigate_card_action: change_zoom frigate_card_action: change_zoom
[...] # [...]
``` ```
| Parameter | Description | | Parameter | Description |
@@ -107,7 +107,7 @@ Select a display mode (e.g. view a `single` camera or a `grid` of cameras).
```yaml ```yaml
action: custom:frigate-card-action action: custom:frigate-card-action
frigate_card_action: display_mode_select frigate_card_action: display_mode_select
[...] # [...]
``` ```
| Parameter | Description | | Parameter | Description |
@@ -196,7 +196,7 @@ Select a substream. Use [Camera dependency configuration](../../cameras/README.m
```yaml ```yaml
action: custom:frigate-card-action action: custom:frigate-card-action
frigate_card_action: live_substream_select frigate_card_action: live_substream_select
[...] # [...]
``` ```
| Parameter | Description | | Parameter | Description |
@@ -212,7 +212,7 @@ Log a message to the Javascript console.
```yaml ```yaml
action: custom:frigate-card-action action: custom:frigate-card-action
frigate_card_action: log frigate_card_action: log
[...] # [...]
``` ```
| Parameter | Default | Description | | Parameter | Default | Description |
@@ -229,7 +229,7 @@ Perform a media player action.
```yaml ```yaml
action: custom:frigate-card-action action: custom:frigate-card-action
frigate_card_action: media_player frigate_card_action: media_player
[...] # [...]
``` ```
| Parameter | Description | | Parameter | Description |
@@ -300,7 +300,7 @@ Execute a real PTZ action, whether configured manually (see [Camera PTZ configur
```yaml ```yaml
action: custom:frigate-card-action action: custom:frigate-card-action
frigate_card_action: ptz frigate_card_action: ptz
[...] # [...]
``` ```
| Parameter | | Description | | Parameter | | Description |
@@ -321,7 +321,7 @@ Show or hide the PTZ controls.
```yaml ```yaml
action: custom:frigate-card-action action: custom:frigate-card-action
frigate_card_action: ptz_controls frigate_card_action: ptz_controls
[...] # [...]
``` ```
| Parameter | Description | | Parameter | Description |
@@ -337,7 +337,7 @@ Execute a digital PTZ action.
```yaml ```yaml
action: custom:frigate-card-action action: custom:frigate-card-action
frigate_card_action: ptz-digital frigate_card_action: ptz-digital
[...] # [...]
``` ```
| Parameter | Default | Description | | Parameter | Default | Description |
@@ -373,7 +373,7 @@ action), otherwise a digital PTZ action will be run (equivalent to using the
```yaml ```yaml
action: custom:frigate-card-action action: custom:frigate-card-action
frigate_card_action: ptz-multi frigate_card_action: ptz-multi
[...] # [...]
``` ```
| Parameter | Description | | Parameter | Description |
docs/configuration/actions/stock/README.md
+5 -5
View File
@@ -6,7 +6,7 @@ Call a service. See [Home Assistant actions documentation](https://www.home-assi
```yaml ```yaml
action: call-service action: call-service
[...] # [...]
``` ```
## `more-info` ## `more-info`
@@ -15,7 +15,7 @@ Open the "more-info" dialog for an entity. See [Home Assistant actions documenta
```yaml ```yaml
action: more-info action: more-info
[...] # [...]
``` ```
## `navigate` ## `navigate`
@@ -24,7 +24,7 @@ Navigate to a particular dashboard path. See [Home Assistant actions documentati
```yaml ```yaml
action: navigate action: navigate
[...] # [...]
``` ```
## `toggle` ## `toggle`
@@ -33,7 +33,7 @@ Toggle an entity. See [Home Assistant actions documentation](https://www.home-as
```yaml ```yaml
action: toggle action: toggle
[...] # [...]
``` ```
## `url` ## `url`
@@ -42,7 +42,7 @@ Navigate to an arbitrary URL. See [Home Assistant actions documentation](https:/
```yaml ```yaml
action: url action: url
[...] # [...]
``` ```
## Fully expanded reference ## Fully expanded reference
docs/configuration/cameras/README.md
+18 -9
View File
@@ -12,7 +12,8 @@ cameras:
The `cameras_global` block can be used to set defaults across multiple cameras. The `cameras_global` block can be used to set defaults across multiple cameras.
```yaml ```yaml
cameras_global: [...] cameras_global:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -38,7 +39,8 @@ The `capabilities` block allows selected disabling of auto-detected camera capab
```yaml ```yaml
cameras: cameras:
- camera_entity: camera.office - camera_entity: camera.office
capabilities: [...] capabilities:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -68,7 +70,8 @@ The `cast` block configures how a camera is cast / sent to media players.
```yaml ```yaml
cameras: cameras:
- camera_entity: camera.office - camera_entity: camera.office
cast: [...] cast:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -84,7 +87,8 @@ See the [dashboard method cast example](../../examples.md?id=cast-a-dashboard).
cameras: cameras:
- camera_entity: camera.office - camera_entity: camera.office
cast: cast:
dashboard: [...] dashboard:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -99,7 +103,8 @@ The `dependencies` block configures other cameras as dependents of this camera.
```yaml ```yaml
cameras: cameras:
- camera_entity: camera.office - camera_entity: camera.office
dependencies: [...] dependencies:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -114,7 +119,8 @@ The `dimensions` block configures the dimensions and layout of media of a given
```yaml ```yaml
cameras: cameras:
- camera_entity: camera.office - camera_entity: camera.office
dimensions: [...] dimensions:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -130,7 +136,8 @@ The `layout` block configures the fit and position of the media _within_ the cam
cameras: cameras:
- camera_entity: camera.office - camera_entity: camera.office
dimensions: dimensions:
layout: [...] layout:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -174,7 +181,8 @@ Configure the PTZ actions taken for a camera (not to be confused with configurat
```yaml ```yaml
cameras: cameras:
- camera_entity: camera.office - camera_entity: camera.office
ptz: [...] ptz:
# [...]
``` ```
### Movement types ### Movement types
@@ -236,7 +244,8 @@ camera is triggered.
```yaml ```yaml
cameras: cameras:
- camera_entity: camera.office - camera_entity: camera.office
triggers: [...] triggers:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
docs/configuration/cameras/engine.md
+8 -4
View File
@@ -27,7 +27,8 @@ The `frigate` block configures options for a Frigate camera.
```yaml ```yaml
cameras: cameras:
- camera_entity: camera.office - camera_entity: camera.office
frigate: [...] frigate:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -45,7 +46,8 @@ The `motioneye` block configures options for a MotionEye camera.
```yaml ```yaml
cameras: cameras:
- camera_entity: camera.office - camera_entity: camera.office
motioneye: [...] motioneye:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -62,14 +64,16 @@ The `images` and `movies` block configures how images and movies respectively ar
cameras: cameras:
- camera_entity: camera.office - camera_entity: camera.office
motioneye: motioneye:
images: [...] images:
# [...]
``` ```
```yaml ```yaml
cameras: cameras:
- camera_entity: camera.office - camera_entity: camera.office
motioneye: motioneye:
movies: [...] movies:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
docs/configuration/cameras/live-provider.md
+8 -4
View File
@@ -22,7 +22,8 @@ The `go2rtc` block configures use of the `go2rtc` live provider. This configurat
cameras: cameras:
- camera_entity: camera.office - camera_entity: camera.office
live_provider: go2rtc live_provider: go2rtc
go2rtc: [...] go2rtc:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -39,7 +40,8 @@ All configuration is under:
cameras: cameras:
- camera_entity: camera.office - camera_entity: camera.office
live_provider: image live_provider: image
image: [...] image:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -55,7 +57,8 @@ All configuration is under:
cameras: cameras:
- camera_entity: camera.office - camera_entity: camera.office
live_provider: jsmpeg live_provider: jsmpeg
jsmpeg: [...] jsmpeg:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -72,7 +75,8 @@ events/snapshots/UI. AlexxIT's WebRTC Integration/Card must be installed and con
cameras: cameras:
- camera_entity: camera.office - camera_entity: camera.office
live_provider: webrtc-card live_provider: webrtc-card
webrtc_card: [...] webrtc_card:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
docs/configuration/conditions.md
+13 -13
View File
@@ -19,7 +19,7 @@ certain configurations (in `overrides`) or to display "picture elements" (in
```yaml ```yaml
conditions: conditions:
- condition: camera - condition: camera
[...] # [...]
``` ```
| Parameter | Description | | Parameter | Description |
@@ -32,7 +32,7 @@ conditions:
```yaml ```yaml
conditions: conditions:
- condition: expand - condition: expand
[...] # [...]
``` ```
| Parameter | Description | | Parameter | Description |
@@ -45,7 +45,7 @@ conditions:
```yaml ```yaml
conditions: conditions:
- condition: fullscreen - condition: fullscreen
[...] # [...]
``` ```
| Parameter | Description | | Parameter | Description |
@@ -58,7 +58,7 @@ conditions:
```yaml ```yaml
conditions: conditions:
- condition: interaction - condition: interaction
[...] # [...]
``` ```
| Parameter | Description | | Parameter | Description |
@@ -71,7 +71,7 @@ conditions:
```yaml ```yaml
conditions: conditions:
- condition: key - condition: key
[...] # [...]
``` ```
| Parameter | Default | Description | | Parameter | Default | Description |
@@ -89,7 +89,7 @@ conditions:
```yaml ```yaml
conditions: conditions:
- condition: media_loaded - condition: media_loaded
[...] # [...]
``` ```
| Parameter | Description | | Parameter | Description |
@@ -102,7 +102,7 @@ conditions:
```yaml ```yaml
conditions: conditions:
- condition: microphone - condition: microphone
[...] # [...]
``` ```
| Parameter | Description | | Parameter | Description |
@@ -116,7 +116,7 @@ conditions:
```yaml ```yaml
conditions: conditions:
- condition: numeric_state - condition: numeric_state
[...] # [...]
``` ```
This stock Home Assistant condition works out of the box. See [Home Assistant conditions documentation](https://www.home-assistant.io/dashboards/conditional/#numeric-state). This stock Home Assistant condition works out of the box. See [Home Assistant conditions documentation](https://www.home-assistant.io/dashboards/conditional/#numeric-state).
@@ -126,7 +126,7 @@ This stock Home Assistant condition works out of the box. See [Home Assistant co
```yaml ```yaml
conditions: conditions:
- condition: screen - condition: screen
[...] # [...]
``` ```
| Parameter | Description | | Parameter | Description |
@@ -141,7 +141,7 @@ See the [screen conditions examples](../examples.md?id=screen-conditions).
```yaml ```yaml
conditions: conditions:
- condition: state - condition: state
[...] # [...]
``` ```
This stock Home Assistant condition works out of the box. See [Home Assistant conditions documentation](https://www.home-assistant.io/dashboards/conditional/#state). This stock Home Assistant condition works out of the box. See [Home Assistant conditions documentation](https://www.home-assistant.io/dashboards/conditional/#state).
@@ -151,7 +151,7 @@ This stock Home Assistant condition works out of the box. See [Home Assistant co
```yaml ```yaml
conditions: conditions:
- condition: triggered - condition: triggered
[...] # [...]
``` ```
| Parameter | Description | | Parameter | Description |
@@ -164,7 +164,7 @@ conditions:
```yaml ```yaml
conditions: conditions:
- condition: user - condition: user
[...] # [...]
``` ```
This stock Home Assistant condition works out of the box. See [Home Assistant conditions documentation](https://www.home-assistant.io/dashboards/conditional/#user). This stock Home Assistant condition works out of the box. See [Home Assistant conditions documentation](https://www.home-assistant.io/dashboards/conditional/#user).
@@ -174,7 +174,7 @@ This stock Home Assistant condition works out of the box. See [Home Assistant co
```yaml ```yaml
conditions: conditions:
- condition: view - condition: view
[...] # [...]
``` ```
| Parameter | Description | | Parameter | Description |
docs/configuration/dimensions.md
+2 -1
View File
@@ -9,7 +9,8 @@ expanded (popup/dialog mode) the aspect ratio is chosen dynamically to maximize
the amount of content shown. the amount of content shown.
```yaml ```yaml
dimensions: [...] dimensions:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
docs/configuration/elements.md
+13 -13
View File
@@ -21,7 +21,7 @@ This element will let you show its sub-elements based on entity states. See [Hom
```yaml ```yaml
elements: elements:
- type: conditional - type: conditional
[...] # [...]
``` ```
## `custom` ## `custom`
@@ -31,7 +31,7 @@ Custom elements provided by a card. See [Home Assistant elements documentation](
```yaml ```yaml
elements: elements:
- type: custom - type: custom
[...] # [...]
``` ```
## `custom:frigate-card-menu-icon` ## `custom:frigate-card-menu-icon`
@@ -41,7 +41,7 @@ Add an arbitrary icon to the Frigate Card menu. Configuration is ~identical to t
```yaml ```yaml
elements: elements:
- type: custom:frigate-card-menu-icon - type: custom:frigate-card-menu-icon
[...] # [...]
``` ```
## `custom:frigate-card-menu-state-icon` ## `custom:frigate-card-menu-state-icon`
@@ -51,7 +51,7 @@ Add a state icon to the Frigate Card menu that represents the state of a Home As
```yaml ```yaml
elements: elements:
- type: custom:frigate-card-menu-icon - type: custom:frigate-card-menu-icon
[...] # [...]
``` ```
## `custom:frigate-card-menu-submenu` ## `custom:frigate-card-menu-submenu`
@@ -61,7 +61,7 @@ Add a configurable submenu dropdown.
```yaml ```yaml
elements: elements:
- type: custom:frigate-card-menu-submenu - type: custom:frigate-card-menu-submenu
[...] # [...]
``` ```
Parameters for this element are identical to the parameters of the [stock Home Assistant Icon Element](https://www.home-assistant.io/lovelace/picture-elements/#icon-element) with the exception of these parameters which differ: Parameters for this element are identical to the parameters of the [stock Home Assistant Icon Element](https://www.home-assistant.io/lovelace/picture-elements/#icon-element) with the exception of these parameters which differ:
@@ -91,7 +91,7 @@ Add a submenu based on a `select` or `input_select`. This element allows you to
```yaml ```yaml
elements: elements:
- type: custom:frigate-card-menu-submenu-select - type: custom:frigate-card-menu-submenu-select
[...] # [...]
``` ```
Parameters for the `custom:frigate-card-menu-submenu-select` element are identical to the parameters of the [stock Home Assistant State Icon Element](https://www.home-assistant.io/dashboards/picture-elements/#state-icon) with the exception of these parameters which differ: Parameters for the `custom:frigate-card-menu-submenu-select` element are identical to the parameters of the [stock Home Assistant State Icon Element](https://www.home-assistant.io/dashboards/picture-elements/#state-icon) with the exception of these parameters which differ:
@@ -110,7 +110,7 @@ Restrict a set of elements to only render when the card is matches a set of [con
```yaml ```yaml
elements: elements:
- type: custom:frigate-card-conditional - type: custom:frigate-card-conditional
[...] # [...]
``` ```
Parameters for the `custom:frigate-card-conditional` element: Parameters for the `custom:frigate-card-conditional` element:
@@ -130,7 +130,7 @@ This element creates a static icon that is not linked to the state of an entity.
```yaml ```yaml
elements: elements:
- type: icon - type: icon
[...] # [...]
``` ```
## `image` ## `image`
@@ -140,7 +140,7 @@ This creates an image element that overlays the background image. See [Home Assi
```yaml ```yaml
elements: elements:
- type: image - type: image
[...] # [...]
``` ```
## `service-button` ## `service-button`
@@ -150,7 +150,7 @@ This entity creates a button (with arbitrary text) that can be used to call a se
```yaml ```yaml
elements: elements:
- type: service-button - type: service-button
[...] # [...]
``` ```
## `state-badge` ## `state-badge`
@@ -160,7 +160,7 @@ This element creates a badge representing the state of an entity. See [Home Assi
```yaml ```yaml
elements: elements:
- type: state-badge - type: state-badge
[...] # [...]
``` ```
## `state-icon` ## `state-icon`
@@ -170,7 +170,7 @@ This element represents an entity state using an icon. See [Home Assistant eleme
```yaml ```yaml
elements: elements:
- type: state-icon - type: state-icon
[...] # [...]
``` ```
## `state-label` ## `state-label`
@@ -180,7 +180,7 @@ This element represents an entity’s state via text. See [Home Assistant elemen
```yaml ```yaml
elements: elements:
- type: state-label - type: state-label
[...] # [...]
``` ```
## Fully expanded reference ## Fully expanded reference
docs/configuration/image.md
+2 -1
View File
@@ -3,7 +3,8 @@
Configure the `image` view. Configure the `image` view.
```yaml ```yaml
image: [...] image:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
docs/configuration/live.md
+16 -8
View File
@@ -3,7 +3,8 @@
Configures the behavior of the `live` view. Configures the behavior of the `live` view.
```yaml ```yaml
live: [...] live:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -30,7 +31,8 @@ Configure the controls for the `live` view.
```yaml ```yaml
live: live:
controls: [...] controls:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -48,7 +50,8 @@ Configures how the "Next & Previous" controls are shown on the live view.
```yaml ```yaml
live: live:
controls: controls:
next_previous: [...] next_previous:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -63,7 +66,8 @@ Configures the PTZ (Pan Tilt Zoom) controls.
```yaml ```yaml
live: live:
controls: controls:
ptz: [...] ptz:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -85,7 +89,8 @@ Configures how thumbnails are shown on the live view.
```yaml ```yaml
live: live:
controls: controls:
thumbnails: [...] thumbnails:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -106,7 +111,8 @@ Configures how the mini-timeline is shown on the live view.
```yaml ```yaml
live: live:
controls: controls:
timeline: [...] timeline:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -128,7 +134,8 @@ Configures how the camera title is shown on the live view.
```yaml ```yaml
live: live:
controls: controls:
title: [...] title:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -142,7 +149,8 @@ Controls whether to show a single or grid `live` view.
```yaml ```yaml
live: live:
display: [...] display:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
docs/configuration/media-gallery.md
+6 -3
View File
@@ -3,7 +3,8 @@
The `media_gallery` is used for providing an overview of all `clips`, `snapshots` and `recordings` in a thumbnail gallery. The `media_gallery` is used for providing an overview of all `clips`, `snapshots` and `recordings` in a thumbnail gallery.
```yaml ```yaml
media_gallery: [...] media_gallery:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -20,7 +21,8 @@ Configure the media gallery filter.
```yaml ```yaml
media_gallery: media_gallery:
controls: controls:
filter: [...] filter:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -34,7 +36,8 @@ Configure the media gallery thumbnails.
```yaml ```yaml
media_gallery: media_gallery:
controls: controls:
thumbnails: [...] thumbnails:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
docs/configuration/media-viewer.md
+16 -8
View File
@@ -3,7 +3,8 @@
The `media_player` section configures viewing all `clip`, `snapshot` or `recording` media, in either a media carousel or grid. The `media_player` section configures viewing all `clip`, `snapshot` or `recording` media, in either a media carousel or grid.
```yaml ```yaml
media_viewer: [...] media_viewer:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -26,7 +27,8 @@ Configure the controls for the media player views.
```yaml ```yaml
media_viewer: media_viewer:
controls: [...] controls:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -44,7 +46,8 @@ Configures how the "Next & Previous" controls are shown on the media viewer.
```yaml ```yaml
media_viewer: media_viewer:
controls: controls:
next_previous: [...] next_previous:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -61,7 +64,8 @@ real) panning and zooming.
```yaml ```yaml
media_viewer: media_viewer:
controls: controls:
ptz: [...] ptz:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -81,7 +85,8 @@ Configures how thumbnails are shown on the media viewer.
```yaml ```yaml
media_viewer: media_viewer:
controls: controls:
thumbnails: [...] thumbnails:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -100,7 +105,8 @@ Configures how the mini-timeline is shown on the media viewer.
```yaml ```yaml
media_viewer: media_viewer:
controls: controls:
timeline: [...] timeline:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -122,7 +128,8 @@ Configures how the media title is shown on the media viewer.
```yaml ```yaml
media_viewer: media_viewer:
controls: controls:
title: [...] title:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -136,7 +143,8 @@ Controls whether to show a single media item or grid in the media viewer.
```yaml ```yaml
media_viewer: media_viewer:
display: [...] display:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
docs/configuration/menu.md
+4 -2
View File
@@ -3,7 +3,8 @@
Configures how the card menu behaves. Configures how the card menu behaves.
```yaml ```yaml
menu: [...] menu:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -21,7 +22,8 @@ All configuration is under:
```yaml ```yaml
menu: menu:
buttons: buttons:
[button]: [...] [button]:
# [...]
``` ```
### Available Buttons ### Available Buttons
docs/configuration/overrides.md
+24 -13
View File
@@ -6,8 +6,8 @@ hide the menu in fullscreen mode).
```yaml ```yaml
overrides: overrides:
- conditions: - conditions:
[condition] - [condition]
[...] # [...]
``` ```
!> Whilst all configuration parameters are theoretically overridable, in some instances a configuration variable may only be consulted on startup or changing its value may negatively impact behavior -- override results may vary! !> Whilst all configuration parameters are theoretically overridable, in some instances a configuration variable may only be consulted on startup or changing its value may negatively impact behavior -- override results may vary!
@@ -42,7 +42,8 @@ An array of configuration paths to delete.
```yaml ```yaml
overrides: overrides:
- conditions: [condition] - conditions:
- [condition]
delete: delete:
- [path_1] - [path_1]
- [path_2] - [path_2]
@@ -54,16 +55,20 @@ Delete the 2nd camera:
```yaml ```yaml
overrides: overrides:
- conditions: [condition] - conditions:
delete: 'cameras[2]' - [condition]
delete:
- 'cameras[2]'
``` ```
Delete the menu style parameter, thus falling back to the default: Delete the menu style parameter, thus falling back to the default:
```yaml ```yaml
overrides: overrides:
- conditions: [condition] - conditions:
delete: 'menu.style' - [condition]
delete:
- 'menu.style'
``` ```
## `merge` ## `merge`
@@ -80,7 +85,8 @@ Hide the menu when a given condition is met:
```yaml ```yaml
overrides: overrides:
- conditions: [condition] - conditions:
- [condition]
merge: merge:
menu: { style: 'hidden' } menu: { style: 'hidden' }
``` ```
@@ -89,7 +95,8 @@ Enable thumbnails below the `live` feed:
```yaml ```yaml
overrides: overrides:
- conditions: [condition] - conditions:
- [condition]
merge: merge:
'live.controls.thumbnails': { mode: 'below' } 'live.controls.thumbnails': { mode: 'below' }
``` ```
@@ -98,7 +105,8 @@ Also enables thumbnails below the `live` feed, but without using the dot-separat
```yaml ```yaml
overrides: overrides:
- conditions: [condition] - conditions:
- [condition]
merge: merge:
live: { controls: { thumbnails: { mode: 'below' } } } live: { controls: { thumbnails: { mode: 'below' } } }
``` ```
@@ -117,7 +125,8 @@ Set the entire menu configuration to defaults with the exception of the `style`
```yaml ```yaml
overrides: overrides:
- conditions: [condition] - conditions:
- [condition]
set: set:
menu: { style: 'overlay' } menu: { style: 'overlay' }
``` ```
@@ -126,7 +135,8 @@ Set the menu style but without touching the other `menu` parameters:
```yaml ```yaml
overrides: overrides:
- conditions: [condition] - conditions:
- [condition]
set: set:
'menu.style': 'overlay' 'menu.style': 'overlay'
``` ```
@@ -135,7 +145,8 @@ That is equivalent to merging the following:
```yaml ```yaml
overrides: overrides:
- conditions: [condition] - conditions:
- [condition]
merge: merge:
menu: { style: 'overlay' } menu: { style: 'overlay' }
``` ```
docs/configuration/performance.md
+6 -3
View File
@@ -3,7 +3,8 @@
Configure the card performance settings to enable the card to run (more) smoothly on lower end devices. Configure the card performance settings to enable the card to run (more) smoothly on lower end devices.
```yaml ```yaml
performance: [...] performance:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -17,7 +18,8 @@ Controls card-wide functionality that may impact performance.
```yaml ```yaml
performance: performance:
features: [...] features:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -35,7 +37,8 @@ shadows on timeline items, or curves in the media gallery items).
```yaml ```yaml
performance: performance:
style: [...] style:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
docs/configuration/timeline.md
+6 -3
View File
@@ -4,7 +4,8 @@ Configures a `timeline` view used to show the timing sequence of events and
recordings across multiple cameras. recordings across multiple cameras.
```yaml ```yaml
timeline: [...] timeline:
# [...]
``` ```
You can interact with the timeline in a number of ways: You can interact with the timeline in a number of ways:
@@ -28,7 +29,8 @@ Configure the controls for the `timeline` view.
```yaml ```yaml
timeline: timeline:
controls: [...] controls:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -42,7 +44,8 @@ Configures how thumbnails are shown on the timeline.
```yaml ```yaml
timeline: timeline:
controls: controls:
thumbnails: [...] thumbnails:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
docs/configuration/view.md
+4 -2
View File
@@ -3,7 +3,8 @@
The `view` configuration options control how the default view of the card behaves. The `view` configuration options control how the default view of the card behaves.
```yaml ```yaml
view: [...] view:
# [...]
``` ```
| Option | Default | Description | | Option | Default | Description |
@@ -49,7 +50,8 @@ All configuration is under:
```yaml ```yaml
view: view:
triggers: [...] triggers:
# [...]
``` ```
When a camera untriggers (e.g. an entity state returning to something other than When a camera untriggers (e.g. an entity state returning to something other than