homebridge-ecobee-security 0.7.0 → 0.7.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.7.1
+
+- Keypad unlock: the plugin now reads ecobee's current state first and only disarms when the system
+  is armed, arming or alarming. A disarm sent while it was already off was followed by ecobee camera
+  activity alerts.
+- An intrusion incident only shows as **Alarm triggered** while the system is armed. ecobee also
+  opens one for a camera activity alert while the system is off, which briefly showed as an alarm in
+  the Home app (and counted as one for security holds). Smoke alarms still show at any time.
+
 ## 0.7.0
 
 - New setting **Disarm when a door is unlocked with its keypad** (`keypadDisarm`, off by default,

package/README.md

@@ -92,8 +92,9 @@ node <plugin folder>/bin/ecobee-login.js --browser  # website sign-in
   exit delay (0 by default). Off needs no PIN.
 - **Changes from elsewhere** (ecobee app, keypad, ecobee automations) show up within 10 s, about
   as fast as in the ecobee app (it polls too), and quickly after an exit delay ends.
-- **Alarm triggered** while ecobee lists an open incident (see `alarmTrigger` above for when it
-  starts showing). Disarming clears it. Every change in the incident list is logged.
+- **Alarm triggered** while ecobee lists an open incident: a smoke alarm at any time, an intrusion
+  only while armed (ecobee also opens one for a camera activity alert while the system is off; that
+  isn't shown as an alarm). See `alarmTrigger` above for when it starts showing. Disarming clears it. Every change in the incident list is logged.
 - **Siri:** asking for Home or for Stay mode both set Home (ecobee's Stay).
 - **Night** is only offered with `offerNight`; ecobee has no Night mode of its own.
 - After three failed reads in a row the accessory shows a fault; reads back off up to 5 minutes.
@@ -111,6 +112,8 @@ schedules, expiry), so the plugin needs no codes of its own.
   unlocked (HomeKit's Lock Last Known Action), for example homebridge-nest-accfactory's Nest × Yale
   locks. The settings page lists the locks found; untick the ones that shouldn't disarm. Locks
   paired to Apple Home directly (not through Homebridge) can't be seen.
+- **Only when armed:** the plugin checks ecobee's current state first and sends nothing if the system
+  is already off.
 - **Only keypad unlocks** count: not the app, Siri, automations, a key or the thumb turn. Any code
   that opens the lock disarms, yours included.
 - **Speed:** the plugin checks the locks every second; the disarm reaches ecobee about as fast as

package/lib/security.js

@@ -73,7 +73,7 @@ export class SecuritySystem {
     this.alarmAfterEntryDelay = alarmAfterEntryDelay;
     // Extra exit-delay time for robots heading back to their base when Away is armed (ms).
     this.returnWait = Math.max(0, returnWait) * 1000;
-    this.incidents = [];
+    this.openIncidents = [];
     this.firstSeen = new Map();
 
     const { Service, Characteristic } = api.hap;
@@ -259,8 +259,17 @@ export class SecuritySystem {
     }
   }
 
+  /**
+   * Open incidents that are alarms: smoke always, intrusions only while armed. ecobee also opens an
+   * intrusion incident for a camera activity alert while the system is off; that isn't an alarm.
+   */
+  get incidents() {
+    const armed = [ArmedState.STAY, ArmedState.AWAY].includes(this.monitoring?.armedState);
+    return this.openIncidents.filter(i => i.detectedSmokeAlarm || armed);
+  }
+
   noteIncidents(incidents) {
-    this.incidents = incidents.filter(i => !CLOSED_INCIDENT.test(i.status ?? ''));
+    this.openIncidents = incidents.filter(i => !CLOSED_INCIDENT.test(i.status ?? ''));
     const summary = JSON.stringify(incidents);
     if (summary !== this.incidentSummary) {
       if (incidents.length || this.incidentSummary !== undefined) {
@@ -270,8 +279,8 @@ export class SecuritySystem {
     }
     // ecobee's incidents carry no time we read, so the entry delay counts from when we first saw one.
     const now = Date.now();
-    const ids = new Set(this.incidents.map(i => i.id));
-    this.incidents.forEach(i => this.firstSeen.has(i.id) || this.firstSeen.set(i.id, now));
+    const ids = new Set(this.openIncidents.map(i => i.id));
+    this.openIncidents.forEach(i => this.firstSeen.has(i.id) || this.firstSeen.set(i.id, now));
     [...this.firstSeen.keys()].filter(id => !ids.has(id)).forEach(id => this.firstSeen.delete(id));
   }
 
@@ -388,9 +397,8 @@ export class SecuritySystem {
 
 
   /**
-   * A door was unlocked with its keypad: disarm, like Nest Guard with a Nest × Yale lock. Always sent,
-   * even if the last poll said Off: it may be up to 10 s old, and disarming twice does no harm.
-   * Retried once, since a missed disarm means an alarm.
+   * A door was unlocked with its keypad: disarm, like Nest Guard with a Nest × Yale lock. Retried
+   * once, since a missed disarm means an alarm.
    */
   keypadDisarm(lock) {
     return this.serial(async () => {
@@ -398,6 +406,13 @@ export class SecuritySystem {
         this.log.info(`${lock} was unlocked during the ${this.holders().join(' and ')} hold; it won't be put back to Away.`);
         this.dropHold();
       }
+      // Only disarm what's armed: a disarm sent while ecobee is already off isn't a no-op for ecobee
+      // (camera activity alerts followed it), so read the live state first. Can't read it: disarm anyway.
+      if (await this.refresh() && this.monitoring?.armedState === ArmedState.DISARMED
+        && !this.monitoring.delayedArmedState?.desiredArmedState) {
+        this.log.info(`${lock} was unlocked with its keypad; the security system is already off.`);
+        return;
+      }
       try {
         await this.arm(Hk.DISARMED, `${lock} unlocked with its keypad`);
       } catch {
@@ -552,7 +567,7 @@ export class SecuritySystem {
       this.apply(home);
       return true;
     } catch (error) {
-      this.log.warn(`Could not read the security state for a hold (${error.message}).`);
+      this.log.warn(`Could not read the security state (${error.message}).`);
       return false;
     }
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "homebridge-ecobee-security",
   "displayName": "ecobee Smart Security",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "ecobee Smart Security as a HomeKit security system: arm Stay / Away, disarm, alarm state (unofficial, ecobee cloud)",
   "type": "module",
   "main": "index.js",