blakeblackshear.frigate/README.md

<p align="center">
  <img align="center" alt="logo" src="docs/static/img/frigate.png">
</p>

# Frigate - NVR With Realtime Object Detection for IP Cameras

A complete and local NVR designed for [Home Assistant](https://www.home-assistant.io) with AI object detection. Uses OpenCV and Tensorflow to perform realtime object detection locally for IP cameras.

Use of a [Google Coral Accelerator](https://coral.ai/products/) 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](https://github.com/blakeblackshear/frigate-hass-integration)
- 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](https://github.com/sponsors/blakeblackshear).

## Screenshots

### Live dashboard
<div>
<img width="800" alt="Live dashboard" src="https://github.com/blakeblackshear/frigate/assets/569905/5e713cb9-9db5-41dc-947a-6937c3bc376e">
</div>

### Streamlined review workflow
<div>
<img width="800" alt="Streamlined review workflow" src="https://github.com/blakeblackshear/frigate/assets/569905/6fed96e8-3b18-40e5-9ddc-31e6f3c9f2ff">
</div>

### Multi-camera scrubbing
<div>
<img width="800" alt="Multi-camera scrubbing" src="https://github.com/blakeblackshear/frigate/assets/569905/d6788a15-0eeb-4427-a8d4-80b93cae3d74">
</div>

### Built-in mask and zone editor
<div>
<img width="800" alt="Multi-camera scrubbing" src="https://github.com/blakeblackshear/frigate/assets/569905/d7885fc3-bfe6-452f-b7d0-d957cb3e31f5">
</div>
docs rewrite 2020-10-24 15:23:16 +02:00			`<p align="center">`
docs: move docs to docusaurus 2021-01-21 01:26:49 +01:00			`<img align="center" alt="logo" src="docs/static/img/frigate.png">`
docs rewrite 2020-10-24 15:23:16 +02:00			`</p>`

update readme 2020-09-17 14:26:49 +02:00			`# Frigate - NVR With Realtime Object Detection for IP Cameras`
docs: move docs to docusaurus 2021-01-21 01:26:49 +01:00
Correct spelling Home Assistant 2021-05-01 06:11:47 +02:00			`A complete and local NVR designed for [Home Assistant](https://www.home-assistant.io) with AI object detection. Uses OpenCV and Tensorflow to perform realtime object detection locally for IP cameras.`
update readme 2019-03-03 17:04:27 +01:00
docs rewrite 2020-10-24 15:23:16 +02:00			`Use of a [Google Coral Accelerator](https://coral.ai/products/) is optional, but highly recommended. The Coral will outperform even the best CPUs and can process 100+ FPS with very little overhead.`
update docs and add back benchmark 2020-02-22 15:59:16 +01:00
Correct spelling Home Assistant 2021-05-01 06:11:47 +02:00			`- Tight integration with Home Assistant via a [custom component](https://github.com/blakeblackshear/frigate-hass-integration)`
docs rewrite 2020-10-24 15:23:16 +02:00			`- Designed to minimize resource use and maximize performance by only looking for objects when and where it is necessary`
update docs and add back benchmark 2020-02-22 15:59:16 +01:00			`- 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`
docs rewrite 2020-10-24 15:23:16 +02:00			`- Object detection with TensorFlow runs in separate processes for maximum FPS`
			`- Communicates over MQTT for easy integration into other systems`
clean house on clips 2021-08-15 15:30:27 +02:00			`- Records video with retention settings based on detected objects`
doc updates 2020-12-05 02:06:20 +01:00			`- 24/7 recording`
Clarify docs about rtmp (#5052) * Update readme features * Remove RTMP setup from setup guide * Update integration for RTSP * Remove rtmp from faq * Remove RTMP stream from guide * Remove rtmp from install * Remove rtmp from dev config 2023-01-13 14:20:25 +01:00			`- Re-streaming via RTSP to reduce the number of connections to your camera`
			`- WebRTC & MSE support for low-latency live view`
doc updates 2020-12-05 02:06:20 +01:00
docs rewrite 2020-10-24 15:23:16 +02:00			`## Documentation`

update docs url 2021-09-26 23:43:26 +02:00			`View the documentation at https://docs.frigate.video`
tweaking the docs 2021-01-24 15:27:43 +01:00
clarifying addon docs 2021-01-28 14:45:09 +01:00			`## Donations`
clean house on clips 2021-08-15 15:30:27 +02:00
clarifying addon docs 2021-01-28 14:45:09 +01:00			`If you would like to make a donation to support development, please use [Github Sponsors](https://github.com/sponsors/blakeblackshear).`

tweaking the docs 2021-01-24 15:27:43 +01:00			`## Screenshots`
clean house on clips 2021-08-15 15:30:27 +02:00
update images in readme 2024-06-08 22:37:16 +02:00			`### Live dashboard`
tweaking the docs 2021-01-24 15:27:43 +01:00			`<div>`
update images in readme 2024-06-08 22:37:16 +02:00			`<img width="800" alt="Live dashboard" src="https://github.com/blakeblackshear/frigate/assets/569905/5e713cb9-9db5-41dc-947a-6937c3bc376e">`
tweaking the docs 2021-01-24 15:27:43 +01:00			`</div>`

update images in readme 2024-06-08 22:37:16 +02:00			`### Streamlined review workflow`
			`<div>`
			`<img width="800" alt="Streamlined review workflow" src="https://github.com/blakeblackshear/frigate/assets/569905/6fed96e8-3b18-40e5-9ddc-31e6f3c9f2ff">`
			`</div>`
clean house on clips 2021-08-15 15:30:27 +02:00
update images in readme 2024-06-08 22:37:16 +02:00			`### Multi-camera scrubbing`
tweaking the docs 2021-01-24 15:27:43 +01:00			`<div>`
update images in readme 2024-06-08 22:37:16 +02:00			`<img width="800" alt="Multi-camera scrubbing" src="https://github.com/blakeblackshear/frigate/assets/569905/d6788a15-0eeb-4427-a8d4-80b93cae3d74">`
tweaking the docs 2021-01-24 15:27:43 +01:00			`</div>`

update images in readme 2024-06-08 22:37:16 +02:00			`### Built-in mask and zone editor`
			`<div>`
			`<img width="800" alt="Multi-camera scrubbing" src="https://github.com/blakeblackshear/frigate/assets/569905/d7885fc3-bfe6-452f-b7d0-d957cb3e31f5">`
			`</div>`