Merge pull request #110 from 0x2142/add-alert-filters

Add new alert filters

config/config.go

@@ -61,17 +61,19 @@ type Cameras struct {
 }
 
 type Alerts struct {
-	General  General  `fig:"general"`
-	Zones    Zones    `fig:"zones"`
-	Labels   Labels   `fig:"labels"`
-	Discord  Discord  `fig:"discord"`
-	Gotify   Gotify   `fig:"gotify"`
-	SMTP     SMTP     `fig:"smtp"`
-	Telegram Telegram `fig:"telegram"`
-	Pushover Pushover `fig:"pushover"`
-	Nfty     Nfty     `fig:"nfty"`
-	Ntfy     Ntfy     `fig:"ntfy"`
-	Webhook  Webhook  `fig:"webhook"`
+	General   General  `fig:"general"`
+	Quiet     Quiet    `fig:"quiet"`
+	Zones     Zones    `fig:"zones"`
+	Labels    Labels   `fig:"labels"`
+	SubLabels Labels   `fig:"sublabels"`
+	Discord   Discord  `fig:"discord"`
+	Gotify    Gotify   `fig:"gotify"`
+	SMTP      SMTP     `fig:"smtp"`
+	Telegram  Telegram `fig:"telegram"`
+	Pushover  Pushover `fig:"pushover"`
+	Nfty      Nfty     `fig:"nfty"`
+	Ntfy      Ntfy     `fig:"ntfy"`
+	Webhook   Webhook  `fig:"webhook"`
 }
 
 type General struct {
@@ -80,15 +82,21 @@ type General struct {
 	NoSnap     string `fig:"nosnap" default:"allow"`
 }
 
+type Quiet struct {
+	Start string `fig:"start" default:""`
+	End   string `fig:"end" default:""`
+}
+
 type Zones struct {
 	Unzoned string   `fig:"unzoned" default:"allow"`
 	Allow   []string `fig:"allow" default:[]`
 	Block   []string `fig:"block" default:[]`
 }
 
 type Labels struct {
-	Allow []string `fig:"allow" default:[]`
-	Block []string `fig:"block" default:[]`
+	MinScore float64  `fig:"min_score" default:0`
+	Allow    []string `fig:"allow" default:[]`
+	Block    []string `fig:"block" default:[]`
 }
 
 type Discord struct {
@@ -306,6 +314,24 @@ func validateConfig() {
 		}
 	}
 
+	// Check quiet hours config
+	if ConfigData.Alerts.Quiet.Start != "" || ConfigData.Alerts.Quiet.End != "" {
+		timeformat := "15:04"
+		validstart := true
+		validend := true
+		if _, ok := time.Parse(timeformat, ConfigData.Alerts.Quiet.Start); ok != nil {
+			configErrors = append(configErrors, "Start time for quiet hours does not match format: 00:00")
+			validstart = false
+		}
+		if _, ok := time.Parse(timeformat, ConfigData.Alerts.Quiet.End); ok != nil {
+			configErrors = append(configErrors, "End time for quiet hours does not match format: 00:00")
+			validend = false
+		}
+		if validstart && validend {
+			log.Debug().Msgf("Quiet hours enabled. Start: %v, End: %v", ConfigData.Alerts.Quiet.Start, ConfigData.Alerts.Quiet.End)
+		}
+	}
+
 	// Check action on no snapshot available
 	if strings.ToLower(ConfigData.Alerts.General.NoSnap) != "allow" && strings.ToLower(ConfigData.Alerts.General.NoSnap) != "drop" {
 		configErrors = append(configErrors, "Option for nosnap must be 'allow' or 'drop'")
@@ -338,6 +364,9 @@ func validateConfig() {
 	}
 
 	// Check Label filtering config
+	if ConfigData.Alerts.Labels.MinScore > 0 {
+		log.Debug().Msgf("Label required minimum score: %v", ConfigData.Alerts.Labels.MinScore)
+	}
 	if len(ConfigData.Alerts.Labels.Allow) > 0 {
 		log.Debug().Msg("Labels to generate alerts for:")
 		for _, c := range ConfigData.Alerts.Labels.Allow {
@@ -355,6 +384,24 @@ func validateConfig() {
 		log.Debug().Msg("No labels excluded")
 	}
 
+	// Check Subabel filtering config
+	if len(ConfigData.Alerts.SubLabels.Allow) > 0 {
+		log.Debug().Msg("Sublabels to generate alerts for:")
+		for _, c := range ConfigData.Alerts.SubLabels.Allow {
+			log.Debug().Msgf(" - %v", c)
+		}
+	} else {
+		log.Debug().Msg("All Sublabels included in alerts")
+	}
+	if len(ConfigData.Alerts.SubLabels.Block) > 0 {
+		log.Debug().Msg("Sublabels to exclude from alerting:")
+		for _, c := range ConfigData.Alerts.SubLabels.Block {
+			log.Debug().Msgf(" - %v", c)
+		}
+	} else {
+		log.Debug().Msg("No Sublabels excluded")
+	}
+
 	// Check / Load alerting configuration
 	if ConfigData.Alerts.Discord.Enabled {
 		log.Debug().Msg("Discord alerting enabled.")

docs/changelog.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [v0.3.3](https://github.com/0x2142/frigate-notify/releases/tag/v0.3.3) - Upcoming Release
+ - Additional filtering options for alerts:
+     - [Sublabels](https://frigate-notify.0x2142.com/latest/config/file/#sublabels)
+     - [Minimum label score](https://frigate-notify.0x2142.com/latest/config/file/#labels)
+     - [Quiet hours](https://frigate-notify.0x2142.com/latest/config/file/#quiet-hours)
+
 ## [v0.3.2](https://github.com/0x2142/frigate-notify/releases/tag/v0.3.2) - Jun 13 2024
 
  - Allow config to be provided via environment variables (Thanks [@ryan-willis](https://github.com/ryan-willis)!!)

docs/config/file.md

@@ -133,13 +133,31 @@ frigate:
     - Set to `drop` to silently drop these events & not send notifications
 
 ```yaml title="Config File Snippet"
-alerts:  
+alerts:
   general:
     title: Frigate Alert
     timeformat: Mon, 02 Jan 2006 15:04:05 MST
     nosnap: 
 ```
 
+### Quiet Hours
+
+Define a quiet period & supress alerts during this time.
+
+- **start** (Optional)
+    - When quiet period begins, in 24-hour format
+    - Required if `end` is configured
+- **end** (Optional)
+    - When quiet period ends, in 24-hour format
+    - Required if `start` is configured
+
+```yaml title="Config File Snippet"
+alerts:
+  quiet:
+    start: 08:00
+    end: 17:00
+```
+
 ### Zones
 
 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.
@@ -180,6 +198,11 @@ alerts:
 
 Similar to [zones](#zones), notifications can be filtered based on labels. By default, the app will generate notifications regardless of any labels received from Frigate. Using this config section, certain labels can be blocked from sending notifications - or an allowlist can be provided to only generate alerts from specified labels.
 
+- **min_score** (Optional - Default: `0`)
+    - Filter by minimum label score, based on Frigate `top_score` value
+    - Scores are a percent accuracy of object identification (0-100)
+    - For example, to filter objects under 80% accuracy, set `min_score: 80`
+    - By default, any score above 0 will generate an alert
 - **allow** (Optional)
     - Specify a list of labels to allow notifications
     - If set, all other labels will be ignored
@@ -191,13 +214,36 @@ Similar to [zones](#zones), notifications can be filtered based on labels. By de
 ```yaml title="Config File Snippet"
 alerts:
   labels:
+    min_score: 80
     allow:
      - person
      - dog
     block:
      - bird
 ```
 
+### Sublabels
+
+Filter by sublabels, just like normal [labels](#labels).
+
+- **allow** (Optional)
+    - Specify a list of sublabels to allow notifications
+    - If set, all other sublabels will be ignored
+    - If not set, all sublabels will generate notifications
+- **block** (Optional)
+    - Specify a list of sublabels to always ignore
+    - This takes precedence over the `allow` list
+
+```yaml title="Config File Snippet"
+alerts:
+  sublabels:
+    allow:
+     - ABCD
+     - EFGH
+    block:
+     - XYZ
+```
+
 ### Discord
 
 - **enabled** (Optional - Default: `false`)

docs/config/sample.md

@@ -35,6 +35,10 @@ alerts:
     timeformat:
     nosnap:
 
+  quiet:
+    start:
+    end:
+
   zones:
     unzoned: allow
     allow:
@@ -43,12 +47,19 @@ alerts:
      - test_zone_02
 
   labels:
+    min_score:
     allow:
      - person
      - dog
     block:
      - bird
 
+  sublabels:
+    allow:
+     - ABCD
+    block:
+     - EFGH
+
   discord:
     enabled: false
     webhook: 

events/api.go

@@ -79,8 +79,8 @@ func CheckForEvents() {
 			Str("event_id", event.ID).
 			Msgf("Event start time: %s", eventTime)
 
-		// Check that event passes the zone & label filters
-		if !isAllowedZone(event.ID, event.Zones) || !isAllowedLabel(event.ID, event.Label) {
+		// Check that event passes configured filters
+		if !checkEventFilters(event) {
 			return
 		}