Skip to content

Commit

Permalink
Document zone inertia in zone docs
Browse files Browse the repository at this point in the history
  • Loading branch information
NickM-27 committed Oct 3, 2023
1 parent 3ae9fde commit b2e06f6
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/docs/configuration/zones.md
Expand Up @@ -56,3 +56,27 @@ 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.

### Zone Inertia

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:
zones:
front_yard:
inertia: 3
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:

```yaml
camera:
zones:
driveway_entrance:
inertia: 1
objects:
- car
```

0 comments on commit b2e06f6

Please sign in to comment.