frigate/web/src/hooks
Josh Hawkins c93dad9bd9
Camera profile support (#22482)
* 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
2026-03-19 09:47:57 -05:00
..
resize-observer.ts Update frontend to React 19 (#22275) 2026-03-05 07:42:38 -07:00
use-allowed-cameras.ts Debug replay (#22212) 2026-03-04 10:07:34 -06:00
use-api-filter.ts Fixes (#19406) 2025-08-06 22:09:43 -05:00
use-camera-activity.ts fix: variable shadowing silently drops object label updates (#22472) 2026-03-16 06:43:25 -06:00
use-camera-friendly-name.ts Rename nickname to friendly_name (#19782) 2025-08-26 15:29:52 -05:00
use-camera-live-mode.ts Miscellaneous Fixes (0.17 Beta) (#21320) 2025-12-16 22:35:43 -06:00
use-camera-previews.ts Fix fetching of generated preview video (#13498) 2024-09-02 09:18:58 -05:00
use-config-override.ts Camera profile support (#22482) 2026-03-19 09:47:57 -05:00
use-config-schema.ts Full UI configuration (#22151) 2026-02-27 08:55:36 -07:00
use-contextmenu.ts Face UI cleanup (#17472) 2025-03-31 16:49:56 -05:00
use-date-locale.ts UI tweaks and fixes (#22448) 2026-03-15 07:26:23 -05:00
use-date-utils.ts Improve timezone handling (#18257) 2025-05-15 17:13:32 -05:00
use-deep-memo.ts Add status bar provider (#11066) 2024-04-22 08:20:23 -06:00
use-deferred-stream-metadata.ts Update frontend to React 19 (#22275) 2026-03-05 07:42:38 -07:00
use-doc-domain.ts feat: document locale url (#18409) 2025-05-28 06:10:45 -06:00
use-draggable-element.ts Update frontend to React 19 (#22275) 2026-03-05 07:42:38 -07:00
use-event-segment-utils.ts Review card refactor (#20813) 2025-11-05 09:48:47 -06:00
use-fullscreen.ts Update frontend to React 19 (#22275) 2026-03-05 07:42:38 -07:00
use-global-mutate.ts Regenerate genai tracked object descriptions (#13930) 2024-09-24 08:14:51 -06:00
use-history-back.ts Miscellaneous Fixes (#21063) 2025-11-27 07:58:35 -06:00
use-image-loaded.ts Update frontend to React 19 (#22275) 2026-03-05 07:42:38 -07:00
use-is-admin.ts UI viewer role (#16978) 2025-03-08 10:01:08 -06:00
use-is-custom-role.ts Enhance user roles to limit camera access (#20024) 2025-09-12 05:19:29 -06:00
use-keyboard-listener.tsx Make keyboard shortcuts consistent (#20326) 2025-10-02 07:21:37 -06:00
use-motion-segment-utils.ts No recordings indicator on History timeline (#20715) 2025-10-29 08:39:07 -06:00
use-mouse-listener.ts Implement scroll lock for previews (#10180) 2024-03-01 17:34:41 -07:00
use-navigation.ts Add GenAI Backend Streaming and Chat (#22152) 2026-02-27 09:07:30 -07:00
use-optimistic-state.ts Fix optimistic state (#11556) 2024-05-27 07:59:26 -05:00
use-overlay-state.tsx Frontend fixes (#22294) 2026-03-06 13:41:15 -07:00
use-persistence.ts Ensure that persisted state is kept in sync (#12596) 2024-07-24 11:17:32 -06:00
use-polygon-states.ts Replace react-tracked and react-use-websocket with useSyncExternalStore (#22386) 2026-03-11 09:02:51 -05:00
use-press.ts Explore bulk actions (#15307) 2024-12-02 11:12:55 -07:00
use-session-persistence.ts Persist live view muted/unmuted for session only (#12727) 2024-08-09 06:46:39 -06:00
use-stats.ts UI tweaks and fixes (#22448) 2026-03-15 07:26:23 -05:00
use-suggestions.ts Add ability to filter search by time range (#13946) 2024-09-25 10:05:40 -06:00
use-tap-utils.ts Scrolling fixes and motion timeline changes (#10295) 2024-03-06 14:35:10 -07:00
use-timeline-utils.ts Update frontend to React 19 (#22275) 2026-03-05 07:42:38 -07:00
use-timeline-zoom.ts Update frontend to React 19 (#22275) 2026-03-05 07:42:38 -07:00
use-user-interaction.ts Update frontend to React 19 (#22275) 2026-03-05 07:42:38 -07:00
use-user-persistence.ts Frontend fixes (#22309) 2026-03-07 06:43:00 -07:00
use-video-dimensions.ts Update frontend to React 19 (#22275) 2026-03-05 07:42:38 -07:00
use-ws-message-buffer.ts Debug replay (#22212) 2026-03-04 10:07:34 -06:00
use-zone-friendly-name.ts Add zones friend name (#20761) 2025-11-07 08:02:06 -06:00