homebridge-verisure 2.0.2 → 3.0.0

package/CHANGELOG.md

@@ -1,180 +0,0 @@
-## 2.0.2 (Feb 10, 2026)
-
-### Dependencies
-
-* Bump `verisure` module.
-
-## 2.0.1 (Mar 31, 2021)
-
-### Dependencies
-
-* Bump `verisure` module.
-
-## 2.0.0 (Mar 20, 2023)
-
-### Config
-
-* __BREAKING__: Property `cookies` replaces `token`. See README for how to get and configure.
-
-### Plugin & accessories
-
-* Use Verisure GraphQL API.
-
-### Dependencies
-
-* Bump `verisure` module to support GraphQL requests.
-
-## 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
-
-* 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
-
-* Return empty list of accessories when initiation fails.
-
-## 1.13.1 (Feb 27, 2021)
-
-### Plugin
-
-* Safer logging when initiating.
-
-## 1.13.0 (Feb 24, 2021)
-
-### Dependencies
-
-* Bump `verisure` module.
-
-## 1.12.1 (Sep 2, 2020)
-
-### Plugin
-
-* Correct schema file for UI.
-
-## 1.12.0 (Sep 1, 2020)
-
-### Plugin
-
-* Add schema file for UI.
-
-## 1.11.0 (Nov 30, 2019)
-
-### Dependencies
-
-* Bump `verisure` module.
-
-## 1.10.1 (Feb 4, 2019)
-
-### Accessories
-
-* Remove night arm from supported states.
-
-## 1.10.0 (Feb 3, 2019)
-
-### Accessories
-
-* Enable configuration of auto-lock via switch service.
-
-### Platform
-
-* Enable configuration using environment variables.
-
-## 1.9.2 (Dec 23, 2018)
-
-### Accessories
-
-* Set supported temperature range.
-
-## 1.9.1 (Jul 5, 2018)
-
-### Accessories
-
-* When unable to set SmartPlug state, pass a correctly composed error object.
-
-## 1.9.0 (Jun 15, 2018)
-
-### Accessories
-
-* Poll for contact sensor state value.
-
-## 1.8.0 (Jun 11, 2018)
-
-### Accessories
-
-* Poll alarm and door lock accessories for current state.
-
-## 1.7.0 (Jun 5, 2018)
-
-### Refactor
-
-* Split platform from accessories.
-* Setup linting and unit testing with decent coverage.
-
-### Accessories
-
-* Added support for security system.
-* Added support for contact sensors.
-* Added humidity service to supported climate sensors.
-
-## Config
-
-* Key `doorcode` changed to `doorCode`.
-
-## 1.6.0 (Jul 20, 2017)
-
-### Accessories
-
-* Added support for door lock (Yale Doorman).
-
-## 1.5.0 (Apr 23, 2017)
-
-### Dependencies
-
-* Bump `verisure` module.
-
-## 1.4.0 (Feb 2, 2017)
-
-### Accessories
-
-* Added support for climate sensor type `HUMIDITY1`.
-
-## 1.3.0 (Jan 25, 2017)
-
-### Accessories
-
-* Added support for climate sensor type `SIREN1`.
-
-## 1.1.0 (Jan 23, 2017)
-
-Initial release with basic support for climate sensors.

package/bin/verisure

@@ -1,55 +0,0 @@
-#!/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,
-    cookies: verisure.cookies,
-  }, null, 2));
-};
-
-try {
-  run();
-} catch (error) {
-  console.log(error.message);
-}

package/index.js

@@ -1,6 +0,0 @@
-const VerisurePlatform = require('./lib/platform');
-
-module.exports = (homebridge) => {
-  VerisurePlatform.init(homebridge);
-  homebridge.registerPlatform('homebridge-verisure', 'verisure', VerisurePlatform);
-};

package/lib/accessories/alarm.js

