administrator/frigate
1
0
Fork 0
mirror of https://github.com/blakeblackshear/frigate.git synced 2026-02-09 20:55:25 +03:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Update zones.md round 2

Browse Source
This commit is contained in:
Austin Kirsch 2024-03-20 11:43:21 -04:00 committed by GitHub
parent eb1ed27470
commit 464ecfb47d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 43 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -20,16 +20,17 @@ Often you will only want events to be created when an object enters areas of int
```yaml ```yaml
cameras: cameras:
record: name_of_your_camera:
events: record:
events:
required_zones:
- entire_yard
snapshots:
required_zones: required_zones:
- entire_yard - entire_yard
snapshots: zones:
required_zones: entire_yard:
- entire_yard coordinates: ...
zones:
entire_yard:
coordinates: ...
``` ```
### Restricting zones to specific objects ### Restricting zones to specific objects
@ -38,24 +39,25 @@ Sometimes you want to limit a zone to specific object types to have more granula
```yaml ```yaml
cameras: cameras:
record: name_of_your_camera:
events: record:
events:
required_zones:
- entire_yard
- front_yard_street
snapshots:
required_zones: required_zones:
- entire_yard - entire_yard
- front_yard_street - front_yard_street
snapshots: zones:
required_zones: entire_yard:
- entire_yard coordinates: ... (everywhere you want a person)
- front_yard_street objects:
zones: - person
entire_yard: front_yard_street:
coordinates: ... (everywhere you want a person) coordinates: ... (just the street)
objects: objects:
- person - car
front_yard_street:
coordinates: ... (just the street)
objects:
- car
``` ```
Only car objects can trigger the `front_yard_street` zone and only person can trigger the `entire_yard`. You will get events for person objects that enter anywhere in the yard, and events for cars only if they enter the street. Only car objects can trigger the `front_yard_street` zone and only person can trigger the `entire_yard`. You will get events for person objects that enter anywhere in the yard, and events for cars only if they enter the street.
@ -66,11 +68,12 @@ Sometimes objects are expected to be passing through a zone, but an object loite
```yaml ```yaml
cameras: cameras:
zones: name_of_your_camera:
sidewalk: zones:
loitering_time: 4 # unit is in seconds sidewalk:
objects: loitering_time: 4 # unit is in seconds
- person objects:
- person
``` ```
### Zone Inertia ### Zone Inertia
@ -79,20 +82,22 @@ Sometimes an objects bounding box may be slightly incorrect and the bottom cente
```yaml ```yaml
cameras: cameras:
zones: name_of_your_camera:
front_yard: zones:
inertia: 3 front_yard:
objects: inertia: 3
- person objects:
- person
``` ```
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: 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 ```yaml
cameras: cameras:
zones: name_of_your_camera:
driveway_entrance: zones:
inertia: 1 driveway_entrance:
objects: inertia: 1
- car objects:
- car
``` ```