UNPKG

homebridge-meross

Version:

Homebridge plugin to control Meross devices.

813 lines (735 loc) 28.4 kB
/* jshint node: true,esversion: 9, -W014, -W033 */ /* eslint-disable new-cap */ 'use strict' const { default: PQueue } = require('p-queue') module.exports = class deviceDIffuser { constructor (platform, accessory) { // Set up variables from the platform this.colourUtils = platform.colourUtils this.cusChar = platform.cusChar this.funcs = platform.funcs 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.accessory = accessory this.brightnessStep = this.accessory.context.options.brightnessStep || platform.consts.defaultValues.brightnessStep this.brightnessStep = Math.min(this.brightnessStep, 100) this.enableLogging = accessory.context.enableLogging this.enableDebugLogging = accessory.context.enableDebugLogging this.name = accessory.displayName this.pollInterval = accessory.context.connection === 'cloud' ? this.platform.config.cloudRefreshRate * 1000 : this.platform.config.refreshRate * 1000 this.hk2mr = speed => { if (speed === 0) { return 2 } else if (speed <= 75) { return 0 } else { return 1 } } this.hk2Label = speed => { if (speed === 0) { return 'off' } else if (speed <= 75) { return 'mild' } else { return 'full' } } this.mr2hk = speed => { if (speed === 0) { return 50 } else if (speed === 1) { return 100 } else { return 0 } } // Add the diffuser (fan) service if it doesn't already exist this.fanService = this.accessory.getService('Diffuser') || this.accessory.addService(this.hapServ.Fan, 'Diffuser', 'diffuser') // Add the lightbulb service if it doesn't already exist this.lightService = this.accessory.getService('Light') || this.accessory.addService(this.hapServ.Lightbulb, 'Light', 'light') // Add the set handler to the diffuser (fan) on/off service this.fanService .getCharacteristic(this.hapChar.On) .onSet(async value => await this.internalFanStateUpdate(value)) this.cacheFanState = this.fanService.getCharacteristic(this.hapChar.On).value this.fanService .getCharacteristic(this.hapChar.RotationSpeed) .setProps({ minStep: 50, validValues: [0, 50, 100] }) .onSet(async value => await this.internalFanSpeedUpdate(value)) this.cacheFanSpeed = this.hk2mr( this.fanService.getCharacteristic(this.hapChar.RotationSpeed).value ) // Add the set handler to the lightbulb on/off characteristic this.lightService .getCharacteristic(this.hapChar.On) .onSet(async value => await this.internalLightStateUpdate(value)) this.cacheLightState = this.lightService.getCharacteristic(this.hapChar.On).value // Add the set handler to the lightbulb brightness this.lightService .getCharacteristic(this.hapChar.Brightness) .setProps({ minStep: this.brightnessStep }) .onSet(async value => await this.internalLightBrightnessUpdate(value)) this.cacheLightBright = this.lightService.getCharacteristic(this.hapChar.Brightness).value // Add the set handler to the lightbulb hue characteristic this.lightService .getCharacteristic(this.hapChar.Hue) .onSet(async value => await this.internalLightColourUpdate(value)) this.cacheLightHue = this.lightService.getCharacteristic(this.hapChar.Hue).value this.cacheLightSat = this.lightService.getCharacteristic(this.hapChar.Saturation).value // Add the set handler to the diffuser (fan) custom colour mode characteristic if (!this.lightService.testCharacteristic(this.cusChar.DiffColourMode)) { this.lightService.addCharacteristic(this.cusChar.DiffColourMode) } this.lightService .getCharacteristic(this.cusChar.DiffColourMode) .onSet(async value => await this.internalLightModeUpdate(value, 'colour')) if (this.lightService.getCharacteristic(this.cusChar.DiffColourMode).value) { this.cacheLightMode = 1 } // Add the set handler to the diffuser (fan) custom rainbow mode characteristic if (!this.lightService.testCharacteristic(this.cusChar.DiffRainbowMode)) { this.lightService.addCharacteristic(this.cusChar.DiffRainbowMode) } this.lightService .getCharacteristic(this.cusChar.DiffRainbowMode) .onSet(async value => await this.internalLightModeUpdate(value, 'rainbow')) if (this.lightService.getCharacteristic(this.cusChar.DiffRainbowMode).value) { this.cacheLightMode = 0 } // Add the set handler to the diffuser (fan) custom temperature mode characteristic if (!this.lightService.testCharacteristic(this.cusChar.DiffTemperatureMode)) { this.lightService.addCharacteristic(this.cusChar.DiffTemperatureMode) } this.lightService .getCharacteristic(this.cusChar.DiffTemperatureMode) .onSet(async value => await this.internalLightModeUpdate(value, 'temperature')) if (this.lightService.getCharacteristic(this.cusChar.DiffTemperatureMode).value) { this.cacheLightMode = 2 } // 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 === 'cloud') { this.accessory.mqtt = new (require('./../connection/mqtt'))(platform, this.accessory) this.accessory.mqtt.connect() // Override disabled cloud polling whilst real-time updates aren't available if (this.pollInterval === 0) { this.pollInterval = 30000 } } // Always request a device update on startup, then enable polling if user enabled this.requestUpdate(true) if (this.pollInterval > 0) { this.refreshinterval = setInterval(() => this.requestUpdate(), this.pollInterval) } // Stop the intervals and close mqtt connection on Homebridge shutdown platform.api.on('shutdown', () => { if (this.refreshInterval) { clearInterval(this.refreshInterval) } if (this.accessory.mqtt) { this.accessory.mqtt.disconnect() } }) // Output the customised options to the log const opts = JSON.stringify({ brightnessStep: this.brightnessStep, connection: this.accessory.context.connection, logging: this.enableDebugLogging ? 'debug' : this.enableLogging ? 'standard' : 'disable' }) this.log('[%s] %s %s.', this.name, this.lang.devInitOpts, opts) } async internalFanStateUpdate (value) { try { // Add the request to the queue so updates are send apart return 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.Diffuser.Spray' const payload = { type: 'mod100', spray: [ { mode: value ? this.cacheFanSpeed : 2, 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 if (this.enableLogging) { this.log('[%s] current diffuser state [%s].', this.name, value ? 'on' : 'off') } }) } catch (err) { // Catch any errors whilst updating the device const eText = this.funcs.parseError(err) this.log.warn('[%s] sending update failed as %s.', this.name, 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 send apart return 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.Diffuser.Spray' const payload = { type: 'mod100', 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) return } // Update the cache and log the update has been successful this.cacheFanSpeed = mrVal if (this.enableLogging) { this.log('[%s] current diffuser spray [%s].', this.name, this.hk2Label(value)) } }) } catch (err) { // Catch any errors whilst updating the device const eText = this.funcs.parseError(err) this.log.warn('[%s] sending update failed as %s.', this.name, 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 send apart return 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.Diffuser.Light' const payload = { type: 'mod100', 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 if (this.enableLogging) { this.log('[%s] current light state [%s].', this.name, value ? 'on' : 'off') } }) } catch (err) { // Catch any errors whilst updating the device const eText = this.funcs.parseError(err) this.log.warn('[%s] sending update failed as %s.', this.name, eText) setTimeout(() => { this.lightService.updateCharacteristic(this.hapChar.On, this.cacheLightState) }, 2000) throw new this.hapErr(-70402) } } async internalLightBrightnessUpdate (value) { try { // Add the request to the queue so updates are send apart return await this.queue.add(async () => { // Don't continue if the state is the same as before if (this.cacheLightBright === value) { return } // Avoid multiple changes in short space of time const updateKey = Math.random() .toString(36) .substr(2, 8) this.updateKeyBright = updateKey await this.funcs.sleep(300) if (updateKey !== this.updateKeyBright) { return } // This flag stops the plugin from requesting updates while pending on others this.updateInProgress = true // Generate the payload to send for the correct device model const namespace = 'Appliance.Control.Diffuser.Light' const payload = { type: 'mod100', light: [ { luminance: value, 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.cacheLightBright = value if (this.enableLogging) { this.log('[%s] current light brightness [%s%].', this.name, value) } }) } catch (err) { const eText = this.funcs.parseError(err) this.log.warn('[%s] sending update failed as %s.', this.name, eText) setTimeout(() => { this.lightService.updateCharacteristic(this.hapChar.Brightness, this.cacheLightBright) }, 2000) throw new this.hapErr(-70402) } } async internalLightColourUpdate (value) { try { // Add the request to the queue so updates are send apart return 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 = Math.random() .toString(36) .substr(2, 8) this.updateKeyColour = updateKey await this.funcs.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] = this.colourUtils.hs2rgb(value, saturation) // Generate the payload to send const namespace = 'Appliance.Control.Diffuser.Light' const payload = { type: 'mod100', light: [ { rgb: this.colourUtils.hk2mrRGB(r, g, b), mode: 1, 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.cacheLightHue = value this.cacheLightSat = this.lightService.getCharacteristic(this.hapChar.Saturation).value if (this.enableLogging) { this.log( '[%s] current light hue/sat [%s/%s] rgb [%s, %s, %s].', this.name, this.cacheHue, this.cacheSat, r, g, b ) } }) } catch (err) { const eText = this.funcs.parseError(err) this.log.warn('[%s] sending update failed as %s.', this.name, eText) setTimeout(() => { this.lightService.updateCharacteristic(this.hapChar.Hue, this.cacheLightHue) }, 2000) throw new this.hapErr(-70402) } } async internalLightModeUpdate (value, mode) { try { // Add the request to the queue so updates are send apart return await this.queue.add(async () => { // Don't continue if we are turning off, can't leave a mode without selecting another if (!value) { return } // This flag stops the plugin from requesting updates while pending on others this.updateInProgress = true // Get the mode value from the mode selected let modeVal switch (mode) { case 'colour': modeVal = 1 break case 'rainbow': modeVal = 0 break case 'temperature': modeVal = 2 break default: // Should be a never case return } // Generate the payload and namespace const namespace = 'Appliance.Control.Diffuser.Spray' const payload = { type: 'mod100', light: [ { mode: modeVal, channel: 0 } ] } // Use the platform function to send the update to the device await this.platform.sendUpdate(this.accessory, { namespace, payload }) // Turn all the mode characteristics OFF, the needed one will turn ON at end of this func ;['DiffColourMode', 'DiffRainbowMode', 'DiffTemperatureMode'].forEach(cusChar => { this.lightService.updateCharacteristic(this.cusChar[cusChar], false) }) // Update the cache and log the update has been successful this.cacheLightMode = modeVal if (this.enableLogging) { this.log('[%s] current light mode [%s].', this.name, mode) } }) } catch (err) { // Catch any errors whilst updating the device const eText = this.funcs.parseError(err) this.log.warn('[%s] sending update failed as %s.', this.name, eText) let charToError switch (mode) { case 'colour': charToError = this.cusChar.DiffColourMode break case 'rainbow': charToError = this.cusChar.DiffRainbowMode break case 'temperature': charToError = this.cusChar.DiffTemperatureMode break default: // Should be a never case return } setTimeout(() => { this.lightService.updateCharacteristic(charToError, false) }, 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 send apart return 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 if (this.enableDebugLogging) { this.log('[%s] incoming poll: %s.', this.name, JSON.stringify(res.data)) } // Check the response is in a useful format const data = res.data.payload if (data.all) { if (data.all.digest && data.all.digest.diffuser) { this.applyUpdate(data.all.digest.diffuser) } // 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, IP and firmware don't change regularly so only get on first poll if (firstRun) { if (data.all.system.hardware) { this.cacheMac = (data.all.system.hardware.macAddress || '').toUpperCase() if (this.cacheMac !== this.accessory.context.macAddress) { this.accessory.context.macAddress = this.cacheMac needsUpdate = true } this.cacheHardware = data.all.system.hardware.version if (this.cacheHardware !== this.accessory.context.hardware) { this.accessory.context.hardware = this.cacheHardware needsUpdate = true } } // Get the ip address and firmware of the device if (data.all.system.firmware) { this.cacheIp = data.all.system.firmware.innerIp if (this.cacheIp !== this.accessory.context.ipAddress) { this.accessory.context.ipAddress = this.cacheIp needsUpdate = true } if (!this.accessory.context.firmware) { this.cacheFirmware = data.all.system.firmware.version if (this.cacheFirmware !== this.accessory.context.firmware) { this.accessory.context.firmware = this.cacheFirmware needsUpdate = true } } } } } // Get the cloud online status of the device if (data.all.system.online) { this.cacheOnline = data.all.system.online.status === 1 if (this.cacheOnline !== this.accessory.context.isOnline) { this.accessory.context.isOnline = this.cacheOnline needsUpdate = true } } // Update the accessory cache if anything has changed if (needsUpdate) { this.platform.updateAccessory(this.accessory) } } }) } catch (err) { const eText = this.funcs.parseError(err) this.log.warn('[%s] failed to request status as %s.', this.name, eText) // Set the homebridge-ui status of the device to offline if local and error is timeout if (this.accessory.context.connection === 'local') { if (['EHOSTUNREACH', '4000ms exceeded'].some(el => eText.includes(el))) { this.accessory.context.isOnline = false this.cacheOnline = false if (this.enableLogging) { this.log.warn('[%s] has been reported [offline].', this.name) } this.platform.updateAccessory(this.accessory) } } } } receiveUpdate (params) { try { // Log the received data if (this.enableDebugLogging) { this.log('[%s] incoming mqtt: %s.', this.name, JSON.stringify(params)) } // Check the response is in a useful format const data = params.payload if (data.light || data.spray) { this.applyUpdate(data) } } catch (err) { const eText = this.funcs.parseError(err) this.log.warn('[%s] failed to refresh status as %s.', this.name, eText) } } applyUpdate (data) { // Update the diffuser (fan) service from the supplied data if (data.spray && data.spray[0] && this.funcs.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 === 2) { // Looks like the spray has been turned off this.cacheFanState = false this.fanService.updateCharacteristic(this.hapChar.On, false) if (this.enableLogging) { this.log('[%s] current diffuser state [off].', this.name) } } 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) if (this.enableLogging) { this.log('[%s] current diffuser state [on].', this.name) } } const hkValue = this.mr2hk(this.cacheFanSpeed) this.fanService.updateCharacteristic(this.hapChar.RotationSpeed, hkValue) if (this.enableLogging) { this.log('[%s] current diffuser spray [%s].', this.name, this.hk2Label(hkValue)) } } } } // Update the light from the supplied data if (data.light && data.light[0]) { if (this.funcs.hasProperty(data.light[0], 'onoff')) { const newState = data.light[0].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 if (this.enableLogging) { this.log( '[%s] current light state [%s].', this.name, this.cacheLightState ? 'on' : 'off' ) } } } if (this.funcs.hasProperty(data.light[0], 'luminance')) { const newBright = data.light[0].luminance // Check against the cache and update HomeKit and the cache if needed if (this.cacheBright !== newBright) { this.lightService.updateCharacteristic(this.hapChar.Brightness, newBright) this.cacheLightBright = newBright if (this.enableLogging) { this.log('[%s] current light brightness [%s%].', this.name, this.cacheLightBright) } } } if (data.light[0].mode === 0) { if (!this.cacheLightMode !== 0) { this.cacheLightMode = 0 ;['DiffColourMode', 'DiffTemperatureMode'].forEach(cusChar => { this.lightService.updateCharacteristic(this.cusChar[cusChar], false) }) this.lightService.updateCharacteristic(this.cusChar.DiffRainbowMode, true) if (this.enableLogging) { this.log('[%s] current light mode [rainbow].', this.name) } } } if (data.light[0].mode === 1) { if (!this.cacheLightMode !== 1) { this.cacheLightMode = 1 ;['DiffRainbowMode', 'DiffTemperatureMode'].forEach(cusChar => { this.lightService.updateCharacteristic(this.cusChar[cusChar], false) }) this.lightService.updateCharacteristic(this.cusChar.DiffColourMode, true) if (this.enableLogging) { this.log('[%s] current light mode [colour].', this.name) } } if (this.funcs.hasProperty(data.light[0], 'rgb')) { const [r, g, b] = this.colourUtils.mr2hk(data.light[0].rgb) const [newHue, newSat] = this.colourUtils.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 if (this.enableLogging) { this.log( '[%s] current light hue/sat [%s/%s] rgb [%s, %s, %s].', this.name, this.cacheLightHue, this.cacheLightSat, r, g, b ) } } } } if (data.light[0].mode === 2) { if (!this.cacheLightMode !== 2) { this.cacheLightMode = 2 ;['DiffColourMode', 'DiffRainbowMode'].forEach(cusChar => { this.lightService.updateCharacteristic(this.cusChar[cusChar], false) }) this.lightService.updateCharacteristic(this.cusChar.DiffTemperatureMode, true) if (this.enableLogging) { this.log('[%s] current light mode [temperature].', this.name) } } } } } }