@@ -1,111 +0,0 @@
-const VerisureAccessory = require('./verisure');
-
-const {
-  overviewOperation,
-  armAwayOperation,
-  armHomeOperation,
-  disarmOperation,
-  pollArmStateOperation,
-} = require('../operations');
-
-class Alarm extends VerisureAccessory {
-  constructor(...args) {
-    super(...args);
-
-    const { alarmCode } = this.platformConfig;
-    this.alarmCode = alarmCode.toString();
-    this.model = 'ALARM';
-    this.name = VerisureAccessory.getUniqueAccessoryName(`Alarm - ${this.installation.config.alias}`);
-
-    const { SecuritySystemCurrentState } = this.homebridge.hap.Characteristic;
-    this.armStateMap = {
-      ARMED_AWAY: SecuritySystemCurrentState.AWAY_ARM,
-      ARMED_HOME: SecuritySystemCurrentState.STAY_ARM,
-      DISARMED: SecuritySystemCurrentState.DISARMED,
-    };
-  }
-
-  resolveArmState(input) {
-    let output;
-
-    // Verisure to HAP
-    if (typeof input === 'string') {
-      output = this.armStateMap[input];
-    }
-
-    // HAP to Verisure
-    if (typeof input === 'number') {
-      output = Object.keys(this.armStateMap).find((key) => this.armStateMap[key] === input);
-    }
-
-    if (typeof output === 'undefined') {
-      throw Error(`Cannot resolve arm state from unknown input: ${input}`);
-    }
-
-    return output;
-  }
-
-  getCurrentAlarmState(callback) {
-    this.log('Getting current alarm state.', 'debug');
-
-    this.installation.client(overviewOperation)
-      .then((overview) => {
-        callback(null, this.resolveArmState(overview.installation.armState.statusType));
-      })
-      .catch(callback);
-  }
-
-  setTargetAlarmState(value, callback) {
-    this.log(`Setting target alarm state to: ${value}`);
-
-    const targetArmState = this.resolveArmState(value);
-
-    const operation = {
-      ARMED_AWAY: armAwayOperation,
-      ARMED_HOME: armHomeOperation,
-      DISARMED: disarmOperation,
-    }[targetArmState](this.alarmCode);
-
-    this.installation.client(operation)
-      .then(({ transactionId }) => this.resolveChangeResult(
-        pollArmStateOperation(transactionId, targetArmState),
-      ))
-      .then(() => {
-        callback(); // Successful action.
-
-        setImmediate(() => {
-          const { SecuritySystemCurrentState } = this.homebridge.hap.Characteristic;
-          this.service.setCharacteristic(SecuritySystemCurrentState, value);
-        });
-      })
-      .catch(callback);
-  }
-
-  getServices() {
-    const { Service, Characteristic } = this.homebridge.hap;
-
-    this.service = new Service.SecuritySystem(this.name);
-
-    const currentStateCharacteristic = this.service
-      .getCharacteristic(Characteristic.SecuritySystemCurrentState)
-      .on('get', this.getCurrentAlarmState.bind(this));
-
-    const targetStateCharacteristic = this.service
-      .getCharacteristic(Characteristic.SecuritySystemTargetState)
-      .on('get', this.getCurrentAlarmState.bind(this))
-      .on('set', this.setTargetAlarmState.bind(this));
-
-    const { NIGHT_ARM } = Characteristic.SecuritySystemTargetState;
-    const validValues = targetStateCharacteristic.props.validValues
-      .filter((state) => state !== NIGHT_ARM);
-    targetStateCharacteristic.setProps({ validValues });
-
-    this.accessoryInformation.setCharacteristic(Characteristic.Model, this.model);
-
-    this.pollCharacteristics.push(currentStateCharacteristic);
-
-    return [this.accessoryInformation, this.service];
-  }
-}
-
-module.exports = Alarm;

package/lib/accessories/climatesensor.js

@@ -1,68 +0,0 @@
-const VerisureAccessory = require('./verisure');
-const { overviewOperation } = require('../operations');
-const i18n = require('../i18n');
-
-const deviceNames = {
-  HOMEPAD: 'VoiceBox',
-  HUMIDITY: 'Climate sensor',
-  SIREN: 'Siren',
-  SMOKE: 'Smoke detector',
-  VOICEBOX: 'VoiceBox',
-  // TODO: Old ones, not verified from GraphQL.
-  SMARTCAMERA1: 'SmartCam',
-  WATER1: 'Water detector',
-};
-
-class ClimateSensor extends VerisureAccessory {
-  constructor(...args) {
-    super(...args);
-
-    const { device: { area, gui: { label } } } = this.config;
-    const _ = i18n(this.installation.locale);
-    const name = _(deviceNames[label]) || label;
-
-    this.model = label;
-    this.name = VerisureAccessory.getUniqueAccessoryName(`${name} - ${area}`);
-  }
-
-  getCurrentPropertyValue(property, callback) {
-    this.log(`Getting current ${property} value.`);
-
-    this.installation.client(overviewOperation)
-      .then((overview) => overview.installation.climates
-        .find((climate) => climate.device.deviceLabel === this.serialNumber))
-      .then((device) => {
-        callback(null, device[`${property}Value`]);
-      })
-      .catch(callback);
-  }
-
-  getServices() {
-    const { Service, Characteristic } = this.homebridge.hap;
-
-    const services = [];
-
-    services.push(this.accessoryInformation.setCharacteristic(Characteristic.Model, this.model));
-
-    if (this.config.temperatureValue) {
-      this.temperatureService = new Service.TemperatureSensor(this.name);
-      this.temperatureService
-        .getCharacteristic(Characteristic.CurrentTemperature)
-        .setProps({ minValue: -40.0, maxValue: 60.0 })
-        .on('get', this.getCurrentPropertyValue.bind(this, 'temperature'));
-      services.push(this.temperatureService);
-    }
-
-    if (this.config.humidityValue) {
-      this.humidityService = new Service.HumiditySensor(this.name);
-      this.humidityService
-        .getCharacteristic(Characteristic.CurrentRelativeHumidity)
-        .on('get', this.getCurrentPropertyValue.bind(this, 'humidity'));
-      services.push(this.humidityService);
-    }
-
-    return services;
-  }
-}
-
-module.exports = ClimateSensor;

