homebridge-lib 5.2.0 → 5.2.1

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

package/lib/ServiceDelegate/History/Room.js

@@ -0,0 +1,115 @@
+// homebridge-lib/lib/ServiceDelegate/History/Room.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 Room _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.CurrentTemperature`,
+  * `Characteristics.hap.CurrentRelativeHumidity`, and
+  * `Characteristics.hap.VOCDensity` characteristics.
+  * @extends ServiceDelegate.History
+  * @memberof ServiceDelegate.History
+  */
+class Room extends ServiceDelegate.History {
+  /** Create a new instance of an Eve Weather _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} temperatureDelegate - A reference to the
+    * delegate of the associated `Characteristics.hap.CurrentTemperature`
+    * characteristic.
+    * @param {?CharacteristicDelegate} humidityDelegate - A reference to the
+    * delegate of the associated `Characteristics.hap.CurrentRelativeHumidity`
+    * characteristic.
+    * @param {?CharacteristicDelegate} vocDensityDelegate - A reference to the
+    * delegate of the associated `Characteristics.eve.AirPressure`
+    * characteristic.
+    */
+  constructor (
+    accessoryDelegate, params,
+    temperatureDelegate, humidityDelegate, vocDensityDelegate
+  ) {
+    super(accessoryDelegate, params)
+    if (!(temperatureDelegate instanceof homebridgeLib.CharacteristicDelegate)) {
+      throw new TypeError('temperatureDelegate: not a CharacteristicDelegate')
+    }
+    if (
+      humidityDelegate != null &&
+      !(humidityDelegate instanceof homebridgeLib.CharacteristicDelegate)
+    ) {
+      throw new TypeError('humidityDelegate: not a CharacteristicDelegate')
+    }
+    if (
+      vocDensityDelegate != null &&
+      !(vocDensityDelegate instanceof homebridgeLib.CharacteristicDelegate)
+    ) {
+      throw new TypeError('vocDensityDelegate: not a CharacteristicDelegate')
+    }
+    this._entry = {
+      time: 0,
+      temp: temperatureDelegate.value,
+      humidity: 0,
+      voc: 0
+    }
+    temperatureDelegate.on('didSet', (value) => {
+      this._entry.temp = value
+    })
+    if (humidityDelegate != null) {
+      this._entry.humidity = humidityDelegate.value
+      humidityDelegate.on('didSet', (value) => {
+        this._entry.humidity = value
+      })
+      if (vocDensityDelegate != null) {
+        this._entry.voc = vocDensityDelegate.value
+        vocDensityDelegate.on('didSet', (value) => {
+          this._entry.voc = value
+        })
+      }
+    }
+  }
+
+  get _fingerPrint () {
+    // return '07 0102 0202 2202 2901 2501 2302 2801'
+    return '03 0102 0202 2202'
+  }
+
+  _entryStream (entry) {
+    return util.format(
+      '|10 %s %s 07 %s %s %s',
+      numToHex(swap32(this._h.currentEntry), 8),
+      numToHex(swap32(entry.time - this._h.initialTime), 8),
+      numToHex(swap16(entry.temp * 100), 4),
+      numToHex(swap16(entry.humidity * 100), 4),
+      numToHex(swap16(entry.voc), 4)
+    )
+  }
+}
+
+module.exports = Room

package/lib/ServiceDelegate/History/Thermo.js

