Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(deps): update dependency blakeblackshear/frigate to v0.15.0 #518

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Aug 8, 2024

This PR contains the following updates:

Package Update Change
blakeblackshear/frigate minor 0.13.2 -> 0.15.0

Warning

Some dependencies could not be looked up. Check the Dependency Dashboard for more information.


Release Notes

blakeblackshear/frigate (blakeblackshear/frigate)

v0.15.0: 0.15.0 Release

Compare Source

Images

Changes since RC2

  • None

Major Changes for 0.15.0

Breaking Changes

There are several breaking changes in this release, Frigate will attempt to update the configuration automatically. In some cases manual changes may be required. It is always recommended to back up your current config and database before upgrading:

  1. Simply copy your current config file to a new location
  2. Stop Frigate and make a copy of the frigate.db file
  • Rewritten SHM system
    • The SHM system has been rewritten to be more stable. This means that a large % of shared memory (SHM) will be used by default but the total usage will not fluctuate, and Frigate will not fail from SHM overflowing. However, this also means that having the correct SHM size for your cameras, detector, and hardware is more important to having a smooth experience with Frigate. A new calculation is done on startup, so if your shm_size is too low then a warning will be printed in the log stating that it needs to be increased.
  • Recording configuration changed
    • The record config has been refactored to allow for direct control of how long alerts and detections are retained. These values will be automatically populated from your current config, but you may want to adjust the values that are set after updating. See the updated docs here and ensure your updated config retains the footage you want it to.
  • ffmpeg updates
    • ffmpeg has been updated to version 7. Some Intel users may need to change what hwaccel preset they are using (preset-vaapi may need to now be preset-intel-qsv-h264 or preset-intel-qsv-h265) if camera feeds are not functioning correctly after upgrading. This may need to be adjusted on a per-camera basis. If a qsv preset is not working properly, you may still need to use a preset-vaapi or revert to the previous ffmpeg version as described below.
    • The new version provides many improvements, but the old version can still be run if needed by specifying path: "5.0" in your ffmpeg: config entry. For example:
      ffmpeg:
      path: "5.0"
    • ffmpeg presets have been updated. It is always recommended to use ffmpeg presets rather than manual arguments.
    • ffmpeg is no longer part of $PATH. In most cases this is handled automatically.
      • go2rtc exec streams will need to add the full path for ffmpeg which in most cases will be /usr/lib/ffmpeg/7.0/bin/ffmpeg.
      • If the go2rtc config has bin: ffmpeg defined, it needs to be removed.
  • The nested model config under a detector has been simplified to just model_path as a string value. This change will be handled automatically through config migration.
  • Submitting to Frigate+
    • The Frigate+ view in the UI has been replaced by the new Explore view. See the notes below.

Explore

The new Explore pane in Frigate 0.15 makes it easy to explore every object tracked by Frigate. It offers a variety of filters and supports keyword and phrase-based text search, searching for similar images, and searching through descriptive text generated by AI models.

The default Explore pane shows a summary of your most recent tracked objects organized by label. Clicking the small arrow icon at the end of the list will bring you to an infinitely scrolling grid view. The grid view can also be set as the default by changing the view type from the Settings button in the top right corner of the pane.

The Explore pane also serves as the new way to submit images to Frigate+. Filters can be applied to only display tracked objects with snapshots that have not been submitted to Frigate+. The left/right arrow keys on the keyboard allow quick navigation between tracked object snapshots when looking at the Tracked Object Details pane from the grid view.

AI/ML Search

Frigate 0.15 introduces two powerful search features: Semantic Search and GenAI Search. Semantic Search can be enabled on its own, while GenAI Search works in addition to Semantic Search.

Semantic Search

Semantic Search uses a CLIP model to generate embeddings (numerical representations of images) for the thumbnails of your tracked objects, enabling searches based on text descriptions or visual similarity. This is all done locally.

