homebridge-securitysystem 8.3.0-beta.1 → 8.3.0-beta.3

package/.github/workflows/stale-activity.yml

@@ -24,3 +24,4 @@ jobs:
           stale-pr-message: "This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in a few days if no further activity occurs. Thank you for your contributions."
           stale-issue-label: "stale"
           stale-pr-label: "stale"
+          exempt-issue-labels: "feature,enhancement"

package/config.schema.json

@@ -207,7 +207,7 @@
         "required": false,
         "minimum": 0
       },
-      "away_extended_trigger_seconds": {
+      "mode_away_extended_switch_trigger_seconds": {
         "title": "Away Extended Delay Trigger Seconds",
         "description": "",
         "type": "integer",
@@ -311,14 +311,14 @@
         "required": false,
         "minimum": 0
       },
-      "siren_sensor": {
+      "triggered_sensor": {
         "title": "Show Triggered Sensor",
         "description": "Adds a sensor that triggers multiple times when the security system has been triggered.",
         "type": "boolean",
         "default": false,
         "required": false
       },
-      "siren_sensor_seconds": {
+      "triggered_sensor_seconds": {
         "title": "Triggered Sensor Seconds",
         "description": "",
         "type": "integer",
@@ -383,21 +383,21 @@
         "default": false,
         "required": false
       },
-      "siren_switch": {
+      "trip_switch": {
         "title": "Show Trip Switch",
         "description": "Adds a global switch that will trip the security system.",
         "type": "boolean",
         "default": false,
         "required": false
       },
-      "siren_override_switch": {
+      "trip_override_switch": {
         "title": "Show Trip Override Switch",
         "description": "Adds a special switch that will trigger the security system bypassing the conditions set.",
         "type": "boolean",
         "default": false,
         "required": false
       },
-      "siren_mode_switches": {
+      "trip_mode_switches": {
         "title": "Show Trip Mode Switches",
         "description": "Adds switches that will trigger the security system when their mode is set.",
         "type": "boolean",
@@ -744,7 +744,7 @@
           "flex-direction": "row",
           "items": [
             "mode_away_extended_switch",
-            "away_extended_trigger_seconds"
+            "mode_away_extended_switch_trigger_seconds"
           ]
         },
         {
@@ -756,9 +756,9 @@
         },
         "arming_lock_switch",
         "arming_lock_switches",
-        "siren_switch",
-        "siren_override_switch",
-        "siren_mode_switches",
+        "trip_switch",
+        "trip_override_switch",
+        "trip_mode_switches",
         "audio_switch"
       ]
     },
@@ -771,13 +771,13 @@
       "items": [
         "arming_sensor",
         "tripped_sensor",
-        "siren_sensor",
+        "triggered_sensor",
         {
           "type": "div",
           "displayFlex": true,
           "flex-flow": "row wrap",
           "flex-direction": "row",
-          "items": ["tripped_sensor_seconds", "siren_sensor_seconds"]
+          "items": ["tripped_sensor_seconds", "triggered_sensor_seconds"]
         },
         "reset_sensor"
       ]

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "homebridge-securitysystem",
   "displayName": "Homebridge Security System",
-  "version": "8.3.0-beta.1",
+  "version": "8.3.0-beta.3",
   "description": "Homebridge plugin that creates a security system accessory that can be triggered by HomeKit sensors.",
   "main": "src/index.js",
   "scripts": {

package/src/index.js

@@ -1,3 +1,6 @@
+// WARNING:
+// I didn't know about TypeScript when I wrote this code. I'm sorry.
+
 const fs = require("fs");
 const path = require("path");
 const storage = require("node-persist");
@@ -13,7 +16,7 @@ const HK_NOT_ALLOWED_IN_CURRENT_STATE = -70412;
 
 const originTypes = {
   REGULAR_SWITCH: 0,
-  SPECIAL_SWITCH: 1,
+  OVERRIDE_SWITCH: 1,
   INTERNAL: 3,
   EXTERNAL: 4,
 };
@@ -652,7 +655,7 @@ SecuritySystem.prototype.load = async function () {
         this.currentState
       );
 
-      this.handleTargetStateChange(false);
+      this.handleTargetStateChange(originTypes.INTERNAL);
 
       // Log
       this.logMode("Current", this.currentState);
@@ -697,10 +700,6 @@ SecuritySystem.prototype.identify = function (callback) {
 
 // Services
 SecuritySystem.prototype.addArmingMotionSensor = function () {
-  if (options.armingMotionSensor === false) {
-    return;
-  }
-
   this.armingMotionSensorService = new Service.MotionSensor(
     "Arming",
     "arming-motion-sensor"
@@ -715,7 +714,9 @@ SecuritySystem.prototype.addArmingMotionSensor = function () {
     .getCharacteristic(Characteristic.MotionDetected)
     .on("get", this.getArmingMotionDetected.bind(this));
 
-  this.services.push(this.armingMotionSensorService);
+  if (options.armingMotionSensor) {
+    this.services.push(this.armingMotionSensorService);
+  }
 };
 
 // Security system
@@ -814,26 +815,42 @@ SecuritySystem.prototype.setCurrentState = function (state, origin) {
     this.logMode("Current", state);
   }
 
-  this.handleCurrentStateChange(state, origin);
+  this.handleCurrentStateChange(origin);
   this.save();
 };
 
-SecuritySystem.prototype.handleCurrentStateChange = function (state, origin) {
-  // Commands
-  this.executeCommand("current", state, origin);
-
-  // Webhooks
-  this.sendWebhookEvent("current", state, origin);
-
+SecuritySystem.prototype.handleCurrentStateChange = function (origin) {
   const isCurrentStateAlarmTriggered =
-    state === Characteristic.SecuritySystemCurrentState.ALARM_TRIGGERE;
+    this.currentState ===
+    Characteristic.SecuritySystemCurrentState.ALARM_TRIGGERED;
 
   if (isCurrentStateAlarmTriggered) {
     this.handleTriggeredState();
+
+    if (options.testMode) {
+      return;
+    }
   }
+
+  // Reset trip switches if on
+  this.resetTripSwitches();
+
+  // Commands
+  this.executeCommand("current", this.currentState, origin);
+
+  // Webhooks
+  this.sendWebhookEvent("current", this.currentState, origin);
 };
 
 SecuritySystem.prototype.handleTriggeredState = function () {
+  // Clear tripped interval
+  if (this.trippedMotionSensorInterval !== null) {
+    clearInterval(this.trippedMotionSensorInterval);
+
+    this.trippedMotionSensorInterval = null;
+    this.log.debug("Tripped interval (Cleared)");
+  }
+
   // Trigger triggered motion sensor
   // every configured seconds
   this.triggeredMotionSensorInterval = setInterval(() => {
@@ -855,8 +872,7 @@ SecuritySystem.prototype.handleTriggeredState = function () {
     }
 
     // Normal flow
-    this.handleTargetStateChange(false);
-    this.setCurrentState(this.targetState, false);
+    this.setCurrentState(this.targetState, originTypes.EXTERNAL);
   }, options.resetMinutes * 60 * 1000);
 };
 
@@ -953,10 +969,10 @@ SecuritySystem.prototype.resetTimers = function () {
   }
 };
 
-SecuritySystem.prototype.handleTargetStateChange = function (
-  origin,
-  alarmTriggered
-) {
+SecuritySystem.prototype.handleTargetStateChange = function (origin) {
+  // Clear arming timeout
+  clearTimeout(this.armTimeout);
+
   // Reset double-knock
   this.isKnocked = false;
 
@@ -972,10 +988,12 @@ SecuritySystem.prototype.handleTargetStateChange = function (
 
   // Trigger reset sensor for mode
   // change in triggered state
-  if (alarmTriggered) {
-    if (isCurrentStateAlarmTriggered) {
-      this.triggerResetSensor();
-    }
+  const isCurrentStateAlarmTriggered =
+    this.currentState ===
+    Characteristic.SecuritySystemCurrentState.ALARM_TRIGGERED;
+
+  if (isCurrentStateAlarmTriggered) {
+    this.triggerResetSensor();
 
     // Keep characteristic & switches on
     return;
@@ -1052,11 +1070,11 @@ SecuritySystem.prototype.updateTargetState = function (
     );
   }
 
+  // Handle mode change
+  this.handleTargetStateChange(origin);
+
   // Check if current state is already set
   if (state === this.currentState) {
-    // Clear arming timeout
-    clearTimeout(this.armTimeout);
-
     // Run set current state logic again
     this.setCurrentState(state, origin);
 
@@ -1067,9 +1085,6 @@ SecuritySystem.prototype.updateTargetState = function (
     return false;
   }
 
-  // Handle mode change
-  this.handleTargetStateChange(origin, false);
-
   // Set arming delay
   let armSeconds = 0;
 
@@ -1171,9 +1186,9 @@ SecuritySystem.prototype.updateTripSwitch = function (
 
   // Check if the security system is disarmed
   const isNotOverridingOff = options.overrideOff === false;
-  const isNotSpecialSwitch = origin !== originTypes.SPECIAL_SWITCH;
+  const isNotOverrideSwitch = origin !== originTypes.OVERRIDE_SWITCH;
 
-  if (isCurrentStateDisarmed && isNotOverridingOff && isNotSpecialSwitch) {
+  if (isCurrentStateDisarmed && isNotOverridingOff && isNotOverrideSwitch) {
     this.log.warn("Trip Switch (Not armed)");
 
     if (callback !== null) {
@@ -1201,14 +1216,14 @@ SecuritySystem.prototype.updateTripSwitch = function (
     });
 
     const isFirstKnock = this.isKnocked === false;
-    const isSpecialSwitch = origin === originTypes.SPECIAL_SWITCH;
+    const isOverrideSwitch = origin === originTypes.OVERRIDE_SWITCH;
     const isStateKnockable = doubleKnockStates.includes(this.currentState);
 
     if (
       value &&
       isStateKnockable &&
       isFirstKnock &&
-      isSpecialSwitch === false
+      isOverrideSwitch === false
     ) {
       this.log.warn("Trip Switch (Knock)");
       this.isKnocked = true;
@@ -1316,10 +1331,10 @@ SecuritySystem.prototype.updateTripSwitch = function (
         modeAwayExtendedSwitchCharacteristicOn.value;
 
       if (
-        options.isValueSet(options.awayExtendedTriggerSeconds) &&
+        options.isValueSet(options.modeAwayExtendedSwitchTriggerSeconds) &&
         modeAwayExtendedSwitchCharacteristicOnValue
       ) {
-        triggerSeconds = options.awayExtendedTriggerSeconds;
+        triggerSeconds = options.modeAwayExtendedSwitchTriggerSeconds;
       } else if (options.isValueSet(options.awayTriggerSeconds)) {
         triggerSeconds = options.awayTriggerSeconds;
       }
@@ -1506,10 +1521,9 @@ SecuritySystem.prototype.startServer = async function () {
         return;
       }
 
-      this.handleTargetStateChange(true);
       this.setCurrentState(
         Characteristic.SecuritySystemCurrentState.ALARM_TRIGGERED,
-        true
+        originTypes.EXTERNAL
       );
     }
 
@@ -1987,7 +2001,7 @@ SecuritySystem.prototype.getTripOverrideSwitch = function (callback) {
 
 SecuritySystem.prototype.setTripOverrideSwitch = function (value, callback) {
   this.log.info(`Trip Override Switch (${value ? "On" : "Off"})`);
-  this.updateTripSwitch(value, originTypes.SPECIAL_SWITCH, false, callback);
+  this.updateTripSwitch(value, originTypes.OVERRIDE_SWITCH, false, callback);
 };
 
 SecuritySystem.prototype.triggerIfModeSet = function (
@@ -2390,12 +2404,7 @@ SecuritySystem.prototype.setModePauseSwitch = function (value, callback) {
     if (options.pauseMinutes !== 0) {
       this.pauseTimeout = setTimeout(() => {
         this.log.info("Mode pause (Finished)");
-        this.updateTargetState(
-          this.pausedCurrentState,
-          originTypes.INTERNAL,
-          true,
-          null
-        );
+        this.Atate(this.pausedCurrentState, originTypes.INTERNAL, true, null);
       }, options.pauseMinutes * 60 * 1000);
     }
   } else {

package/src/utils/options.js

@@ -10,7 +10,6 @@ const options = {
     options.defaultMode = config.default_mode;
     options.armSeconds = config.arm_seconds;
     options.triggerSeconds = config.trigger_seconds;
-    options.pauseMinutes = config.pause_minutes;
     options.resetMinutes = config.reset_minutes;
     options.saveState = config.save_state;
     options.proxyMode = config.proxy_mode;
@@ -35,30 +34,33 @@ const options = {
 
     // END: Names
 
+    // Main settings
     options.logDirectory = config.log_directory;
     options.overrideOff = config.override_off;
     options.resetOffFlow = config.reset_off_flow;
     options.disabledModes = config.disabled_modes;
 
+    // Arming settings
     options.homeArmSeconds = config.home_arm_seconds;
     options.awayArmSeconds = config.away_arm_seconds;
     options.nightArmSeconds = config.night_arm_seconds;
 
+    // Trigger settings
     options.homeTriggerSeconds = config.home_trigger_seconds;
     options.awayTriggerSeconds = config.away_trigger_seconds;
     options.nightTriggerSeconds = config.night_trigger_seconds;
 
-    options.awayExtendedTriggerSeconds = config.away_extended_trigger_seconds;
+    // Trip switches
+    options.tripSwitch = config.trip_switch || config.siren_switch;
+    options.tripOverrideSwitch =
+      config.trip_override_switch || config.siren_override_switch;
+    options.tripModeSwitches =
+      config.trip_mode_switches || config.siren_mode_switches;
 
     // Arming lock switch
     options.armingLockSwitch = config.arming_lock_switch;
     options.armingLockSwitches = config.arming_lock_switches;
 
-    // Trip switches
-    options.tripSwitch = config.siren_switch;
-    options.tripOverrideSwitch = config.siren_override_switch;
-    options.tripModeSwitches = config.siren_mode_switches;
-
     // Arming motion sensor
     options.armingMotionSensor = config.arming_sensor;
 
@@ -67,17 +69,28 @@ const options = {
     options.trippedMotionSensorSeconds = config.tripped_sensor_seconds;
 
     // Triggered motion sensor
-    options.triggeredMotionSensor = config.siren_sensor;
-    options.triggeredMotionSensorSeconds = config.siren_sensor_seconds;
+    options.triggeredMotionSensor =
+      config.triggered_sensor || config.siren_sensor;
+    options.triggeredMotionSensorSeconds =
+      config.triggered_sensor_seconds || config.siren_sensor_seconds;
 
     // Reset motion sensor
     options.resetSensor = config.reset_sensor;
 
     // Mode switches
     options.modeSwitches = config.mode_switches;
+
+    // Off switch
     options.modeOffSwitch = config.mode_off_switch;
+
+    // Pause switch
     options.modePauseSwitch = config.mode_pause_switch;
+    options.pauseMinutes = config.pause_minutes;
+
+    // Away extended switch
     options.modeAwayExtendedSwitch = config.mode_away_extended_switch;
+    options.modeAwayExtendedSwitchTriggerSeconds =
+      config.mode_away_extended_switch_trigger_seconds;
 
     // Double knock
     options.doubleKnock = config.double_knock;
@@ -88,8 +101,6 @@ const options = {
     options.awayDoubleKnockSeconds = config.away_double_knock_seconds;
     options.nightDoubleKnockSeconds = config.night_double_knock_seconds;
 
-    options.audioSwitch = config.audio_switch;
-
     // Server
     options.serverPort = config.server_port;
     options.serverCode = config.server_code;
@@ -103,6 +114,9 @@ const options = {
     options.audioAlertLooped = config.audio_alert_looped;
     options.audioExtraVariables = config.audio_extra_variables;
 
+    // Audio switch
+    options.audioSwitch = config.audio_switch;
+
     // Commands
     options.commandTargetHome = config.command_target_home;
     options.commandTargetAway = config.command_target_away;