@homebridge-plugins/homebridge-ewelink 12.3.3

package/lib/device/zigbee/sensor-leak.js

@@ -0,0 +1,119 @@
+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
+    this.sensorTimeDifference = deviceConf.sensorTimeDifference || platformConsts.defaultValues.sensorTimeDifference
+
+    // 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 leak sensor service if it doesn't already exist
+    this.service = this.accessory.getService(this.hapServ.LeakSensor)
+    if (!this.service) {
+      this.service = this.accessory.addService(this.hapServ.LeakSensor)
+      this.service.addCharacteristic(this.eveChar.LastActivation)
+    }
+
+    // Add the battery service if it doesn't already exist
+    this.battService = 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('motion', this.accessory, {
+      log: () => {},
+    })
+
+    // 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,
+      sensorTimeDifference: this.sensorTimeDifference,
+    })
+    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
+        this.cacheBattScaled = Math.max(Math.min(this.cacheBatt, 100), 0)
+        this.battService.updateCharacteristic(this.hapChar.BatteryLevel, this.cacheBattScaled)
+        this.battService.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 (
+        hasProperty(params, 'water')
+        && hasProperty(params, 'trigTime')
+        && this.cacheState !== params.water
+      ) {
+        this.cacheState = params.water
+        const timeDiff = (new Date().getTime() - params.trigTime) / 1000
+        const leakDetected = !!(
+          params.updateSource
+          && params.water === 1
+          && timeDiff < this.sensorTimeDifference
+        )
+        this.service.updateCharacteristic(this.hapChar.LeakDetected, leakDetected ? 1 : 0)
+        if (leakDetected) {
+          const initialTime = this.accessory.eveService.getInitialTime()
+          this.service.updateCharacteristic(
+            this.eveChar.LastActivation,
+            Math.round(new Date().valueOf() / 1000) - initialTime,
+          )
+        }
+        this.accessory.eveService.addEntry({ status: leakDetected ? 1 : 0 })
+        if (params.updateSource && this.enableLogging) {
+          this.log(
+            '[%s] %s [%s].',
+            this.name,
+            this.lang.curState,
+            leakDetected ? this.lang.leakYes : this.lang.leakNo,
+          )
+        }
+      }
+    } catch (err) {
+      this.platform.deviceUpdateError(this.accessory, err, false)
+    }
+  }
+}

package/lib/device/zigbee/sensor-motion.js

@@ -0,0 +1,119 @@
+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
+    this.sensorTimeDifference = deviceConf.sensorTimeDifference || platformConsts.defaultValues.sensorTimeDifference
+
+    // 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 motion sensor service if it doesn't already exist
+    this.service = this.accessory.getService(this.hapServ.MotionSensor)
+    if (!this.service) {
+      this.service = this.accessory.addService(this.hapServ.MotionSensor)
+      this.service.addCharacteristic(this.eveChar.LastActivation)
+    }
+
+    // Add the battery service if it doesn't already exist
+    this.battService = 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('motion', this.accessory, {
+      log: () => {},
+    })
+
+    // 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,
+      sensorTimeDifference: this.sensorTimeDifference,
+    })
+    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
+        this.cacheBattScaled = Math.max(Math.min(this.cacheBatt, 100), 0)
+        this.battService.updateCharacteristic(this.hapChar.BatteryLevel, this.cacheBattScaled)
+        this.battService.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 (
+        hasProperty(params, 'motion')
+        && hasProperty(params, 'trigTime')
+        && params.motion !== this.cacheState
+      ) {
+        this.cacheState = params.motion
+        const timeDiff = (new Date().getTime() - params.trigTime) / 1000
+        const motionDetected = !!(
+          params.updateSource
+          && params.motion === 1
+          && timeDiff < this.sensorTimeDifference
+        )
+        this.service.updateCharacteristic(this.hapChar.MotionDetected, motionDetected)
+        if (motionDetected) {
+          const initialTime = this.accessory.eveService.getInitialTime()
+          this.service.updateCharacteristic(
+            this.eveChar.LastActivation,
+            Math.round(new Date().valueOf() / 1000) - initialTime,
+          )
+        }
+        this.accessory.eveService.addEntry({ status: motionDetected ? 1 : 0 })
+        if (params.updateSource && this.enableLogging) {
+          this.log(
+            '[%s] %s [%s].',
+            this.name,
+            this.lang.curState,
+            motionDetected ? this.lang.motionYes : this.lang.motionNo,
+          )
+        }
+      }
+    } catch (err) {
+      this.platform.deviceUpdateError(this.accessory, err, false)
+    }
+  }
+}

package/lib/device/zigbee/sensor-occupancy.js

