Initial version of more advanced scan mode control.

src/card-controller/triggers-manager.ts

@@ -2,30 +2,44 @@ import { HomeAssistant } from '@dermotduffy/custom-card-helpers';
 import orderBy from 'lodash-es/orderBy';
 import { getHassDifferences, isTriggeredState } from '../utils/ha';
 import { Timer } from '../utils/timer';
+import { View } from '../view/view';
 import { CardTriggersAPI } from './types';
 
 export class TriggersManager {
   protected _api: CardTriggersAPI;
 
-  protected _triggers: Map<string, Date> = new Map();
-  protected _untriggerTimer = new Timer();
+  protected _triggeredCameras: Map<string, Date> = new Map();
+  protected _triggeredCameraTimers: Map<string, Timer> = new Map();
+  protected _triggeredState: Set<string> = new Set();
 
   constructor(api: CardTriggersAPI) {
     this._api = api;
   }
 
-  public isTriggered(): boolean {
-    return !!this._triggers.size || this._untriggerTimer.isRunning();
+  public getTriggeredCameraIDs(): Set<string> {
+    return new Set(this._triggeredCameras.keys());
   }
 
-  public updateTriggeredCameras(oldHass?: HomeAssistant | null): boolean {
-    if (!this._shouldTrackTriggers()) {
-      return false;
+  public isTriggered(): boolean {
+    return !!this._triggeredCameras.size;
+  }
+
+  public getMostRecentlyTriggeredCameraID(): string | null {
+    const sorted = orderBy(
+      [...this._triggeredCameras.entries()],
+      (entry) => entry[1].getTime(),
+      'desc',
+    );
+    return sorted.length ? sorted[0][0] : null;
+  }
+
+  public updateTriggerHAState(oldHass?: HomeAssistant | null): void {
+    const scanConfig = this._api.getConfigManager().getConfig()?.view.scan;
+    if (!scanConfig || !scanConfig.enabled) {
+      return;
     }
 
     const hass = this._api.getHASSManager().getHASS();
-
-    const now = new Date();
     let triggerChanges = false;
 
     const visibleCameraIDs = this._api
@@ -45,88 +59,108 @@ export class TriggersManager {
         (entity) => !isTriggeredState(hass?.states[entity]),
       );
       if (shouldTrigger) {
-        this._triggers.set(cameraID, now);
+        this._triggeredState.add(cameraID);
         triggerChanges = true;
-      } else if (shouldUntrigger && this._triggers.has(cameraID)) {
-        this._triggers.delete(cameraID);
+      } else if (shouldUntrigger && this._triggeredState.has(cameraID)) {
+        this._triggeredState.delete(cameraID);
         triggerChanges = true;
       }
     }
 
     if (triggerChanges) {
-      const targetCameraID = this._getMostRecentTrigger();
-      if (targetCameraID) {
-        this._triggerAction(targetCameraID);
-        return true;
-      } else {
-        this._startUntriggerTimer();
+      this._evaluateTriggers();
+    }
+  }
+
+  public updateView(oldView?: View | null): void {
+    if (oldView?.camera !== this._api.getViewManager().getView()?.camera) {
+      // If the view changes, a new camera may have been selected, which may
+      // mean a trigger is required (in the case that `trigger_filter_camera`
+      // has been set to `selected`).
+      this._evaluateTriggers();
+    }
+  }
+
+  protected _evaluateTriggers(): void {
+    const scanConfig = this._api.getConfigManager().getConfig()?.view.scan;
+    if (!scanConfig) {
+      return;
+    }
+
+    const now = new Date();
+    for (const cameraID of this._triggeredState.keys()) {
+      if (
+        !this._triggeredCameras.has(cameraID) &&
+        (scanConfig.trigger_filter_camera === 'all' ||
+          (scanConfig.trigger_filter_camera === 'selected' &&
+            cameraID === this._api.getViewManager().getView()?.camera))
+      ) {
+        this._triggeredCameras.set(cameraID, now);
+        this._triggerAction();
       }
     }
-    return false;
-  }
 
-  public untrigger(): void {
-    const wasTriggered = this.isTriggered();
-    this._triggers.clear();
-    this._untriggerTimer.stop();
-
-    if (wasTriggered) {
-      this._untriggerAction();
+    for (const cameraID of this._triggeredCameras.keys()) {
+      if (!this._triggeredState.has(cameraID)) {
+        this._startUntriggerTimer(cameraID);
+      }
     }
   }
 
-  protected _triggerAction(cameraID: string): void {
-    const view = this._api.getViewManager().getView();
-    if (
-      this._isAutomatedViewUpdateAllowed() &&
-      (view?.camera !== cameraID || !view?.is('live'))
-    ) {
-      this._api.getViewManager().setViewByParameters({
-        viewName: 'live',
-        cameraID: cameraID,
-      });
-    }
-  }
+  protected _hasAllowableInteractionState(): boolean {
+    const scanConfig = this._api.getConfigManager().getConfig()?.view.scan;
+    const hasInteraction = this._api.getInteractionManager().hasInteraction();
 
-  protected _untriggerAction(): void {
-    if (
-      !this.isTriggered() &&
-      this._isAutomatedViewUpdateAllowed() &&
-      this._api.getConfigManager().getConfig()?.view.scan.untrigger_reset
-    ) {
-      this._api.getViewManager().setViewDefault();
-    }
-  }
-
-  protected _isAutomatedViewUpdateAllowed(): boolean {
     return (
-      this._api.getConfigManager().getConfig()?.view.update_force ||
-      !this._api.getInteractionManager().hasInteraction()
+      !!scanConfig &&
+      (scanConfig.interaction_mode === 'all' ||
+        (scanConfig.interaction_mode === 'active' && hasInteraction) ||
+        (scanConfig.interaction_mode === 'inactive' && !hasInteraction))
     );
   }
 
-  protected _shouldTrackTriggers(): boolean {
-    return !!this._api.getConfigManager().getConfig()?.view.scan.enabled;
+  protected _triggerAction(): void {
+    const action = this._api.getConfigManager().getConfig()?.view.scan.trigger_action;
+
+    if (action && this._hasAllowableInteractionState()) {
+      this._api.getActionsManager().executeActions(action);
+    }
+
+    // Must update master element to add border pulsing.
+    this._api.getCardElementManager().update();
   }
 
-  protected _startUntriggerTimer(): void {
-    this._untriggerTimer.start(
+  protected _untriggerAction(cameraID: string): void {
+    const action = this._api.getConfigManager().getConfig()?.view.scan.untrigger_action;
+
+    if (action && this._hasAllowableInteractionState()) {
+      this._api.getActionsManager().executeActions(action);
+    }
+    this._triggeredCameras.delete(cameraID);
+    this._deleteTimer(cameraID);
+
+    // Must update master element to remove border pulsing.
+    this._api.getCardElementManager().update();
+  }
+
+  protected _startUntriggerTimer(cameraID: string): void {
+    this._deleteTimer(cameraID);
+
+    const timer = new Timer();
+    this._triggeredCameraTimers.set(cameraID, timer);
+    timer.start(
       /* istanbul ignore next: the case of config being null here cannot be
          reached, as there's no way to have the untrigger call happen without
          a config. -- @preserve */
       this._api.getConfigManager().getConfig()?.view.scan.untrigger_seconds ?? 0,
       () => {
-        this._untriggerAction();
+        this._untriggerAction(cameraID);
       },
     );
   }
 
-  protected _getMostRecentTrigger(): string | null {
-    const sorted = orderBy(
-      [...this._triggers.entries()],
-      (entry) => entry[1].getTime(),
-      'desc',
-    );
-    return sorted.length ? sorted[0][0] : null;
+  protected _deleteTimer(cameraID: string): void {
+    this._triggeredCameraTimers.get(cameraID)?.stop();
+    this._triggeredCameraTimers.delete(cameraID);
   }
 }