Skip to content

v3.0.0 to v4.0.0 configuration upgrade instructions

Jump to bottom
Dermot Duffy edited this page Jun 15, 2022 · 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) 
event_viewer:
  # Anything
 
media_viewer:
  # Anything

All sizes are numeric, pixels are the only supported unit and acceptable ranges are enforced.

live:
  controls:
    thumbnails:
      size: 100px
    next_previous:
      size: 100px
event_viewer:
  controls:
    thumbnails:
      size: 100px
    next_previous:
      size: 100px
menu:
  button_size: 100px
 
live:
  controls:
    thumbnails:
      size: 100
    next_previous:
      size: 100
media_viewer:
  controls:
    thumbnails:
      size: 100
    next_previous:
      size: 100
menu:
  button_size: 100

Removal of the min_columns variable.

event_gallery:
  min_columns: 4

Instead set thumbnail pixel size to dictate column count.

event_gallery:
  controls:
    thumbnails:
      size: 75

Menu modes are decomposed into style and position:

menu:
  mode: hover-top  # Any former menu mode.
 
menu:
  style: hover   # {hover, hidden, overlay, none, outside}
  position: top  # {above, below, left, right, top, bottom}
 
menu:
  buttons:
    cameras: true  # Any button
 
menu:
  buttons:
    cameras:
      enabled: true
 
live:
  lazy_unload: true
  auto_unmute: true
event_viewer:
  auto_play: true
  auto_unmute: true
 
live:
  lazy_unload: 'all'
  auto_unmute: 'all'
media_viewer:
  auto_play: 'all'
  auto_unmute: 'all'
 
cameras:
  - camera_name: foo
    client_id: bar
    zone: baz
    label: person
    frigate_url: http://my-frigate-instance
 
cameras:
  - frigate:
      camera_name: foo
      client_id: bar
      zone: baz
      label: person
      url: http://my-frigate-instance  # Note key change.
Clone this wiki locally