From 6dc1d3e906b11cd31059c710c89cb2939b45d4fa Mon Sep 17 00:00:00 2001 From: Nick Mowen Date: Fri, 20 Jan 2023 08:52:38 -0700 Subject: [PATCH] Write camera docs for PTZ --- docs/docs/configuration/cameras.md | 18 ++++++++++++++++++ docs/docs/configuration/index.md | 26 +++++++++++++------------- 2 files changed, 31 insertions(+), 13 deletions(-) diff --git a/docs/docs/configuration/cameras.md b/docs/docs/configuration/cameras.md index d8fefed8f..bd89c148b 100644 --- a/docs/docs/configuration/cameras.md +++ b/docs/docs/configuration/cameras.md @@ -48,3 +48,21 @@ cameras: ``` For camera model specific settings check the [camera specific](camera_specific.md) infos. + +## Setting up camera PTZ controls + +Add onvif config to camera + +```yaml +cameras: + back: + ffmpeg: + ... + onvif: + host: 10.0.10.10 + port: 8000 + user: admin + password: "{FRIGATE_RTSP_PASSWORD}" +``` + +then PTZ controls will be available in the cameras WebUI. diff --git a/docs/docs/configuration/index.md b/docs/docs/configuration/index.md index 3817d6c2a..548a2da9d 100644 --- a/docs/docs/configuration/index.md +++ b/docs/docs/configuration/index.md @@ -409,19 +409,6 @@ timestamp_style: # "shadow" (shadow for font) effect: None -# Optional: connect to ONVIF camera -# to enable PTZ controls. -onvif: - # Required: host of the camera being connected to. - host: 0.0.0.0 - # Optional: ONVIF port for device (default: shown below). - port: 8000 - # Optional: username for login. - # NOTE: Some devices require admin to access ONVIF. - user: admin - # Optional: password for login. - password: admin - # Required cameras: # Required: name of the camera @@ -510,6 +497,19 @@ cameras: # Optional: Whether or not to show the camera in the Frigate UI (default: shown below) dashboard: True + # Optional: connect to ONVIF camera + # to enable PTZ controls. + onvif: + # Required: host of the camera being connected to. + host: 0.0.0.0 + # Optional: ONVIF port for device (default: shown below). + port: 8000 + # Optional: username for login. + # NOTE: Some devices require admin to access ONVIF. + user: admin + # Optional: password for login. + password: admin + # Optional ui: # Optional: Set the default live mode for cameras in the UI (default: shown below)