homebridge-lib 6.2.2 → 6.3.0

package/lib/ServiceDelegate/History/Thermo.js

@@ -1,88 +0,0 @@
-// homebridge-lib/lib/ServiceDelegate/History/Thermo.js
-//
-// Library for Homebridge plugins.
-// Copyright © 2017-2023 Erik Baauw. All rights reserved.
-
-'use strict'
-
-const homebridgeLib = require('../../../index')
-
-const { History } = homebridgeLib.ServiceDelegate
-
-/** Class for an Eve Thermo _History_ service delegate.
-  *
-  * This delegate sets up a `Services.eve.History` HomeKit service
-  * with keys for the following HomeKit characteristics:
-  *
-  * key              | Characteristic
-  * ---------------- | ----------------------------------
-  * `name`           | `Characteristics.hap.Name`
-  * `historyRequest` | `Characteristics.eve.HistoryRequest`
-  * `setTime`        | `Characteristics.eve.SetTime`
-  * `historyStatus`  | `Characteristics.eve.HistoryStatus`
-  * `historyEntries` | `Characteristics.eve.HistoryEntries`
-  *
-  * This delegate creates the history from the associated
-  * `Characteristics.hap.CurrentTemperature`,
-  * `Characteristics.hap.TargetTemperature`, and
-  * `Characteristics.eve.ValvePosition` characteristics.
-  * @extends ServiceDelegate.History
-  * @memberof ServiceDelegate.History
-  */
-class Thermo extends History {
-  /** Create a new instance of an Eve Thermo _History_ service delegate.
-    * @param {!AccessoryDelegate} accessoryDelegate - The delegate of the
-    * corresponding HomeKit accessory.
-    * @param {!object} params - The parameters for the
-    * _History_ HomeKit service.
-    * @param {!CharacteristicDelegate} params.temperatureDelegate - A reference
-    * to the delegate of the associated `Characteristics.hap.CurrentTemperature`
-    * characteristic.
-    * @param {!CharacteristicDelegate} params.targetTemperatureDelegate - A
-    * reference to the delegate of the associated
-    * `Characteristics.hap.TargetTemperature` characteristic.
-    * @param {!CharacteristicDelegate} params.valvePositionDelegate - A
-    * reference to the delegate of the associated
-    * `Characteristics.eve.ValvePosition` characteristic.
-    */
-  constructor (accessoryDelegate, params) {
-    super(accessoryDelegate, params)
-    if (!(params.temperatureDelegate instanceof homebridgeLib.CharacteristicDelegate)) {
-      throw new TypeError('params.temperatureDelegate: not a CharacteristicDelegate')
-    }
-    if (!(params.targetTemperatureDelegate instanceof homebridgeLib.CharacteristicDelegate)) {
-      throw new TypeError('params.targetTemperatureDelegate: not a CharacteristicDelegate')
-    }
-    if (!(params.valvePositionDelegate instanceof homebridgeLib.CharacteristicDelegate)) {
-      throw new TypeError('params.valvePositionDelegate: not a CharacteristicDelegate')
-    }
-    this.entry = {
-      t: params.temperatureDelegate.value * 100,
-      s: params.targetTemperatureDelegate.value * 100,
-      v: params.valvePositionDelegate.value
-    }
-    params.temperatureDelegate.on('didSet', (value) => {
-      this.entry.t = value * 100
-    })
-    params.targetTemperatureDelegate.on('didSet', (value) => {
-      this.entry.s = value * 100
-    })
-    params.valvePositionDelegate.on('didSet', (value) => {
-      this.entry.v = value
-    })
-  }
-
-  get fingerPrint () { return '03 0102 1102 1001' }
-
-  entryToBuffer (entry) {
-    const buffer = Buffer.alloc(6)
-    let o = 1
-    buffer.writeUInt16LE(entry.t, o); o += 2
-    buffer.writeUInt16LE(entry.s, o); o += 2
-    buffer.writeUInt8(entry.v, o); o += 1
-    buffer.writeUInt8(0x07, 0)
-    return buffer.slice(0, o)
-  }
-}
-
-module.exports = Thermo

package/lib/ServiceDelegate/History/index.js

