@homebridge-plugins/homebridge-ewelink 12.3.3

package/lib/device/simulation/doorbell.js

@@ -0,0 +1,190 @@
+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 doorbell service if it doesn't already exist
+    this.service = this.accessory.getService(this.hapServ.Doorbell)
+    || this.accessory.addService(this.hapServ.Doorbell)
+
+    // 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'
+      this.powerReadings = true
+    } 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
+        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 get handlers only if the user hasn't disabled the disableNoResponse setting
+    if (!platform.config.disableNoResponse) {
+      this.service.getCharacteristic(this.hapChar.ProgrammableSwitchEvent).onGet(() => {
+        if (!this.isOnline) {
+          throw new this.hapErr(-70402)
+        }
+        return this.service.getCharacteristic(this.hapChar.ProgrammableSwitchEvent).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: 'doorbell',
+    })
+    this.log('[%s] %s %s.', this.name, this.lang.devInitOpts, opts)
+  }
+
+  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.inUse) {
+        if (
+          (this.setup === 'switchMulti' && params.switches && params.switches[0].switch === 'on')
+          || (this.setup === 'switchSingle' && params.switch && params.switch === 'on')
+        ) {
+          this.inUse = true
+          setTimeout(() => {
+            this.inUse = false
+          }, 2000)
+          this.service.updateCharacteristic(this.hapChar.ProgrammableSwitchEvent, 0)
+          if (params.updateSource && this.enableLogging) {
+            this.log('[%s] %s [%s].', this.name, this.lang.curState, this.lang.buttonSingle)
+          }
+        }
+      }
+
+      // 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
+        logger = true
+      } else if (hasProperty(params, 'power')) {
+        power = Number.parseFloat(params.power)
+        logger = true
+      }
+      if (hasProperty(params, 'voltage_00')) {
+        voltage = Number.parseInt(params.voltage_00, 10) / 100
+        logger = true
+      } else if (hasProperty(params, 'voltage')) {
+        voltage = Number.parseFloat(params.voltage)
+        logger = true
+      }
+      if (hasProperty(params, 'current_00')) {
+        current = Number.parseInt(params.current_00, 10) / 100
+        logger = true
+      } else if (hasProperty(params, 'current')) {
+        current = Number.parseFloat(params.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.inUse = false
+      this.platform.deviceUpdateError(this.accessory, err, false)
+    }
+  }
+
+  markStatus(isOnline) {
+    this.isOnline = isOnline
+  }
+}

package/lib/device/simulation/garage-eachen.js

