Skip to content

v4.0.0 to v5.0.0 configuration upgrade instructions

Jump to bottom
Dermot Duffy edited this page Apr 1, 2023 · 4 revisions

Visual Card Editor Users

Users of the visual card editor should receive a message prompting "An automated card configuration upgrade is available, please visit the visual card editor". Opening the card editor, clicking "Upgrade" and "Save" should convert the card for the vast majority of users.

Using the visual editor will save you time -- the upgrade is automated for you!

Manual / YAML Users

Before (Shows all impacted values) After (Please only include values as needed)

Any use of conditions in the card needs to use a renamed mediaLoaded parameter:

overrides:
  - conditions:
      mediaLoaded: true
    overrides:
      # Anything
 
overrides:
  - conditions:
      media_loaded: true
    overrides:
      # Anything

event_gallery has been renamed to media_gallery (since it now shows more than events):

event_gallery:
 
media_gallery:

Menu button frigate_ui is renamed to camera_ui:

menu:
  buttons:
    frigate_ui:
 
menu:
  buttons:
    camera_ui:

The frigate-jsmpeg live provider has been renamed to just jsmpeg:

cameras:
  - live_provider: frigate-jsmpeg
 
cameras:
  - live_provider: jsmpeg

Global live settings used to override camera defaults are moved to a new cameras_global section.

live:
  image:
    # Anything
  jsmpeg:
    # Anything
  webrtc_card:
    # Anything
 
cameras_global:
  image:
    # Anything
  jsmpeg:
    # Anything
  webrtc_card:
    # Anything

Camera zone property is renamed to zones, and label property to labels and both are converted to arrays.

cameras:
 - zone: foo
 - label: bar
 
cameras:
 - zones:
    - foo
 - labels:
    - bar
Clone this wiki locally