homebridge-lib 6.3.3 → 6.3.5

package/lib/AccessoryDelegate.js

@@ -34,6 +34,7 @@ class AccessoryDelegate extends homebridgeLib.Delegate {
     * @param {!string} params.firmware - The accessory firmware revision.
     * @param {?string} params.hardware - The accessory hardware revision.
     * @param {?string} params.software - The accessory software revision.
+    * @param {?integer} params.logLevel - The log level for the accessory
     */
   constructor (platform, params = {}) {
     if (params.name == null) {
@@ -46,6 +47,9 @@ class AccessoryDelegate extends homebridgeLib.Delegate {
     if (params.id === '') {
       throw new RangeError('params.id: invalid id')
     }
+    if (params.logLevel == null) {
+      params.logLevel = platform.logLevel
+    }
 
     // Link or create associated PlatformAccessory.
     this._accessory = this._platform._getAccessory(this, params)
@@ -59,10 +63,13 @@ class AccessoryDelegate extends homebridgeLib.Delegate {
     this.addPropertyDelegate({ key: 'version', silent: true })
     this.values.version = platform.packageJson.version
     this.addPropertyDelegate({ key: 'id', value: params.id, silent: true })
-    this.addPropertyDelegate({ key: 'logLevel', value: platform.logLevel })
+    this.addPropertyDelegate({ key: 'logLevel', value: params.logLevel })
     this.addPropertyDelegate({ key: 'name', value: this.name, silent: true })
       .on('didSet', (name) => { this.name = name })
-    this.addPropertyDelegate({ key: 'uiPort', silent: true })
+    if (platform._ui != null) {
+      this._context.uiPort = platform._ui.port
+      this.addPropertyDelegate({ key: 'uiPort', silent: true })
+    }
 
     // Create delegate for AccessoryInformation service.
     this._serviceDelegates = {}
@@ -109,9 +116,22 @@ class AccessoryDelegate extends homebridgeLib.Delegate {
     })
   }
 
-  // Remove associated accessory from platform
-  destroy () {
+  /** Destroy accessory delegate and associated HomeKit accessory.
+    * @params {boolean} [delegateOnly=false] - Destroy the delegate, but keep the
+    * associated HomeKit accessory (including context).
+    */
+  destroy (delegateOnly = false) {
     this.removeAllListeners()
+    for (const key in this._serviceDelegates) {
+      this._serviceDelegates[key].destroy(delegateOnly)
+    }
+    for (const key in this._propertyDelegates) {
+      this._propertyDelegates[key]._destroy(delegateOnly)
+    }
+    if (delegateOnly) {
+      this._accessory.removeAllListeners()
+      return
+    }
     this._platform._removeAccessory(this._accessory)
   }
 
@@ -122,10 +142,13 @@ class AccessoryDelegate extends homebridgeLib.Delegate {
     return serviceDelegate
   }
 
-  _unlinkServiceDelegate (serviceDelegate) {
+  _unlinkServiceDelegate (serviceDelegate, delegateOnly) {
     const key = serviceDelegate._key
     // this.debug('unlink service %s', key)
     delete this._serviceDelegates[key]
+    if (delegateOnly) {
+      return
+    }
     delete this._context[key]
   }
 

package/lib/CharacteristicDelegate.js

@@ -136,6 +136,7 @@ class CharacteristicDelegate extends homebridgeLib.Delegate {
       // Install getter and setter when needed.
       if (params.getter != null && typeof params.getter === 'function') {
         this._getter = params.getter
+        this._onGetCount = 0
         this._characteristic.on('get', this._onGet.bind(this))
       }
       if (this._canWrite && Characteristic !== this.Characteristics.hap.Identify) {
@@ -167,13 +168,21 @@ class CharacteristicDelegate extends homebridgeLib.Delegate {
     }
   }
 
-  /** Destroy the HomeKit characteristic delegate.
-    *
-    * Removes the associated HomeKit characteristic.
+  /** Destroy characteristic delegate and delete associated HomeKit characteristic.
+    * @params {boolean} [delegateOnly=false] - Destroy the delegate, but keep the
+    * associated HomeKit characteristic (including context).
     */
-  _destroy () {
+  _destroy (delegateOnly = false) {
     this.debug('destroy %s', this._key)
     this.removeAllListeners()
+    if (delegateOnly) {
+      if (this._characteristic != null) {
+        // this._characteristic.removeAllListeners() // Doesn't work ?!
+        this._characteristic.removeAllListeners('get')
+        this._characteristic.removeAllListeners('set')
+      }
+      return
+    }
     if (this._characteristic != null) {
       this._service.removeCharacteristic(this._characteristic)
     }
@@ -338,7 +347,6 @@ class CharacteristicDelegate extends homebridgeLib.Delegate {
     let value = this.value
     const timeout = setTimeout(() => {
       timedOut = true
-      this.warn('get: timed out - return previous value %j%s', this.value, this._unit)
       callback(null, this.value)
     }, this._timeout)
     try {

package/lib/PropertyDelegate.js

@@ -60,10 +60,15 @@ class PropertyDelegate extends homebridgeLib.Delegate {
   }
 
   /** Destroy the propery delegate.
+    * @params {boolean} [delegateOnly=false] - Destroy the delegate, but keep the
+    * associated value in context.
     */
-  _destroy () {
+  _destroy (delegateOnly = false) {
     this.vdebug('destroy')
     this.removeAllListeners()
+    if (delegateOnly) {
+      return
+    }
     delete this._parent._context[this.key]
   }
 

package/lib/ServiceDelegate/History.js

@@ -102,6 +102,11 @@ class AirPressureValue extends HistoryValue {
   prepareEntry (entry) { entry[this.id] = this._delegate.value * 10 }
 }
 
+class VocLevelValue extends HistoryValue {
+  get tag () { return 0x04 }
+  get id () { return 'r' }
+}
+
 class ContactValue extends HistoryValue {
   get tag () { return 0x06 }
   get length () { return 1 }
@@ -145,7 +150,7 @@ class ConsumptionValue extends HistoryValue {
   prepareEntry (entry) {
     const delta = this._delegate.value - this._consumption // kWh
     const period = entry.time - this._time // s
-    const power = 1000 * 3600 * delta / period // W
+    const power = period === 0 ? 0 : 1000 * 3600 * delta / period // W
     if (this._parent.computedPowerDelegate != null) {
       this._parent.computedPowerDelegate.value = Math.round(power) // W
     }
@@ -195,6 +200,25 @@ class PowerValue extends HistoryValue {
   }
 }
 
+class SwitchOnValue extends HistoryValue {
+  get tag () { return 0x0E }
+  get length () { return 1 }
+  get id () { return 'w' }
+  prepareEntry (entry) { entry[this.id] = this._delegate.value ? 1 : 0 }
+  writeEntry (entry, buffer, offset) { buffer.writeInt8(entry[this.id], offset) }
+
+  constructor (parent, delegate) {
+    super(parent, delegate)
+    delegate.on('didSet', (value) => {
+      const now = History.now()
+      const entry = { time: now }
+      entry[this.id] = this._delegate.value ? 1 : 0
+      this._parent.addEntry(entry)
+      parent.lastSwitchOnDelegate.value = parent.lastActivationValue(now)
+    })
+  }
+}
+
 class ValvePositionValue extends HistoryValue {
   get tag () { return 0x10 }
   get length () { return 1 }
@@ -261,9 +285,11 @@ class LightLevelValue extends HistoryValue {
 const historyValueTypes = {
   temperature: TemperatureValue,
   humidity: HumidityValue,
+  vocLevel: VocLevelValue,
   airPressure: AirPressureValue,
   contact: ContactValue,
   power: PowerValue,
+  switchOn: SwitchOnValue,
   consumption: ConsumptionValue,
   valvePosition: ValvePositionValue,
   targetTemperature: TargetTemperatureValue,
@@ -280,6 +306,7 @@ const historyDerivedTypes = {
   lastMotion: 'motion',
   lastOn: 'on',
   lastLightOn: 'lightOn',
+  lastSwitchOn: 'switchOn',
   computedConsumption: 'power',
   computedPower: 'consumption'
 }
@@ -347,12 +374,6 @@ class History extends ServiceDelegate {
     * @param {?CharacteristicDelegate} params.lastOnDelegate - The
     * `.eve.LastActivation` characteristic delegate
     * for a `hap.Outlet` service.
-    * @param {?CharacteristicDelegate} params.lightOnDelegate - The
-    * `Characteristics.hap.On` characteristic delegate
-    * for a `hap.Lightbulb` service.
-    * @param {?CharacteristicDelegate} params.lastLightOnDelegate - A
-    * `.eve.LastActivation` characteristic delegate
-    * for a `hap.Lightbulb` service.
     * @param {?CharacteristicDelegate} params.powerDelegate - The
     * `.eve.CurrentConsumption` characteristic delegate
     * for a `hap.Outlet` or `eve.Consumption` service
@@ -369,6 +390,18 @@ class History extends ServiceDelegate {
     * `.eve.CurrentConsumption` characteristic delegate
     * for a `hap.Outlet` or `eve.Consumption` service
     * for a device that reports total consumption but not current consumption.
+    * @param {?CharacteristicDelegate} params.lightOnDelegate - The
+    * `Characteristics.hap.On` characteristic delegate
+    * for a `hap.Lightbulb` service.
+    * @param {?CharacteristicDelegate} params.lastLightOnDelegate - A
+    * `.eve.LastActivation` characteristic delegate
+    * for a `hap.Lightbulb` service.
+    * @param {?CharacteristicDelegate} params.switchOnDelegate - The
+    * `Characteristics.hap.On` characteristic delegate
+    * for a `hap.Switch` service.
+    * @param {?CharacteristicDelegate} params.lastSwitchOnDelegate - A
+    * `.eve.LastActivation` characteristic delegate
+    * for a `hap.Switch` service.
     * @param {integer} [params.memorySize=4032] - The memory size, in number of
     * history entries.  The default is 4 weeks of 1 entry per 10 minutes.
     * @param {?boolean} params.config - Expose config.
@@ -383,20 +416,25 @@ class History extends ServiceDelegate {
     let i = 0
     for (const param of Object.keys(params)) {
       if (param.endsWith('Delegate')) {
+        if (params[param] == null) {
+          continue
+        }
         if (!(params[param] instanceof CharacteristicDelegate)) {
           throw new TypeError(`params.${param}: not a CharacteristicDelegate`)
         }
         const key = param.slice(0, -8)
         if (historyDerivedTypes[key] != null) {
           if (params[historyDerivedTypes[key] + 'Delegate'] == null) {
-            throw new SyntaxError(`params.${param}: missing params.${key}Delegate`)
+            throw new SyntaxError(
+              `params.${param}: missing params.${historyDerivedTypes[key]}Delegate`
+            )
           }
           this[param] = params[param]
           continue
         }
         if (key === 'lightOn') {
           if (!(params.lastLightOnDelegate instanceof CharacteristicDelegate)) {
-            throw new SyntaxError(`params.${param}: missing params.${key}Delegate`)
+            throw new SyntaxError(`params.${param}: missing params.lastLightOnDelegate`)
           }
           params[param].on('didSet', (value) => {
             const now = History.now()

package/lib/ServiceDelegate/index.js

@@ -169,17 +169,20 @@ class ServiceDelegate extends homebridgeLib.Delegate {
     })
   }
 
-  /** Destroy the HomeKit service delegate.
-    *
-    * Destroys the associated HomeKit characteristic delegates.
-    * Removes the associated HomeKit service.
+  /** Destroy service delegate and associated HomeKit service.
+    * @params {boolean} [delegateOnly=false] - Destroy the delegate, but keep the
+    * associated HomeKit service (including context).
     */
-  destroy () {
+  destroy (delegateOnly = false) {
     this.debug('destroy %s (%s)', this._key, this.constructor.name)
-    this._accessoryDelegate._unlinkServiceDelegate(this)
+    this._accessoryDelegate._unlinkServiceDelegate(this, delegateOnly)
     this.removeAllListeners()
     for (const key in this._characteristicDelegates) {
-      this._characteristicDelegates[key]._destroy()
+      this._characteristicDelegates[key]._destroy(delegateOnly)
+    }
+    if (delegateOnly) {
+      this._service.removeAllListeners()
+      return
     }
     this._accessory.removeService(this._service)
     delete this._accessory.context[this._key]

package/package.json

@@ -3,7 +3,7 @@
   "description": "Library for homebridge plugins",
   "author": "Erik Baauw",
   "license": "Apache-2.0",
-  "version": "6.3.3",
+  "version": "6.3.5",
   "keywords": [
     "homekit",
     "homebridge"
@@ -22,7 +22,7 @@
   },
   "engines": {
     "homebridge": "^1.6.0",
-    "node": "^18.13.0"
+    "node": "^18.14.0"
   },
   "dependencies": {
     "@homebridge/plugin-ui-utils": "~0.0.19",