@@ -0,0 +1,235 @@
+import platformConsts from '../../utils/constants.js'
+import { generateRandomString, 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.operationTime = deviceConf.operationTime || platformConsts.defaultValues.operationTime
+
+    // 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))
+    }
+
+    // If the accessory has a contact sensor service then remove it
+    if (this.accessory.getService(this.hapServ.ContactSensor)) {
+      this.accessory.removeService(this.accessory.getService(this.hapServ.ContactSensor))
+    }
+
+    // If the accessory has a lock service then remove it
+    if (this.accessory.getService(this.hapServ.LockMechanism)) {
+      this.accessory.removeService(this.accessory.getService(this.hapServ.LockMechanism))
+    }
+
+    // Add the garage door service if it doesn't already exist
+    this.service = this.accessory.getService(this.hapServ.GarageDoorOpener)
+    if (!this.service) {
+      this.service = this.accessory.addService(this.hapServ.GarageDoorOpener)
+      this.service.updateCharacteristic(this.hapChar.CurrentDoorState, 1)
+      this.service.updateCharacteristic(this.hapChar.TargetDoorState, 1)
+      this.service.updateCharacteristic(this.hapChar.ObstructionDetected, false)
+      this.service.addCharacteristic(this.eveChar.LastActivation)
+      this.service.addCharacteristic(this.eveChar.ResetTotal)
+      this.service.addCharacteristic(this.eveChar.TimesOpened)
+    }
+
+    // Remove unneeded characteristics
+    if (this.service.testCharacteristic(this.hapChar.ContactSensorState)) {
+      this.service.removeCharacteristic(
+        this.service.getCharacteristic(this.hapChar.ContactSensorState),
+      )
+    }
+    if (this.service.testCharacteristic(this.hapChar.OpenDuration)) {
+      this.service.removeCharacteristic(this.service.getCharacteristic(this.hapChar.OpenDuration))
+    }
+    if (this.service.testCharacteristic(this.hapChar.ClosedDuration)) {
+      this.service.removeCharacteristic(this.service.getCharacteristic(this.hapChar.ClosedDuration))
+    }
+
+    // Add the set handler to the garage door reset total characteristic
+    this.service.getCharacteristic(this.eveChar.ResetTotal).onSet(() => {
+      this.service.updateCharacteristic(this.eveChar.TimesOpened, 0)
+    })
+
+    // Add the set handler to the target position characteristic
+    this.service.getCharacteristic(this.hapChar.TargetDoorState).onSet((value) => {
+      // We don't use await as we want the callback to be run straight away
+      this.internalStateUpdate(value)
+    })
+
+    // Add the get handlers only if the user hasn't disabled the disableNoResponse setting
+    if (!platform.config.disableNoResponse) {
+      this.service.getCharacteristic(this.hapChar.CurrentDoorState).onGet(() => {
+        if (!this.isOnline) {
+          throw new this.hapErr(-70402)
+        }
+        return this.service.getCharacteristic(this.hapChar.CurrentDoorState).value
+      })
+      this.service.getCharacteristic(this.hapChar.TargetDoorState).onGet(() => {
+        if (!this.isOnline) {
+          throw new this.hapErr(-70402)
+        }
+        return this.service.getCharacteristic(this.hapChar.TargetDoorState).value
+      })
+    }
+
+    // Update the obstruction detected to false on Homebridge restart
+    this.service.updateCharacteristic(this.hapChar.ObstructionDetected, false)
+
+    // 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.CurrentDoorState).value === 0 ? 0 : 1,
+    })
+
+    // Output the customised options to the log
+    const normalLogging = this.enableLogging ? 'standard' : 'disable'
+    const opts = JSON.stringify({
+      logging: this.enableDebugLogging ? 'debug' : normalLogging,
+      operationTime: this.operationTime,
+      showAs: 'garage_eachen',
+    })
+    this.log('[%s] %s %s.', this.name, this.lang.devInitOpts, opts)
+  }
+
+  async internalStateUpdate(value) {
+    try {
+      const params = { switch: value === 0 ? 'on' : 'off' }
+      const curState = this.service.getCharacteristic(this.hapChar.CurrentDoorState).value
+      if (value === curState % 2) {
+        return
+      }
+      this.inUse = true
+      await this.platform.sendDeviceUpdate(this.accessory, params)
+      this.service.updateCharacteristic(this.hapChar.TargetDoorState, value)
+      this.service.updateCharacteristic(this.hapChar.CurrentDoorState, value + 2)
+      await sleep(3000)
+      this.inUse = false
+      if (value === 0) {
+        this.accessory.eveService.addEntry({ status: 0 })
+        this.service.updateCharacteristic(
+          this.eveChar.LastActivation,
+          Math.round(new Date().valueOf() / 1000) - this.accessory.eveService.getInitialTime(),
+        )
+        this.service.updateCharacteristic(
+          this.eveChar.TimesOpened,
+          this.service.getCharacteristic(this.eveChar.TimesOpened).value + 1,
+        )
+        await sleep(Math.max((this.operationTime - 30) * 100, 0))
+        this.service.updateCharacteristic(this.hapChar.CurrentDoorState, 0)
+        if (this.enableLogging) {
+          this.log('[%s] %s [%s].', this.name, this.lang.curState, this.lang.doorOpen)
+        }
+      }
+    } catch (err) {
+      this.inUse = false
+      this.platform.deviceUpdateError(this.accessory, err, true)
+      setTimeout(() => {
+        this.service.updateCharacteristic(
+          this.hapChar.TargetDoorState,
+          this.accessory.context.cacheTargetDoorState,
+        )
+      }, 2000)
+      this.service.updateCharacteristic(this.hapChar.TargetDoorState, new this.hapErr(-70402))
+    }
+  }
+
+  async externalUpdate(params) {
+    try {
+      if (!params.switch || this.inUse) {
+        return
+      }
+
+      // In a period of three seconds we want to only use the 'last' update
+      const updateKey = generateRandomString(5)
+      this.updateKey = updateKey
+      await sleep(3000)
+      if (this.updateKey !== updateKey) {
+        return
+      }
+
+      // Update the characteristics
+      const newValue = params.switch === 'on' ? 0 : 1
+      if (this.service.getCharacteristic(this.hapChar.TargetDoorState).value !== newValue) {
+        this.service.updateCharacteristic(this.hapChar.TargetDoorState, newValue)
+      }
+      if (this.service.getCharacteristic(this.hapChar.CurrentDoorState).value !== newValue) {
+        this.service.updateCharacteristic(this.hapChar.CurrentDoorState, newValue)
+      }
+      this.accessory.eveService.addEntry({ status: newValue })
+      if (newValue === 0) {
+        this.service.updateCharacteristic(
+          this.eveChar.LastActivation,
+          Math.round(new Date().valueOf() / 1000) - this.accessory.eveService.getInitialTime(),
+        )
+        this.service.updateCharacteristic(
+          this.eveChar.TimesOpened,
+          this.service.getCharacteristic(this.eveChar.TimesOpened).value + 1,
+        )
+      }
+      if (params.updateSource && this.enableLogging) {
+        this.log(
+          '[%s] %s [%s].',
+          this.name,
+          this.lang.curState,
+          params.switch === 'on' ? this.lang.doorOpen : this.lang.doorClosed,
+        )
+      }
+    } catch (err) {
+      this.platform.deviceUpdateError(this.accessory, err, false)
+    }
+  }
+
+  currentState() {
+    return {
+      services: ['garage'],
+      garage: {
+        target: this.service.getCharacteristic(this.hapChar.TargetDoorState).value,
+        state: this.service.getCharacteristic(this.hapChar.CurrentDoorState).value,
+      },
+    }
+  }
+
+  markStatus(isOnline) {
+    this.isOnline = isOnline
+  }
+}

