Files
frigate/frigate/test/test_config.py
T

1678 lines
55 KiB
Python
Raw Normal View History

2023-04-30 14:58:39 -05:00
import json
import os
2021-06-24 01:45:27 -04:00
import unittest
2024-02-29 16:10:13 -07:00
from unittest.mock import patch
2023-05-29 12:31:17 +02:00
2021-06-24 01:45:27 -04:00
import numpy as np
from pydantic import ValidationError
from ruamel.yaml.constructor import DuplicateKeyError
2022-11-08 18:47:45 -07:00
2023-05-29 12:31:17 +02:00
from frigate.config import BirdseyeModeEnum, FrigateConfig
2023-04-30 14:58:39 -05:00
from frigate.const import MODEL_CACHE_DIR
from frigate.detectors import DetectorTypeEnum
2026-05-15 10:06:38 -05:00
from frigate.util.builtin import deep_merge
2020-11-01 06:17:44 -06:00
2021-02-17 07:23:32 -06:00
2021-06-24 01:45:27 -04:00
class TestConfig(unittest.TestCase):
2020-11-03 08:15:58 -06:00
def setUp(self):
self.minimal = {
2021-02-17 07:23:32 -06:00
"mqtt": {"host": "mqtt"},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
2020-11-29 15:55:53 -06:00
]
2020-11-03 08:15:58 -06:00
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2020-11-03 08:15:58 -06:00
}
2021-02-17 07:23:32 -06:00
},
2020-11-03 08:15:58 -06:00
}
2021-02-17 07:23:32 -06:00
2023-04-30 14:58:39 -05:00
self.plus_model_info = {
"id": "e63b7345cc83a84ed79dedfc99c16616",
"name": "SSDLite Mobiledet",
"description": "Fine tuned model",
"trainDate": "2023-04-28T23:22:01.262Z",
"type": "ssd",
2025-05-22 10:38:14 -05:00
"supportedDetectors": ["cpu", "edgetpu"],
2023-04-30 14:58:39 -05:00
"width": 320,
"height": 320,
"inputShape": "nhwc",
"pixelFormat": "rgb",
"labelMap": {
"0": "amazon",
"1": "car",
"2": "cat",
"3": "deer",
"4": "dog",
"5": "face",
"6": "fedex",
"7": "license_plate",
"8": "package",
"9": "person",
"10": "ups",
},
}
if not os.path.exists(MODEL_CACHE_DIR) and not os.path.islink(MODEL_CACHE_DIR):
os.makedirs(MODEL_CACHE_DIR)
2020-11-03 08:15:58 -06:00
def test_config_class(self):
2021-06-24 01:45:27 -04:00
frigate_config = FrigateConfig(**self.minimal)
assert "cpu" in frigate_config.detectors.keys()
assert frigate_config.detectors["cpu"].type == DetectorTypeEnum.cpu
assert frigate_config.detectors["cpu"].model.width == 320
2024-02-29 16:10:13 -07:00
@patch("frigate.detectors.detector_config.load_labels")
def test_detector_custom_model_path(self, mock_labels):
mock_labels.return_value = {}
config = {
"detectors": {
"cpu": {
"type": "cpu",
2025-01-07 20:59:37 -07:00
"model_path": "/cpu_model.tflite",
},
"edgetpu": {
"type": "edgetpu",
2025-01-07 20:59:37 -07:00
"model_path": "/edgetpu_model.tflite",
},
"openvino": {
"type": "openvino",
},
},
2024-05-20 15:37:56 +02:00
# needs to be a file that will exist, doesn't matter what
2023-04-24 07:24:28 -05:00
"model": {"path": "/etc/hosts", "width": 512},
}
frigate_config = FrigateConfig(**(deep_merge(config, self.minimal)))
assert "cpu" in frigate_config.detectors.keys()
assert "edgetpu" in frigate_config.detectors.keys()
assert "openvino" in frigate_config.detectors.keys()
assert frigate_config.detectors["cpu"].type == DetectorTypeEnum.cpu
assert frigate_config.detectors["edgetpu"].type == DetectorTypeEnum.edgetpu
assert frigate_config.detectors["openvino"].type == DetectorTypeEnum.openvino
assert frigate_config.detectors["cpu"].num_threads == 3
assert frigate_config.detectors["edgetpu"].device is None
assert frigate_config.detectors["openvino"].device is None
assert frigate_config.model.path == "/etc/hosts"
assert frigate_config.detectors["cpu"].model.path == "/cpu_model.tflite"
assert frigate_config.detectors["edgetpu"].model.path == "/edgetpu_model.tflite"
assert frigate_config.detectors["openvino"].model.path == "/etc/hosts"
2021-06-24 01:45:27 -04:00
def test_invalid_mqtt_config(self):
config = {
"mqtt": {"host": "mqtt", "user": "test"},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2021-06-24 01:45:27 -04:00
}
},
}
self.assertRaises(ValidationError, lambda: FrigateConfig(**config))
2021-02-17 07:23:32 -06:00
2020-11-03 08:15:58 -06:00
def test_inherit_tracked_objects(self):
config = {
2021-02-17 07:23:32 -06:00
"mqtt": {"host": "mqtt"},
"objects": {"track": ["person", "dog"]},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
2020-11-29 15:55:53 -06:00
]
2020-11-03 08:15:58 -06:00
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2020-11-03 08:15:58 -06:00
}
2021-02-17 07:23:32 -06:00
},
2020-11-03 08:15:58 -06:00
}
2021-06-24 01:45:27 -04:00
frigate_config = FrigateConfig(**config)
assert "dog" in frigate_config.cameras["back"].objects.track
2021-02-17 07:23:32 -06:00
2026-03-04 10:07:34 -06:00
def test_deep_merge_override_replaces_list_values(self):
base = {"objects": {"track": ["person", "face"]}}
update = {"objects": {"track": ["person"]}}
merged = deep_merge(base, update, override=True)
assert merged["objects"]["track"] == ["person"]
def test_deep_merge_merge_lists_still_appends(self):
base = {"track": ["person"]}
update = {"track": ["face"]}
merged = deep_merge(base, update, override=True, merge_lists=True)
assert merged["track"] == ["person", "face"]
def test_override_birdseye(self):
config = {
"mqtt": {"host": "mqtt"},
2022-04-16 08:44:04 -05:00
"birdseye": {"enabled": True, "mode": "continuous"},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2022-04-16 08:44:04 -05:00
"birdseye": {"enabled": False, "mode": "motion"},
}
},
}
frigate_config = FrigateConfig(**config)
assert not frigate_config.cameras["back"].birdseye.enabled
assert frigate_config.cameras["back"].birdseye.mode is BirdseyeModeEnum.motion
2022-04-16 08:44:04 -05:00
def test_override_birdseye_non_inheritable(self):
config = {
"mqtt": {"host": "mqtt"},
2022-04-16 08:44:04 -05:00
"birdseye": {"enabled": True, "mode": "continuous", "height": 1920},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
}
},
}
frigate_config = FrigateConfig(**config)
assert frigate_config.cameras["back"].birdseye.enabled
2022-04-16 08:44:04 -05:00
def test_inherit_birdseye(self):
config = {
"mqtt": {"host": "mqtt"},
"birdseye": {"enabled": True, "mode": "continuous"},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
}
},
}
frigate_config = FrigateConfig(**config)
assert frigate_config.cameras["back"].birdseye.enabled
2022-04-16 08:44:04 -05:00
assert (
frigate_config.cameras["back"].birdseye.mode is BirdseyeModeEnum.continuous
2022-04-16 08:44:04 -05:00
)
2020-11-03 08:15:58 -06:00
def test_override_tracked_objects(self):
config = {
2021-02-17 07:23:32 -06:00
"mqtt": {"host": "mqtt"},
"objects": {"track": ["person", "dog"]},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
2020-11-29 15:55:53 -06:00
]
2020-11-03 08:15:58 -06:00
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2021-02-17 07:23:32 -06:00
"objects": {"track": ["cat"]},
2020-11-01 06:17:44 -06:00
}
2021-02-17 07:23:32 -06:00
},
2020-11-01 06:17:44 -06:00
}
2021-06-24 01:45:27 -04:00
frigate_config = FrigateConfig(**config)
assert "cat" in frigate_config.cameras["back"].objects.track
2021-02-17 07:23:32 -06:00
2020-11-03 08:15:58 -06:00
def test_default_object_filters(self):
config = {
2021-02-17 07:23:32 -06:00
"mqtt": {"host": "mqtt"},
"objects": {"track": ["person", "dog"]},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
2020-11-29 15:55:53 -06:00
]
2020-11-03 08:15:58 -06:00
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2020-11-03 08:15:58 -06:00
}
2021-02-17 07:23:32 -06:00
},
2020-11-03 08:15:58 -06:00
}
2021-06-24 01:45:27 -04:00
frigate_config = FrigateConfig(**config)
assert "dog" in frigate_config.cameras["back"].objects.filters
2021-02-17 07:23:32 -06:00
2026-03-25 14:14:32 -05:00
def test_default_audio_filters(self):
config = {
"mqtt": {"host": "mqtt"},
"audio": {"listen": ["speech", "yell"]},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
}
},
}
frigate_config = FrigateConfig(**config)
2026-05-15 10:06:38 -05:00
assert set(frigate_config.cameras["back"].audio.filters.keys()) == {
"speech",
"yell",
2026-03-25 14:14:32 -05:00
}
def test_override_audio_filters(self):
config = {
"mqtt": {"host": "mqtt"},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
"audio": {
"listen": ["speech", "yell"],
"filters": {"speech": {"threshold": 0.9}},
},
}
},
}
frigate_config = FrigateConfig(**config)
assert "speech" in frigate_config.cameras["back"].audio.filters
assert frigate_config.cameras["back"].audio.filters["speech"].threshold == 0.9
2026-05-15 10:06:38 -05:00
assert "yell" in frigate_config.cameras["back"].audio.filters
assert "babbling" not in frigate_config.cameras["back"].audio.filters
2026-03-25 14:14:32 -05:00
2020-11-03 08:15:58 -06:00
def test_inherit_object_filters(self):
config = {
2021-02-17 07:23:32 -06:00
"mqtt": {"host": "mqtt"},
"objects": {
"track": ["person", "dog"],
"filters": {"dog": {"threshold": 0.7}},
2020-11-03 08:15:58 -06:00
},
2021-02-17 07:23:32 -06:00
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
2020-11-29 15:55:53 -06:00
]
2020-11-03 08:15:58 -06:00
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2020-11-03 08:15:58 -06:00
}
2021-02-17 07:23:32 -06:00
},
2020-11-03 08:15:58 -06:00
}
2021-06-24 01:45:27 -04:00
frigate_config = FrigateConfig(**config)
assert "dog" in frigate_config.cameras["back"].objects.filters
assert frigate_config.cameras["back"].objects.filters["dog"].threshold == 0.7
2021-02-17 07:23:32 -06:00
2020-11-03 08:15:58 -06:00
def test_override_object_filters(self):
config = {
2021-02-17 07:23:32 -06:00
"mqtt": {"host": "mqtt"},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
2020-11-29 15:55:53 -06:00
]
2020-11-03 08:15:58 -06:00
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2021-02-17 07:23:32 -06:00
"objects": {
"track": ["person", "dog"],
"filters": {"dog": {"threshold": 0.7}},
},
2020-11-03 08:15:58 -06:00
}
2021-02-17 07:23:32 -06:00
},
2020-11-03 08:15:58 -06:00
}
2021-06-24 01:45:27 -04:00
frigate_config = FrigateConfig(**config)
assert "dog" in frigate_config.cameras["back"].objects.filters
assert frigate_config.cameras["back"].objects.filters["dog"].threshold == 0.7
2021-02-17 07:23:32 -06:00
2021-02-06 06:30:26 -06:00
def test_global_object_mask(self):
config = {
2021-02-17 07:23:32 -06:00
"mqtt": {"host": "mqtt"},
"objects": {"track": ["person", "dog"]},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
2021-02-06 06:30:26 -06:00
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2021-02-17 07:23:32 -06:00
"objects": {
2026-02-28 08:04:43 -06:00
"mask": {
"global_mask_1": {
"friendly_name": "Global Mask 1",
"enabled": True,
"coordinates": "0,0,1,1,0,1",
}
},
"filters": {
"dog": {
"mask": {
"dog_mask_1": {
"friendly_name": "Dog Mask 1",
"enabled": True,
"coordinates": "1,1,1,1,1,1",
}
}
}
},
2021-02-17 07:23:32 -06:00
},
2021-02-06 06:30:26 -06:00
}
2021-02-17 07:23:32 -06:00
},
2021-02-06 06:30:26 -06:00
}
2021-06-24 01:45:27 -04:00
frigate_config = FrigateConfig(**config)
back_camera = frigate_config.cameras["back"]
2021-06-24 01:45:27 -04:00
assert "dog" in back_camera.objects.filters
2026-02-28 08:04:43 -06:00
# dog filter has its own mask + global mask merged
assert len(back_camera.objects.filters["dog"].mask) == 2
# person filter only has the global mask
assert len(back_camera.objects.filters["person"].mask) == 1
2021-02-17 07:23:32 -06:00
def test_motion_mask_relative_matches_explicit(self):
config = {
"mqtt": {"host": "mqtt"},
"record": {"alerts": {"retain": {"days": 20}}},
"cameras": {
"explicit": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
]
},
"detect": {
"height": 400,
"width": 800,
"fps": 5,
},
"motion": {
2026-02-28 08:04:43 -06:00
"mask": {
"explicit_mask": {
"friendly_name": "Explicit Mask",
"enabled": True,
"coordinates": "0,0,200,100,600,300,800,400",
}
}
},
},
"relative": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
]
},
"detect": {
"height": 400,
"width": 800,
"fps": 5,
},
"motion": {
2026-02-28 08:04:43 -06:00
"mask": {
"relative_mask": {
"friendly_name": "Relative Mask",
"enabled": True,
"coordinates": "0.0,0.0,0.25,0.25,0.75,0.75,1.0,1.0",
}
}
},
},
},
}
frigate_config = FrigateConfig(**config)
assert np.array_equal(
2026-02-28 08:04:43 -06:00
frigate_config.cameras["explicit"].motion.rasterized_mask,
frigate_config.cameras["relative"].motion.rasterized_mask,
)
2021-07-09 20:21:35 -05:00
def test_default_input_args(self):
config = {
"mqtt": {"host": "mqtt"},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2021-07-09 20:21:35 -05:00
}
},
}
frigate_config = FrigateConfig(**config)
assert "-rtsp_transport" in frigate_config.cameras["back"].ffmpeg_cmds[0]["cmd"]
2021-07-09 20:21:35 -05:00
2021-02-05 07:22:33 -06:00
def test_ffmpeg_params_global(self):
2020-11-03 08:15:58 -06:00
config = {
2021-06-24 16:45:15 -04:00
"ffmpeg": {"input_args": "-re"},
2021-02-17 07:23:32 -06:00
"mqtt": {"host": "mqtt"},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
2020-11-29 15:55:53 -06:00
]
2020-11-03 08:15:58 -06:00
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2021-02-17 07:23:32 -06:00
"objects": {
"track": ["person", "dog"],
"filters": {"dog": {"threshold": 0.7}},
},
2020-11-03 08:15:58 -06:00
}
2021-02-17 07:23:32 -06:00
},
2020-11-03 08:15:58 -06:00
}
2021-06-24 01:45:27 -04:00
frigate_config = FrigateConfig(**config)
assert "-re" in frigate_config.cameras["back"].ffmpeg_cmds[0]["cmd"]
2021-02-05 07:22:33 -06:00
def test_ffmpeg_params_camera(self):
config = {
2021-02-17 07:23:32 -06:00
"mqtt": {"host": "mqtt"},
2021-06-24 16:45:15 -04:00
"ffmpeg": {"input_args": ["test"]},
2021-02-17 07:23:32 -06:00
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
2021-02-05 07:22:33 -06:00
],
2021-02-17 07:23:32 -06:00
"input_args": ["-re"],
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2021-02-17 07:23:32 -06:00
"objects": {
"track": ["person", "dog"],
"filters": {"dog": {"threshold": 0.7}},
2021-02-05 07:22:33 -06:00
},
}
2021-02-17 07:23:32 -06:00
},
2021-02-05 07:22:33 -06:00
}
2021-06-24 01:45:27 -04:00
frigate_config = FrigateConfig(**config)
assert "-re" in frigate_config.cameras["back"].ffmpeg_cmds[0]["cmd"]
assert "test" not in frigate_config.cameras["back"].ffmpeg_cmds[0]["cmd"]
2021-02-05 07:22:33 -06:00
def test_ffmpeg_params_input(self):
config = {
2021-02-17 07:23:32 -06:00
"mqtt": {"host": "mqtt"},
2021-06-24 16:45:15 -04:00
"ffmpeg": {"input_args": ["test2"]},
2021-02-17 07:23:32 -06:00
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
2021-06-24 16:45:15 -04:00
"input_args": "-re test",
2021-02-17 07:23:32 -06:00
}
2021-06-24 16:45:15 -04:00
],
"input_args": "test3",
2021-02-05 07:22:33 -06:00
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2021-02-17 07:23:32 -06:00
"objects": {
"track": ["person", "dog"],
"filters": {"dog": {"threshold": 0.7}},
},
2021-02-05 07:22:33 -06:00
}
2021-02-17 07:23:32 -06:00
},
2021-02-05 07:22:33 -06:00
}
2021-06-24 01:45:27 -04:00
frigate_config = FrigateConfig(**config)
assert "-re" in frigate_config.cameras["back"].ffmpeg_cmds[0]["cmd"]
assert "test" in frigate_config.cameras["back"].ffmpeg_cmds[0]["cmd"]
assert "test2" not in frigate_config.cameras["back"].ffmpeg_cmds[0]["cmd"]
assert "test3" not in frigate_config.cameras["back"].ffmpeg_cmds[0]["cmd"]
2021-02-17 07:23:32 -06:00
2020-12-23 07:16:37 -06:00
def test_inherit_clips_retention(self):
2020-11-23 08:25:46 -06:00
config = {
2021-02-17 07:23:32 -06:00
"mqtt": {"host": "mqtt"},
"record": {"alerts": {"retain": {"days": 20}}},
2021-02-17 07:23:32 -06:00
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
2020-11-29 15:55:53 -06:00
]
2020-11-23 08:25:46 -06:00
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2020-11-23 08:25:46 -06:00
}
2021-02-17 07:23:32 -06:00
},
2020-11-23 08:25:46 -06:00
}
2021-06-24 01:45:27 -04:00
frigate_config = FrigateConfig(**config)
assert frigate_config.cameras["back"].record.alerts.retain.days == 20
2021-02-17 07:23:32 -06:00
2020-11-29 15:55:53 -06:00
def test_roles_listed_twice_throws_error(self):
config = {
2021-02-17 07:23:32 -06:00
"mqtt": {"host": "mqtt"},
2021-08-15 08:30:27 -05:00
"record": {
"alerts": {
"retain": {
"days": 20,
}
}
2021-08-15 08:30:27 -05:00
},
2021-02-17 07:23:32 -06:00
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]},
{"path": "rtsp://10.0.0.1:554/video2", "roles": ["detect"]},
2020-11-29 15:55:53 -06:00
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2020-11-29 15:55:53 -06:00
}
2021-02-17 07:23:32 -06:00
},
2020-11-29 15:55:53 -06:00
}
2021-06-24 01:45:27 -04:00
self.assertRaises(ValidationError, lambda: FrigateConfig(**config))
2021-02-17 07:23:32 -06:00
def test_zone_matching_camera_name_throws_error(self):
config = {
2021-02-17 07:23:32 -06:00
"mqtt": {"host": "mqtt"},
2021-08-15 08:30:27 -05:00
"record": {
"alerts": {
"retain": {
"days": 20,
}
}
2021-08-15 08:30:27 -05:00
},
2021-02-17 07:23:32 -06:00
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2021-02-17 07:23:32 -06:00
"zones": {"back": {"coordinates": "1,1,1,1,1,1"}},
}
2021-02-17 07:23:32 -06:00
},
}
2021-06-24 01:45:27 -04:00
self.assertRaises(ValidationError, lambda: FrigateConfig(**config))
def test_zone_assigns_color_and_contour(self):
config = {
"mqtt": {"host": "mqtt"},
2021-08-15 08:30:27 -05:00
"record": {
"alerts": {
"retain": {
"days": 20,
}
}
2021-08-15 08:30:27 -05:00
},
2021-06-24 01:45:27 -04:00
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2021-06-24 01:45:27 -04:00
"zones": {"test": {"coordinates": "1,1,1,1,1,1"}},
}
},
}
frigate_config = FrigateConfig(**config)
2021-06-24 01:45:27 -04:00
assert isinstance(
frigate_config.cameras["back"].zones["test"].contour, np.ndarray
2021-06-24 01:45:27 -04:00
)
assert frigate_config.cameras["back"].zones["test"].color != (0, 0, 0)
2021-02-17 07:23:32 -06:00
2026-01-18 07:36:27 -06:00
def test_zone_filter_area_percent_converts_to_pixels(self):
config = {
"mqtt": {"host": "mqtt"},
"record": {
"alerts": {
"retain": {
"days": 20,
}
}
},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
"zones": {
"notification": {
"coordinates": "0.03,1,0.025,0,0.626,0,0.643,1",
"objects": ["person"],
"filters": {"person": {"min_area": 0.1}},
}
},
}
},
}
frigate_config = FrigateConfig(**config)
expected_min_area = int(1080 * 1920 * 0.1)
assert (
frigate_config.cameras["back"]
.zones["notification"]
.filters["person"]
.min_area
== expected_min_area
)
def test_zone_relative_matches_explicit(self):
config = {
"mqtt": {"host": "mqtt"},
"record": {
"alerts": {
"retain": {
"days": 20,
}
}
},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
]
},
"detect": {
"height": 400,
"width": 800,
"fps": 5,
},
"zones": {
"explicit": {
"coordinates": "0,0,200,100,600,300,800,400",
},
"relative": {
"coordinates": "0.0,0.0,0.25,0.25,0.75,0.75,1.0,1.0",
},
},
}
},
}
frigate_config = FrigateConfig(**config)
assert np.array_equal(
frigate_config.cameras["back"].zones["explicit"].contour,
frigate_config.cameras["back"].zones["relative"].contour,
)
def test_role_assigned_but_not_enabled(self):
2021-06-24 01:45:27 -04:00
config = {
2021-02-17 07:23:32 -06:00
"mqtt": {"host": "mqtt"},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
2023-12-12 16:20:25 -07:00
"roles": ["detect"],
2021-02-17 07:23:32 -06:00
},
{"path": "rtsp://10.0.0.1:554/record", "roles": ["record"]},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
}
2021-02-17 07:23:32 -06:00
},
}
2021-06-24 01:45:27 -04:00
frigate_config = FrigateConfig(**config)
ffmpeg_cmds = frigate_config.cameras["back"].ffmpeg_cmds
2021-02-17 07:23:32 -06:00
assert len(ffmpeg_cmds) == 1
2023-05-29 12:31:17 +02:00
assert "clips" not in ffmpeg_cmds[0]["roles"]
2021-06-26 13:18:06 -05:00
def test_max_disappeared_default(self):
config = {
"mqtt": {"host": "mqtt"},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
]
},
"detect": {
"enabled": True,
"height": 1080,
"width": 1920,
"fps": 5,
},
2021-06-26 13:18:06 -05:00
}
},
}
frigate_config = FrigateConfig(**config)
assert frigate_config.cameras["back"].detect.max_disappeared == 5 * 5
2021-06-26 13:18:06 -05:00
2021-07-01 07:47:22 -05:00
def test_motion_frame_height_wont_go_below_120(self):
2021-07-01 07:33:53 -05:00
config = {
"mqtt": {"host": "mqtt"},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2021-07-01 07:33:53 -05:00
}
},
}
frigate_config = FrigateConfig(**config)
assert frigate_config.cameras["back"].motion.frame_height == 100
2021-07-01 07:47:22 -05:00
def test_motion_contour_area_dynamic(self):
config = {
"mqtt": {"host": "mqtt"},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2021-07-01 07:47:22 -05:00
}
},
}
frigate_config = FrigateConfig(**config)
assert round(frigate_config.cameras["back"].motion.contour_area) == 10
2021-07-01 07:33:53 -05:00
def test_merge_labelmap(self):
config = {
"mqtt": {"host": "mqtt"},
"model": {"labelmap": {7: "truck"}},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
}
},
}
frigate_config = FrigateConfig(**config)
assert frigate_config.model.merged_labelmap[7] == "truck"
def test_default_labelmap_empty(self):
config = {
"mqtt": {"host": "mqtt"},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
}
},
}
frigate_config = FrigateConfig(**config)
assert frigate_config.model.merged_labelmap[0] == "person"
def test_default_labelmap(self):
config = {
"mqtt": {"host": "mqtt"},
"model": {"width": 320, "height": 320},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
}
},
}
frigate_config = FrigateConfig(**config)
assert frigate_config.model.merged_labelmap[0] == "person"
2023-04-30 14:58:39 -05:00
def test_plus_labelmap(self):
2025-03-01 05:35:09 +01:00
with open(os.path.join(MODEL_CACHE_DIR, "test"), "w") as f:
2023-04-30 14:58:39 -05:00
json.dump(self.plus_model_info, f)
2025-03-01 05:35:09 +01:00
with open(os.path.join(MODEL_CACHE_DIR, "test.json"), "w") as f:
2023-04-30 14:58:39 -05:00
json.dump(self.plus_model_info, f)
config = {
"mqtt": {"host": "mqtt"},
2026-05-07 08:53:07 -05:00
"detectors": {"cpu": {"type": "cpu"}},
2023-04-30 14:58:39 -05:00
"model": {"path": "plus://test"},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
}
},
}
frigate_config = FrigateConfig(**config)
assert frigate_config.model.merged_labelmap[0] == "amazon"
2023-04-30 14:58:39 -05:00
2021-08-28 08:16:25 -05:00
def test_fails_on_invalid_role(self):
config = {
"mqtt": {"host": "mqtt"},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
2021-10-22 19:41:28 -05:00
"roles": ["detect"],
},
{
"path": "rtsp://10.0.0.1:554/video2",
"roles": ["clips"],
2021-08-28 08:16:25 -05:00
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
}
},
}
self.assertRaises(ValidationError, lambda: FrigateConfig(**config))
2021-10-22 19:41:28 -05:00
def test_fails_on_missing_role(self):
config = {
"mqtt": {"host": "mqtt"},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
{
"path": "rtsp://10.0.0.1:554/video2",
"roles": ["record"],
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2023-12-12 16:20:25 -07:00
"audio": {"enabled": True},
2021-10-22 19:41:28 -05:00
}
},
}
self.assertRaises(ValueError, lambda: FrigateConfig(**config))
2021-10-22 19:41:28 -05:00
2021-10-24 13:33:13 -05:00
def test_works_on_missing_role_multiple_cams(self):
config = {
"mqtt": {"host": "mqtt"},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
{
"path": "rtsp://10.0.0.1:554/video2",
"roles": ["record"],
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
},
"cam2": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
{
"path": "rtsp://10.0.0.1:554/video2",
"roles": ["record"],
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
},
},
}
FrigateConfig(**config)
2021-10-24 13:33:13 -05:00
def test_global_detect(self):
config = {
"mqtt": {"host": "mqtt"},
"detect": {"max_disappeared": 1},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
}
},
}
frigate_config = FrigateConfig(**config)
assert frigate_config.cameras["back"].detect.max_disappeared == 1
assert frigate_config.cameras["back"].detect.height == 1080
def test_default_detect(self):
config = {
"mqtt": {"host": "mqtt"},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
]
},
"detect": {
"height": 720,
"width": 1280,
"fps": 5,
},
}
},
}
frigate_config = FrigateConfig(**config)
assert frigate_config.cameras["back"].detect.max_disappeared == 25
assert frigate_config.cameras["back"].detect.height == 720
def test_global_detect_merge(self):
config = {
"mqtt": {"host": "mqtt"},
2026-03-30 08:34:54 -05:00
"detect": {"max_disappeared": 1, "height": 720, "width": 1280},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
}
},
}
frigate_config = FrigateConfig(**config)
assert frigate_config.cameras["back"].detect.max_disappeared == 1
assert frigate_config.cameras["back"].detect.height == 1080
assert frigate_config.cameras["back"].detect.width == 1920
2021-08-28 09:14:00 -05:00
def test_global_snapshots(self):
config = {
"mqtt": {"host": "mqtt"},
"snapshots": {"enabled": True},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2021-08-28 09:14:00 -05:00
"snapshots": {
"height": 100,
},
}
},
}
frigate_config = FrigateConfig(**config)
assert frigate_config.cameras["back"].snapshots.enabled
assert frigate_config.cameras["back"].snapshots.height == 100
2021-08-28 09:14:00 -05:00
def test_default_snapshots(self):
config = {
"mqtt": {"host": "mqtt"},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2021-08-28 09:14:00 -05:00
}
},
}
frigate_config = FrigateConfig(**config)
assert frigate_config.cameras["back"].snapshots.bounding_box
assert frigate_config.cameras["back"].snapshots.quality == 60
2021-08-28 09:14:00 -05:00
def test_global_snapshots_merge(self):
config = {
"mqtt": {"host": "mqtt"},
"snapshots": {"bounding_box": False, "height": 300},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2021-08-28 09:14:00 -05:00
"snapshots": {
"height": 150,
"enabled": True,
},
}
},
}
frigate_config = FrigateConfig(**config)
assert frigate_config.cameras["back"].snapshots.bounding_box is False
assert frigate_config.cameras["back"].snapshots.height == 150
assert frigate_config.cameras["back"].snapshots.enabled
2021-08-28 09:14:00 -05:00
def test_global_jsmpeg(self):
2021-09-13 20:33:00 -05:00
config = {
"mqtt": {"host": "mqtt"},
2023-01-16 16:50:35 -07:00
"live": {"quality": 4},
2021-09-13 20:33:00 -05:00
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2021-09-13 20:33:00 -05:00
}
},
}
frigate_config = FrigateConfig(**config)
assert frigate_config.cameras["back"].live.quality == 4
2021-09-13 20:33:00 -05:00
def test_default_live(self):
config = {
"mqtt": {"host": "mqtt"},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2021-09-13 20:33:00 -05:00
}
},
}
frigate_config = FrigateConfig(**config)
assert frigate_config.cameras["back"].live.quality == 8
2021-09-13 20:33:00 -05:00
def test_global_live_merge(self):
config = {
"mqtt": {"host": "mqtt"},
2023-01-16 16:50:35 -07:00
"live": {"quality": 4, "height": 480},
2021-09-13 20:33:00 -05:00
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2023-01-16 16:50:35 -07:00
"live": {
"quality": 7,
2021-09-13 20:33:00 -05:00
},
}
},
}
frigate_config = FrigateConfig(**config)
assert frigate_config.cameras["back"].live.quality == 7
assert frigate_config.cameras["back"].live.height == 480
2021-09-13 20:33:00 -05:00
def test_global_timestamp_style(self):
config = {
"mqtt": {"host": "mqtt"},
2021-09-04 16:56:01 -05:00
"timestamp_style": {"position": "bl"},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
}
},
}
frigate_config = FrigateConfig(**config)
assert frigate_config.cameras["back"].timestamp_style.position == "bl"
def test_default_timestamp_style(self):
config = {
"mqtt": {"host": "mqtt"},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
}
},
}
frigate_config = FrigateConfig(**config)
assert frigate_config.cameras["back"].timestamp_style.position == "tl"
def test_global_timestamp_style_merge(self):
config = {
"mqtt": {"host": "mqtt"},
2021-09-04 16:56:01 -05:00
"timestamp_style": {"position": "br", "thickness": 2},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2021-09-04 16:56:01 -05:00
"timestamp_style": {"position": "bl", "thickness": 4},
}
},
}
frigate_config = FrigateConfig(**config)
assert frigate_config.cameras["back"].timestamp_style.position == "bl"
assert frigate_config.cameras["back"].timestamp_style.thickness == 4
2021-09-20 18:59:16 -05:00
def test_allow_retain_to_be_a_decimal(self):
config = {
"mqtt": {"host": "mqtt"},
"snapshots": {"retain": {"default": 1.5}},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2021-09-20 18:59:16 -05:00
}
},
}
frigate_config = FrigateConfig(**config)
assert frigate_config.cameras["back"].snapshots.retain.default == 1.5
2021-09-20 18:59:16 -05:00
2022-02-02 07:21:03 -06:00
def test_fails_on_bad_camera_name(self):
config = {
"mqtt": {"host": "mqtt"},
"snapshots": {"retain": {"default": 1.5}},
"cameras": {
"back camer#": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2022-02-02 07:21:03 -06:00
}
},
}
self.assertRaises(ValidationError, lambda: FrigateConfig(**config).cameras)
2022-02-02 07:21:03 -06:00
def test_fails_on_bad_segment_time(self):
config = {
"mqtt": {"host": "mqtt"},
"record": {"enabled": True},
"cameras": {
"back": {
"ffmpeg": {
"output_args": {
"record": "-f segment -segment_time 70 -segment_format mp4 -reset_timestamps 1 -strftime 1 -c copy -an"
},
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
],
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
}
},
}
self.assertRaises(
2023-04-30 13:32:36 -05:00
ValueError,
lambda: FrigateConfig(**config).ffmpeg.output_args.record,
)
2022-11-08 18:47:45 -07:00
def test_fails_zone_defines_untracked_object(self):
config = {
"mqtt": {"host": "mqtt"},
"objects": {"track": ["person"]},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{
"path": "rtsp://10.0.0.1:554/video",
"roles": ["detect"],
},
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
2022-11-08 18:47:45 -07:00
"zones": {
"steps": {
"coordinates": "0,0,0,0",
"objects": ["car", "person"],
},
},
}
},
}
self.assertRaises(ValueError, lambda: FrigateConfig(**config).cameras)
2022-11-08 18:47:45 -07:00
def test_fails_duplicate_keys(self):
raw_config = """
cameras:
test:
ffmpeg:
inputs:
- one
- two
inputs:
- three
- four
"""
self.assertRaises(
DuplicateKeyError, lambda: FrigateConfig.parse_yaml(raw_config)
2022-11-08 18:47:45 -07:00
)
2022-04-10 09:25:18 -04:00
def test_object_filter_ratios_work(self):
config = {
"mqtt": {"host": "mqtt"},
"objects": {
"track": ["person", "dog"],
"filters": {"dog": {"min_ratio": 0.2, "max_ratio": 10.1}},
},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
}
},
}
frigate_config = FrigateConfig(**config)
assert "dog" in frigate_config.cameras["back"].objects.filters
assert frigate_config.cameras["back"].objects.filters["dog"].min_ratio == 0.2
assert frigate_config.cameras["back"].objects.filters["dog"].max_ratio == 10.1
2022-04-10 09:25:18 -04:00
def test_valid_movement_weights(self):
config = {
"mqtt": {"host": "mqtt"},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
"onvif": {
2025-04-29 11:17:56 -05:00
"autotracking": {
"movement_weights": "0, 1, 1.23, 2.34, 0.50, 1"
}
},
}
},
}
frigate_config = FrigateConfig(**config)
assert frigate_config.cameras["back"].onvif.autotracking.movement_weights == [
2023-11-01 06:12:43 -05:00
"0.0",
"1.0",
"1.23",
"2.34",
"0.5",
2025-04-29 11:17:56 -05:00
"1.0",
]
def test_fails_invalid_movement_weights(self):
config = {
"mqtt": {"host": "mqtt"},
"cameras": {
"back": {
"ffmpeg": {
"inputs": [
{"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
]
},
"detect": {
"height": 1080,
"width": 1920,
"fps": 5,
},
"onvif": {"autotracking": {"movement_weights": "1.234, 2.345a"}},
}
},
}
self.assertRaises(ValueError, lambda: FrigateConfig(**config))
2020-11-01 06:17:44 -06:00
2021-02-17 07:23:32 -06:00
if __name__ == "__main__":
2021-06-24 01:45:27 -04:00
unittest.main(verbosity=2)