For instance, if Frigate detects and tracks a car, you can use similarity search to see other instances where Frigate detected and tracked that same car. You can also quickly search your tracked objects using an "image caption" approach. Searching for "red car driving on a residential street" or "person in a blue shirt walking on the sidewalk at dawn" or even "a person wearing a black t-shirt with the word 'SPORT' on it" will produce some stunning results.

Semantic Search works by running an AI model locally on your system. Small or underpowered systems like a Raspberry Pi will not run Semantic Search reliably or at all. A dedicated GPU and 16GB of RAM is recommended for best performance.

See the Semantic Search docs for system requirements, setup instructions, and usage tips.

Screen Shot 2024-10-15 at 07 38 16 AM

Generative AI

GenAI Search employs generative AI models to create descriptive text for the thumbnails of your tracked objects, which are stored in the Frigate database to enhance future searches. Supported providers include Google Gemini, Ollama, and OpenAI, so you can choose whether you want to send data to the cloud or use a locally hosted provider.

See the GenAI docs for setup instructions and use case suggestions.

Improved Tools for Debugging

Review Item Details Pane

A new Review Item Details pane can be viewed by clicking / tapping on the gray chip on a review item in the Review pane. This shows more information about the review item as well as thumbnails or snapshots for individual objects (if enabled). The pane also provides links to share the review item, download it, submit images to Frigate+, view object lifecycles, and more.

image

Object Lifecycle Pane

The Recordings Timeline from Frigate 0.13 has been improved upon and returns to 0.15 as the Object Lifecycle, viewable in the Review Details pane as well as the new Explore page. The new pane shows the significant moments during the object's lifecycle: when it was first seen, when it entered a zone, became stationary, etc. It also provides information about the object's area and size ratio to assist in configuring Frigate to tune out false positives.

image

Native Notifications

Frigate now supports notifications using the WebPush protocol. This allows Frigate to deliver notifications to devices that have registered to receive notifications in the Frigate settings, delivering them in a timely and secure manner. Currently, notifications will be delivered for all review items marked as alerts. More options for native notifications will be supported in the future.

image

See the notifications docs.

New Object Detectors

ONNX

ONNX is an open model standard which allows for a single model format that can run on different types of GPUs. The default, tensorrt, and rocm Frigate build variants include GPU support for efficient object detection via ONNX models, simplifying configuration and support more models. There are no default included ONNX models for object detection.

AMD MiGraphX

Support has been added for AMD GPUs via ROCm and MiGraphX. Currently there is no default included model for this detector.

Hailo-8

Support has been added for the Hailo8 and Hailo-8L hardware for object detection on both arm64 and amd64 platforms.

Other UI Changes

  • Rework the Storage metrics pane to be more clear how much storage each camera is using
  • Camera stream info button has been added to the camera metrics page allowing easy access to see camera codec information
  • Add button for downloading the full set of logs
  • The timeline handlebar will now automatically scroll while viewing recordings
  • Review items and exports can now be shared via your browser's sharing pane or via direct link url. A secure context is required for the browser/OS sharing pane to function
  • Add the ability to rename camera groups
  • Add middle mouse button support in the Review pane to open full recordings view in a new tab
  • Add Nvidia GPU encode and decode stats to system metrics
  • New desktop keyboard shortcuts. In addition to the numerous keyboard shortcuts available with 0.14, 0.15 adds several more. In Live view, the numeric keys (1-9) will move PTZ cameras to presets. In Review, Page Up and Page Down will scroll through review items
  • Accessibility updates for users with screen readers

Other Backend Changes

  • FFMPEG updated to 7.0
  • OpenVINO updated to 2024.3
  • Use FastAPI instead of Flask for the Frigate API
  • Add service manager infrastructure
  • Install onevpl tools and update drivers for Intel
  • If record is disabled for a camera then that camera will not save frames to the preview during that time
  • Fix stalled connections to certain onvif cameras
  • Fix autotracking absolute zoom interpolation logic
  • TensorRT models are no longer generated by default, the ENV var must be set

