homebridge-lib 5.1.24-5 → 5.2.2

package/lib/ServiceDelegate/Dummy.js

@@ -0,0 +1,44 @@
+// homebridge-lib/lib/ServiceDelegate/Dummy.js
+//
+// Library for Homebridge plugins.
+// Copyright © 2017-2022 Erik Baauw. All rights reserved.
+
+'use strict'
+
+const homebridgeLib = require('../../index')
+
+const { ServiceDelegate } = homebridgeLib
+
+/** Class for a delegate for a dummy _StatelessProgrammableSwitch_ service.
+  *
+  * This delegate sets up a dummy `Services.hap.StatelessProgrammableSwitch`
+  * HomeKit service with the following HomeKit characteristics:
+  *
+  * key                       | Characteristic                                | isOptional
+  * ------------------------- | --------------------------------------------- | ----------
+  * `name`                    | `Characteristics.hap.Name`                    |
+  * `programmableSwitchEvent` | `Characteristics.hap.ProgrammableSwitchEvent` |
+  *
+  * Including the dummy service prevents Home from showing a _Not Supported_
+  * tile, and causes Home on iOS14 to show the _Favorite_ setting.
+  * @extends ServiceDelegate
+  * @memberof ServiceDelegate
+  */
+class Dummy extends ServiceDelegate {
+  constructor (nbAccessory, params = {}) {
+    params.name = nbAccessory.name
+    params.Service = nbAccessory.Services.hap.StatelessProgrammableSwitch
+    super(nbAccessory, params)
+
+    this.addCharacteristicDelegate({
+      key: 'programmableSwitchEvent',
+      Characteristic: this.Characteristics.hap.ProgrammableSwitchEvent,
+      props: {
+        minValue: this.Characteristics.hap.ProgrammableSwitchEvent.SINGLE_PRESS,
+        maxValue: this.Characteristics.hap.ProgrammableSwitchEvent.SINGLE_PRESS
+      }
+    })
+  }
+}
+
+module.exports = Dummy

package/lib/ServiceDelegate/History/Consumption.js