@@ -1,310 +0,0 @@
-// homebridge-lib/lib/ServiceDelegate/History/index.js
-//
-// Library for Homebridge plugins.
-// Copyright © 2017-2023 Erik Baauw. All rights reserved.
-//
-// The logic for handling Eve history was inspired by Simone Tisa's
-// fakagato-history repository, copyright © 2017 simont77.
-// See https://github.com/simont77/fakegato-history.
-
-'use strict'
-
-const homebridgeLib = require('../../../index')
-
-const { ServiceDelegate } = homebridgeLib
-
-/** Eve history keeps time as # seconds since epoch of 2001/01/01.
-  * @type {integer}
-  */
-const epoch = Math.round(new Date('2001-01-01T00:00:00Z').valueOf() / 1000)
-
-const defaultMemorySize = 6 * 24 * 7 * 4 // 4 weeks of 1 entry per 10 minutes
-
-/** Convert date (in # seconds since NodeJS epoch) to string.
-  * @param {integer} d - # seconds since NodeJS epoch.
-  * @returns {string} Human readable date string.
-  */
-function dateToString (d) {
-  return new Date(1000 * d).toString().slice(0, 24)
-}
-
-/** Abstract superclass for an Eve _History_ service delegate.
-  *
-  * This delegate sets up a `Services.eve.History` HomeKit service
-  * with keys for the following HomeKit characteristics:
-  *
-  * key              | Characteristic
-  * ---------------- | ----------------------------------
-  * `name`           | `Characteristics.hap.Name`
-  * `historyRequest` | `Characteristics.eve.HistoryRequest`
-  * `setTime`        | `Characteristics.eve.SetTime`
-  * `historyStatus`  | `Characteristics.eve.HistoryStatus`
-  * `historyEntries` | `Characteristics.eve.HistoryEntries`
-  * @abstract
-  * @extends ServiceDelegate
-  * @memberof ServiceDelegate
-  */
-class History extends ServiceDelegate {
-  static get Consumption () { return require('./Consumption') }
-  static get Light () { return require('./Light') }
-  static get On () { return require('./On') }
-  static get Power () { return require('./Power') }
-  static get Sensor () { return require('./Sensor') }
-  static get Thermo () { return require('./Thermo') }
-
-  /** Create a new instance of an Eve _History_ service delegate.
-    * @param {!AccessoryDelegate} accessoryDelegate - The delegate of the
-    * corresponding HomeKit accessory.
-    * @param {!object} params - The parameters for the
-    * _History_ HomeKit 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.
-    */
-  constructor (accessoryDelegate, params = {}) {
-    params.name = accessoryDelegate.name + ' History'
-    params.Service = accessoryDelegate.Services.eve.History
-    params.hidden = true
-    super(accessoryDelegate, params)
-    const memorySize = params.memorySize == null ? defaultMemorySize : params.memorySize
-    this._transfer = false
-
-    this.addCharacteristicDelegate({
-      key: 'history',
-      silent: true
-    })
-    this._h = this.values.history
-    if (this._h == null) {
-      this.values.history = {
-        memorySize,
-        firstEntry: 1,
-        lastEntry: 1,
-        entryOffset: 0,
-        entries: [null, null],
-        initialTime: History.now()
-      }
-      this._h = this.values.history
-    } else if (this._h.memorySize !== memorySize) {
-      this.values.history = {
-        memorySize,
-        firstEntry: this._h.lastEntry,
-        lastEntry: this._h.lastEntry,
-        entryOffset: this._h.lastEntry - 1,
-        entries: [null, null],
-        initialTime: this._h.initialTime
-      }
-      this._h = this.values.history
-    } else {
-      this.debug(
-        'restored %d history entries (%d to %d)', this._h.entries.length,
-        this._h.firstEntry, this._h.lastEntry
-      )
-    }
-
-    this.addCharacteristicDelegate({
-      key: 'historyRequest',
-      Characteristic: this.Characteristics.eve.HistoryRequest,
-      value: params.historyRequest,
-      setter: this._onSetHistoryRequest.bind(this),
-      silent: true
-    })
-
-    this.addCharacteristicDelegate({
-      key: 'setTime',
-      Characteristic: this.Characteristics.eve.SetTime,
-      value: params.setTime,
-      silent: true
-    }).on('didSet', (value) => {
-      const buffer = Buffer.from(value, 'base64')
-      this.vdebug('SetTime changed to %j', buffer.toString('hex'))
-      const date = dateToString(buffer.readUInt32LE() + epoch)
-      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,
-      value: params.historyEntries,
-      getter: this._onGetEntries.bind(this),
-      silent: true
-    })
-
-    if (params.config) {
-      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
-      })
-    }
-
-    accessoryDelegate.propertyDelegate('name')
-      .on('didSet', (value) => {
-        this.values.configuredName = value + ' History'
-      })
-
-    this._accessoryDelegate.heartbeatEnabled = true
-    this._accessoryDelegate
-      .once('heartbeat', (beat) => {
-        this._historyBeat = (beat % 600) + 5
-      })
-      .on('heartbeat', (beat) => {
-        if (beat % 600 === this._historyBeat) {
-          this.addEntry(
-            Object.assign({ time: History.now() }, this.entry)
-          )
-        }
-      })
-      .on('shutdown', () => {
-        this.debug(
-          'saved %d history entries (%d to %d)', this._h.entries.length,
-          this._h.firstEntry, this._h.lastEntry
-        )
-      })
-  }
-
-  /** Return current time as # seconds since NodeJS epoch.
-    * @returns {integer} # seconds since NodeJS epoch.
-    */
-  static now () { return Math.round(new Date().valueOf() / 1000) }
-
-  /** Convert date intp `Characteristics.eve.LastActivation` characteristic value.
-    * @param {integer} date - # seconds since NodeJS epoch.
-    * @returns {integer} Value for last activation.
-    */
-  lastActivationValue (date = History.now()) { return date - this._h.initialTime }
-
-  /** Return the history fingerprint.
-    * @abstract
-    * @returns {string} fingerprint - Hex string with the fingerprint.
-    */
-  get fingerPrint () { return '00' }
-
-  /** Convert a history entry to a buffer.
-    * @abstract
-    * @param {object} entry - The entry.
-    * @returns {Buffer} A Buffer with the values from the entry.
-    */
-  entryToBuffer (entry) {
-    return Buffer.alloc(0)
-  }
-
-  /** Add an entry to the history.
-    * @param {object} entry - The entry.
-    */
-  addEntry (entry) {
-    if (this._h.memorySize > 0) {
-      if (this._h.lastEntry - this._h.entryOffset >= this._h.memorySize) {
-        this._h.firstEntry++
-      }
-      this._h.lastEntry++
-      const index = (this._h.lastEntry - this._h.entryOffset) % this._h.memorySize
-      this.debug(
-        'History Entries: set entry %d (index %d) to %j',
-        this._h.lastEntry, index, entry
-      )
-      this._h.entries[index] = entry
-    }
-
-    this.debug('set History Status to %d .. %d', this._h.firstEntry, this._h.lastEntry)
-    const buffer = Buffer.alloc(1024)
-    let offset = 0
-    buffer.writeUInt32LE(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')
-    offset += 1 + 2 * parseInt(this.fingerPrint.slice(0, 2))
-    buffer.writeUInt16LE(this._h.lastEntry - this._h.firstEntry + 1, offset); offset += 2
-    buffer.writeUInt16LE(this._h.memorySize, offset); offset += 2
-    buffer.writeUInt32LE(this._h.firstEntry, offset); offset += 4
-    buffer.writeUInt32LE(0, offset); offset += 4
-    buffer.writeUInt8(1, offset); offset += 1
-    buffer.writeUInt8(1, offset); offset += 1
-    const value = buffer.slice(0, offset)
-    this.values.historyStatus = value.toString('base64')
-  }
-
-  async _onSetHistoryRequest (value) {
-    const buffer = Buffer.from(value, 'base64')
-    this.vdebug('History Request changed to %j', buffer.toString('hex'))
-    const entry = buffer.readUInt32LE(2)
-    this.debug(
-      'History Request changed to %d (%d to %d)', entry,
-      this._h.firstEntry, this._h.lastEntry
-    )
-    this._currentEntry = Math.max(this._h.firstEntry, entry)
-    this._transfer = true
-  }
-
-  async _onGetEntries () {
-    if (this._currentEntry > this._h.lastEntry || !this._transfer) {
-      this.debug('History Entries: no entry')
-      this.vdebug('History Entries: send data: 00')
-      this._transfer = false
-      return Buffer.from('00', 'hex').toString('base64')
-    }
-
-    const buffer = Buffer.alloc(1024)
-    let offset = 0
-    for (let i = 0; i < 11; i++) {
-      const index = this._h.memorySize === 0
-        ? 1
-        : (this._currentEntry - this._h.entryOffset) % this._h.memorySize
-      if (this._currentEntry === this._h.firstEntry) {
-        this.debug(
-          'History Entries (%d/11): entry %d (index: %d): %j (%s)',
-          i, this._currentEntry, index, { initialTime: this._h.initialTime - epoch },
-          dateToString(this._h.initialTime)
-        )
-        buffer.writeUInt8(21, offset); offset += 1
-        buffer.writeUInt32LE(this._currentEntry, offset); offset += 4
-        buffer.write('0100000081', offset, 'hex'); offset += 5
-        buffer.writeUInt32LE(this._h.initialTime - epoch, offset); offset += 4
-        buffer.write('00000000000000', offset, 'hex'); offset += 7
-      } else {
-        const entry = this._h.entries[index]
-        this.debug(
-          'History Entries (%d/11): entry %d (index: %d): %j (%s)',
-          i, this._currentEntry, index, entry, dateToString(entry.time)
-        )
-        const b = this.entryToBuffer(entry)
-        buffer.writeUInt8(b.length + 9, offset); offset += 1
-        buffer.writeUInt32LE(this._currentEntry, offset); offset += 4
-        buffer.writeUInt32LE(entry.time - this._h.initialTime, offset); offset += 4
-        b.copy(buffer, offset); offset += b.length
-      }
-      this._currentEntry++
-      if (this._currentEntry > this._h.lastEntry) {
-        break
-      }
-    }
-    const value = buffer.slice(0, offset)
-    this.vdebug('History Entries: send data: %s', value.toString('hex'))
-    return value.toString('base64')
-  }
-
-  async _onSetConfig (value) {
-    const buffer = Buffer.from(value, 'base64')
-    this.vdebug('Config Request changed to %j', buffer.toString('hex'))
-  }
-
-  async _onGetConfig () {
-    return Buffer.from('D200', 'hex').toString('base64')
-  }
-}
-
-module.exports = History