Files
advanced-camera-card/docs/configuration
Dermot Duffy 3279481b0e feat: Add festive visual effects (#2252)
<!-- CURSOR_SUMMARY -->
> [!NOTE]
> Introduces an effects system (fireworks, ghost, hearts, shamrocks,
snow), a new `effect` action, and optional date-based loading effects,
integrated into the card with docs, schema, editor, and tests.
> 
> - **Effects System**:
> - Add `EffectsController` and `advanced-camera-card-effects` host with
lazy-loaded effect modules (`fireworks`, `ghost`, `hearts`, `shamrocks`,
`snow`).
> - New base effect component with fade-in/out; SCSS and z-index
updates.
> - **Actions**:
> - New custom action `advanced_camera_card_action: effect` with
`effect_action` (`start`|`stop`|`toggle`).
>   - Wire into `ActionFactory` and add `EffectAction` executor.
> - **Card Integration**:
> - Mount effects host in `advanced-camera-card` and expose
`getEffectsControllerAPI()` via `CardController`.
> - Loading component can trigger date-based effects (e.g., New Year
fireworks) when enabled.
> - **Configuration & Editor**:
> - Add `performance.features.card_loading_effects` (default `true`)
alongside `card_loading_indicator`.
> - Update schemas, defaults, low-performance profile (disables
effects), and editor toggles.
> - **Docs & Examples**:
>   - Document `effect` action parameters and add menu example.
>   - Update performance docs with new option.
> - **Localization & Tests**:
>   - Update i18n strings for new performance option.
> - Add comprehensive tests for effects controller, action, factory,
config defaults/profiles, and utilities.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
cffd4304fe3bd22340316f9cec53e341379b1756. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
2025-12-06 18:21:44 -08: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.