package/lib/device/simulation/garage-four.js

@@ -0,0 +1,176 @@
+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.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, 'cacheStates')) {
+      this.accessory.context.cacheStates = [
+        { cacheCurrentDoorState: 1, cacheTargetDoorState: 1 },
+        { cacheCurrentDoorState: 1, cacheTargetDoorState: 1 },
+        { cacheCurrentDoorState: 1, cacheTargetDoorState: 1 },
+        { cacheCurrentDoorState: 1, cacheTargetDoorState: 1 },
+      ]
+    }
+
+    // We want four garage door services for this accessory
+    ['A', 'B', 'C', 'D'].forEach((v) => {
+      // Add the garage door service if it doesn't already exist
+      let gdService = this.accessory.getService(`Garage ${v}`)
+      if (!gdService) {
+        gdService = this.accessory.addService(this.hapServ.GarageDoorOpener, `Garage ${v}`, `garage${v}`)
+        gdService.updateCharacteristic(this.hapChar.CurrentDoorState, 1)
+        gdService.updateCharacteristic(this.hapChar.TargetDoorState, 1)
+        gdService.updateCharacteristic(this.hapChar.ObstructionDetected, false)
+      }
+
+      // Add the set handler to the target position characteristic
+      gdService.getCharacteristic(this.hapChar.TargetDoorState).onSet((value) => {
+        // We don't use await as we want the callback to be run straight away
+        this.internalStateUpdate(v, value)
+      })
+
+      // Add the get handlers only if the user hasn't disabled the disableNoResponse setting
+      if (!platform.config.disableNoResponse) {
+        gdService.getCharacteristic(this.hapChar.CurrentDoorState).onGet(() => {
+          if (!this.isOnline) {
+            throw new this.hapErr(-70402)
+          }
+          return gdService.getCharacteristic(this.hapChar.CurrentDoorState).value
+        })
+        gdService.getCharacteristic(this.hapChar.TargetDoorState).onGet(() => {
+          if (!this.isOnline) {
+            throw new this.hapErr(-70402)
+          }
+          return gdService.getCharacteristic(this.hapChar.TargetDoorState).value
+        })
+      }
+    })
+
+    // 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: 'garage_four',
+    })
+    this.log('[%s] %s %s.', this.name, this.lang.devInitOpts, opts)
+  }
+
+  async internalStateUpdate(garage, value) {
+    try {
+      let garageChannel
+      switch (garage) {
+        case 'A':
+          garageChannel = 0
+          break
+        case 'B':
+          garageChannel = 1
+          break
+        case 'C':
+          garageChannel = 2
+          break
+        case 'D':
+          garageChannel = 3
+          break
+        default:
+          return
+      }
+      const prevState = this.accessory.context.cacheStates[garageChannel].cacheCurrentDoorState
+      if (value === prevState % 2) {
+        return
+      }
+      const gdService = this.accessory.getService(`Garage ${garage}`)
+      this.inUse = true
+      const updateKey = generateRandomString(5)
+      this.updateKey = updateKey
+      gdService.updateCharacteristic(this.hapChar.TargetDoorState, value)
+      gdService.updateCharacteristic(this.hapChar.CurrentDoorState, value + 2)
+      this.accessory.context.cacheStates[garageChannel].cacheTargetDoorState = value
+      this.accessory.context.cacheStates[garageChannel].cacheCurrentDoorState = value + 2
+      const params = {
+        switches: [
+          {
+            switch: 'on',
+            outlet: garageChannel,
+          },
+        ],
+      }
+      await this.platform.sendDeviceUpdate(this.accessory, params)
+      await sleep(2000)
+      this.inUse = false
+      const operationTime = value === 0 ? this.operationTimeUp : this.operationTimeDown
+      await sleep(Math.max((operationTime - 20) * 100, 0))
+      if (this.updateKey !== updateKey) {
+        return
+      }
+      gdService.updateCharacteristic(this.hapChar.CurrentDoorState, value)
+      this.accessory.context.cacheStates[garageChannel].cacheCurrentDoorState = value
+      if (this.enableLogging) {
+        this.log(
+          '[%s] %s [garage %s %s].',
+          this.name,
+          this.lang.curState,
+          garageChannel,
+          value === 0 ? this.lang.doorOpen : this.lang.doorClosed,
+        )
+      }
+    } catch (err) {
+      this.inUse = false
+      this.platform.deviceUpdateError(this.accessory, err, true)
+      const gdService = this.accessory.getService(`Garage ${garage}`)
+      setTimeout(() => {
+        gdService.updateCharacteristic(
+          this.hapChar.TargetDoorState,
+          this.accessory.context.cacheTargetDoorState,
+        )
+      }, 2000)
+      gdService.updateCharacteristic(this.hapChar.TargetDoorState, new this.hapErr(-70402))
+    }
+  }
+
+  markStatus(isOnline) {
+    this.isOnline = isOnline
+  }
+}

