@homebridge-plugins/homebridge-ewelink 12.3.3

package/lib/device/simulation/tap-one.js

@@ -0,0 +1,283 @@
+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.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] || {}
+
+    // 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 switch service then remove it
+    if (this.accessory.getService(this.hapServ.Switch)) {
+      this.accessory.removeService(this.accessory.getService(this.hapServ.Switch))
+    }
+
+    // Add the tap service if it doesn't already exist
+    this.service = this.accessory.getService(this.hapServ.Valve)
+    if (!this.service) {
+      this.service = this.accessory.addService(this.hapServ.Valve)
+      this.service.updateCharacteristic(this.hapChar.Active, 0)
+      this.service.updateCharacteristic(this.hapChar.InUse, 0)
+      this.service.updateCharacteristic(this.hapChar.ValveType, 3)
+    }
+
+    // Set up the device type and power readings if necessary
+    if (platformConsts.devices.switchSingle.includes(this.accessory.context.eweUIID)) {
+      this.setup = 'switchSingle'
+    } else if (platformConsts.devices.switchSinglePower.includes(this.accessory.context.eweUIID)) {
+      this.setup = 'switchSingle'
+
+      // Add Eve power characteristics
+      this.powerReadings = true
+      if (!this.service.testCharacteristic(this.eveChar.CurrentConsumption)) {
+        this.service.addCharacteristic(this.eveChar.CurrentConsumption)
+      }
+      if (this.accessory.context.eweUIID === 32) {
+        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)
+        }
+      }
+    } else if (platformConsts.devices.switchMulti.includes(this.accessory.context.eweUIID)) {
+      this.setup = 'switchMulti'
+      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)
+        }
+        this.isDualR3 = true
+      }
+    } else if (platformConsts.devices.switchSCM.includes(this.accessory.context.eweUIID)) {
+      this.setup = 'switchMulti'
+    } else if (platformConsts.devices.switchSCMPower.includes(this.accessory.context.eweUIID)) {
+      // Could do power here
+      this.setup = 'switchMulti'
+    }
+
+    // Add the set handler to the tap active characteristic
+    this.service.getCharacteristic(this.hapChar.Active).onSet(async (value) => {
+      await this.internalUpdate(value)
+    })
+
+    // Add the get handlers only if the user hasn't disabled the disableNoResponse setting
+    if (!platform.config.disableNoResponse) {
+      this.service.getCharacteristic(this.hapChar.Active).onGet(() => {
+        if (!this.isOnline) {
+          throw new this.hapErr(-70402)
+        }
+        return this.service.getCharacteristic(this.hapChar.Active).value
+      })
+    }
+
+    // Set up an interval to get eWeLink to send power updates
+    if (
+      this.powerReadings
+      && (!this.isDualR3 || (this.isDualR3 && 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,
+      showAs: 'tap',
+    })
+    this.log('[%s] %s %s.', this.name, this.lang.devInitOpts, opts)
+  }
+
+  async internalUpdate(value) {
+    try {
+      const params = {}
+      switch (this.setup) {
+        case 'switchSingle':
+          params.switch = value ? 'on' : 'off'
+          break
+        case 'switchMulti':
+          params.switches = [
+            {
+              switch: value ? 'on' : 'off',
+              outlet: 0,
+            },
+          ]
+          break
+        default:
+          return
+      }
+      await this.platform.sendDeviceUpdate(this.accessory, params)
+      this.cacheState = value ? 'on' : 'off'
+      this.service.updateCharacteristic(this.hapChar.InUse, value)
+      if (this.enableLogging) {
+        this.log(
+          '[%s] %s [%s].',
+          this.name,
+          this.lang.curState,
+          value === 1 ? this.lang.valveYes : this.lang.valveNo,
+        )
+      }
+    } catch (err) {
+      this.platform.deviceUpdateError(this.accessory, err, true)
+      setTimeout(() => {
+        this.service.updateCharacteristic(this.hapChar.Active, this.cacheState === 'on')
+      }, 2000)
+      throw 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
+      if (this.isDualR3) {
+        await this.platform.sendDeviceUpdate(this.accessory, { uiActive: { outlet: 0, time: 120 } })
+      } else {
+        await this.platform.sendDeviceUpdate(this.accessory, { uiActive: 120 })
+      }
+    } catch (err) {
+      // Suppress errors here
+    }
+  }
+
+  async externalUpdate(params) {
+    try {
+      if (
+        (this.setup === 'switchMulti' && params.switches)
+        || (this.setup === 'switchSingle' && params.switch)
+      ) {
+        let newState
+        if (this.setup === 'switchMulti' && params.switches) {
+          newState = params.switches[0].switch
+        } else if (this.setup === 'switchSingle' && params.switch) {
+          newState = params.switch
+        }
+        if (newState && newState !== this.cacheState) {
+          this.cacheState = newState
+          this.service.updateCharacteristic(this.hapChar.Active, this.cacheState === 'on' ? 1 : 0)
+          this.service.updateCharacteristic(this.hapChar.InUse, this.cacheState === 'on' ? 1 : 0)
+          if (params.updateSource && this.enableLogging) {
+            this.log(
+              '[%s] %s [%s].',
+              this.name,
+              this.lang.curState,
+              this.cacheState === 'on' ? this.lang.valveYes : this.lang.valveNo,
+            )
+          }
+        }
+      }
+
+      // Get the power readings given by certain devices
+      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
+      } else if (hasProperty(params, 'power')) {
+        power = Number.parseFloat(params.power)
+        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
+      } else if (hasProperty(params, 'voltage')) {
+        voltage = Number.parseFloat(params.voltage)
+        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
+      } else if (hasProperty(params, 'current')) {
+        current = Number.parseFloat(params.current)
+        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)
+    }
+  }
+
+  currentState() {
+    return {
+      services: ['valve'],
+      valve: {
+        state: this.service.getCharacteristic(this.hapChar.Active).value === 1 ? 'on' : 'off',
+      },
+    }
+  }
+
+  markStatus(isOnline) {
+    this.isOnline = isOnline
+  }
+}

