homebridge-lib 5.6.7 → 5.7.0

package/index.js

@@ -291,6 +291,11 @@ class homebridgeLib {
   static toHexString (i, length = 4) {
     return (zeroes + i.toString(16)).slice(-length).toUpperCase()
   }
+
+  /** Return the `semver` library, so plugins don't have to list this as a
+    * separate dependency.
+    */
+  static get semver () { return require('semver') }
 }
 
 module.exports = homebridgeLib

package/lib/AccessoryDelegate.js

@@ -204,7 +204,7 @@ class AccessoryDelegate extends homebridgeLib.Delegate {
 
   /** Returns the property delegate correspondig to the property key.
     * @param {!string} key - The key for the property.
-    * returns {PropertyDelegate}
+    * @returns {PropertyDelegate}
     */
   propertyDelegate (key) {
     return this._propertyDelegates[key]

package/lib/MyHomeKitTypes.js

@@ -700,7 +700,7 @@ class MyHomeKitTypes extends homebridgeLib.CustomHomeKitTypes {
       format: this.Formats.UINT8,
       unit: this.Units.PERCENTAGE,
       minValue: 0,
-      maxValue: 95,
+      maxValue: 100,
       minStep: 5,
       perms: [this.Perms.READ, this.Perms.NOTIFY, this.Perms.WRITE]
     }, 'Low Battery Threshold')

package/lib/Platform.js

@@ -10,7 +10,7 @@ const homebridgeLib = require('../index')
 const events = require('events')
 const fs = require('fs')
 const http = require('http')
-const semver = require('semver')
+const { semver } = homebridgeLib
 const util = require('util')
 const zlib = require('zlib')
 

package/lib/ServiceDelegate/History/Consumption.js

@@ -53,9 +53,11 @@ class Consumption extends History {
     * @param {?CharacteristicDelegate} powerDelegate - A reference to the
     * delegate of the associated `Characteristics.eve.CurrentConsumption`
     * characteristic.
+    * @param {!CharacteristicDelegate} onDelegate - A reference to the
+    * delegate of the associated `Characteristics.hap.On` characteristic.
     */
   constructor (
-    accessoryDelegate, params, consumptionDelegate, powerDelegate
+    accessoryDelegate, params, consumptionDelegate, powerDelegate, onDelegate
   ) {
     super(accessoryDelegate, params)
     if (!(consumptionDelegate instanceof homebridgeLib.CharacteristicDelegate)) {
@@ -67,25 +69,33 @@ class Consumption extends History {
     ) {
       throw new TypeError('powerDelegate: not a CharacteristicDelegate')
     }
-    this.addCharacteristicDelegate({
-      key: 'consumption',
-      silent: true
-    })
-    this.addCharacteristicDelegate({
-      key: 'time',
-      silent: true
-    })
+    if (
+      onDelegate != null &&
+      !(onDelegate instanceof homebridgeLib.CharacteristicDelegate)
+    ) {
+      throw new TypeError('temperatureDelegate: not a CharacteristicDelegate')
+    }
     this._consumptionDelegate = consumptionDelegate
     this._powerDelegate = powerDelegate
     this._entry = { time: 0, power: 0 }
+    if (onDelegate != null) {
+      this._entry.on = onDelegate.value ? 1 : 0
+      onDelegate.on('didSet', (value) => {
+        this._entry.on = value ? 1 : 0
+        const power = this._entry.power
+        this._entry.power = null
+        super._addEntry()
+        this._entry.power = power
+      })
+    }
   }
 
   _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
+    if (this._consumption != null && this._time != null) {
+      const delta = this._consumptionDelegate.value - this._consumption // kWh
+      const period = now - this._time // s
       const power = Math.round(1000 * 3600 * delta / period) // W
       if (this._powerDelegate != null) {
         this._powerDelegate.value = power
@@ -93,20 +103,35 @@ class Consumption extends History {
       this._entry.power = power
       super._addEntry(now)
     }
-    this.values.consumption = this._consumptionDelegate.value
-    this.values.time = now
+    this._consumption = this._consumptionDelegate.value
+    this._time = now
   }
 
-  // get _fingerPrint () { return '04 0102 0202 0702 0f03' }
-  get _fingerPrint () { return '01 0702' }
+  get _fingerPrint () { return '02 0702 0E01' }
 
   _entryStream (entry) {
+    if (entry.on == null) {
+      return util.format(
+        '|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)
+      )
+    }
+    if (entry.power == null) {
+      return util.format(
+        '|0b %s %s 02 %s',
+        numToHex(swap32(this._h.currentEntry), 8),
+        numToHex(swap32(entry.time - this._h.initialTime), 8),
+        numToHex(entry.on, 2)
+      )
+    }
     return util.format(
-      // '|14 %s %s 1f 0000 0000 %s 0000 0000',
-      '|0c %s %s 01 %s',
+      '|0d %s %s 03 %s %s',
       numToHex(swap32(this._h.currentEntry), 8),
       numToHex(swap32(entry.time - this._h.initialTime), 8),
-      numToHex(swap16(entry.power * 10), 4)
+      numToHex(swap16(entry.power * 10), 4),
+      numToHex(entry.on, 2)
     )
   }
 }

package/lib/ServiceDelegate/History/Motion.js

@@ -113,7 +113,7 @@ class Motion extends History {
   }
 
   get _fingerPrint () {
-    return '03 1c01 3002 0102'
+    return '03 1C01 3002 0102'
   }
 
   _entryStream (entry) {

package/lib/ServiceDelegate/History/On.js

@@ -71,7 +71,7 @@ class On extends History {
     }
   }
 
-  get _fingerPrint () { return '01 0e01' }
+  get _fingerPrint () { return '01 0E01' }
 
   _entryStream (entry) {
     return util.format(

package/lib/ServiceDelegate/History/Power.js

@@ -49,10 +49,11 @@ class Power extends History {
     * @param {!CharacteristicDelegate} consumptionDelegate - A reference to the
     * delegate of the associated `Characteristics.eve.TotalConsumption`
     * characteristic.
+    * @param {!CharacteristicDelegate} onDelegate - A reference to the
+    * delegate of the associated `Characteristics.hap.On` characteristic.
     */
   constructor (
-    accessoryDelegate, params,
-    powerDelegate, consumptionDelegate
+    accessoryDelegate, params, powerDelegate, consumptionDelegate, onDelegate
   ) {
     super(accessoryDelegate, params)
     if (!(powerDelegate instanceof homebridgeLib.CharacteristicDelegate)) {
@@ -61,6 +62,12 @@ class Power extends History {
     if (!(consumptionDelegate instanceof homebridgeLib.CharacteristicDelegate)) {
       throw new TypeError('consumptionDelegate: not a CharacteristicDelegate')
     }
+    if (
+      onDelegate != null &&
+      !(onDelegate instanceof homebridgeLib.CharacteristicDelegate)
+    ) {
+      throw new TypeError('temperatureDelegate: not a CharacteristicDelegate')
+    }
     this._powerDelegate = powerDelegate
     this._consumptionDelegate = consumptionDelegate
     this._entry = { time: 0, power: 0 }
@@ -71,7 +78,7 @@ class Power extends History {
       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._totalConsumption += Math.round(delta / 3600000.0) // kWh
       }
       this._power = value
       this._time = now
@@ -86,6 +93,16 @@ class Power extends History {
       this._totalConsumption = 0
       this._consumptionDelegate.value = this._totalConsumption
     })
+    if (onDelegate != null) {
+      this._entry.on = onDelegate.value ? 1 : 0
+      onDelegate.on('didSet', (value) => {
+        this._entry.on = value ? 1 : 0
+        const power = this._entry.power
+        this._entry.power = null
+        super._addEntry()
+        this._entry.power = power
+      })
+    }
   }
 
   _addEntry () {
@@ -98,22 +115,39 @@ class Power extends History {
       this._consumptionDelegate.value = this._totalConsumption
       this._entry.power = this._runningConsumption
       super._addEntry(now)
+    } else if (this._entry.on != null) {
+      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' }
+  get _fingerPrint () { return '02 0702 0E01' }
 
   _entryStream (entry) {
+    if (entry.on == null) {
+      return util.format(
+        '|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)
+      )
+    }
+    if (entry.power == null) {
+      return util.format(
+        '|0b %s %s 02 %s',
+        numToHex(swap32(this._h.currentEntry), 8),
+        numToHex(swap32(entry.time - this._h.initialTime), 8),
+        numToHex(entry.on, 2)
+      )
+    }
     return util.format(
-      // '|14 %s %s 1f 0000 0000 %s 0000 0000',
-      '|0c %s %s 01 %s',
+      '|0d %s %s 03 %s %s',
       numToHex(swap32(this._h.currentEntry), 8),
       numToHex(swap32(entry.time - this._h.initialTime), 8),
-      numToHex(swap16(entry.power * 10), 4)
+      numToHex(swap16(entry.power * 10), 4),
+      numToHex(entry.on, 2)
     )
   }
 }

package/lib/SystemInfo.js

@@ -98,7 +98,8 @@ const macOsInfo = {
     10.14: 'Mojave',
     10.15: 'Catalina',
     11: 'Big Sur',
-    12: 'Monterey'
+    12: 'Monterey',
+    13: 'Ventura'
   }
 }
 
@@ -340,20 +341,20 @@ class SystemInfo extends events.EventEmitter {
     const text = await this.exec('sw_vers')
     const lines = text.split('\n')
     for (const line of lines) {
-      const fields = line.split(':\t')
+      const fields = line.split(':')
       if (fields.length === 2) {
         switch (fields[0]) {
           case 'ProductName': // e.g. 'macOS' or 'Mac OS X'
-            name = fields[1]
+            name = fields[1].trim()
             break
           case 'ProductVersion': // e.g. '12.0.1' or '12.1'
-            version = fields[1]
+            version = fields[1].trim()
             if (version.split('.').length === 2) {
               version += '.0'
             }
             break
           case 'BuildVersion': // e.g. '21A559'
-            build = fields[1]
+            build = fields[1].trim()
             break
           default:
             break

package/lib/UiServer.js

@@ -10,7 +10,7 @@ const {
 } = require('@homebridge/plugin-ui-utils')
 const { HttpClient, formatError } = require('../index')
 const chalk = require('chalk')
-const fs = require('fs/promises')
+const fs = require('fs').promises
 const path = require('path')
 const util = require('util')
 

package/package.json

@@ -3,7 +3,7 @@
   "description": "Library for homebridge plugins",
   "author": "Erik Baauw",
   "license": "Apache-2.0",
-  "version": "5.6.7",
+  "version": "5.7.0",
   "keywords": [
     "homekit",
     "homebridge"
@@ -21,14 +21,14 @@
     "upnp": "cli/upnp.js"
   },
   "engines": {
-    "homebridge": "^1.5.0",
-    "node": "^16.17.0"
+    "homebridge": "^1.5.1",
+    "node": "^18.12.0"
   },
   "dependencies": {
     "@homebridge/plugin-ui-utils": "~0.0.19",
-    "bonjour-hap": "^3.6.3",
+    "bonjour-hap": "^3.6.4",
     "chalk": "^4.1.2",
-    "semver": "^7.3.7"
+    "semver": "^7.3.8"
   },
   "scripts": {
     "prepare": "standard && mocha && rm -rf out && jsdoc -c jsdoc.json",