@homebridge-plugins/homebridge-meross 10.8.0

package/lib/device/humidifier.js

@@ -0,0 +1,521 @@
+import PQueue from 'p-queue'
+import { TimeoutError } from 'p-timeout'
+
+import mqttClient from '../connection/mqtt.js'
+import {
+  hk2mrRGB,
+  hs2rgb,
+  mr2hkRGB,
+  rgb2hs,
+} from '../utils/colour.js'
+import platformConsts from '../utils/constants.js'
+import {
+  generateRandomString,
+  hasProperty,
+  parseError,
+  sleep,
+} 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
+    this.name = accessory.displayName
+    const cloudRefreshRate = hasProperty(platform.config, 'cloudRefreshRate')
+      ? platform.config.cloudRefreshRate
+      : platformConsts.defaultValues.cloudRefreshRate
+    const localRefreshRate = hasProperty(platform.config, 'refreshRate')
+      ? platform.config.refreshRate
+      : platformConsts.defaultValues.refreshRate
+    this.pollInterval = accessory.context.connection === 'local'
+      ? localRefreshRate
+      : cloudRefreshRate
+    this.hk2mr = (speed) => {
+      if (speed === 0) {
+        return 0
+      }
+      if (speed <= 75) {
+        return 2
+      }
+      return 1
+    }
+    this.hk2Label = (speed) => {
+      if (speed === 0) {
+        return 'off'
+      }
+      if (speed <= 75) {
+        return 'intermittent'
+      }
+      return 'continuous'
+    }
+    this.mr2hk = (speed) => {
+      if (speed === 0) {
+        return 0
+      }
+      if (speed === 1) {
+        return 100
+      }
+      return 50
+    }
+
+    // Add the switch service if it doesn't already exist
+    this.fanService = this.accessory.getService(this.hapServ.Fan) || this.accessory.addService(this.hapServ.Fan)
+
+    // Add the set handler to the fan on/off characteristic
+    this.fanService
+      .getCharacteristic(this.hapChar.On)
+      .onSet(async value => this.internalFanStateUpdate(value))
+    this.cacheFanState = this.fanService.getCharacteristic(this.hapChar.On).value
+
+    // Add the set handler to the fan speed characteristic
+    this.fanService
+      .getCharacteristic(this.hapChar.RotationSpeed)
+      .setProps({
+        minStep: 50,
+        validValues: [0, 50, 100],
+      })
+      .onSet(async value => this.internalFanSpeedUpdate(value))
+    this.cacheFanSpeed = this.hk2mr(
+      this.fanService.getCharacteristic(this.hapChar.RotationSpeed).value,
+    )
+
+    // Add the lightbulb service if it doesn't already exist
+    this.lightService = this.accessory.getService(this.hapServ.Lightbulb)
+    || this.accessory.addService(this.hapServ.Lightbulb)
+
+    // Add the set handler to the lightbulb on/off characteristic
+    this.lightService
+      .getCharacteristic(this.hapChar.On)
+      .onSet(async value => this.internalLightStateUpdate(value))
+    this.cacheLightState = this.lightService.getCharacteristic(this.hapChar.On).value
+
+    // No set handler for brightness as not supported
+    this.lightService.getCharacteristic(this.hapChar.Brightness).setProps({
+      minStep: 100,
+      validValues: [0, 100],
+    })
+
+    // Add the set handler to the lightbulb hue characteristic
+    this.lightService
+      .getCharacteristic(this.hapChar.Hue)
+      .onSet(async value => this.internalLightColourUpdate(value))
+    this.cacheLightHue = this.lightService.getCharacteristic(this.hapChar.Hue).value
+    this.cacheLightSat = this.lightService.getCharacteristic(this.hapChar.Saturation).value
+
+    // Create the queue used for sending device requests
+    this.updateInProgress = false
+    this.queue = new PQueue({
+      concurrency: 1,
+      interval: 250,
+      intervalCap: 1,
+      timeout: 10000,
+      throwOnTimeout: true,
+    })
+    this.queue.on('idle', () => {
+      this.updateInProgress = false
+    })
+
+    // Set up the mqtt client for cloud devices to send and receive device updates
+    if (accessory.context.connection !== 'local') {
+      this.accessory.mqtt = new mqttClient(platform, this.accessory)
+      this.accessory.mqtt.connect()
+    }
+
+    // Always request a device update on startup, then start the interval for polling
+    setTimeout(() => this.requestUpdate(true), 2000)
+    this.accessory.refreshInterval = setInterval(
+      () => this.requestUpdate(),
+      this.pollInterval * 1000,
+    )
+
+    // Output the customised options to the log
+    const opts = JSON.stringify({
+      connection: this.accessory.context.connection,
+    })
+    platform.log('[%s] %s %s.', this.name, platformLang.devInitOpts, opts)
+  }
+
+  async internalFanStateUpdate(value) {
+    try {
+      // Add the request to the queue so updates are sent apart
+      await this.queue.add(async () => {
+        // Don't continue if the state is the same as before
+        if (value === this.cacheFanState) {
+          return
+        }
+
+        // This flag stops the plugin from requesting updates while pending on others
+        this.updateInProgress = true
+
+        // Generate the payload and namespace
+        const namespace = 'Appliance.Control.Spray'
+        const payload = {
+          spray: {
+            mode: value ? Math.max(this.cacheFanSpeed, 1) : 0,
+            channel: 0,
+          },
+        }
+
+        // Use the platform function to send the update to the device
+        await this.platform.sendUpdate(this.accessory, {
+          namespace,
+          payload,
+        })
+
+        // Update the cache and log the update has been successful
+        this.cacheFanState = value
+
+        this.accessory.log(`${platformLang.curState} [${value ? 'on' : 'off'}]`)
+      })
+    } catch (err) {
+      // Catch any errors whilst updating the device
+      const eText = err instanceof TimeoutError ? platformLang.timeout : parseError(err)
+      this.accessory.logWarn(`${platformLang.sendFailed} ${eText}`)
+      setTimeout(() => {
+        this.fanService.updateCharacteristic(this.hapChar.On, this.cacheFanState)
+      }, 2000)
+      throw new this.hapErr(-70402)
+    }
+  }
+
+  async internalFanSpeedUpdate(value) {
+    try {
+      // Add the request to the queue so updates are sent apart
+      await this.queue.add(async () => {
+        // Some homekit apps might not support the valid values of 0, 50 and 100
+        if (value === 0) {
+          value = 0
+        } else if (value <= 75) {
+          value = 50
+        } else {
+          value = 100
+        }
+
+        // Don't continue if the state is the same as before
+        const mrVal = this.hk2mr(value)
+        if (mrVal === this.cacheFanSpeed) {
+          return
+        }
+
+        // This flag stops the plugin from requesting updates while pending on others
+        this.updateInProgress = true
+
+        // Generate the payload and namespace
+        const namespace = 'Appliance.Control.Spray'
+        const payload = {
+          spray: {
+            mode: mrVal,
+            channel: 0,
+          },
+        }
+
+        // Use the platform function to send the update to the device
+        await this.platform.sendUpdate(this.accessory, {
+          namespace,
+          payload,
+        })
+
+        // If using the slider to turn off then set the rotation speed back to original value
+        // This stops homekit turning back to 100% if using the icon after turned off
+        if (value === 0) {
+          // Update the rotation speed back to the previous value (with the fan still off)
+          setTimeout(() => {
+            this.fanService.updateCharacteristic(
+              this.hapChar.RotationSpeed,
+              this.mr2hk(this.cacheFanSpeed),
+            )
+          }, 2000)
+        } else {
+          // Update the cache and log the update has been successful
+          this.cacheFanSpeed = mrVal
+          this.accessory.log(`${platformLang.curSpray} [${this.hk2Label(value)}]`)
+        }
+      })
+    } catch (err) {
+      // Catch any errors whilst updating the device
+      const eText = err instanceof TimeoutError ? platformLang.timeout : parseError(err)
+      this.accessory.logWarn(`${platformLang.sendFailed} ${eText}`)
+      setTimeout(() => {
+        this.fanService.updateCharacteristic(
+          this.hapChar.RotationSpeed,
+          this.mr2hk(this.cacheFanSpeed),
+        )
+      }, 2000)
+      throw new this.hapErr(-70402)
+    }
+  }
+
+  async internalLightStateUpdate(value) {
+    try {
+      // Add the request to the queue so updates are sent apart
+      await this.queue.add(async () => {
+        // Don't continue if the state is the same as before
+        if (value === this.cacheLightState) {
+          return
+        }
+
+        // This flag stops the plugin from requesting updates while pending on others
+        this.updateInProgress = true
+
+        // Generate the payload and namespace
+        const namespace = 'Appliance.Control.Light'
+        const payload = {
+          light: {
+            onoff: value ? 1 : 0,
+            channel: 0,
+          },
+        }
+
+        // Use the platform function to send the update to the device
+        await this.platform.sendUpdate(this.accessory, {
+          namespace,
+          payload,
+        })
+
+        // Update the cache and log the update has been successful
+        this.cacheLightState = value
+        this.accessory.log(`${platformLang.curLightState} [${value ? 'on' : 'off'}]`)
+      })
+    } catch (err) {
+      // Catch any errors whilst updating the device
+      const eText = err instanceof TimeoutError ? platformLang.timeout : parseError(err)
+      this.accessory.logWarn(`${platformLang.sendFailed} ${eText}`)
+      setTimeout(() => {
+        this.lightService.updateCharacteristic(this.hapChar.On, this.cacheLightState)
+      }, 2000)
+      throw new this.hapErr(-70402)
+    }
+  }
+
+  async internalLightColourUpdate(value) {
+    try {
+      // Add the request to the queue so updates are sent apart
+      await this.queue.add(async () => {
+        // Don't continue if the state is the same as before
+        if (this.cacheLightHue === value) {
+          return
+        }
+
+        // Avoid multiple changes in short space of time
+        const updateKey = generateRandomString(5)
+        this.updateKeyColour = updateKey
+        await sleep(300)
+        if (updateKey !== this.updateKeyColour) {
+          return
+        }
+
+        // This flag stops the plugin from requesting updates while pending on others
+        this.updateInProgress = true
+
+        // Convert to RGB
+        const saturation = this.lightService.getCharacteristic(this.hapChar.Saturation).value
+        const [r, g, b] = hs2rgb(value, saturation)
+
+        // Generate the payload to send
+        const namespace = 'Appliance.Control.Light'
+        const payload = {
+          light: {
+            capacity: 1,
+            channel: 0,
+            rgb: hk2mrRGB(r, g, b),
+            onoff: 1,
+            luminance: 100,
+          },
+        }
+
+        // For some reason the device sends an mqtt with the old colour, so create a flag to ignore
+        this.ignoreNextMQTT = true
+
+        // Use the platform function to send the update to the device
+        await this.platform.sendUpdate(this.accessory, {
+          namespace,
+          payload,
+        })
+
+        // Update the cache and log the update has been successful
+        if (!this.cacheLightState) {
+          this.cacheLightState = true
+          this.lightService.updateCharacteristic(this.hapChar.On, true)
+          this.accessory.log(`${platformLang.curLightState} [on]`)
+          this.lightService.updateCharacteristic(this.hapChar.Brightness, 100)
+        }
+        this.cacheLightHue = value
+        this.cacheLightSat = this.lightService.getCharacteristic(this.hapChar.Saturation).value
+
+        this.accessory.log(`${platformLang.curLightColour} [${this.cacheLightHue}, ${this.cacheLightSat}] / [${r}, ${g}, ${b}]`)
+      })
+    } catch (err) {
+      this.ignoreNextMQTT = false
+      const eText = parseError(err)
+      this.accessory.logWarn(`${platformLang.sendFailed} ${eText}`)
+      setTimeout(() => {
+        this.lightService.updateCharacteristic(this.hapChar.Hue, this.cacheLightHue)
+      }, 2000)
+      throw new this.hapErr(-70402)
+    }
+  }
+
+  async requestUpdate(firstRun = false) {
+    try {
+      // Don't continue if an update is currently being sent to the device
+      if (this.updateInProgress) {
+        return
+      }
+
+      // Add the request to the queue so updates are sent apart
+      await this.queue.add(async () => {
+        // This flag stops the plugin from requesting updates while pending on others
+        this.updateInProgress = true
+
+        // Send the request
+        const res = await this.platform.sendUpdate(this.accessory, {
+          namespace: 'Appliance.System.All',
+          payload: {},
+        })
+
+        // Log the received data
+        this.accessory.logDebug(`${platformLang.incPoll}: ${JSON.stringify(res.data)}`)
+
+        // Check the response is in a useful format
+        const data = res.data.payload
+
+        if (data.all) {
+          if (data.all.digest) {
+            this.applyUpdate(data.all.digest)
+          }
+
+          // A flag to check if we need to update the accessory context
+          let needsUpdate = false
+
+          // Get the mac address and hardware version of the device
+          if (data.all.system) {
+            // Mac address and hardware don't change regularly so only get on first poll
+            if (firstRun && data.all.system.hardware) {
+              this.accessory.context.macAddress = data.all.system.hardware.macAddress.toUpperCase()
+              this.accessory.context.hardware = data.all.system.hardware.version
+            }
+
+            // Get the ip address and firmware of the device
+            if (data.all.system.firmware) {
+              // Check for an IP change each and every time the device is polled
+              if (this.accessory.context.ipAddress !== data.all.system.firmware.innerIp) {
+                this.accessory.context.ipAddress = data.all.system.firmware.innerIp
+                needsUpdate = true
+              }
+
+              // Firmware doesn't change regularly so only get on first poll
+              if (firstRun) {
+                this.accessory.context.firmware = data.all.system.firmware.version
+              }
+            }
+          }
+
+          // Get the cloud online status of the device
+          if (data.all.system.online) {
+            const isOnline = data.all.system.online.status === 1
+            if (this.accessory.context.isOnline !== isOnline) {
+              this.accessory.context.isOnline = isOnline
+              needsUpdate = true
+            }
+          }
+
+          // Update the accessory cache if anything has changed
+          if (needsUpdate || firstRun) {
+            this.platform.updateAccessory(this.accessory)
+          }
+        }
+      })
+    } catch (err) {
+      const eText = err instanceof TimeoutError ? platformLang.timeout : parseError(err)
+      this.accessory.logDebugWarn(`${platformLang.reqFailed}: ${eText}`)
+
+      // Set the homebridge-ui status of the device to offline if local and error is timeout
+      if (
+        (this.accessory.context.isOnline || firstRun)
+        && ['EHOSTUNREACH', 'timed out'].some(el => eText.includes(el))
+      ) {
+        this.accessory.context.isOnline = false
+        this.platform.updateAccessory(this.accessory)
+      }
+    }
+  }
+
+  receiveUpdate(params) {
+    try {
+      // Log the received data
+      this.accessory.logDebug(`${platformLang.incMQTT}: ${JSON.stringify(params)}`)
+
+      // Check the response is in a useful format
+      const data = params.payload
+      if (data.spray || data.light) {
+        this.applyUpdate(data)
+      }
+    } catch (err) {
+      this.accessory.logWarn(`${platformLang.refFailed} ${parseError(err)}`)
+    }
+  }
+
+  applyUpdate(data) {
+    // Update the diffuser (fan) service from the supplied data
+    if (data.spray && data.spray[0] && hasProperty(data.spray[0], 'mode')) {
+      const newSpeed = data.spray[0].mode
+
+      // Check against the cache and update HomeKit and the cache if needed
+      if (this.cacheFanSpeed !== newSpeed) {
+        this.cacheFanSpeed = newSpeed
+        if (this.cacheFanSpeed === 0) {
+          // Looks like the spray has been turned off
+          this.cacheFanState = false
+          this.fanService.updateCharacteristic(this.hapChar.On, false)
+          this.accessory.log(`${platformLang.curState} [off]`)
+        } else {
+          // Looks like the spray is now on (from OFF or a different mode)
+          if (!this.cacheFanState) {
+            // Looks like the spray has been turn ON from OFF
+            this.cacheFanState = true
+            this.fanService.updateCharacteristic(this.hapChar.On, true)
+            this.accessory.log(`${platformLang.curState} [on]`)
+          }
+          const hkValue = this.mr2hk(this.cacheFanSpeed)
+          this.fanService.updateCharacteristic(this.hapChar.RotationSpeed, hkValue)
+          this.accessory.log(`${platformLang.curSpray} [${this.hk2Label(hkValue)}]`)
+        }
+      }
+    }
+
+    // Update the diffuser (light) service from the supplied data
+    if (data.light) {
+      if (hasProperty(data.light, 'onoff')) {
+        const newState = data.light.onoff === 1
+
+        // Check against the cache and update HomeKit and the cache if needed
+        if (this.cacheLightState !== newState) {
+          this.lightService.updateCharacteristic(this.hapChar.On, newState)
+          this.cacheLightState = newState
+          this.accessory.log(`${platformLang.curLightState} [${this.cacheLightState ? 'on' : 'off'}]`)
+        }
+      }
+      if (hasProperty(data.light, 'rgb') && !this.ignoreNextMQTT) {
+        const [r, g, b] = mr2hkRGB(data.light.rgb)
+        const [newHue, newSat] = rgb2hs(r, g, b)
+
+        // Check against the cache and update HomeKit and the cache if needed
+        if (this.cacheLightHue !== newHue || this.cacheLightSat !== newSat) {
+          this.lightService.updateCharacteristic(this.hapChar.Hue, newHue)
+          this.lightService.updateCharacteristic(this.hapChar.Saturation, newSat)
+          this.cacheLightHue = newHue
+          this.cacheLightSat = newSat
+          this.accessory.log(`${platformLang.curLightColour} [${this.cacheLightHue}, ${this.cacheLightSat}] / [${r}, ${g}, ${b}]`)
+        }
+      }
+      this.ignoreNextMQTT = false
+    }
+  }
+}