@@ -0,0 +1,119 @@
+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
+    this.sensorTimeDifference = deviceConf.sensorTimeDifference || platformConsts.defaultValues.sensorTimeDifference
+
+    // 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 occupancy sensor service if it doesn't already exist
+    this.service = this.accessory.getService(this.hapServ.OccupancySensor)
+    if (!this.service) {
+      this.service = this.accessory.addService(this.hapServ.OccupancySensor)
+      this.service.addCharacteristic(this.eveChar.LastActivation)
+    }
+
+    // Add the battery service if it doesn't already exist
+    this.battService = 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('motion', this.accessory, {
+      log: () => {},
+    })
+
+    // 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,
+      sensorTimeDifference: this.sensorTimeDifference,
+    })
+    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
+        this.cacheBattScaled = Math.max(Math.min(this.cacheBatt, 100), 0)
+        this.battService.updateCharacteristic(this.hapChar.BatteryLevel, this.cacheBattScaled)
+        this.battService.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 (
+        hasProperty(params, 'human')
+        && hasProperty(params, 'trigTime')
+        && params.occupancy !== this.cacheState
+      ) {
+        this.cacheState = params.occupancy
+        const timeDiff = (new Date().getTime() - params.trigTime) / 1000
+        const occupancyDetected = !!(
+          params.updateSource
+          && params.occupancy === 1
+          && timeDiff < this.sensorTimeDifference
+        )
+        this.service.updateCharacteristic(this.hapChar.OccupancyDetected, occupancyDetected)
+        if (occupancyDetected) {
+          const initialTime = this.accessory.eveService.getInitialTime()
+          this.service.updateCharacteristic(
+            this.eveChar.LastActivation,
+            Math.round(new Date().valueOf() / 1000) - initialTime,
+          )
+        }
+        this.accessory.eveService.addEntry({ status: occupancyDetected ? 1 : 0 })
+        if (params.updateSource && this.enableLogging) {
+          this.log(
+            '[%s] %s [%s].',
+            this.name,
+            this.lang.curState,
+            occupancyDetected ? this.lang.occupancyYes : this.lang.occupancyNo,
+          )
+        }
+      }
+    } catch (err) {
+      this.platform.deviceUpdateError(this.accessory, err, false)
+    }
+  }
+}

package/lib/device/zigbee/sensor-smoke.js

@@ -0,0 +1,96 @@
+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
+    }
+
+    // Add the smoke sensor service if it doesn't already exist
+    this.service = this.accessory.getService(this.hapServ.SmokeSensor)
+    || this.accessory.addService(this.hapServ.SmokeSensor)
+
+    // Add the battery service if it doesn't already exist
+    this.battService = this.accessory.getService(this.hapServ.Battery)
+    || this.accessory.addService(this.hapServ.Battery)
+
+    // 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,
+    })
+    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
+        this.cacheBattScaled = this.scaleBattery ? this.cacheBatt * 10 : this.cacheBatt
+        this.cacheBattScaled = Math.max(Math.min(this.cacheBattScaled, 100), 0)
+        this.battService.updateCharacteristic(this.hapChar.BatteryLevel, this.cacheBattScaled)
+        this.battService.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 (
+        hasProperty(params, 'smoke')
+        && [0, 1].includes(params.smoke)
+        && params.smoke !== this.cacheState
+      ) {
+        this.cacheState = params.smoke
+        this.service.updateCharacteristic(this.hapChar.SmokeDetected, this.cacheState)
+        if (params.updateSource && this.enableLogging) {
+          this.log(
+            '[%s] %s [%s].',
+            this.name,
+            this.lang.curState,
+            params.smoke === 0 ? this.lang.smokeYes : this.lang.smokeNo,
+          )
+        }
+      }
+    } catch (err) {
+      this.platform.deviceUpdateError(this.accessory, err, false)
+    }
+  }
+}

package/lib/device/zigbee/switch-stateless.js

@@ -0,0 +1,104 @@
+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.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.hideLongDouble = deviceConf.hideLongDouble
+    this.lowBattThreshold = deviceConf.lowBattThreshold
+      ? Math.min(deviceConf.lowBattThreshold, 100)
+      : platformConsts.defaultValues.lowBattThreshold
+    this.sensorTimeDifference = deviceConf.sensorTimeDifference || platformConsts.defaultValues.sensorTimeDifference
+
+    // 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 stateless switch service if it doesn't already exist
+    this.service = this.accessory.getService(this.hapServ.StatelessProgrammableSwitch)
+    || this.accessory.addService(this.hapServ.StatelessProgrammableSwitch)
+
+    // Hide the double and long press options if the user wants
+    if (this.hideLongDouble) {
+      this.service.getCharacteristic(this.hapChar.ProgrammableSwitchEvent).setProps({
+        validValues: [0],
+      })
+    }
+
+    // Add the battery service if it doesn't already exist
+    this.battService = this.accessory.getService(this.hapServ.Battery)
+    || this.accessory.addService(this.hapServ.Battery)
+
+    // Output the customised options to the log
+    const normalLogging = this.enableLogging ? 'standard' : 'disable'
+    const opts = JSON.stringify({
+      hideLongDouble: this.hideLongDouble,
+      logging: this.enableDebugLogging ? 'debug' : normalLogging,
+      lowBattThreshold: this.lowBattThreshold,
+      sensorTimeDifference: this.sensorTimeDifference,
+    })
+    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
+        this.cacheBattScaled = Math.max(Math.min(this.cacheBatt, 100), 0)
+        this.battService.updateCharacteristic(this.hapChar.BatteryLevel, this.cacheBattScaled)
+        this.battService.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 (
+        hasProperty(params, 'key')
+        && [0, 1, 2].includes(params.key)
+        && params.trigTime
+      ) {
+        const timeDiff = (new Date().getTime() - params.trigTime) / 1000
+        if (timeDiff < this.sensorTimeDifference) {
+          this.service.updateCharacteristic(this.hapChar.ProgrammableSwitchEvent, params.key)
+          if (params.updateSource && this.enableLogging) {
+            const doubleLong = params.key === 1 ? this.lang.buttonDouble : this.lang.buttonLong
+            const textLabel = params.key === 0 ? this.lang.buttonSingle : doubleLong
+            this.log('[%s] %s [%s].', this.name, this.lang.curState, textLabel)
+          }
+        }
+      }
+    } catch (err) {
+      this.platform.deviceUpdateError(this.accessory, err, false)
+    }
+  }
+}