@@ -0,0 +1,114 @@
+// homebridge-lib/lib/ServiceDelegate/History/Consumption.js
+//
+// Library for Homebridge plugins.
+// Copyright © 2017-2022 Erik Baauw. All rights reserved.
+//
+// The logic for handling Eve history was copied from Simone Tisa's
+// fakagato-history repository, copyright © 2017 simont77.
+// See https://github.com/simont77/fakegato-history.
+
+'use strict'
+
+const homebridgeLib = require('../../../index')
+const util = require('util')
+
+const { ServiceDelegate } = homebridgeLib
+const { History } = ServiceDelegate
+const { swap16, swap32, numToHex } = History
+
+/** Class for an Eve Energy _History_ service delegate.
+  *
+  * This delegate sets up a `Services.eve.History` HomeKit service
+  * with keys for the following HomeKit characteristics:
+  *
+  * key              | Characteristic
+  * ---------------- | ----------------------------------
+  * `name`           | `Characteristics.hap.Name`
+  * `historyRequest` | `Characteristics.eve.HistoryRequest`
+  * `setTime`        | `Characteristics.eve.SetTime`
+  * `historyStatus`  | `Characteristics.eve.HistoryStatus`
+  * `historyEntries` | `Characteristics.eve.HistoryEntries`
+  *
+  * This delegate is for sensors that report life-time consumption. The history
+  * is computed from the changes to the value of the associated
+  * `Characteristics.eve.TotalConsumption` characteristic. If the sensor doesn't
+  * also report power, this delegate can update the the value of the associated
+  * `Characteristics.eve.CurrentConsumption` characteristic.
+  *
+  * Note that the key in the history entry is called `power`, but its value
+  * is the consumption in Wh since the previous entry.
+  *
+  * @extends ServiceDelegate.History
+  * @memberof ServiceDelegate.History
+  */
+class Consumption extends History {
+  /** Create a new instance of an Eve Energy _History_ service delegate.
+    * @param {!AccessoryDelegate} accessoryDelegate - The delegate of the
+    * corresponding HomeKit accessory.
+    * @param {!object} params - The parameters for the
+    * _History_ HomeKit service.
+    * @param {!CharacteristicDelegate} consumptionDelegate - A reference to the
+    * delegate of the associated `Characteristics.eve.TotalConsumption`
+    * characteristic.
+    * @param {?CharacteristicDelegate} powerDelegate - A reference to the
+    * delegate of the associated `Characteristics.eve.CurrentConsumption`
+    * characteristic.
+    */
+  constructor (
+    accessoryDelegate, params, consumptionDelegate, powerDelegate
+  ) {
+    super(accessoryDelegate, params)
+    if (!(consumptionDelegate instanceof homebridgeLib.CharacteristicDelegate)) {
+      throw new TypeError('consumptionDelegate: not a CharacteristicDelegate')
+    }
+    if (
+      powerDelegate != null &&
+      !(powerDelegate instanceof homebridgeLib.CharacteristicDelegate)
+    ) {
+      throw new TypeError('powerDelegate: not a CharacteristicDelegate')
+    }
+    this.addCharacteristicDelegate({
+      key: 'consumption',
+      silent: true
+    })
+    this.addCharacteristicDelegate({
+      key: 'time',
+      silent: true
+    })
+    this._consumptionDelegate = consumptionDelegate
+    this._powerDelegate = powerDelegate
+    this._entry = { time: 0, power: 0 }
+  }
+
+  _addEntry () {
+    const now = Math.round(new Date().valueOf() / 1000)
+    // Sensor deliveres totalConsumption, optionally compute currentConsumption
+    if (this.values.consumption != null && this.values.time != null) {
+      const delta = this._consumptionDelegate.value - this.values.consumption // kWh
+      const period = now - this.values.time // s
+      const power = Math.round(1000 * 3600 * delta / period) // W
+      if (this._powerDelegate != null) {
+        this._powerDelegate.value = power
+      }
+      this._entry.power = power
+      super._addEntry(now)
+    }
+    this.values.consumption = this._consumptionDelegate.value
+    this.values.time = now
+  }
+
+  // get _fingerPrint () { return '04 0102 0202 0702 0f03' }
+  get _fingerPrint () { return '01 0702' }
+
+  _entryStream (entry) {
+    return util.format(
+      // '|14 %s %s 1f 0000 0000 %s 0000 0000',
+      '|0c %s %s 01 %s',
+      numToHex(swap32(this._h.currentEntry), 8),
+      numToHex(swap32(entry.time - this._h.initialTime), 8),
+      numToHex(swap16(entry.power * 10), 4)
+    )
+  }
+}
+
+module.exports = Consumption

package/lib/ServiceDelegate/History/Contact.js

