mirror of
https://github.com/blakeblackshear/frigate.git
synced 2026-04-05 22:57:40 +03:00
* add CameraProfileConfig model for named config overrides * add profiles field to CameraConfig * add active_profile field to FrigateConfig Runtime-only field excluded from YAML serialization, tracks which profile is currently active. * add ProfileManager for profile activation and persistence Handles snapshotting base configs, applying profile overrides via deep_merge + apply_section_update, publishing ZMQ updates, and persisting active profile to /config/.active_profile. * add profile API endpoints (GET /profiles, GET/PUT /profile) * add MQTT and dispatcher integration for profiles - Subscribe to frigate/profile/set MQTT topic - Publish profile/state and profiles/available on connect - Add _on_profile_command handler to dispatcher - Broadcast active profile state on WebSocket connect * wire ProfileManager into app startup and FastAPI - Create ProfileManager after dispatcher init - Restore persisted profile on startup - Pass dispatcher and profile_manager to FastAPI app * add tests for invalid profile values and keys Tests that Pydantic rejects: invalid field values (fps: "not_a_number"), unknown section keys (ffmpeg in profile), invalid nested values, and invalid profiles in full config parsing. * formatting * fix CameraLiveConfig JSON serialization error on profile activation refactor _publish_updates to only publish ZMQ updates for sections that actually changed, not all sections on affected cameras. * consolidate * add enabled field to camera profiles for enabling/disabling cameras * add zones support to camera profiles * add frontend profile types, color utility, and config save support * add profile state management and save preview support * add profileName prop to BaseSection for profile-aware config editing * add profile section dropdown and wire into camera settings pages * add per-profile camera enable/disable to Camera Management view * add profiles summary page with card-based layout and fix backend zone comparison bug * add active profile badge to settings toolbar * i18n * add red dot for any pending changes including profiles * profile support for mask and zone editor * fix hidden field validation errors caused by lodash wildcard and schema gaps lodash unset does not support wildcard (*) segments, so hidden fields like filters.*.mask were never stripped from form data, leaving null raw_coordinates that fail RJSF anyOf validation. Add unsetWithWildcard helper and also strip hidden fields from the JSON schema itself as defense-in-depth. * add face_recognition and lpr to profile-eligible sections * move profile dropdown from section panes to settings header * add profiles enable toggle and improve empty state * formatting * tweaks * tweak colors and switch * fix profile save diff, masksAndZones delete, and config sync * ui tweaks * ensure profile manager gets updated config * rename profile settings to ui settings * refactor profilesview and add dots/border colors when overridden * implement an update_config method for profile manager * fix mask deletion * more unique colors * add top-level profiles config section with friendly names * implement profile friendly names and improve profile UI - Add ProfileDefinitionConfig type and profiles field to FrigateConfig - Use ProfilesApiResponse type with friendly_name support throughout - Replace Record<string, unknown> with proper JsonObject/JsonValue types - Add profile creation form matching zone pattern (Zod + NameAndIdFields) - Add pencil icon for renaming profile friendly names in ProfilesView - Move Profiles menu item to first under Camera Configuration - Add activity indicators on save/rename/delete buttons - Display friendly names in CameraManagementView profile selector - Fix duplicate colored dots in management profile dropdown - Fix i18n namespace for overridden base config tooltips - Move profile override deletion from dropdown trash icon to footer button with confirmation dialog, matching Reset to Global pattern - Remove Add Profile from section header dropdown to prevent saving camera overrides before top-level profile definition exists - Clean up newProfiles state after API profile deletion - Refresh profiles SWR cache after saving profile definitions * remove profile badge in settings and add profiles to main menu * use icon only on mobile * change color order * docs * show activity indicator on trash icon while deleting a profile * tweak language * immediately create profiles on backend instead of deferring to Save All * hide restart-required fields when editing a profile section fields that require a restart cannot take effect via profile switching, so they are merged into hiddenFields when profileName is set * show active profile indicator in desktop status bar * fix profile config inheritance bug where Pydantic defaults override base values The /config API was dumping profile overrides with model_dump() which included all Pydantic defaults. When the frontend merged these over the camera's base config, explicitly-set base values were lost. Now profile overrides are re-dumped with exclude_unset=True so only user-specified fields are returned. Also fixes the Save All path generating spurious deletion markers for restart-required fields that are hidden during profile editing but not excluded from the raw data sanitization in prepareSectionSavePayload. * docs tweaks * docs tweak * formatting * formatting * fix typing * fix test pollution test_maintainer was injecting MagicMock() into sys.modules["frigate.config.camera.updater"] at module load time and never restoring it. When the profile tests later imported CameraConfigUpdateEnum and CameraConfigUpdateTopic from that module, they got mock objects instead of the real dataclass/enum, so equality comparisons always failed * remove * fix settings showing profile-merged values when editing base config When a profile is active, the in-memory config contains effective (profile-merged) values. The settings UI was displaying these merged values even when the "Base Config" view was selected. Backend: snapshot pre-profile base configs in ProfileManager and expose them via a `base_config` key in the /api/config camera response when a profile is active. The top-level sections continue to reflect the effective running config. Frontend: read from `base_config` when available in BaseSection, useConfigOverride, useAllCameraOverrides, and prepareSectionSavePayload. Include formData labels in Object/Audio switches widgets so that labels added only by a profile override remain visible when editing that profile. * use rasterized_mask as field makes it easier to exclude from the schema with exclude=True prevents leaking of the field when using model_dump for profiles * fix zones - Fix zone colors not matching across profiles by falling back to base zone color when profile zone data lacks a color field - Use base_config for base-layer values in masks/zones view so profile-merged values don't pollute the base config editing view - Handle zones separately in profile manager snapshot/restore since ZoneConfig requires special serialization (color as private attr, contour generation) - Inherit base zone color and generate contours for profile zone overrides in profile manager * formatting * don't require restart for camera enabled change for profiles * publish camera state when changing profiles * formatting * remove available profiles from mqtt * improve typing
530 lines
16 KiB
TypeScript
530 lines
16 KiB
TypeScript
import Heading from "../ui/heading";
|
|
import { Separator } from "../ui/separator";
|
|
import { Button } from "@/components/ui/button";
|
|
import {
|
|
Select,
|
|
SelectContent,
|
|
SelectGroup,
|
|
SelectItem,
|
|
SelectSeparator,
|
|
SelectTrigger,
|
|
SelectValue,
|
|
} from "@/components/ui/select";
|
|
import {
|
|
Form,
|
|
FormControl,
|
|
FormDescription,
|
|
FormField,
|
|
FormItem,
|
|
FormLabel,
|
|
FormMessage,
|
|
} from "@/components/ui/form";
|
|
import { useCallback, useEffect, useMemo } from "react";
|
|
import { FrigateConfig } from "@/types/frigateConfig";
|
|
import useSWR from "swr";
|
|
import { zodResolver } from "@hookform/resolvers/zod";
|
|
import { useForm, FormProvider } from "react-hook-form";
|
|
import { z } from "zod";
|
|
import { ObjectMaskFormValuesType, Polygon } from "@/types/canvas";
|
|
import PolygonEditControls from "./PolygonEditControls";
|
|
import { FaCheckCircle } from "react-icons/fa";
|
|
import { flattenPoints, interpolatePoints } from "@/utils/canvasUtil";
|
|
import axios from "axios";
|
|
import { toast } from "sonner";
|
|
import { Toaster } from "../ui/sonner";
|
|
import ActivityIndicator from "../indicators/activity-indicator";
|
|
import { useTranslation } from "react-i18next";
|
|
import { getTranslatedLabel } from "@/utils/i18n";
|
|
import NameAndIdFields from "../input/NameAndIdFields";
|
|
import { Switch } from "../ui/switch";
|
|
import { useObjectMaskState } from "@/api/ws";
|
|
|
|
type ObjectMaskEditPaneProps = {
|
|
polygons?: Polygon[];
|
|
setPolygons: React.Dispatch<React.SetStateAction<Polygon[]>>;
|
|
activePolygonIndex?: number;
|
|
scaledWidth?: number;
|
|
scaledHeight?: number;
|
|
isLoading: boolean;
|
|
setIsLoading: React.Dispatch<React.SetStateAction<boolean>>;
|
|
onSave?: () => void;
|
|
onCancel?: () => void;
|
|
snapPoints: boolean;
|
|
setSnapPoints: React.Dispatch<React.SetStateAction<boolean>>;
|
|
editingProfile?: string | null;
|
|
};
|
|
|
|
export default function ObjectMaskEditPane({
|
|
polygons,
|
|
setPolygons,
|
|
activePolygonIndex,
|
|
scaledWidth,
|
|
scaledHeight,
|
|
isLoading,
|
|
setIsLoading,
|
|
onSave,
|
|
onCancel,
|
|
snapPoints,
|
|
setSnapPoints,
|
|
editingProfile,
|
|
}: ObjectMaskEditPaneProps) {
|
|
const { t } = useTranslation(["views/settings"]);
|
|
const { data: config, mutate: updateConfig } =
|
|
useSWR<FrigateConfig>("config");
|
|
|
|
const polygon = useMemo(() => {
|
|
if (polygons && activePolygonIndex !== undefined) {
|
|
return polygons[activePolygonIndex];
|
|
} else {
|
|
return null;
|
|
}
|
|
}, [polygons, activePolygonIndex]);
|
|
|
|
const { send: sendObjectMaskState } = useObjectMaskState(
|
|
polygon?.camera || "",
|
|
polygon?.name || "",
|
|
);
|
|
|
|
const cameraConfig = useMemo(() => {
|
|
if (polygon?.camera && config) {
|
|
return config.cameras[polygon.camera];
|
|
}
|
|
}, [polygon, config]);
|
|
|
|
const defaultName = useMemo(() => {
|
|
if (!polygons) {
|
|
return "";
|
|
}
|
|
|
|
const count = polygons.filter((poly) => poly.type == "object_mask").length;
|
|
|
|
return t("masksAndZones.objectMaskLabel", {
|
|
number: count,
|
|
});
|
|
}, [polygons, t]);
|
|
|
|
const defaultId = useMemo(() => {
|
|
if (!polygons) {
|
|
return "";
|
|
}
|
|
|
|
const count = polygons.filter((poly) => poly.type == "object_mask").length;
|
|
|
|
return `object_mask_${count}`;
|
|
}, [polygons]);
|
|
|
|
const formSchema = z.object({
|
|
name: z
|
|
.string()
|
|
.min(1, {
|
|
message: t("masksAndZones.form.id.error.mustNotBeEmpty"),
|
|
})
|
|
.refine(
|
|
(value: string) => {
|
|
// When editing, allow the same name
|
|
if (polygon?.name && value === polygon.name) {
|
|
return true;
|
|
}
|
|
// Check if mask ID already exists in global masks or filter masks
|
|
const globalMaskIds = Object.keys(cameraConfig?.objects.mask || {});
|
|
const filterMaskIds = Object.values(
|
|
cameraConfig?.objects.filters || {},
|
|
).flatMap((filter) => Object.keys(filter.mask || {}));
|
|
return (
|
|
!globalMaskIds.includes(value) && !filterMaskIds.includes(value)
|
|
);
|
|
},
|
|
{
|
|
message: t("masksAndZones.form.id.error.alreadyExists"),
|
|
},
|
|
),
|
|
friendly_name: z.string().min(1, {
|
|
message: t("masksAndZones.form.name.error.mustNotBeEmpty"),
|
|
}),
|
|
enabled: z.boolean(),
|
|
objects: z.string(),
|
|
isFinished: z.boolean().refine(() => polygon?.isFinished === true, {
|
|
message: t("masksAndZones.form.polygonDrawing.error.mustBeFinished"),
|
|
}),
|
|
});
|
|
|
|
const form = useForm<z.infer<typeof formSchema>>({
|
|
resolver: zodResolver(formSchema),
|
|
mode: "onChange",
|
|
defaultValues: {
|
|
name: polygon?.name || defaultId,
|
|
friendly_name: polygon?.friendly_name || defaultName,
|
|
enabled: polygon?.enabled ?? true,
|
|
objects: polygon?.objects[0] ?? "all_labels",
|
|
isFinished: polygon?.isFinished ?? false,
|
|
},
|
|
});
|
|
|
|
const saveToConfig = useCallback(
|
|
async ({
|
|
name: maskId,
|
|
friendly_name,
|
|
enabled,
|
|
objects: form_objects,
|
|
}: ObjectMaskFormValuesType) => {
|
|
if (!scaledWidth || !scaledHeight || !polygon || !cameraConfig) {
|
|
return;
|
|
}
|
|
|
|
const coordinates = flattenPoints(
|
|
interpolatePoints(polygon.points, scaledWidth, scaledHeight, 1, 1),
|
|
).join(",");
|
|
|
|
const editingMask = polygon.name.length > 0;
|
|
const renamingMask = editingMask && maskId !== polygon.name;
|
|
const globalMask = form_objects === "all_labels";
|
|
|
|
// Build the mask configuration
|
|
const maskConfig = {
|
|
friendly_name: friendly_name,
|
|
enabled: enabled,
|
|
coordinates: coordinates,
|
|
};
|
|
|
|
// If renaming, delete the old mask first
|
|
if (renamingMask) {
|
|
try {
|
|
// Determine if old mask was global or per-object
|
|
const wasGlobal =
|
|
polygon.objects.length === 0 || polygon.objects[0] === "all_labels";
|
|
|
|
let oldPath: string;
|
|
if (editingProfile) {
|
|
oldPath = wasGlobal
|
|
? `cameras.${polygon.camera}.profiles.${editingProfile}.objects.mask.${polygon.name}`
|
|
: `cameras.${polygon.camera}.profiles.${editingProfile}.objects.filters.${polygon.objects[0]}.mask.${polygon.name}`;
|
|
} else {
|
|
oldPath = wasGlobal
|
|
? `cameras.${polygon.camera}.objects.mask.${polygon.name}`
|
|
: `cameras.${polygon.camera}.objects.filters.${polygon.objects[0]}.mask.${polygon.name}`;
|
|
}
|
|
|
|
await axios.put(`config/set?${oldPath}`, {
|
|
requires_restart: 0,
|
|
});
|
|
} catch {
|
|
toast.error(t("toast.save.error.noMessage", { ns: "common" }), {
|
|
position: "top-center",
|
|
});
|
|
setIsLoading(false);
|
|
return;
|
|
}
|
|
}
|
|
|
|
// Build config path based on profile mode
|
|
const objectsSection = globalMask
|
|
? { objects: { mask: { [maskId]: maskConfig } } }
|
|
: {
|
|
objects: {
|
|
filters: { [form_objects]: { mask: { [maskId]: maskConfig } } },
|
|
},
|
|
};
|
|
|
|
const cameraData = editingProfile
|
|
? { profiles: { [editingProfile]: objectsSection } }
|
|
: objectsSection;
|
|
|
|
const updateTopic = editingProfile
|
|
? undefined
|
|
: `config/cameras/${polygon.camera}/objects`;
|
|
|
|
const configBody = {
|
|
config_data: {
|
|
cameras: {
|
|
[polygon.camera]: cameraData,
|
|
},
|
|
},
|
|
requires_restart: 0,
|
|
update_topic: updateTopic,
|
|
};
|
|
|
|
axios
|
|
.put("config/set", configBody)
|
|
.then((res) => {
|
|
if (res.status === 200) {
|
|
toast.success(
|
|
t("masksAndZones.objectMasks.toast.success.title", {
|
|
polygonName: friendly_name || maskId,
|
|
}),
|
|
{
|
|
position: "top-center",
|
|
},
|
|
);
|
|
updateConfig();
|
|
// Only publish WS state for base config
|
|
if (!editingProfile) {
|
|
sendObjectMaskState(enabled ? "ON" : "OFF");
|
|
}
|
|
} else {
|
|
toast.error(
|
|
t("toast.save.error.title", {
|
|
errorMessage: res.statusText,
|
|
ns: "common",
|
|
}),
|
|
{
|
|
position: "top-center",
|
|
},
|
|
);
|
|
}
|
|
})
|
|
.catch((error) => {
|
|
const errorMessage =
|
|
error.response?.data?.message ||
|
|
error.response?.data?.detail ||
|
|
"Unknown error";
|
|
toast.error(
|
|
t("toast.save.error.title", {
|
|
errorMessage,
|
|
ns: "common",
|
|
}),
|
|
{
|
|
position: "top-center",
|
|
},
|
|
);
|
|
})
|
|
.finally(() => {
|
|
setIsLoading(false);
|
|
});
|
|
},
|
|
[
|
|
updateConfig,
|
|
polygon,
|
|
scaledWidth,
|
|
scaledHeight,
|
|
setIsLoading,
|
|
cameraConfig,
|
|
t,
|
|
sendObjectMaskState,
|
|
editingProfile,
|
|
],
|
|
);
|
|
|
|
function onSubmit(values: z.infer<typeof formSchema>) {
|
|
if (activePolygonIndex === undefined || !values || !polygons) {
|
|
return;
|
|
}
|
|
setIsLoading(true);
|
|
|
|
saveToConfig(values as ObjectMaskFormValuesType);
|
|
if (onSave) {
|
|
onSave();
|
|
}
|
|
}
|
|
|
|
useEffect(() => {
|
|
document.title = t("masksAndZones.objectMasks.documentTitle");
|
|
}, [t]);
|
|
|
|
if (!polygon) {
|
|
return;
|
|
}
|
|
|
|
return (
|
|
<>
|
|
<Toaster position="top-center" closeButton={true} />
|
|
<Heading as="h3" className="my-2">
|
|
{polygon.name.length
|
|
? t("masksAndZones.objectMasks.edit")
|
|
: t("masksAndZones.objectMasks.add")}
|
|
</Heading>
|
|
<div className="my-2 text-sm text-muted-foreground">
|
|
<p>{t("masksAndZones.objectMasks.context")}</p>
|
|
</div>
|
|
<Separator className="my-3 bg-secondary" />
|
|
{polygons && activePolygonIndex !== undefined && (
|
|
<div className="my-2 flex w-full flex-row justify-between text-sm">
|
|
<div className="my-1 inline-flex">
|
|
{t("masksAndZones.objectMasks.point", {
|
|
count: polygons[activePolygonIndex].points.length,
|
|
})}
|
|
{polygons[activePolygonIndex].isFinished && (
|
|
<FaCheckCircle className="ml-2 size-5" />
|
|
)}
|
|
</div>
|
|
<PolygonEditControls
|
|
polygons={polygons}
|
|
setPolygons={setPolygons}
|
|
activePolygonIndex={activePolygonIndex}
|
|
snapPoints={snapPoints}
|
|
setSnapPoints={setSnapPoints}
|
|
/>
|
|
</div>
|
|
)}
|
|
<div className="mb-3 text-sm text-muted-foreground">
|
|
{t("masksAndZones.objectMasks.clickDrawPolygon")}
|
|
</div>
|
|
|
|
<Separator className="my-3 bg-secondary" />
|
|
|
|
<FormProvider {...form}>
|
|
<Form {...form}>
|
|
<form
|
|
onSubmit={form.handleSubmit(onSubmit)}
|
|
className="flex flex-1 flex-col space-y-6"
|
|
>
|
|
<div className="space-y-4">
|
|
<NameAndIdFields
|
|
type="object_mask"
|
|
control={form.control}
|
|
nameField="friendly_name"
|
|
idField="name"
|
|
idVisible={(polygon && polygon.name.length > 0) ?? false}
|
|
nameLabel={t("masksAndZones.objectMasks.name.title")}
|
|
nameDescription={t(
|
|
"masksAndZones.objectMasks.name.description",
|
|
)}
|
|
placeholderName={t(
|
|
"masksAndZones.objectMasks.name.placeholder",
|
|
)}
|
|
/>
|
|
<FormField
|
|
control={form.control}
|
|
name="enabled"
|
|
render={({ field }) => (
|
|
<FormItem className="flex flex-row items-center justify-between gap-3">
|
|
<div className="space-y-0.5">
|
|
<FormLabel>
|
|
{t("masksAndZones.masks.enabled.title")}
|
|
</FormLabel>
|
|
<FormDescription>
|
|
{t("masksAndZones.masks.enabled.description")}
|
|
</FormDescription>
|
|
</div>
|
|
<FormControl>
|
|
<Switch
|
|
checked={field.value}
|
|
onCheckedChange={field.onChange}
|
|
/>
|
|
</FormControl>
|
|
</FormItem>
|
|
)}
|
|
/>
|
|
<FormField
|
|
control={form.control}
|
|
name="objects"
|
|
render={({ field }) => (
|
|
<FormItem>
|
|
<FormLabel>
|
|
{t("masksAndZones.objectMasks.objects.title")}
|
|
</FormLabel>
|
|
<Select
|
|
onValueChange={field.onChange}
|
|
defaultValue={field.value}
|
|
disabled={polygon.name.length != 0}
|
|
>
|
|
<FormControl>
|
|
<SelectTrigger>
|
|
<SelectValue placeholder="Select an object type" />
|
|
</SelectTrigger>
|
|
</FormControl>
|
|
<SelectContent>
|
|
<ZoneObjectSelector camera={polygon.camera} />
|
|
</SelectContent>
|
|
</Select>
|
|
<FormDescription>
|
|
{t("masksAndZones.objectMasks.objects.desc")}
|
|
</FormDescription>
|
|
<FormMessage />
|
|
</FormItem>
|
|
)}
|
|
/>
|
|
<FormField
|
|
control={form.control}
|
|
name="isFinished"
|
|
render={() => (
|
|
<FormItem>
|
|
<FormMessage />
|
|
</FormItem>
|
|
)}
|
|
/>
|
|
</div>
|
|
<div className="flex flex-1 flex-col justify-end">
|
|
<div className="flex flex-row gap-2 pt-5">
|
|
<Button
|
|
className="flex flex-1"
|
|
aria-label={t("button.cancel", { ns: "common" })}
|
|
onClick={onCancel}
|
|
>
|
|
{t("button.cancel", { ns: "common" })}
|
|
</Button>
|
|
<Button
|
|
variant="select"
|
|
disabled={isLoading}
|
|
className="flex flex-1"
|
|
aria-label={t("button.save", { ns: "common" })}
|
|
type="submit"
|
|
>
|
|
{isLoading ? (
|
|
<div className="flex flex-row items-center gap-2">
|
|
<ActivityIndicator className="size-4" />
|
|
<span>{t("button.saving", { ns: "common" })}</span>
|
|
</div>
|
|
) : (
|
|
t("button.save", { ns: "common" })
|
|
)}
|
|
</Button>
|
|
</div>
|
|
</div>
|
|
</form>
|
|
</Form>
|
|
</FormProvider>
|
|
</>
|
|
);
|
|
}
|
|
|
|
type ZoneObjectSelectorProps = {
|
|
camera: string;
|
|
};
|
|
|
|
export function ZoneObjectSelector({ camera }: ZoneObjectSelectorProps) {
|
|
const { t } = useTranslation(["views/settings"]);
|
|
const { data: config } = useSWR<FrigateConfig>("config");
|
|
|
|
const cameraConfig = useMemo(() => {
|
|
if (config && camera) {
|
|
return config.cameras[camera];
|
|
}
|
|
}, [config, camera]);
|
|
|
|
const allLabels = useMemo<string[]>(() => {
|
|
if (!config || !cameraConfig) {
|
|
return [];
|
|
}
|
|
|
|
const labels = new Set<string>();
|
|
|
|
Object.values(config.cameras).forEach((camera) => {
|
|
camera.objects.track.forEach((label) => {
|
|
labels.add(label);
|
|
});
|
|
});
|
|
|
|
cameraConfig.objects.track.forEach((label) => {
|
|
labels.add(label);
|
|
});
|
|
|
|
return [...labels].sort();
|
|
}, [config, cameraConfig]);
|
|
|
|
return (
|
|
<>
|
|
<SelectGroup>
|
|
<SelectItem value="all_labels">
|
|
{t("masksAndZones.objectMasks.objects.allObjectTypes")}
|
|
</SelectItem>
|
|
<SelectSeparator className="bg-secondary" />
|
|
{allLabels.map((item) => (
|
|
<SelectItem key={item} value={item}>
|
|
{getTranslatedLabel(item)}
|
|
</SelectItem>
|
|
))}
|
|
</SelectGroup>
|
|
</>
|
|
);
|
|
}
|