From eca8c52f15b19d084ba149fe3c66bcfd80241927 Mon Sep 17 00:00:00 2001 From: Josh Hawkins <32435876+hawkeye217@users.noreply.github.com> Date: Mon, 27 May 2024 10:31:49 -0500 Subject: [PATCH] docs update: how to exclude camera from alerts/detections (#11560) --- docs/docs/configuration/review.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/docs/configuration/review.md b/docs/docs/configuration/review.md index fdf8c5259..3fe6db4b1 100644 --- a/docs/docs/configuration/review.md +++ b/docs/docs/configuration/review.md @@ -42,6 +42,20 @@ review: - dog ``` +## Excluding a camera from alerts or detections + +To exclude a specific camera from alerts or detections, simply provide an empty list to the alerts or detections field _at the camera level_. + +For example, to exclude objects on the camera _gatecamera_ from any detections, include this in your config: + +```yaml +cameras: + gatecamera: + review: + detections: + labels: [] +``` + ## Restricting review items to specific zones By default a review item will be created if any `review -> alerts -> labels` and `review -> detections -> labels` are detected anywhere in the camera frame. You will likely want to configure review items to only be created when the object enters an area of interest, [see the zone docs for more information](./zones.md#restricting-alerts-and-detections-to-specific-zones)