@@ -0,0 +1,100 @@
+// homebridge-lib/lib/ServiceDelegate/History/Contact.js
+//
+// Library for Homebridge plugins.
+// Copyright © 2017-2022 Erik Baauw. All rights reserved.
+//
+// The logic for handling Eve history was copied from Simone Tisa's
+// fakagato-history repository, copyright © 2017 simont77.
+// See https://github.com/simont77/fakegato-history.
+
+'use strict'
+
+const homebridgeLib = require('../../../index')
+const util = require('util')
+
+const { ServiceDelegate } = homebridgeLib
+const { History } = ServiceDelegate
+const { swap32, numToHex } = History
+
+/** Class for an Eve Door _History_ service delegate.
+  *
+  * This delegate sets up a `Services.eve.History` HomeKit service
+  * with keys for the following HomeKit characteristics:
+  *
+  * key              | Characteristic
+  * ---------------- | ----------------------------------
+  * `name`           | `Characteristics.hap.Name`
+  * `historyRequest` | `Characteristics.eve.HistoryRequest`
+  * `setTime`        | `Characteristics.eve.SetTime`
+  * `historyStatus`  | `Characteristics.eve.HistoryStatus`
+  * `historyEntries` | `Characteristics.eve.HistoryEntries`
+  * `resetTotal`     | `Characteristics.eve.ResetTotal`
+  *
+  * This delegate creates the history from the associated
+  * `Characteristics.hap.ContactSensorState` characteristic.  It updates the
+  * values of the associated `Characteristics.eve.TimesOpened` and
+  * `Characteristics.eve.LastActivation` characteristics.
+  * @extends ServiceDelegate.History
+  * @memberof ServiceDelegate.History
+  */
+class Contact extends History {
+  /** Create a new instance of an Eve Door _History_ service delegate.
+    * @param {!AccessoryDelegate} accessoryDelegate - The delegate of the
+    * corresponding HomeKit accessory.
+    * @param {!object} params - The parameters for the
+    * _History_ HomeKit service.
+    * @param {!CharacteristicDelegate} contactDelegate - A reference to the
+    * delegate of the associated `Characteristics.hap.ContactSensorState`
+    * characteristic.
+    * @param {!CharacteristicDelegate} timesOpenedDelegate - A reference to the
+    * delegate of the associated `Characteristics.eve.TimesOpened`
+    * characteristic.
+    * @param {!CharacteristicDelegate} lastActivationDelegate - A reference to the
+    * delegate of the associated `Characteristics.eve.LastActivation`
+    * characteristic.
+    */
+  constructor (
+    accessoryDelegate, params,
+    contactDelegate, timesOpenedDelegate, lastActivationDelegate
+  ) {
+    super(accessoryDelegate, params)
+    if (!(contactDelegate instanceof homebridgeLib.CharacteristicDelegate)) {
+      throw new TypeError('contactDelegate: not a CharacteristicDelegate')
+    }
+    if (!(timesOpenedDelegate instanceof homebridgeLib.CharacteristicDelegate)) {
+      throw new TypeError('timesOpenedDelegate: not a CharacteristicDelegate')
+    }
+    if (!(lastActivationDelegate instanceof homebridgeLib.CharacteristicDelegate)) {
+      throw new TypeError('lastActivationDelegate: not a CharacteristicDelegate')
+    }
+    this._entry = { time: 0, status: contactDelegate.value }
+    contactDelegate.on('didSet', (value) => {
+      const now = Math.round(new Date().valueOf() / 1000)
+      timesOpenedDelegate.value += value
+      lastActivationDelegate.value = now - this._h.initialTime
+      this._entry.status = value
+      this._addEntry(now)
+    })
+    this.addCharacteristicDelegate({
+      key: 'resetTotal',
+      Characteristic: this.Characteristics.eve.ResetTotal,
+      value: params.resetTotal
+    })
+    this._characteristicDelegates.resetTotal.on('didSet', (value) => {
+      timesOpenedDelegate.value = 0
+    })
+  }
+
+  get _fingerPrint () { return '01 0601' }
+
+  _entryStream (entry) {
+    return util.format(
+      '|0b %s %s 01 %s',
+      numToHex(swap32(this._h.currentEntry), 8),
+      numToHex(swap32(entry.time - this._h.initialTime), 8),
+      numToHex(entry.status, 2)
+    )
+  }
+}
+
+module.exports = Contact

package/lib/ServiceDelegate/History/Motion.js

