diff --git a/docs/configuration/actions/custom/README.md b/docs/configuration/actions/custom/README.md index ba8a7c86..15fb42f4 100644 --- a/docs/configuration/actions/custom/README.md +++ b/docs/configuration/actions/custom/README.md @@ -4,7 +4,7 @@ Execute a Frigate Card action. ```yaml action: custom:frigate-card-action -[...] +# [...] ``` | Parameter | Description | @@ -19,7 +19,7 @@ Select a given camera. ```yaml action: custom:frigate-card-action frigate_card_action: camera_select -[...] +# [...] ``` | Parameter | Description | @@ -49,7 +49,7 @@ Zoom in and/or pan for a given camera. ```yaml action: custom:frigate-card-action frigate_card_action: change_zoom -[...] +# [...] ``` | Parameter | Description | @@ -107,7 +107,7 @@ Select a display mode (e.g. view a `single` camera or a `grid` of cameras). ```yaml action: custom:frigate-card-action frigate_card_action: display_mode_select -[...] +# [...] ``` | Parameter | Description | @@ -196,7 +196,7 @@ Select a substream. Use [Camera dependency configuration](../../cameras/README.m ```yaml action: custom:frigate-card-action frigate_card_action: live_substream_select -[...] +# [...] ``` | Parameter | Description | @@ -212,7 +212,7 @@ Log a message to the Javascript console. ```yaml action: custom:frigate-card-action frigate_card_action: log -[...] +# [...] ``` | Parameter | Default | Description | @@ -229,7 +229,7 @@ Perform a media player action. ```yaml action: custom:frigate-card-action frigate_card_action: media_player -[...] +# [...] ``` | Parameter | Description | @@ -300,7 +300,7 @@ Execute a real PTZ action, whether configured manually (see [Camera PTZ configur ```yaml action: custom:frigate-card-action frigate_card_action: ptz -[...] +# [...] ``` | Parameter | | Description | @@ -321,7 +321,7 @@ Show or hide the PTZ controls. ```yaml action: custom:frigate-card-action frigate_card_action: ptz_controls -[...] +# [...] ``` | Parameter | Description | @@ -337,7 +337,7 @@ Execute a digital PTZ action. ```yaml action: custom:frigate-card-action frigate_card_action: ptz-digital -[...] +# [...] ``` | Parameter | Default | Description | @@ -373,7 +373,7 @@ action), otherwise a digital PTZ action will be run (equivalent to using the ```yaml action: custom:frigate-card-action frigate_card_action: ptz-multi -[...] +# [...] ``` | Parameter | Description | diff --git a/docs/configuration/actions/stock/README.md b/docs/configuration/actions/stock/README.md index 6fdcfd03..d8458d03 100644 --- a/docs/configuration/actions/stock/README.md +++ b/docs/configuration/actions/stock/README.md @@ -6,7 +6,7 @@ Call a service. See [Home Assistant actions documentation](https://www.home-assi ```yaml action: call-service -[...] +# [...] ``` ## `more-info` @@ -15,7 +15,7 @@ Open the "more-info" dialog for an entity. See [Home Assistant actions documenta ```yaml action: more-info -[...] +# [...] ``` ## `navigate` @@ -24,7 +24,7 @@ Navigate to a particular dashboard path. See [Home Assistant actions documentati ```yaml action: navigate -[...] +# [...] ``` ## `toggle` @@ -33,7 +33,7 @@ Toggle an entity. See [Home Assistant actions documentation](https://www.home-as ```yaml action: toggle -[...] +# [...] ``` ## `url` @@ -42,7 +42,7 @@ Navigate to an arbitrary URL. See [Home Assistant actions documentation](https:/ ```yaml action: url -[...] +# [...] ``` ## Fully expanded reference diff --git a/docs/configuration/cameras/README.md b/docs/configuration/cameras/README.md index 51ced51e..e1da9a0c 100644 --- a/docs/configuration/cameras/README.md +++ b/docs/configuration/cameras/README.md @@ -12,7 +12,8 @@ cameras: The `cameras_global` block can be used to set defaults across multiple cameras. ```yaml -cameras_global: [...] +cameras_global: + # [...] ``` | Option | Default | Description | @@ -38,7 +39,8 @@ The `capabilities` block allows selected disabling of auto-detected camera capab ```yaml cameras: - camera_entity: camera.office - capabilities: [...] + capabilities: + # [...] ``` | Option | Default | Description | @@ -68,7 +70,8 @@ The `cast` block configures how a camera is cast / sent to media players. ```yaml cameras: - camera_entity: camera.office - cast: [...] + cast: + # [...] ``` | Option | Default | Description | @@ -84,7 +87,8 @@ See the [dashboard method cast example](../../examples.md?id=cast-a-dashboard). cameras: - camera_entity: camera.office cast: - dashboard: [...] + dashboard: + # [...] ``` | Option | Default | Description | @@ -99,7 +103,8 @@ The `dependencies` block configures other cameras as dependents of this camera. ```yaml cameras: - camera_entity: camera.office - dependencies: [...] + dependencies: + # [...] ``` | Option | Default | Description | @@ -114,7 +119,8 @@ The `dimensions` block configures the dimensions and layout of media of a given ```yaml cameras: - camera_entity: camera.office - dimensions: [...] + dimensions: + # [...] ``` | Option | Default | Description | @@ -130,7 +136,8 @@ The `layout` block configures the fit and position of the media _within_ the cam cameras: - camera_entity: camera.office dimensions: - layout: [...] + layout: + # [...] ``` | Option | Default | Description | @@ -174,7 +181,8 @@ Configure the PTZ actions taken for a camera (not to be confused with configurat ```yaml cameras: - camera_entity: camera.office - ptz: [...] + ptz: + # [...] ``` ### Movement types @@ -236,7 +244,8 @@ camera is triggered. ```yaml cameras: - camera_entity: camera.office - triggers: [...] + triggers: + # [...] ``` | Option | Default | Description | diff --git a/docs/configuration/cameras/engine.md b/docs/configuration/cameras/engine.md index dab970e1..dcf80892 100644 --- a/docs/configuration/cameras/engine.md +++ b/docs/configuration/cameras/engine.md @@ -27,7 +27,8 @@ The `frigate` block configures options for a Frigate camera. ```yaml cameras: - camera_entity: camera.office - frigate: [...] + frigate: + # [...] ``` | Option | Default | Description | @@ -45,7 +46,8 @@ The `motioneye` block configures options for a MotionEye camera. ```yaml cameras: - camera_entity: camera.office - motioneye: [...] + motioneye: + # [...] ``` | Option | Default | Description | @@ -62,14 +64,16 @@ The `images` and `movies` block configures how images and movies respectively ar cameras: - camera_entity: camera.office motioneye: - images: [...] + images: + # [...] ``` ```yaml cameras: - camera_entity: camera.office motioneye: - movies: [...] + movies: + # [...] ``` | Option | Default | Description | diff --git a/docs/configuration/cameras/live-provider.md b/docs/configuration/cameras/live-provider.md index 03604627..a9b01412 100644 --- a/docs/configuration/cameras/live-provider.md +++ b/docs/configuration/cameras/live-provider.md @@ -22,7 +22,8 @@ The `go2rtc` block configures use of the `go2rtc` live provider. This configurat cameras: - camera_entity: camera.office live_provider: go2rtc - go2rtc: [...] + go2rtc: + # [...] ``` | Option | Default | Description | @@ -39,7 +40,8 @@ All configuration is under: cameras: - camera_entity: camera.office live_provider: image - image: [...] + image: + # [...] ``` | Option | Default | Description | @@ -55,7 +57,8 @@ All configuration is under: cameras: - camera_entity: camera.office live_provider: jsmpeg - jsmpeg: [...] + jsmpeg: + # [...] ``` | Option | Default | Description | @@ -72,7 +75,8 @@ events/snapshots/UI. AlexxIT's WebRTC Integration/Card must be installed and con cameras: - camera_entity: camera.office live_provider: webrtc-card - webrtc_card: [...] + webrtc_card: + # [...] ``` | Option | Default | Description | diff --git a/docs/configuration/conditions.md b/docs/configuration/conditions.md index 8555e1f3..855695c4 100644 --- a/docs/configuration/conditions.md +++ b/docs/configuration/conditions.md @@ -19,7 +19,7 @@ certain configurations (in `overrides`) or to display "picture elements" (in ```yaml conditions: - condition: camera - [...] + # [...] ``` | Parameter | Description | @@ -32,7 +32,7 @@ conditions: ```yaml conditions: - condition: expand - [...] + # [...] ``` | Parameter | Description | @@ -45,7 +45,7 @@ conditions: ```yaml conditions: - condition: fullscreen - [...] + # [...] ``` | Parameter | Description | @@ -58,7 +58,7 @@ conditions: ```yaml conditions: - condition: interaction - [...] + # [...] ``` | Parameter | Description | @@ -71,7 +71,7 @@ conditions: ```yaml conditions: - condition: key - [...] + # [...] ``` | Parameter | Default | Description | @@ -89,7 +89,7 @@ conditions: ```yaml conditions: - condition: media_loaded - [...] + # [...] ``` | Parameter | Description | @@ -102,7 +102,7 @@ conditions: ```yaml conditions: - condition: microphone - [...] + # [...] ``` | Parameter | Description | @@ -116,7 +116,7 @@ conditions: ```yaml conditions: - 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). @@ -126,7 +126,7 @@ This stock Home Assistant condition works out of the box. See [Home Assistant co ```yaml conditions: - condition: screen - [...] + # [...] ``` | Parameter | Description | @@ -141,7 +141,7 @@ See the [screen conditions examples](../examples.md?id=screen-conditions). ```yaml conditions: - 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). @@ -151,7 +151,7 @@ This stock Home Assistant condition works out of the box. See [Home Assistant co ```yaml conditions: - condition: triggered - [...] + # [...] ``` | Parameter | Description | @@ -164,7 +164,7 @@ conditions: ```yaml conditions: - 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). @@ -174,7 +174,7 @@ This stock Home Assistant condition works out of the box. See [Home Assistant co ```yaml conditions: - condition: view - [...] + # [...] ``` | Parameter | Description | diff --git a/docs/configuration/dimensions.md b/docs/configuration/dimensions.md index 3a74d5c3..a499c558 100644 --- a/docs/configuration/dimensions.md +++ b/docs/configuration/dimensions.md @@ -9,7 +9,8 @@ expanded (popup/dialog mode) the aspect ratio is chosen dynamically to maximize the amount of content shown. ```yaml -dimensions: [...] +dimensions: + # [...] ``` | Option | Default | Description | diff --git a/docs/configuration/elements.md b/docs/configuration/elements.md index 87606c68..a3caf508 100644 --- a/docs/configuration/elements.md +++ b/docs/configuration/elements.md @@ -20,8 +20,8 @@ This element will let you show its sub-elements based on entity states. See [Hom ```yaml elements: - - type: conditional - [...] + - type: conditional + # [...] ``` ## `custom` @@ -30,8 +30,8 @@ Custom elements provided by a card. See [Home Assistant elements documentation]( ```yaml elements: - - type: custom - [...] + - type: custom + # [...] ``` ## `custom:frigate-card-menu-icon` @@ -40,8 +40,8 @@ Add an arbitrary icon to the Frigate Card menu. Configuration is ~identical to t ```yaml elements: - - type: custom:frigate-card-menu-icon - [...] + - type: custom:frigate-card-menu-icon + # [...] ``` ## `custom:frigate-card-menu-state-icon` @@ -50,8 +50,8 @@ Add a state icon to the Frigate Card menu that represents the state of a Home As ```yaml elements: - - type: custom:frigate-card-menu-icon - [...] + - type: custom:frigate-card-menu-icon + # [...] ``` ## `custom:frigate-card-menu-submenu` @@ -60,8 +60,8 @@ Add a configurable submenu dropdown. ```yaml 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: @@ -90,8 +90,8 @@ Add a submenu based on a `select` or `input_select`. This element allows you to ```yaml 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: @@ -109,8 +109,8 @@ Restrict a set of elements to only render when the card is matches a set of [con ```yaml elements: - - type: custom:frigate-card-conditional - [...] + - type: custom:frigate-card-conditional + # [...] ``` Parameters for the `custom:frigate-card-conditional` element: @@ -129,8 +129,8 @@ This element creates a static icon that is not linked to the state of an entity. ```yaml elements: - - type: icon - [...] + - type: icon + # [...] ``` ## `image` @@ -139,8 +139,8 @@ This creates an image element that overlays the background image. See [Home Assi ```yaml elements: - - type: image - [...] + - type: image + # [...] ``` ## `service-button` @@ -149,8 +149,8 @@ This entity creates a button (with arbitrary text) that can be used to call a se ```yaml elements: - - type: service-button - [...] + - type: service-button + # [...] ``` ## `state-badge` @@ -159,8 +159,8 @@ This element creates a badge representing the state of an entity. See [Home Assi ```yaml elements: - - type: state-badge - [...] + - type: state-badge + # [...] ``` ## `state-icon` @@ -169,8 +169,8 @@ This element represents an entity state using an icon. See [Home Assistant eleme ```yaml elements: - - type: state-icon - [...] + - type: state-icon + # [...] ``` ## `state-label` @@ -179,8 +179,8 @@ This element represents an entity’s state via text. See [Home Assistant elemen ```yaml elements: - - type: state-label - [...] + - type: state-label + # [...] ``` ## Fully expanded reference diff --git a/docs/configuration/image.md b/docs/configuration/image.md index 273bd767..9141db6d 100644 --- a/docs/configuration/image.md +++ b/docs/configuration/image.md @@ -3,7 +3,8 @@ Configure the `image` view. ```yaml -image: [...] +image: + # [...] ``` | Option | Default | Description | diff --git a/docs/configuration/live.md b/docs/configuration/live.md index 777c6753..b22e29c2 100644 --- a/docs/configuration/live.md +++ b/docs/configuration/live.md @@ -3,7 +3,8 @@ Configures the behavior of the `live` view. ```yaml -live: [...] +live: + # [...] ``` | Option | Default | Description | @@ -30,7 +31,8 @@ Configure the controls for the `live` view. ```yaml live: - controls: [...] + controls: + # [...] ``` | Option | Default | Description | @@ -48,7 +50,8 @@ Configures how the "Next & Previous" controls are shown on the live view. ```yaml live: controls: - next_previous: [...] + next_previous: + # [...] ``` | Option | Default | Description | @@ -63,7 +66,8 @@ Configures the PTZ (Pan Tilt Zoom) controls. ```yaml live: controls: - ptz: [...] + ptz: + # [...] ``` | Option | Default | Description | @@ -85,7 +89,8 @@ Configures how thumbnails are shown on the live view. ```yaml live: controls: - thumbnails: [...] + thumbnails: + # [...] ``` | Option | Default | Description | @@ -106,7 +111,8 @@ Configures how the mini-timeline is shown on the live view. ```yaml live: controls: - timeline: [...] + timeline: + # [...] ``` | Option | Default | Description | @@ -128,7 +134,8 @@ Configures how the camera title is shown on the live view. ```yaml live: controls: - title: [...] + title: + # [...] ``` | Option | Default | Description | @@ -142,7 +149,8 @@ Controls whether to show a single or grid `live` view. ```yaml live: - display: [...] + display: + # [...] ``` | Option | Default | Description | diff --git a/docs/configuration/media-gallery.md b/docs/configuration/media-gallery.md index 34a6d4af..d04bb9b8 100644 --- a/docs/configuration/media-gallery.md +++ b/docs/configuration/media-gallery.md @@ -3,7 +3,8 @@ The `media_gallery` is used for providing an overview of all `clips`, `snapshots` and `recordings` in a thumbnail gallery. ```yaml -media_gallery: [...] +media_gallery: + # [...] ``` | Option | Default | Description | @@ -20,7 +21,8 @@ Configure the media gallery filter. ```yaml media_gallery: controls: - filter: [...] + filter: + # [...] ``` | Option | Default | Description | @@ -34,7 +36,8 @@ Configure the media gallery thumbnails. ```yaml media_gallery: controls: - thumbnails: [...] + thumbnails: + # [...] ``` | Option | Default | Description | diff --git a/docs/configuration/media-viewer.md b/docs/configuration/media-viewer.md index beb3e800..049df860 100644 --- a/docs/configuration/media-viewer.md +++ b/docs/configuration/media-viewer.md @@ -3,7 +3,8 @@ The `media_player` section configures viewing all `clip`, `snapshot` or `recording` media, in either a media carousel or grid. ```yaml -media_viewer: [...] +media_viewer: + # [...] ``` | Option | Default | Description | @@ -26,7 +27,8 @@ Configure the controls for the media player views. ```yaml media_viewer: - controls: [...] + controls: + # [...] ``` | Option | Default | Description | @@ -44,7 +46,8 @@ Configures how the "Next & Previous" controls are shown on the media viewer. ```yaml media_viewer: controls: - next_previous: [...] + next_previous: + # [...] ``` | Option | Default | Description | @@ -61,7 +64,8 @@ real) panning and zooming. ```yaml media_viewer: controls: - ptz: [...] + ptz: + # [...] ``` | Option | Default | Description | @@ -81,7 +85,8 @@ Configures how thumbnails are shown on the media viewer. ```yaml media_viewer: controls: - thumbnails: [...] + thumbnails: + # [...] ``` | Option | Default | Description | @@ -100,7 +105,8 @@ Configures how the mini-timeline is shown on the media viewer. ```yaml media_viewer: controls: - timeline: [...] + timeline: + # [...] ``` | Option | Default | Description | @@ -122,7 +128,8 @@ Configures how the media title is shown on the media viewer. ```yaml media_viewer: controls: - title: [...] + title: + # [...] ``` | Option | Default | Description | @@ -136,7 +143,8 @@ Controls whether to show a single media item or grid in the media viewer. ```yaml media_viewer: - display: [...] + display: + # [...] ``` | Option | Default | Description | diff --git a/docs/configuration/menu.md b/docs/configuration/menu.md index c332f13d..e885a32c 100644 --- a/docs/configuration/menu.md +++ b/docs/configuration/menu.md @@ -3,7 +3,8 @@ Configures how the card menu behaves. ```yaml -menu: [...] +menu: + # [...] ``` | Option | Default | Description | @@ -21,7 +22,8 @@ All configuration is under: ```yaml menu: buttons: - [button]: [...] + [button]: + # [...] ``` ### Available Buttons diff --git a/docs/configuration/overrides.md b/docs/configuration/overrides.md index ace180ad..a645bbc9 100644 --- a/docs/configuration/overrides.md +++ b/docs/configuration/overrides.md @@ -6,8 +6,8 @@ hide the menu in fullscreen mode). ```yaml overrides: - 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! @@ -42,7 +42,8 @@ An array of configuration paths to delete. ```yaml overrides: - - conditions: [condition] + - conditions: + - [condition] delete: - [path_1] - [path_2] @@ -54,16 +55,20 @@ Delete the 2nd camera: ```yaml overrides: - - conditions: [condition] - delete: 'cameras[2]' + - conditions: + - [condition] + delete: + - 'cameras[2]' ``` Delete the menu style parameter, thus falling back to the default: ```yaml overrides: - - conditions: [condition] - delete: 'menu.style' + - conditions: + - [condition] + delete: + - 'menu.style' ``` ## `merge` @@ -80,7 +85,8 @@ Hide the menu when a given condition is met: ```yaml overrides: - - conditions: [condition] + - conditions: + - [condition] merge: menu: { style: 'hidden' } ``` @@ -89,7 +95,8 @@ Enable thumbnails below the `live` feed: ```yaml overrides: - - conditions: [condition] + - conditions: + - [condition] merge: 'live.controls.thumbnails': { mode: 'below' } ``` @@ -98,7 +105,8 @@ Also enables thumbnails below the `live` feed, but without using the dot-separat ```yaml overrides: - - conditions: [condition] + - conditions: + - [condition] merge: live: { controls: { thumbnails: { mode: 'below' } } } ``` @@ -117,7 +125,8 @@ Set the entire menu configuration to defaults with the exception of the `style` ```yaml overrides: - - conditions: [condition] + - conditions: + - [condition] set: menu: { style: 'overlay' } ``` @@ -126,7 +135,8 @@ Set the menu style but without touching the other `menu` parameters: ```yaml overrides: - - conditions: [condition] + - conditions: + - [condition] set: 'menu.style': 'overlay' ``` @@ -135,7 +145,8 @@ That is equivalent to merging the following: ```yaml overrides: - - conditions: [condition] + - conditions: + - [condition] merge: menu: { style: 'overlay' } ``` diff --git a/docs/configuration/performance.md b/docs/configuration/performance.md index f7ec210d..9590a07c 100644 --- a/docs/configuration/performance.md +++ b/docs/configuration/performance.md @@ -3,7 +3,8 @@ Configure the card performance settings to enable the card to run (more) smoothly on lower end devices. ```yaml -performance: [...] +performance: + # [...] ``` | Option | Default | Description | @@ -17,7 +18,8 @@ Controls card-wide functionality that may impact performance. ```yaml performance: - features: [...] + features: + # [...] ``` | Option | Default | Description | @@ -35,7 +37,8 @@ shadows on timeline items, or curves in the media gallery items). ```yaml performance: - style: [...] + style: + # [...] ``` | Option | Default | Description | diff --git a/docs/configuration/timeline.md b/docs/configuration/timeline.md index cb9b0ea8..28ebfffc 100644 --- a/docs/configuration/timeline.md +++ b/docs/configuration/timeline.md @@ -4,7 +4,8 @@ Configures a `timeline` view used to show the timing sequence of events and recordings across multiple cameras. ```yaml -timeline: [...] +timeline: + # [...] ``` You can interact with the timeline in a number of ways: @@ -28,7 +29,8 @@ Configure the controls for the `timeline` view. ```yaml timeline: - controls: [...] + controls: + # [...] ``` | Option | Default | Description | @@ -42,7 +44,8 @@ Configures how thumbnails are shown on the timeline. ```yaml timeline: controls: - thumbnails: [...] + thumbnails: + # [...] ``` | Option | Default | Description | diff --git a/docs/configuration/view.md b/docs/configuration/view.md index 18971513..f71ce88f 100644 --- a/docs/configuration/view.md +++ b/docs/configuration/view.md @@ -3,7 +3,8 @@ The `view` configuration options control how the default view of the card behaves. ```yaml -view: [...] +view: + # [...] ``` | Option | Default | Description | @@ -49,7 +50,8 @@ All configuration is under: ```yaml view: - triggers: [...] + triggers: + # [...] ``` When a camera untriggers (e.g. an entity state returning to something other than