homebridge-securitysystem 6.1.0-beta.0 → 6.2.0

package/.github/release.yml

@@ -0,0 +1,21 @@
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release
+
+  categories:
+    - title: Breaking Changes ⚠️
+      labels:
+        - breaking-change
+
+    - title: New Features 🎉
+      labels:
+        - enhancement
+
+    - title: Bug Fixes
+      labels:
+        - bug
+
+    - title: Other Changes
+      labels:
+        - "*"

package/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "javascript.inlayHints.parameterNames.enabled": "all",
+  "editor.bracketPairColorization.enabled": true,
+  "editor.guides.bracketPairs": true
+}

package/config.schema.json

@@ -309,6 +309,13 @@
         "default": true,
         "required": false
       },
+      "audio_switch": {
+        "title": "Show Audio Switch",
+        "description": "Adds a global switch to enable or disable audio except for alarm triggered.",
+        "type": "boolean",
+        "default": false,
+        "required": false
+      },
       "audio": {
         "title": "Play Sounds (local-only, ffmpeg required)",
         "description": "Warns of pending or current events by playing sounds.",
@@ -603,7 +610,8 @@
         "arming_lock_switches",
         "siren_switch",
         "siren_override_switch",
-        "siren_mode_switches"
+        "siren_mode_switches",
+        "audio_switch"
       ]
     },
     {

package/package.json

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

package/pull_request_template.md

@@ -1,7 +1 @@
-**Issue (if exists)**
-
-*Fixes #XX / None*
-
-**Changes proposed**
-
-*Write a description of the changes proposed here and thank you for contributing!*
+Closes #XXX

package/src/index.js

@@ -252,6 +252,16 @@ function SecuritySystem(log, config) {
     .on('get', this.getModePauseSwitch.bind(this))
     .on('set', this.setModePauseSwitch.bind(this));
 
+  // Audio switch
+  this.audioSwitchService = new Service.Switch('Audio', 'kx82r64zN3txDXKFiX9JDi');
+
+  this.audioSwitchService
+    .getCharacteristic(Characteristic.On)
+    .on('get', this.getAudioSwitch.bind(this))
+    .on('set', this.setAudioSwitch.bind(this))
+
+  this.audioSwitchService.getCharacteristic(Characteristic.On).value = true;
+
   // Siren sensors
   this.sirenTrippedMotionSensorService = new Service.MotionSensor('Siren Tripped', 'siren-tripped');
 
@@ -359,6 +369,10 @@ function SecuritySystem(log, config) {
     this.services.push(this.modePauseSwitchService);
   }
 
+  if (options.audio && options.audioSwitch) {
+    this.services.push(this.audioSwitchService);
+  }
+
   // Storage
   if (options.saveState) {
     this.load();
@@ -485,6 +499,7 @@ SecuritySystem.prototype.state2Mode = function (state) {
 
     // Custom
     case 'lock':
+      // Audio sound
       return state;
 
     case 'warning':
@@ -679,6 +694,7 @@ SecuritySystem.prototype.handleStateUpdate = function (alarmTriggered) {
 SecuritySystem.prototype.updateTargetState = function (state, origin, delay, callback) {
   const isTargetStateAlreadySet = this.targetState === state;
   const isCurrentStateAlarmTriggered = this.currentState === Characteristic.SecuritySystemCurrentState.ALARM_TRIGGERED;
+  const isTargetStateDisarm = state === Characteristic.SecuritySystemTargetState.DISARM;
 
   // Check if target state is already set
   if (isTargetStateAlreadySet && isCurrentStateAlarmTriggered === false) {
@@ -704,7 +720,9 @@ SecuritySystem.prototype.updateTargetState = function (state, origin, delay, cal
   }
 
   // Check arming lock switches
-  if (this.isArmingLocked(state)) {
+  const isArmingLockEnabled = options.isValueSet(options.armingLockSwitch) || options.isValueSet(options.armingLockSwitches);
+
+  if (isTargetStateDisarm === false && isArmingLockEnabled && this.isArmingLocked(state)) {
     this.log.warn('Arming lock (Not allowed)');
 
     if (callback !== null) {
@@ -722,7 +740,6 @@ SecuritySystem.prototype.updateTargetState = function (state, origin, delay, cal
   const isTargetStateHome = this.targetState === Characteristic.SecuritySystemTargetState.STAY_ARM;
   const isTargetStateAway = this.targetState === Characteristic.SecuritySystemTargetState.AWAY_ARM;
   const isTargetStateNight = this.targetState === Characteristic.SecuritySystemTargetState.NIGHT_ARM;
-  const isTargetStateDisarm = this.targetState === Characteristic.SecuritySystemTargetState.DISARM;
 
   // Update characteristic
   if (origin === originTypes.INTERNAL || origin === originTypes.EXTERNAL) {
@@ -1211,6 +1228,9 @@ SecuritySystem.prototype.playAudio = async function (type, state) {
 
   const mode = this.state2Mode(state);
 
+  // Close previous player
+  this.stopAudio();
+
   // Ignore 'Current Off' event
   if (mode === 'off') {
     if (type === 'target') {
@@ -1218,8 +1238,13 @@ SecuritySystem.prototype.playAudio = async function (type, state) {
     }
   }
 
-  // Close previous player
-  this.stopAudio();
+  // Check audio switch except for triggered
+  const audioSwitchOnCharacteristic = this.audioSwitchService.getCharacteristic(Characteristic.On);
+  const isAudioDisabledBySwitch = audioSwitchOnCharacteristic.value === false;
+
+  if (mode !== 'triggered' && isAudioDisabledBySwitch) {
+    return;
+  }
 
   // Directory
   let directory = `${__dirname}/../sounds`;
@@ -1362,7 +1387,7 @@ SecuritySystem.prototype.executeCommand = function (type, state, origin) {
       break;
 
     default:
-      this.log.error(`Unknown ${type} state (${state})`);
+      this.log.error(`Unknown command ${type} state (${state})`);
   }
 
   if (command === undefined || command === null) {
@@ -1446,7 +1471,7 @@ SecuritySystem.prototype.sendWebhookEvent = function (type, state, origin) {
       break;
 
     default:
-      this.log.error(`Unknown ${type} state (${state})`);
+      this.log.error(`Unknown webhook ${type} state (${state})`);
       return;
   }
 
@@ -1598,6 +1623,7 @@ SecuritySystem.prototype.isArmingLocked = function (state) {
   // Check mode switches
   switch (state) {
     case 'global':
+      // Server status endpoint
       return false;
 
     case Characteristic.SecuritySystemCurrentState.STAY_ARM:
@@ -1613,7 +1639,7 @@ SecuritySystem.prototype.isArmingLocked = function (state) {
       break;
 
     default:
-      this.log.error(`Unknown state (${state})`);
+      this.log.debug(`Unknown arming lock state (${state})`);
   }
 
   return armingLockSwitchService.getCharacteristic(Characteristic.On).value;
@@ -1640,7 +1666,7 @@ SecuritySystem.prototype.updateArmingLock = function (mode, value) {
       break;
 
     default:
-      this.log.warn(`Unknown arming lock type (${mode})`);
+      this.log.debug(`Unknown arming lock mode (${mode})`);
       return false;
   }
 
@@ -1842,6 +1868,16 @@ SecuritySystem.prototype.setModePauseSwitch = function (value, callback) {
   callback(null);
 };
 
+SecuritySystem.prototype.getAudioSwitch = function (callback) {
+  const value = this.audioSwitchService.getCharacteristic(Characteristic.On).value;
+  callback(null, value);
+};
+
+SecuritySystem.prototype.setAudioSwitch = function (value, callback) {
+  this.log.info(`Audio (${value ? 'Enabled' : 'Disabled'})`);
+  callback(null);
+};
+
 // Siren Tripped Motion Sensor
 SecuritySystem.prototype.getSirenTrippedMotionDetected = function (callback) {
   const value = this.sirenTrippedMotionSensorService.getCharacteristic(Characteristic.MotionDetected).value;

package/src/utils/options.js

@@ -62,6 +62,8 @@ 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;
@@ -276,15 +278,13 @@ const options = {
   },
 
   validateValues: (log) => {
-    if (options.isValueSet(options.resetMinutes) && options.resetMinutes === 0) {
+    if (options.resetMinutes === 0) {
       log.error('Value of setting \'Reset Delay Seconds\' should be at least 1.');
       options.resetMinutes = 1;
     }
 
-    if (options.serverPort !== null) {
-      if (options.serverPort < 0 || options.serverPort > 65535) {
-        log.error('Value of setting \'Server Port\' not between 0 and 65535.');
-      }
+    if (options.serverPort < 0 || options.serverPort > 65535) {
+      log.error('Value of setting \'Server Port\' not between 0 and 65535.');
     }
   },