Browse Source

further doc clarifications

Blake Blackshear 3 years ago
parent
commit
0260d824a6

+ 14 - 0
docs/docs/configuration/advanced.md

@@ -48,3 +48,17 @@ This may need to be in a custom location if network storage is used for the medi
 If using a custom model, the width and height will need to be specified.
 
 The labelmap can be customized to your needs. A common reason to do this is to combine multiple object types that are easily confused when you don't need to be as granular such as car/truck. By default, truck is renamed to car because they are often confused. You cannot add new object types, but you can change the names of existing objects in the model.
+
+```yaml
+model:
+  labelmap:
+    2: vehicle
+    3: vehicle
+    5: vehicle
+    7: vehicle
+    15: animal
+    16: animal
+    17: animal
+```
+
+Note that if you rename objects in the labelmap, you will also need to update your `objects -> track` list as well.

+ 5 - 1
docs/docs/configuration/zones.md

@@ -20,6 +20,10 @@ camera:
       required_zones:
         - entire_yard
         - front_yard_street
+  snapshots:
+    required_zones:
+      - entire_yard
+      - front_yard_street
   zones:
     entire_yard:
       coordinates: ... (everywhere you want a person)
@@ -31,4 +35,4 @@ camera:
         - car
 ```
 
-Only car objects can trigger the `front_yard_street` zone and only person can trigger the `entire_yard`. You will get clips for person objects that enter anywhere in the yard, and clips for cars only if they enter the street.
+Only car objects can trigger the `front_yard_street` zone and only person can trigger the `entire_yard`. You will get events for person objects that enter anywhere in the yard, and events for cars only if they enter the street.

+ 4 - 4
docs/docs/guides/stationary_objects.md

@@ -15,14 +15,14 @@ Frigate is designed to track objects as they move and over-masking can prevent i
 
 :::
 
-For example, you could create multiple zones that cover your driveway. For cars, you would only notify if entered_zones has more than 1 zone. For person, you would notify regardless of the number of entered_zones.
+To only be notified of cars that enter your driveway from the street, you could create multiple zones that cover your driveway. For cars, you would only notify if `entered_zones` from the events MQTT topic has more than 1 zone.
 
-See [this example](/configuration/zones#restricting-zones-to-specific-objects) from the Zones documentation.
-
-You can also create a zone for the entrance of your driveway and only save an event if that zone is in the list of entered_zones when the object is a car.
+See [this example](/configuration/zones#restricting-zones-to-specific-objects) from the Zones documentation to see how to restrict zones to certain object types.
 
 ![Driveway Zones](/img/driveway_zones-min.png)
 
+To limit snapshots and events, you can list the zone for the entrance of your driveway under `required_zones` in your configuration file. Example below.
+
 ```yaml
 camera:
   record: