@homebridge-plugins/homebridge-wemo 7.0.0

package/lib/device/motion.js

@@ -0,0 +1,148 @@
+import platformConsts from '../utils/constants.js'
+import { hasProperty, parseError } from '../utils/functions.js'
+import platformLang from '../utils/lang-en.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.platform = platform
+
+    // Set up variables from the accessory
+    this.accessory = accessory
+
+    // Set up custom variables for this device type
+    const deviceConf = platform.deviceConf[accessory.context.serialNumber] || {}
+    this.noMotionTimer = deviceConf.noMotionTimer || platformConsts.defaultValues.noMotionTimer
+
+    // Add the motion sensor service if it doesn't already exist
+    this.service = this.accessory.getService(this.hapServ.MotionSensor)
+      || this.accessory.addService(this.hapServ.MotionSensor)
+
+    // Pass the accessory to fakegato to set up the Eve info service
+    this.accessory.historyService = new platform.eveService('motion', this.accessory, {
+      log: () => {},
+    })
+
+    // Output the customised options to the log
+    const opts = JSON.stringify({
+      noMotionTimer: this.noMotionTimer,
+    })
+    platform.log('[%s] %s %s.', accessory.displayName, platformLang.devInitOpts, opts)
+
+    // Request a device update immediately
+    this.requestDeviceUpdate()
+
+    // Start a polling interval if the user has disabled upnp
+    if (this.accessory.context.connection === 'http') {
+      this.pollingInterval = setInterval(
+        () => this.requestDeviceUpdate(),
+        platform.config.pollingInterval * 1000,
+      )
+    }
+  }
+
+  receiveDeviceUpdate(attribute) {
+    // Log the receiving update if debug is enabled
+    this.accessory.logDebug(`${platformLang.recUpd} [${attribute.name}: ${JSON.stringify(attribute.value)}]`)
+
+    // Send a HomeKit needed true/false argument
+    // attribute.value is 1 if and only if motion is detected
+    this.externalUpdate(attribute.value === 1)
+  }
+
+  async requestDeviceUpdate() {
+    try {
+      // Request the update
+      const data = await this.platform.httpClient.sendDeviceUpdate(
+        this.accessory,
+        'urn:Belkin:service:basicevent:1',
+        'GetBinaryState',
+      )
+
+      // Check for existence since BinaryState can be int 0
+      if (hasProperty(data, 'BinaryState')) {
+        // Send the data to the receiver function
+        this.receiveDeviceUpdate({
+          name: 'BinaryState',
+          value: Number.parseInt(data.BinaryState, 10),
+        })
+      }
+    } catch (err) {
+      const eText = parseError(err, [
+        platformLang.timeout,
+        platformLang.timeoutUnreach,
+        platformLang.noService,
+      ])
+      this.accessory.logDebugWarn(`${platformLang.rduErr} ${eText}`)
+    }
+  }
+
+  externalUpdate(value) {
+    try {
+      // Obtain the previous state of the motion sensor
+      const prevState = this.service.getCharacteristic(this.hapChar.MotionDetected).value
+
+      // Don't continue in the following cases:
+      // (1) the previous state is the same as before and the motion timer isn't running
+      // (2) the new value is 'no motion detected' but the motion timer is still running
+      if ((value === prevState && !this.motionTimer) || (!value && this.motionTimer)) {
+        return
+      }
+
+      // Next logic depends on two cases
+      if (value || this.noMotionTimer === 0) {
+        // CASE: new motion detected or the user motion timer is set to 0 seconds
+        // If a motion timer is already present then stop it
+        if (this.motionTimer) {
+          this.accessory.log(platformLang.timerStopped)
+          clearTimeout(this.motionTimer)
+          this.motionTimer = false
+        }
+
+        // Update the HomeKit characteristics
+        this.service.updateCharacteristic(this.hapChar.MotionDetected, value)
+
+        // Add the entry to Eve
+        this.accessory.historyService.addEntry({ status: value ? 1 : 0 })
+
+        // If motion detected then update the LastActivation Eve characteristic
+        if (value) {
+          this.service.updateCharacteristic(
+            this.eveChar.LastActivation,
+            Math.round(new Date().valueOf() / 1000) - this.accessory.historyService.getInitialTime(),
+          )
+        }
+
+        // Log the change if appropriate
+        this.accessory.log(`${platformLang.motionSensor} [${value ? platformLang.motionYes : platformLang.motionNo}]`)
+      } else {
+        // CASE: motion not detected and the user motion timer is more than 0 seconds
+        this.accessory.log(`${platformLang.timerStarted} [${this.noMotionTimer}s]`)
+
+        // Clear any existing timers
+        clearTimeout(this.motionTimer)
+
+        // Create a new 'no motion timer'
+        this.motionTimer = setTimeout(() => {
+          // Update the HomeKit characteristic to false
+          this.service.updateCharacteristic(this.hapChar.MotionDetected, false)
+
+          // Add a no motion detected value to Eve
+          this.accessory.historyService.addEntry({ status: 0 })
+
+          // Log the change if appropriate
+          this.accessory.log(`${platformLang.motionSensor} [${platformLang.motionNo}] [${platformLang.timerComplete}]`)
+
+          // Set the motion timer in use to false
+          this.motionTimer = false
+        }, this.noMotionTimer * 1000)
+      }
+    } catch (err) {
+      // Catch any errors
+      this.accessory.logWarn(`${platformLang.cantUpd} ${parseError(err)}`)
+    }
+  }
+}

