mirror of
https://github.com/blakeblackshear/frigate.git
synced 2026-03-19 22:58:22 +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
383 lines
12 KiB
TypeScript
383 lines
12 KiB
TypeScript
import { Label } from "@/components/ui/label";
|
|
import { Switch } from "@/components/ui/switch";
|
|
import { ReactNode, useCallback, useContext, useEffect } from "react";
|
|
import { Toaster, toast } from "sonner";
|
|
import { Button } from "../../components/ui/button";
|
|
import useSWR from "swr";
|
|
import { FrigateConfig } from "@/types/frigateConfig";
|
|
import {
|
|
useUserPersistence,
|
|
deleteUserNamespacedKey,
|
|
} from "@/hooks/use-user-persistence";
|
|
import { isSafari } from "react-device-detect";
|
|
import {
|
|
Select,
|
|
SelectContent,
|
|
SelectGroup,
|
|
SelectItem,
|
|
SelectTrigger,
|
|
} from "../../components/ui/select";
|
|
import { useTranslation } from "react-i18next";
|
|
import { AuthContext } from "@/context/auth-context";
|
|
import {
|
|
SettingsGroupCard,
|
|
SPLIT_ROW_CLASS_NAME,
|
|
DESCRIPTION_CLASS_NAME,
|
|
CONTROL_COLUMN_CLASS_NAME,
|
|
} from "@/components/card/SettingsGroupCard";
|
|
import Heading from "@/components/ui/heading";
|
|
|
|
const WEEK_STARTS_ON = ["Sunday", "Monday"];
|
|
|
|
type SwitchSettingRowProps = {
|
|
id: string;
|
|
label: string;
|
|
description: string;
|
|
checked: boolean | undefined;
|
|
onCheckedChange: (checked: boolean | undefined) => void;
|
|
};
|
|
|
|
function SwitchSettingRow({
|
|
id,
|
|
label,
|
|
description,
|
|
checked,
|
|
onCheckedChange,
|
|
}: SwitchSettingRowProps) {
|
|
return (
|
|
<div className={SPLIT_ROW_CLASS_NAME}>
|
|
<div className="space-y-1.5">
|
|
<div className="flex items-center justify-between gap-4 md:block">
|
|
<Label className="cursor-pointer" htmlFor={id}>
|
|
{label}
|
|
</Label>
|
|
<div className="md:hidden">
|
|
<Switch
|
|
id={id}
|
|
checked={checked ?? false}
|
|
onCheckedChange={onCheckedChange}
|
|
/>
|
|
</div>
|
|
</div>
|
|
<p className={DESCRIPTION_CLASS_NAME}>{description}</p>
|
|
</div>
|
|
<div className="hidden w-full md:flex md:max-w-2xl md:items-center">
|
|
<Switch
|
|
id={`${id}-desktop`}
|
|
checked={checked ?? false}
|
|
onCheckedChange={onCheckedChange}
|
|
/>
|
|
</div>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
type ValueSettingRowProps = {
|
|
id: string;
|
|
label: string;
|
|
description: string;
|
|
control: ReactNode;
|
|
};
|
|
|
|
function ValueSettingRow({
|
|
id,
|
|
label,
|
|
description,
|
|
control,
|
|
}: ValueSettingRowProps) {
|
|
return (
|
|
<div className={SPLIT_ROW_CLASS_NAME}>
|
|
<div className="space-y-1.5">
|
|
<Label className="cursor-pointer" htmlFor={id}>
|
|
{label}
|
|
</Label>
|
|
<p className="hidden text-sm text-muted-foreground md:block">
|
|
{description}
|
|
</p>
|
|
</div>
|
|
<div className={`${CONTROL_COLUMN_CLASS_NAME} space-y-1.5`}>
|
|
{control}
|
|
<p className="text-sm text-muted-foreground md:hidden">{description}</p>
|
|
</div>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
export default function UiSettingsView() {
|
|
const { data: config } = useSWR<FrigateConfig>("config");
|
|
const { t } = useTranslation("views/settings");
|
|
const { auth } = useContext(AuthContext);
|
|
const username = auth?.user?.username;
|
|
|
|
const PLAYBACK_RATE_DEFAULT = isSafari ? [0.5, 1, 2] : [0.5, 1, 2, 4, 8, 16];
|
|
|
|
const clearStoredLayouts = useCallback(() => {
|
|
if (!config) {
|
|
return [];
|
|
}
|
|
|
|
Object.entries(config.camera_groups).forEach(async ([cameraName]) => {
|
|
await deleteUserNamespacedKey(`${cameraName}-draggable-layout`, username)
|
|
.then(() => {
|
|
toast.success(
|
|
t("general.toast.success.clearStoredLayout", { cameraName }),
|
|
{
|
|
position: "top-center",
|
|
},
|
|
);
|
|
})
|
|
.catch((error) => {
|
|
const errorMessage =
|
|
error.response?.data?.message ||
|
|
error.response?.data?.detail ||
|
|
"Unknown error";
|
|
toast.error(
|
|
t("general.toast.error.clearStoredLayoutFailed", { errorMessage }),
|
|
{
|
|
position: "top-center",
|
|
},
|
|
);
|
|
});
|
|
});
|
|
}, [config, t, username]);
|
|
|
|
const clearStreamingSettings = useCallback(async () => {
|
|
if (!config) {
|
|
return [];
|
|
}
|
|
|
|
await deleteUserNamespacedKey("streaming-settings", username)
|
|
.then(() => {
|
|
toast.success(t("general.toast.success.clearStreamingSettings"), {
|
|
position: "top-center",
|
|
});
|
|
})
|
|
.catch((error) => {
|
|
const errorMessage =
|
|
error.response?.data?.message ||
|
|
error.response?.data?.detail ||
|
|
"Unknown error";
|
|
toast.error(
|
|
t("general.toast.error.clearStreamingSettingsFailed", {
|
|
errorMessage,
|
|
}),
|
|
{
|
|
position: "top-center",
|
|
},
|
|
);
|
|
});
|
|
}, [config, t, username]);
|
|
|
|
useEffect(() => {
|
|
document.title = t("documentTitle.general");
|
|
}, [t]);
|
|
|
|
const [autoLive, setAutoLive] = useUserPersistence("autoLiveView", true);
|
|
const [cameraNames, setCameraName] = useUserPersistence(
|
|
"displayCameraNames",
|
|
false,
|
|
);
|
|
const [playbackRate, setPlaybackRate] = useUserPersistence("playbackRate", 1);
|
|
const [weekStartsOn, setWeekStartsOn] = useUserPersistence("weekStartsOn", 0);
|
|
const [alertVideos, setAlertVideos] = useUserPersistence("alertVideos", true);
|
|
const [fallbackTimeout, setFallbackTimeout] = useUserPersistence(
|
|
"liveFallbackTimeout",
|
|
3,
|
|
);
|
|
|
|
const liveDashboardSwitchRows = [
|
|
{
|
|
id: "auto-live",
|
|
label: t("general.liveDashboard.automaticLiveView.label"),
|
|
description: t("general.liveDashboard.automaticLiveView.desc"),
|
|
checked: autoLive,
|
|
onCheckedChange: setAutoLive,
|
|
},
|
|
{
|
|
id: "images-only",
|
|
label: t("general.liveDashboard.playAlertVideos.label"),
|
|
description: t("general.liveDashboard.playAlertVideos.desc"),
|
|
checked: alertVideos,
|
|
onCheckedChange: setAlertVideos,
|
|
},
|
|
{
|
|
id: "camera-names",
|
|
label: t("general.liveDashboard.displayCameraNames.label"),
|
|
description: t("general.liveDashboard.displayCameraNames.desc"),
|
|
checked: cameraNames,
|
|
onCheckedChange: setCameraName,
|
|
},
|
|
];
|
|
|
|
return (
|
|
<div className="flex size-full flex-col">
|
|
<Toaster position="top-center" closeButton={true} />
|
|
<div className="scrollbar-container mb-2 mt-2 flex h-full w-full flex-col overflow-y-auto pb-2">
|
|
<Heading as="h4" className="mb-3">
|
|
{t("general.title")}
|
|
</Heading>
|
|
<div className="w-full max-w-5xl space-y-6">
|
|
<SettingsGroupCard title={t("general.liveDashboard.title")}>
|
|
<div className="space-y-6">
|
|
{liveDashboardSwitchRows.map((row) => (
|
|
<SwitchSettingRow key={row.id} {...row} />
|
|
))}
|
|
|
|
<ValueSettingRow
|
|
id="live-fallback-timeout"
|
|
label={t("general.liveDashboard.liveFallbackTimeout.label")}
|
|
description={t(
|
|
"general.liveDashboard.liveFallbackTimeout.desc",
|
|
)}
|
|
control={
|
|
<Select
|
|
value={fallbackTimeout?.toString()}
|
|
onValueChange={(value) =>
|
|
setFallbackTimeout(parseInt(value, 10))
|
|
}
|
|
>
|
|
<SelectTrigger
|
|
id="live-fallback-timeout"
|
|
className="w-full md:w-36"
|
|
>
|
|
{t("time.second", {
|
|
ns: "common",
|
|
time: fallbackTimeout,
|
|
count: fallbackTimeout,
|
|
})}
|
|
</SelectTrigger>
|
|
<SelectContent>
|
|
<SelectGroup>
|
|
{[1, 2, 3, 5, 8, 10, 12, 15].map((timeout) => (
|
|
<SelectItem
|
|
key={timeout}
|
|
className="cursor-pointer"
|
|
value={timeout.toString()}
|
|
>
|
|
{t("time.second", {
|
|
ns: "common",
|
|
time: timeout,
|
|
count: timeout,
|
|
})}
|
|
</SelectItem>
|
|
))}
|
|
</SelectGroup>
|
|
</SelectContent>
|
|
</Select>
|
|
}
|
|
/>
|
|
|
|
<ValueSettingRow
|
|
id="stored-layouts-clear"
|
|
label={t("general.storedLayouts.title")}
|
|
description={t("general.storedLayouts.desc")}
|
|
control={
|
|
<Button
|
|
id="stored-layouts-clear"
|
|
aria-label={t("general.storedLayouts.clearAll")}
|
|
className="w-full md:w-auto"
|
|
onClick={clearStoredLayouts}
|
|
>
|
|
{t("general.storedLayouts.clearAll")}
|
|
</Button>
|
|
}
|
|
/>
|
|
|
|
<ValueSettingRow
|
|
id="camera-group-streaming-clear"
|
|
label={t("general.cameraGroupStreaming.title")}
|
|
description={t("general.cameraGroupStreaming.desc")}
|
|
control={
|
|
<Button
|
|
id="camera-group-streaming-clear"
|
|
aria-label={t("general.cameraGroupStreaming.clearAll")}
|
|
className="w-full md:w-auto"
|
|
onClick={clearStreamingSettings}
|
|
>
|
|
{t("general.cameraGroupStreaming.clearAll")}
|
|
</Button>
|
|
}
|
|
/>
|
|
</div>
|
|
</SettingsGroupCard>
|
|
|
|
<SettingsGroupCard title={t("general.recordingsViewer.title")}>
|
|
<ValueSettingRow
|
|
id="default-playback-rate"
|
|
label={t("general.recordingsViewer.defaultPlaybackRate.label")}
|
|
description={t(
|
|
"general.recordingsViewer.defaultPlaybackRate.desc",
|
|
)}
|
|
control={
|
|
<Select
|
|
value={playbackRate?.toString()}
|
|
onValueChange={(value) => setPlaybackRate(parseFloat(value))}
|
|
>
|
|
<SelectTrigger
|
|
id="default-playback-rate"
|
|
className="w-full md:w-20"
|
|
>
|
|
{`${playbackRate}x`}
|
|
</SelectTrigger>
|
|
<SelectContent>
|
|
<SelectGroup>
|
|
{PLAYBACK_RATE_DEFAULT.map((rate) => (
|
|
<SelectItem
|
|
key={rate}
|
|
className="cursor-pointer"
|
|
value={rate.toString()}
|
|
>
|
|
{rate}x
|
|
</SelectItem>
|
|
))}
|
|
</SelectGroup>
|
|
</SelectContent>
|
|
</Select>
|
|
}
|
|
/>
|
|
</SettingsGroupCard>
|
|
|
|
<SettingsGroupCard title={t("general.calendar.title")}>
|
|
<ValueSettingRow
|
|
id="first-weekday"
|
|
label={t("general.calendar.firstWeekday.label")}
|
|
description={t("general.calendar.firstWeekday.desc")}
|
|
control={
|
|
<Select
|
|
value={weekStartsOn?.toString()}
|
|
onValueChange={(value) =>
|
|
setWeekStartsOn(parseInt(value, 10))
|
|
}
|
|
>
|
|
<SelectTrigger id="first-weekday" className="w-full md:w-32">
|
|
{t(
|
|
"general.calendar.firstWeekday." +
|
|
WEEK_STARTS_ON[weekStartsOn ?? 0].toLowerCase(),
|
|
)}
|
|
</SelectTrigger>
|
|
<SelectContent>
|
|
<SelectGroup>
|
|
{WEEK_STARTS_ON.map((day, index) => (
|
|
<SelectItem
|
|
key={index}
|
|
className="cursor-pointer"
|
|
value={index.toString()}
|
|
>
|
|
{t(
|
|
"general.calendar.firstWeekday." +
|
|
day.toLowerCase(),
|
|
)}
|
|
</SelectItem>
|
|
))}
|
|
</SelectGroup>
|
|
</SelectContent>
|
|
</Select>
|
|
}
|
|
/>
|
|
</SettingsGroupCard>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
);
|
|
}
|