administrator/frigate
1
0
Fork 0
mirror of https://github.com/blakeblackshear/frigate.git synced 2025-12-06 13:34:13 +03:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
32781af2a5
frigate/docs
History
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
..
docs Add optional idle heartbeat for Birdseye (#20453) 2025-10-19 05:20:36 -06:00
plugins docs: include available objects in documentation 2021-03-09 06:23:37 -06:00
src Add chinese docs (#17954) 2025-05-06 08:49:49 -06:00
static Change clean snapshots from png to webp format (#20484) 2025-10-14 07:08:41 -06:00
.gitignore docs: move docs to docusaurus 2021-01-26 21:40:33 -06:00
babel.config.js docs: move docs to docusaurus 2021-01-26 21:40:33 -06:00
docusaurus.config.ts Merge remote-tracking branch 'origin/master' into dev 2025-06-27 06:53:02 -05:00
package-lock.json Deps updates (#20133) 2025-09-19 06:02:02 -05:00
package.json Merge remote-tracking branch 'origin/master' into dev 2025-06-27 06:53:02 -05:00
README.md Use Swagger documentation for Frigate HTTP API (#14178) 2024-10-07 14:27:35 -06:00
sidebars.ts Add docs for HomeKit (#20435) 2025-10-11 16:29:24 -05:00

README.md

Website

This website is built using Docusaurus 3.5, a modern static website generator.

For installation and contributing instructions, please follow the Contributing Docs.

Development

  1. Run npm i to install dependencies
  2. Run npm run start to start the website