Allow for excluding id patterns (#751)

* Add exclude_devices to config
ESPresense · Sep 30, 2024 · 5b55335 · 5b55335
1 parent ce81b87
commit 5b55335
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 20 deletions.
diff --git a/src/Models/Config.cs b/src/Models/Config.cs
@@ -27,7 +27,11 @@ public class Config
         [YamlMember(Alias = "nodes")]
         public ConfigNode[] Nodes { get; set; } = Array.Empty<ConfigNode>();
 
-        [YamlMember(Alias = "devices")] public ConfigDevice[] Devices { get; set; } = Array.Empty<ConfigDevice>();
+        [YamlMember(Alias = "devices")]
+        public ConfigDevice[] Devices { get; set; } = Array.Empty<ConfigDevice>();
+
+        [YamlMember(Alias = "exclude_devices")]
+        public ConfigDevice[] ExcludeDevices { get; set; } = Array.Empty<ConfigDevice>();
 
         [YamlMember(Alias = "history")]
         public ConfigHistory History { get; set; } = new();

diff --git a/src/Models/State.cs b/src/Models/State.cs
@@ -115,5 +115,32 @@ public IEnumerable<Scenario> GetScenarios(Device device)
         //yield return new Scenario(_state.Config, new MultiFloorMultilateralizer(device, _state), "Multifloor");
         yield return new Scenario(Config, new NearestNode(device), "NearestNode");
     }
-}
 
+    public bool ShouldTrack(Device device)
+    {
+        if (IsExcluded(device))
+            return false;
+
+        if (ConfigDeviceById.TryGetValue(device.Id, out var cdById))
+        {
+            if (!string.IsNullOrWhiteSpace(cdById.Name))
+                device.Name = cdById.Name;
+            return true;
+        }
+        if (!string.IsNullOrWhiteSpace(device.Name) && ConfigDeviceByName.TryGetValue(device.Name, out _))
+            return true;
+        if (!string.IsNullOrWhiteSpace(device.Id) && IdsToTrack.Any(a => a.IsMatch(device.Id)))
+            return true;
+        if (!string.IsNullOrWhiteSpace(device.Name) && NamesToTrack.Any(a => a.IsMatch(device.Name)))
+            return true;
+        return false;
+    }
+
+    private bool IsExcluded(Device device)
+    {
+        return Config?.ExcludeDevices.Any(d =>
+            (!string.IsNullOrWhiteSpace(d.Id) && !string.IsNullOrWhiteSpace(device.Id) && Glob.Parse(d.Id).IsMatch(device.Id)) ||
+            (!string.IsNullOrWhiteSpace(d.Name) && !string.IsNullOrWhiteSpace(device.Name) && Glob.Parse(d.Name).IsMatch(device.Name))
+        ) ?? false;
+    }
+}
diff --git a/src/Services/DeviceTracker.cs b/src/Services/DeviceTracker.cs
@@ -117,30 +117,13 @@ private async Task CheckIdleDevicesAsync(CancellationToken stoppingToken)
         }
     }
 
-    private bool ShouldTrackDevice(Device device)
-    {
-        if (state.ConfigDeviceById.TryGetValue(device.Id, out var cdById))
-        {
-            if (!string.IsNullOrWhiteSpace(cdById.Name))
-                device.Name = cdById.Name;
-            return true;
-        }
-        if (!string.IsNullOrWhiteSpace(device.Name) && state.ConfigDeviceByName.TryGetValue(device.Name, out _))
-            return true;
-        if (!string.IsNullOrWhiteSpace(device.Id) && state.IdsToTrack.Any(a => a.IsMatch(device.Id)))
-            return true;
-        if (!string.IsNullOrWhiteSpace(device.Name) && state.NamesToTrack.Any(a => a.IsMatch(device.Name)))
-            return true;
-        return false;
-    }
-
     private async Task<bool> CheckDeviceAsync(Device device)
     {
         var wasTracked = device.Track;
         if (device.Check)
         {
             Log.Debug("Checking {Device}", device);
-            device.Track = ShouldTrackDevice(device);
+            device.Track = state.ShouldTrack(device);
             device.Check = false;
         }
         if (device.Track != wasTracked)

diff --git a/src/config.example.yaml b/src/config.example.yaml
@@ -209,3 +209,7 @@ devices:
   - id: "keys:*"
   - id: "therm:*"
   - id: "iBeacon:*"
+
+# Devices to NOT track
+exclude_devices:
+  - id: "iBeacon:e5ca1ade-f007-ba11-0000-000000000000-*" # These are junk, we alias them to node:*