@homebridge-plugins/homebridge-ewelink 12.3.3

package/lib/device/sensor-contact.js

@@ -0,0 +1,140 @@
+import platformConsts from '../utils/constants.js'
+import { hasProperty } from '../utils/functions.js'
+
+export default class {
+  constructor(platform, accessory) {
+    // Set up variables from the platform
+    this.eveChar = platform.eveChar
+    this.hapChar = platform.api.hap.Characteristic
+    this.hapServ = platform.api.hap.Service
+    this.lang = platform.lang
+    this.log = platform.log
+    this.platform = platform
+
+    // Set up variables from the accessory
+    this.name = accessory.displayName
+    this.accessory = accessory
+
+    // Set up custom variables for this device type
+    const deviceConf = platform.deviceConf[accessory.context.eweDeviceId] || {}
+    this.lowBattThreshold = deviceConf.lowBattThreshold
+      ? Math.min(deviceConf.lowBattThreshold, 100)
+      : platformConsts.defaultValues.lowBattThreshold
+
+    // Set the correct logging variables for this accessory
+    switch (deviceConf.overrideLogging) {
+      case 'standard':
+        this.enableLogging = true
+        this.enableDebugLogging = false
+        break
+      case 'debug':
+        this.enableLogging = true
+        this.enableDebugLogging = true
+        break
+      case 'disable':
+        this.enableLogging = false
+        this.enableDebugLogging = false
+        break
+      default:
+        this.enableLogging = !platform.config.disableDeviceLogging
+        this.enableDebugLogging = platform.config.debug
+        break
+    }
+
+    // If the accessory has a leak sensor service then remove it
+    if (this.accessory.getService(this.hapServ.LeakSensor)) {
+      this.accessory.removeService(this.accessory.getService(this.hapServ.LeakSensor))
+    }
+
+    // Add the contact sensor service if it doesn't already exist
+    this.service = this.accessory.getService(this.hapServ.ContactSensor)
+    if (!this.service) {
+      this.service = this.accessory.addService(this.hapServ.ContactSensor)
+      this.service.addCharacteristic(this.eveChar.LastActivation)
+      this.service.addCharacteristic(this.eveChar.ResetTotal)
+      this.service.addCharacteristic(this.eveChar.OpenDuration)
+      this.service.addCharacteristic(this.eveChar.ClosedDuration)
+      this.service.addCharacteristic(this.eveChar.TimesOpened)
+    }
+
+    // Add the set handler to the contact sensor reset total characteristic
+    this.service.getCharacteristic(this.eveChar.ResetTotal).onSet(() => {
+      this.service.updateCharacteristic(this.eveChar.TimesOpened, 0)
+    })
+
+    // Add the battery service if it doesn't already exist
+    this.batteryService = this.accessory.getService(this.hapServ.Battery)
+    || this.accessory.addService(this.hapServ.Battery)
+
+    // Pass the accessory to Fakegato to set up with Eve
+    this.accessory.eveService = new platform.eveService('door', this.accessory, {
+      log: () => {},
+    })
+    this.accessory.eveService.addEntry({
+      status: this.service.getCharacteristic(this.hapChar.ContactSensorState).value,
+    })
+
+    // Output the customised options to the log
+    const normalLogging = this.enableLogging ? 'standard' : 'disable'
+    const opts = JSON.stringify({
+      logging: this.enableDebugLogging ? 'debug' : normalLogging,
+      lowBattThreshold: this.lowBattThreshold,
+      showAs: 'default',
+    })
+    this.log('[%s] %s %s.', this.name, this.lang.devInitOpts, opts)
+  }
+
+  async externalUpdate(params) {
+    try {
+      if (hasProperty(params, 'battery') && params.battery !== this.cacheBatt) {
+        this.cacheBatt = params.battery
+        if (this.accessory.context.eweUIID === 154) {
+          // No scaling needed for this model as provided as a %
+          this.cacheBattScaled = this.cacheBatt
+        } else {
+          // Scaling needed for UIID 102 as provided as a voltage rather than a %
+          this.cacheBattScaled = Math.min(Math.max(this.cacheBatt, 2), 3)
+          this.cacheBattScaled = Math.round((this.cacheBattScaled - 2) * 100)
+        }
+
+        this.batteryService.updateCharacteristic(this.hapChar.BatteryLevel, this.cacheBattScaled)
+        this.batteryService.updateCharacteristic(
+          this.hapChar.StatusLowBattery,
+          this.cacheBattScaled < this.lowBattThreshold ? 1 : 0,
+        )
+        if (params.updateSource && this.enableLogging) {
+          this.log('[%s] %s [%s%].', this.name, this.lang.curBatt, this.cacheBattScaled)
+        }
+      }
+      if (!params.switch || params.switch === this.cacheState) {
+        return
+      }
+      this.cacheState = params.switch
+      const newState = params.switch === 'on' ? 1 : 0
+      if (newState === 1) {
+        this.service.updateCharacteristic(this.hapChar.ContactSensorState, 1)
+        this.accessory.eveService.addEntry({ status: 1 })
+        const initialTime = this.accessory.eveService.getInitialTime()
+        this.service.updateCharacteristic(
+          this.eveChar.LastActivation,
+          Math.round(new Date().valueOf() / 1000) - initialTime,
+        )
+        const newTO = this.service.getCharacteristic(this.eveChar.TimesOpened).value + 1
+        this.service.updateCharacteristic(this.eveChar.TimesOpened, newTO)
+      } else {
+        this.service.updateCharacteristic(this.hapChar.ContactSensorState, 0)
+        this.accessory.eveService.addEntry({ status: 0 })
+      }
+      if (params.updateSource && this.enableLogging) {
+        this.log(
+          '[%s] %s [%s].',
+          this.name,
+          this.lang.curState,
+          newState === 0 ? this.lang.contactYes : this.lang.contactNo,
+        )
+      }
+    } catch (err) {
+      this.platform.deviceUpdateError(this.accessory, err, false)
+    }
+  }
+}

package/lib/device/sensor-temp-humi.js

@@ -0,0 +1,182 @@
+import platformConsts from '../utils/constants.js'
+import { hasProperty, parseError } from '../utils/functions.js'
+
+export default class {
+  constructor(platform, accessory) {
+    // Set up variables from the platform
+    this.hapChar = platform.api.hap.Characteristic
+    this.hapServ = platform.api.hap.Service
+    this.lang = platform.lang
+    this.log = platform.log
+    this.platform = platform
+
+    // Set up variables from the accessory
+    this.name = accessory.displayName
+    this.accessory = accessory
+
+    // Initially set the online flag as true (to be then updated as false if necessary)
+    this.isOnline = true
+
+    // Set up custom variables for this device type
+    const deviceConf = platform.deviceConf[accessory.context.eweDeviceId] || {}
+    this.tempOffset = deviceConf.offset || platformConsts.defaultValues.offset
+    this.tempOffsetFactor = deviceConf.offsetFactor
+    this.humiOffset = deviceConf && deviceConf.humidityOffset
+      ? Number.parseInt(deviceConf.humidityOffset, 10)
+      : platformConsts.defaultValues.humidityOffset
+    this.humiOffsetFactor = deviceConf.humidityOffsetFactor
+
+    // Set the correct logging variables for this accessory
+    switch (deviceConf.overrideLogging) {
+      case 'standard':
+        this.enableLogging = true
+        this.enableDebugLogging = false
+        break
+      case 'debug':
+        this.enableLogging = true
+        this.enableDebugLogging = true
+        break
+      case 'disable':
+        this.enableLogging = false
+        this.enableDebugLogging = false
+        break
+      default:
+        this.enableLogging = !platform.config.disableDeviceLogging
+        this.enableDebugLogging = platform.config.debug
+        break
+    }
+
+    // Add the temperature sensor service if it doesn't already exist
+    this.tempService = this.accessory.getService(this.hapServ.TemperatureSensor)
+    || this.accessory.addService(this.hapServ.TemperatureSensor)
+
+    // Set custom properties of the current temperature characteristic
+    this.tempService.getCharacteristic(this.hapChar.CurrentTemperature).setProps({
+      minStep: 0.1,
+    })
+    this.cacheTemp = this.tempService.getCharacteristic(this.hapChar.CurrentTemperature).value
+    this.updateCache()
+
+    // Add the humidity sensor service if it doesn't already exist
+    this.humiService = this.accessory.getService(this.hapServ.HumiditySensor)
+    || this.accessory.addService(this.hapServ.HumiditySensor)
+
+    // Add the get handlers only if the user hasn't disabled the disableNoResponse setting
+    if (!platform.config.disableNoResponse) {
+      this.tempService
+        .getCharacteristic(this.hapChar.CurrentTemperature)
+        .setProps({
+          minStep: 0.1,
+        })
+        .onGet(() => {
+          if (!this.isOnline) {
+            throw new this.hapErr(-70402)
+          }
+          return this.tempService.getCharacteristic(this.hapChar.CurrentTemperature).value
+        })
+      this.humiService.getCharacteristic(this.hapChar.CurrentRelativeHumidity).onGet(() => {
+        if (!this.isOnline) {
+          throw new this.hapErr(-70402)
+        }
+        return this.humiService.getCharacteristic(this.hapChar.CurrentRelativeHumidity).value
+      })
+    }
+
+    // Pass the accessory to Fakegato to set up with Eve
+    this.accessory.eveService = new platform.eveService('custom', this.accessory, {
+      log: () => {},
+    })
+
+    // Output the customised options to the log
+    const normalLogging = this.enableLogging ? 'standard' : 'disable'
+    const opts = JSON.stringify({
+      humidityOffset: this.humiOffset,
+      humidityOffsetFactor: this.humiOffsetFactor,
+      logging: this.enableDebugLogging ? 'debug' : normalLogging,
+      offset: this.tempOffset,
+      offsetFactor: this.tempOffsetFactor,
+    })
+    this.log('[%s] %s %s.', this.name, this.lang.devInitOpts, opts)
+  }
+
+  async externalUpdate(params) {
+    try {
+      if (hasProperty(params, 'temperature')) {
+        let newTemp = Number(params.temperature)
+        if (this.tempOffsetFactor) {
+          newTemp *= this.tempOffset
+        } else {
+          newTemp += this.tempOffset
+        }
+        if (newTemp !== this.cacheTemp) {
+          this.cacheTemp = newTemp
+          this.tempService.updateCharacteristic(this.hapChar.CurrentTemperature, this.cacheTemp)
+          this.accessory.eveService.addEntry({ temp: this.cacheTemp })
+          if (params.updateSource && this.enableLogging) {
+            this.log('[%s] %s [%s°C].', this.name, this.lang.curTemp, this.cacheTemp)
+          }
+
+          // Update the cache file with the new temperature
+          this.updateCache()
+        }
+      }
+      if (hasProperty(params, 'humidity')) {
+        let newHumi = Number.parseInt(params.humidity, 10)
+        if (this.humiOffsetFactor) {
+          newHumi *= this.humiOffset
+        } else {
+          newHumi += this.humiOffset
+        }
+        newHumi = Math.max(Math.min(Number.parseInt(newHumi, 10), 100), 0)
+        if (newHumi !== this.cacheHumi) {
+          this.cacheHumi = newHumi
+          this.humiService.updateCharacteristic(
+            this.hapChar.CurrentRelativeHumidity,
+            this.cacheHumi,
+          )
+          this.accessory.eveService.addEntry({ humidity: this.cacheHumi })
+          if (params.updateSource && this.enableLogging) {
+            this.log('[%s] %s [%s%].', this.name, this.lang.curHumi, this.cacheHumi)
+          }
+        }
+      }
+    } catch (err) {
+      this.platform.deviceUpdateError(this.accessory, err, false)
+    }
+  }
+
+  async updateCache() {
+    // Don't continue if the storage client hasn't initialised properly
+    if (!this.platform.storageClientData) {
+      return
+    }
+
+    // Attempt to save the new temperature to the cache
+    try {
+      await this.platform.storageData.setItem(
+        `${this.accessory.context.eweDeviceId}_temp`,
+        this.cacheTemp,
+      )
+    } catch (err) {
+      if (this.enableLogging) {
+        this.log.warn('[%s] %s %s.', this.name, this.lang.storageWriteErr, parseError(err))
+      }
+    }
+  }
+
+  currentState() {
+    const toReturn = {}
+    toReturn.services = ['temperature', 'humidity']
+    toReturn.temperature = {
+      current: this.tempService.getCharacteristic(this.hapChar.CurrentTemperature).value,
+    }
+    toReturn.humidity = {
+      current: this.humiService.getCharacteristic(this.hapChar.CurrentRelativeHumidity).value,
+    }
+    return toReturn
+  }
+
+  markStatus(isOnline) {
+    this.isOnline = isOnline
+  }
+}

package/lib/device/simulation/blind.js

@@ -0,0 +1,253 @@
+import platformConsts from '../../utils/constants.js'
+import { generateRandomString, hasProperty, sleep } from '../../utils/functions.js'
+
+export default class {
+  constructor(platform, accessory) {
+    // Set up variables from the platform
+    this.eveChar = platform.eveChar
+    this.hapChar = platform.api.hap.Characteristic
+    this.hapErr = platform.api.hap.HapStatusError
+    this.hapServ = platform.api.hap.Service
+    this.lang = platform.lang
+    this.log = platform.log
+    this.platform = platform
+
+    // Set up variables from the accessory
+    this.name = accessory.displayName
+    this.accessory = accessory
+
+    // Initially set the online flag as true (to be then updated as false if necessary)
+    this.isOnline = true
+
+    // Set up custom variables for this device type
+    const deviceConf = platform.deviceConf[accessory.context.eweDeviceId] || {}
+    this.operationTimeUp = deviceConf.operationTime || platformConsts.defaultValues.operationTime
+    this.operationTimeDown = deviceConf.operationTimeDown || this.operationTimeUp
+
+    // Set the correct logging variables for this accessory
+    switch (deviceConf.overrideLogging) {
+      case 'standard':
+        this.enableLogging = true
+        this.enableDebugLogging = false
+        break
+      case 'debug':
+        this.enableLogging = true
+        this.enableDebugLogging = true
+        break
+      case 'disable':
+        this.enableLogging = false
+        this.enableDebugLogging = false
+        break
+      default:
+        this.enableLogging = !platform.config.disableDeviceLogging
+        this.enableDebugLogging = platform.config.debug
+        break
+    }
+
+    // Set up the accessory with default positions when added the first time
+    if (!hasProperty(this.accessory.context, 'cacheCurrentPosition')) {
+      this.accessory.context.cacheCurrentPosition = 0
+      this.accessory.context.cachePositionState = 2
+      this.accessory.context.cacheTargetPosition = 0
+    }
+
+    // Add the window covering service if it doesn't already exist
+    this.service = this.accessory.getService(this.hapServ.WindowCovering)
+    if (!this.service) {
+      this.service = this.accessory.addService(this.hapServ.WindowCovering)
+      this.service.updateCharacteristic(this.hapChar.CurrentPosition, 0)
+      this.service.updateCharacteristic(this.hapChar.TargetPosition, 0)
+      this.service.updateCharacteristic(this.hapChar.PositionState, 2)
+    }
+
+    // Certain devices give power readings
+    if (platformConsts.devices.switchMultiPower.includes(this.accessory.context.eweUIID)) {
+      // Add Eve power characteristics
+      this.powerReadings = true
+      if (!this.service.testCharacteristic(this.eveChar.CurrentConsumption)) {
+        this.service.addCharacteristic(this.eveChar.CurrentConsumption)
+      }
+      if (!this.service.testCharacteristic(this.eveChar.ElectricCurrent)) {
+        this.service.addCharacteristic(this.eveChar.ElectricCurrent)
+      }
+      if (!this.service.testCharacteristic(this.eveChar.Voltage)) {
+        this.service.addCharacteristic(this.eveChar.Voltage)
+      }
+    }
+
+    // Add the set handler to the target position characteristic
+    this.service.getCharacteristic(this.hapChar.TargetPosition).onSet((value) => {
+      // We don't use await as we want the callback to be run straight away
+      this.internalPositionUpdate(value)
+    })
+
+    // Add the get handlers only if the user hasn't disabled the disableNoResponse setting
+    if (!platform.config.disableNoResponse) {
+      this.service.getCharacteristic(this.hapChar.CurrentPosition).onGet(() => {
+        if (!this.isOnline) {
+          throw new this.hapErr(-70402)
+        }
+        return this.service.getCharacteristic(this.hapChar.CurrentPosition).value
+      })
+      this.service.getCharacteristic(this.hapChar.TargetPosition).onGet(() => {
+        if (!this.isOnline) {
+          throw new this.hapErr(-70402)
+        }
+        return this.service.getCharacteristic(this.hapChar.TargetPosition).value
+      })
+    }
+
+    // Set up an interval to get eWeLink to send power updates
+    if (this.powerReadings && platform.config.mode !== 'lan') {
+      setTimeout(() => {
+        this.internalUIUpdate()
+        this.intervalPoll = setInterval(() => this.internalUIUpdate(), 120000)
+      }, 5000)
+
+      // Stop the intervals on Homebridge shutdown
+      platform.api.on('shutdown', () => clearInterval(this.intervalPoll))
+    }
+
+    // Output the customised options to the log
+    const normalLogging = this.enableLogging ? 'standard' : 'disable'
+    const opts = JSON.stringify({
+      logging: this.enableDebugLogging ? 'debug' : normalLogging,
+      operationTimeDown: this.operationTimeDown,
+      operationTimeUp: this.operationTimeUp,
+      showAs: 'blind',
+    })
+    this.log('[%s] %s %s.', this.name, this.lang.devInitOpts, opts)
+  }
+
+  async internalPositionUpdate(value) {
+    try {
+      let prevPosition = this.accessory.context.cacheCurrentPosition
+      if (value === prevPosition) {
+        return
+      }
+      const params = {
+        switches: [],
+      }
+      const prevState = this.accessory.context.cachePositionState
+      const percentStepUpPerDS = this.operationTimeUp / 100
+      const percentStepDownPerDS = this.operationTimeDown / 100
+      const updateKey = generateRandomString(5)
+      this.updateKey = updateKey
+      if (prevState !== 2) {
+        params.switches.push({ switch: 'off', outlet: 0 })
+        params.switches.push({ switch: 'off', outlet: 1 })
+        await this.platform.sendDeviceUpdate(this.accessory, params)
+        params.switches = []
+        const posPercentChange = Math.floor(Date.now() / 100) - this.accessory.context.cacheLastStartTime
+        const posPercentChangeUp = Math.floor(percentStepUpPerDS * posPercentChange)
+        const posPercentChangeDown = Math.floor(percentStepDownPerDS * posPercentChange)
+        if (prevState === 0) {
+          // Was going down
+          prevPosition -= posPercentChangeDown
+        } else {
+          // Was going up
+          prevPosition += posPercentChangeUp
+        }
+        prevPosition = Math.min(Math.max(prevPosition, 0), 100)
+        this.service.updateCharacteristic(this.hapChar.CurrentPosition, prevPosition)
+        this.accessory.context.cacheCurrentPosition = prevPosition
+      }
+      const diffPosition = value - prevPosition
+      const setToMoveUp = diffPosition > 0
+      let decisecondsToMove
+      if (setToMoveUp) {
+        decisecondsToMove = Math.round(Math.abs(diffPosition) * percentStepUpPerDS)
+        params.switches.push({ switch: 'on', outlet: 0 })
+      } else {
+        decisecondsToMove = Math.round(Math.abs(diffPosition) * percentStepDownPerDS)
+        params.switches.push({ switch: 'on', outlet: 1 })
+      }
+      await this.platform.sendDeviceUpdate(this.accessory, params)
+      params.switches = []
+      this.accessory.context.cacheTargetPosition = value
+      this.accessory.context.cachePositionState = setToMoveUp ? 1 : 0
+      this.accessory.context.cacheLastStartTime = Math.floor(Date.now() / 100)
+      await sleep(decisecondsToMove * 100)
+      if (this.updateKey !== updateKey) {
+        return
+      }
+      params.switches.push({
+        switch: 'off',
+        outlet: setToMoveUp ? 0 : 1,
+      })
+      await this.platform.sendDeviceUpdate(this.accessory, params)
+      this.service.updateCharacteristic(this.hapChar.PositionState, 2)
+      this.service.updateCharacteristic(this.hapChar.CurrentPosition, value)
+      this.accessory.context.cachePositionState = 2
+      this.accessory.context.cacheCurrentPosition = value
+      if (this.enableLogging) {
+        this.log('[%s] %s [%s%]', this.name, this.lang.curPos, value)
+      }
+    } catch (err) {
+      this.platform.deviceUpdateError(this.accessory, err, true)
+      setTimeout(() => {
+        this.service.updateCharacteristic(
+          this.hapChar.TargetPosition,
+          this.accessory.context.cacheTargetPosition,
+        )
+      }, 2000)
+      this.service.updateCharacteristic(this.hapChar.TargetPosition, new this.hapErr(-70402))
+    }
+  }
+
+  async internalUIUpdate() {
+    try {
+      // Skip polling if device isn't online
+      if (!this.isOnline) {
+        return
+      }
+
+      // Send the params to request the updates
+      await this.platform.sendDeviceUpdate(this.accessory, { uiActive: { outlet: 0, time: 120 } })
+    } catch (err) {
+      // Suppress errors here
+    }
+  }
+
+  async externalUpdate(params) {
+    try {
+      if (!this.powerReadings) {
+        return
+      }
+      let logger = false
+      let power
+      let voltage
+      let current
+      if (hasProperty(params, 'actPow_00')) {
+        power = Number.parseInt(params.actPow_00, 10) / 100
+        this.service.updateCharacteristic(this.eveChar.CurrentConsumption, power)
+        logger = true
+      }
+      if (hasProperty(params, 'voltage_00')) {
+        voltage = Number.parseInt(params.voltage_00, 10) / 100
+        this.service.updateCharacteristic(this.eveChar.Voltage, voltage)
+        logger = true
+      }
+      if (hasProperty(params, 'current_00')) {
+        current = Number.parseInt(params.current_00, 10) / 100
+        this.service.updateCharacteristic(this.eveChar.ElectricCurrent, current)
+        logger = true
+      }
+      if (params.updateSource && logger && this.enableLogging) {
+        this.log(
+          '[%s] %s%s%s.',
+          this.name,
+          power !== undefined ? `${this.lang.curPower} [${power}W]` : '',
+          voltage !== undefined ? ` ${this.lang.curVolt} [${voltage}V]` : '',
+          current !== undefined ? ` ${this.lang.curCurr} [${current}A]` : '',
+        )
+      }
+    } catch (err) {
+      this.platform.deviceUpdateError(this.accessory, err, false)
+    }
+  }
+
+  markStatus(isOnline) {
+    this.isOnline = isOnline
+  }
+}