homebridge-securitysystem 7.3.0 → 7.5.0-beta.2

package/.github/release.yml

@@ -31,6 +31,6 @@ changelog:
       labels:
         - dependencies
 
-    - title: ✨ Miscellaneous Changes
+    - title: 🪄 Other Changes
       labels:
         - "*"

package/.github/workflows/create-release.yml

@@ -0,0 +1,80 @@
+name: Create release
+
+on:
+  pull_request:
+    types:
+      - closed
+    branches:
+      - main
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  create-tag:
+    name: Create tag
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.merged == true && contains(github.event.pull_request.labels.*.name, 'new-release')
+    outputs:
+      tag-name: ${{ steps.prepare-tag.outputs.tag-name }}
+    steps:
+      - name: Parse tag
+        id: prepare-tag
+        run: |
+          branch_name="${{ github.event.pull_request.head.ref }}"
+          tag_name=$(echo $branch_name | sed 's/version\///')
+          echo "tag-name=$tag_name" >> $GITHUB_OUTPUT
+
+      - name: Checkout branch
+        uses: actions/checkout@v3
+
+      - name: Create tag
+        run: |
+          git tag "${{ steps.prepare-tag.outputs.tag-name }}"
+
+      - name: Push tag to origin
+        run: git push origin "${{ steps.prepare-tag.outputs.tag-name }}"
+
+  create-release:
+    name: Create release
+    needs: [create-tag]
+    runs-on: ubuntu-latest
+    if: needs.create-tag.outputs.tag-name != ''
+    permissions:
+      contents: write
+    steps:
+      - name: Create release
+        uses: ncipollo/release-action@v1
+        with:
+          tag: "${{ needs.create-tag.outputs.tag-name }}"
+          prerelease: ${{ contains(needs.create-tag.outputs.tag-name, '-') }}
+          generateReleaseNotes: true
+          allowUpdates: true
+
+  publish-package:
+    name: Publish package
+    runs-on: ubuntu-latest
+    needs: [create-tag, create-release]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Setup node
+        uses: actions/setup-node@v3
+
+        with:
+          registry-url: https://registry.npmjs.org/
+
+      - name: Get version
+        run: |
+          echo "NPM_VERSION=${{ needs.create-tag.outputs.tag-name }}" >> $GITHUB_ENV
+
+      - name: Publish package
+
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+        run: |
+          npm publish --access public --provenance --tag "$(if [[ $NPM_VERSION == *-* ]]; then echo beta; else echo latest; fi)"

package/.github/workflows/{update-version.yml → create-version.yml}

@@ -1,4 +1,4 @@
-name: Update version
+name: Create version
 
 on:
   workflow_dispatch:
@@ -30,13 +30,13 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Generate tag name
-        uses: MiguelRipoll23/generate-tag-name@playground
+        uses: MiguelRipoll23/generate-tag-name@v1.7.0
         id: generate-tag-name
         with:
           channel: ${{ inputs.channel }}
 
       - name: Update version name
-        uses: reedyuk/npm-version@1.1.1
+        uses: reedyuk/npm-version@1.2.1
         with:
           version: ${{ steps.generate-tag-name.outputs.tag-name }}
 

package/.vscode/settings.json

@@ -7,5 +7,6 @@
   "editor.defaultFormatter": "esbenp.prettier-vscode",
   "[javascript]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
-  }
+  },
+  "cSpell.words": ["securitysystem"]
 }

package/config.schema.json

@@ -109,6 +109,55 @@
         "default": "Trip Override",
         "required": false
       },
