NVR with realtime local object detection for IP cameras
Go to file
Francesco Durighetto 4c689dde8e
Add optional idle heartbeat for Birdseye (#20453)
* Add optional idle heartbeat for Birdseye (periodic frame emission when idle)

birdseye: add optional idle heartbeat and FFmpeg tuning envs (default off)

This adds an optional configuration field `birdseye.idle_heartbeat_fps` to
enable a lightweight idle heartbeat mechanism in Birdseye. When set to a value
greater than 0, Birdseye periodically re-sends the last composed frame during
idle periods (no motion or active updates).

This helps downstream consumers such as go2rtc, Alexa, or Scrypted to attach
faster and maintain a low-latency RTSP stream when the system is idle.

Key details:
- Config-based (`birdseye.idle_heartbeat_fps`), default `0` (disabled).
- Uses existing Birdseye rendering pipeline; minimal performance impact.
- Does not alter behavior when unset.

Documentation: added tip section in docs/configuration/restream.md.

* Update docs/docs/configuration/restream.md

Co-authored-by: Nicolas Mowen <nickmowen213@gmail.com>

* Update docs/docs/configuration/reference.md

Co-authored-by: Nicolas Mowen <nickmowen213@gmail.com>

* Refactors Birdseye idle frame broadcasting

Simplifies the idle frame broadcasting logic by removing the dedicated thread.

The idle frame is now resent directly within the main loop,
improving efficiency and reducing complexity.  Also, limits the idle
heartbeat FPS to a maximum of 10 since the framebuffer is limited to 10 anyway

* ruff fix

---------

Co-authored-by: Nicolas Mowen <nickmowen213@gmail.com>
Co-authored-by: Francesco Durighetto <francesco.durighetto@subbyx.com>
Co-authored-by: duri <duri@homelabubuntu.durihome.unifi>
2025-10-19 05:20:36 -06:00
.cspell Fixes (#18304) 2025-05-19 14:43:22 -06:00
.devcontainer Initial implementation of D-FINE model via ONNX (#16772) 2025-02-24 08:56:01 -07:00
.github [Init] Initial commit for Synaptics SL1680 NPU (#19680) 2025-09-26 07:07:12 -05:00
.vscode Fix vscode launch configuration (#13795) 2024-09-17 10:42:10 -05:00
config Improve the devcontainer experience (#3492) 2022-11-20 07:34:12 -06:00
docker Add support for Intel NPU (#20536) 2025-10-17 05:58:59 -05:00
docs Add optional idle heartbeat for Birdseye (#20453) 2025-10-19 05:20:36 -06:00
frigate Add optional idle heartbeat for Birdseye (#20453) 2025-10-19 05:20:36 -06:00
migrations Semantic Search Triggers (#18969) 2025-08-16 10:20:33 -05:00
notebooks Update YOLO_NAS_Pretrained_Export.ipynb (#19669) 2025-08-20 14:59:43 -05:00
web Detail Stream tweaks (#20553) 2025-10-18 12:19:21 -06:00
.dockerignore Improve the devcontainer experience (#3492) 2022-11-20 07:34:12 -06:00
.gitignore Removed usage of PyYAML for config parsing. (#13883) 2024-09-22 10:56:57 -05:00
.pylintrc use fstr log style 2021-02-25 07:01:59 -06:00
audio-labelmap.txt Audio events (#6848) 2023-07-01 08:18:33 -05:00
benchmark_motion.py use a different method for blur and contrast to reduce CPU (#6940) 2023-06-30 07:27:31 -05:00
benchmark.py Fix go2rtc init (#18708) 2025-08-16 10:20:33 -05:00
CODEOWNERS Initial support for Hailo-8L (#12431) 2024-08-29 20:19:50 -06:00
cspell.json Work through most of the cspell warnings in python (#13794) 2024-09-17 10:41:46 -05:00
docker-compose.yml Devcontainer: update Mosquitto from 1.6 to 2.0 (#17415) 2025-03-27 10:33:49 -06:00
generate_config_translations.py Add script to generate english config translation file from config (#20301) 2025-10-01 07:39:43 -05:00
labelmap.txt Cleanup Detector labelmap (#4932) 2023-01-06 07:03:16 -06:00
LICENSE switch to MIT license 2020-07-26 12:07:47 -05:00
Makefile Fixes (#19984) 2025-09-09 06:17:56 -06:00
netlify.toml Docs improvements (#8641) 2023-11-18 08:04:43 -06:00
package-lock.json Implement support for notifications (#12523) 2024-08-29 20:19:50 -06:00
process_clip.py Improve async object detector support (#17712) 2025-04-15 08:55:38 -05:00
pyproject.toml Fix various typing issues (#18187) 2025-05-13 08:27:20 -06:00
README_CN.md Add Chinese community sponsors (#18945) 2025-07-04 14:32:48 -05:00
README.md Small Tweaks (#17652) 2025-04-11 08:21:01 -06:00

logo

Frigate - NVR With Realtime Object Detection for IP Cameras

Translation status
English

A complete and local NVR designed for Home Assistant with AI object detection. Uses OpenCV and Tensorflow to perform realtime object detection locally for IP cameras.

Use of a GPU or AI accelerator such as a Google Coral or Hailo is highly recommended. AI accelerators will outperform even the best CPUs with very little overhead.

  • Tight integration with Home Assistant via a custom component
  • Designed to minimize resource use and maximize performance by only looking for objects when and where it is necessary
  • Leverages multiprocessing heavily with an emphasis on realtime over processing every frame
  • Uses a very low overhead motion detection to determine where to run object detection
  • Object detection with TensorFlow runs in separate processes for maximum FPS
  • Communicates over MQTT for easy integration into other systems
  • Records video with retention settings based on detected objects
  • 24/7 recording
  • Re-streaming via RTSP to reduce the number of connections to your camera
  • WebRTC & MSE support for low-latency live view

Documentation

View the documentation at https://docs.frigate.video

Donations

If you would like to make a donation to support development, please use Github Sponsors.

Screenshots

Live dashboard

Live dashboard

Streamlined review workflow

Streamlined review workflow

Multi-camera scrubbing

Multi-camera scrubbing

Built-in mask and zone editor

Multi-camera scrubbing

Translations

We use Weblate to support language translations. Contributions are always welcome.

Translation status