@@ -0,0 +1,122 @@
+// homebridge-lib/lib/ServiceDelegate/History/Motion.js
+//
+// Library for Homebridge plugins.
+// Copyright © 2017-2022 Erik Baauw. All rights reserved.
+//
+// The logic for handling Eve history was copied from Simone Tisa's
+// fakagato-history repository, copyright © 2017 simont77.
+// See https://github.com/simont77/fakegato-history.
+
+'use strict'
+
+const homebridgeLib = require('../../../index')
+const util = require('util')
+
+const { ServiceDelegate } = homebridgeLib
+const { History } = ServiceDelegate
+const { swap16, swap32, numToHex } = History
+
+/** Class for an Eve Motion _History_ service delegate.
+  *
+  * This delegate sets up a `Services.eve.History` HomeKit service
+  * with keys for the following HomeKit characteristics:
+  *
+  * key              | Characteristic
+  * ---------------- | ----------------------------------
+  * `name`           | `Characteristics.hap.Name`
+  * `historyRequest` | `Characteristics.eve.HistoryRequest`
+  * `setTime`        | `Characteristics.eve.SetTime`
+  * `historyStatus`  | `Characteristics.eve.HistoryStatus`
+  * `historyEntries` | `Characteristics.eve.HistoryEntries`
+  * `resetTotal`     | `Characteristics.eve.ResetTotal`
+  *
+  * This delegate creates the history from the associated
+  * `Characteristics.hap.MotionDetected` characteristic.  It updates the
+  * value of the associated `Characteristics.eve.LastActivation` characteristic.
+  * @extends ServiceDelegate.History
+  * @memberof ServiceDelegate.History
+  */
+class Motion extends History {
+  /** Create a new instance of an Eve Motion _History_ service delegate.
+    * @param {!AccessoryDelegate} accessoryDelegate - The delegate of the
+    * corresponding HomeKit accessory.
+    * @param {!object} params - The parameters for the
+    * _History_ HomeKit service.
+    * @param {!CharacteristicDelegate} motionDelegate - A reference to the
+    * delegate of the associated `Characteristics.hap.MotionDetected`
+    * characteristic.
+    * @param {!CharacteristicDelegate} lastActivationDelegate - A reference to the
+    * delegate of the associated `Characteristics.eve.LastActivation`
+    * characteristic.
+    * @param {?CharacteristicDelegate} temperatureDelegate - A reference to the
+    * delegate of the associated `Characteristics.hap.CurrentTemperature`
+    * characteristic.  For PIR sensors (like the Hue motion sensor) that report
+    * temperature in addition to motion.
+    */
+  constructor (
+    accessoryDelegate, params,
+    motionDelegate, lastActivationDelegate, temperatureDelegate
+  ) {
+    super(accessoryDelegate, params)
+    if (!(motionDelegate instanceof homebridgeLib.CharacteristicDelegate)) {
+      throw new TypeError('motionDelegate: not a CharacteristicDelegate')
+    }
+    if (!(lastActivationDelegate instanceof homebridgeLib.CharacteristicDelegate)) {
+      throw new TypeError('lastActivationDelegate: not a CharacteristicDelegate')
+    }
+    if (
+      temperatureDelegate != null &&
+      !(temperatureDelegate instanceof homebridgeLib.CharacteristicDelegate)
+    ) {
+      throw new TypeError('temperatureDelegate: not a CharacteristicDelegate')
+    }
+    this._entry = { time: 0, status: motionDelegate.value }
+    motionDelegate.on('didSet', (value) => {
+      const now = Math.round(new Date().valueOf() / 1000)
+      lastActivationDelegate.value = now - this._h.initialTime
+      this._entry.status = value
+      // Eve v5.4.2 fills in missing temperature at 0.00°C.
+      // if (this._entry.temp != null) {
+      //   const temp = this._entry.temp
+      //   this._entry.temp = null
+      //   this._addEntry(now)
+      //   this._entry.temp = temp
+      // } else {
+      this._addEntry(now)
+      // }
+    })
+    if (temperatureDelegate != null) {
+      this._entry.temp = temperatureDelegate.value
+      temperatureDelegate.on('didSet', (value) => {
+        this._entry.temp = value
+      })
+    }
+  }
+
+  get _fingerPrint () {
+    if (this._entry.temp != null) {
+      return '02 1c01 0102'
+    }
+    return '01 1c01'
+  }
+
+  _entryStream (entry) {
+    if (this._entry.temp != null) {
+      return util.format(
+        '|0d %s %s 03 %s %s',
+        numToHex(swap32(this._h.currentEntry), 8),
+        numToHex(swap32(entry.time - this._h.initialTime), 8),
+        numToHex(entry.status, 2),
+        numToHex(swap16(entry.temp * 100), 4)
+      )
+    }
+    return util.format(
+      '|0b %s %s 01 %s',
+      numToHex(swap32(this._h.currentEntry), 8),
+      numToHex(swap32(entry.time - this._h.initialTime), 8),
+      numToHex(entry.status, 2)
+    )
+  }
+}
+
+module.exports = Motion

package/lib/ServiceDelegate/History/On.js