+      "mode_home_switch_name": {
+        "title": "Mode Home Switch Name",
+        "description": "",
+        "type": "string",
+        "default": "Mode Home",
+        "required": false
+      },
+      "mode_away_switch_name": {
+        "title": "Mode Away Switch Name",
+        "description": "",
+        "type": "string",
+        "default": "Mode Away",
+        "required": false
+      },
+      "mode_night_switch_name": {
+        "title": "Mode Night Switch Name",
+        "description": "",
+        "type": "string",
+        "default": "Mode Night",
+        "required": false
+      },
+      "mode_off_switch_name": {
+        "title": "Mode Off Switch Name",
+        "description": "",
+        "type": "string",
+        "default": "Mode Off",
+        "required": false
+      },
+      "mode_away_extended_switch_name": {
+        "title": "Mode Away Extended Switch Name",
+        "description": "",
+        "type": "string",
+        "default": "Mode Away Extended",
+        "required": false
+      },
+      "mode_pause_switch_name": {
+        "title": "Mode Pause Name",
+        "description": "",
+        "type": "string",
+        "default": "Mode Pause",
+        "required": false
+      },
+      "audio_switch_name": {
+        "title": "Audio Name",
+        "description": "",
+        "type": "string",
+        "default": "Audio",
+        "required": false
+      },
       "log_directory": {
         "title": "Log Directory Path",
         "description": "",
@@ -611,7 +660,14 @@
         "trip_home_switch_name",
         "trip_away_switch_name",
         "trip_night_switch_name",
-        "trip_override_switch_name"
+        "trip_override_switch_name",
+        "mode_home_switch_name",
+        "mode_away_switch_name",
+        "mode_night_switch_name",
+        "mode_off_switch_name",
+        "mode_away_extended_switch_name",
+        "mode_pause_switch_name",
+        "audio_switch_name"
       ]
     },
     {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "homebridge-securitysystem",
   "displayName": "Homebridge Security System",
-  "version": "7.3.0",
+  "version": "7.5.0-beta.2",
   "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

@@ -299,44 +299,69 @@ function SecuritySystem(log, config) {
     .on("set", this.setArmingLockNightSwitch.bind(this));
 
   // Mode switches
-  this.modeHomeSwitchService = new Service.Switch("Mode Home", "mode-home");
+  this.modeHomeSwitchService = new Service.Switch(
+    options.modeHomeSwitchName,
+    "mode-home"
+  );
+
   this.modeHomeSwitchService.addCharacteristic(Characteristic.ConfiguredName);
 
   this.modeHomeSwitchService
-    .setCharacteristic(Characteristic.ConfiguredName, "Mode Home")
+    .setCharacteristic(
+      Characteristic.ConfiguredName,
+      options.modeHomeSwitchName
+    )
     .getCharacteristic(Characteristic.On)
     .on("get", this.getModeHomeSwitch.bind(this))
     .on("set", this.setModeHomeSwitch.bind(this));
 
-  this.modeAwaySwitchService = new Service.Switch("Mode Away", "mode-away");
+  this.modeAwaySwitchService = new Service.Switch(
+    options.modeAwaySwitchName,
+    "mode-away"
+  );
+
   this.modeAwaySwitchService.addCharacteristic(Characteristic.ConfiguredName);
 
   this.modeAwaySwitchService
-    .setCharacteristic(Characteristic.ConfiguredName, "Mode Away")
+    .setCharacteristic(
+      Characteristic.ConfiguredName,
+      options.modeAwaySwitchName
+    )
     .getCharacteristic(Characteristic.On)
     .on("get", this.getModeAwaySwitch.bind(this))
     .on("set", this.setModeAwaySwitch.bind(this));
 
-  this.modeNightSwitchService = new Service.Switch("Mode Night", "mode-night");
+  this.modeNightSwitchService = new Service.Switch(
+    options.modeNightSwitchName,
+    "mode-night"
+  );
+
   this.modeNightSwitchService.addCharacteristic(Characteristic.ConfiguredName);
 
   this.modeNightSwitchService
-    .setCharacteristic(Characteristic.ConfiguredName, "Mode Night")
+    .setCharacteristic(
+      Characteristic.ConfiguredName,
+      options.modeNightSwitchName
+    )
     .getCharacteristic(Characteristic.On)
     .on("get", this.getModeNightSwitch.bind(this))
     .on("set", this.setModeNightSwitch.bind(this));
 
-  this.modeOffSwitchService = new Service.Switch("Mode Off", "mode-off");
+  this.modeOffSwitchService = new Service.Switch(
+    options.modeOffSwitchName,
+    "mode-off"
+  );
+
   this.modeOffSwitchService.addCharacteristic(Characteristic.ConfiguredName);
 
   this.modeOffSwitchService
-    .setCharacteristic(Characteristic.ConfiguredName, "Mode Off")
+    .setCharacteristic(Characteristic.ConfiguredName, options.modeOffSwitchName)
     .getCharacteristic(Characteristic.On)
     .on("get", this.getModeOffSwitch.bind(this))
     .on("set", this.setModeOffSwitch.bind(this));
 
   this.modeAwayExtendedSwitchService = new Service.Switch(
-    "Mode Away Extended",
+    options.modeAwayExtendedSwitchName,
     "mode-away-extended"
   );
 
@@ -345,30 +370,40 @@ function SecuritySystem(log, config) {
   );
 
   this.modeAwayExtendedSwitchService
-    .setCharacteristic(Characteristic.ConfiguredName, "Mode Away Extended")
+    .setCharacteristic(
+      Characteristic.ConfiguredName,
+      options.modeAwayExtendedSwitchName
+    )
     .getCharacteristic(Characteristic.On)
     .on("get", this.getModeAwayExtendedSwitch.bind(this))
     .on("set", this.setModeAwayExtendedSwitch.bind(this));
 
-  this.modePauseSwitchService = new Service.Switch("Mode Pause", "mode-pause");
+  this.modePauseSwitchService = new Service.Switch(
+    options.modePauseSwitchName,
+    "mode-pause"
+  );
+
   this.modePauseSwitchService.addCharacteristic(Characteristic.ConfiguredName);
 
   this.modePauseSwitchService
-    .setCharacteristic(Characteristic.ConfiguredName, "Mode Pause")
+    .setCharacteristic(
+      Characteristic.ConfiguredName,
+      options.modePauseSwitchName
+    )
     .getCharacteristic(Characteristic.On)
     .on("get", this.getModePauseSwitch.bind(this))
     .on("set", this.setModePauseSwitch.bind(this));
 
   // Audio switch
   this.audioSwitchService = new Service.Switch(
-    "Audio",
+    options.audioSwitchName,
     "kx82r64zN3txDXKFiX9JDi"
   );
 
   this.audioSwitchService.addCharacteristic(Characteristic.ConfiguredName);
 
   this.audioSwitchService
-    .setCharacteristic(Characteristic.ConfiguredName, "Audio")
+    .setCharacteristic(Characteristic.ConfiguredName, options.audioSwitchName)
     .getCharacteristic(Characteristic.On)
     .on("get", this.getAudioSwitch.bind(this))
     .on("set", this.setAudioSwitch.bind(this));
@@ -1917,7 +1952,7 @@ SecuritySystem.prototype.triggerIfModeSet = function (
     ) {
       this.updateTripSwitch(value, originTypes.REGULAR_SWITCH, false, callback);
     } else {
-      this.log.debug("Security System (Trip mode not set)");
+      this.log.warn("Security System (Trip mode not set)");
       callback(HK_NOT_ALLOWED_IN_CURRENT_STATE, false);
     }
   } else {

package/src/utils/options.js

@@ -16,13 +16,25 @@ const options = {
     options.proxyMode = config.proxy_mode;
     options.testMode = config.test_mode;
 
-    // Names
+    // START: Names
     options.tripSwitchName = config.trip_switch_name;
     options.tripHomeSwitchName = config.trip_home_switch_name;
     options.tripAwaySwitchName = config.trip_away_switch_name;
     options.tripNightSwitchName = config.trip_night_switch_name;
     options.tripOverrideSwitchName = config.trip_override_switch_name;
 
+    options.modeHomeSwitchName = config.mode_home_switch_name;
+    options.modeAwaySwitchName = config.mode_away_switch_name;
+    options.modeNightSwitchName = config.mode_night_switch_name;
+    options.modeOffSwitchName = config.mode_off_switch_name;
+
+    options.modeAwayExtendedSwitchName = config.mode_away_extended_switch_name;
+    options.modePauseSwitchName = config.mode_pause_switch_name;
+
+    options.audioSwitchName = config.audio_switch_name;
+
+    // END: Names
+
     options.logDirectory = config.log_directory;
     options.overrideOff = config.override_off;
     options.resetOffFlow = config.reset_off_flow;
@@ -193,6 +205,34 @@ const options = {
       options.tripOverrideSwitchName = "Trip Override";
     }
 
+    if (options.isValueSet(options.modeHomeSwitchName) === false) {
+      options.modeHomeSwitchName = "Mode Home";
+    }
+
+    if (options.isValueSet(options.modeAwaySwitchName) === false) {
+      options.modeAwaySwitchName = "Mode Away";
+    }
+
+    if (options.isValueSet(options.modeNightSwitchName) === false) {
+      options.modeNightSwitchName = "Mode Night";
+    }
+
+    if (options.isValueSet(options.modeOffSwitch) === false) {
+      options.modeOffSwitchName = "Mode Off";
+    }
+
+    if (options.isValueSet(options.modeAwayExtendedSwitchName) === false) {
+      options.modeAwayExtendedSwitchName = "Mode Away Extended";
+    }
+
+    if (options.isValueSet(options.modePauseSwitchName) === false) {
+      options.modePauseSwitchName = "Mode Away Extended";
+    }
+
+    if (options.isValueSet(options.audioSwitchName) === false) {
+      options.audioSwitchName = "Audio";
+    }
+
     if (options.isValueSet(options.overrideOff) === false) {
       options.overrideOff = false;
     }

package/.github/workflows/new-tag.yml

@@ -1,39 +0,0 @@
-name: Create tag
-
-on:
-  pull_request:
-    types:
-      - closed
-    branches:
-      - main
-
-jobs:
-  get-tag-name:
-    name: Get tag name
-    runs-on: ubuntu-latest
-    if: github.event.pull_request.merged == true && contains(github.event.pull_request.labels.*.name, 'new-release')
-    outputs:
-      tag-name: ${{ steps.get-tag-name.outputs.tag-name }}
-    steps:
-      - name: Get tag name
-        id: get-tag-name
-        run: |
-          branch_name="${{ github.event.pull_request.head.ref }}"
-          tag_name=$(echo $branch_name | sed 's/version\///')
-          echo "tag-name=$tag_name" >> $GITHUB_OUTPUT
-
-  create-tag:
-    name: Create new tag
-    needs: get-tag-name
-    runs-on: ubuntu-latest
-    if: needs.get-tag-name.outputs.tag-name != ''
-    steps:
-      - name: Checkout branch
-        uses: actions/checkout@v3
-
-      - name: Create tag name
-        run: |
-          git tag "${{ needs.get-tag-name.outputs.tag-name }}"
-
-      - name: Push tag to origin
-        run: git push origin "${{ needs.get-tag-name.outputs.tag-name }}"

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

@@ -1,51 +0,0 @@
-name: Publish package
-
-on:
-  release:
-    types: [published]
-
-jobs:
-  install-package:
-    name: Install package
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v3
-
-      - name: Setup node
-        uses: actions/setup-node@v3
-
-        with:
-          cache: "npm"
-          registry-url: https://registry.npmjs.org/
-
-      - name: Install package
-        run: npm ci
-
-  publish-package:
-    name: Publish package
-    runs-on: ubuntu-latest
-    needs: [install-package]
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v3
-
-      - name: Setup node
-        uses: actions/setup-node@v3
-
-        with:
-          registry-url: https://registry.npmjs.org/
-
-      - name: Get version
-        run: |
-          echo "NPM_VERSION=${GITHUB_REF##*/v}" >> $GITHUB_ENV
-
-      - 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)"