From b69c0daadbea44b42dca80da4f5c02c6e723e553 Mon Sep 17 00:00:00 2001 From: Nicolas Mowen Date: Wed, 15 Feb 2023 05:30:29 -0700 Subject: [PATCH] Add docs for required_zones (#5499) * Add docs for required_zones * fix spacing --- docs/docs/configuration/zones.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/docs/configuration/zones.md b/docs/docs/configuration/zones.md index 47855d929..f8e463605 100644 --- a/docs/docs/configuration/zones.md +++ b/docs/docs/configuration/zones.md @@ -11,6 +11,24 @@ 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 events to specific zones + +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: + record: + events: + required_zones: + - entire_yard + snapshots: + required_zones: + - entire_yard + zones: + entire_yard: + coordinates: ... +``` + ### Restricting zones to specific objects 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.