Skip to content

Commit

Permalink
Update zone and review docs to reflect latest config
Browse files Browse the repository at this point in the history
  • Loading branch information
NickM-27 committed Apr 14, 2024
1 parent feab0be commit d06107d
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 17 deletions.
4 changes: 0 additions & 4 deletions docs/docs/configuration/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
43 changes: 33 additions & 10 deletions docs/docs/configuration/review.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,43 @@ 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 object types
## 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 using the following config:
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 camera level
objects:
alert:
- car
- cat
- dog
- person
# 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 `objects -> alert` 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-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
```
26 changes: 23 additions & 3 deletions docs/docs/configuration/zones.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,42 @@ 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
Expand Down

0 comments on commit d06107d

Please sign in to comment.