From e1c541735a12659b4ddcba1858c477512a3508a6 Mon Sep 17 00:00:00 2001
From: Josh Hawkins <32435876+hawkeye217@users.noreply.github.com>
Date: Sat, 26 Oct 2024 06:24:59 -0500
Subject: [PATCH] docs

---
 .cspell/frigate-dictionary.txt                |  3 ++
 .../license_plate_recognition.md              | 48 +++++++++++++++++++
 docs/sidebars.ts                              |  1 +
 3 files changed, 52 insertions(+)
 create mode 100644 docs/docs/configuration/license_plate_recognition.md

diff --git a/.cspell/frigate-dictionary.txt b/.cspell/frigate-dictionary.txt
index 2849bc2ef..5e6ff5b03 100644
--- a/.cspell/frigate-dictionary.txt
+++ b/.cspell/frigate-dictionary.txt
@@ -61,6 +61,7 @@ dsize
 dtype
 ECONNRESET
 edgetpu
+facenet
 fastapi
 faststart
 fflags
@@ -114,6 +115,8 @@ itemsize
 Jellyfin
 jetson
 jetsons
+jina
+jinaai
 joserfc
 jsmpeg
 jsonify
diff --git a/docs/docs/configuration/license_plate_recognition.md b/docs/docs/configuration/license_plate_recognition.md
new file mode 100644
index 000000000..b2fbb6214
--- /dev/null
+++ b/docs/docs/configuration/license_plate_recognition.md
@@ -0,0 +1,48 @@
+---
+id: license_plate_recognition
+title: License Plate Recognition (LPR)
+---
+
+Frigate can recognize license plates on vehicles and automatically add the detected characters as a `sub_label` to objects that are of type `car`. A common use case may be to read the license plates of cars pulling into a driveway or cars passing by on a street with a dedicated LPR camera.
+
+Users running a Frigate+ model should ensure that `license_plate` is added to the [list of objects to track](https://docs.frigate.video/plus/#available-label-types) either globally or for a specific camera. This will improve the accuracy and performance of the LPR model.
+
+LPR is most effective when the vehicle’s license plate is fully visible to the camera. For moving vehicles, Frigate will attempt to read the plate continuously, refining its detection and keeping the most confident result. LPR will not run on stationary vehicles.
+
+## Minimum System Requirements
+
+License plate recognition works by running AI models locally on your system. The models are relatively lightweight and run on your CPU. At least 4GB of RAM is required.
+
+## Configuration
+
+License plate recognition is disabled by default. Enable it in your config file:
+
+```yaml
+lpr:
+  enabled: true
+```
+
+## Advanced Configuration
+
+Several options are available to fine-tune the LPR feature. For example, you can adjust the `min_area` setting, which defines the minimum size in pixels a license plate must be before LPR runs. The default is 500 pixels.
+
+Additionally, you can define `known_plates`, allowing Frigate to label tracked vehicles with custom sub_labels when a recognized plate is detected. This information is then accessible in the UI, filters, and notifications.
+
+```yaml
+lpr:
+  enabled: true
+  min_area: 500
+  known_plates:
+    Wife's Car:
+      - "ABC-1234"
+      - "ABC-I234"
+    Johnny:
+      - "JHN-1234"
+      - "JMN-1234"
+      - "JHN-I234"
+    Sally:
+      - "SLL-1234"
+      - "5LL-1234"
+```
+
+In this example, "Wife's Car" will appear as the label for any vehicle matching the plate "ABC-1234." The model might occasionally interpret the digit 1 as a capital I (e.g., "ABC-I234"), so both variations are listed. Similarly, multiple possible variations are specified for Johnny and Sally.
diff --git a/docs/sidebars.ts b/docs/sidebars.ts
index 1038b1f98..8b31c61d0 100644
--- a/docs/sidebars.ts
+++ b/docs/sidebars.ts
@@ -37,6 +37,7 @@ const sidebars: SidebarsConfig = {
         'configuration/semantic_search',
         'configuration/genai',
         'configuration/face_recognition',
+        'configuration/license_plate_recognition',
       ],
       Cameras: [
         'configuration/cameras',