homebridge-lib 5.2.2 → 5.2.3-0

package/lib/EveHomeKitTypes.js

@@ -40,13 +40,12 @@ class EveHomeKitTypes extends homebridgeLib.CustomHomeKitTypes {
     super(homebridge)
 
     /** @member EveHomeKitTypes#Characteristics
-      * @property {Class} AirParticulateDensity - Density (in ppm) of air
-      * particulates.
-      * <br>Used by: Eve Room.
+      * @property {Class} AirParticulateDensity - Deprecated. use `VOCLevel`
+      * instead.
       * @property {Class} AirPressure - Air pressure (in hPa).
       * <br>Used by: Eve Weather.
-      * @property {Class} ClosedDuration - Time in seconds that door has been
-      * open.
+      * @property {Class} ClosedDuration - Duration (in seconds) that door has
+      * been closed.
       * <br>Used by: Eve Door.
       * @property {Class} Clouds - Cloud coverage (in %).
       * <br>Used by: weather station.
@@ -59,6 +58,10 @@ class EveHomeKitTypes extends homebridgeLib.CustomHomeKitTypes {
       * @property {Class} ConditionCategory - Weather condition
       * (as numberic code).
       * <br>Used by: weather station.
+      * @property {Class} ConfigCommand - Used by Eve app to set configuration.
+      * <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).
       * <br>Used by: Eve Energy.
@@ -98,7 +101,7 @@ class EveHomeKitTypes extends homebridgeLib.CustomHomeKitTypes {
       * @property {Class} ObservationTime - Time of observation.
       * <br>Used by: weather station.
       * @property {Class} OpenDuration - Duration (in seconds) that door has
-      * been closed.
+      * been open.
       * <br>Used by: Eve Door.
       * @property {Class} Ozone - Ozone level (in DU).
       * <br>Used by: weather station.
@@ -138,6 +141,8 @@ class EveHomeKitTypes extends homebridgeLib.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).
+      * <br>Used by: Eve Room (1st gen).
       * @property {Class} Voltage - Electric voltage (in V).
       * <br>Used by: Eve Energy.
       * @property {Class} WindDirection - Wind direction (as text).
@@ -167,23 +172,32 @@ class EveHomeKitTypes extends homebridgeLib.CustomHomeKitTypes {
       maxValue: 5000,
       minStep: 1,
       perms: [this.Perms.READ, this.Perms.NOTIFY]
-    }, 'Air Particulate Density')
+    }, 'VOC Level')
+
+    this.createCharacteristicClass('VOCLevel', uuid('10B'), {
+      format: this.Formats.INT16,
+      unit: 'ppm',
+      minValue: 5,
+      maxValue: 5000,
+      minStep: 5,
+      perms: [this.Perms.READ, this.Perms.NOTIFY]
+    }, 'VOC Level')
 
     this.createCharacteristicClass('TotalConsumption', uuid('10C'), {
       format: this.Formats.FLOAT,
+      unit: 'kWh',
       minValue: 0,
       maxValue: 1000000,
       minStep: 0.1,
-      unit: 'kWh',
       perms: [this.Perms.READ, this.Perms.NOTIFY]
     }, 'Total Consumption')
 
     this.createCharacteristicClass('CurrentConsumption', uuid('10D'), {
       format: this.Formats.FLOAT,
+      unit: 'W',
       minValue: 0,
       maxValue: 12000,
       minStep: 0.1,
-      unit: 'W',
       perms: [this.Perms.READ, this.Perms.NOTIFY]
     }, 'Current Consumption')
 
@@ -236,6 +250,11 @@ class EveHomeKitTypes extends homebridgeLib.CustomHomeKitTypes {
       perms: [this.Perms.WRITE, this.Perms.HIDDEN]
     }, 'History Request')
 
+    this.createCharacteristicClass('ConfigCommand', uuid('11D'), {
+      format: this.Formats.DATA,
+      perms: [this.Perms.WRITE, this.Perms.HIDDEN]
+    }, 'Config Command')
+
     this.createCharacteristicClass('Sensitivity', uuid('120'), {
       format: this.Formats.UINT8,
       minValue: 0,
@@ -314,6 +333,11 @@ class EveHomeKitTypes extends homebridgeLib.CustomHomeKitTypes {
       adminOnlyAccess: [this.Access.WRITE]
     })
 
+    this.createCharacteristicClass('ConfigData', uuid('131'), {
+      format: this.Formats.DATA,
+      perms: [this.Perms.READ, this.Perms.NOTIFY, this.Perms.HIDDEN]
+    }, 'Config Data')
+
     // =========================================================================
 
     // The following custom characteristics are supported by the Eve app.
@@ -541,10 +565,10 @@ class EveHomeKitTypes extends homebridgeLib.CustomHomeKitTypes {
       this.Characteristics.HistoryStatus,
       this.Characteristics.HistoryEntries
     ], [
-      // this.Characteristics.Char11E,
+      // this.Characteristics.Char11E, // Used for firmware update?
       this.Characteristics.ResetTotal
-      // this.Characteristics.Char11D,
-      // this.Characteristics.Char131
+      // this.Characteristics.ConfigCommand,
+      // this.Characteristics.ConfigData
     ])
 
     this.createServiceClass('AirPressureSensor', uuid('00A'), [

package/lib/ServiceDelegate/History/Motion.js

@@ -75,15 +75,14 @@ class Motion extends History {
       const now = Math.round(new Date().valueOf() / 1000)
       lastActivationDelegate.value = now - this._h.initialTime
       this._entry.status = value
-      // Eve v5.4.2 fills in missing temperature at 0.00°C.
-      // if (this._entry.temp != null) {
-      //   const temp = this._entry.temp
-      //   this._entry.temp = null
-      //   this._addEntry(now)
-      //   this._entry.temp = temp
-      // } else {
-      this._addEntry(now)
-      // }
+      if (this._entry.temp != null) {
+        const temp = this._entry.temp
+        this._entry.temp = null
+        this._addEntry(now)
+        this._entry.temp = temp
+      } else {
+        this._addEntry(now)
+      }
     })
     if (temperatureDelegate != null) {
       this._entry.temp = temperatureDelegate.value
@@ -94,27 +93,24 @@ class Motion extends History {
   }
 
   get _fingerPrint () {
-    if (this._entry.temp != null) {
-      return '02 1c01 0102'
-    }
-    return '01 1c01'
+    return '02 1c01 0102'
   }
 
   _entryStream (entry) {
-    if (this._entry.temp != null) {
+    if (entry.temp == null) {
       return util.format(
-        '|0d %s %s 03 %s %s',
+        '|0b %s %s 01 %s',
         numToHex(swap32(this._h.currentEntry), 8),
         numToHex(swap32(entry.time - this._h.initialTime), 8),
-        numToHex(entry.status, 2),
-        numToHex(swap16(entry.temp * 100), 4)
+        numToHex(entry.status, 2)
       )
     }
     return util.format(
-      '|0b %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(entry.status, 2)
+      numToHex(entry.status, 2),
+      numToHex(swap16(entry.temp * 100), 4)
     )
   }
 }

package/lib/ServiceDelegate/History/Weather.js

@@ -74,9 +74,7 @@ class Weather extends ServiceDelegate.History {
     }
     this._entry = {
       time: 0,
-      temp: temperatureDelegate.value,
-      humidity: 0,
-      pressure: 0
+      temp: temperatureDelegate.value
     }
     temperatureDelegate.on('didSet', (value) => {
       this._entry.temp = value
@@ -95,11 +93,26 @@ class Weather extends ServiceDelegate.History {
     }
   }
 
-  get _fingerPrint () {
-    return '03 0102 0202 0302'
-  }
+  get _fingerPrint () { return '03 0102 0202 0302' }
 
   _entryStream (entry) {
+    if (entry.humidity == 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.temp * 100), 4)
+      )
+    }
+    if (entry.pressure == null) {
+      return util.format(
+        '|0e %s %s 03 %s %s',
+        numToHex(swap32(this._h.currentEntry), 8),
+        numToHex(swap32(entry.time - this._h.initialTime), 8),
+        numToHex(swap16(entry.temp * 100), 4),
+        numToHex(swap16(entry.humidity * 100), 4)
+      )
+    }
     return util.format(
       '|10 %s %s 07 %s %s %s',
       numToHex(swap32(this._h.currentEntry), 8),

package/lib/ServiceDelegate/History/index.js

@@ -144,6 +144,7 @@ class History extends ServiceDelegate {
       setter: this._onSetHistoryRequest.bind(this),
       silent: true
     })
+
     this.addCharacteristicDelegate({
       key: 'setTime',
       Characteristic: this.Characteristics.eve.SetTime,
@@ -155,12 +156,14 @@ class History extends ServiceDelegate {
       const date = dateToString(buffer.readUInt32LE())
       this.debug('SetTime changed to %s', date)
     })
+
     this.addCharacteristicDelegate({
       key: 'historyStatus',
       Characteristic: this.Characteristics.eve.HistoryStatus,
       value: params.historyStatus,
       silent: true
     })
+
     this.addCharacteristicDelegate({
       key: 'historyEntries',
       Characteristic: this.Characteristics.eve.HistoryEntries,
@@ -168,6 +171,21 @@ class History extends ServiceDelegate {
       getter: this._onGetEntries.bind(this),
       silent: true
     })
+
+    // this.addCharacteristicDelegate({
+    //   key: 'configCommand',
+    //   Characteristic: this.Characteristics.eve.ConfigCommand,
+    //   setter: this._onSetConfig.bind(this)
+    //   // silent: true
+    // })
+
+    // this.addCharacteristicDelegate({
+    //   key: 'configData',
+    //   Characteristic: this.Characteristics.eve.ConfigData,
+    //   getter: this._onGetConfig.bind(this)
+    //   // silent: true
+    // })
+
     this._accessoryDelegate.heartbeatEnabled = true
     this._accessoryDelegate
       .once('heartbeat', (beat) => {
@@ -214,30 +232,31 @@ class History extends ServiceDelegate {
 
     const usedMemeoryOffset = this._h.usedMemory < this._memorySize ? 1 : 0
     const firstEntryOffset = this._h.usedMemory < this._memorySize ? 0 : 1
-    const buffer = Buffer.alloc(1024)
-    let offset = 0
-    buffer.writeUInt32LE(this._entry.time - this._h.initialTime, offset)
-    offset += 4
-    buffer.writeUInt32LE(0, offset)
-    offset += 4
-    buffer.writeUInt32LE(this._h.initialTime - epoch, offset)
-    offset += 4
-    buffer.write(this._fingerPrint.replace(/[^0-9A-F]/ig, ''), offset, 'hex')
-    const length = 1 + 2 * parseInt(this._fingerPrint.slice(0, 2))
-    this.debug('fingerprint length: %d', length)
-    offset += length
-    buffer.writeUInt16LE(this._h.usedMemory + usedMemeoryOffset, offset)
-    offset += 2
-    buffer.writeUInt16LE(this._memorySize, offset)
-    offset += 2
-    buffer.writeUInt32LE(this._h.firstEntry + firstEntryOffset, offset)
-    offset += 4
-    buffer.writeUInt32LE(0, offset)
-    offset += 4
-    buffer.writeUint8(1, offset)
-    offset += 1
-    buffer.writeUint8(1, offset)
-    offset += 1
+
+    // const buffer = Buffer.alloc(1024)
+    // let offset = 0
+    // buffer.writeUInt32LE(this._entry.time - this._h.initialTime, offset)
+    // offset += 4
+    // buffer.writeUInt32LE(0, offset)
+    // offset += 4
+    // buffer.writeUInt32LE(this._h.initialTime - epoch, offset)
+    // offset += 4
+    // buffer.write(this._fingerPrint.replace(/[^0-9A-F]/ig, ''), offset, 'hex')
+    // const length = 1 + 2 * parseInt(this._fingerPrint.slice(0, 2))
+    // this.debug('fingerprint length: %d', length)
+    // offset += length
+    // buffer.writeUInt16LE(this._h.usedMemory + usedMemeoryOffset, offset)
+    // offset += 2
+    // buffer.writeUInt16LE(this._memorySize, offset)
+    // offset += 2
+    // buffer.writeUInt32LE(this._h.firstEntry + firstEntryOffset, offset)
+    // offset += 4
+    // buffer.writeUInt32LE(0, offset)
+    // offset += 4
+    // buffer.writeUint8(1, offset)
+    // offset += 1
+    // buffer.writeUint8(1, offset)
+    // offset += 1
 
     const value = util.format(
       '%s 00000000 %s [%s] %s %s %s 000000000101',
@@ -251,7 +270,7 @@ class History extends ServiceDelegate {
 
     this.debug('add entry %d: %j', this._h.lastEntry, this._entry)
     this.debug('set history status to: %j', value)
-    this.debug('set history status to: %j', buffer.slice(0, offset).toString('hex'))
+    // this.debug('set history status to: %j', buffer.slice(0, offset).toString('hex'))
     this.values.historyStatus = hexToBase64(value)
   }
 
@@ -313,6 +332,13 @@ class History extends ServiceDelegate {
     this.debug('send data: %s', dataStream)
     return hexToBase64(dataStream)
   }
+
+  // async _onGetConfig () {
+  //   return hexToBase64('D200')
+  // }
+
+  // async _onSetConfig () {
+  // }
 }
 
 module.exports = History

package/package.json

@@ -3,7 +3,7 @@
   "description": "Library for homebridge plugins",
   "author": "Erik Baauw",
   "license": "Apache-2.0",
-  "version": "5.2.2",
+  "version": "5.2.3-0",
   "keywords": [
     "homekit",
     "homebridge"
@@ -22,7 +22,7 @@
   },
   "engines": {
     "homebridge": "^1.4.0",
-    "node": "^16.13.2"
+    "node": "^16.14.0"
   },
   "dependencies": {
     "bonjour-hap": "^3.6.3",