Merge remote-tracking branch 'origin/master' into dev

docs/docs/guides/configuring_go2rtc.md

@@ -33,19 +33,16 @@ After adding this to the config, restart Frigate and try to watch the live strea
 ### What if my video doesn't play?
 
 - Check Logs:
-
   - Access the go2rtc logs in the Frigate UI under Logs in the sidebar.
   - If go2rtc is having difficulty connecting to your camera, you should see some error messages in the log.
 
 - Check go2rtc Web Interface: if you don't see any errors in the logs, try viewing the camera through go2rtc's web interface.
-
   - Navigate to port 1984 in your browser to access go2rtc's web interface.
     - If using Frigate through Home Assistant, enable the web interface at port 1984.
     - If using Docker, forward port 1984 before accessing the web interface.
   - Click `stream` for the specific camera to see if the camera's stream is being received.
 
 - Check Video Codec:
-
   - If the camera stream works in go2rtc but not in your browser, the video codec might be unsupported.
   - If using H265, switch to H264. Refer to [video codec compatibility](https://github.com/AlexxIT/go2rtc/tree/v1.9.13#codecs-madness) in go2rtc documentation.
   - If unable to switch from H265 to H264, or if the stream format is different (e.g., MJPEG), re-encode the video using [FFmpeg parameters](https://github.com/AlexxIT/go2rtc/tree/v1.9.13#source-ffmpeg). It supports rotating and resizing video feeds and hardware acceleration. Keep in mind that transcoding video from one format to another is a resource intensive task and you may be better off using the built-in jsmpeg view.
@@ -58,7 +55,6 @@ After adding this to the config, restart Frigate and try to watch the live strea
     ```
 
 - Switch to FFmpeg if needed:
-
   - Some camera streams may need to use the ffmpeg module in go2rtc. This has the downside of slower startup times, but has compatibility with more stream types.
 
     ```yaml
@@ -101,9 +97,9 @@ After adding this to the config, restart Frigate and try to watch the live strea
 
 :::warning
 
-To access the go2rtc stream externally when utilizing the Frigate Add-On (for
+To access the go2rtc stream externally when utilizing the Frigate App (for
 instance through VLC), you must first enable the RTSP Restream port.
-You can do this by visiting the Frigate Add-On configuration page within Home
+You can do this by visiting the Frigate App configuration page within Home
 Assistant and revealing the hidden options under the "Show disabled ports"
 section.
 

docs/docs/guides/getting_started.md

@@ -9,7 +9,7 @@ title: Getting started
 
 If you already have an environment with Linux and Docker installed, you can continue to [Installing Frigate](#installing-frigate) below.
 
-If you already have Frigate installed through Docker or through a Home Assistant Add-on, you can continue to [Configuring Frigate](#configuring-frigate) below.
+If you already have Frigate installed through Docker or through a Home Assistant App, you can continue to [Configuring Frigate](#configuring-frigate) below.
 
 :::
 
@@ -81,7 +81,7 @@ Now you have a minimal Debian server that requires very little maintenance.
 
 ## Installing Frigate
 
-This section shows how to create a minimal directory structure for a Docker installation on Debian. If you have installed Frigate as a Home Assistant Add-on or another way, you can continue to [Configuring Frigate](#configuring-frigate).
+This section shows how to create a minimal directory structure for a Docker installation on Debian. If you have installed Frigate as a Home Assistant App or another way, you can continue to [Configuring Frigate](#configuring-frigate).
 
 ### Setup directories
 
@@ -150,7 +150,7 @@ Here is an example configuration with hardware acceleration configured to work w
 
 `docker-compose.yml` (after modifying, you will need to run `docker compose up -d` to apply changes)
 
-```yaml
+```yaml {4,5}
 services:
   frigate:
     ...
@@ -168,17 +168,57 @@ cameras:
   name_of_your_camera:
     ffmpeg:
       inputs: ...
+      # highlight-next-line
       hwaccel_args: preset-vaapi
     detect: ...
 ```
 
 ### Step 4: Configure detectors
 
-By default, Frigate will use a single CPU detector. If you have a USB Coral, you will need to add a detectors section to your config.
+By default, Frigate will use a single CPU detector.
+
+In many cases, the integrated graphics on Intel CPUs provides sufficient performance for typical Frigate setups. If you have an Intel processor, you can follow the configuration below.
+
+<details>
+  <summary>Use Intel OpenVINO detector</summary>
+
+You need to refer to **Configure hardware acceleration** above to enable the container to use the GPU.
+
+```yaml {3-6,9-15,20-21}
+mqtt: ...
+
+detectors: # <---- add detectors
+  ov:
+    type: openvino  # <---- use openvino detector
+    device: GPU
+
+# We will use the default MobileNet_v2 model from OpenVINO.
+model:
+  width: 300
+  height: 300
+  input_tensor: nhwc
+  input_pixel_format: bgr
+  path: /openvino-model/ssdlite_mobilenet_v2.xml
+  labelmap_path: /openvino-model/coco_91cl_bkgr.txt
+
+cameras:
+  name_of_your_camera:
+    ffmpeg: ...
+    detect:
+      enabled: True # <---- turn on detection
+      ...
+```
+
+</details>
+
+If you have a USB Coral, you will need to add a detectors section to your config.
+
+<details>
+   <summary>Use USB Coral detector</summary>
 
 `docker-compose.yml` (after modifying, you will need to run `docker compose up -d` to apply changes)
 
-```yaml
+```yaml {4-6}
 services:
   frigate:
     ...
@@ -188,7 +228,7 @@ services:
     ...
 ```
 
-```yaml
+```yaml {3-6,11-12}
 mqtt: ...
 
 detectors: # <---- add detectors
@@ -204,6 +244,8 @@ cameras:
       ...
 ```
 
+</details>
+
 More details on available detectors can be found [here](../configuration/object_detectors.md).
 
 Restart Frigate and you should start seeing detections for `person`. If you want to track other objects, they will need to be added according to the [configuration file reference](../configuration/reference.md).
@@ -222,7 +264,7 @@ Note that motion masks should not be used to mark out areas where you do not wan
 
 Your configuration should look similar to this now.
 
-```yaml
+```yaml {16-18}
 mqtt:
   enabled: False
 
@@ -252,7 +294,7 @@ In order to review activity in the Frigate UI, recordings need to be enabled.
 
 To enable recording video, add the `record` role to a stream and enable it in the config. If record is disabled in the config, it won't be possible to enable it in the UI.
 
-```yaml
+```yaml {16-17}
 mqtt: ...
 
 detectors: ...

docs/docs/guides/ha_network_storage.md

@@ -3,7 +3,7 @@ id: ha_network_storage
 title: Home Assistant network storage
 ---
 
-As of Home Assistant 2023.6, Network Mounted Storage is supported for Add-ons.
+As of Home Assistant 2023.6, Network Mounted Storage is supported for Apps.
 
 ## Setting Up Remote Storage For Frigate
 
@@ -14,7 +14,7 @@ As of Home Assistant 2023.6, Network Mounted Storage is supported for Add-ons.
 
 ### Initial Setup
 
-1. Stop the Frigate Add-on
+1. Stop the Frigate App
 
 ### Move current data
 
@@ -37,4 +37,4 @@ Keeping the current data is optional, but the data will need to be moved regardl
 4. Fill out the additional required info for your particular NAS
 5. Connect
 6. Move files from `/media/frigate_tmp` to `/media/frigate` if they were kept in previous step
-7. Start the Frigate Add-on
+7. Start the Frigate App