homebridge-securitysystem 8.1.2 → 8.2.0-beta.1

package/.github/workflows/bump-version.yml

@@ -32,24 +32,25 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v4.0.1
 
-      - name: Create tag name
-        uses: MiguelRipoll23/create-tag-name@v2.1.2
-        id: create-tag-name
+      - name: Get next version
+        uses: MiguelRipoll23/get-next-version@v3.0.0
+        id: get-next-version
         with:
           channel: ${{ inputs.channel }}
+          new-build-for-prerelease: ${{ inputs.new-build-for-prerelease }}
 
       - name: Update version
         run: |
-          npm version --no-git-tag-version ${{ env.TAG_NAME }}
+          npm version --no-git-tag-version ${{ env.NEXT_VERSION }}
         env:
-          TAG_NAME: ${{ steps.create-tag-name.outputs.tag-name }}
+          NEXT_VERSION: ${{ steps.get-next-version.outputs.next-version }}
 
       - name: Create pull request
         uses: peter-evans/create-pull-request@v6
         with:
-          branch: version/${{ steps.create-tag-name.outputs.tag-name }}
-          commit-message: ${{ steps.create-tag-name.outputs.tag-name }}
-          title: Bump version to ${{ steps.create-tag-name.outputs.tag-name }}
+          branch: version/${{ steps.get-next-version.outputs.next-version }}
+          commit-message: ${{ steps.get-next-version.outputs.next-version }}
+          title: Bump version to ${{ steps.get-next-version.outputs.next-version }}
           body: Automated pull request triggered by a new release.
           labels: new-release,ignore-for-release
           reviewers: MiguelRipoll23

package/config.schema.json

@@ -289,6 +289,13 @@
           "uniqueItems": true
         }
       },
