homebridge-verisure 1.13.2 → 1.15.0

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+## 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
+
+* Bump `verisure` module.
+
+## 1.14.0 (Mar 17, 2021)
+
+### Config
+
+* Support for Multi-factor authentication (MFA).
+
+### Dependencies
+
+* Bump `verisure` module.
+
 ## 1.13.2 (Feb 28, 2021)
 
 ### Plugin

package/README.md

@@ -48,19 +48,48 @@ your array (list) of enabled platform plugins. Example config:
     "name" : "Verisure",
     "email": "your@email.com",
     "password": "yourT0p5ecre7Passw0rd",
+    "token": "vid=topSecretToken",
     "alarmCode": "0000",
     "doorCode": "000000",
+    "installations": ["Alias"],
     "pollInterval": 60
   }
 ]
 ```
 
 * __`email`__ Required string containing your Verisure account email address.
-* __`password`__ Required string containing your Verisure account password.
+* __`password`__ Required string containing your Verisure account password. Not needed if you use a `token`.
+* __`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 homebridge-verisure` in your terminal and copy the output values into your config.
+
+```bash
+$ npx homebridge-verisure
+✔ What is your login email? · foo@bar.com
+✔ What is your password? · ********************
+
+ One-time code sent.
+
+✔ What is your one-time code? · FAKE12
+
+ Your config is ready.
+
+{
+  "platform": "verisure",
+  "name": "Verisure",
+  "email": "foo@bar.com",
+  "token": "vid=topSecretToken"
+}
+```
+
 ### Environment variables
 
 For convenience, the following environment variables can be used instead of placing secrets in your `config.json`.
@@ -69,3 +98,4 @@ For convenience, the following environment variables can be used instead of plac
 * `VERISURE_DOOR_CODE`
 * `VERISURE_EMAIL`
 * `VERISURE_PASSWORD`
+* `VERISURE_TOKEN`

package/bin/verisure

@@ -0,0 +1,55 @@
+#!/usr/bin/env node
+/* eslint-disable no-console */
+
+const { prompt, Password } = require('enquirer');
+
+const Verisure = require('verisure');
+
+const validate = (value) => !!value.length;
+
+const run = async () => {
+  const { email } = await prompt({
+    type: 'input',
+    name: 'email',
+    message: 'What is your login email?',
+    validate,
+  });
+
+  const password = await new Password({
+    name: 'password',
+    message: 'What is your password?',
+    validate,
+  }).run();
+
+  const verisure = new Verisure(email.trim(), password);
+
+  await verisure.getToken();
+
+  if (!verisure.getCookie('vid')) {
+    console.log('\n', 'One-time code sent.', '\n');
+
+    const { code } = await prompt({
+      type: 'input',
+      name: 'code',
+      message: 'What is your one-time code?',
+      validate,
+    });
+
+    await verisure.getToken(code.trim());
+  }
+
+  console.log('\n', 'Your config is ready.', '\n');
+
+  console.log(JSON.stringify({
+    platform: 'verisure',
+    name: 'Verisure',
+    email,
+    token: verisure.getCookie('vid'),
+  }, null, 2));
+};
+
+try {
+  run();
+} catch (error) {
+  console.log(error.message);
+}

package/config.schema.json

@@ -13,7 +13,12 @@
       "password": {
         "title": "Password",
         "type": "string",
-        "required": true
+        "required": false
+      },
+      "token": {
+        "title": "Token",
+        "type": "string",
+        "required": false
       },
       "alarmCode": {
         "title": "Alarm Code",
@@ -25,6 +30,14 @@
         "type": "string",
         "required": false
       },
+      "installations": {
+        "title": "Installations",
+        "type": "array",
+        "items": {
+          "type": "string"
+        },
+        "required": false
+      },
       "pollInterval": {
         "title": "Poll interval",
         "type": "integer",

package/lib/accessories/verisure.js

@@ -54,7 +54,7 @@ class VerisureAccessory {
   }
 
   log(message) {
-    return this.logger('info', `${this.name}: ${message}`);
+    return this.logger('info', `${this.installation.config.alias} ${this.name}: ${message}`);
   }
 }
 

package/lib/platform.js

@@ -15,13 +15,16 @@ class VerisurePlatform {
       VERISURE_DOOR_CODE,
       VERISURE_EMAIL,
       VERISURE_PASSWORD,
+      VERISURE_TOKEN,
     } = process.env;
 
     const {
       alarmCode,
       doorcode, doorCode,
       email,
+      token,
       password,
+      installations = [],
       pollInterval = 60,
     } = config;
 
@@ -30,13 +33,19 @@ class VerisurePlatform {
       doorCode: VERISURE_DOOR_CODE || doorcode || doorCode,
       email: VERISURE_EMAIL || email,
       password: VERISURE_PASSWORD || password,
+      token: VERISURE_TOKEN || token,
+      installations,
       pollInterval,
     };
 
     this.homebridge = homebridge;
     this.logger = logger;
 
-    this.verisure = new Verisure(this.config.email, this.config.password);
+    this.verisure = new Verisure(
+      this.config.email,
+      this.config.password,
+      this.config.token && [this.config.token],
+    );
   }
 
   static init(homebridgeRef) {
@@ -84,23 +93,45 @@ class VerisurePlatform {
     return accessories;
   }
 
-  accessories(callback) {
-    this.verisure.getToken()
-      .then(() => this.verisure.getInstallations(), (error) => { throw Error(error); })
-      .then((installations) => Promise.all(
-        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([]);
-      });
+  async accessories(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([]);
+    }
+
+    if (this.installations.length === 0) {
+      this.logger.error(`No installations found matching config: ${JSON.stringify(this.config.installations)}`);
+      return callback([]);
+    }
+
+    const overviews = await Promise.all(
+      this.installations.map((installation) => Promise.all([
+        installation,
+        installation.getOverview(),
+      ])),
+    );
+
+    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.13.2",
+  "version": "1.15.0",
   "description": "Verisure plugin for homebridge: https://github.com/nfarina/homebridge",
   "license": "MIT",
   "keywords": [
@@ -11,24 +11,30 @@
     "url": "git://github.com/ptz0n/homebridge-verisure.git"
   },
   "scripts": {
-    "test": "eslint lib && jest --env=node --coverage"
+    "test": "eslint lib && jest --coverage"
   },
+  "bin": "bin/verisure",
   "bugs": {
     "url": "http://github.com/ptz0n/homebridge-verisure/issues"
   },
   "engines": {
-    "node": ">=8",
+    "node": ">=12",
     "homebridge": ">=0.2.0"
   },
   "dependencies": {
-    "verisure": "^3.1.1"
+    "enquirer": "^2.3.6",
+    "verisure": "^4.1.0"
   },
   "devDependencies": {
+    "eslint": "^6.7.2",
     "eslint-config-airbnb-base": "^14.0.0",
     "eslint-plugin-import": "^2.8.0",
     "eslint-plugin-jest": "^23.1.0",
-    "eslint": "^6.7.2",
     "hap-nodejs": "^0.7.2",
+    "homebridge": "^1.3.9",
     "jest": "^25.0.0"
+  },
+  "jest": {
+    "testEnvironment": "node"
   }
 }