Full Changelog: blakeblackshear/frigate@v0.14.1...v0.15.0

v0.14.1: 0.14.1 Release

Compare Source

Images

This is a maintenance release for Frigate 0.14 that includes bugfixes as well as performance and stability improvements.

What's Changed

v0.14.0: 0.14.0 Release

Compare Source

Images

  • ghcr.io/blakeblackshear/frigate:0.14.0
  • ghcr.io/blakeblackshear/frigate:0.14.0-standard-arm64
  • ghcr.io/blakeblackshear/frigate:0.14.0-tensorrt
  • ghcr.io/blakeblackshear/frigate:0.14.0-tensorrt-jp4
  • ghcr.io/blakeblackshear/frigate:0.14.0-tensorrt-jp5
  • ghcr.io/blakeblackshear/frigate:0.14.0-rk

Changes since RC2

  • None

Major Changes for 0.14.0

Breaking Changes

There are several breaking changes in this release, Frigate will attempt to update the configuration automatically. In some cases manual changes may be required. It is always recommended to backup your current config and database before upgrading:

  • Simply copy your current config file to a new location
  • Stop Frigate and make a copy of the frigate.db file

Your existing events will not be visible in Frigate's new UI

  • An entirely new way of reviewing camera footage has been implemented in Frigate 0.14, and existing events could not be migrated
  • Recordings can still be viewed in the new UI using the recordings viewer (From Live view, click/tap on a camera and select the History button at the top left)
  • You may want to export any starred/favorite events before upgrading
  • If you are using the Home Assistant integration, events can still be viewed there
  • Recording (enabled: True for record in your config) is required to see review items and motion data in the UI

Zone/mask coordinates are now stored in the config as relative values

  • Frigate's configuration migrator will read your existing mask/zone coordinates and convert them for relative use internally on startup
  • Using the built-in mask/zone editor will make your config file incompatible with prior versions of Frigate
  • If you have mask/zone coordinate values that exceed the detect resolution, it will be ignored and you will see warnings in the log. Delete the mask or zone from your config and then use the editor in the UI to recreate it.

The UI's live mode is now intelligently selected

  • The live_mode config option is now deprecated and should be removed.

Backwards incompatible database changes

  • There are a number of changes made to Frigate's database, which are not backwards compatible. A backup of the database is automatically made on startup, but a manual backup is highly recommended.

Other breaking changes

  • RTMP was deprecated in 0.13 and has been fully removed in 0.14. You will need to remove any rtmp references in your config file.
  • OpenVINO has been upgraded, and Intel Neural Compute sticks are no longer supported. Support for YOLO-NAS models has been added. Additionally, AUTO mode now maps to GPU internally to avoid some unresolved issues with AUTO. The existing YOLO-X model will not work in this version.

Brand New UI

Frigate 0.14's UI has been completely rewritten (helpful walkthrough video from a user) and optimized for desktop and mobile devices, aiming to simplify the user experience by focusing on two specific goals:

  1. Allow you to quickly see what's currently happening or what just happened on your cameras. The new Live view features a real-time dashboard with live camera feeds and a filmstrip of animated thumbnails showing recent activity.
  2. Make reviewing video footage more efficient. Frigate intelligently identifies parts of your timeline for review by leveraging the underlying data about motion and tracked objects. The new Review area implements a scrollable grid of thumbnails alongside a timeline where a hover or swipe begins a preview playback. Review items can be configured to be pre-categorized into alerts or detections based on cameras and/or zones. The review area also provides a motion review mode, allowing real-time scrubbing of video footage for any objects of interest that Frigate may have missed.

Frigate 0.14's UI will likely change the way you review your camera footage. It's a big change, but we love it and hope you do too. See the announcement post for more information regarding the motivation, ideas, and design decisions behind the new UI.

