homebridge-securitysystem 6.1.0 → 6.2.1-beta.1

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/.github/workflows/analyze-package.yml

@@ -0,0 +1,16 @@
+name: Analyze package
+
+on:
+  push:
+    branches:
+      - stable
+
+  pull_request:
+
+jobs:
+  analyze-package:
+    name: Analyze package
+    uses: MiguelRipoll23/global/.github/workflows/analyze-package.yml@main
+
+    with:
+      node-version: 16

package/.github/workflows/build-package.yml

@@ -2,29 +2,13 @@ name: Build package
 
 on:
   push:
-    branches:
-      - 'beta'
-      - 'hotfix/*'
-
-  pull_request:
-    branches:
-      - 'beta'
-      - 'hotfix/*'
+    branches-ignore:
+      - stable
 
 jobs:
   build-package:
     name: Build package
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v2
-
-      - name: Setup node
-        uses: actions/setup-node@v2
-        with:
-          node-version: '14'
-          cache: 'npm'
+    uses: MiguelRipoll23/global/.github/workflows/build-package.yml@main
 
-      - name: Install package
-        run: npm ci
+    with:
+      node-version: 16

package/.github/workflows/clean-issues.yml

@@ -0,0 +1,10 @@
+name: Clean issues
+
+on:
+  schedule:
+    - cron: "0 9 * * *"
+
+jobs:
+  clean-issues:
+    name: Clean issues
+    uses: MiguelRipoll23/global/.github/workflows/clean-issues.yml@main

package/.github/workflows/publish-package.yml

@@ -5,27 +5,12 @@ on:
     types: [published]
 
 jobs:
-  publish-npm:
+  publish-package:
     name: Publish package
-    runs-on: ubuntu-latest
+    uses: MiguelRipoll23/global/.github/workflows/publish-package.yml@main
 
-    steps:
-      - name: Get version
-        run: |
-          echo "NPM_VERSION=${GITHUB_REF##*/v}" >> $GITHUB_ENV
+    with:
+      node-version: 16
 
-      - name: Checkout repository
-        uses: actions/checkout@v2
-
-      - name: Setup node
-        uses: actions/setup-node@v2
-        with:
-          node-version: "14"
-          cache: "npm"
-          registry-url: https://registry.npmjs.org/
-
-      - name: Publish package
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: |
-          npm publish --access public --tag "$(if [[ $NPM_VERSION == *-* ]]; then echo beta; else echo latest; fi)"
+    secrets:
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

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,11 +1,12 @@
 {
   "name": "homebridge-securitysystem",
   "displayName": "Homebridge Security System",
-  "version": "6.1.0",
+  "version": "6.2.1-beta.1",
   "description": "Homebridge plugin that creates a security system accessory that can be triggered by HomeKit sensors.",
   "main": "src/index.js",
   "scripts": {
-    "test": "npm install -g && homebridge -I -D"
+    "test": "npm install -g && homebridge -I -D",
+    "build": "exit 0"
   },
   "keywords": [
     "homebridge-plugin",
@@ -44,6 +45,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();
@@ -1214,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') {
@@ -1221,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`;
@@ -1846,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.');
     }
   },
 

package/.github/workflows/assign-issue.yml

@@ -1,17 +0,0 @@
-name: Assign issue
-
-on:
-  issues:
-    types: [opened]
-
-jobs:
-  auto-assign:
-    name: Assign issue
-    runs-on: ubuntu-latest
-
-    steps:
-    - name: Assign issue
-      uses: pozil/auto-assign-issue@v1
-      with:
-        repo-token: ${{ secrets.GITHUB_TOKEN }}
-        assignees: MiguelRipoll23

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

@@ -1,18 +0,0 @@
-name: 'Close stale issues and PRs'
-on:
-  schedule:
-    - cron: '0 9 * * *'
-
-jobs:
-  stale:
-    name: Check activity
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Check issues/pull requests 
-        uses: actions/stale@v3
-        with:
-          days-before-stale: 14
-          days-before-close: 7
-          exempt-issue-labels: 'pinned,help wanted,investigating,evaluating'
-          stale-issue-message: 'This issue is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 7 days.'