homebridge-verisure 1.14.1 → 1.16.0

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 1.16.0 (Aug 27, 2022)
+
+### Plugin
+
+* Added config options for door lock; auto-lock and volume.
+
+## 1.15.0 (Jan 11, 2022)
+
+### Plugin
+
+* Added config option for installations to initiate.
+
+## 1.14.2 (Jan 4, 2022)
+
+### Plugin
+
+* Initiate gracefully, to not affect other plugins.
+
 ## 1.14.1 (Oct 8, 2021)
 
 ### Dependencies

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)
 
@@ -51,6 +53,7 @@ your array (list) of enabled platform plugins. Example config:
     "token": "vid=topSecretToken",
     "alarmCode": "0000",
     "doorCode": "000000",
+    "installations": ["Alias"],
     "pollInterval": 60
   }
 ]
@@ -61,16 +64,17 @@ your array (list) of enabled platform plugins. Example config:
 * __`token`__ Required string for accounts with MFA enabled.
 * `alarmCode` Optional string containing your security system alarm code.
 * `doorCode` Optional string containing your door lock code.
+* `installations` Optional array for filtering installations based on Verisure alias. Defaults to `[]`
 * `pollInterval` Optional integer containing poll interval in seconds. Defaults to `60`.
 
 ### Multi-factor authentication
 
 > [Verisure] MFA is enabled for user. Please see README.
 
-In 2021 Verisure started enrolling MFA which requires you to obtain a long lived token. This token is used instead of a `password` in your config and will need to be renewed yearly. After installing the plugin, run `npx verisure` in your terminal and copy the output values into your config.
+In 2021 Verisure started enrolling MFA which requires you to obtain a long lived token. This token is used instead of a `password` in your config and will need to be renewed yearly. After installing the plugin, run `npx homebridge-verisure` in your terminal and copy the output values into your config.
 
 ```bash
-$ npx verisure
+$ npx homebridge-verisure
 ✔ What is your login email? · foo@bar.com
 ✔ What is your password? · ********************
 

package/bin/verisure

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+/* eslint-disable no-console */
 
 const { prompt, Password } = require('enquirer');
 
@@ -25,7 +26,7 @@ const run = async () => {
   await verisure.getToken();
 
   if (!verisure.getCookie('vid')) {
-    console.log("\n", 'One-time code sent.', "\n");
+    console.log('\n', 'One-time code sent.', '\n');
 
     const { code } = await prompt({
       type: 'input',
@@ -37,13 +38,13 @@ const run = async () => {
     await verisure.getToken(code.trim());
   }
 
-  console.log("\n", 'Your config is ready.', "\n");
+  console.log('\n', 'Your config is ready.', '\n');
 
   console.log(JSON.stringify({
     platform: 'verisure',
     name: 'Verisure',
     email,
-    token: verisure.getCookie('vid')
+    token: verisure.getCookie('vid'),
   }, null, 2));
 };
 

package/config.schema.json

@@ -18,16 +18,27 @@
       "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": {
+        "title": "Installations",
+        "type": "array",
+        "items": {
+          "type": "string"
+        },
         "required": false
       },
       "pollInterval": {
@@ -35,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.name}: ${message}`);
+  log(message, level = 'info') {
+    return this.logger[level](`${this.installation.config.alias} ${this.name}: ${message}`);
   }
 }
 

package/lib/platform.js

@@ -24,7 +24,12 @@ class VerisurePlatform {
       email,
       token,
       password,
+      installations = [],
       pollInterval = 60,
+      showAutoLockSwitch = true,
+      showAudioSwitch = true,
+      audioOffValue = 'LOW',
+      audioOnValue = 'HIGH',
     } = config;
 
     this.config = {
@@ -33,7 +38,12 @@ class VerisurePlatform {
       email: VERISURE_EMAIL || email,
       password: VERISURE_PASSWORD || password,
       token: VERISURE_TOKEN || token,
+      installations,
       pollInterval,
+      showAutoLockSwitch,
+      showAudioSwitch,
+      audioOffValue,
+      audioOnValue,
     };
 
     this.homebridge = homebridge;
@@ -92,31 +102,44 @@ class VerisurePlatform {
   }
 
   async accessories(callback) {
-    if (!this.verisure.cookies.length) {
-      await this.verisure.getToken();
-
-      if (!this.verisure.getCookie('vid')) {
-        this.logger.error('MFA is enabled for user. Please see README.');
-        return callback([]);
+    try {
+      if (!this.verisure.cookies.length) {
+        await this.verisure.getToken();
+
+        if (!this.verisure.getCookie('vid')) {
+          this.logger.error('MFA is enabled for user. Please see README.');
+          return callback([]);
+        }
       }
+
+      this.installations = (await this.verisure.getInstallations())
+        // Filter out installations based on configuration.
+        .filter((installation) => this.config.installations.length === 0
+          || this.config.installations.includes(installation.config.alias));
+    } catch (error) {
+      this.logger.error(`Unable to get installations. Please check configured credentials: ${error.message}`);
+      return callback([]);
     }
 
-    const installations = await this.verisure.getInstallations();
+    if (this.installations.length === 0) {
+      this.logger.error(`No installations found matching config: ${JSON.stringify(this.config.installations)}`);
+      return callback([]);
+    }
 
-    return Promise.all(
-      installations.map((installation) => Promise.all([
+    const overviews = await Promise.all(
+      this.installations.map((installation) => Promise.all([
         installation,
         installation.getOverview(),
       ])),
-    )
-      .then((overviews) => {
-        const accessoryLists = overviews.map(this.overviewToAccessories.bind(this));
-        callback(accessoryLists.reduce((a, b) => [...a, ...b]));
-      })
-      .catch((error) => {
-        this.logger.error((error.response && error.response.data) || error.message);
-        callback([]);
-      });
+    );
+
+    try {
+      const accessoryLists = overviews.map(this.overviewToAccessories.bind(this));
+      return callback(accessoryLists.reduce((a, b) => [...a, ...b]));
+    } catch (error) {
+      this.logger.error((error.response && error.response.data) || error.message);
+      return callback([]);
+    }
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-verisure",
-  "version": "1.14.1",
+  "version": "1.16.0",
   "description": "Verisure plugin for homebridge: https://github.com/nfarina/homebridge",
   "license": "MIT",
   "keywords": [
@@ -10,18 +10,20 @@
     "type": "git",
     "url": "git://github.com/ptz0n/homebridge-verisure.git"
   },
-  "scripts": {
-    "test": "eslint lib && jest --env=node --coverage"
+  "funding": {
+    "type": "paypal",
+    "url": "https://www.paypal.com/paypalme/ptz0n"
   },
-  "bin": {
-    "verisure": "bin/verisure"
+  "scripts": {
+    "test": "eslint lib && jest --coverage"
   },
+  "bin": "bin/verisure",
   "bugs": {
     "url": "http://github.com/ptz0n/homebridge-verisure/issues"
   },
   "engines": {
-    "node": ">=8",
-    "homebridge": ">=0.2.0"
+    "node": ">=12",
+    "homebridge": ">=1.0.0"
   },
   "dependencies": {
     "enquirer": "^2.3.6",
@@ -33,6 +35,10 @@
     "eslint-plugin-import": "^2.8.0",
     "eslint-plugin-jest": "^23.1.0",
     "hap-nodejs": "^0.7.2",
+    "homebridge": "^1.3.9",
     "jest": "^25.0.0"
+  },
+  "jest": {
+    "testEnvironment": "node"
   }
 }