homebridge-lib 6.3.11 → 6.3.12

package/lib/EveHomeKitTypes.js

@@ -62,9 +62,10 @@ class EveHomeKitTypes extends CustomHomeKitTypes {
       * <br> Used by: `History` service.
       * @property {Class} ConfigData - Used by Eve app to read configuration.
       * <br> Used by: `History` service.
-      * @property {Class} CurrentConsumption - Current electric consumption
-      * (in W).
+      * @property {Class} Consumption - Current electric power (in W).
       * <br>Used by: Eve Energy.
+      * @property {Class} CurrentConsumption -  Deprecated. use `Consumption`
+      * instead.
       * @property {Class} CurrentTemperature - Current temperature (in °C).
       * This is the same characterisic as `hap.CurrentTemperature`, but with
       * a minimum value of -40°C instead of 0°C (or -270°C).
@@ -141,7 +142,7 @@ class EveHomeKitTypes extends CustomHomeKitTypes {
       * <br>Used by: Eve Thermo.
       * @property {Class} Visibility - Visibility (in km).
       * <br>Used by: weather station.
-      * @property {Class} VOCLevel - Volatile Organic Compound level (in ppm).
+      * @property {Class} VOCLevel - Volatile Organic Compound level (in ppb).
       * <br>Used by: Eve Room (1st gen).
       * @property {Class} Voltage - Electric voltage (in V).
       * <br>Used by: Eve Energy.
@@ -176,7 +177,7 @@ class EveHomeKitTypes extends CustomHomeKitTypes {
 
     this.createCharacteristicClass('VOCLevel', uuid('10B'), {
       format: this.Formats.INT16,
-      unit: 'ppm',
+      unit: 'ppb',
       minValue: 5,
       maxValue: 5000,
       minStep: 5,
@@ -192,6 +193,15 @@ class EveHomeKitTypes extends CustomHomeKitTypes {
       perms: [this.Perms.PAIRED_READ, this.Perms.NOTIFY]
     }, 'Total Consumption')
 
+    this.createCharacteristicClass('Consumption', uuid('10D'), {
+      format: this.Formats.FLOAT,
+      unit: 'W',
+      minValue: 0,
+      maxValue: 12000,
+      minStep: 0.1,
+      perms: [this.Perms.PAIRED_READ, this.Perms.NOTIFY]
+    }, 'Consumption')
+
     this.createCharacteristicClass('CurrentConsumption', uuid('10D'), {
       format: this.Formats.FLOAT,
       unit: 'W',
@@ -199,7 +209,7 @@ class EveHomeKitTypes extends CustomHomeKitTypes {
       maxValue: 12000,
       minStep: 0.1,
       perms: [this.Perms.PAIRED_READ, this.Perms.NOTIFY]
-    }, 'Current Consumption')
+    }, 'Consumption')
 
     this.createCharacteristicClass('AirPressure', uuid('10F'), {
       format: this.Formats.FLOAT,
@@ -601,7 +611,7 @@ class EveHomeKitTypes extends CustomHomeKitTypes {
     this.createServiceClass('Consumption', uuid('008'), [
       this.Characteristics.Voltage, // 10A
       this.Characteristics.TotalConsumption, // 10C
-      this.Characteristics.CurrentConsumption, // 10D
+      this.Characteristics.Consumption, // 10D
       this.Characteristics.ElectricCurrent, // 126
       this.hapCharacteristics.StatusFault,
       this.hapCharacteristics.LockPhysicalControls
@@ -642,7 +652,7 @@ class EveHomeKitTypes extends CustomHomeKitTypes {
         this.hapCharacteristics.InUse,
         this.Characteristics.Voltage,
         this.Characteristics.ElectricCurrent,
-        this.Characteristics.CurrentConsumption,
+        this.Characteristics.Consumption,
         this.Characteristics.TotalConsumption
       ]
     )

package/lib/MyHomeKitTypes.js

@@ -32,6 +32,8 @@ class MyHomeKitTypes extends CustomHomeKitTypes {
       * <br>Used by: homebridge-hue in for group LightBulb or Outlet service.
       * @property {Class} ApparentTemperature - Apparent temperature.
       * <br>Used by: homebridge-ws.
+      * @property {Class} AverageConsumption - Average electrical power (in W).
+      * <br>Used by: homebridge-p1.
       * @property {Class} Balance - Audio balance.
       * <br>Used by: homebridge-zp in Speaker service.
       * @property {Class} Bass - Audio bass.
@@ -43,6 +45,10 @@ class MyHomeKitTypes extends CustomHomeKitTypes {
       * <br>Used by: homebridge-otgw.
       * @property {Class} BurnerStarts - Number of burner starts.
       * <br>Used by: homebridge-otgw.
+      * @property {Class} CampfireEffect - Enabled/disable campfire dynamic effect.
+      * <br>Used by: homebridge-deconz.
+      * @property {Class} CandleEffect - Enabled/disable candle dynamic effect.
+      * <br>Used by: homebridge-deconz, homebridge-hue2.
       * @property {Class} ChangeInput - For relative changes to `InputSource`.
       * <br>Used by: homebridge-zp in Sonos service.
       * @property {Class} ChangeTrack - For relative changes to `CurrentTrack`.
@@ -93,6 +99,8 @@ class MyHomeKitTypes extends CustomHomeKitTypes {
       * <br>Used by: homebridge-deconz, homebridge-hue2.
       * @property {Class} ExposeSensors - Expose sensors devices to HomeKit.
       * <br>Used by: homebridge-deconz, homebridge-hue2.
+      * @property {Class} FireplaceEffect - Enabled/disable fireplace 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.
@@ -113,6 +121,8 @@ class MyHomeKitTypes extends CustomHomeKitTypes {
       * <br>Deprecated - use `hap.LockPhysicalControls`.
       * <br>Previously used by homebridge-hue for Thermostat sensor.
       * @property {Class} LogLevel - Level of logging.
+      * @property {Class} LoopEffect - Enabled/disable loop dynamic effect.
+      * <br>Used by: homebridge-deconz, homebridge-hue2.
       * @property {Class} Loudness - Audio loudness.
       * <br>Used by: homebridge-zp in Speaker service.
       * @property {Class} LowBatteryThreshold - Threshold value for setting
@@ -122,10 +132,14 @@ class MyHomeKitTypes extends CustomHomeKitTypes {
       * @property {Class} MorningMode - Move the blinds slowly, making less
       * noise.
       * <br>Used by: homebridge-sc, homebridge-soma in Window Covering service.
+      * @property {Class} NightlightEffect - Enabled/disable nightlight dynamic effect.
+      * <br>Used by: homebridge-deconz.
       * @property {Class} NightSound - Audio night sound.
       * <br>Used by: homebridge-zp in Speaker service.
       * @property {Class} Offset - Temperature offset.
       * <br>Used by: homebridge-hue in Temperature service.
+      * @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} PumpHours - Pump run time (in hours).
@@ -147,6 +161,8 @@ class MyHomeKitTypes extends CustomHomeKitTypes {
       * <br>Used by: homebridge-otgw.
       * @property {Class} RingToOpen - Ring to Open active.
       * <br> Used by: homebridge-nb.
+      * @property {Class} RomanceEffect - Enabled/disable romance dynamic effect.
+      * <br>Used by: homebridge-deconz.
       * @property {Class} Search - Search for new devices.
       * <br>Used by: homebridge-hue.
       * @property {Class} Sensitivity - Motion sensor sensitivity.
@@ -160,6 +176,8 @@ class MyHomeKitTypes extends CustomHomeKitTypes {
       * @property {Class} SonosGroup - Current Sonos group to which zone player
       * belongs.
       * <br>Used by: homebridge-zp in Sonos service.
+      * @property {Class} SparkleEffect - Enabled/disable sparkle dynamic effect.
+      * <br>Used by: homebridge-deconz, homebridge-hue2.
       * @property {Class} SpeechEnhancement - Audio speech enhancement setting.
       * <br>Used by: homebridge-zp in Speaker service.
       * @property {Class} Status - Generic status.
@@ -172,8 +190,12 @@ class MyHomeKitTypes extends CustomHomeKitTypes {
       * <br>Used by: homebridge-zp in Speaker service.
       * @property {Class} Sunrise - Date/time of today's sun rise.
       * <br>Used by: homebridge-hue, homebridge-ws.
+      * @property {Class} SunriseEffect - Enabled/disable sunrise dynamic effect.
+      * <br>Used by: homebridge-deconz, homebridge-hue2.
       * @property {Class} Sunset - Date/time of today's sun set.
       * <br>Used by: homebridge-hue, homebridge-ws.
+      * @property {Class} SunsetEffect - Enabled/disable sunset dynamic effect.
+      * <br>Used by: homebridge-deconz.
       * @property {Class} Tariff - Electricity tariff (normal vs low).
       * <br>Used by: homebridge-p1 in Electricity service.
       * @property {Class} TemperatureMax - Maximum temperature.
@@ -208,6 +230,8 @@ class MyHomeKitTypes extends CustomHomeKitTypes {
       * @property {Class} WaterPressure - Water pressure (in bar) of the central
       * heating system.
       * <br>Used by: homebridge-otgw.
+      * @property {Class} WorklightEffect - Enabled/disable worklight dynamic effect.
+      * <br>Used by: homebridge-deconz.
       */
 
     this.createCharacteristicClass('Resource', uuid('021'), {
@@ -759,6 +783,74 @@ class MyHomeKitTypes extends CustomHomeKitTypes {
       perms: [this.Perms.PAIRED_READ, this.Perms.NOTIFY, this.Perms.PAIRED_WRITE]
     }, 'Sub Level')
 
+    this.createCharacteristicClass('AverageConsumption', uuid('07E'), {
+      format: this.Formats.FLOAT,
+      unit: 'W',
+      minValue: 0,
+      maxValue: 12000,
+      minStep: 0.1,
+      perms: [this.Perms.PAIRED_READ, this.Perms.NOTIFY]
+    }, 'Average Consumption')
+
+    // Dynamic effects for Hue lights.
+
+    this.createCharacteristicClass('CandleEffect', uuid('07F'), {
+      format: this.Formats.BOOL,
+      perms: [this.Perms.PAIRED_READ, this.Perms.NOTIFY, this.Perms.PAIRED_WRITE]
+    }, 'Candle')
+
+    this.createCharacteristicClass('FireplaceEffect', uuid('080'), {
+      format: this.Formats.BOOL,
+      perms: [this.Perms.PAIRED_READ, this.Perms.NOTIFY, this.Perms.PAIRED_WRITE]
+    }, 'Fire Place')
+
+    this.createCharacteristicClass('LoopEffect', uuid('081'), {
+      format: this.Formats.BOOL,
+      perms: [this.Perms.PAIRED_READ, this.Perms.NOTIFY, this.Perms.PAIRED_WRITE]
+    }, 'Loop')
+
+    this.createCharacteristicClass('SunriseEffect', uuid('082'), {
+      format: this.Formats.BOOL,
+      perms: [this.Perms.PAIRED_READ, this.Perms.NOTIFY, this.Perms.PAIRED_WRITE]
+    }, 'Sunrise')
+
+    this.createCharacteristicClass('SparkleEffect', uuid('083'), {
+      format: this.Formats.BOOL,
+      perms: [this.Perms.PAIRED_READ, this.Perms.NOTIFY, this.Perms.PAIRED_WRITE]
+    }, 'Sparkle')
+
+    // Dynamic effects for MLI lights.
+
+    this.createCharacteristicClass('SunsetEffect', uuid('084'), {
+      format: this.Formats.BOOL,
+      perms: [this.Perms.PAIRED_READ, this.Perms.NOTIFY, this.Perms.PAIRED_WRITE]
+    }, 'Sunset')
+
+    this.createCharacteristicClass('PartyEffect', uuid('085'), {
+      format: this.Formats.BOOL,
+      perms: [this.Perms.PAIRED_READ, this.Perms.NOTIFY, this.Perms.PAIRED_WRITE]
+    }, 'Party')
+
+    this.createCharacteristicClass('WorklightEffect', uuid('086'), {
+      format: this.Formats.BOOL,
+      perms: [this.Perms.PAIRED_READ, this.Perms.NOTIFY, this.Perms.PAIRED_WRITE]
+    }, 'Work Light')
+
+    this.createCharacteristicClass('CampfireEffect', uuid('087'), {
+      format: this.Formats.BOOL,
+      perms: [this.Perms.PAIRED_READ, this.Perms.NOTIFY, this.Perms.PAIRED_WRITE]
+    }, 'Camp Fire')
+
+    this.createCharacteristicClass('RomanceEffect', uuid('088'), {
+      format: this.Formats.BOOL,
+      perms: [this.Perms.PAIRED_READ, this.Perms.NOTIFY, this.Perms.PAIRED_WRITE]
+    }, 'Romance')
+
+    this.createCharacteristicClass('NightlightEffect', uuid('089'), {
+      format: this.Formats.BOOL,
+      perms: [this.Perms.PAIRED_READ, this.Perms.NOTIFY, this.Perms.PAIRED_WRITE]
+    }, 'Night Light')
+
     // 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

@@ -132,8 +132,9 @@ 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 {
+// Device delivers _Total Consumption_ in kWh.
+// We compute average power, and, optionally, update _Consumption_ (power).
+class TotalConsumptionValue extends HistoryValue {
   get tag () { return 0x07 }
   get id () { return 'p' }
 
@@ -153,20 +154,22 @@ class ConsumptionValue extends HistoryValue {
   }
 
   prepareEntry (entry) {
-    const consumption = (this._delegate.value - this._parent.values.consumption) * 1000 * 3600 // Ws
+    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 * 10) / 10 // W
+    if (this._parent.computedConsumptionDelegate != null) {
+      this._parent.computedConsumptionDelegate.value = Math.round(power * 10) / 10 // W
     }
     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 {
+// Device delivers _Consumption_ (power) in W.
+// We compute _Total Consumption_ and average power, and update _Total Consumption_.
+class ConsumptionValue extends HistoryValue {
   get tag () { return 0x07 }
   get id () { return 'p' }
 
@@ -174,7 +177,7 @@ class PowerValue extends HistoryValue {
     super(parent, delegate)
     this._consumption = 0 // Ws
     this._period = 0 // s
-    this._totalConsumption = parent.computedConsumptionDelegate.value * 1000 * 3600 // Ws
+    this._totalConsumption = parent.computedTotalConsumptionDelegate.value * 1000 * 3600 // Ws
     this._power = delegate.value // W
     this._time = History.now()
     delegate.on('didSet', (value) => {
@@ -186,7 +189,7 @@ class PowerValue extends HistoryValue {
       Characteristic: parent.Characteristics.eve.ResetTotal
     }).on('didSet', (value) => {
       this._totalConsumption = 0 // Ws
-      parent.computedConsumptionDelegate.value = 0 // kWh
+      parent.computedTotalConsumptionDelegate.value = 0 // kWh
     })
   }
 
@@ -196,7 +199,8 @@ class PowerValue extends HistoryValue {
     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._parent.computedTotalConsumptionDelegate.value =
+      Math.round(totalConsumption * 100) / 100 // kWh
 
     this._consumption = 0
     this._period = 0
@@ -212,8 +216,8 @@ class PowerValue extends HistoryValue {
   }
 }
 
-// Device delivers (running) avarage power in W.
-class AveragePowerValue extends HistoryValue {
+// Device delivers (running) average _Consumption_ (power) in W.
+class AverageConsumptionValue extends HistoryValue {
   get tag () { return 0x07 }
   get id () { return 'p' }
   prepareEntry (entry) { entry[this.id] = this._delegate.value * 10 }
@@ -232,7 +236,7 @@ class SwitchOnValue extends HistoryValue {
       const now = History.now()
       const entry = { time: now }
       entry[this.id] = this._delegate.value ? 1 : 0
-      this._parent.addEntry(entry)
+      parent.addEntry(entry)
       parent.lastSwitchOnDelegate.value = parent.lastActivationValue(now)
     })
   }
@@ -284,7 +288,7 @@ class OnValue extends HistoryValue {
       const now = History.now()
       const entry = { time: now }
       entry[this.id] = this._delegate.value ? 1 : 0
-      this._parent.addEntry(entry)
+      parent.addEntry(entry)
       parent.lastOnDelegate.value = parent.lastActivationValue(now)
     })
   }
@@ -307,10 +311,10 @@ const historyValueTypes = {
   vocLevel: VocLevelValue,
   airPressure: AirPressureValue,
   contact: ContactValue,
-  power: PowerValue,
-  averagePower: AveragePowerValue,
-  switchOn: SwitchOnValue,
+  totalConsumption: TotalConsumptionValue,
   consumption: ConsumptionValue,
+  averageConsumption: AverageConsumptionValue,
+  switchOn: SwitchOnValue,
   valvePosition: ValvePositionValue,
   targetTemperature: TargetTemperatureValue,
   motion: MotionValue,
@@ -327,8 +331,8 @@ const historyDerivedTypes = {
   lastOn: 'on',
   lastLightOn: 'lightOn',
   lastSwitchOn: 'switchOn',
-  computedConsumption: 'power',
-  computedPower: 'consumption'
+  computedConsumption: 'totalConsumption',
+  computedTotalConsumption: 'consumption'
 }
 
 /** Class for an Eve _History_ service delegate.
@@ -394,22 +398,26 @@ class History extends ServiceDelegate {
     * @param {?CharacteristicDelegate} params.lastOnDelegate - The
     * `.eve.LastActivation` characteristic delegate
     * for a `hap.Outlet` service.
-    * @param {?CharacteristicDelegate} params.powerDelegate - The
-    * `.eve.CurrentConsumption` characteristic delegate
+    * @param {?CharacteristicDelegate} params.consumptionDelegate - The
+    * `.eve.Consumption` characteristic delegate
     * for a `hap.Outlet` or `eve.Consumption` service
-    * for a device that reports current consumption.
-    * @param {?CharacteristicDelegate} params.computedConsumptionDelegate - The
+    * for a device that reports power.
+    * @param {?CharacteristicDelegate} params.computedTotalConsumptionDelegate - The
     * `eve.TotalConsumption` characteristic delegate
     * for a `hap.Outlet` or `eve.Consumption` service
-    * for a device that reports current consumption, but not total consumption.
-    * @param {?CharacteristicDelegate} params.consumptionDelegate - The
+    * for a device that reports power, but not total consumption.
+    * @param {?CharacteristicDelegate} params.totalConsumptionDelegate - The
     * `.eve.TotalConsumption` characteristic delegate
     * for a `hap.Outlet` or `eve.Consumption` service
     * for a device that reports total consumption.
-    * @param {?CharacteristicDelegate} params.computedPowerDelegate - The
-    * `.eve.CurrentConsumption` characteristic delegate
+    * @param {?CharacteristicDelegate} params.computedConsumptionDelegate - The
+    * `.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
     * for a `hap.Outlet` or `eve.Consumption` service
-    * for a device that reports total consumption but not current consumption.
+    * for a device that reports runing average for power.
     * @param {?CharacteristicDelegate} params.lightOnDelegate - The
     * `Characteristics.hap.On` characteristic delegate
     * for a `hap.Lightbulb` service.

package/lib/ServiceDelegate/index.js

@@ -88,18 +88,6 @@ class ServiceDelegate extends homebridgeLib.Delegate {
     }
     this._service.setHiddenService(!!params.hidden)
 
-    // Fix bug in homebridge-lib@<4.3.0 that caused the service context in
-    // ~/.homebridge/accessories/cachedAccessories to be stored under the
-    // wrong key.
-    if (
-      params.subtype == null &&
-      this._accessory.context[this._key + '.'] != null
-    ) {
-      this._accessory.context[this._key] =
-        this._accessory.context[this._key + '.']
-      delete this._accessory.context[this._key + '.']
-    }
-
     // Setup persisted storage in ~/.homebridge/accessories/cachedAccessories.
     if (this._accessory.context[this._key] == null) {
       this._accessory.context[this._key] = {}
@@ -118,6 +106,7 @@ class ServiceDelegate extends homebridgeLib.Delegate {
       Characteristic: this.Characteristics.hap.Name,
       value: params.name
     })
+    this.name = this.values.name
     if (this._service.constructor.name !== 'AccessoryInformation') {
       this.addCharacteristicDelegate({
         key: 'configuredName',
@@ -138,6 +127,7 @@ class ServiceDelegate extends homebridgeLib.Delegate {
         }
       }).on('didSet', (value) => {
         this.name = value
+        this.values.name = value
         if (params.primaryService) {
           accessoryDelegate.values.name = value
         }

package/package.json

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