@@ -0,0 +1,102 @@
+// homebridge-lib/lib/ServiceDelegate/History/Thermo.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 Thermo _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.CurrentTemperature`,
+  * `Characteristics.hap.TargetTemperature`, and
+  * `Characteristics.eve.ValvePosition` characteristics.
+  * @extends ServiceDelegate.History
+  * @memberof ServiceDelegate.History
+  */
+class Thermo extends ServiceDelegate.History {
+  /** Create a new instance of an Eve Thermo _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} temperatureDelegate - A reference to the
+    * delegate of the associated `Characteristics.hap.CurrentTemperature`
+    * characteristic.
+    * @param {!CharacteristicDelegate} targetTemperatureDelegate - A reference
+    * to the delegate of the associated `Characteristics.hap.TargetTemperature`
+    * characteristic.
+    * @param {!CharacteristicDelegate} valvePositionDelegate - A reference to
+    * the delegate of the associated `Characteristics.eve.ValvePosition`
+    * characteristic.
+    */
+  constructor (
+    accessoryDelegate, params,
+    temperatureDelegate, targetTemperatureDelegate, valvePositionDelegate
+  ) {
+    super(accessoryDelegate, params)
+    if (!(temperatureDelegate instanceof homebridgeLib.CharacteristicDelegate)) {
+      throw new TypeError('temperatureDelegate: not a CharacteristicDelegate')
+    }
+    if (!(targetTemperatureDelegate instanceof homebridgeLib.CharacteristicDelegate)) {
+      throw new TypeError('targetTemperatureDelegate: not a CharacteristicDelegate')
+    }
+    if (!(valvePositionDelegate instanceof homebridgeLib.CharacteristicDelegate)) {
+      throw new TypeError('valvePositionDelegate: not a CharacteristicDelegate')
+    }
+    this._entry = {
+      time: 0,
+      currentTemp: temperatureDelegate.value,
+      setTemp: targetTemperatureDelegate.value,
+      valvePosition: valvePositionDelegate.value
+    }
+    temperatureDelegate
+      .on('didSet', (value) => { this._entry.currentTemp = value })
+    targetTemperatureDelegate
+      .on('didSet', (value) => { this._entry.setTemp = value })
+    valvePositionDelegate
+      .on('didSet', (value) => { this._entry.valvePosition = value })
+  }
+
+  // I think 1201 and 1d01 are for current mode and target more, but it doesn't
+  // look like Eve displays any history for these.
+  // As of v3.8.1, Eve no longer shows the valve position history.
+  // get _fingerPrint () { return '05 0102 1102 1001 1201 1d01' }
+  get _fingerPrint () { return '03 0102 1102 1001' }
+
+  _entryStream (entry) {
+    return util.format(
+      // '|11 %s %s 1f %s %s %s 00 00',
+      '|0f %s %s 07 %s %s %s',
+      numToHex(swap32(this._h.currentEntry), 8),
+      numToHex(swap32(entry.time - this._h.initialTime), 8),
+      numToHex(swap16(entry.currentTemp * 100), 4),
+      numToHex(swap16(entry.setTemp * 100), 4),
+      numToHex(entry.valvePosition, 2)
+    )
+  }
+}
+
+module.exports = Thermo

package/lib/ServiceDelegate/History/Weather.js

@@ -0,0 +1,114 @@
+// homebridge-lib/lib/ServiceDelegate/History/Weather.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 Weather _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.CurrentTemperature`,
+  * `Characteristics.hap.CurrentRelativeHumidity`, and
+  * `Characteristics.eve.AirPressure` characteristics.
+  * @extends ServiceDelegate.History
+  * @memberof ServiceDelegate.History
+  */
+class Weather extends ServiceDelegate.History {
+  /** Create a new instance of an Eve Weather _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} temperatureDelegate - A reference to the
+    * delegate of the associated `Characteristics.hap.CurrentTemperature`
+    * characteristic.
+    * @param {?CharacteristicDelegate} humidityDelegate - A reference to the
+    * delegate of the associated `Characteristics.hap.CurrentRelativeHumidity`
+    * characteristic.
+    * @param {?CharacteristicDelegate} pressureDelegate - A reference to the
+    * delegate of the associated `Characteristics.eve.AirPressure`
+    * characteristic.
+    */
+  constructor (
+    accessoryDelegate, params,
+    temperatureDelegate, humidityDelegate, pressureDelegate
+  ) {
+    super(accessoryDelegate, params)
+    if (!(temperatureDelegate instanceof homebridgeLib.CharacteristicDelegate)) {
+      throw new TypeError('temperatureDelegate: not a CharacteristicDelegate')
+    }
+    if (
+      humidityDelegate != null &&
+      !(humidityDelegate instanceof homebridgeLib.CharacteristicDelegate)
+    ) {
+      throw new TypeError('humidityDelegate: not a CharacteristicDelegate')
+    }
+    if (
+      pressureDelegate != null &&
+      !(pressureDelegate instanceof homebridgeLib.CharacteristicDelegate)
+    ) {
+      throw new TypeError('pressureDelegate: not a CharacteristicDelegate')
+    }
+    this._entry = {
+      time: 0,
+      temp: temperatureDelegate.value,
+      humidity: 0,
+      pressure: 0
+    }
+    temperatureDelegate.on('didSet', (value) => {
+      this._entry.temp = value
+    })
+    if (humidityDelegate != null) {
+      this._entry.humidity = humidityDelegate.value
+      humidityDelegate.on('didSet', (value) => {
+        this._entry.humidity = value
+      })
+      if (pressureDelegate != null) {
+        this._entry.pressure = pressureDelegate.value
+        pressureDelegate.on('didSet', (value) => {
+          this._entry.pressure = value
+        })
+      }
+    }
+  }
+
+  get _fingerPrint () {
+    return '03 0102 0202 0302'
+  }
+
+  _entryStream (entry) {
+    return util.format(
+      '|10 %s %s 07 %s %s %s',
+      numToHex(swap32(this._h.currentEntry), 8),
+      numToHex(swap32(entry.time - this._h.initialTime), 8),
+      numToHex(swap16(entry.temp * 100), 4),
+      numToHex(swap16(entry.humidity * 100), 4),
+      numToHex(swap16(entry.pressure * 10), 4)
+    )
+  }
+}
+
+module.exports = Weather