@homebridge-plugins/homebridge-ewelink 12.3.3

package/lib/device/index.js

@@ -0,0 +1,61 @@
+import deviceCurtain from './curtain.js'
+import deviceDiffuser from './diffuser.js'
+import deviceFan from './fan.js'
+import deviceGroup from './group.js'
+import deviceHumidifier from './humidifier.js'
+import deviceLightCCT from './light-cct.js'
+import deviceLightDimmer from './light-dimmer.js'
+import deviceLightRGB from './light-rgb.js'
+import deviceLightRGBCCT from './light-rgb-cct.js'
+import deviceMotor from './motor.js'
+import deviceOutletMulti from './outlet-multi.js'
+import deviceOutletSingle from './outlet-single.js'
+import deviceOutletSingleInched from './outlet-single-inched.js'
+import devicePanel from './panel.js'
+import deviceRfBridge from './rf-bridge.js'
+import deviceRfButton from './rf-button.js'
+import deviceRfSensor from './rf-sensor.js'
+import deviceSensorAmbient from './sensor-ambient.js'
+import deviceSensorContact from './sensor-contact.js'
+import deviceSensorTempHumi from './sensor-temp-humi.js'
+import sim from './simulation/index.js'
+import deviceSwitchMan from './switch-man.js'
+import deviceSwitchMate from './switch-mate.js'
+import deviceSwitchMulti from './switch-multi.js'
+import deviceSwitchSingle from './switch-single.js'
+import deviceSwitchSingleInched from './switch-single-inched.js'
+import deviceTemplate from './template.js'
+import deviceThermostat from './thermostat.js'
+import zb from './zigbee/index.js'
+
+export default {
+  deviceCurtain,
+  deviceDiffuser,
+  deviceFan,
+  deviceGroup,
+  deviceHumidifier,
+  deviceLightCCT,
+  deviceLightDimmer,
+  deviceLightRGB,
+  deviceLightRGBCCT,
+  deviceMotor,
+  deviceOutletMulti,
+  deviceOutletSingle,
+  deviceOutletSingleInched,
+  devicePanel,
+  deviceRfBridge,
+  deviceRfButton,
+  deviceRfSensor,
+  deviceSensorAmbient,
+  deviceSensorContact,
+  deviceSensorTempHumi,
+  deviceSwitchMan,
+  deviceSwitchMate,
+  deviceSwitchMulti,
+  deviceSwitchSingle,
+  deviceSwitchSingleInched,
+  deviceTemplate,
+  deviceThermostat,
+  sim,
+  zb,
+}

package/lib/device/light-cct.js

