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

Update zones docs

Browse Source
This commit is contained in:
Nick Mowen 2022-05-27 13:14:03 -06:00
parent 9d05e86847
commit 258d6af1f1
2 changed files with 17 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -3,7 +3,7 @@ id: zones
title: Zones title: Zones
--- ---
Zones allow you to define a specific area of the frame and apply additional filters for object types so you can determine whether or not an object is within a particular area. Presence in a zone is evaluated based on the bottom center of the bounding box for the object. It does not matter how much of the bounding box overlaps with the zone. Zones allow you to define a specific area of the frame and apply additional filters for object types so you can determine whether or not an object is within a particular area. Presence in a zone is evaluated based on a specified point of the bounding box for the object (bottom center by default). It does not matter how much of the bounding box overlaps with the zone.
Zones cannot have the same name as a camera. If desired, a single zone can include multiple cameras if you have multiple cameras covering the same area by configuring zones with the same name for each camera. Zones cannot have the same name as a camera. If desired, a single zone can include multiple cameras if you have multiple cameras covering the same area by configuring zones with the same name for each camera.
@ -38,3 +38,15 @@ camera:
``` ```
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.
### Setting trigger point for zone
```yaml
camera:
zones:
couch:
coordinates: ... (everywhere you want a person)
objects:
- person
bounding_box_trigger: top_center
```

8
frigate/util.py
View File

@ -976,10 +976,10 @@ class SharedMemoryFrameManager(FrameManager):
class BoundingBoxTriggerEnum(str, Enum): class BoundingBoxTriggerEnum(str, Enum):
bottom_center = "bottom-center" bottom_center = "bottom_center"
left_center = "left-center" left_center = "left_center"
right_center = "right-center" right_center = "right_center"
top_center = "top-center" top_center = "top_center"
def is_in_zone(self, centroid, box, contour) -> bool: def is_in_zone(self, centroid, box, contour) -> bool:
"""Tests a zone based on the bounding box """Tests a zone based on the bounding box