From 54b5688626814dbac090ee6321979f32ab0e5c18 Mon Sep 17 00:00:00 2001 From: Nicolas Mowen Date: Fri, 12 Apr 2024 11:36:11 -0600 Subject: [PATCH] Update reference config to reflect new config --- docs/docs/configuration/reference.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/docs/docs/configuration/reference.md b/docs/docs/configuration/reference.md index 0591f9757..f603d33fb 100644 --- a/docs/docs/configuration/reference.md +++ b/docs/docs/configuration/reference.md @@ -257,6 +257,28 @@ objects: # Checks based on the bottom center of the bounding box of the object mask: 0,0,1000,0,1000,200,0,200 +# Optional: Review configuration +# NOTE: Can be overridden at the camera level +review: + # Optional: alerts configuration + alerts: + # Optional: labels that qualify as an alert (default: shown below) + labels: + - car + - person + # Optional: required zones for an object to be marked as an alert (default: none) + required_zones: + - driveway + # Optional: detections configuration + detections: + # Optional: labels that qualify as a detection (default: all labels that are tracked / listened to) + labels: + - car + - person + # Optional: required zones for an object to be marked as a detection (default: none) + required_zones: + - driveway + # Optional: Motion configuration # NOTE: Can be overridden at the camera level motion: @@ -345,8 +367,6 @@ record: # Optional: Objects to save recordings for. (default: all tracked objects) objects: - person - # Optional: Restrict recordings to objects that entered any of the listed zones (default: no required zones) - required_zones: [] # Optional: Retention settings for recordings of events retain: # Required: Default retention days (default: shown below)