Mirrors/blakeblackshear.frigate
1
0
Fork 0
mirror of https://github.com/blakeblackshear/frigate.git synced 2025-08-04 13:47:37 +02:00
Code Issues Projects Releases Wiki Activity

small docs typo fix for zones (#10549)

Browse Source 
* Update zones.md

* Update zones.md round 2
This commit is contained in:
Austin Kirsch 2024-04-11 07:41:48 -04:00 committed by GitHub
parent 4a7a47a931
commit 0c5aef0907
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 48 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/docs/configuration/zones.md
View File

@ -19,7 +19,8 @@ To create a zone, follow [the steps for a "Motion mask"](masks.md), but use the
Often you will only want events 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 be notified when an object enters your entire_yard zone, the config would be:
```yaml
camera:
cameras:
name_of_your_camera:
record:
events:
required_zones:
@ -37,7 +38,8 @@ camera:
Sometimes you want to limit a zone to specific object types to have more granular control of when events/snapshots are saved. The following example will limit one zone to person objects and the other to cars.
```yaml
camera:
cameras:
name_of_your_camera:
record:
events:
required_zones:
@ -65,7 +67,8 @@ Only car objects can trigger the `front_yard_street` zone and only person can tr
Sometimes objects are expected to be passing through a zone, but an object loitering in an area is unexpected. Zones can be configured to have a minimum loitering time before the object will be considered in the zone.
```yaml
camera:
cameras:
name_of_your_camera:
zones:
sidewalk:
loitering_time: 4 # unit is in seconds
@ -78,7 +81,8 @@ camera:
Sometimes an objects bounding box may be slightly incorrect and the bottom center of the bounding box is inside the zone while the object is not actually in the zone. Zone inertia helps guard against this by requiring an object's bounding box to be within the zone for multiple consecutive frames. This value can be configured:
```yaml
camera:
cameras:
name_of_your_camera:
zones:
front_yard:
inertia: 3
@ -89,7 +93,8 @@ camera:
There may also be cases where you expect an object to quickly enter and exit a zone, like when a car is pulling into the driveway, and you may want to have the object be considered present in the zone immediately:
```yaml
camera:
cameras:
name_of_your_camera:
zones:
driveway_entrance:
inertia: 1