+      "arming_sensor": {
+        "title": "Show Arming Sensor",
+        "description": "Adds a sensor that triggers when the security system is being armed.",
+        "type": "boolean",
+        "default": false,
+        "required": false
+      },
       "tripped_sensor": {
         "title": "Show Tripped Sensor",
         "description": "Adds a sensor that triggers multiple times when any of the Trip switches have been turned on.",
@@ -762,6 +769,7 @@
       "expandable": true,
       "expanded": false,
       "items": [
+        "arming_sensor",
         "tripped_sensor",
         "siren_sensor",
         {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "homebridge-securitysystem",
   "displayName": "Homebridge Security System",
-  "version": "8.1.2",
+  "version": "8.2.0-beta.1",
   "description": "Homebridge plugin that creates a security system accessory that can be triggered by HomeKit sensors.",
   "main": "src/index.js",
   "scripts": {
@@ -46,6 +46,6 @@
     "node-persist": "^4.0.1"
   },
   "devDependencies": {
-    "eslint": "^8.0.0"
+    "eslint": "^9.0.0"
   }
 }

package/src/index.js

@@ -483,6 +483,8 @@ function SecuritySystem(log, config) {
   // Services list
   this.services = [this.service, this.accessoryInformationService];
 
+  this.addArmingMotionSensor();
+
   if (options.trippedMotionSensor) {
     this.services.push(this.trippedMotionSensorService);
   }
@@ -649,7 +651,8 @@ SecuritySystem.prototype.load = async function () {
         Characteristic.SecuritySystemCurrentState,
         this.currentState
       );
-      this.handleStateUpdate(false);
+
+      this.handleTargetStateChange(false);
 
       // Log
       this.logMode("Current", this.currentState);
@@ -692,6 +695,29 @@ SecuritySystem.prototype.identify = function (callback) {
   callback(null);
 };
 
+// Services
+SecuritySystem.prototype.addArmingMotionSensor = function () {
+  if (options.armingMotionSensor === false) {
+    return;
+  }
+
+  this.armingMotionSensorService = new Service.MotionSensor(
+    "Arming",
+    "arming-motion-sensor"
+  );
+
+  this.armingMotionSensorService.addOptionalCharacteristic(
+    Characteristic.ConfiguredName
+  );
+
+  this.armingMotionSensorService
+    .setCharacteristic(Characteristic.ConfiguredName, "Arming")
+    .getCharacteristic(Characteristic.MotionDetected)
+    .on("get", this.getArmingMotionDetected.bind(this));
+
+  this.services.push(this.armingMotionSensorService);
+};
+
 // Security system
 SecuritySystem.prototype.state2Mode = function (state) {
   switch (state) {
@@ -778,7 +804,9 @@ SecuritySystem.prototype.setCurrentState = function (state, origin) {
     Characteristic.SecuritySystemCurrentState,
     state
   );
+
   this.logMode("Current", state);
+  this.handleCurrentStateChange(false);
 
   // Audio
   this.playAudio("current", state);
@@ -826,7 +854,7 @@ SecuritySystem.prototype.setCurrentState = function (state, origin) {
       }
 
       // Normal flow
-      this.handleStateUpdate(false);
+      this.handleTargetStateChange(false);
       this.setCurrentState(this.targetState, false);
     }, options.resetMinutes * 60 * 1000);
   }
@@ -834,6 +862,11 @@ SecuritySystem.prototype.setCurrentState = function (state, origin) {
   this.save();
 };
 
+SecuritySystem.prototype.handleCurrentStateChange = function (alarmTriggered) {
+  // Arming motion sensor
+  this.updateArmingMotionDetected(false);
+};
+
 SecuritySystem.prototype.triggerResetSensor = function () {
   // Update triggered reset motion sensor
   this.triggeredResetMotionSensorService.updateCharacteristic(
@@ -907,7 +940,7 @@ SecuritySystem.prototype.resetTimers = function () {
   }
 };
 
-SecuritySystem.prototype.handleStateUpdate = function (alarmTriggered) {
+SecuritySystem.prototype.handleTargetStateChange = function (alarmTriggered) {
   // Reset double-knock
   this.isKnocked = false;
 
@@ -920,6 +953,7 @@ SecuritySystem.prototype.handleStateUpdate = function (alarmTriggered) {
     return;
   }
 
+  // Reset tripped motion sensor
   const trippedOnCharacteristic = this.tripSwitchService.getCharacteristic(
     Characteristic.On
   );
@@ -928,6 +962,7 @@ SecuritySystem.prototype.handleStateUpdate = function (alarmTriggered) {
     this.updateTripSwitch(false, originTypes.INTERNAL, true, null);
   }
 
+  // Reset trip switches
   this.resetTripSwitches();
 };
 
@@ -1009,7 +1044,7 @@ SecuritySystem.prototype.updateTargetState = function (
   }
 
   // Reset everything
-  this.handleStateUpdate(false);
+  this.handleTargetStateChange(false);
 
   // Commands
   this.executeCommand("target", state, origin);
@@ -1021,6 +1056,9 @@ SecuritySystem.prototype.updateTargetState = function (
   if (state === this.currentState) {
     this.log.warn("Current mode (Already set)");
 
+    // Reset arming motion sensor
+    this.updateArmingMotionDetected(false);
+
     // Play audio
     this.playAudio("current", this.currentState);
 
@@ -1067,6 +1105,9 @@ SecuritySystem.prototype.updateTargetState = function (
     if (armSeconds > 0) {
       this.isArming = true;
 
+      // Trigger arming motion sensor
+      this.updateArmingMotionDetected(true);
+
       // Play sound
       this.playAudio("target", state);
 
@@ -1452,7 +1493,7 @@ SecuritySystem.prototype.startServer = async function () {
         return;
       }
 
-      this.handleStateUpdate(true);
+      this.handleTargetStateChange(true);
       this.setCurrentState(
         Characteristic.SecuritySystemCurrentState.ALARM_TRIGGERED,
         true
@@ -2375,6 +2416,22 @@ SecuritySystem.prototype.setAudioSwitch = function (value, callback) {
   callback(null);
 };
 
+// Tripped Motion Sensor
+SecuritySystem.prototype.getArmingMotionDetected = function (callback) {
+  const value = this.armingMotionSensorService.getCharacteristic(
+    Characteristic.MotionDetected
+  ).value;
+
+  callback(null, value);
+};
+
+SecuritySystem.prototype.updateArmingMotionDetected = function (value) {
+  this.armingMotionSensorService.updateCharacteristic(
+    Characteristic.MotionDetected,
+    value
+  );
+};
+
 // Tripped Motion Sensor
 SecuritySystem.prototype.getTrippedMotionDetected = function (callback) {
   const value = this.trippedMotionSensorService.getCharacteristic(

package/src/utils/options.js

@@ -59,6 +59,9 @@ const options = {
     options.tripOverrideSwitch = config.siren_override_switch;
     options.tripModeSwitches = config.siren_mode_switches;
 
+    // Arming motion sensor
+    options.armingMotionSensor = config.arming_sensor;
+
     // Tripped motion sensor
     options.trippedMotionSensor = config.tripped_sensor;
     options.trippedMotionSensorSeconds = config.tripped_sensor_seconds;
@@ -261,18 +264,23 @@ const options = {
       options.logDirectory = null;
     }
 
+    // Arming sensor
+    if (options.isValueSet(options.armingMotionSensor) === false) {
+      options.armingMotionSensor = false;
+    }
+
     // Tripped sensor
-    if (options.isValueSet(options.trippedSensor) === false) {
-      options.trippedSensor = false;
+    if (options.isValueSet(options.trippedMotionSensor) === false) {
+      options.trippedMotionSensor = false;
     }
 
     if (options.isValueSet(options.trippedSensorSeconds) === false) {
       options.trippedSensorSeconds = 5;
     }
 
-    // Tripped sensor
-    if (options.isValueSet(options.trippedMotionSensor) === false) {
-      options.trippedMotionSensor = false;
+    // Triggered sensor
+    if (options.isValueSet(options.triggeredMotionSensor) === false) {
+      options.triggeredMotionSensor = false;
     }
 
     if (options.isValueSet(options.triggeredMotionSensorSeconds) === false) {