NVR with realtime local object detection for IP cameras
Go to file
Rui Alves 757150dec1
Use Swagger documentation for Frigate HTTP API (#14178)
* Updated documentation

* docusaurus.config and sidebars converted to Typescript to allow for typings

* Added type for sidebars.ts

* Replaced integrations/api.md with automatically generated openAPI specification. Make sidebar collapsible to increase readability

* Fix HTTP API links in the documentation

* Added rust as language in the openapi sidebar

* Make sure configuration/pwa is present

* Fix API slug

* Fix links

* Revert sidebarCollapsible configuration

* Make HTTP API sidebar collapsed by default. Added CSS for OpenAPI methods

* Proper localhost server path

* Proper localhost server path

* No introduction page

* Lint
2024-10-07 14:27:35 -06:00
.cspell Work through most of the cspell warnings in python (#13794) 2024-09-17 10:41:46 -05:00
.devcontainer Removed usage of PyYAML for config parsing. (#13883) 2024-09-22 10:56:57 -05:00
.github Bump docker/login-action from 3.2.0 to 3.3.0 (#12555) 2024-10-01 06:03:55 -06:00
.vscode Fix vscode launch configuration (#13795) 2024-09-17 10:42:10 -05:00
config
docker Include lsof in container (#14145) 2024-10-03 17:23:37 -05:00
docs Use Swagger documentation for Frigate HTTP API (#14178) 2024-10-07 14:27:35 -06:00
frigate Bug Fixes (#14193) 2024-10-07 07:18:09 -06:00
migrations Implement support for notifications (#12523) 2024-08-29 20:19:50 -06:00
notebooks
web Explicitly set video tag dimensions to fit inside dialog (#14184) 2024-10-07 07:19:22 -06:00
.dockerignore
.gitignore Removed usage of PyYAML for config parsing. (#13883) 2024-09-22 10:56:57 -05:00
.pylintrc
audio-labelmap.txt
benchmark_motion.py
benchmark.py Custom classes for Process and Metrics (#13950) 2024-09-27 07:53:23 -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
labelmap.txt
LICENSE
Makefile Formatting improvements (#13765) 2024-09-17 07:39:44 -05:00
netlify.toml
package-lock.json Implement support for notifications (#12523) 2024-08-29 20:19:50 -06:00
process_clip.py Removed usage of PyYAML for config parsing. (#13883) 2024-09-22 10:56:57 -05:00
pyproject.toml
README.md

logo

Frigate - NVR With Realtime Object Detection for IP Cameras

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 Google Coral Accelerator is optional, but highly recommended. The Coral will outperform even the best CPUs and can process 100+ FPS 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