diff --git a/docs/docs/configuration/birdseye.md b/docs/docs/configuration/birdseye.md index 6471bf4e3..8edf50583 100644 --- a/docs/docs/configuration/birdseye.md +++ b/docs/docs/configuration/birdseye.md @@ -1,6 +1,8 @@ # Birdseye -Birdseye allows a heads-up view of your cameras to see what is going on around your property / space without having to watch all cameras that may have nothing happening. Birdseye allows specific modes that intelligently show and disappear based on what you care about. +Birdseye allows a heads-up view of your cameras to see what is going on around your property / space without having to watch all cameras that may have nothing happening. Birdseye allows specific modes that intelligently show and disappear based on what you care about. + +## Birdseye Behavior ### Birdseye Modes @@ -34,6 +36,29 @@ cameras: enabled: False ``` +### Birdseye Inactivity + +By default birdseye shows all cameras that have had the configured activity in the last 30 seconds, this can be configured: + +```yaml +birdseye: + enabled: True + inactivity_threshold: 15 +``` + +## Birdseye Layout + +### Birdseye Dimensions + +The resolution and aspect ratio of birdseye can be configured. Resolution will increase the quality but does not affect the layout. Changing the aspect ratio of birdseye does affect how cameras are laid out. + +```yaml +birdseye: + enabled: True + width: 1280 + height: 720 +``` + ### Sorting cameras in the Birdseye view It is possible to override the order of cameras that are being shown in the Birdseye view. @@ -55,3 +80,27 @@ cameras: ``` *Note*: Cameras are sorted by default using their name to ensure a constant view inside Birdseye. + +### Birdseye Cameras + +It is possible to limit the number of cameras shown on birdseye at one time. When this is enabled, birdseye will show the cameras with most recent activity. There is a cooldown to ensure that cameras do not switch too frequently. + +For example, this can be configured to only show the most recently active camera. + +```yaml +birdseye: + enabled: True + layout: + max_cameras: 1 +``` + +### Birdseye Scaling + +By default birdseye tries to fit 2 cameras in each row and then double in size until a suitable layout is found. The scaling can be configured with a value between 1.0 and 5.0 depending on use case. + +```yaml +birdseye: + enabled: True + layout: + scaling_factor: 3.0 +``` diff --git a/docs/docs/configuration/reference.md b/docs/docs/configuration/reference.md index d500060a7..816bfd456 100644 --- a/docs/docs/configuration/reference.md +++ b/docs/docs/configuration/reference.md @@ -145,6 +145,14 @@ birdseye: # motion - cameras are included if motion was detected in the last 30 seconds # continuous - all cameras are included always mode: objects + # Optional: Threshold for camera activity to stop showing camera (default: shown below) + inactivity_threshold: 30 + # Optional: Configure the birdseye layout + layout: + # Optional: Scaling factor for the layout calculator (default: shown below) + scaling_factor: 2.0 + # Optional: Maximum number of cameras to show at one time, showing the most recent (default: show all cameras) + max_cameras: 1 # Optional: ffmpeg configuration # More information about presets at https://docs.frigate.video/configuration/ffmpeg_presets diff --git a/frigate/config.py b/frigate/config.py index 22718fb1f..2e8b25700 100644 --- a/frigate/config.py +++ b/frigate/config.py @@ -530,7 +530,7 @@ class BirdseyeModeEnum(str, Enum): class BirdseyeLayoutConfig(FrigateBaseModel): scaling_factor: float = Field( - default=2.0, title="Birdseye Scaling Factor", gt=1.0, le=5.0 + default=2.0, title="Birdseye Scaling Factor", ge=1.0, le=5.0 ) max_cameras: Optional[int] = Field(default=None, title="Max cameras")