@@ -0,0 +1,333 @@
+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.deviceModel = deviceConf.deviceModel || 'bulbB02FA60'
+    this.alShift = deviceConf.adaptiveLightingShift || platformConsts.defaultValues.adaptiveLightingShift
+    this.brightStep = deviceConf.brightnessStep
+      ? Math.min(deviceConf.brightnessStep, 100)
+      : platformConsts.defaultValues.brightnessStep
+    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
+    }
+
+    // Different bulbs have different colour temperature ranges
+    switch (this.deviceModel) {
+      case 'bulbB02FST64':
+        this.minK = 1800
+        this.maxK = 5000
+        break
+      case 'bulbB02BA60':
+        this.minK = 2700
+        this.maxK = 6500
+        break
+      default:
+        this.minK = 2200
+        this.maxK = 6500
+        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)
+
+    // If adaptive lighting has just been disabled then remove and re-add service to hide AL icon
+    if (this.alShift === -1 && this.accessory.context.adaptiveLighting) {
+      this.accessory.removeService(this.service)
+      this.service = this.accessory.addService(this.hapServ.Lightbulb)
+      this.accessory.context.adaptiveLighting = false
+    }
+
+    // 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: this.brightStep })
+      .onSet(async value => this.internalBrightnessUpdate(value))
+
+    // Add the set handler to the lightbulb colour temperature characteristic
+    this.service
+      .getCharacteristic(this.hapChar.ColorTemperature)
+      .onSet(async value => this.internalCTUpdate(value))
+
+    // This is needed as sometimes we need to send the brightness with a cct update
+    this.cacheBright = this.service.getCharacteristic(this.hapChar.Brightness).value
+
+    // Set up the adaptive lighting controller if not disabled by user
+    if (this.alShift !== -1) {
+      this.accessory.alController = new platform.api.hap.AdaptiveLightingController(this.service, {
+        customTemperatureAdjustment: this.alShift,
+      })
+      this.accessory.configureController(this.accessory.alController)
+    }
+
+    // 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.ColorTemperature).onGet(() => {
+        if (!this.isOnline) {
+          throw new this.hapErr(-70402)
+        }
+        return this.service.getCharacteristic(this.hapChar.ColorTemperature).value
+      })
+    }
+
+    // Output the customised options to the log
+    const normalLogging = this.enableLogging ? 'standard' : 'disable'
+    const opts = JSON.stringify({
+      adaptiveLightingShift: this.alShift,
+      brightnessStep: this.brightStep,
+      deviceModel: this.deviceModel,
+      logging: this.enableDebugLogging ? 'debug' : normalLogging,
+      offlineAsOff: !!this.offlineAsOff,
+    })
+    this.log('[%s] %s %s.', this.name, this.lang.devInitOpts, opts)
+  }
+
+  async internalStateUpdate(value) {
+    try {
+      const newValue = value ? 'on' : 'off'
+      if (this.cacheState === newValue) {
+        return
+      }
+      const timerKey = generateRandomString(5)
+      this.updateTimeout = timerKey
+      setTimeout(() => {
+        if (this.updateTimeout === timerKey) {
+          this.updateTimeout = false
+        }
+      }, 5000)
+      await this.platform.sendDeviceUpdate(this.accessory, {
+        switch: newValue,
+      })
+      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 {
+      if (this.cacheBright === value) {
+        return
+      }
+      const updateKey = generateRandomString(5)
+      this.updateKeyBright = updateKey
+      await sleep(500)
+      if (updateKey !== this.updateKeyBright) {
+        return
+      }
+      this.updateTimeout = updateKey
+      setTimeout(() => {
+        if (this.updateTimeout === updateKey) {
+          this.updateTimeout = false
+        }
+      }, 5000)
+      const params = {
+        white: {
+          br: value,
+          ct: this.cacheCT,
+        },
+      }
+      await this.platform.sendDeviceUpdate(this.accessory, params)
+      this.cacheBright = value
+      if (this.enableLogging) {
+        this.log('[%s] %s [%s%].', this.name, this.lang.curBright, this.cacheBright)
+      }
+    } 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 internalCTUpdate(value) {
+    try {
+      if (this.cacheMired === value) {
+        return
+      }
+      if (
+        this.accessory.alController
+        && this.accessory.alController.isAdaptiveLightingActive()
+        && (this.cacheState !== 'on' || !this.isOnline)
+      ) {
+        return
+      }
+      const updateKey = generateRandomString(5)
+      this.updateKeyCT = updateKey
+      await sleep(400)
+      if (updateKey !== this.updateKeyCT) {
+        return
+      }
+      this.updateTimeout = updateKey
+      setTimeout(() => {
+        if (this.updateTimeout === updateKey) {
+          this.updateTimeout = false
+        }
+      }, 5000)
+      const kelvin = Math.round(1000000 / value)
+      const scaledK = Math.max(Math.min(kelvin, this.maxK), this.minK)
+      const scaledCT = Math.round(((scaledK - this.minK) / (this.maxK - this.minK)) * 255)
+      const params = {
+        white: {
+          br: this.cacheBright,
+          ct: scaledCT,
+        },
+      }
+      await this.platform.sendDeviceUpdate(this.accessory, params)
+      this.cacheMired = value
+      this.cacheCT = scaledCT
+      if (this.enableLogging) {
+        if (this.accessory.alController && this.accessory.alController.isAdaptiveLightingActive()) {
+          this.log('[%s] %s [%sK] %s.', this.name, this.lang.curColour, scaledK, this.lang.viaAL)
+        } else {
+          this.log('[%s] %s [%sK].', this.name, this.lang.curColour, scaledK)
+        }
+      }
+    } catch (err) {
+      this.platform.deviceUpdateError(this.accessory, err, true)
+      setTimeout(() => {
+        this.service.updateCharacteristic(this.hapChar.ColorTemperature, this.cacheMired)
+      }, 2000)
+      throw new this.hapErr(-70402)
+    }
+  }
+
+  async externalUpdate(params) {
+    try {
+      if (this.updateTimeout) {
+        return
+      }
+      if (params.switch && params.switch !== this.cacheState) {
+        this.cacheState = params.switch
+        this.service.updateCharacteristic(this.hapChar.On, this.cacheState === 'on')
+        if (params.updateSource && this.enableLogging) {
+          this.log('[%s] %s [%s].', this.name, this.lang.curState, this.cacheState)
+        }
+      }
+      if (params.white) {
+        if (hasProperty(params.white, 'br') && this.cacheBright !== params.white.br) {
+          this.cacheBright = params.white.br
+          this.service.updateCharacteristic(this.hapChar.Brightness, this.cacheBright)
+          if (params.updateSource && this.enableLogging) {
+            this.log('[%s] %s [%s%].', this.name, this.lang.curBright, this.cacheBright)
+          }
+        }
+        if (hasProperty(params.white, 'ct') && this.cacheCT !== params.white.ct) {
+          const ctDiff = Math.abs(params.white.ct - this.cacheCT)
+          this.cacheCT = params.white.ct
+          const kelvin = (this.cacheCT / 255) * (this.maxK - this.minK) + this.minK
+          const scaledK = Math.round(kelvin)
+          this.cacheMired = Math.min(Math.max(Math.round(1000000 / scaledK), 140), 500)
+          this.service.updateCharacteristic(this.hapChar.ColorTemperature, this.cacheMired)
+          if (params.updateSource) {
+            if (this.enableLogging) {
+              this.log('[%s] %s [%sK].', this.name, this.lang.curColour, scaledK)
+            }
+            if (
+              this.accessory.alController
+              && this.accessory.alController.isAdaptiveLightingActive()
+              && ctDiff > 20
+            ) {
+              // Look for a variation greater than twenty
+              this.accessory.alController.disableAdaptiveLighting()
+              if (this.enableLogging) {
+                this.log('[%s] %s.', this.name, this.lang.disabledAL)
+              }
+            }
+          }
+        }
+      }
+    } 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,
+      colourtemperature: this.service.getCharacteristic(this.hapChar.ColorTemperature).value,
+      adaptivelighting:
+        this.accessory.alController && this.accessory.alController.isAdaptiveLightingActive()
+          ? 'on'
+          : 'off',
+    }
+    return toReturn
+  }
+}