package/lib/device/simulation/tap-two.js

@@ -0,0 +1,266 @@
+import platformConsts from '../../utils/constants.js'
+import { 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] || {}
+
+    // 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
+    }
+
+    // Certain devices give power readings
+    if (platformConsts.devices.switchMultiPower.includes(this.accessory.context.eweUIID)) {
+      this.powerReadings = true
+    }
+
+    // We want two tap services for this accessory
+    ['1', '2'].forEach((v) => {
+      // Add the tap service if it doesn't already exist
+      let tapService = this.accessory.getService(`Tap ${v}`)
+      if (!tapService) {
+        tapService = this.accessory.addService(this.hapServ.Valve, `Tap ${v}`, `tap${v}`)
+        tapService.updateCharacteristic(this.hapChar.Active, 0)
+        tapService.updateCharacteristic(this.hapChar.InUse, 0)
+        tapService.updateCharacteristic(this.hapChar.ValveType, 3)
+      }
+
+      // Add Eve power characteristics
+      if (this.powerReadings) {
+        if (!tapService.testCharacteristic(this.eveChar.CurrentConsumption)) {
+          tapService.addCharacteristic(this.eveChar.CurrentConsumption)
+        }
+        if (!tapService.testCharacteristic(this.eveChar.ElectricCurrent)) {
+          tapService.addCharacteristic(this.eveChar.ElectricCurrent)
+        }
+        if (!tapService.testCharacteristic(this.eveChar.Voltage)) {
+          tapService.addCharacteristic(this.eveChar.Voltage)
+        }
+      }
+
+      // Add the set handler to the tap active characteristic
+      tapService
+        .getCharacteristic(this.hapChar.Active)
+        .onSet(async value => this.internalUpdate(`Tap ${v}`, value))
+
+      // Add the get handlers only if the user hasn't disabled the disableNoResponse setting
+      if (!platform.config.disableNoResponse) {
+        tapService.getCharacteristic(this.hapChar.Active).onGet(() => {
+          if (!this.isOnline) {
+            throw new this.hapErr(-70402)
+          }
+          return tapService.getCharacteristic(this.hapChar.Active).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,
+      showAs: 'tap_two',
+    })
+    this.log('[%s] %s %s.', this.name, this.lang.devInitOpts, opts)
+  }
+
+  async internalUpdate(tap, value) {
+    try {
+      const params = {
+        switches: [],
+      }
+      const tapService = this.accessory.getService(tap)
+      switch (tap) {
+        case 'Tap 1':
+          params.switches.push({ switch: value ? 'on' : 'off', outlet: 0 })
+          break
+        case 'Tap 2':
+          params.switches.push({ switch: value ? 'on' : 'off', outlet: 1 })
+          break
+        default:
+          return
+      }
+      tapService.updateCharacteristic(this.hapChar.InUse, value)
+      if (this.enableLogging) {
+        this.log(
+          '[%s] [%s] %s [%s].',
+          this.name,
+          tap,
+          this.lang.curState,
+          value === 1 ? this.lang.valveYes : this.lang.valveNo,
+        )
+      }
+      await this.platform.sendDeviceUpdate(this.accessory, params)
+    } catch (err) {
+      this.platform.deviceUpdateError(this.accessory, err, true)
+      const tapService = this.accessory.getService(tap)
+      setTimeout(() => {
+        tapService.updateCharacteristic(this.hapChar.Active, value === 1 ? 0 : 1)
+      }, 2000)
+      throw 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 } })
+      await sleep(2000)
+      await this.platform.sendDeviceUpdate(this.accessory, { uiActive: { outlet: 1, time: 120 } })
+    } catch (err) {
+      // Suppress errors here
+    }
+  }
+
+  async externalUpdate(params) {
+    try {
+      if (params.switches) {
+        ['1', '2'].forEach((v, k) => {
+          const tapService = this.accessory.getService(`Tap ${v}`)
+          tapService.updateCharacteristic(
+            this.hapChar.Active,
+            params.switches[k].switch === 'on' ? 1 : 0,
+          )
+          tapService.updateCharacteristic(
+            this.hapChar.InUse,
+            params.switches[k].switch === 'on' ? 1 : 0,
+          )
+          if (params.updateSource && this.enableLogging) {
+            this.log(
+              '[%s] [Tap %s] %s [%s].',
+              this.name,
+              v,
+              this.lang.curState,
+              params.switches[k].switch === 'on' ? this.lang.valveYes : this.lang.valveNo,
+            )
+          }
+        })
+      }
+
+      // Get the power readings given by certain devices
+      if (!this.powerReadings) {
+        return
+      }
+      let logger0 = false
+      let logger1 = false
+      let power0
+      let power1
+      let voltage0
+      let voltage1
+      let current0
+      let current1
+      if (hasProperty(params, 'actPow_00')) {
+        power0 = Number.parseInt(params.actPow_00, 10) / 100
+        this.accessory
+          .getService('Tap 1')
+          .updateCharacteristic(this.eveChar.CurrentConsumption, power0)
+        logger0 = true
+      }
+      if (hasProperty(params, 'actPow_01')) {
+        power1 = Number.parseInt(params.actPow_01, 10) / 100
+        this.accessory
+          .getService('Tap 2')
+          .updateCharacteristic(this.eveChar.CurrentConsumption, power1)
+        logger1 = true
+      }
+      if (hasProperty(params, 'voltage_00')) {
+        voltage0 = Number.parseInt(params.voltage_00, 10) / 100
+        this.accessory.getService('Tap 1').updateCharacteristic(this.eveChar.Voltage, voltage0)
+        logger0 = true
+      }
+      if (hasProperty(params, 'voltage_01')) {
+        voltage1 = Number.parseInt(params.voltage_01, 10) / 100
+        this.accessory.getService('Tap 2').updateCharacteristic(this.eveChar.Voltage, voltage1)
+        logger1 = true
+      }
+      if (hasProperty(params, 'current_00')) {
+        current0 = Number.parseInt(params.current_00, 10) / 100
+        this.accessory
+          .getService('Tap 1')
+          .updateCharacteristic(this.eveChar.ElectricCurrent, current0)
+        logger0 = true
+      }
+      if (hasProperty(params, 'current_01')) {
+        current1 = Number.parseInt(params.current_01, 10) / 100
+        this.accessory
+          .getService('Tap 2')
+          .updateCharacteristic(this.eveChar.ElectricCurrent, current1)
+        logger1 = true
+      }
+      if (params.updateSource && this.enableLogging) {
+        if (logger0) {
+          this.log(
+            '[%s] [Tap 1] %s%s%s.',
+            this.name,
+            power0 !== undefined ? `${this.lang.curPower} [${power0}W]` : '',
+            voltage0 !== undefined ? ` ${this.lang.curVolt} [${voltage0}V]` : '',
+            current0 !== undefined ? ` ${this.lang.curCurr} [${current0}A]` : '',
+          )
+        }
+        if (logger1) {
+          this.log(
+            '[%s] [Tap 2] %s%s%s.',
+            this.name,
+            power1 !== undefined ? `${this.lang.curPower} [${power1}W]` : '',
+            voltage1 !== undefined ? ` ${this.lang.curVolt} [${voltage1}V]` : '',
+            current1 !== undefined ? ` ${this.lang.curCurr} [${current1}A]` : '',
+          )
+        }
+      }
+    } catch (err) {
+      this.platform.deviceUpdateError(this.accessory, err, false)
+    }
+  }
+
+  markStatus(isOnline) {
+    this.isOnline = isOnline
+  }
+}