diff --git a/docs/docs/configuration/events.md b/docs/docs/configuration/events.md deleted file mode 100644 index ca110fa7a..000000000 --- a/docs/docs/configuration/events.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: events -title: Events ---- - -Events are saved as periods of time where active objects are detected. After watching the preview of an event it is marked as reviewed. - -## Restricting alerts to specific object types - -By default an event will only be marked as an alert if a person or car is detected. This can be configured using the following config: - -```yaml -# can be overridden at camera level -objects: - alert: - - car - - cat - - dog - - person -``` - -## Restricting alerts to specific zones - -By default an event will be marked as an alert if any `objects -> alert` is detected anywhere in the camera frame. You will likely want to configure events to only be marked as an alert when the object enters an area of interest, [see the zone docs for more information](./zones.mdzones#restricting-alerts-to-specific-zones) diff --git a/docs/docs/configuration/reference.md b/docs/docs/configuration/reference.md index e97439dee..829bae690 100644 --- a/docs/docs/configuration/reference.md +++ b/docs/docs/configuration/reference.md @@ -231,10 +231,6 @@ detect: # Optional: Object configuration # NOTE: Can be overridden at the camera level objects: - # Optional: list of objects that cause an event to be marked as an alert (default: shown below) - alert: - - car - - person # Optional: list of objects to track from labelmap.txt (default: shown below) track: - person diff --git a/docs/docs/configuration/review.md b/docs/docs/configuration/review.md new file mode 100644 index 000000000..441208537 --- /dev/null +++ b/docs/docs/configuration/review.md @@ -0,0 +1,47 @@ +--- +id: review +title: Review +--- + +Review items are saved as periods of time where frigate detected events. After watching the preview of a review item it is marked as reviewed. + +## Restricting alerts to specific labels + +By default a review item will only be marked as an alert if a person or car is detected. This can be configured to include any object or audio label using the following config: + +```yaml +# can be overridden at the camera level +review: + alerts: + labels: + - car + - cat + - dog + - person + - speech +``` + +## Restricting alerts to specific zones + +By default a review item will be marked as an alert if any `review -> alerts -> labels` is detected anywhere in the camera frame. You will likely want to configure review items to only be marked as an alert when the object enters an area of interest, [see the zone docs for more information](./zones.md#restricting-alerts-and-detections-to-specific-zones) + +:::info + +Because zones don't apply to audio, audio labels will always be marked as an alert. + +::: + +## Restricting detections to specific labels + +By default all detections that do not qualify as an alert qualify as a detection. However, detections can further be filtered to only include certain labels or certain zones. + +By default a review item will only be marked as an alert if a person or car is detected. This can be configured to include any object or audio label using the following config: + +```yaml +# can be overridden at the camera level +review: + detections: + labels: + - bark + - dog +``` diff --git a/docs/docs/configuration/snapshots.md b/docs/docs/configuration/snapshots.md index 6145812db..dce689a67 100644 --- a/docs/docs/configuration/snapshots.md +++ b/docs/docs/configuration/snapshots.md @@ -3,6 +3,8 @@ id: snapshots title: Snapshots --- -Frigate can save a snapshot image to `/media/frigate/clips` for each event named as `-.jpg`. +Frigate can save a snapshot image to `/media/frigate/clips` for each object that is detected named as `-.jpg`. They are also accessible [via the api](../integrations/api.md#get-apieventsidsnapshotjpg) + +To only save snapshots for objects that enter a specific zone, [see the zone docs](./zones.md#restricting-snapshots-to-specific-zones) Snapshots sent via MQTT are configured in the [config file](https://docs.frigate.video/configuration/) under `cameras -> your_camera -> mqtt` diff --git a/docs/docs/configuration/zones.md b/docs/docs/configuration/zones.md index 035027cec..23fcea986 100644 --- a/docs/docs/configuration/zones.md +++ b/docs/docs/configuration/zones.md @@ -14,17 +14,47 @@ During testing, enable the Zones option for the debug feed so you can adjust as To create a zone, follow [the steps for a "Motion mask"](masks.md), but use the section of the web UI for creating a zone instead. -### Restricting alerts to specific zones +### Restricting alerts and detections to specific zones Often you will only want alerts to be created when an object enters areas of interest. This is done using zones along with setting required_zones. Let's say you only want to have an alert created when an object enters your entire_yard zone, the config would be: ```yaml cameras: name_of_your_camera: - record: - events: + review: + alerts: required_zones: - entire_yard + zones: + entire_yard: + coordinates: ... +``` + +You may also want to filter detections to only be created when an object enters a secondary area of interest. This is done using zones along with setting required_zones. Let's say you want alerts when an object enters the inner area of the yard but detections when an object enters the edge of the yard, the config would be + +```yaml +cameras: + name_of_your_camera: + review: + alerts: + required_zones: + - inner_yard + detections: + required_zones: + - edge_yard + zones: + edge_yard: + coordinates: ... + inner_yard: + coordinates: ... + +``` + +### Restricting snapshots to specific zones + +```yaml +cameras: + name_of_your_camera: snapshots: required_zones: - entire_yard diff --git a/docs/sidebars.js b/docs/sidebars.js index d783b489a..eff51212c 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -32,7 +32,7 @@ module.exports = { ], Cameras: [ "configuration/cameras", - "configuration/events", + "configuration/review", "configuration/record", "configuration/snapshots", "configuration/motion_detection",