From 03f516cb67bed82ee7664bb7533fea1014fa6278 Mon Sep 17 00:00:00 2001
From: Nick Mowen <nickmowen213@gmail.com>
Date: Sat, 9 Apr 2022 18:13:34 -0600
Subject: [PATCH] Add docs to elaborate more on stationary tracking

---
 docs/docs/configuration/stationary_objects.md | 24 +++++++++++++++++++
 docs/sidebars.js                              |  1 +
 2 files changed, 25 insertions(+)
 create mode 100644 docs/docs/configuration/stationary_objects.md

diff --git a/docs/docs/configuration/stationary_objects.md b/docs/docs/configuration/stationary_objects.md
new file mode 100644
index 000000000..cf4fe7d79
--- /dev/null
+++ b/docs/docs/configuration/stationary_objects.md
@@ -0,0 +1,24 @@
+# Stationary Objects
+
+An object is considered stationary when it is being tracked and has been in a very similar position for a certain number of frames. This number is defined in the configuration under `detect -> stationary -> threshold`, and is 10x the frame rate (or 10 seconds) by default. Once an object is considered stationary, it will remain stationary until motion occurs near the object at which point it will be considered active.
+
+## Why does it matter if an object is stationary?
+
+Once an object becomes stationary, object detection will not be continually run on that object. This serves to reduce resource usage and redundant detections when there has been no motion near the tracked object. This also means that Frigate is contextually aware, and can for example [filter out recording segments](record.md) to only when the object is considered active.
+
+## Tuning stationary behavior
+
+The default config is:
+
+```yaml
+detect:
+  stationary:
+    interval: 0
+    threshold: 50
+```
+
+`interval` is defined as the frequency for running detection on stationary objects. This means that by default, once an object is considered stationary detection will not be run on it until motion is detected. With `interval > 0`, every nth frames detection will be run to make sure the object is still there. 
+
+NOTE: There is no way to disable stationary object tracking with this value.
+
+`threshold` is the number of frames an object needs to remain relatively still before it is considered stationary.
diff --git a/docs/sidebars.js b/docs/sidebars.js
index 2b3669bdf..75260d1b2 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -22,6 +22,7 @@ module.exports = {
       'configuration/objects',
       'configuration/rtmp',
       'configuration/zones',
+      'configuration/stationary_objects',
       'configuration/advanced',
       'configuration/hardware_acceleration',
       'configuration/nvdec',