Dashboard

The new home page for Frigate is intended to be a real-time dashboard for your cameras. Recent alerts are represented by animated thumbnails in a filmstrip view above your camera feeds. Your camera images update once per minute when no detectable activity is occurring to conserve bandwidth and resources. As soon as any motion is detected, cameras seamlessly switch to a full-resolution live stream.

  • Custom camera groups are now supported. Add any of your cameras (including the Birdseye camera) to user-definable groups and easily toggle between them.
  • On desktops and tablets, cameras in a camera group can be resized and rearranged via dragging.

Screen Shot 2024-05-18 at 18 00 22 PM

Live View

Clicking a camera from the dashboard will bring up a full-resolution live view where you can quickly access historical footage, use PTZ controls, toggle camera audio, use two-way talk, and more. Zooming with pinch or a scroll wheel is also supported.

Screen Shot 2024-05-18 at 18 02 30 PM

Review

The Review area of Frigate 0.14 is for quickly reviewing historical footage of interest from your cameras. Review items are indicated on a vertical timeline and displayed as a grid of previews - bandwidth-optimized, low frame rate, low resolution videos. Hovering over or swiping a preview plays the video and marks it as reviewed. If more in-depth analysis is required, the preview can be clicked/tapped and the full frame rate, full resolution recording is displayed. Review items are filterable by date, object type, and camera.

Screen Shot 2024-05-18 at 18 01 12 PM

Alerts and Detections

Not every segment of video captured by Frigate may be of the same level of interest to you. Video of people who enter your property are a different priority than those walking by on the sidewalk. For this reason, Frigate 0.14 categorizes review items as alerts or detections. By default, all person and car objects are considered alerts. You can refine categorization of your review items by configuring required zones for them.

See the review docs for more information

Motion review

In Frigate 0.13, there isn’t a way to see motion activity on a timeline and watch video at that time. The ability to scrub video for things Frigate missed has been one of the most common feature requests. Within the Motion tab of the Review section, you can now scrub through the timeline for all cameras simultaneously with a timeline showing relative motion activity. In order to avoid scrubbing over time periods already included in alerts and detections, you can also scrub in motion only mode.

image

History

In Frigate 0.14, full frame rate, full resolution camera footage (called "recordings" in earlier versions) can be viewed and scrubbed via a timeline. Previews of your other cameras are displayed and scrubbed alongside the main selected camera.

  • Exporting footage from the History view has been drastically improved. Choose predefined time periods, enter a time directly, or drag handles on the timeline to select an export range.
  • Past exports can be viewed, renamed, deleted, and downloaded from the dedicated Export pane, accessible from the navigation bar.
Other Notable UI Changes
  • System stats - New charts and graphs with colored segments to track system usage history and more quickly identify problems or issues.
  • Status bar - A new status bar gives at-a-glance CPU/GPU usage as well as any problems or issues with Frigate.
  • New log viewer - The log viewer now provides a pane with links to solutions for common issues.
  • Real-time motion tuning - Tune motion detection settings for your cameras without editing your config file and restarting.
  • New mask and zone editor - Edit your masks and zones with a much-improved editor.

Authentication

Frigate now supports authentication. Frigate manages users and authentication using JWT tokens via a cookie or authorization header. Additionally, a new proxy section in the config allows you to use the user header passed from common authentication proxies such as authelia, authentik, oauth2_proxy, etc.

  • Authentication is enforced on a new port 8971, and port 5000 is still unauthenticated for backwards compatibility. If you want to use Frigate's authentication, update your reverse proxy to point at port 8971 instead of 5000.
  • Support for role based authorization (admin/user roles) will come in a future release and will support upstream authentication proxies.
  • The Home Assistant integration needs to be pointed at port 5000. Some recommended configuration examples are in the updated docs.

See the documentation for more information.

TLS

Since Authentication should really be used over secure connections, TLS is also enabled by default for port 8971. It can be disabled in the config file with the following yaml:

