homebridge-verisure 1.15.0 → 1.16.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.16.0 (Aug 27, 2022)
+
+### Plugin
+
+* Added config options for door lock; auto-lock and volume.
+
 ## 1.15.0 (Jan 11, 2022)
 
 ### Plugin

package/README.md

@@ -1,6 +1,8 @@
 # homebridge-verisure
 
-[![Greenkeeper badge](https://badges.greenkeeper.io/ptz0n/homebridge-verisure.svg)](https://greenkeeper.io/)
+[![Verified by Homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
+
+[![Synk badge](https://snyk.io/test/github/ptz0n/homebridge-verisure/badge.svg)](https://snyk.io/)
 
 [![GitHub Actions badge](https://github.com/ptz0n/homebridge-verisure/workflows/Test/badge.svg)](https://github.com/ptz0n/homebridge-verisure/actions?query=workflow%3ATest)
 

package/config.schema.json

@@ -18,16 +18,19 @@
       "token": {
         "title": "Token",
         "type": "string",
+        "placeholder": "vid=topSecretToken",
         "required": false
       },
       "alarmCode": {
         "title": "Alarm Code",
         "type": "string",
+        "placeholder": "0000",
         "required": false
       },
       "doorCode": {
         "title": "Door Code",
         "type": "string",
+        "placeholder": "000000",
         "required": false
       },
       "installations": {
@@ -43,9 +46,42 @@
         "type": "integer",
         "default": 60,
         "required": false
+      },
+      "showAutoLockSwitch": {
+        "title": "Show Auto-lock switch",
+        "type": "boolean",
+        "default": true
+      },
+      "showAudioSwitch": {
+        "title": "Show audio switch",
+        "type": "boolean",
+        "default": true
+      },
+      "audioOffValue": {
+        "title": "Audio off Value",
+        "type": "string",
+        "default": "SILENCE",
+        "oneOf": [
+          { "title": "Silence", "enum": ["SILENCE"] },
+          { "title": "Low", "enum": ["LOW"] }
+        ],
+        "required": true,
+        "functionBody": "return model.showAudioSwitch === true;"
+      },
+      "audioOnValue": {
+        "title": "Audio on Value",
+        "type": "string",
+        "default": "HIGH",
+        "oneOf": [
+          { "title": "Low", "enum": ["LOW"] },
+          { "title": "High", "enum": ["HIGH"] }
+        ],
+        "required": true,
+        "functionBody": "return model.showAudioSwitch === true;"
       }
     }
   },
   "form": null,
   "display": null
+ 
 }

package/lib/accessories/alarm.js

@@ -38,7 +38,7 @@ class Alarm extends VerisureAccessory {
   }
 
   getCurrentAlarmState(callback) {
-    this.log('Getting current alarm state.');
+    this.log('Getting current alarm state.', 'debug');
 
     this.installation.getOverview()
       .then((overview) => {

package/lib/accessories/contactsensor.js

@@ -15,7 +15,7 @@ class ContactSensor extends VerisureAccessory {
   }
 
   getCurrentSensorState(callback) {
-    this.log('Getting current sensor state.');
+    this.log('Getting current sensor state.', 'debug');
 
     this.installation.getOverview()
       .then((overview) => overview.doorWindow.doorWindowDevice

package/lib/accessories/doorlock.js

@@ -8,6 +8,7 @@ class DoorLock extends VerisureAccessory {
 
     this.doorCode = this.platformConfig.doorCode;
     this.switchName = VerisureAccessory.getUniqueAccessoryName(`Auto-lock (${this.config.area})`);
+    this.audioName = VerisureAccessory.getUniqueAccessoryName(`Audio (${this.config.area})`);
     this.configUrl = `/device/${this.serialNumber}/doorlockconfig`;
   }
 
@@ -38,7 +39,7 @@ class DoorLock extends VerisureAccessory {
   }
 
   getCurrentLockState(callback) {
-    this.log('Getting current lock state.');
+    this.log('Getting current lock state.', 'debug');
 
     // TODO: Use this.cachedValue, if available?
 
@@ -124,6 +125,36 @@ class DoorLock extends VerisureAccessory {
       });
   }
 
+  getAudioState(callback) {
+    this.installation.client({ url: this.configUrl })
+      .then((config) => {
+        this.audioState = config.volume !== this.platformConfig.audioOffValue;
+        callback(null, this.audioState);
+      })
+      .catch(callback);
+  }
+
+  setAudioState(value, callback) {
+    this.audioState = value;
+
+    const volume = value
+      ? this.platformConfig.audioOnValue
+      : this.platformConfig.audioOffValue;
+
+    const request = {
+      method: 'PUT',
+      url: this.configUrl,
+      data: { volume },
+    };
+
+    this.installation.client(request)
+      .then(() => callback(null))
+      .catch((error) => {
+        // TODO: Revert config state in this.value?
+        callback({ message: error.errorMessage });
+      });
+  }
+
   getServices() {
     const { Service, Characteristic } = this.homebridge.hap;
 
@@ -141,13 +172,25 @@ class DoorLock extends VerisureAccessory {
 
     services.push(this.lockService);
 
-    this.switchService = new Service.Switch(this.switchName);
-    this.switchService
-      .getCharacteristic(Characteristic.On)
-      .on('get', this.getAutoLockState.bind(this))
-      .on('set', this.setAutoLockState.bind(this));
+    if (this.platformConfig.showAutoLockSwitch) {
+      this.autoLockService = new Service.Switch(this.switchName, this.switchName);
+      this.autoLockService
+        .getCharacteristic(Characteristic.On)
+        .on('get', this.getAutoLockState.bind(this))
+        .on('set', this.setAutoLockState.bind(this));
+
+      services.push(this.autoLockService);
+    }
+
+    if (this.platformConfig.showAudioSwitch) {
+      this.audioService = new Service.Switch(this.audioName, this.audioName);
+      this.audioService
+        .getCharacteristic(Characteristic.On)
+        .on('get', this.getAudioState.bind(this))
+        .on('set', this.setAudioState.bind(this));
 
-    services.push(this.switchService);
+      services.push(this.audioService);
+    }
 
     this.pollCharacteristics.push(currentStateCharacteristic);
 

package/lib/accessories/verisure.js

@@ -53,8 +53,8 @@ class VerisureAccessory {
     });
   }
 
-  log(message) {
-    return this.logger('info', `${this.installation.config.alias} ${this.name}: ${message}`);
+  log(message, level = 'info') {
+    return this.logger[level](`${this.installation.config.alias} ${this.name}: ${message}`);
   }
 }
 

package/lib/platform.js

@@ -26,6 +26,10 @@ class VerisurePlatform {
       password,
       installations = [],
       pollInterval = 60,
+      showAutoLockSwitch = true,
+      showAudioSwitch = true,
+      audioOffValue = 'LOW',
+      audioOnValue = 'HIGH',
     } = config;
 
     this.config = {
@@ -36,6 +40,10 @@ class VerisurePlatform {
       token: VERISURE_TOKEN || token,
       installations,
       pollInterval,
+      showAutoLockSwitch,
+      showAudioSwitch,
+      audioOffValue,
+      audioOnValue,
     };
 
     this.homebridge = homebridge;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-verisure",
-  "version": "1.15.0",
+  "version": "1.16.0",
   "description": "Verisure plugin for homebridge: https://github.com/nfarina/homebridge",
   "license": "MIT",
   "keywords": [
@@ -10,6 +10,10 @@
     "type": "git",
     "url": "git://github.com/ptz0n/homebridge-verisure.git"
   },
+  "funding": {
+    "type": "paypal",
+    "url": "https://www.paypal.com/paypalme/ptz0n"
+  },
   "scripts": {
     "test": "eslint lib && jest --coverage"
   },
@@ -19,7 +23,7 @@
   },
   "engines": {
     "node": ">=12",
-    "homebridge": ">=0.2.0"
+    "homebridge": ">=1.0.0"
   },
   "dependencies": {
     "enquirer": "^2.3.6",