Files
advanced-camera-card/docs/configuration/performance.md
T
Dermot Duffy 6b3736bdaf fix: Show version number with card loading spinner (#1825)
- Closes #1818

**Why add this?**: A repeated pattern is that an issue is fixed in the
card, a new build is released and users will incorrectly believe it's
not yet fixed due to their browser caching the old code. This results in
wasting their time, and my time.

**But it's obnoxious!**: I'm pretty sensitive to this (hence adding
these messages!), so let me know how terrible you find it. You can
disable it with:

```yaml
performance:
  features:
    card_loading_indicator: false
```
2025-01-12 16:26:30 -08:00

4.6 KiB

performance

Configure the card performance settings to enable the card to run (more) smoothly on lower end devices.

performance:
  # [...]
Option Default Description
features Configure feature settings that impact performance.
style Configure style settings that impact performance.

features

Controls card-wide functionality that may impact performance.

performance:
  features:
    # [...]
Option Default Description
animated_progress_indicator true Will show the animated progress indicator 'spinners' when true.
card_loading_indicator true Will show the card loading indicator (spinner & version number) when true.
media_chunk_size 50 How many media items to fetch and render at a time (e.g. thumbnails under a live view, or number of snapshots to load in the media viewer). This may only make partial sense in some contexts (e.g. the 'infinite gallery' is still infinite, it just loads thumbnails this many items at a time) or not at all (e.g. the timeline will show the number of events dictated by the time span the user navigates to).
max_simultaneous_engine_requests Infinity How many camera engine requests to allow occur in parallel. Setting lower values will slow the card down since more requests will run in sequence, but it will increase the chances of positive cache hit rates and reduce the chances of overwhelming the backend.

style

Style performance options request the card minimize certain expensive CSS stylings. This does not necessarily disable these stylings entirely since that may break the basic expected visuals of the card (e.g. menu icons need curves), but rather avoids use of them in high item-count situations (e.g. avoiding shadows on timeline items, or curves in the media gallery items).

performance:
  style:
    # [...]
Option Default Description
border_radius true If false minimizes the usage of rounded corners.
box_shadow true If false minimizes the usage of shadows.

The low-performance profile

For low end devices, the low-performance profile will adjust card defaults to attempt to improve performance. See the profiles configuration option for details on how to select profiles.

Fully expanded reference

performance:
  features:
    animated_progress_indicator: true
    card_loading_indicator: true
    media_chunk_size: 50
    max_simultaneous_engine_requests: 100
  style:
    border_radius: true
    box_shadow: true