package/lib/accessories/contactsensor.js

@@ -1,45 +0,0 @@
-const VerisureAccessory = require('./verisure');
-const { overviewOperation } = require('../operations');
-
-class ContactSensor extends VerisureAccessory {
-  constructor(...args) {
-    super(...args);
-
-    const { device: { area }, state } = this.config;
-
-    this.name = VerisureAccessory.getUniqueAccessoryName(area);
-    this.value = ContactSensor.resolveSensorState(state);
-  }
-
-  static resolveSensorState(input) {
-    return input !== 'CLOSE';
-  }
-
-  getCurrentSensorState(callback) {
-    this.log('Getting current sensor state.', 'debug');
-
-    this.installation.client(overviewOperation)
-      .then((overview) => overview.installation.doorWindows
-        .find((doorWindow) => doorWindow.device.deviceLabel === this.serialNumber))
-      .then((doorWindow) => {
-        this.value = ContactSensor.resolveSensorState(doorWindow.state);
-        callback(null, this.value);
-      })
-      .catch(callback);
-  }
-
-  getServices() {
-    const { Service, Characteristic } = this.homebridge.hap;
-
-    this.service = new Service.ContactSensor(this.name);
-    const currentStateCharacteristic = this.service
-      .getCharacteristic(Characteristic.ContactSensorState)
-      .on('get', this.getCurrentSensorState.bind(this));
-
-    this.pollCharacteristics.push(currentStateCharacteristic);
-
-    return [this.accessoryInformation, this.service];
-  }
-}
-
-module.exports = ContactSensor;

package/lib/accessories/doorlock.js

