homebridge-lib 6.5.0 → 6.6.0

package/lib/MyHomeKitTypes.js

@@ -101,6 +101,8 @@ class MyHomeKitTypes extends CustomHomeKitTypes {
       * <br>Used by: homebridge-deconz, homebridge-hue2.
       * @property {Class} FireplaceEffect - Enabled/disable fireplace dynamic effect.
       * <br>Used by: homebridge-deconz, homebridge-hue2.
+      * @property {Class} GlistenEffect - Enabled/disable glisten dynamic effect.
+      * <br>Used by: homebridge-deconz, homebridge-hue2.
       * @property {Class} Heartrate - Refresh rate.
       * <br>Used by: homebridge-hue in HueBridge service,
       * by Homebridge-soma, by Homebridge-rpi, by Homebridge-ws.
@@ -122,6 +124,7 @@ class MyHomeKitTypes extends CustomHomeKitTypes {
       * <br>Previously used by homebridge-hue for Thermostat sensor.
       * @property {Class} LogLevel - Level of logging.
       * @property {Class} LoopEffect - Enabled/disable loop dynamic effect.
+      * <br>Deprecated - use `PrismEffect`.
       * <br>Used by: homebridge-deconz, homebridge-hue2.
       * @property {Class} Loudness - Audio loudness.
       * <br>Used by: homebridge-zp in Speaker service.
@@ -138,10 +141,14 @@ class MyHomeKitTypes extends CustomHomeKitTypes {
       * <br>Used by: homebridge-zp in Speaker service.
       * @property {Class} Offset - Temperature offset.
       * <br>Used by: homebridge-hue in Temperature service.
+      * @property {Class} OpalEffect - Enabled/disable opal dynamic effect.
+      * <br>Used by: homebridge-deconz, homebridge-hue2.
       * @property {Class} PartyEffect - Enabled/disable party dynamic effect.
       * <br>Used by: homebridge-deconz.
       * @property {Class} Period - Daylight period (e.g. Dawn).
       * <br>Used by: homebridge-hue for Daylight sensor.
+      * @property {Class} PrismEffect - Enabled/disable prism dynamic effect.
+      * <br>Used by: homebridge-deconz, homebridge-hue2.
       * @property {Class} PumpHours - Pump run time (in hours).
       * <br>Used by: homebridge-otgw.
       * @property {Class} PumpStarts - Number of pump starts.
@@ -807,7 +814,12 @@ class MyHomeKitTypes extends CustomHomeKitTypes {
     this.createCharacteristicClass('LoopEffect', uuid('081'), {
       format: this.Formats.BOOL,
       perms: [this.Perms.PAIRED_READ, this.Perms.NOTIFY, this.Perms.PAIRED_WRITE]
-    }, 'Loop')
+    }, 'Prism')
+
+    this.createCharacteristicClass('PrismEffect', uuid('081'), {
+      format: this.Formats.BOOL,
+      perms: [this.Perms.PAIRED_READ, this.Perms.NOTIFY, this.Perms.PAIRED_WRITE]
+    }, 'Prism')
 
     this.createCharacteristicClass('SunriseEffect', uuid('082'), {
       format: this.Formats.BOOL,
@@ -851,6 +863,18 @@ class MyHomeKitTypes extends CustomHomeKitTypes {
       perms: [this.Perms.PAIRED_READ, this.Perms.NOTIFY, this.Perms.PAIRED_WRITE]
     }, 'Night Light')
 
+    // More dynamic effects for Hue lights.
+
+    this.createCharacteristicClass('OpalEffect', uuid('08A'), {
+      format: this.Formats.BOOL,
+      perms: [this.Perms.PAIRED_READ, this.Perms.NOTIFY, this.Perms.PAIRED_WRITE]
+    }, 'Opal')
+
+    this.createCharacteristicClass('GlistenEffect', uuid('08B'), {
+      format: this.Formats.BOOL,
+      perms: [this.Perms.PAIRED_READ, this.Perms.NOTIFY, this.Perms.PAIRED_WRITE]
+    }, 'Glisten')
+
     // Characteristic for Unique ID, used by homebridge-hue.
     // Source: as exposed by the Philips Hue bridge.  This characteristic is
     // used by the Hue app to select the accessories when syncing Hue bridge

package/lib/ServiceDelegate/History.js

@@ -223,10 +223,10 @@ class AverageConsumptionValue extends HistoryValue {
   prepareEntry (entry) { entry[this.id] = this._delegate.value * 10 }
 }
 
-class SwitchOnValue extends HistoryValue {
+class OnValue extends HistoryValue {
   get tag () { return 0x0E }
   get length () { return 1 }
-  get id () { return 'w' }
+  get id () { return 'o' }
   prepareEntry (entry) { entry[this.id] = this._delegate.value ? 1 : 0 }
   writeEntry (entry, buffer, offset) { buffer.writeInt8(entry[this.id], offset) }
 
@@ -237,7 +237,7 @@ class SwitchOnValue extends HistoryValue {
       const entry = { time: now }
       entry[this.id] = this._delegate.value ? 1 : 0
       parent.addEntry(entry)
-      parent.lastSwitchOnDelegate.value = parent.lastActivationValue(now)
+      parent.lastOnDelegate.value = parent.lastActivationValue(now)
     })
   }
 }
@@ -275,25 +275,6 @@ class MotionValue extends HistoryValue {
   }
 }
 
-class OnValue extends HistoryValue {
-  get tag () { return 0x1E }
-  get length () { return 1 }
-  get id () { return 'o' }
-  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
-      parent.addEntry(entry)
-      parent.lastOnDelegate.value = parent.lastActivationValue(now)
-    })
-  }
-}
-
 class VocDensityValue extends HistoryValue {
   get tag () { return 0x22 }
   get id () { return 'q' }
@@ -309,6 +290,7 @@ class ButtonValue extends HistoryValue {
 class LightLevelValue extends HistoryValue {
   get tag () { return 0x30 }
   get id () { return 'l' }
+  prepareEntry (entry) { entry[this.id] = Math.max(1, this._delegate.value) }
 }
 
 // Types of delegates for characteristics for history data points.
@@ -321,11 +303,10 @@ const historyValueTypes = {
   totalConsumption: TotalConsumptionValue,
   consumption: ConsumptionValue,
   averageConsumption: AverageConsumptionValue,
-  switchOn: SwitchOnValue,
+  on: OnValue,
   valvePosition: ValvePositionValue,
   targetTemperature: TargetTemperatureValue,
   motion: MotionValue,
-  on: OnValue,
   vocDensity: VocDensityValue,
   button: ButtonValue,
   lightLevel: LightLevelValue
@@ -338,7 +319,6 @@ const historyDerivedTypes = {
   lastMotion: 'motion',
   lastOn: 'on',
   lastLightOn: 'lightOn',
-  lastSwitchOn: 'switchOn',
   computedConsumption: 'totalConsumption',
   computedTotalConsumption: 'consumption'
 }
@@ -365,79 +345,73 @@ class History extends ServiceDelegate {
     * corresponding HomeKit accessory.
     * @param {!object} params - The parameters for the _History_ HomeKit service.
     * @param {?CharacteristicDelegate} params.contactDelegate - The
-    * `hap.ContactSensorState` characteristic delegate
+    * `Characteristics.hap.ContactSensorState` characteristic delegate
     * for a `hap.ContactSensor` service.
     * @param {?CharacteristicDelegate} params.lastContactDelegate - The
-    * `eve.LastActivation` characteristic delegate
+    * `Characteristics.eve.LastActivation` characteristic delegate
     * for a `hap.ContactSensor` service.
     * @param {?CharacteristicDelegate} params.timesOpenedDelegate - The
-    * `eve.TimesOpened` characteristic delegate
+    * `Characteristics.eve.TimesOpened` characteristic delegate
     * for a `hap.ContactSensor` service.
     * @param {?CharacteristicDelegate} params.motionDelegate - The
-    * `.hap.MotionDetected` characteristic delegate
+    * `Characteristics.hap.MotionDetected` characteristic delegate
     * for a `hap.MotionSensor` service.
     * @param {?CharacteristicDelegate} params.lastMotionDelegate - The
-    * `.eve.LastActivation` characteristic delegate
+    * `Characteristics.eve.LastActivation` characteristic delegate
     * for a `hap.MotionSensor` service.
     * @param {?CharacteristicDelegate} params.lightLevelDelegate - The
-    * `.hap.CurrentAmbientLightLevel` characteristic delegate
+    * `Characteristics.hap.CurrentAmbientLightLevel` characteristic delegate
     * for a `hap.LightLevelSensor` service.
     * @param {?CharacteristicDelegate} params.temperatureDelegate - The
-    * `.hap.CurrentTemperature` characteristic delegate
+    * `Characteristics.hap.CurrentTemperature` characteristic delegate
     * for a `hap.TemperatureSensor`, `eve.Weather`, or `hap.Thermostat` service.
     * @param {?CharacteristicDelegate} params.humidityDelegate - The
-    * `hap.CurrentRelativeHumidity` characteristic delegate
+    * `Characteristics.hap.CurrentRelativeHumidity` characteristic delegate
     * for a `hap.HumiditySensor` or `eve.Weather` service.
     * @param {?CharacteristicDelegate} params.airPressureDelegate - The
-    * `.eve.AirPressure` characteristic delegate
+    * `Characteristics.eve.AirPressure` characteristic delegate
     * for an `eve.AirPressureSensor` or `eve.Weather` service.
     * @param {?CharacteristicDelegate} params.vocDensityDelegate - The
-    * `hap.VOCDensity` characteristic delegate
+    * `Characteristics.hap.VOCDensity` characteristic delegate
     * for a `hap.AirQualilitySensor` service.
     * @param {?CharacteristicDelegate} params.targetTemperatureDelegate - The
-    * `hap.TargetTemperature` characteristic delegate
+    * `Characteristics.hap.TargetTemperature` characteristic delegate
     * for a `hap.Thermostat` service.
     * @param {?CharacteristicDelegate} params.valvePositionDelegate - The
-    * `.eve.ValvePosition` characteristic delegate
+    * `Characteristics.eve.ValvePosition` characteristic delegate
     * for a `hap.Thermostat` service.
     * @param {?CharacteristicDelegate} params.onDelegate - The
     * `Characteristics.hap.On` characteristic delegate
-    * for a `hap.Outlet` service.
+    * for a `hap.Outlet` or a `hap.Switch` service.
     * @param {?CharacteristicDelegate} params.lastOnDelegate - The
-    * `.eve.LastActivation` characteristic delegate
-    * for a `hap.Outlet` service.
+    * `Characteristics.eve.LastActivation` characteristic delegate
+    * for a `hap.Outlet` or a `hap.Switch` service.
     * @param {?CharacteristicDelegate} params.consumptionDelegate - The
-    * `.eve.Consumption` characteristic delegate
+    * `Characteristics.eve.Consumption` characteristic delegate
     * for a `hap.Outlet` or `eve.Consumption` service
     * for a device that reports power.
     * @param {?CharacteristicDelegate} params.computedTotalConsumptionDelegate - The
-    * `eve.TotalConsumption` characteristic delegate
+    * `Characteristics.eve.TotalConsumption` characteristic delegate
     * for a `hap.Outlet` or `eve.Consumption` service
     * for a device that reports power, but not total consumption.
     * @param {?CharacteristicDelegate} params.totalConsumptionDelegate - The
-    * `.eve.TotalConsumption` characteristic delegate
+    * `Characteristics.eve.TotalConsumption` characteristic delegate
     * for a `hap.Outlet` or `eve.Consumption` service
     * for a device that reports total consumption.
     * @param {?CharacteristicDelegate} params.computedConsumptionDelegate - The
-    * `.eve.Consumption` characteristic delegate
+    * `Characteristics.eve.Consumption` characteristic delegate
     * for a `hap.Outlet` or `eve.Consumption` service
     * for a device that reports total consumption but not power.
     * @param {?CharacteristicDelegate} params.avarageConsumptionDelegate - The
-    * `.eve.Consumption` characteristic delegate
+    * `Characteristics.eve.Consumption` characteristic delegate
     * for a `hap.Outlet` or `eve.Consumption` service
     * for a device that reports runing average for power.
     * @param {?CharacteristicDelegate} params.lightOnDelegate - The
     * `Characteristics.hap.On` characteristic delegate
     * for a `hap.Lightbulb` service.
     * @param {?CharacteristicDelegate} params.lastLightOnDelegate - A
-    * `.eve.LastActivation` characteristic delegate
+    * `Characteristics.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.
@@ -510,6 +484,10 @@ class History extends ServiceDelegate {
       key: 'history',
       silent: true
     })
+    if (this.values.history?.initialTime > History.now()) {
+      this.warn('resetting history after time travel from %s', dateToString(this.values.history.initialTime))
+      this.values.history = null
+    }
     this._h = this.values.history
     if (this._h == null) {
       this.values.history = {
@@ -616,6 +594,18 @@ class History extends ServiceDelegate {
       })
   }
 
+  addLastOnDelegate (onDelegate, lastOnDelegate) {
+    if (!(onDelegate instanceof CharacteristicDelegate)) {
+      throw new TypeError('onDelegate: not a CharacteristicDelegate')
+    }
+    if (!(lastOnDelegate instanceof CharacteristicDelegate)) {
+      throw new TypeError('lastOnDelegate: not a CharacteristicDelegate')
+    }
+    onDelegate.on('didSet', (value) => {
+      lastOnDelegate.value = this.lastActivationValue()
+    })
+  }
+
   /** Return current time as # seconds since NodeJS epoch.
     * @returns {integer} # seconds since NodeJS epoch.
     */

package/package.json

@@ -3,7 +3,7 @@
   "description": "Library for homebridge plugins",
   "author": "Erik Baauw",
   "license": "Apache-2.0",
-  "version": "6.5.0",
+  "version": "6.6.0",
   "keywords": [
     "homekit",
     "homebridge"
@@ -22,11 +22,11 @@
   },
   "engines": {
     "homebridge": "^1.6.1",
-    "node": "18.17.1||^18||^16"
+    "node": "20.7.0||^20||^18"
   },
   "dependencies": {
     "@homebridge/plugin-ui-utils": "~0.0.19",
-    "hb-lib-tools": "~1.1.0"
+    "hb-lib-tools": "~1.1.1"
   },
   "scripts": {
     "prepare": "standard && rm -rf out && jsdoc -c jsdoc.json",