@@ -0,0 +1,86 @@
+// homebridge-lib/lib/ServiceDelegate/History/On.js
+//
+// Library for Homebridge plugins.
+// Copyright © 2017-2022 Erik Baauw. All rights reserved.
+//
+// The logic for handling Eve history was copied from Simone Tisa's
+// fakagato-history repository, copyright © 2017 simont77.
+// See https://github.com/simont77/fakegato-history.
+
+'use strict'
+
+const homebridgeLib = require('../../../index')
+const util = require('util')
+
+const { ServiceDelegate } = homebridgeLib
+const { History } = ServiceDelegate
+const { swap32, numToHex } = History
+
+/** Class for a Raspberry Pi _History_ service delegate.
+  *
+  * This delegate sets up a `Services.eve.History` HomeKit service
+  * with keys for the following HomeKit characteristics:
+  *
+  * key              | Characteristic
+  * ---------------- | ----------------------------------
+  * `name`           | `Characteristics.hap.Name`
+  * `historyRequest` | `Characteristics.eve.HistoryRequest`
+  * `setTime`        | `Characteristics.eve.SetTime`
+  * `historyStatus`  | `Characteristics.eve.HistoryStatus`
+  * `historyEntries` | `Characteristics.eve.HistoryEntries`
+  *
+  * This delegate creates the history from the associated
+  * `Characteristics.hap.On` characteristic.
+  * @extends ServiceDelegate.History
+  * @memberof ServiceDelegate.History
+  */
+class On extends History {
+  /** Create a new instance of a Raspberry Pi _History_ service delegate.
+    * @param {!AccessoryDelegate} accessoryDelegate - The delegate of the
+    * corresponding HomeKit accessory.
+    * @param {!object} params - The parameters for the
+    * _History_ HomeKit service.
+    * @param {!CharacteristicDelegate} onDelegate - A reference to the
+    * delegate of the associated `Characteristics.hap.On`
+    * characteristic.
+    */
+  constructor (accessoryDelegate, params, onDelegate, temperatureDelegate) {
+    super(accessoryDelegate, params)
+    if (!(onDelegate instanceof homebridgeLib.CharacteristicDelegate)) {
+      throw new TypeError('onDelegate: not a CharacteristicDelegate')
+    }
+    if (
+      temperatureDelegate != null &&
+      !(temperatureDelegate instanceof homebridgeLib.CharacteristicDelegate)
+    ) {
+      throw new TypeError('temperatureDelegate: not a CharacteristicDelegate')
+    }
+    this._entry = {
+      time: 0,
+      on: onDelegate.value ? 1 : 0
+    }
+    onDelegate.on('didSet', (value) => {
+      this._entry.on = value ? 1 : 0
+      this._addEntry()
+    })
+    if (temperatureDelegate != null) {
+      this._entry.temp = temperatureDelegate.value
+      temperatureDelegate.on('didSet', (value) => {
+        this._entry.temp = value
+      })
+    }
+  }
+
+  get _fingerPrint () { return '01 0e01' }
+
+  _entryStream (entry) {
+    return util.format(
+      '|0b %s %s 01 %s',
+      numToHex(swap32(this._h.currentEntry), 8),
+      numToHex(swap32(entry.time - this._h.initialTime), 8),
+      numToHex(entry.on, 2)
+    )
+  }
+}
+
+module.exports = On

package/lib/ServiceDelegate/History/Power.js

