From 10db9faff9c31b875b3f46162d8d10c802fba13c Mon Sep 17 00:00:00 2001 From: Nick Mowen Date: Mon, 2 May 2022 09:22:37 -0600 Subject: [PATCH 1/9] Add docs about casting --- docs/docs/integrations/home-assistant.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/docs/integrations/home-assistant.md b/docs/docs/integrations/home-assistant.md index ae6d40344..847d3af02 100644 --- a/docs/docs/integrations/home-assistant.md +++ b/docs/docs/integrations/home-assistant.md @@ -85,6 +85,12 @@ The integration provides: This is accessible via "Media Browser" on the left menu panel in Home Assistant. +## Casting Clips To Media Devices + +The integration supports casting clips and cameras to supported media devices. + +**NOTE: For clips to be castable to media devices, audio is required and may need to be [enabled for recordings](../faqs.md#audio-in-recordings). + ## Notification API From 2dda7608bb0fdbf574545f17b9df2d4f484ca868 Mon Sep 17 00:00:00 2001 From: Nick Mowen Date: Mon, 2 May 2022 09:24:31 -0600 Subject: [PATCH 2/9] Clarify camera streaming --- docs/docs/integrations/home-assistant.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/integrations/home-assistant.md b/docs/docs/integrations/home-assistant.md index 847d3af02..c01262e34 100644 --- a/docs/docs/integrations/home-assistant.md +++ b/docs/docs/integrations/home-assistant.md @@ -87,7 +87,7 @@ This is accessible via "Media Browser" on the left menu panel in Home Assistant. ## Casting Clips To Media Devices -The integration supports casting clips and cameras to supported media devices. +The integration supports casting clips and camera streams to supported media devices. **NOTE: For clips to be castable to media devices, audio is required and may need to be [enabled for recordings](../faqs.md#audio-in-recordings). From f59871a189a218b6f6da35b85b8c9b38ef676ac1 Mon Sep 17 00:00:00 2001 From: Nick Mowen Date: Mon, 2 May 2022 09:29:28 -0600 Subject: [PATCH 3/9] Fix bolding --- docs/docs/integrations/home-assistant.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/integrations/home-assistant.md b/docs/docs/integrations/home-assistant.md index c01262e34..6aa9ccfc6 100644 --- a/docs/docs/integrations/home-assistant.md +++ b/docs/docs/integrations/home-assistant.md @@ -89,7 +89,7 @@ This is accessible via "Media Browser" on the left menu panel in Home Assistant. The integration supports casting clips and camera streams to supported media devices. -**NOTE: For clips to be castable to media devices, audio is required and may need to be [enabled for recordings](../faqs.md#audio-in-recordings). +**NOTE: For clips to be castable to media devices, audio is required and may need to be [enabled for recordings](../faqs.md#audio-in-recordings).** From 53bf3cd2e63e7a37efa017ee943a4cbf1b73fa8e Mon Sep 17 00:00:00 2001 From: Nick Mowen Date: Mon, 2 May 2022 09:39:57 -0600 Subject: [PATCH 4/9] Use tip for casting notes and specific note for no audio cameras --- docs/docs/integrations/home-assistant.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/docs/integrations/home-assistant.md b/docs/docs/integrations/home-assistant.md index 6aa9ccfc6..cab093b52 100644 --- a/docs/docs/integrations/home-assistant.md +++ b/docs/docs/integrations/home-assistant.md @@ -89,7 +89,12 @@ This is accessible via "Media Browser" on the left menu panel in Home Assistant. The integration supports casting clips and camera streams to supported media devices. -**NOTE: For clips to be castable to media devices, audio is required and may need to be [enabled for recordings](../faqs.md#audio-in-recordings).** +:::tip +For clips to be castable to media devices, audio is required and may need to be [enabled for recordings](../faqs.md#audio-in-recordings). + +**NOTE: Even if you camera does not support audio, audio will need to be enabled for Casting to be accepted.** + +::: From 93cd973e59ae854382841d1256a97d5b5be733b0 Mon Sep 17 00:00:00 2001 From: Nicolas Mowen Date: Sun, 29 May 2022 08:48:55 -0600 Subject: [PATCH 5/9] Update index.md (#3267) --- docs/docs/configuration/index.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/docs/configuration/index.md b/docs/docs/configuration/index.md index c0d74085d..14fe556d6 100644 --- a/docs/docs/configuration/index.md +++ b/docs/docs/configuration/index.md @@ -25,6 +25,10 @@ cameras: height: 720 ``` +### VSCode Configuration Schema + +VSCode (and VSCode addon) supports the JSON schemas which will automatically validate the config. This can be added by adding `# yaml-language-server: $schema=http://frigate_host:5000/api/config/schema` to the top of the config file. `frigate_host` being the IP address of frigate or `ccab4aaf-frigate` if running in the addon. + ### Full configuration reference: :::caution From 653c2274e13872fec78184167510c5c68735ba9c Mon Sep 17 00:00:00 2001 From: Nick Mowen Date: Mon, 11 Jul 2022 10:05:47 -0600 Subject: [PATCH 6/9] Add FAQ about database locked error --- docs/docs/faqs.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/docs/faqs.md b/docs/docs/faqs.md index 34b040f01..61ed49cfd 100644 --- a/docs/docs/faqs.md +++ b/docs/docs/faqs.md @@ -47,3 +47,7 @@ These messages in the logs are expected in certain situations. Frigate checks th ### "On connect called" If you see repeated "On connect called" messages in your config, check for another instance of frigate. This happens when multiple frigate containers are trying to connect to mqtt with the same client_id. + +### Error: Database Is Locked + +sqlite does not work well on a network share, if the `/media` folder is mapped to a network share then [this guide](/configuration/advanced#database) should be used to move the database to a location on the internal drive. From e68f80b44a8e609e254ce11cdf0bc91b9ddfdbd8 Mon Sep 17 00:00:00 2001 From: Matthew Parlane Date: Tue, 19 Jul 2022 13:33:30 +1200 Subject: [PATCH 7/9] Use relative path without .. for rtmp documentation to fix #3481 ../faq was used in rtmp.md which leads to the wrong URL when the current URL ends in a slash due to 301 redirect of netlify --- docs/docs/configuration/rtmp.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/configuration/rtmp.md b/docs/docs/configuration/rtmp.md index 76f6f81a7..5c6b3b5a0 100644 --- a/docs/docs/configuration/rtmp.md +++ b/docs/docs/configuration/rtmp.md @@ -5,4 +5,4 @@ title: RTMP Frigate can re-stream your video feed as a RTMP feed for other applications such as Home Assistant to utilize it at `rtmp:///live/`. Port 1935 must be open. This allows you to use a video feed for detection in frigate and Home Assistant live view at the same time without having to make two separate connections to the camera. The video feed is copied from the original video feed directly to avoid re-encoding. This feed does not include any annotation by Frigate. -Some video feeds are not compatible with RTMP. If you are experiencing issues, check to make sure your camera feed is h264 with AAC audio. If your camera doesn't support a compatible format for RTMP, you can use the ffmpeg args to re-encode it on the fly at the expense of increased CPU utilization. Some more information about it can be found [here](../faqs#audio-in-recordings). +Some video feeds are not compatible with RTMP. If you are experiencing issues, check to make sure your camera feed is h264 with AAC audio. If your camera doesn't support a compatible format for RTMP, you can use the ffmpeg args to re-encode it on the fly at the expense of increased CPU utilization. Some more information about it can be found [here](/faqs#audio-in-recordings). From 7a1215d581195d24990d443f6c5915e3081e7cb7 Mon Sep 17 00:00:00 2001 From: ZuluWhiskey <35011199+ZuluWhiskey@users.noreply.github.com> Date: Sat, 13 Aug 2022 12:42:25 +0100 Subject: [PATCH 8/9] Adding configuration example for retain modes (#3589) * Adding configuration example for retain modes Reading the documentation on its own didn't help me but when I found https://github.com/blakeblackshear/frigate/discussions/2447 I was able to understand how to add this to my configuration. I've added the example given in that discussion to help future readers of the page. * Update record.md Added suggested changes and have also added wording beneath the example mentioning the configuration can be added on a per camera basis. Have also built on the example to add object specific retentions timings - Not sure if it would be preferred to have it all within one example to not complicate things? Let me know your thoughts * Update record.md Created Object Specific Retention header * Typo Co-authored-by: Blake Blackshear --- docs/docs/configuration/record.md | 32 +++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/docs/docs/configuration/record.md b/docs/docs/configuration/record.md index 9cb5878d5..7aeec9d0c 100644 --- a/docs/docs/configuration/record.md +++ b/docs/docs/configuration/record.md @@ -42,3 +42,35 @@ The same options are available with events. Let's consider a scenario where you - With the `all` option all segments for the duration of the event would be saved for the event. This event would have 4 hours of footage. - With the `motion` option all segments for the duration of the event with motion would be saved. This means any segment where a car drove by in the street, person walked by, lighting changed, etc. would be saved. - With the `active_objects` it would only keep segments where the object was active. In this case the only segments that would be saved would be the ones where the car was driving up, you going inside, you coming outside, and the car driving away. Essentially reducing the 4 hours to a minute or two of event footage. + +A configuration example of the above retain modes where all `motion` segments are stored for 7 days and `active objects` are stored for 14 days would be as follows: +```yaml +record: + enabled: True + retain: + days: 7 + mode: motion + events: + retain: + default: 14 + mode: active_objects +``` +The above configuration example can be added globally or on a per camera basis. + +### Object Specific Retention + +You can also set specific retention length for an object type. The below configuration example builds on from above but also specifies that recordings of dogs only need to be kept for 2 days and recordings of cars should be kept for 7 days. +```yaml +record: + enabled: True + retain: + days: 7 + mode: motion + events: + retain: + default: 14 + mode: active_objects + objects: + dog: 2 + car: 7 +``` From 6e2e297aeb451598223a3beb6735eb5fc27b37b2 Mon Sep 17 00:00:00 2001 From: Nick Mowen Date: Wed, 27 Jul 2022 10:01:32 -0600 Subject: [PATCH 9/9] Add clean copy to configuration docs --- docs/docs/configuration/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/docs/configuration/index.md b/docs/docs/configuration/index.md index 14fe556d6..61ac9aa90 100644 --- a/docs/docs/configuration/index.md +++ b/docs/docs/configuration/index.md @@ -312,6 +312,8 @@ snapshots: # Optional: Enable writing jpg snapshot to /media/frigate/clips (default: shown below) # This value can be set via MQTT and will be updated in startup based on retained value enabled: False + # Optional: save a clean PNG copy of the snapshot image (default: shown below) + clean_copy: True # Optional: print a timestamp on the snapshots (default: shown below) timestamp: False # Optional: draw bounding box on the snapshots (default: shown below)