package/lib/device/index.js

@@ -0,0 +1,63 @@
+import deviceBaby from './baby.js'
+import deviceCoolerSingle from './cooler-single.js'
+import deviceDiffuser from './diffuser.js'
+import deviceFan from './fan.js'
+import deviceGarageMain from './garage-main.js'
+import deviceGarageSingle from './garage-single.js'
+import deviceGarageSub from './garage-sub.js'
+import deviceHeaterSingle from './heater-single.js'
+import deviceHubContact from './hub-contact.js'
+import deviceHubLeak from './hub-leak.js'
+import deviceHubMain from './hub-main.js'
+import deviceHubSensor from './hub-sensor.js'
+import deviceHubSmoke from './hub-smoke.js'
+import deviceHubValve from './hub-valve.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 deviceOutletMulti from './outlet-multi.js'
+import deviceOutletSingle from './outlet-single.js'
+import devicePowerStrip from './power-strip.js'
+import devicePurifier from './purifier.js'
+import devicePurifierSingle from './purifier-single.js'
+import deviceRoller from './roller.js'
+import deviceRollerLocation from './roller-location.js'
+import deviceSensorPresence from './sensor-presence.js'
+import deviceSwitchMulti from './switch-multi.js'
+import deviceSwitchSingle from './switch-single.js'
+import deviceTemplate from './template.js'
+import deviceThermostat from './thermostat.js'
+
+export default {
+  deviceBaby,
+  deviceCoolerSingle,
+  deviceDiffuser,
+  deviceFan,
+  deviceGarageMain,
+  deviceGarageSingle,
+  deviceGarageSub,
+  deviceHeaterSingle,
+  deviceHubContact,
+  deviceHubLeak,
+  deviceHubMain,
+  deviceHubSensor,
+  deviceHubSmoke,
+  deviceHubValve,
+  deviceHumidifier,
+  deviceLightCCT,
+  deviceLightDimmer,
+  deviceLightRGB,
+  deviceOutletMulti,
+  deviceOutletSingle,
+  devicePowerStrip,
+  devicePurifierSingle,
+  devicePurifier,
+  deviceRollerLocation,
+  deviceRoller,
+  deviceSensorPresence,
+  deviceSwitchMulti,
+  deviceSwitchSingle,
+  deviceTemplate,
+  deviceThermostat,
+}