homebridge-lib 6.3.8 → 6.3.9

package/lib/ServiceDelegate/History.js

@@ -76,13 +76,14 @@ class HistoryValue {
     * @params {Buffer} buffer - The buffer to write to.
     * @params {integer} offset - The offset within the buffer.
     */
-  writeEntry (entry, buffer, offset) { buffer.writeInt16LE(entry[this.id], offset) }
+  writeEntry (entry, buffer, offset) { buffer.writeUInt16LE(entry[this.id], offset) }
 }
 
 class TemperatureValue extends HistoryValue {
   get tag () { return 0x01 }
   get id () { return 't' }
   prepareEntry (entry) { entry[this.id] = this._delegate.value * 100 }
+  writeEntry (entry, buffer, offset) { buffer.writeInt16LE(entry[this.id], offset) }
 }
 
 class HumidityValue extends HistoryValue {
@@ -106,7 +107,7 @@ class ContactValue extends HistoryValue {
   get tag () { return 0x06 }
   get length () { return 1 }
   get id () { return 'c' }
-  prepareEntry (entry) { entry[this.id] = this._delegate.value ? 1 : 0 }
+  prepareEntry (entry) { entry[this.id] = this._delegate.value }
   writeEntry (entry, buffer, offset) { buffer.writeInt8(entry[this.id], offset) }
 
   constructor (parent, delegate) {
@@ -114,14 +115,10 @@ class ContactValue extends HistoryValue {
     delegate.on('didSet', (value) => {
       const now = History.now()
       const entry = { time: now }
-      entry[this.id] = this._delegate.value ? 1 : 0
+      entry[this.id] = this._delegate.value
       parent.addEntry(entry)
-      if (parent.lastContactDelegate != null) {
-        parent.lastContactDelegate = parent.lastActivationValue(now)
-      }
-      if (parent.timesOpenedDelegate != null) {
-        parent.timesOpenedDelegate.value += value
-      }
+      parent.lastContactDelegate = parent.lastActivationValue(now)
+      parent.timesOpenedDelegate.value += value
     })
     parent.addCharacteristicDelegate({
       key: 'resetTotal',
@@ -132,67 +129,94 @@ class ContactValue extends HistoryValue {
   }
 }
 
+// Eve history entries for _Total Consumption_ actually contain the (average) power,
+// in 0.1 W, since the previous entry.  Eve computes the displayed consumption in Wh.
+
+// Device delivers consumption in kWh.  We compute average power.
 class ConsumptionValue extends HistoryValue {
   get tag () { return 0x07 }
   get id () { return 'p' }
 
   constructor (parent, delegate) {
     super(parent, delegate)
-    this._consumption = delegate.value
-    this._time = History.now()
+    parent.addCharacteristicDelegate({
+      key: 'consumption',
+      unit: ' kWh',
+      value: delegate.value,
+      silent: true
+    })
+    parent.addCharacteristicDelegate({
+      key: 'time',
+      value: History.now(),
+      silent: true
+    })
   }
 
   prepareEntry (entry) {
-    const delta = this._delegate.value - this._consumption // kWh
-    const period = entry.time - this._time // s
-    const power = period === 0 ? 0 : 1000 * 3600 * delta / period // W
+    const consumption = (this._delegate.value - this._parent.values.consumption) * 1000 * 3600 // Ws
+    const period = entry.time - this._parent.values.time // s
+    const power = consumption / period // W
+    entry[this.id] = Math.round(power * 10) // 0.1 W
     if (this._parent.computedPowerDelegate != null) {
-      this._parent.computedPowerDelegate.value = Math.round(power) // W
+      this._parent.computedPowerDelegate.value = Math.round(power * 10) / 10 // W
     }
-    entry[this.id] = Math.round(power * 10) // 0.1 W * 10 min
-    this._consumption = this._delegate.value
-    this._time = entry.time
+    this._parent.values.consumption = this._delegate.value
+    this._parent.values.time = entry.time
   }
 }
 
+// Device delivers power in W.  We compute total consumption and average power.
 class PowerValue extends HistoryValue {
   get tag () { return 0x07 }
   get id () { return 'p' }
 
   constructor (parent, delegate) {
     super(parent, delegate)
-    this._runningConsumption = 0 // 10-min-interval running value
-    this._totalConsumption = parent.computedConsumptionDelegate.value * 100
-    this._power = delegate.value // current power
-    this._time = History.now() // start time of current power
+    this._consumption = 0 // Ws
+    this._period = 0 // s
+    this._totalConsumption = parent.computedConsumptionDelegate.value * 1000 * 3600 // Ws
+    this._power = delegate.value // W
+    this._time = History.now()
     delegate.on('didSet', (value) => {
-      const now = History.now()
-      const delta = this._power * (now - this._time) // Ws
-      this._runningConsumption += Math.round(delta / 60.0) // 0.1W * 10 min
-      this._totalConsumption += delta / 36000.0 // 0.01 kWh
-      this._power = value
-      this._time = now
+      this.updateRunningTotals()
+      this._power = value // W
     })
     parent.addCharacteristicDelegate({
       key: 'resetTotal',
       Characteristic: parent.Characteristics.eve.ResetTotal
     }).on('didSet', (value) => {
-      this._runningConsumption = 0
-      this._totalConsumption = 0
-      parent.computedConsumptionDelegate.value = this._totalConsumption
+      this._totalConsumption = 0 // Ws
+      parent.computedConsumptionDelegate.value = 0 // kWh
     })
   }
 
   prepareEntry (entry) {
-    const delta = this._power * (entry.time - this._time) // Ws
-    this._runningConsumption += delta / 60.0 // 0.1 W * 10 min
-    this._totalConsumption += delta / 36000.0 // 0.01 kWh
-    this._parent.computedConsumptionDelegate.value = Math.round(this._totalConsumption) / 100.0 // kWh
-    entry[this.id] = Math.round(this._runningConsumption) // 0.1 W * 10 min
-    this._power = this._delegate.value
-    this._time = entry.time
-    this._runningConsumption = 0
+    this.updateRunningTotals(entry.time)
+
+    const power = this._period === 0 ? 0 : this._consumption / this._period // W
+    entry[this.id] = Math.round(power * 10) // 0.1 W
+    const totalConsumption = this._totalConsumption / (1000 * 3600) // kWh
+    this._parent.computedConsumptionDelegate.value = Math.round(totalConsumption * 100) / 100 // kWh
+
+    this._consumption = 0
+    this._period = 0
   }
+
+  updateRunningTotals (now = History.now()) {
+    const period = now - this._time // s
+    const delta = this._power * period // Ws
+    this._consumption += delta // Ws
+    this._period += period // s
+    this._totalConsumption += delta // Ws
+    this._time = now
+  }
+}
+
+// Device delivers (running) avarage power in W.
+class AveragePowerValue extends HistoryValue {
+  get tag () { return 0x07 }
+  get id () { return 'p' }
+  prepareEntry (entry) { entry[this.id] = this._delegate.value * 10 }
 }
 
 class SwitchOnValue extends HistoryValue {
@@ -225,6 +249,7 @@ class TargetTemperatureValue extends HistoryValue {
   get tag () { return 0x11 }
   get id () { return 's' }
   prepareEntry (entry) { entry[this.id] = this._delegate.value * 100 }
+  writeEntry (entry, buffer, offset) { buffer.writeInt16LE(entry[this.id], offset) }
 }
 
 class MotionValue extends HistoryValue {
@@ -273,7 +298,6 @@ class VocDensityValue extends HistoryValue {
 class LightLevelValue extends HistoryValue {
   get tag () { return 0x30 }
   get id () { return 'l' }
-  // writeEntry (entry, buffer, offset) { buffer.writeUInt16LE(entry[this.id], offset) }
 }
 
 // Types of delegates for characteristics for history data points.
@@ -284,6 +308,7 @@ const historyValueTypes = {
   airPressure: AirPressureValue,
   contact: ContactValue,
   power: PowerValue,
+  averagePower: AveragePowerValue,
   switchOn: SwitchOnValue,
   consumption: ConsumptionValue,
   valvePosition: ValvePositionValue,
@@ -596,12 +621,14 @@ class History extends ServiceDelegate {
     let bitmap = 0
     let offset = 1
     for (const i in this._valueTypes) {
-      const valueType = this._valueTypes[i]
-      if (entry[valueType.id] != null) {
-        bitmap |= 0x01 << i
-        valueType.writeEntry(entry, buffer, offset)
-        offset += valueType.length
-      }
+      try {
+        const valueType = this._valueTypes[i]
+        if (entry[valueType.id] != null) {
+          bitmap |= 0x01 << i
+          valueType.writeEntry(entry, buffer, offset)
+          offset += valueType.length
+        }
+      } catch (error) { this.warn(error) }
     }
     buffer.writeUInt8(bitmap, 0)
     return buffer.slice(0, offset)

package/package.json

@@ -3,7 +3,7 @@
   "description": "Library for homebridge plugins",
   "author": "Erik Baauw",
   "license": "Apache-2.0",
-  "version": "6.3.8",
+  "version": "6.3.9",
   "keywords": [
     "homekit",
     "homebridge"
@@ -22,11 +22,11 @@
   },
   "engines": {
     "homebridge": "^1.6.0",
-    "node": "^18.14.0"
+    "node": "^18.14.1"
   },
   "dependencies": {
     "@homebridge/plugin-ui-utils": "~0.0.19",
-    "hb-lib-tools": "^1.0.2"
+    "hb-lib-tools": "^1.0.3"
   },
   "scripts": {
     "prepare": "standard && rm -rf out && jsdoc -c jsdoc.json",