package/lib/device/simulation/garage-od-switch.js

@@ -0,0 +1,36 @@
+export default class {
+  constructor(platform, accessory, devicesInHB) {
+    // Set up variables from the platform
+    this.hapChar = platform.api.hap.Characteristic
+    this.hapServ = platform.api.hap.Service
+    this.platform = platform
+
+    // Set up variables from the accessory
+    this.accessory = accessory
+
+    // Set up custom variables for this device type
+    const garageId = platform.obstructSwitches[accessory.context.eweDeviceId]
+
+    // Check the garage door exists in Homebridge
+    const uuid = platform.api.hap.uuid.generate(`${garageId}SWX`)
+    if (!devicesInHB.has(uuid)) {
+      // Can't find garage so throw an error
+      throw new Error(platform.lang.noGarageForOD)
+    } else {
+      // Get the garage door accessory
+      this.gService = devicesInHB.get(uuid).getService(this.hapServ.GarageDoorOpener)
+    }
+  }
+
+  async externalUpdate(params) {
+    try {
+      if (!params.switch || params.switch === this.cacheState || !this.gService) {
+        return
+      }
+      this.gService.updateCharacteristic(this.hapChar.ObstructionDetected, params.switch === 'on')
+      this.cacheState = params.switch
+    } catch (err) {
+      this.platform.deviceUpdateError(this.accessory, err, false)
+    }
+  }
+}