Skip to content

Add clarifying message and docs link around motion masks #11452

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 20, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions web/src/components/settings/MotionMaskEditPane.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ import axios from "axios";
import { toast } from "sonner";
import { Toaster } from "../ui/sonner";
import ActivityIndicator from "../indicators/activity-indicator";
import { Link } from "react-router-dom";
import { LuExternalLink } from "react-icons/lu";

type MotionMaskEditPaneProps = {
polygons?: Polygon[];
Expand Down Expand Up @@ -187,12 +189,25 @@ export default function MotionMaskEditPane({
<Heading as="h3" className="my-2">
{polygon.name.length ? "Edit" : "New"} Motion Mask
</Heading>
<div className="my-2 text-sm text-muted-foreground">
<div className="my-3 space-y-3 text-sm text-muted-foreground">
<p>
Motion masks are used to prevent unwanted types of motion from
triggering detection. Over masking will make it more difficult for
objects to be tracked.
triggering detection (example: tree branches, camera timestamps).
Motion masks should be used <em>very sparingly</em>, over-masking will
make it more difficult for objects to be tracked.
</p>

<div className="flex items-center text-primary">
<Link
to="https://docs.frigate.video/configuration/masks/"
target="_blank"
rel="noopener noreferrer"
className="inline"
>
Read the documentation{" "}
<LuExternalLink className="ml-2 inline-flex size-3" />
</Link>
</div>
</div>
<Separator className="my-3 bg-secondary" />
{polygons && activePolygonIndex !== undefined && (
Expand Down
Loading