package/lib/device/outlet.js

@@ -0,0 +1,148 @@
+import { hasProperty, parseError } from '../utils/functions.js'
+import platformLang from '../utils/lang-en.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.platform = platform
+
+    // Set up variables from the accessory
+    this.accessory = accessory
+
+    // 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 an air purifier service then remove it
+    if (this.accessory.getService(this.hapServ.AirPurifier)) {
+      this.accessory.removeService(this.accessory.getService(this.hapServ.AirPurifier))
+    }
+
+    // Add the outlet service if it doesn't already exist
+    this.service = this.accessory.getService(this.hapServ.Outlet)
+      || this.accessory.addService(this.hapServ.Outlet)
+
+    // Add the set handler to the outlet on/off characteristic
+    this.service
+      .getCharacteristic(this.hapChar.On)
+      .removeOnSet()
+      .onSet(async value => this.internalStateUpdate(value))
+
+    // Remove the outlet-in-use characteristic as it only matches the state in this case
+    if (this.service.testCharacteristic(this.hapChar.OutletInUse)) {
+      this.service.removeCharacteristic(this.service.getCharacteristic(this.hapChar.OutletInUse))
+    }
+
+    // Output the customised options to the log
+    const opts = JSON.stringify({
+      showAs: 'outlet',
+    })
+    platform.log('[%s] %s %s.', accessory.displayName, platformLang.devInitOpts, opts)
+
+    // Request a device update immediately
+    this.requestDeviceUpdate()
+
+    // Start a polling interval if the user has disabled upnp
+    if (this.accessory.context.connection === 'http') {
+      this.pollingInterval = setInterval(
+        () => this.requestDeviceUpdate(),
+        platform.config.pollingInterval * 1000,
+      )
+    }
+  }
+
+  receiveDeviceUpdate(attribute) {
+    // Log the receiving update if debug is enabled
+    this.accessory.logDebug(`${platformLang.recUpd} [${attribute.name}: ${JSON.stringify(attribute.value)}]`)
+
+    // Send a HomeKit needed true/false argument
+    // attribute.value is 0 if and only if the outlet is off
+    this.externalStateUpdate(attribute.value !== 0)
+  }
+
+  async sendDeviceUpdate(value) {
+    // Log the sending update if debug is enabled
+    this.accessory.logDebug(`${platformLang.senUpd} ${JSON.stringify(value)}`)
+
+    // Send the update
+    await this.platform.httpClient.sendDeviceUpdate(
+      this.accessory,
+      'urn:Belkin:service:basicevent:1',
+      'SetBinaryState',
+      value,
+    )
+  }
+
+  async requestDeviceUpdate() {
+    try {
+      // Request the update
+      const data = await this.platform.httpClient.sendDeviceUpdate(
+        this.accessory,
+        'urn:Belkin:service:basicevent:1',
+        'GetBinaryState',
+      )
+
+      // Check for existence since BinaryState can be int 0
+      if (hasProperty(data, 'BinaryState')) {
+        // Send the data to the receiver function
+        this.receiveDeviceUpdate({
+          name: 'BinaryState',
+          value: Number.parseInt(data.BinaryState, 10),
+        })
+      }
+    } catch (err) {
+      const eText = parseError(err, [
+        platformLang.timeout,
+        platformLang.timeoutUnreach,
+        platformLang.noService,
+      ])
+      this.accessory.logDebugWarn(`${platformLang.rduErr} ${eText}`)
+    }
+  }
+
+  async internalStateUpdate(value) {
+    try {
+      // Send the update
+      await this.sendDeviceUpdate({
+        BinaryState: value ? 1 : 0,
+      })
+
+      // Update the cache value and log the change if appropriate
+      this.cacheState = value
+      this.accessory.log(`${platformLang.curState} [${value ? 'on' : 'off'}]`)
+    } catch (err) {
+      // Catch any errors
+      const eText = parseError(err, [platformLang.timeout, platformLang.timeoutUnreach])
+      this.accessory.logWarn(`${platformLang.cantCtl} ${eText}`)
+
+      // Throw a 'no response' error and set a timeout to revert this after 2 seconds
+      setTimeout(() => {
+        this.service.updateCharacteristic(this.hapChar.On, this.cacheState)
+      }, 2000)
+      throw new this.hapErr(-70402)
+    }
+  }
+
+  externalStateUpdate(value) {
+    try {
+      // Check to see if the cache value is different
+      if (value === this.cacheState) {
+        return
+      }
+
+      // Update the HomeKit characteristics
+      this.service.updateCharacteristic(this.hapChar.On, value)
+
+      // Update the cache value and log the change if appropriate
+      this.cacheState = value
+      this.accessory.log(`${platformLang.curState} [${value ? 'on' : 'off'}]`)
+    } catch (err) {
+      // Catch any errors
+      this.accessory.logWarn(`${platformLang.cantUpd} ${parseError(err)}`)
+    }
+  }
+}