mirror of
https://github.com/blakeblackshear/frigate.git
synced 2026-03-17 21:58:22 +03:00
6a21b2952d
* migrator and runtime config changes * component changes to use rasterized_mask * frontend * convert none to empty string for config save * i18n * update tests * add enabled config to zones * zones frontend * i18n * docs * tweaks * use dashed stroke to indicate disabled * allow toggle from icon * use filelock to ensure atomic config updates from endpoint * enforce atomic config update in the frontend * toggle via mqtt * fix global object masks * correctly handle global object masks in dispatcher * ws hooks * render masks and zones based on ws enabled state * use enabled_in_config for zones and masks * frontend for enabled_in_config * tweaks * i18n * publish websocket on config save * i18n tweaks * pydantic title and description * i18n generation * tweaks * fix typing
86 lines
3.0 KiB
Python
86 lines
3.0 KiB
Python
"""Mask configuration for motion and object masks."""
|
|
|
|
from typing import Any, Optional, Union
|
|
|
|
from pydantic import Field, field_serializer
|
|
|
|
from ..base import FrigateBaseModel
|
|
|
|
__all__ = ["MotionMaskConfig", "ObjectMaskConfig"]
|
|
|
|
|
|
class MotionMaskConfig(FrigateBaseModel):
|
|
"""Configuration for a single motion mask."""
|
|
|
|
friendly_name: Optional[str] = Field(
|
|
default=None,
|
|
title="Friendly name",
|
|
description="A friendly name for this motion mask used in the Frigate UI",
|
|
)
|
|
enabled: bool = Field(
|
|
default=True,
|
|
title="Enabled",
|
|
description="Enable or disable this motion mask",
|
|
)
|
|
coordinates: Union[str, list[str]] = Field(
|
|
default="",
|
|
title="Coordinates",
|
|
description="Ordered x,y coordinates defining the motion mask polygon used to include/exclude areas.",
|
|
)
|
|
raw_coordinates: Union[str, list[str]] = ""
|
|
enabled_in_config: Optional[bool] = Field(
|
|
default=None, title="Keep track of original state of motion mask."
|
|
)
|
|
|
|
def get_formatted_name(self, mask_id: str) -> str:
|
|
"""Return the friendly name if set, otherwise return a formatted version of the mask ID."""
|
|
if self.friendly_name:
|
|
return self.friendly_name
|
|
return mask_id.replace("_", " ").title()
|
|
|
|
@field_serializer("coordinates", when_used="json")
|
|
def serialize_coordinates(self, value: Any, info):
|
|
return self.raw_coordinates if self.raw_coordinates else value
|
|
|
|
@field_serializer("raw_coordinates", when_used="json")
|
|
def serialize_raw_coordinates(self, value: Any, info):
|
|
return None
|
|
|
|
|
|
class ObjectMaskConfig(FrigateBaseModel):
|
|
"""Configuration for a single object mask."""
|
|
|
|
friendly_name: Optional[str] = Field(
|
|
default=None,
|
|
title="Friendly name",
|
|
description="A friendly name for this object mask used in the Frigate UI",
|
|
)
|
|
enabled: bool = Field(
|
|
default=True,
|
|
title="Enabled",
|
|
description="Enable or disable this object mask",
|
|
)
|
|
coordinates: Union[str, list[str]] = Field(
|
|
default="",
|
|
title="Coordinates",
|
|
description="Ordered x,y coordinates defining the object mask polygon used to include/exclude areas.",
|
|
)
|
|
raw_coordinates: Union[str, list[str]] = ""
|
|
enabled_in_config: Optional[bool] = Field(
|
|
default=None, title="Keep track of original state of object mask."
|
|
)
|
|
|
|
@field_serializer("coordinates", when_used="json")
|
|
def serialize_coordinates(self, value: Any, info):
|
|
return self.raw_coordinates if self.raw_coordinates else value
|
|
|
|
@field_serializer("raw_coordinates", when_used="json")
|
|
def serialize_raw_coordinates(self, value: Any, info):
|
|
return None
|
|
|
|
def get_formatted_name(self, mask_id: str) -> str:
|
|
"""Return the friendly name if set, otherwise return a formatted version of the mask ID."""
|
|
if self.friendly_name:
|
|
return self.friendly_name
|
|
return mask_id.replace("_", " ").title()
|