tls:
  enabled: False

Custom certificates can also be used following the tls docs.

Frigate+

Frigate 0.14 now offers a dedicated page for Frigate+ submissions, allowing more specific filtering by score and a faster workflow. Support has also been added to upload frames directly from the History view.

Other notable improvements

  • Loitering Time - Zones now support a loitering_time configuration which can be used to only consider an object as part of a zone if they loiter for the specified number of seconds. This can be used, for example, to create alerts for cars that stop on the street but not cars that just drive past your camera.
  • Two-way talk - For supported cameras, two-way talk can be used directly from a camera's live view.
  • PWA-optimized - The UI has been optimized to work as a progressive web app. Pin Frigate to your iOS home screen or install on Android for a full app-like experience.
  • Rockchip boards now support object detection - See the Rockchip documentation for more information.
  • Automatic hardware acceleration - automatic detection and configuration of hardware acceleration for ffmpeg is attempted on startup
  • New review related MQTT topics and API endpoints - New MQTT topics and api endpoints are available for reviews. These will likely be a better topic for notifications.

Fixes and changes

  • Better ONVIF support - PTZ controls will now show for more ONVIF PTZ cameras
  • Use ZMQ for interprocess communication
  • hwaccel_args are now automatically detected for Nvidia, AMD, and Intel based systems.
  • Stationary object detection has been improved especially for parked cars.
  • Additional support for IPV6
  • RTMP has been removed (after previous deprecation). This is handled by the automatic config migration upon upgrade.

FAQ

Have a question that's not answered here? Look at the most updated list of FAQs here or open a discussion on Github.

Upgrade issues

I'm seeing "add mask expects relative coordinates only" in my logs.
This is usually caused by a mask or zone having coordinates larger than the camera's detect resolution. The easiest fix would be to remove the mask/zone, restart Frigate, and use the new mask/zone editor to recreate it.

What happened to all my events?
An entirely new way of reviewing camera footage has been implemented in Frigate 0.14, so any "events" from any previous versions of Frigate will not be migrated and will not be visible in the new UI. This includes any favorited/starred events. Recordings can still be viewed in the new UI using the recordings viewer (From Live view, click/tap on a camera and select the History button at the top left).

I'm seeing "Preview Not Found" in the UI a lot. Why?
Frigate 0.14 now generates "previews": bandwidth-optimized, low frame rate, low resolution videos for your camera footage. These previews are not generated for any footage from older versions of Frigate. Historical full recordings are still viewable from your cameras, however. From Live view, click/tap on a camera and select the History button at the top left.

Usage

Are there any tutorials or videos on how to use the new version?
Yes, see the guided demo and a helpful walkthrough video from a user.

Can I make the cameras take up more space on my dashboard?
Yes you can, on desktop screens only. Create a camera group, and then use the edit layout button (bottom right) to resize/reposition your cameras on the dashboard.

Where is Birdseye view in the new UI?
Birdseye is accessible by creating a camera group and adding the Birdseye camera to the camera group. Birdseye is also accessible by navigating directly to frigate_ip:port/#birdseye.

Why are there black bars and empty space around my cameras in the new Live dashboard?
Cameras are kept in a standard 16x9 aspect ratio grid layout. If your camera's aspect ratio is not 16x9 (or a multiple of 16x9 like a wide angle 32x9), black bars may appear on any of the sides of the camera image. One solution would be to adjust your camera's resolution in firmware to fit any multiple of the 16x9 aspect ratio. You could also use Birdseye, which is Frigate's solution for an automatic live view layout without black bars. See the Birdseye docs for ways to configure Birdseye's resolution, aspect ratio, and layout preferences.

It doesn't seem like my cameras are streaming on the Live dashboard. Why?
On the Live dashboard, your camera images will update once per minute when no detectable activity is occurring to conserve bandwidth and resources. As soon as any motion is detected, cameras seamlessly switch to a full-resolution live stream.