package/lib/device/light-dimmer.js

@@ -0,0 +1,257 @@
+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.brightStep = deviceConf.brightnessStep
+      ? Math.min(deviceConf.brightnessStep, 100)
+      : platformConsts.defaultValues.brightnessStep
+    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
+    }
+
+    // Remove any fan services from a similation
+    if (accessory.getService(this.hapServ.Fan)) {
+      accessory.removeService(accessory.getService(this.hapServ.Fan))
+    }
+
+    // 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: this.brightStep })
+      .onSet(async value => this.internalBrightnessUpdate(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
+      })
+    }
+
+    // Output the customised options to the log
+    const normalLogging = this.enableLogging ? 'standard' : 'disable'
+    const opts = JSON.stringify({
+      brightnessStep: this.brightStep,
+      logging: this.enableDebugLogging ? 'debug' : normalLogging,
+      offlineAsOff: !!this.offlineAsOff,
+    })
+    this.log('[%s] %s %s.', this.name, this.lang.devInitOpts, opts)
+  }
+
+  async internalStateUpdate(value) {
+    try {
+      const newValue = value ? 'on' : 'off'
+      if (this.cacheState === newValue) {
+        return
+      }
+      const params = {}
+      switch (this.accessory.context.eweUIID) {
+        case 36:
+        case 44:
+          // KING-M4, D1
+          params.switch = newValue
+          break
+        case 57:
+          params.state = newValue
+          break
+        default:
+          return
+      }
+      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 {
+      if (this.cacheBright === value) {
+        return
+      }
+      const updateKey = generateRandomString(5)
+      this.updateKeyBright = updateKey
+      await sleep(500)
+      if (updateKey !== this.updateKeyBright) {
+        return
+      }
+      const params = {}
+      switch (this.accessory.context.eweUIID) {
+        case 36:
+          params.bright = Math.round((value * 9) / 10 + 10)
+          // KING-M4 eWeLink scale is 10-100 and HomeKit scale is 0-100
+          break
+        case 44:
+          params.brightness = value
+          // D1 eWeLink scale matches HomeKit scale of 0-100
+          params.mode = 0
+          break
+        case 57:
+          params.channel0 = Math.round((value * 23) / 10 + 25).toString()
+          // Device eWeLink scale is 25-255 and HomeKit scale is 0-100.
+          break
+        default:
+          return
+      }
+      await this.platform.sendDeviceUpdate(this.accessory, params)
+      this.cacheBright = value
+      if (this.enableLogging) {
+        this.log('[%s] %s [%s%].', this.name, this.lang.curBright, this.cacheBright)
+      }
+    } 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 externalUpdate(params) {
+    try {
+      if (this.accessory.context.eweUIID === 57) {
+        if (params.state && params.state !== this.cacheState) {
+          this.service.updateCharacteristic(this.hapChar.On, params.state === 'on')
+          this.cacheState = params.state
+          if (params.updateSource && this.enableLogging) {
+            this.log('[%s] %s [%s].', this.name, this.lang.curState, this.cacheState)
+          }
+        }
+      } else if (params.switch && params.switch !== this.cacheState) {
+        this.service.updateCharacteristic(this.hapChar.On, params.switch === 'on')
+        this.cacheState = params.switch
+        if (params.updateSource && this.enableLogging) {
+          this.log('[%s] %s [%s].', this.name, this.lang.curState, this.cacheState)
+        }
+      }
+
+      switch (this.accessory.context.eweUIID) {
+        case 36:
+          // KING-M4 eWeLink scale is 10-100 and HomeKit scale is 0-100.
+          if (hasProperty(params, 'bright')) {
+            const nb = Math.round(((params.bright - 10) * 10) / 9)
+            if (nb !== this.cacheBright) {
+              this.service.updateCharacteristic(this.hapChar.Brightness, nb)
+              this.cacheBright = nb
+              if (params.updateSource && this.enableLogging) {
+                this.log('[%s] %s [%s%].', this.name, this.lang.curBright, nb)
+              }
+            }
+          }
+          break
+        case 44:
+          // D1 eWeLink scale matches HomeKit scale of 0-100
+          if (hasProperty(params, 'brightness')) {
+            const nb = params.brightness
+            if (nb !== this.cacheBright) {
+              this.service.updateCharacteristic(this.hapChar.Brightness, nb)
+              this.cacheBright = nb
+              if (params.updateSource && this.enableLogging) {
+                this.log('[%s] %s [%s%].', this.name, this.lang.curBright, nb)
+              }
+            }
+          }
+          break
+        case 57:
+          // Device eWeLink scale is 25-255 and HomeKit scale is 0-100.
+          if (hasProperty(params, 'channel0')) {
+            const nb = Math.round(((Number.parseInt(params.channel0, 10) - 25) * 10) / 23)
+            if (nb !== this.cacheBright) {
+              this.service.updateCharacteristic(this.hapChar.Brightness, nb)
+              this.cacheBright = nb
+              if (params.updateSource && this.enableLogging) {
+                this.log('[%s] %s [%s%].', this.name, this.lang.curBright, nb)
+              }
+            }
+          }
+          break
+        default:
+      }
+    } 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,
+    }
+    return toReturn
+  }
+}