mirror of
https://github.com/blakeblackshear/frigate.git
synced 2026-03-18 22:28:23 +03:00
* use react-jsonschema-form for UI config * don't use properties wrapper when generating config i18n json * configure for full i18n support * section fields * add descriptions to all fields for i18n * motion i18n * fix nullable fields * sanitize internal fields * add switches widgets and use friendly names * fix nullable schema entries * ensure update_topic is added to api calls this needs further backend implementation to work correctly * add global sections, camera config overrides, and reset button * i18n * add reset logic to global config view * tweaks * fix sections and live validation * fix validation for schema objects that can be null * generic and custom per-field validation * improve generic error validation messages * remove show advanced fields switch * tweaks * use shadcn theme * fix array field template * i18n tweaks * remove collapsible around root section * deep merge schema for advanced fields * add array field item template and fix ffmpeg section * add missing i18n keys * tweaks * comment out api call for testing * add config groups as a separate i18n namespace * add descriptions to all pydantic fields * make titles more concise * new titles as i18n * update i18n config generation script to use json schema * tweaks * tweaks * rebase * clean up * form tweaks * add wildcards and fix object filter fields * add field template for additionalproperties schema objects * improve typing * add section description from schema and clarify global vs camera level descriptions * separate and consolidate global and camera i18n namespaces * clean up now obsolete namespaces * tweaks * refactor sections and overrides * add ability to render components before and after fields * fix titles * chore(sections): remove legacy single-section components replaced by template * refactor configs to use individual files with a template * fix review description * apply hidden fields after ui schema * move util * remove unused i18n * clean up error messages * fix fast refresh * add custom validation and use it for ffmpeg input roles * update nav tree * remove unused * re-add override and modified indicators * mark pending changes and add confirmation dialog for resets * fix red unsaved dot * tweaks * add docs links, readonly keys, and restart required per field * add special case and comments for global motion section * add section form special cases * combine review sections * tweaks * add audio labels endpoint * add audio label switches and input to filter list * fix type * remove key from config when resetting to default/global * don't show description for new key/val fields * tweaks * spacing tweaks * add activity indicator and scrollbar tweaks * add docs to filter fields * wording changes * fix global ffmpeg section * add review classification zones to review form * add backend endpoint and frontend widget for ffmpeg presets and manual args * improve wording * hide descriptions for additional properties arrays * add warning log about incorrectly nested model config * spacing and language tweaks * fix i18n keys * networking section docs and description * small wording tweaks * add layout grid field * refactor with shared utilities * field order * add individual detectors to schema add detector titles and descriptions (docstrings in pydantic are used for descriptions) and add i18n keys to globals * clean up detectors section and i18n * don't save model config back to yaml when saving detectors * add full detectors config to api model dump works around the way we use detector plugins so we can have the full detector config for the frontend * add restart button to toast when restart is required * add ui option to remove inner cards * fix buttons * section tweaks * don't zoom into text on mobile * make buttons sticky at bottom of sections * small tweaks * highlight label of changed fields * add null to enum list when unwrapping * refactor to shared utils and add save all button * add undo all button * add RJSF to dictionary * consolidate utils * preserve form data when changing cameras * add mono fonts * add popover to show what fields will be saved * fix mobile menu not re-rendering with unsaved dots * tweaks * fix logger and env vars config section saving use escaped periods in keys to retain them in the config file (eg "frigate.embeddings") * add timezone widget * role map field with validation * fix validation for model section * add another hidden field * add footer message for required restart * use rjsf for notifications view * fix config saving * add replace rules field * default column layout and add field sizing * clean up field template * refactor profile settings to match rjsf forms * tweaks * refactor frigate+ view and make tweaks to sections * show frigate+ model info in detection model settings when using a frigate+ model * update restartRequired for all fields * fix restart fields * tweaks and add ability enable disabled cameras more backend changes required * require restart when enabling camera that is disabled in config * disable save when form is invalid * refactor ffmpeg section for readability * change label * clean up camera inputs fields * misc tweaks to ffmpeg section - add raw paths endpoint to ensure credentials get saved - restart required tooltip * maintenance settings tweaks * don't mutate with lodash * fix description re-rendering for nullable object fields * hide reindex field * update rjsf * add frigate+ description to settings pane * disable save all when any section is invalid * show translated field name in validation error pane * clean up * remove unused * fix genai merge * fix genai
510 lines
19 KiB
TypeScript
510 lines
19 KiB
TypeScript
import Heading from "@/components/ui/heading";
|
|
import { useCallback, useContext, useEffect, useState } from "react";
|
|
import { Toaster } from "@/components/ui/sonner";
|
|
import ActivityIndicator from "@/components/indicators/activity-indicator";
|
|
import { toast } from "sonner";
|
|
import useSWR from "swr";
|
|
import axios from "axios";
|
|
import { FrigateConfig } from "@/types/frigateConfig";
|
|
import { CheckCircle2, XCircle } from "lucide-react";
|
|
import { Trans, useTranslation } from "react-i18next";
|
|
import { IoIosWarning } from "react-icons/io";
|
|
import { Button } from "@/components/ui/button";
|
|
import { Link } from "react-router-dom";
|
|
import { LuExternalLink } from "react-icons/lu";
|
|
import { StatusBarMessagesContext } from "@/context/statusbar-provider";
|
|
import {
|
|
Select,
|
|
SelectContent,
|
|
SelectGroup,
|
|
SelectItem,
|
|
SelectTrigger,
|
|
} from "@/components/ui/select";
|
|
import { useDocDomain } from "@/hooks/use-doc-domain";
|
|
import { CameraNameLabel } from "@/components/camera/FriendlyNameLabel";
|
|
import {
|
|
SettingsGroupCard,
|
|
SplitCardRow,
|
|
} from "@/components/card/SettingsGroupCard";
|
|
import FrigatePlusCurrentModelSummary from "@/views/settings/components/FrigatePlusCurrentModelSummary";
|
|
|
|
type FrigatePlusModel = {
|
|
id: string;
|
|
type: string;
|
|
name: string;
|
|
isBaseModel: boolean;
|
|
supportedDetectors: string[];
|
|
trainDate: string;
|
|
baseModel: string;
|
|
width: number;
|
|
height: number;
|
|
};
|
|
|
|
type FrigatePlusSettings = {
|
|
model: {
|
|
id?: string;
|
|
};
|
|
};
|
|
|
|
type FrigateSettingsViewProps = {
|
|
setUnsavedChanges: React.Dispatch<React.SetStateAction<boolean>>;
|
|
};
|
|
|
|
export default function FrigatePlusSettingsView({
|
|
setUnsavedChanges,
|
|
}: FrigateSettingsViewProps) {
|
|
const { t } = useTranslation("views/settings");
|
|
const { getLocaleDocUrl } = useDocDomain();
|
|
const { data: config, mutate: updateConfig } =
|
|
useSWR<FrigateConfig>("config");
|
|
const [changedValue, setChangedValue] = useState(false);
|
|
const [isLoading, setIsLoading] = useState(false);
|
|
|
|
const { addMessage, removeMessage } = useContext(StatusBarMessagesContext)!;
|
|
|
|
const [frigatePlusSettings, setFrigatePlusSettings] =
|
|
useState<FrigatePlusSettings>({
|
|
model: {
|
|
id: undefined,
|
|
},
|
|
});
|
|
|
|
const [origPlusSettings, setOrigPlusSettings] = useState<FrigatePlusSettings>(
|
|
{
|
|
model: {
|
|
id: undefined,
|
|
},
|
|
},
|
|
);
|
|
|
|
const { data: availableModels = {} } = useSWR<
|
|
Record<string, FrigatePlusModel>
|
|
>("/plus/models", {
|
|
fallbackData: {},
|
|
fetcher: async (url) => {
|
|
const res = await axios.get(url, { withCredentials: true });
|
|
return res.data.reduce(
|
|
(obj: Record<string, FrigatePlusModel>, model: FrigatePlusModel) => {
|
|
obj[model.id] = model;
|
|
return obj;
|
|
},
|
|
{},
|
|
);
|
|
},
|
|
});
|
|
|
|
useEffect(() => {
|
|
if (config) {
|
|
if (frigatePlusSettings?.model.id == undefined) {
|
|
setFrigatePlusSettings({
|
|
model: {
|
|
id: config.model.plus?.id,
|
|
},
|
|
});
|
|
}
|
|
|
|
setOrigPlusSettings({
|
|
model: {
|
|
id: config.model.plus?.id,
|
|
},
|
|
});
|
|
}
|
|
// we know that these deps are correct
|
|
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
}, [config]);
|
|
|
|
const handleFrigatePlusConfigChange = (
|
|
newConfig: Partial<FrigatePlusSettings>,
|
|
) => {
|
|
setFrigatePlusSettings((prevConfig) => ({
|
|
model: {
|
|
...prevConfig.model,
|
|
...newConfig.model,
|
|
},
|
|
}));
|
|
setUnsavedChanges(true);
|
|
setChangedValue(true);
|
|
};
|
|
|
|
const saveToConfig = useCallback(async () => {
|
|
setIsLoading(true);
|
|
|
|
axios
|
|
.put(`config/set?model.path=plus://${frigatePlusSettings.model.id}`, {
|
|
requires_restart: 0,
|
|
})
|
|
.then((res) => {
|
|
if (res.status === 200) {
|
|
toast.success(t("frigatePlus.toast.success"), {
|
|
position: "top-center",
|
|
});
|
|
setChangedValue(false);
|
|
updateConfig();
|
|
} else {
|
|
toast.error(
|
|
t("frigatePlus.toast.error", { errorMessage: res.statusText }),
|
|
{
|
|
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(() => {
|
|
addMessage(
|
|
"plus_restart",
|
|
t("frigatePlus.restart_required"),
|
|
undefined,
|
|
"plus_restart",
|
|
);
|
|
setIsLoading(false);
|
|
});
|
|
}, [updateConfig, addMessage, frigatePlusSettings, t]);
|
|
|
|
const onCancel = useCallback(() => {
|
|
setFrigatePlusSettings(origPlusSettings);
|
|
setChangedValue(false);
|
|
removeMessage("plus_settings", "plus_settings");
|
|
}, [origPlusSettings, removeMessage]);
|
|
|
|
useEffect(() => {
|
|
if (changedValue) {
|
|
addMessage(
|
|
"plus_settings",
|
|
t("frigatePlus.unsavedChanges"),
|
|
undefined,
|
|
"plus_settings",
|
|
);
|
|
} else {
|
|
removeMessage("plus_settings", "plus_settings");
|
|
}
|
|
// we know that these deps are correct
|
|
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
}, [changedValue]);
|
|
|
|
useEffect(() => {
|
|
document.title = t("documentTitle.frigatePlus");
|
|
}, [t]);
|
|
|
|
const needCleanSnapshots = () => {
|
|
if (!config) {
|
|
return false;
|
|
}
|
|
return Object.values(config.cameras).some(
|
|
(camera) => camera.snapshots.enabled && !camera.snapshots.clean_copy,
|
|
);
|
|
};
|
|
|
|
if (!config) {
|
|
return <ActivityIndicator />;
|
|
}
|
|
|
|
return (
|
|
<div className="flex size-full flex-col md:flex-row">
|
|
<Toaster position="top-center" closeButton={true} />
|
|
<div className="mt-2 flex h-full w-full flex-col">
|
|
<div className="scrollbar-container flex-1 overflow-y-auto">
|
|
<div className="w-full max-w-5xl space-y-6">
|
|
<div className="flex flex-col gap-0">
|
|
<Heading as="h4" className="mb-2">
|
|
{t("frigatePlus.title")}
|
|
</Heading>
|
|
|
|
<p className="text-sm text-muted-foreground">
|
|
{t("frigatePlus.description")}
|
|
</p>
|
|
</div>
|
|
|
|
<div className="space-y-6">
|
|
<SettingsGroupCard title={t("frigatePlus.cardTitles.api")}>
|
|
<SplitCardRow
|
|
label={t("frigatePlus.apiKey.title")}
|
|
description={
|
|
<>
|
|
<p>{t("frigatePlus.apiKey.desc")}</p>
|
|
{!config?.model.plus && (
|
|
<div className="mt-2 flex items-center text-primary-variant">
|
|
<Link
|
|
to="https://frigate.video/plus"
|
|
target="_blank"
|
|
rel="noopener noreferrer"
|
|
className="inline"
|
|
>
|
|
{t("frigatePlus.apiKey.plusLink")}
|
|
<LuExternalLink className="ml-2 inline-flex size-3" />
|
|
</Link>
|
|
</div>
|
|
)}
|
|
</>
|
|
}
|
|
content={
|
|
<div className="flex items-center gap-2">
|
|
{config?.plus?.enabled ? (
|
|
<CheckCircle2 className="h-5 w-5 text-green-500" />
|
|
) : (
|
|
<XCircle className="h-5 w-5 text-red-500" />
|
|
)}
|
|
<span className="text-sm">
|
|
{config?.plus?.enabled
|
|
? t("frigatePlus.apiKey.validated")
|
|
: t("frigatePlus.apiKey.notValidated")}
|
|
</span>
|
|
</div>
|
|
}
|
|
/>
|
|
</SettingsGroupCard>
|
|
|
|
{config?.model.plus && (
|
|
<FrigatePlusCurrentModelSummary plusModel={config.model.plus} />
|
|
)}
|
|
|
|
{config?.model.plus && (
|
|
<SettingsGroupCard
|
|
title={t("frigatePlus.cardTitles.otherModels")}
|
|
>
|
|
<SplitCardRow
|
|
label={t("frigatePlus.modelInfo.availableModels")}
|
|
description={
|
|
<Trans ns="views/settings">
|
|
frigatePlus.modelInfo.modelSelect
|
|
</Trans>
|
|
}
|
|
content={
|
|
<Select
|
|
value={frigatePlusSettings.model.id}
|
|
onValueChange={(value) =>
|
|
handleFrigatePlusConfigChange({
|
|
model: { id: value as string },
|
|
})
|
|
}
|
|
>
|
|
{frigatePlusSettings.model.id &&
|
|
availableModels?.[frigatePlusSettings.model.id] ? (
|
|
<SelectTrigger className="w-full">
|
|
{new Date(
|
|
availableModels[
|
|
frigatePlusSettings.model.id
|
|
].trainDate,
|
|
).toLocaleString() +
|
|
" " +
|
|
availableModels[frigatePlusSettings.model.id]
|
|
.baseModel +
|
|
" (" +
|
|
(availableModels[frigatePlusSettings.model.id]
|
|
.isBaseModel
|
|
? t(
|
|
"frigatePlus.modelInfo.plusModelType.baseModel",
|
|
)
|
|
: t(
|
|
"frigatePlus.modelInfo.plusModelType.userModel",
|
|
)) +
|
|
") " +
|
|
availableModels[frigatePlusSettings.model.id]
|
|
.name +
|
|
" (" +
|
|
availableModels[frigatePlusSettings.model.id]
|
|
.width +
|
|
"x" +
|
|
availableModels[frigatePlusSettings.model.id]
|
|
.height +
|
|
")"}
|
|
</SelectTrigger>
|
|
) : (
|
|
<SelectTrigger className="w-full">
|
|
{t("frigatePlus.modelInfo.loadingAvailableModels")}
|
|
</SelectTrigger>
|
|
)}
|
|
|
|
<SelectContent>
|
|
<SelectGroup>
|
|
{Object.entries(availableModels || {}).map(
|
|
([id, model]) => (
|
|
<SelectItem
|
|
key={id}
|
|
className="cursor-pointer"
|
|
value={id}
|
|
disabled={
|
|
!model.supportedDetectors.includes(
|
|
Object.values(config.detectors)[0].type,
|
|
)
|
|
}
|
|
>
|
|
{new Date(model.trainDate).toLocaleString()}{" "}
|
|
<div>
|
|
{model.baseModel} {" ("}
|
|
{model.isBaseModel
|
|
? t(
|
|
"frigatePlus.modelInfo.plusModelType.baseModel",
|
|
)
|
|
: t(
|
|
"frigatePlus.modelInfo.plusModelType.userModel",
|
|
)}
|
|
{")"}
|
|
</div>
|
|
<div>
|
|
{model.name} (
|
|
{model.width + "x" + model.height})
|
|
</div>
|
|
<div>
|
|
{t(
|
|
"frigatePlus.modelInfo.supportedDetectors",
|
|
)}
|
|
: {model.supportedDetectors.join(", ")}
|
|
</div>
|
|
<div className="text-xs text-muted-foreground">
|
|
{id}
|
|
</div>
|
|
</SelectItem>
|
|
),
|
|
)}
|
|
</SelectGroup>
|
|
</SelectContent>
|
|
</Select>
|
|
}
|
|
/>
|
|
</SettingsGroupCard>
|
|
)}
|
|
|
|
<SettingsGroupCard
|
|
title={t("frigatePlus.cardTitles.configuration")}
|
|
>
|
|
<SplitCardRow
|
|
label={t("frigatePlus.snapshotConfig.title")}
|
|
description={
|
|
<>
|
|
<p>
|
|
<Trans ns="views/settings">
|
|
frigatePlus.snapshotConfig.desc
|
|
</Trans>
|
|
</p>
|
|
<div className="mt-2 flex items-center text-primary-variant">
|
|
<Link
|
|
to={getLocaleDocUrl("plus/faq")}
|
|
target="_blank"
|
|
rel="noopener noreferrer"
|
|
className="inline"
|
|
>
|
|
{t("readTheDocumentation", { ns: "common" })}
|
|
<LuExternalLink className="ml-2 inline-flex size-3" />
|
|
</Link>
|
|
</div>
|
|
</>
|
|
}
|
|
content={
|
|
<div className="space-y-3">
|
|
<div className="overflow-x-auto">
|
|
<table className="w-full text-sm">
|
|
<thead>
|
|
<tr className="border-b border-secondary">
|
|
<th className="px-4 py-2 text-left">
|
|
{t("frigatePlus.snapshotConfig.table.camera")}
|
|
</th>
|
|
<th className="px-4 py-2 text-center">
|
|
{t(
|
|
"frigatePlus.snapshotConfig.table.snapshots",
|
|
)}
|
|
</th>
|
|
<th className="px-4 py-2 text-center">
|
|
<Trans ns="views/settings">
|
|
frigatePlus.snapshotConfig.table.cleanCopySnapshots
|
|
</Trans>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
{Object.entries(config.cameras).map(
|
|
([name, camera]) => (
|
|
<tr
|
|
key={name}
|
|
className="border-b border-secondary"
|
|
>
|
|
<td className="px-4 py-2">
|
|
<CameraNameLabel camera={name} />
|
|
</td>
|
|
<td className="px-4 py-2 text-center">
|
|
{camera.snapshots.enabled ? (
|
|
<CheckCircle2 className="mx-auto size-5 text-green-500" />
|
|
) : (
|
|
<XCircle className="mx-auto size-5 text-danger" />
|
|
)}
|
|
</td>
|
|
<td className="px-4 py-2 text-center">
|
|
{camera.snapshots?.enabled &&
|
|
camera.snapshots?.clean_copy ? (
|
|
<CheckCircle2 className="mx-auto size-5 text-green-500" />
|
|
) : (
|
|
<XCircle className="mx-auto size-5 text-danger" />
|
|
)}
|
|
</td>
|
|
</tr>
|
|
),
|
|
)}
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
{needCleanSnapshots() && (
|
|
<div className="rounded-lg border border-secondary-foreground bg-secondary p-4 text-sm text-danger">
|
|
<div className="flex items-center gap-2">
|
|
<IoIosWarning className="mr-2 size-5 text-danger" />
|
|
<div className="max-w-[85%] text-sm">
|
|
<Trans ns="views/settings">
|
|
frigatePlus.snapshotConfig.cleanCopyWarning
|
|
</Trans>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
)}
|
|
</div>
|
|
}
|
|
/>
|
|
</SettingsGroupCard>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div className="sticky bottom-0 z-50 w-full border-t border-secondary bg-background pb-5 pt-0 md:pr-2">
|
|
<div className="flex flex-col items-center gap-4 pt-2 md:flex-row md:justify-end">
|
|
<div className="flex w-full items-center gap-2 md:w-auto">
|
|
<Button
|
|
className="flex min-w-36 flex-1 gap-2"
|
|
variant="outline"
|
|
aria-label={t("button.reset", { ns: "common" })}
|
|
onClick={onCancel}
|
|
>
|
|
{t("button.reset", { ns: "common" })}
|
|
</Button>
|
|
<Button
|
|
variant="select"
|
|
disabled={!changedValue || isLoading}
|
|
className="flex min-w-36 flex-1 gap-2"
|
|
aria-label={t("button.save", { ns: "common" })}
|
|
onClick={saveToConfig}
|
|
>
|
|
{isLoading ? (
|
|
<>
|
|
<ActivityIndicator className="h-4 w-4" />
|
|
{t("button.saving", { ns: "common" })}
|
|
</>
|
|
) : (
|
|
t("button.save", { ns: "common" })
|
|
)}
|
|
</Button>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
);
|
|
}
|