From 9d86f9435bdb42dcdf145c29b54fa6427807eb69 Mon Sep 17 00:00:00 2001 From: banthungprong <59219161+banthungprong@users.noreply.github.com> Date: Tue, 25 Oct 2022 16:52:20 +0200 Subject: [PATCH] Update Docs enabling/disabling camera in config --- docs/docs/configuration/cameras.md | 5 ++++- docs/docs/configuration/index.md | 2 ++ docs/docs/guides/getting_started.md | 1 + 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/docs/configuration/cameras.md b/docs/docs/configuration/cameras.md index d2feceeeb..52fd29b38 100644 --- a/docs/docs/configuration/cameras.md +++ b/docs/docs/configuration/cameras.md @@ -7,6 +7,8 @@ title: Cameras Several inputs can be configured for each camera and the role of each input can be mixed and matched based on your needs. This allows you to use a lower resolution stream for object detection, but create recordings from a higher resolution stream, or vice versa. +A camera is enabled by default but can be temporarily disabled by using `enabled: False`. + Each role can only be assigned to one input per camera. The options for roles are as follows: | Role | Description | @@ -20,6 +22,7 @@ mqtt: host: mqtt.server.com cameras: back: + enabled: True ffmpeg: inputs: - path: rtsp://viewer:{FRIGATE_RTSP_PASSWORD}@10.0.10.10:554/cam/realmonitor?channel=1&subtype=2 @@ -44,4 +47,4 @@ cameras: side: ... ``` -For camera model specific settings check the [camera specific](/configuration/camera_specific) infos. \ No newline at end of file +For camera model specific settings check the [camera specific](/configuration/camera_specific) infos. diff --git a/docs/docs/configuration/index.md b/docs/docs/configuration/index.md index 57bc815dd..26de90118 100644 --- a/docs/docs/configuration/index.md +++ b/docs/docs/configuration/index.md @@ -380,6 +380,8 @@ timestamp_style: cameras: # Required: name of the camera back: + # Optional: Enable/Disable the camera (default: camera is enabled automatically) + enabled: True # Required: ffmpeg settings for the camera ffmpeg: # Required: A list of input streams for the camera. See documentation for more information. diff --git a/docs/docs/guides/getting_started.md b/docs/docs/guides/getting_started.md index 977649b01..72dd1c6b0 100644 --- a/docs/docs/guides/getting_started.md +++ b/docs/docs/guides/getting_started.md @@ -62,6 +62,7 @@ detectors: cameras: camera_1: # <------ Name the camera + enabled: True # <----- Enable/disable camera ffmpeg: inputs: - path: rtsp://10.0.10.10:554/rtsp # <----- Update for your camera