Enhance documentation for motion and object masks #21175
Conversation
Expanded explanations for motion and object filter masks, including usage guidelines and performance considerations.
✅ Deploy Preview for frigate-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
NickM-27
left a comment
NickM-27
left a comment
There was a problem hiding this comment.
I am happy to defer to other maintainers, but this seems like too much of an overhaul. It removes important information that has been very helpful for users while adding some information that is either incorrect or too ambiguous and may make things more confusing.
The tip #13040 contains the primary explanation and recommendations for users regarding zones and masks.
| ## Motion masks | ||
|
|
||
| Motion masks are used to prevent unwanted types of motion from triggering detection. Try watching the Debug feed (Settings --> Debug) with `Motion Boxes` enabled to see what may be regularly detected as motion. For example, you want to mask out your timestamp, the sky, rooftops, etc. Keep in mind that this mask only prevents motion from being detected and does not prevent objects from being detected if object detection was started due to motion in unmasked areas. Motion is also used during object tracking to refine the object detection area in the next frame. _Over-masking will make it more difficult for objects to be tracked._ | ||
| Motion masks tell Frigate where motion should be ignored when deciding whether to run object detection or continue tracking an object. |
There was a problem hiding this comment.
or continue tracking an object.
this is not correct, it does not stop it from tracking objects that have been detected
| - Detect-stream resolution | ||
| - Detected object types (e.g., only `person`) | ||
|
|
||
| ### Further Clarification |
There was a problem hiding this comment.
This section should not be removed
| To reduce load: | ||
|
|
||
| 1. Motion-mask busy areas that never contain relevant objects (streets, public sidewalks, distant parking lots). | ||
| 2. If needed, tune: | ||
| - `detect.fps` | ||
| - Detect-stream resolution | ||
| - Detected object types (e.g., only `person`) |
There was a problem hiding this comment.
This is not recommended, in fact it is highly discouraged. Areas where objects are detected should not be motion masked
|
In addition to @NickM-27's feedback above, I’m curious about the motivation for doing a full rewrite of this page. I would rather keep the existing content and instead make a few targeted edits or clarifications. I’m not convinced that a complete overhaul is necessary - maybe small adjustments might address the issues without losing the helpful information the current version provides. |
3 participants
Expanded explanations for motion and object filter masks, including usage guidelines and performance considerations.
Proposed change
Type of change
Additional information
Checklist
enlocale.ruff format frigate)