homebridge-meross
Version:
Homebridge plugin to control Meross devices.
253 lines (223 loc) • 8.99 kB
JavaScript
/* jshint node: true,esversion: 9, -W014, -W033 */
/* eslint-disable new-cap */
'use strict'
const { default: PQueue } = require('p-queue')
module.exports = class deviceRoller {
constructor (platform, accessory) {
// Set up variables from the platform
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.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.reversePolarity = this.accessory.context.options.reversePolarity
// Add the switch services
this.serviceOpen =
this.accessory.getService('Open') ||
this.accessory.addService(this.hapServ.Switch, 'Open', 'open')
this.serviceClose =
this.accessory.getService('Close') ||
this.accessory.addService(this.hapServ.Switch, 'Close', 'close')
this.serviceStop =
this.accessory.getService('Stop') ||
this.accessory.addService(this.hapServ.Switch, 'Stop', 'stop')
// Add the set handler to the open switch service
this.serviceOpen
.getCharacteristic(this.hapChar.On)
.onSet(async value => {
await this.internalStateUpdate(value, this.reversePolarity ? 0 : 100, this.serviceOpen)
})
.updateValue(false)
// Add the set handler to the close switch service
this.serviceClose
.getCharacteristic(this.hapChar.On)
.onSet(async value => {
await this.internalStateUpdate(value, this.reversePolarity ? 100 : 0, this.serviceClose)
})
.updateValue(false)
// Add the set handler to the stop switch service
this.serviceStop
.getCharacteristic(this.hapChar.On)
.onSet(async value => await this.internalStateUpdate(value, -1, this.serviceStop))
.updateValue(false)
// 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
})
this.states = {
1: 'stopped',
0: 'closing',
100: 'opening'
}
// 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()
}
// Always request a device update on startup
this.requestUpdate(true)
// Stop the intervals and close mqtt connection on Homebridge shutdown
platform.api.on('shutdown', () => {
if (this.accessory.mqtt) {
this.accessory.mqtt.disconnect()
}
})
// Output the customised options to the log
const opts = JSON.stringify({
connection: this.accessory.context.connection,
logging: this.enableDebugLogging ? 'debug' : this.enableLogging ? 'standard' : 'disable',
reversePolarity: this.reversePolarity,
showAs: 'switch'
})
this.log('[%s] %s %s.', this.name, this.lang.devInitOpts, opts)
}
async internalStateUpdate (value, newPosition, hapServ) {
try {
// Only control when turning on a switch
if (!value) {
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
// Generate the payload and namespace for the correct device model
const namespace = 'Appliance.RollerShutter.Position'
const payload = {
position: {
position: newPosition,
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, this.states[Math.abs(newPosition)])
}
// Turn the switch off again after two seconds
setTimeout(() => {
hapServ.updateCharacteristic(this.hapChar.On, false)
}, 2000)
})
} 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(() => {
hapServ.updateCharacteristic(this.hapChar.On, 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) {
// 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)
}
}
}
}
}