@homebridge-plugins/homebridge-ewelink 12.3.3

package/lib/device/light-rgb.js

@@ -0,0 +1,272 @@
+import { hs2rgb, rgb2hs } from '../utils/colour.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.offlineAsOff = deviceConf.offlineAsOff
+
+    // 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 lightbulb service if it doesn't already exist
+    this.service = this.accessory.getService(this.hapServ.Lightbulb)
+    || this.accessory.addService(this.hapServ.Lightbulb)
+
+    // Add the set handler to the lightbulb on/off characteristic
+    this.service
+      .getCharacteristic(this.hapChar.On)
+      .onSet(async value => this.internalStateUpdate(value))
+
+    // Add the set handler to the lightbulb brightness characteristic
+    this.service
+      .getCharacteristic(this.hapChar.Brightness)
+      .setProps({ minStep: 100 })
+      .onSet(async value => this.internalBrightnessUpdate(value))
+
+    // Add the set handler to the lightbulb hue characteristic
+    this.service
+      .getCharacteristic(this.hapChar.Hue)
+      .onSet(async value => this.internalColourUpdate(value))
+    this.cacheSat = this.service.getCharacteristic(this.hapChar.Saturation).value
+
+    // Add the get handlers only if the user hasn't disabled the disableNoResponse setting
+    if (!platform.config.disableNoResponse) {
+      this.service.getCharacteristic(this.hapChar.On).onGet(() => {
+        if (!this.isOnline) {
+          throw new this.hapErr(-70402)
+        }
+        return this.service.getCharacteristic(this.hapChar.On).value
+      })
+      this.service
+        .getCharacteristic(this.hapChar.Brightness)
+        .onGet(() => {
+          if (!this.isOnline) {
+            throw new this.hapErr(-70402)
+          }
+          return this.service.getCharacteristic(this.hapChar.Brightness).value
+        })
+      this.service.getCharacteristic(this.hapChar.Hue).onGet(() => {
+        if (!this.isOnline) {
+          throw new this.hapErr(-70402)
+        }
+        return this.service.getCharacteristic(this.hapChar.Hue).value
+      })
+    }
+
+    // Output the customised options to the log
+    const normalLogging = this.enableLogging ? 'standard' : 'disable'
+    const opts = JSON.stringify({
+      logging: this.enableDebugLogging ? 'debug' : normalLogging,
+      offlineAsOff: !!this.offlineAsOff,
+    })
+    this.log('[%s] %s %s.', this.name, this.lang.devInitOpts, opts)
+  }
+
+  async internalStateUpdate(value) {
+    try {
+      const params = {}
+      const newValue = value ? 'on' : 'off'
+      if (this.cacheState === newValue) {
+        return
+      }
+      params.state = newValue
+      const timerKey = generateRandomString(5)
+      this.updateTimeout = timerKey
+      setTimeout(() => {
+        if (this.updateTimeout === timerKey) {
+          this.updateTimeout = false
+        }
+      }, 5000)
+      await this.platform.sendDeviceUpdate(this.accessory, params)
+      this.cacheState = newValue
+      if (this.enableLogging) {
+        this.log('[%s] %s [%s].', this.name, this.lang.curState, this.cacheState)
+      }
+    } catch (err) {
+      this.platform.deviceUpdateError(this.accessory, err, true)
+      setTimeout(() => {
+        this.service.updateCharacteristic(this.hapChar.On, this.cacheState === 'on')
+      }, 2000)
+      throw new this.hapErr(-70402)
+    }
+  }
+
+  async internalBrightnessUpdate(value) {
+    try {
+      // B1 doesn't support brightness
+      this.cacheBright = value
+    } catch (err) {
+      this.platform.deviceUpdateError(this.accessory, err, true)
+      setTimeout(() => {
+        this.service.updateCharacteristic(this.hapChar.Brightness, this.cacheBright)
+      }, 2000)
+      throw new this.hapErr(-70402)
+    }
+  }
+
+  async internalColourUpdate(value) {
+    try {
+      if (this.cacheHue === value) {
+        return
+      }
+      const updateKeyColour = generateRandomString(5)
+      this.updateKeyColour = updateKeyColour
+      await sleep(400)
+      if (updateKeyColour !== this.updateKeyColour) {
+        return
+      }
+      this.updateTimeout = updateKeyColour
+      setTimeout(() => {
+        if (this.updateTimeout === updateKeyColour) {
+          this.updateTimeout = false
+        }
+      }, 5000)
+      const saturation = this.service.getCharacteristic(this.hapChar.Saturation).value
+      const newRGB = hs2rgb(value, saturation)
+      const params = {
+        zyx_mode: 2,
+        type: 'middle',
+        channel0: '0',
+        channel1: '0',
+        channel2: newRGB[0].toString(),
+        channel3: newRGB[1].toString(),
+        channel4: newRGB[2].toString(),
+      }
+      await this.platform.sendDeviceUpdate(this.accessory, params)
+      this.cacheHue = value;
+      [this.cacheR, this.cacheG, this.cacheB] = newRGB
+      if (this.enableLogging) {
+        this.log(
+          '[%s] %s [rgb %s].',
+          this.name,
+          this.lang.curColour,
+          `${this.cacheR} ${this.cacheG} ${this.cacheB}`,
+        )
+      }
+    } catch (err) {
+      this.platform.deviceUpdateError(this.accessory, err, true)
+      setTimeout(() => {
+        this.service.updateCharacteristic(this.hapChar.Hue, this.cacheHue)
+      }, 2000)
+      throw new this.hapErr(-70402)
+    }
+  }
+
+  async externalUpdate(params) {
+    try {
+      if (this.updateTimeout) {
+        return
+      }
+      if (params.state && params.state !== this.cacheState) {
+        this.cacheState = params.state
+        this.service.updateCharacteristic(this.hapChar.On, this.cacheState === 'on')
+        this.service.updateCharacteristic(
+          this.hapChar.Brightness,
+          this.cacheState === 'on' ? 100 : 0,
+        )
+        if (params.updateSource && this.enableLogging) {
+          this.log('[%s] %s [%s].', this.name, this.lang.curState, this.cacheState)
+        }
+      }
+      let hs
+      let mode
+      if (params.zyx_mode) {
+        mode = Number.parseInt(params.zyx_mode, 10)
+      } else if (
+        hasProperty(params, 'channel0')
+        && Number.parseInt(params.channel0, 10) + Number.parseInt(params.channel1, 10) > 0
+      ) {
+        mode = 1
+      } else {
+        mode = 2
+      }
+      if (mode === 2) {
+        if (hasProperty(params, 'channel2')) {
+          if (
+            params.channel2 !== (this.cacheR || 0).toString()
+            || params.channel3 !== (this.cacheG || 0).toString()
+            || params.channel4 !== (this.cacheB || 0).toString()
+          ) {
+            this.cacheR = Number.parseInt(params.channel2, 10)
+            this.cacheG = Number.parseInt(params.channel3, 10)
+            this.cacheB = Number.parseInt(params.channel4, 10)
+            hs = rgb2hs(this.cacheR, this.cacheG, this.cacheB);
+            [this.cacheHue] = hs
+            this.service.updateCharacteristic(this.hapChar.Hue, this.cacheHue)
+            this.service.updateCharacteristic(this.hapChar.Saturation, 100)
+            this.service.updateCharacteristic(this.hapChar.Brightness, 100)
+            if (params.updateSource && this.enableLogging) {
+              this.log(
+                '[%s] %s [rgb %s].',
+                this.name,
+                this.lang.curColour,
+                `${this.cacheR} ${this.cacheG} ${this.cacheB}`,
+              )
+            }
+          }
+        }
+      }
+    } catch (err) {
+      this.platform.deviceUpdateError(this.accessory, err, false)
+    }
+  }
+
+  markStatus(isOnline) {
+    this.isOnline = isOnline
+
+    // Show as off if offlineAsOff is enabled
+    if (this.offlineAsOff && !isOnline && this.cacheState !== 'off') {
+      this.service.updateCharacteristic(this.hapChar.On, false)
+      this.cacheState = 'off'
+      if (this.enableLogging) {
+        this.log('[%s] %s [%s - offline]', this.name, this.lang.curState, this.cacheState)
+      }
+    }
+  }
+
+  currentState() {
+    const toReturn = {}
+    toReturn.services = ['light']
+    toReturn.light = {
+      state: this.service.getCharacteristic(this.hapChar.On).value ? 'on' : 'off',
+      brightness: this.service.getCharacteristic(this.hapChar.Brightness).value,
+      hue: this.service.getCharacteristic(this.hapChar.Hue).value,
+      saturation: this.service.getCharacteristic(this.hapChar.Saturation).value,
+    }
+    return toReturn
+  }
+}

