Skip to content

Commit

Permalink
Merge pull request #42 from 0x2142/update-docs
Browse files Browse the repository at this point in the history
Minor docs updates
  • Loading branch information
0x2142 authored May 3, 2024
2 parents 86fa87e + 63673e6 commit cf9b8d4
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
10 changes: 10 additions & 0 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,16 @@ alerts:

This config section allows control over whether to generate alerts on all zones, or only specific ones. By default, the app will generate notifications on **all** Frigate events, regardless of whether the event includes zone info.

??? note "A note about how this works"

**With MQTT**, Frigate will send a `new` event when a detection starts. Subsequent changes, like the detected object transitioning from one zone to another, will trigger `update` events. These `update` events will contain a list of current zone(s) that the object is in, as well as a list of all zones that the object has entered during the event.

In order to reduce the number of notifications generated, this app will only alert on the *first time* the detected object enters a zone.

For example, let's say you have a camera in your front yard with zones for sidewalk, driveway, and lawn - but only allow notifications for driveway and lawn. During an event someone was detected originally on the sidewalk, then driveway, lawn, and back to driveway. In this case, you should only receive two notifications. Once for the first time the person entered the driveway zone, and a second when they entered the lawn zone.

**With Web API event query**, we only query the event from Frigate one time. So currently, only one alert would be sent depending on the detected zones at the time the web API was queried for new events.

- **unzoned** (Optional - Default: `allow`)
- Controls alerts on events outside a zone
- By default, events without a zone will generate alerts
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ If you get value out of this tool, please let me know by leaving a star: <a cla

## About the Project

This project is designed to generate notifications based on [Frigate](https://github.com/blakeblackshear/frigate) NVR events.
This project is designed to generate notifications based on events from a standalone instance of [Frigate](https://github.com/blakeblackshear/frigate) NVR.

Currently Frigate only supports notifications through Home Assistant, which I'm not using right now. So I set out to build a simple notification app that would work with a standalone Frigate server.
Currently Frigate only supports notifications through Home Assistant, which I'm not using at the moment. So I set out to build a simple notification app that would work with a standalone Frigate server.

## Features

Expand Down

0 comments on commit cf9b8d4

Please sign in to comment.