NVR with realtime local object detection for IP cameras
Go to file
VideoCurio 56a128b776 Add websockets transport mechanism to MQTT
## Proposed change
Add websockets transport mechanism to MQTT.

An MQTT server is not always reachable only as raw TCP on port 1881; it can also be accessed as a WebSocket server, sometimes even behind a reverse proxy with TLS. Paho MQTT supports this feature, as does Mosquitto.

The default transport option was set to 'tcp', so this change will not affect an already configured Frigate app.

The configuration change is validated using a call to a pydantic library field validator.

This patch has been tested with Mosquitto 1.6 and 2.0, as well as with a server behind a reverse proxy on port 443 (requiring a TLS connection).

The docs/configuration/reference.md file has also been updated to reflect this change.

## Type of change

- [ ] Dependency upgrade
- [ ] Bugfix (non-breaking change which fixes an issue)
- [x] New feature
- [ ] Breaking change (fix/feature causing existing functionality to break)
- [ ] Code quality improvements to existing code
- [x] Documentation Update

## Additional information

- This PR fixes or closes issue: fixes #15600
- This PR is related to issue:

## Checklist

- [x] The code change is tested and works locally.
- [ ] Local tests pass. **Your PR cannot be merged unless tests pass**
- [x] There is no commented out code in this PR.
- [x] The code has been formatted using Ruff (`ruff format frigate`)
2024-12-19 17:29:10 +01:00
.cspell Started unit tests for the review controller (#15077) 2024-11-19 16:35:10 -07:00
.devcontainer Fix devcontainer when there is no ~/.ssh/know_hosts file (#14758) 2024-11-03 08:52:27 -07:00
.github apply zizmor recommendations (#15490) 2024-12-13 07:34:09 -06: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 Fix extraction of Hailo userspace libs (#15187) 2024-12-02 08:35:51 -06:00
docs Add websockets transport mechanism to MQTT 2024-12-19 17:29:10 +01:00
frigate Add websockets transport mechanism to MQTT 2024-12-19 17:29:10 +01:00
migrations Optimize Explore summary database query (#14797) 2024-11-04 16:04:49 -07:00
notebooks Adds support for YOLO-NAS in OpenVino (#11645) 2024-06-07 05:52:08 -06:00
web Genai descriptions are not generated until tracked objects end (#15561) 2024-12-17 17:33:04 -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 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 Don't generate tensorrt models by default (#14865) 2024-11-08 07:37:18 -06: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 Formatting improvements (#13765) 2024-09-17 07:39:44 -05: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 Removed usage of PyYAML for config parsing. (#13883) 2024-09-22 10:56:57 -05:00
pyproject.toml Docs improvements (#8641) 2023-11-18 08:04:43 -06:00
README.md update images in readme 2024-06-08 15:37:16 -05:00

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