Can I export footage from the review screen?
Yes, right click (desktop) or long press (mobile) to choose item(s) you want to export, then press the export button in the header.

What happened to the timelapse export feature?
It's not in the UI, but the API is still available. Most users were using that feature to create videos to manually review each day. One of the main focuses of the new UI was to ensure that isn't necessary. The only remaining use cases we are aware of are for very long periods of time. Having frigate do long exports on high resolution recordings on the server is a really inefficient way to accomplish that.

How can I view snapshots with bounding boxes?
Snapshots have been deprecated in favor of the new review item format. To understand why, consider the situation where two people, one with a dog, walked past your house. At the same time, a car drove by on the street behind them. In this scenario, Frigate would have tracked 4 "events". One for each person, the dog, and the car. In 0.13, you would have had 4 separate videos to watch, even though they would have all overlapped. In 0.14, these separate objects are combined into a single review item which represents the period in time where these objects were active on the camera. Reviews for a single camera cannot overlap. Displaying separate snapshots for this scenario in a way that shows they are connected is not only difficult, but also less helpful than having a combined thumbnail and easy to view video preview that quickly shows what exactly happened. Even though snapshots are no longer available in the 0.14 UI review pipeline, they are still available in the Frigate+ view, on the filesystem, and viewable through Home Assistant's media browser. A screen to help debug review items and answer the question "why was this review item created?" will be coming in a future version (feature request is here).

How can I tune what I see in alerts and detections?
You can restrict alerts and detections to specific objects/labels or exclude a camera entirely. See the review docs. You can also restrict alerts and detections to objects entering zones. The Camera Settings screen in the UI provides a lot of granular control. See the zone docs.

How can I switch the live view type?
In Frigate 0.13, a dropdown menu in the UI allowed users to select between jsmpeg, MSE, or WebRTC. In 0.14, Frigate intelligently selects the best type of live view method for the cameras on your dashboard based on network conditions and features, so this is no longer user selectable.

Can I "star" or "favorite" events like in 0.13?
No, that feature has been removed in 0.14 in favor of Exports. If you have footage you'd like to "favorite" or retain in 0.14, use the export tools. Unlike favorite events in 0.13, exported footage in 0.14 can be given a label/name and is searchable from the Exports page.

Are there any keyboard shortcuts in the UI for desktop devices?
Yes. In the Review pane, Ctrl/Cmd-A selects all of your review items. On Live camera view, you can use the arrow keys along with + and - to control a PTZ camera. In the Logs view, page up/page down and arrow up/arrow down will scroll the logs. Wherever video controls appear (History view, Motion Review), the left and right arrows will seek the video backwards and forwards by 10 seconds. The up and down arrow keys will seek the video by 1 second. The "f" key toggles fullscreen, "m" toggles muting, and the space bar toggles playback/pause.

Have a question that's not answered here? Open a discussion on Github.

Full Changelog: blakeblackshear/frigate@v0.13.2...v0.14.0


Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot force-pushed the renovate/blakeblackshear-frigate-0.x branch from 75ca250 to 52dcc74 Compare August 30, 2024 00:04
@renovate renovate bot changed the title chore(deps): update dependency blakeblackshear/frigate to v0.14.0 chore(deps): update dependency blakeblackshear/frigate to v0.14.1 Aug 30, 2024
@renovate renovate bot force-pushed the renovate/blakeblackshear-frigate-0.x branch from 52dcc74 to e3edba8 Compare January 5, 2025 23:05
@renovate renovate bot force-pushed the renovate/blakeblackshear-frigate-0.x branch from e3edba8 to 64ccfc4 Compare February 8, 2025 21:14
@renovate renovate bot changed the title chore(deps): update dependency blakeblackshear/frigate to v0.14.1 chore(deps): update dependency blakeblackshear/frigate to v0.15.0 Feb 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants