Rename nickname to friendly_name (#19782)

Better aligns with convention from Home Assistant since many Frigate users are also HA users
This commit is contained in:
Josh Hawkins
2025-08-26 15:29:52 -05:00
committed by GitHub
parent d3af748366
commit 398a3a7b95
18 changed files with 42 additions and 40 deletions
+2 -2
View File
@@ -335,7 +335,7 @@ class WebPushClient(Communicator):
camera: str = payload["after"]["camera"]
camera_name: str = getattr(
self.config.cameras[camera], "nickname", None
self.config.cameras[camera], "friendly_name", None
) or titlecase(camera.replace("_", " "))
current_time = datetime.datetime.now().timestamp()
@@ -410,7 +410,7 @@ class WebPushClient(Communicator):
camera: str = payload["camera"]
camera_name: str = getattr(
self.config.cameras[camera], "nickname", None
self.config.cameras[camera], "friendly_name", None
) or titlecase(camera.replace("_", " "))
current_time = datetime.datetime.now().timestamp()
+5 -3
View File
@@ -52,12 +52,14 @@ class CameraTypeEnum(str, Enum):
class CameraConfig(FrigateBaseModel):
name: Optional[str] = Field(None, title="Camera name.", pattern=REGEX_CAMERA_NAME)
nickname: Optional[str] = Field(None, title="Camera nickname. Only for display.")
friendly_name: Optional[str] = Field(
None, title="Camera friendly name used in the Frigate UI."
)
@model_validator(mode="before")
@classmethod
def handle_nickname(cls, values):
if isinstance(values, dict) and "nickname" in values:
def handle_friendly_name(cls, values):
if isinstance(values, dict) and "friendly_name" in values:
pass
return values
+1 -1
View File
@@ -78,7 +78,7 @@ class StorageMaintainer(threading.Thread):
)
camera_key = (
getattr(self.config.cameras[camera], "nickname", None) or camera
getattr(self.config.cameras[camera], "friendly_name", None) or camera
)
usages[camera_key] = {
"usage": camera_storage,