@@ -0,0 +1,121 @@
+// homebridge-lib/lib/ServiceDelegate/History/Power.js
+//
+// Library for Homebridge plugins.
+// Copyright © 2017-2022 Erik Baauw. All rights reserved.
+//
+// The logic for handling Eve history was copied from Simone Tisa's
+// fakagato-history repository, copyright © 2017 simont77.
+// See https://github.com/simont77/fakegato-history.
+
+'use strict'
+
+const homebridgeLib = require('../../../index')
+const util = require('util')
+
+const { ServiceDelegate } = homebridgeLib
+const { History } = ServiceDelegate
+const { swap16, swap32, numToHex } = History
+
+/** Class for an Eve Energy _History_ service delegate.
+  *
+  * This delegate sets up a `Services.eve.History` HomeKit service
+  * with keys for the following HomeKit characteristics:
+  *
+  * key              | Characteristic
+  * ---------------- | ----------------------------------
+  * `name`           | `Characteristics.hap.Name`
+  * `historyRequest` | `Characteristics.eve.HistoryRequest`
+  * `setTime`        | `Characteristics.eve.SetTime`
+  * `historyStatus`  | `Characteristics.eve.HistoryStatus`
+  * `historyEntries` | `Characteristics.eve.HistoryEntries`
+  * `resetTotal`     | `Characteristics.eve.ResetTotal`
+  *
+  * This delegate is for sensors that don't report life-time consumption. The
+  * history from the value of the associated
+  * `Characteristics.eve.CurrentConsumption` over time. It updates the value of
+  * the associated `Characteristics.eve.TotalConsumption` characteristic.
+  * @extends ServiceDelegate.History
+  * @memberof ServiceDelegate.History
+  */
+class Power extends History {
+  /** Create a new instance of an Eve Energy _History_ service delegate.
+    * @param {!AccessoryDelegate} accessoryDelegate - The delegate of the
+    * corresponding HomeKit accessory.
+    * @param {!object} params - The parameters for the
+    * _History_ HomeKit service.
+    * @param {!CharacteristicDelegate} powerDelegate - A reference to the
+    * delegate of the associated `Characteristics.eve.CurrentConsumption`
+    * characteristic.
+    * @param {!CharacteristicDelegate} consumptionDelegate - A reference to the
+    * delegate of the associated `Characteristics.eve.TotalConsumption`
+    * characteristic.
+    */
+  constructor (
+    accessoryDelegate, params,
+    powerDelegate, consumptionDelegate
+  ) {
+    super(accessoryDelegate, params)
+    if (!(powerDelegate instanceof homebridgeLib.CharacteristicDelegate)) {
+      throw new TypeError('powerDelegate: not a CharacteristicDelegate')
+    }
+    if (!(consumptionDelegate instanceof homebridgeLib.CharacteristicDelegate)) {
+      throw new TypeError('consumptionDelegate: not a CharacteristicDelegate')
+    }
+    this._powerDelegate = powerDelegate
+    this._consumptionDelegate = consumptionDelegate
+    this._entry = { time: 0, power: 0 }
+    this._runningConsumption = 0 // 10-min-interval running value
+    this._totalConsumption = consumptionDelegate.value // life-time value
+    powerDelegate.on('didSet', (value) => {
+      const now = Math.round(new Date().valueOf() / 1000)
+      if (this._time != null) {
+        const delta = this._power * (now - this._time) // Ws
+        this._runningConsumption += Math.round(delta / 600.0) // W * 10 min
+        this._totalConsumption += Math.round(delta / 3600.0) // Wh
+      }
+      this._power = value
+      this._time = now
+    })
+    this.addCharacteristicDelegate({
+      key: 'resetTotal',
+      Characteristic: this.Characteristics.eve.ResetTotal,
+      value: params.resetTotal
+    })
+    this._characteristicDelegates.resetTotal.on('didSet', (value) => {
+      this._runningConsumption = 0
+      this._totalConsumption = 0
+      this._consumptionDelegate.value = this._totalConsumption
+    })
+  }
+
+  _addEntry () {
+    // Sensor delivers currentConsumption, compute totalConsumption
+    const now = Math.round(new Date().valueOf() / 1000)
+    if (this._time != null) {
+      const delta = this._power * (now - this._time) // Ws
+      this._runningConsumption += Math.round(delta / 600.0) // W * 10 min
+      this._totalConsumption += Math.round(delta / 3600.0) // Wh
+      this._consumptionDelegate.value = this._totalConsumption
+      this._entry.power = this._runningConsumption
+      super._addEntry(now)
+    }
+    this._power = this._powerDelegate.value
+    this._time = now
+    this._runningConsumption = 0
+  }
+
+  // get _fingerPrint () { return '04 0102 0202 0702 0f03' }
+  get _fingerPrint () { return '01 0702' }
+
+  _entryStream (entry) {
+    return util.format(
+      // '|14 %s %s 1f 0000 0000 %s 0000 0000',
+      '|0c %s %s 01 %s',
+      numToHex(swap32(this._h.currentEntry), 8),
+      numToHex(swap32(entry.time - this._h.initialTime), 8),
+      numToHex(swap16(entry.power * 10), 4)
+    )
+  }
+}
+
+module.exports = Power