@@ -1,216 +0,0 @@
-const VerisureAccessory = require('./verisure');
-const {
-  overviewOperation,
-  doorLockOperation,
-  doorUnlockOperation,
-  pollLockStateOperation,
-  doorLockConfigOperation,
-  doorLockUpdateConfigOperation,
-} = require('../operations');
-
-class DoorLock extends VerisureAccessory {
-  constructor(...args) {
-    super(...args);
-
-    const { area } = this.config.device;
-    this.name = VerisureAccessory.getUniqueAccessoryName(`SmartLock - ${area}`);
-
-    this.doorCode = this.platformConfig.doorCode;
-    this.switchName = VerisureAccessory.getUniqueAccessoryName(`Auto-lock - ${area}`);
-    this.audioName = VerisureAccessory.getUniqueAccessoryName(`Audio - ${area}`);
-
-    // TODO: Could set currentLockState here.
-  }
-
-  resolveCurrentLockState({ currentLockState, motorJam }) {
-    const { LockCurrentState } = this.homebridge.hap.Characteristic;
-
-    if (motorJam) {
-      return LockCurrentState.JAMMED;
-    }
-
-    return currentLockState === 'LOCKED'
-      ? LockCurrentState.SECURED
-      : LockCurrentState.UNSECURED;
-  }
-
-  getDoorLockState() {
-    this.log('Getting current lock state.', 'debug');
-
-    return this.installation.client(overviewOperation)
-      .then((overview) => overview.installation.doorlocks
-        .find((doorlock) => doorlock.device.deviceLabel === this.serialNumber))
-      .then((doorLock) => {
-        if (!doorLock) {
-          throw Error(`Could not find lock state for ${this.name}.`);
-        }
-        return doorLock;
-      });
-  }
-
-  getCurrentLockState(callback) {
-    // TODO: Use this.cachedValue, if available?
-
-    this.getDoorLockState().then((doorLock) => {
-      callback(null, this.resolveCurrentLockState(doorLock));
-    }).catch(callback);
-  }
-
-  getTargetLockState(callback) {
-    this.log('Getting target lock state.');
-
-    this.getDoorLockState().then(({ currentLockState }) => {
-      const { LockTargetState } = this.homebridge.hap.Characteristic;
-
-      const targetLockState = this.targetLockState || currentLockState;
-
-      callback(null, targetLockState === 'LOCKED'
-        ? LockTargetState.SECURED
-        : LockTargetState.UNSECURED);
-    }).catch((error) => {
-      callback(error);
-    });
-  }
-
-  setTargetLockState(value, callback) {
-    this.log(`Setting target lock state to: ${value}`);
-
-    this.targetLockState = value === this.homebridge.hap.Characteristic.LockCurrentState.SECURED
-      ? 'LOCKED'
-      : 'UNLOCKED';
-
-    const operation = this.targetLockState === 'LOCKED'
-      ? doorLockOperation
-      : doorUnlockOperation;
-
-    this.installation.client(operation(this.serialNumber, this.doorCode))
-      .then(({ transactionId }) => this.resolveChangeResult(
-        pollLockStateOperation(transactionId, this.serialNumber, this.targetLockState),
-      ))
-      .catch((error) => {
-        const isAlreadyAtTargetStateError = error.errors && error.errors
-          .find(({ data: { errorCode } }) => errorCode === 'VAL_00819');
-        if (isAlreadyAtTargetStateError) {
-          return true; // Lock at desired state.
-        }
-
-        throw error;
-      })
-      .then(() => {
-        callback(); // Successful action.
-
-        setImmediate(() => {
-          const { LockCurrentState } = this.homebridge.hap.Characteristic;
-          this.lockService.setCharacteristic(LockCurrentState, value);
-        });
-        // TODO: Set this.cachedValue with TTL?
-      })
-      .catch(callback);
-  }
-
-  static resolveAutoLockState(config) {
-    return config.autoLockEnabled === true;
-  }
-
-  getAutoLockState(callback) {
-    this.log('Getting current auto lock config.');
-
-    this.installation.client(doorLockConfigOperation(this.serialNumber))
-      .then(({ installation: { smartLocks: [smartLock] } }) => {
-        this.autoLockState = DoorLock.resolveAutoLockState(smartLock.configuration);
-        callback(null, this.autoLockState);
-      })
-      .catch(callback);
-  }
-
-  setAutoLockState(value, callback) {
-    this.log(`Setting auto lock to: ${value}`);
-
-    this.autoLockState = value;
-
-    this.installation.client(
-      doorLockUpdateConfigOperation(this.serialNumber, { autoLockEnabled: value }),
-    )
-      .then(() => callback(null))
-      .catch((error) => {
-        this.log(error.message, 'debug');
-        // TODO: Revert config state in this.value?
-        callback({ message: error.errorMessage });
-      });
-  }
-
-  getAudioState(callback) {
-    this.log('Getting current audio config.');
-
-    this.installation.client(doorLockConfigOperation(this.serialNumber))
-      .then(({ installation: { smartLocks: [smartLock] } }) => {
-        this.audioState = smartLock.configuration.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;
-
-    this.log(`Setting audio volume to: ${volume}`);
-
-    this.installation.client(
-      doorLockUpdateConfigOperation(this.serialNumber, { volume }),
-    )
-      .then(() => callback(null))
-      .catch((error) => {
-        this.log(error.message, 'debug');
-        // TODO: Revert config state in this.value?
-        callback({ message: error.errorMessage });
-      });
-  }
-
-  getServices() {
-    const { Service, Characteristic } = this.homebridge.hap;
-
-    const services = [this.accessoryInformation];
-
-    this.lockService = new Service.LockMechanism(this.name);
-    const currentStateCharacteristic = this.lockService
-      .getCharacteristic(Characteristic.LockCurrentState)
-      .on('get', this.getCurrentLockState.bind(this));
-
-    this.lockService
-      .getCharacteristic(Characteristic.LockTargetState)
-      .on('get', this.getTargetLockState.bind(this))
-      .on('set', this.setTargetLockState.bind(this));
-
-    services.push(this.lockService);
-
-    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.audioService);
-    }
-
-    this.pollCharacteristics.push(currentStateCharacteristic);
-
-    return services;
-  }
-}
-
-module.exports = DoorLock;

package/lib/accessories/index.js

@@ -1,13 +0,0 @@
-const Alarm = require('./alarm');
-const ClimateSensor = require('./climatesensor');
-const ContactSensor = require('./contactsensor');
-const DoorLock = require('./doorlock');
-const SmartPlug = require('./smartplug');
-
-module.exports = {
-  alarm: Alarm,
-  climateSensor: ClimateSensor,
-  contactSensor: ContactSensor,
-  doorLock: DoorLock,
-  smartPlug: SmartPlug,
-};