package/lib/device/motor.js

@@ -0,0 +1,363 @@
+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
+
+    /*
+      This is for the DUALR3 using motor mode
+      This device's parameters are:
+      motorTurn: 1=OPEN, 0=STOP, 2=CLOSE (not needed by plugin)
+      location: 0=CLOSED, 100=OPEN
+      currLocation: 0=CLOSED, 100=OPEN
+    */
+
+    // Set up custom variables for this device type
+    const deviceConf = platform.deviceConf[accessory.context.eweDeviceId] || {}
+    const showAsMotor = deviceConf.showAsMotor || platformConsts.defaultValues.showAsMotor
+
+    // 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 window covering service if it doesn't already exist
+    let service
+    switch (showAsMotor) {
+      case 'door':
+        service = this.hapServ.Door
+        if (this.accessory.getService(this.hapServ.GarageDoorOpener)) {
+          this.accessory.removeService(this.accessory.getService(this.hapServ.GarageDoorOpener))
+        }
+        if (this.accessory.getService(this.hapServ.Window)) {
+          this.accessory.removeService(this.accessory.getService(this.hapServ.Window))
+        }
+        if (this.accessory.getService(this.hapServ.WindowCovering)) {
+          this.accessory.removeService(this.accessory.getService(this.hapServ.WindowCovering))
+        }
+        break
+      case 'garage':
+        service = this.hapServ.GarageDoorOpener
+        this.isGarage = true
+        if (this.accessory.getService(this.hapServ.Door)) {
+          this.accessory.removeService(this.accessory.getService(this.hapServ.Door))
+        }
+        if (this.accessory.getService(this.hapServ.Window)) {
+          this.accessory.removeService(this.accessory.getService(this.hapServ.Window))
+        }
+        if (this.accessory.getService(this.hapServ.WindowCovering)) {
+          this.accessory.removeService(this.accessory.getService(this.hapServ.WindowCovering))
+        }
+        break
+      case 'window':
+        service = this.hapServ.Window
+        if (this.accessory.getService(this.hapServ.Door)) {
+          this.accessory.removeService(this.accessory.getService(this.hapServ.Door))
+        }
+        if (this.accessory.getService(this.hapServ.GarageDoorOpener)) {
+          this.accessory.removeService(this.accessory.getService(this.hapServ.GarageDoorOpener))
+        }
+        if (this.accessory.getService(this.hapServ.WindowCovering)) {
+          this.accessory.removeService(this.accessory.getService(this.hapServ.WindowCovering))
+        }
+        break
+      default:
+        service = this.hapServ.WindowCovering
+        if (this.accessory.getService(this.hapServ.Door)) {
+          this.accessory.removeService(this.accessory.getService(this.hapServ.Door))
+        }
+        if (this.accessory.getService(this.hapServ.GarageDoorOpener)) {
+          this.accessory.removeService(this.accessory.getService(this.hapServ.GarageDoorOpener))
+        }
+        if (this.accessory.getService(this.hapServ.Window)) {
+          this.accessory.removeService(this.accessory.getService(this.hapServ.Window))
+        }
+        break
+    }
+    this.service = this.accessory.getService(service) || this.accessory.addService(service)
+
+    // Add Eve power characteristics
+    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
+    if (this.isGarage) {
+      this.service
+        .getCharacteristic(this.hapChar.TargetDoorState)
+        .onSet(async value => this.internalTargetUpdate(value))
+    } else {
+      this.service
+        .getCharacteristic(this.hapChar.TargetPosition)
+        .onSet(async value => this.internalPositionUpdate(value))
+    }
+
+    // Add the get handlers only if the user hasn't disabled the disableNoResponse setting
+    if (!platform.config.disableNoResponse) {
+      if (this.isGarage) {
+        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
+        })
+      } else {
+        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
+        })
+      }
+    }
+
+    if (platform.config.mode !== 'lan') {
+      // Set up an interval to get eWeLink to send power updates
+      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,
+      showAsMotor,
+    })
+    this.log('[%s] %s %s.', this.name, this.lang.devInitOpts, opts)
+  }
+
+  async internalPositionUpdate(value) {
+    try {
+      if (this.cachePos === value) {
+        return
+      }
+      const updateKey = generateRandomString(5)
+      this.updateKey = updateKey
+      await sleep(500)
+      if (updateKey !== this.updateKey) {
+        return
+      }
+      const params = { location: value }
+      await this.platform.sendDeviceUpdate(this.accessory, params)
+      this.cacheTarg = value
+      if (this.enableLogging) {
+        this.log('[%s] %s [%s%].', this.name, this.lang.curTarg, this.cacheTarg)
+      }
+    } catch (err) {
+      // Catch any errors and let the platform display them
+      this.platform.deviceUpdateError(this.accessory, err, true)
+      setTimeout(() => {
+        this.service.updateCharacteristic(this.hapChar.TargetPosition, this.cacheTarg)
+      }, 2000)
+      throw new this.hapErr(-70402)
+    }
+  }
+
+  async internalTargetUpdate(value) {
+    try {
+      // 0 for open, 1 for closed
+      // this.cachePos is 0 for closed and >0 for open
+
+      const params = { location: value === 1 ? 0 : 100 }
+      await this.platform.sendDeviceUpdate(this.accessory, params)
+      this.cacheTarg = value === 1 ? 0 : 100
+      if (this.enableLogging) {
+        this.log('[%s] %s [%s%].', this.name, this.lang.curTarg, this.cacheTarg)
+      }
+    } catch (err) {
+      // Catch any errors and let the platform display them
+      this.platform.deviceUpdateError(this.accessory, err, true)
+      setTimeout(() => {
+        this.service.updateCharacteristic(this.hapChar.TargetDoorState, this.cacheTarg)
+      }, 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 } })
+    } catch (err) {
+      this.log.error(err)
+    }
+  }
+
+  async externalUpdate(params) {
+    try {
+      let locationParams = false
+
+      // currLocation is the current position of the motor
+      if (hasProperty(params, 'currLocation')) {
+        locationParams = true
+        if (params.currLocation !== this.cachePos) {
+          this.cachePos = params.currLocation
+          if (!this.isGarage) {
+            this.service.updateCharacteristic(this.hapChar.CurrentPosition, this.cachePos)
+          }
+          if (params.updateSource && this.enableLogging) {
+            this.log('[%s] %s [%s%].', this.name, this.lang.curPos, this.cachePos)
+          }
+        }
+      }
+
+      // location is the target position of the motor
+      if (hasProperty(params, 'location')) {
+        locationParams = true
+        if (params.location !== this.cacheTarg) {
+          this.cacheTarg = params.location
+          if (!this.isGarage) {
+            this.service.updateCharacteristic(this.hapChar.TargetPosition, this.cacheTarg)
+          }
+          if (params.updateSource && this.enableLogging) {
+            this.log('[%s] %s [%s%].', this.name, this.lang.curTarg, this.cacheTarg)
+          }
+        }
+      }
+
+      if (locationParams) {
+        // Get the target door state characteristic for use later
+        const targetChar = this.isGarage
+          ? this.service.getCharacteristic(this.hapChar.TargetDoorState)
+          : this.service.getCharacteristic(this.hapChar.TargetPosition)
+
+        // If the two are equal then the motor must have stopped at this position
+        if (this.cacheTarg === this.cachePos) {
+          if (this.isGarage) {
+            if (this.cachePos === 0) {
+              // CLOSED
+              this.service.updateCharacteristic(this.hapChar.CurrentDoorState, 1)
+              if (targetChar.value !== 1) {
+                targetChar.updateValue(1)
+              }
+            } else {
+              // OPEN
+              this.service.updateCharacteristic(this.hapChar.CurrentDoorState, 0)
+              if (targetChar.value !== 0) {
+                targetChar.updateValue(0)
+              }
+            }
+          } else {
+            // PositionState 2 === STOPPED
+            this.service.updateCharacteristic(this.hapChar.PositionState, 2)
+          }
+        } else if (this.cacheTarg > this.cachePos) {
+          if (this.isGarage) {
+            // OPENING
+            this.service.updateCharacteristic(this.hapChar.CurrentDoorState, 2)
+            if (targetChar.value !== 0) {
+              targetChar.updateValue(0)
+            }
+          } else {
+            // PositionState 1 === INCREASING
+            this.service.updateCharacteristic(this.hapChar.PositionState, 1)
+          }
+        } else if (this.isGarage) {
+          // CLOSING
+          this.service.updateCharacteristic(this.hapChar.CurrentDoorState, 3)
+          if (targetChar.value !== 1) {
+            targetChar.updateValue(1)
+          }
+        } else {
+          // PositionState 0 === DECREASING
+          this.service.updateCharacteristic(this.hapChar.PositionState, 0)
+        }
+      }
+
+      // Update power information if given
+      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) {
+      // Catch any errors and let the platform display them
+      this.platform.deviceUpdateError(this.accessory, err, false)
+    }
+  }
+
+  markStatus(isOnline) {
+    this.isOnline = isOnline
+  }
+}