Files
advanced-camera-card/docs/configuration
Dermot Duffy cc376a8be1 feat: Rename the card to advanced-camera-card (#1873)
Whilst the Frigate support in this card is the best among camera
engines, the name incorrectly suggests that Frigate is a requirement.
Instead, to broaden the appeal, change to more camera agnostic name.
This does not suggest any change in priority, role or support for
Frigate.

This change is likely to be bug prone, due to the size of the rename --
the code contains 1500+ references to "Frigate" most of which make sense
to rename, some which do not, all of which needed human assessment.

- Closes #1298


BREAKING CHANGE: References to `frigate-card` in all kinds of
configuration need to be updated to `advanced-camera-card`. An automated
config upgrade should take care of the majority of usecases (click `Edit
-> Upgrade -> Save`), though may not be perfect.
2025-02-06 19:32:32 -08:00
..
2024-08-16 20:08:21 -07:00
2024-08-16 20:08:21 -07:00

Configuration

The card supports a myriad of configuration options for simple or complex setups.

Minimal configuration

type: custom:advanced-camera-card
cameras:
  - camera_entity: camera.office

Configuration blocks

Top-level configuration blocks

Only the cameras option is required, all other parameters are optional.

Option Description
automations Take action when conditions are met.
cameras Configures the cameras to be used in the card. At least one camera must be specified.
cameras_global 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. Must exclusively consist of these characters: [a-zA-Z0-9_].
dimensions Configures the overall card dimensions.
elements Add custom elements to the card.
image Configures the image view.
live Configures the live view.
media_gallery Configures the media gallery.
media_viewer Configures the media viewer.
menu Configures the card menu.
overrides Override card configuration when conditions are met.
performance Configures the card performance.
profiles Apply pre-configured sets of defaults to ease card configuration.
timeline Configures the timeline view.
view Configures the default view and behavior of the card.

Common configuration blocks

Option Description
actions Configure actions.
conditions Configure conditions.