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
233 lines
7.2 KiB
TypeScript
233 lines
7.2 KiB
TypeScript
// Generic Switches Widget - Reusable component for selecting from any list of entities
|
|
import { WidgetProps } from "@rjsf/utils";
|
|
import { useMemo, useState } from "react";
|
|
import { Switch } from "@/components/ui/switch";
|
|
import { Button } from "@/components/ui/button";
|
|
import { Input } from "@/components/ui/input";
|
|
import {
|
|
Collapsible,
|
|
CollapsibleContent,
|
|
CollapsibleTrigger,
|
|
} from "@/components/ui/collapsible";
|
|
import { LuChevronDown, LuChevronRight } from "react-icons/lu";
|
|
import { CameraConfig, FrigateConfig } from "@/types/frigateConfig";
|
|
import { ConfigFormContext } from "@/types/configForm";
|
|
import { cn } from "@/lib/utils";
|
|
|
|
type FormContext = Pick<
|
|
ConfigFormContext,
|
|
| "cameraValue"
|
|
| "globalValue"
|
|
| "fullCameraConfig"
|
|
| "fullConfig"
|
|
| "formData"
|
|
| "t"
|
|
| "level"
|
|
> & {
|
|
fullCameraConfig?: CameraConfig;
|
|
fullConfig?: FrigateConfig;
|
|
};
|
|
|
|
export type { FormContext };
|
|
|
|
export type SwitchesWidgetOptions = {
|
|
/** Function to extract available entities from context */
|
|
getEntities: (context: FormContext) => string[];
|
|
/** Function to get display label for an entity (e.g., translate, get friendly name) */
|
|
getDisplayLabel?: (entity: string, context?: FormContext) => string;
|
|
/** i18n key prefix (e.g., "objectLabels", "zoneNames") */
|
|
i18nKey: string;
|
|
/** Translation namespace (default: "views/settings") */
|
|
namespace?: string;
|
|
/** Optional class name for the list container */
|
|
listClassName?: string;
|
|
/** Enable search input to filter the list */
|
|
enableSearch?: boolean;
|
|
};
|
|
|
|
function normalizeValue(value: unknown): string[] {
|
|
if (Array.isArray(value)) {
|
|
return value.filter((item): item is string => typeof item === "string");
|
|
}
|
|
|
|
if (typeof value === "string" && value.trim().length > 0) {
|
|
return [value.trim()];
|
|
}
|
|
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* Generic switches widget for selecting from any list of entities (objects, zones, etc.)
|
|
*
|
|
* @example
|
|
* // In uiSchema:
|
|
* "track": {
|
|
* "ui:widget": "switches",
|
|
* "ui:options": {
|
|
* "getEntities": (context) => [...],
|
|
* "i18nKey": "objectLabels"
|
|
* }
|
|
* }
|
|
*/
|
|
export function SwitchesWidget(props: WidgetProps) {
|
|
const { value, disabled, readonly, onChange, formContext, id, registry } =
|
|
props;
|
|
|
|
// Get configuration from widget options
|
|
const i18nKey = useMemo(
|
|
() => (props.options?.i18nKey as string | undefined) || "entities",
|
|
[props.options],
|
|
);
|
|
const namespace = useMemo(
|
|
() => (props.options?.namespace as string | undefined) || "views/settings",
|
|
[props.options],
|
|
);
|
|
|
|
// Try to get formContext from direct prop, options, or registry
|
|
const context = useMemo(
|
|
() =>
|
|
(formContext as FormContext | undefined) ||
|
|
(props.options?.formContext as FormContext | undefined) ||
|
|
(registry?.formContext as FormContext | undefined),
|
|
[formContext, props.options, registry],
|
|
);
|
|
|
|
const availableEntities = useMemo(() => {
|
|
const getEntities =
|
|
(props.options?.getEntities as
|
|
| ((context: FormContext) => string[])
|
|
| undefined) || (() => []);
|
|
if (context) {
|
|
return getEntities(context);
|
|
}
|
|
return [];
|
|
}, [context, props.options]);
|
|
|
|
const getDisplayLabel = useMemo(
|
|
() =>
|
|
(props.options?.getDisplayLabel as
|
|
| ((entity: string, context?: FormContext) => string)
|
|
| undefined) || ((entity: string) => entity),
|
|
[props.options],
|
|
);
|
|
|
|
const listClassName = useMemo(
|
|
() => props.options?.listClassName as string | undefined,
|
|
[props.options],
|
|
);
|
|
|
|
const enableSearch = useMemo(
|
|
() => props.options?.enableSearch as boolean | undefined,
|
|
[props.options],
|
|
);
|
|
|
|
const selectedEntities = useMemo(() => normalizeValue(value), [value]);
|
|
const [isOpen, setIsOpen] = useState(selectedEntities.length > 0);
|
|
const [searchTerm, setSearchTerm] = useState("");
|
|
|
|
const filteredEntities = useMemo(() => {
|
|
if (!enableSearch || !searchTerm.trim()) {
|
|
return availableEntities;
|
|
}
|
|
const term = searchTerm.toLowerCase();
|
|
return availableEntities.filter((entity) => {
|
|
const displayLabel = getDisplayLabel(entity, context);
|
|
return displayLabel.toLowerCase().includes(term);
|
|
});
|
|
}, [availableEntities, searchTerm, enableSearch, getDisplayLabel, context]);
|
|
|
|
const toggleEntity = (entity: string, enabled: boolean) => {
|
|
if (enabled) {
|
|
onChange([...selectedEntities, entity]);
|
|
} else {
|
|
onChange(selectedEntities.filter((item) => item !== entity));
|
|
}
|
|
};
|
|
|
|
const t = context?.t;
|
|
const summary = t
|
|
? t(`configForm.${i18nKey}.summary`, {
|
|
ns: namespace,
|
|
defaultValue: "{{count}} selected",
|
|
count: selectedEntities.length,
|
|
})
|
|
: `${selectedEntities.length} selected`;
|
|
|
|
const emptyMessage = t
|
|
? t(`configForm.${i18nKey}.empty`, {
|
|
ns: namespace,
|
|
defaultValue: "No items available",
|
|
})
|
|
: "No items available";
|
|
|
|
return (
|
|
<Collapsible open={isOpen} onOpenChange={setIsOpen}>
|
|
<div className="space-y-3">
|
|
<CollapsibleTrigger asChild>
|
|
<Button
|
|
type="button"
|
|
variant="ghost"
|
|
className="w-full justify-start gap-2 pl-0"
|
|
disabled={disabled || readonly}
|
|
>
|
|
{isOpen ? (
|
|
<LuChevronDown className="h-4 w-4" />
|
|
) : (
|
|
<LuChevronRight className="h-4 w-4" />
|
|
)}
|
|
{summary}
|
|
</Button>
|
|
</CollapsibleTrigger>
|
|
|
|
<CollapsibleContent className="rounded-lg bg-secondary p-2 pr-0 md:max-w-md">
|
|
{availableEntities.length === 0 ? (
|
|
<div className="text-sm text-muted-foreground">{emptyMessage}</div>
|
|
) : (
|
|
<>
|
|
{enableSearch && (
|
|
<div className="mr-2">
|
|
<Input
|
|
type="text"
|
|
placeholder={t?.("configForm.searchPlaceholder", {
|
|
ns: "views/settings",
|
|
defaultValue: "Search...",
|
|
})}
|
|
value={searchTerm}
|
|
onChange={(e) => setSearchTerm(e.target.value)}
|
|
className="mb-2"
|
|
/>
|
|
</div>
|
|
)}
|
|
<div className={cn("grid gap-2", listClassName)}>
|
|
{filteredEntities.map((entity) => {
|
|
const checked = selectedEntities.includes(entity);
|
|
const displayLabel = getDisplayLabel(entity, context);
|
|
return (
|
|
<div
|
|
key={entity}
|
|
className="flex items-center justify-between rounded-md px-3 py-0"
|
|
>
|
|
<label htmlFor={`${id}-${entity}`} className="text-sm">
|
|
{displayLabel}
|
|
</label>
|
|
<Switch
|
|
id={`${id}-${entity}`}
|
|
checked={checked}
|
|
disabled={disabled || readonly}
|
|
onCheckedChange={(value) =>
|
|
toggleEntity(entity, !!value)
|
|
}
|
|
/>
|
|
</div>
|
|
);
|
|
})}
|
|
</div>
|
|
</>
|
|
)}
|
|
</CollapsibleContent>
|
|
</div>
|
|
</Collapsible>
|
|
);
|
|
}
|