From 01143a9b2edf3ea7e6c524d0ab7365371a852153 Mon Sep 17 00:00:00 2001 From: Jesper Lodin Date: Mon, 9 Dec 2024 22:22:08 +0000 Subject: [PATCH] fix broken links in docs --- .../_components/ComponentCard/index.tsx | 2 +- .../ComponentTroubleshooting/index.mdx} | 2 +- .../_domains/face_recognition/index.mdx | 2 +- .../_domains/image_classification/index.mdx | 2 +- .../license_plate_recognition/index.mdx | 2 +- .../_domains/object_detector/index.mdx | 2 +- .../background_subtractor/index.mdx | 4 ++-- .../components/codeprojectai/index.mdx | 4 ++-- .../components/compreface/index.mdx | 4 ++-- .../components/darknet/index.mdx | 4 ++-- .../components/deepstack/index.mdx | 4 ++-- .../components/dlib/index.mdx | 4 ++-- .../components/edgetpu/index.mdx | 4 ++-- .../components/ffmpeg/index.mdx | 19 +++++-------------- .../components/gstreamer/index.mdx | 4 ++-- .../components/logger/index.mdx | 8 +++++--- .../components/mog2/index.mdx | 4 ++-- .../components/mqtt/index.mdx | 4 ++-- .../components/nvr/index.mdx | 4 ++-- .../components/storage/index.mdx | 18 ++++++++++++------ .../components/webserver/index.mdx | 4 ++-- 21 files changed, 52 insertions(+), 53 deletions(-) rename docs/src/pages/components-explorer/{components/troubleshooting.mdx => _components/ComponentTroubleshooting/index.mdx} (67%) diff --git a/docs/src/pages/components-explorer/_components/ComponentCard/index.tsx b/docs/src/pages/components-explorer/_components/ComponentCard/index.tsx index 23eca8c67..10becb95e 100644 --- a/docs/src/pages/components-explorer/_components/ComponentCard/index.tsx +++ b/docs/src/pages/components-explorer/_components/ComponentCard/index.tsx @@ -45,7 +45,7 @@ function ComponentCardTag({ tags }: { tags: DomainType[] }) { } function ComponentCard({ component }: { component: Component }) { - const componentLink = `components-explorer/components/${component.name}`; + const componentLink = `/components-explorer/components/${component.name}`; return (
  • diff --git a/docs/src/pages/components-explorer/components/troubleshooting.mdx b/docs/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx similarity index 67% rename from docs/src/pages/components-explorer/components/troubleshooting.mdx rename to docs/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx index d48d7f08e..915aef9ec 100644 --- a/docs/src/pages/components-explorer/components/troubleshooting.mdx +++ b/docs/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx @@ -2,4 +2,4 @@ import ComponentTroubleshooting from "@site/src/pages/components-explorer/_compo ## Troubleshooting - + diff --git a/docs/src/pages/components-explorer/_domains/face_recognition/index.mdx b/docs/src/pages/components-explorer/_domains/face_recognition/index.mdx index 4b39abca8..8417aac18 100644 --- a/docs/src/pages/components-explorer/_domains/face_recognition/index.mdx +++ b/docs/src/pages/components-explorer/_domains/face_recognition/index.mdx @@ -5,7 +5,7 @@ import PostProcessorLabels from "@site/src/pages/components-explorer/_domains/po ## Face recognition -Face recognition runs as a post processor when a specific object is detected. +Face recognition runs as a post processor when a specific object is detected. ### Labels \{#face-recognition-labels} diff --git a/docs/src/pages/components-explorer/_domains/image_classification/index.mdx b/docs/src/pages/components-explorer/_domains/image_classification/index.mdx index 16ea56bde..8ea06c4b1 100644 --- a/docs/src/pages/components-explorer/_domains/image_classification/index.mdx +++ b/docs/src/pages/components-explorer/_domains/image_classification/index.mdx @@ -4,7 +4,7 @@ import PostProcessorLabels from "@site/src/pages/components-explorer/_domains/po ## Image classification -Image classification runs as a post processor when a specific object is detected. +Image classification runs as a post processor when a specific object is detected. Image classification works by labeling and image with known objects and provide a score. Classifiers have more fine tuned models than object detectors typically have, which allows them to have more detailed detections. diff --git a/docs/src/pages/components-explorer/_domains/license_plate_recognition/index.mdx b/docs/src/pages/components-explorer/_domains/license_plate_recognition/index.mdx index fb1a31b6e..6591031cc 100644 --- a/docs/src/pages/components-explorer/_domains/license_plate_recognition/index.mdx +++ b/docs/src/pages/components-explorer/_domains/license_plate_recognition/index.mdx @@ -2,7 +2,7 @@ import Link from "@docusaurus/Link"; ## License plate recognition -License plate recognition runs as a post processor when a specific object is detected. +License plate recognition runs as a post processor when a specific object is detected. You can track known license plates by adding them to the `known_plates` list in the configuration. Known plates will be reported as binary sensors. diff --git a/docs/src/pages/components-explorer/_domains/object_detector/index.mdx b/docs/src/pages/components-explorer/_domains/object_detector/index.mdx index 35f16d2cc..7b6961612 100644 --- a/docs/src/pages/components-explorer/_domains/object_detector/index.mdx +++ b/docs/src/pages/components-explorer/_domains/object_detector/index.mdx @@ -8,7 +8,7 @@ An object detector scans an image to identify multiple objects and their positio :::tip -Object detectors can be taxing on the system, so it is wise to combine it with a [motion detector](/docs/documentation/configuration#motion-detector-domain) +Object detectors can be taxing on the system, so it is wise to combine it with a [motion detector](/docs/documentation/configuration/domains/#motion-detector-domain) ::: diff --git a/docs/src/pages/components-explorer/components/background_subtractor/index.mdx b/docs/src/pages/components-explorer/components/background_subtractor/index.mdx index fa114bcb9..b4f8d5779 100644 --- a/docs/src/pages/components-explorer/components/background_subtractor/index.mdx +++ b/docs/src/pages/components-explorer/components/background_subtractor/index.mdx @@ -1,7 +1,7 @@ import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration"; import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader"; +import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx"; import MotionDetector from "@site/src/pages/components-explorer/_domains/motion_detector/index.mdx"; -import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx"; import ComponentMetadata from "./_meta"; import config from "./config.json"; @@ -43,7 +43,7 @@ background_subtractor: - + diff --git a/docs/src/pages/components-explorer/components/codeprojectai/index.mdx b/docs/src/pages/components-explorer/components/codeprojectai/index.mdx index 9e155ba2d..8063232c1 100644 --- a/docs/src/pages/components-explorer/components/codeprojectai/index.mdx +++ b/docs/src/pages/components-explorer/components/codeprojectai/index.mdx @@ -3,10 +3,10 @@ import CodeBlock from "@theme/CodeBlock"; import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration"; import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader"; +import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx"; import FaceRecognition from "@site/src/pages/components-explorer/_domains/face_recognition/index.mdx"; import LicensePlateRecognition from "@site/src/pages/components-explorer/_domains/license_plate_recognition/index.mdx"; import ObjectDetector from "@site/src/pages/components-explorer/_domains/object_detector/index.mdx"; -import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx"; import ComponentMetadata from "./_meta"; import config from "./config.json"; @@ -92,7 +92,7 @@ codeprojectai: - + diff --git a/docs/src/pages/components-explorer/components/compreface/index.mdx b/docs/src/pages/components-explorer/components/compreface/index.mdx index 2475283f9..31fb1e1fd 100644 --- a/docs/src/pages/components-explorer/components/compreface/index.mdx +++ b/docs/src/pages/components-explorer/components/compreface/index.mdx @@ -1,7 +1,7 @@ import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration"; import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader"; +import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx"; import FaceRecognition from "@site/src/pages/components-explorer/_domains/face_recognition/index.mdx"; -import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx"; import ComponentMetadata from "./_meta"; import config from "./config.json"; @@ -44,7 +44,7 @@ compreface: - + diff --git a/docs/src/pages/components-explorer/components/darknet/index.mdx b/docs/src/pages/components-explorer/components/darknet/index.mdx index 734597ceb..95c04a14a 100644 --- a/docs/src/pages/components-explorer/components/darknet/index.mdx +++ b/docs/src/pages/components-explorer/components/darknet/index.mdx @@ -4,8 +4,8 @@ import Tabs from "@theme/Tabs"; import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration"; import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader"; +import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx"; import ObjectDetector from "@site/src/pages/components-explorer/_domains/object_detector/index.mdx"; -import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx"; import ComponentMetadata from "./_meta"; import config from "./config.json"; @@ -80,7 +80,7 @@ darknet: - + - + - + diff --git a/docs/src/pages/components-explorer/components/edgetpu/index.mdx b/docs/src/pages/components-explorer/components/edgetpu/index.mdx index 3159a21e6..77349220c 100644 --- a/docs/src/pages/components-explorer/components/edgetpu/index.mdx +++ b/docs/src/pages/components-explorer/components/edgetpu/index.mdx @@ -1,8 +1,8 @@ import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration"; import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader"; +import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx"; import ImageClassification from "@site/src/pages/components-explorer/_domains/image_classification/index.mdx"; import ObjectDetector from "@site/src/pages/components-explorer/_domains/object_detector/index.mdx"; -import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx"; import ComponentMetadata from "./_meta"; import config from "./config.json"; @@ -50,7 +50,7 @@ edgetpu: - + - + @@ -190,19 +190,10 @@ ffmpeg_recoverable_errors: ### Recorder [FFmpeg segments](https://www.ffmpeg.org/ffmpeg-formats.html#segment_002c-stream_005fsegment_002c-ssegment) are used to handle recordings.
    -FFmpeg will write small 5 second segments of the stream to disk, and in case of any recording starting, Viseron will find the appropriate segments and concatenate them together.
    -The reason for using segments instead of just starting the recorder on an event, is to support the `lookback` feature which makes it possible to record _before_ an event actually happened. - -
    - The default concatenation command +FFmpeg will write small 5 second segments of the stream to disk.
    -``` -ffmpeg -hide_banner -loglevel error -y -protocol_whitelist file,pipe -f concat -safe 0 -i - -c:v copy {outfile.mp4} -``` - -
    - -If you want to re-encode the video you can choose `codec`, `video_filters` and optionally `hwaccel_args`. +The reason for using segments instead of just starting the recorder on an event, is to support the `lookback` feature which makes it possible to record _before_ an event actually happened. +It also makes it possible to have continuous recordings. ### Store segments in memory diff --git a/docs/src/pages/components-explorer/components/gstreamer/index.mdx b/docs/src/pages/components-explorer/components/gstreamer/index.mdx index 2518ab027..c8af522cd 100644 --- a/docs/src/pages/components-explorer/components/gstreamer/index.mdx +++ b/docs/src/pages/components-explorer/components/gstreamer/index.mdx @@ -1,7 +1,7 @@ import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration"; import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader"; +import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx"; import Camera from "@site/src/pages/components-explorer/_domains/camera/index.mdx"; -import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx"; import ComponentMetadata from "./_meta"; import config from "./config.json"; @@ -56,7 +56,7 @@ gstreamer: - + diff --git a/docs/src/pages/components-explorer/components/logger/index.mdx b/docs/src/pages/components-explorer/components/logger/index.mdx index 56fc3d845..ca5f01409 100644 --- a/docs/src/pages/components-explorer/components/logger/index.mdx +++ b/docs/src/pages/components-explorer/components/logger/index.mdx @@ -1,7 +1,9 @@ -import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration"; -import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader"; import TabItem from "@theme/TabItem"; import Tabs from "@theme/Tabs"; + +import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration"; +import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader"; + import ComponentMetadata from "./_meta"; import config from "./config.json"; @@ -28,7 +30,7 @@ logger: - + ## Available levels diff --git a/docs/src/pages/components-explorer/components/mog2/index.mdx b/docs/src/pages/components-explorer/components/mog2/index.mdx index eb9516239..e8720c589 100644 --- a/docs/src/pages/components-explorer/components/mog2/index.mdx +++ b/docs/src/pages/components-explorer/components/mog2/index.mdx @@ -1,7 +1,7 @@ import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration"; import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader"; +import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx"; import MotionDetector from "@site/src/pages/components-explorer/_domains/motion_detector/index.mdx"; -import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx"; import ComponentMetadata from "./_meta"; import config from "./config.json"; @@ -43,7 +43,7 @@ mog2: - + diff --git a/docs/src/pages/components-explorer/components/mqtt/index.mdx b/docs/src/pages/components-explorer/components/mqtt/index.mdx index c011d90e1..1cca5e7d9 100644 --- a/docs/src/pages/components-explorer/components/mqtt/index.mdx +++ b/docs/src/pages/components-explorer/components/mqtt/index.mdx @@ -3,7 +3,7 @@ import Tabs from "@theme/Tabs"; import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration"; import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader"; -import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx"; +import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx"; import ComponentMetadata from "./_meta"; import config from "./config.json"; @@ -29,7 +29,7 @@ mqtt: - + ## Topics diff --git a/docs/src/pages/components-explorer/components/nvr/index.mdx b/docs/src/pages/components-explorer/components/nvr/index.mdx index 7c8b61526..b15db7b3a 100644 --- a/docs/src/pages/components-explorer/components/nvr/index.mdx +++ b/docs/src/pages/components-explorer/components/nvr/index.mdx @@ -1,6 +1,6 @@ import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration"; import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader"; -import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx"; +import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx"; import ComponentMetadata from "./_meta"; import config from "./config.json"; @@ -30,6 +30,6 @@ nvr: - + diff --git a/docs/src/pages/components-explorer/components/storage/index.mdx b/docs/src/pages/components-explorer/components/storage/index.mdx index 447fe08c9..b69536052 100644 --- a/docs/src/pages/components-explorer/components/storage/index.mdx +++ b/docs/src/pages/components-explorer/components/storage/index.mdx @@ -1,6 +1,6 @@ import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration"; import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader"; -import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx"; +import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx"; import ComponentMetadata from "./_meta"; import config from "./config.json"; @@ -49,7 +49,7 @@ It will also store continuous recordings on `/ssd/tier1` for 1 day, after which - + :::caution @@ -92,8 +92,8 @@ For technical reasons it is very likely that there will be a few extra megabytes ### Continuous (24/7) recordings -To enable continuous recordings for **all** cameras you use the `continuous` configuration option for a tier. -The below example will store 10gb of continuous recordings in the default location `/segments`. +To allocate space for continuous recordings for **all** cameras you use the `continuous` configuration option for a tier. +The below example will store 10gb of continuous recordings **per camera** in the default location `/segments`. No events will be stored.
    @@ -111,13 +111,19 @@ storage:
    +:::info + +For each camera that you want to store continuous recordings for, you need to set `continuous_recording: true` under `recorder` in the camera configuration. + +::: + :::tip To set camera specific options, you can use `continuous` or override the entire `storage` configuration under your camera configuration. See the `recorder` documentation for the component that provides your cameras. -[FFmpeg](/components-explorer/components/FFmpeg)

    -[GStreamer](/components-explorer/components/GStreamer) +[FFmpeg](/components-explorer/components/ffmpeg)

    +[GStreamer](/components-explorer/components/gstreamer) ::: diff --git a/docs/src/pages/components-explorer/components/webserver/index.mdx b/docs/src/pages/components-explorer/components/webserver/index.mdx index 6c3dbc162..3a27a9136 100644 --- a/docs/src/pages/components-explorer/components/webserver/index.mdx +++ b/docs/src/pages/components-explorer/components/webserver/index.mdx @@ -1,6 +1,6 @@ import ComponentConfiguration from "@site/src/pages/components-explorer/_components/ComponentConfiguration"; import ComponentHeader from "@site/src/pages/components-explorer/_components/ComponentHeader"; -import ComponentTroubleshooting from "@site/src/pages/components-explorer/components/troubleshooting.mdx"; +import ComponentTroubleshooting from "@site/src/pages/components-explorer/_components/ComponentTroubleshooting/index.mdx"; import ComponentMetadata from "./_meta"; import config from "./config.json"; @@ -31,6 +31,6 @@ webserver: - +