Split config.py into multiple files (#14038)

* Replace logging.warn with logging.warning * Install config global state early * Split config.py into more manageable pieces
2026-10-24 15:35:46 +03:00 · 2024-09-28 14:21:42 -05:00
parent 576191cd4e
commit bbbb3b4a06
39 changed files with 2240 additions and 1892 deletions
@@ -0,0 +1,84 @@
+from enum import Enum
+from typing import Optional, Union
+
+from pydantic import Field, field_validator
+
+from ..base import FrigateBaseModel
+from ..env import EnvString
+from .objects import DEFAULT_TRACKED_OBJECTS
+
+__all__ = ["OnvifConfig", "PtzAutotrackConfig", "ZoomingModeEnum"]
+
+
+class ZoomingModeEnum(str, Enum):
+    disabled = "disabled"
+    absolute = "absolute"
+    relative = "relative"
+
+
+class PtzAutotrackConfig(FrigateBaseModel):
+    enabled: bool = Field(default=False, title="Enable PTZ object autotracking.")
+    calibrate_on_startup: bool = Field(
+        default=False, title="Perform a camera calibration when Frigate starts."
+    )
+    zooming: ZoomingModeEnum = Field(
+        default=ZoomingModeEnum.disabled, title="Autotracker zooming mode."
+    )
+    zoom_factor: float = Field(
+        default=0.3,
+        title="Zooming factor (0.1-0.75).",
+        ge=0.1,
+        le=0.75,
+    )
+    track: list[str] = Field(default=DEFAULT_TRACKED_OBJECTS, title="Objects to track.")
+    required_zones: list[str] = Field(
+        default_factory=list,
+        title="List of required zones to be entered in order to begin autotracking.",
+    )
+    return_preset: str = Field(
+        default="home",
+        title="Name of camera preset to return to when object tracking is over.",
+    )
+    timeout: int = Field(
+        default=10, title="Seconds to delay before returning to preset."
+    )
+    movement_weights: Optional[Union[str, list[str]]] = Field(
+        default_factory=list,
+        title="Internal value used for PTZ movements based on the speed of your camera's motor.",
+    )
+    enabled_in_config: Optional[bool] = Field(
+        default=None, title="Keep track of original state of autotracking."
+    )
+
+    @field_validator("movement_weights", mode="before")
+    @classmethod
+    def validate_weights(cls, v):
+        if v is None:
+            return None
+
+        if isinstance(v, str):
+            weights = list(map(str, map(float, v.split(","))))
+        elif isinstance(v, list):
+            weights = [str(float(val)) for val in v]
+        else:
+            raise ValueError("Invalid type for movement_weights")
+
+        if len(weights) != 5:
+            raise ValueError("movement_weights must have exactly 5 floats")
+
+        return weights
+
+
+class OnvifConfig(FrigateBaseModel):
+    host: str = Field(default="", title="Onvif Host")
+    port: int = Field(default=8000, title="Onvif Port")
+    user: Optional[EnvString] = Field(default=None, title="Onvif Username")
+    password: Optional[EnvString] = Field(default=None, title="Onvif Password")
+    autotracking: PtzAutotrackConfig = Field(
+        default_factory=PtzAutotrackConfig,
+        title="PTZ auto tracking config.",
+    )
+    ignore_time_mismatch: bool = Field(
+        default=False,
+        title="Onvif Ignore Time Synchronization Mismatch Between Camera and Server",
+    )