homebridge-meross
Version:
Homebridge plugin to control Meross devices.
572 lines (508 loc) • 20.5 kB
JavaScript
/* jshint node: true,esversion: 9, -W014, -W033 */
/* eslint-disable new-cap */
'use strict'
const { default: PQueue } = require('p-queue')
module.exports = class deviceLightRGB {
constructor (platform, accessory) {
// Set up variables from the platform
this.colourUtils = platform.colourUtils
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.alShift =
this.accessory.context.options.adaptiveLightingShift ||
platform.consts.defaultValues.adaptiveLightingShift
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
// 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 => await this.internalStateUpdate(value))
this.cacheState = this.service.getCharacteristic(this.hapChar.On).value
// Add the set handler to the lightbulb brightness characteristic
this.service
.getCharacteristic(this.hapChar.Brightness)
.setProps({ minStep: this.brightnessStep })
.onSet(async value => await this.internalBrightnessUpdate(value))
this.cacheBright = this.service.getCharacteristic(this.hapChar.Brightness).value
// Add the set handler to the lightbulb hue characteristic
this.service
.getCharacteristic(this.hapChar.Hue)
.onSet(async value => await this.internalColourUpdate(value))
this.cacheHue = this.service.getCharacteristic(this.hapChar.Hue).value
this.cacheSat = this.service.getCharacteristic(this.hapChar.Saturation).value
// Add the set handler to the lightbulb colour temperature characteristic
this.service
.getCharacteristic(this.hapChar.ColorTemperature)
.onSet(async value => await this.internalCTUpdate(value))
this.cacheMired = this.service.getCharacteristic(this.hapChar.ColorTemperature).value
// Set up the adaptive lighting controller if not disabled by user
if (this.alShift !== -1) {
this.alController = new platform.api.hap.AdaptiveLightingController(this.service, {
customTemperatureAdjustment: this.alShift
})
this.accessory.configureController(this.alController)
this.accessory.context.adaptiveLighting = true
}
// 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({
adaptiveLightingShift: this.alShift,
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 internalStateUpdate (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.cacheState) {
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.ToggleX'
const payload = {
togglex: {
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.cacheState = value
if (this.enableLogging) {
this.log('[%s] current 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.service.updateCharacteristic(this.hapChar.On, this.cacheState)
}, 2000)
throw new this.hapErr(-70402)
}
}
async internalBrightnessUpdate (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.cacheBright === 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 payload = {
light: {
luminance: value,
capacity: 4,
channel: 0
}
}
// Generate the namespace
const namespace = 'Appliance.Control.Light'
// 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.cacheBright = value
if (this.enableLogging) {
this.log('[%s] current 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.service.updateCharacteristic(this.hapChar.Brightness, this.cacheBright)
}, 2000)
throw new this.hapErr(-70402)
}
}
async internalColourUpdate (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.cacheHue === 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.service.getCharacteristic(this.hapChar.Saturation).value
const [r, g, b] = this.colourUtils.hs2rgb(value, saturation)
// Generate the payload to send
const payload = {
light: {
rgb: this.colourUtils.hk2mrRGB(r, g, b),
capacity: 1,
luminance: this.cacheBright,
temperature: -1,
channel: 0
}
}
// Generate the namespace
const namespace = 'Appliance.Control.Light'
// 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.cacheHue = value
this.cacheSat = this.service.getCharacteristic(this.hapChar.Saturation).value
if (this.enableLogging) {
this.log(
'[%s] current 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.service.updateCharacteristic(this.hapChar.Hue, this.cacheHue)
}, 2000)
throw new this.hapErr(-70402)
}
}
async internalCTUpdate (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.cacheMired === value) {
return
}
// Avoid multiple changes in short space of time
const updateKey = Math.random()
.toString(36)
.substr(2, 8)
this.updateKeyCT = updateKey
await this.funcs.sleep(300)
if (updateKey !== this.updateKeyCT) {
return
}
// This flag stops the plugin from requesting updates while pending on others
this.updateInProgress = true
// Don't continue if the new value is the same as before
if (!this.cacheState || this.cacheMired === value) {
return
}
// Generate the payload to send
const payload = {
light: {
temperature: this.colourUtils.hk2mrCT(value),
capacity: 2,
channel: 0
}
}
// Generate the namespace
const namespace = 'Appliance.Control.Light'
// 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.cacheMired = value
if (this.enableLogging) {
const kelvin = Math.round(1000000 / this.cacheMired)
const al =
this.alController && this.alController.isAdaptiveLightingActive()
? ' via adaptive lighting'
: ''
this.log('[%s] current mired/kelvin [%s/%s]%s.', this.name, this.cacheMired, kelvin, al)
}
})
} catch (err) {
const eText = this.funcs.parseError(err)
this.log.warn('[%s] sending update failed as %s.', this.name, eText)
setTimeout(() => {
this.service.updateCharacteristic(this.hapChar.ColorTemperature, this.cacheMired)
}, 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) {
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, 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))
}
// Validate the response, checking for payload property
if (!params.payload) {
throw new Error('invalid response received')
}
const data = params.payload
if (data.togglex || data.light) {
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) {
if (data.togglex && data.togglex[0] && this.funcs.hasProperty(data.togglex[0], 'onoff')) {
// newState is given as 0 or 1 -> convert to bool for HomeKit
const newState = data.togglex[0].onoff === 1
// Check against the cache and update HomeKit and the cache if needed
if (this.cacheState !== newState) {
this.service.updateCharacteristic(this.hapChar.On, newState)
this.cacheState = newState
if (this.enableLogging) {
this.log('[%s] current state [%s].', this.name, this.cacheState ? 'on' : 'off')
}
}
}
if (data.light) {
if (this.funcs.hasProperty(data.light, 'luminance')) {
const newBright = data.light.luminance
// Check against the cache and update HomeKit and the cache if needed
if (this.cacheBright !== newBright) {
this.service.updateCharacteristic(this.hapChar.Brightness, newBright)
this.cacheBright = newBright
if (this.enableLogging) {
this.log('[%s] current brightness [%s%].', this.name, this.cacheBright)
}
}
}
if (this.funcs.hasProperty(data.light, 'rgb') && data.light.rgb !== -1) {
const [r, g, b] = this.colourUtils.mr2hkRGB(data.light.rgb)
const [newHue, newSat] = this.colourUtils.rgb2hs(r, g, b)
// Check against the cache and update HomeKit and the cache if needed
if (this.cacheHue !== newHue || this.cacheSat !== newSat) {
this.service.updateCharacteristic(this.hapChar.Hue, newHue)
this.service.updateCharacteristic(this.hapChar.Saturation, newSat)
this.cacheHue = newHue
this.cacheSat = newSat
if (this.enableLogging) {
this.log(
'[%s] current hue/sat [%s/%s] rgb [%s, %s, %s].',
this.name,
this.cacheHue,
this.cacheSat,
r,
g,
b
)
}
}
// Disable adaptive lighting
if (this.alController && this.alController.isAdaptiveLightingActive()) {
this.alController.disableAdaptiveLighting()
if (this.enableLogging) {
this.log('[%s] adaptive lighting disabled as RGB colour chosen.', this.name)
}
}
}
if (this.funcs.hasProperty(data.light, 'temperature') && data.light.temperature !== -1) {
const hkTemp = this.colourUtils.mr2hkCT(data.light.temperature)
// Check against the cache and update HomeKit and the cache if needed
if (this.cacheMired !== hkTemp) {
const dif = Math.abs(this.cacheMired - hkTemp)
this.service.updateCharacteristic(this.hapChar.ColorTemperature, hkTemp)
this.cacheMired = hkTemp
if (this.enableLogging) {
const kelvin = Math.round(1000000 / this.cacheMired)
this.log('[%s] current mired/kelvin [%s/%s].', this.name, this.cacheMired, kelvin)
}
if (dif > 10 && this.alController && this.alController.isAdaptiveLightingActive()) {
this.alController.disableAdaptiveLighting()
if (this.enableLogging) {
this.log('[%s] adaptive lighting disabled due to change of mired.', this.name)
}
}
}
}
}
}
}