* add generation script a script to read yaml code blocks from docs markdown files and generate corresponding "Frigate UI" tab instructions based on the json schema, i18n, section configs (hidden fields), and nav mappings * first pass * components * add to gitignore * second pass * fix broken anchors * fixes * clean up tabs * version bump * tweaks * remove role mapping config from ui
4.7 KiB
| id | title |
|---|---|
| objects | Available Objects |
import ConfigTabs from "@site/src/components/ConfigTabs"; import TabItem from "@theme/TabItem"; import NavPath from "@site/src/components/NavPath"; import labels from "../../../labelmap.txt";
Frigate includes the object labels listed below from the Google Coral test data.
Please note:
caris listed twice becausetruckhas been renamed tocarby default. These object types are frequently confused.personis the only tracked object by default. To track additional objects, configure them in the objects settings.
-
{labels.split("\n").map((label) => (
- {label.replace(/^\d+\s+/, "")} ))}
Configuring Tracked Objects
By default, Frigate only tracks person. To track additional object types, add them to the tracked objects list.
- Navigate to .
- Add the desired object types to the Objects to track list (e.g.,
person,car,dog)
- Add the desired object types to the Objects to track list (e.g.,
To override the tracked objects list for a specific camera:
- Navigate to .
- Add the desired object types to the Objects to track list
objects:
track:
- person
- car
- dog
To override at the camera level:
cameras:
front_door:
objects:
track:
- person
- car
Filtering Objects
Object filters help reduce false positives by constraining the size, shape, and confidence thresholds for each object type. Filters can be configured globally or per camera.
Navigate to .
| Field | Description |
|---|---|
| Object filters > Person > Min Area | Minimum bounding box area in pixels (or decimal for percentage of frame) |
| Object filters > Person > Max Area | Maximum bounding box area in pixels (or decimal for percentage of frame) |
| Object filters > Person > Min Ratio | Minimum width/height ratio of the bounding box |
| Object filters > Person > Max Ratio | Maximum width/height ratio of the bounding box |
| Object filters > Person > Min Score | Minimum score for the object to initiate tracking |
| Object filters > Person > Threshold | Minimum computed score to be considered a true positive |
To override filters for a specific camera, navigate to .
objects:
filters:
person:
min_area: 5000
max_area: 100000
min_ratio: 0.5
max_ratio: 2.0
min_score: 0.5
threshold: 0.7
To override at the camera level:
cameras:
front_door:
objects:
filters:
person:
min_area: 5000
threshold: 0.7
Object Filter Masks
Object filter masks prevent specific object types from being detected in certain areas of the camera frame. These masks check the bottom center of the bounding box. A global mask applies to all object types, while per-object masks apply only to the specified type.
Navigate to and select a camera. Use the mask editor to draw object filter masks directly on the camera feed. Global object masks and per-object masks can both be configured from this view.
objects:
# Global mask applied to all object types
mask:
mask1:
friendly_name: "Object filter mask area"
enabled: true
coordinates: "0.000,0.000,0.781,0.000,0.781,0.278,0.000,0.278"
# Per-object mask
filters:
person:
mask:
mask1:
friendly_name: "Person filter mask"
enabled: true
coordinates: "0.000,0.000,0.781,0.000,0.781,0.278,0.000,0.278"
:::note
The global mask is combined with any object-specific mask. Both are checked based on the bottom center of the bounding box.
:::
Custom Models
Models for both CPU and EdgeTPU (Coral) are bundled in the image. You can use your own models with volume mounts:
- CPU Model:
/cpu_model.tflite - EdgeTPU Model:
/edgetpu_model.tflite - Labels:
/labelmap.txt
You also need to update the model config if they differ from the defaults.