@homebridge-plugins/homebridge-ewelink
Version:
Homebridge plugin to integrate eWeLink devices into HomeKit.
383 lines (361 loc) • 11.7 kB
JavaScript
import platformConsts from '../utils/constants.js'
import { hasProperty, parseError } from '../utils/functions.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.lang = platform.lang
this.log = platform.log
this.platform = platform
// Set up variables from the accessory
this.name = accessory.displayName
this.accessory = accessory
this.isProPanel = [195, 228].includes(accessory.context.eweUIID)
// Initially set the online flag as true (to be then updated as false if necessary)
this.isOnline = true
// Set up custom variables for this device type
const deviceConf = platform.deviceConf[accessory.context.eweDeviceId] || {}
this.tempOffset = deviceConf.offset || platformConsts.defaultValues.offset
this.tempOffsetFactor = deviceConf.offsetFactor
// Set the correct logging variables for this accessory
switch (deviceConf.overrideLogging) {
case 'standard':
this.enableLogging = true
this.enableDebugLogging = false
break
case 'debug':
this.enableLogging = true
this.enableDebugLogging = true
break
case 'disable':
this.enableLogging = false
this.enableDebugLogging = false
break
default:
this.enableLogging = !platform.config.disableDeviceLogging
this.enableDebugLogging = platform.config.debug
break
}
// Add the temperature sensor service if it doesn't already exist
this.tempService = this.accessory.getService(this.hapServ.TemperatureSensor)
|| this.accessory.addService(this.hapServ.TemperatureSensor)
// Set custom properties of the current temperature characteristic
this.tempService.getCharacteristic(this.hapChar.CurrentTemperature).setProps({
minStep: 0.1,
})
this.cacheTemp = this.tempService.getCharacteristic(this.hapChar.CurrentTemperature).value
this.updateCache()
if (!this.isProPanel) {
// Add the outlet services if they don't already exist
this.service1 = this.accessory.getService('Channel 1')
|| this.accessory.addService(this.hapServ.Switch, 'Channel 1', 'channel1')
this.service2 = this.accessory.getService('Channel 2')
|| this.accessory.addService(this.hapServ.Switch, 'Channel 2', 'channel2')
// Add the set handler to the switch on/off characteristic
this.service1.getCharacteristic(this.hapChar.On).onSet(async (value) => {
await this.internalStateUpdate(this.service1, value)
})
this.cacheState1 = this.service1.getCharacteristic(this.hapChar.On).value ? 'on' : 'off'
this.service2.getCharacteristic(this.hapChar.On).onSet(async (value) => {
await this.internalStateUpdate(this.service2, value)
})
this.cacheState2 = this.service2.getCharacteristic(this.hapChar.On).value ? 'on' : 'off'
// Add the get handlers only if the user hasn't disabled the disableNoResponse setting
if (!platform.config.disableNoResponse) {
this.tempService.getCharacteristic(this.hapChar.CurrentTemperature).onGet(() => {
if (!this.isOnline) {
throw new this.hapErr(-70402)
}
return this.tempService.getCharacteristic(this.hapChar.CurrentTemperature).value
})
this.service1.getCharacteristic(this.hapChar.On).onGet(() => {
if (!this.isOnline) {
throw new this.hapErr(-70402)
}
return this.service1.getCharacteristic(this.hapChar.On).value
})
this.service2.getCharacteristic(this.hapChar.On).onGet(() => {
if (!this.isOnline) {
throw new this.hapErr(-70402)
}
return this.service2.getCharacteristic(this.hapChar.On).value
})
}
}
// Pass the accessory to Fakegato to set up with Eve
this.accessory.eveService = new platform.eveService('custom', this.accessory, {
log: () => {},
})
// Output the customised options to the log
const normalLogging = this.enableLogging ? 'standard' : 'disable'
const opts = JSON.stringify({
logging: this.enableDebugLogging ? 'debug' : normalLogging,
offset: this.tempOffset,
offsetFactor: this.tempOffsetFactor,
})
this.log('[%s] %s %s.', this.name, this.lang.devInitOpts, opts)
/*
{
"bindInfos":{
"gaction":[
""
],
"scene":2
},
"version":8,
"pulses":[
{
"pulse":"off",
"width":1000,
"outlet":0
},
{
"pulse":"off",
"width":1000,
"outlet":1
}
],
"switches":[
{
"switch":"off",
"outlet":0
},
{
"switch":"off",
"outlet":1
}
],
"configure":[
{
"startup":"off",
"outlet":0
},
{
"startup":"off",
"outlet":1
}
],
"lock":0,
"fwVersion":"1.0.2",
"temperature":24,
"humidity":50,
"tempUnit":0,
"HMI_outdoorTemp":{
"current":13,
"range":"-2,14"
},
"HMI_weather":1,
"cityId":"00000",
"dst":0,
"dstChange":"",
"geo":"",
"timeZone":1,
"HMI_dimEnable":0,
"HMI_resources":[
{
"ctype":"device",
"id":"100000000",
"uiid":6
},
{
"ctype":"device",
"id":"100000001",
"uiid":1
},
{
"ctype":"device",
"id":"100000002",
"uiid":6
},
{
"ctype":"idle"
},
{
"ctype":"idle"
},
{
"ctype":"idle"
},
{
"ctype":"idle"
},
{
"ctype":"idle"
}
],
"HMI_ATCDevice":{
"ctype":"device",
"id":"100000000",
"outlet":0,
"etype":"hot"
},
"ctype":"device",
"id":"100000000",
"resourcetype":"ATC",
"ATCMode":1,
"ATCExpect0":23,
"ATCEnable":1,
"ATCExpect1":23
}
*/
}
async internalStateUpdate(service, value) {
try {
const newValue = value ? 'on' : 'off'
const params = { switches: [] }
switch (service) {
case this.service1: {
if (newValue === this.cacheState1) {
return
}
params.switches.push({ outlet: 0, switch: value ? 'on' : 'off' })
break
}
case this.service2: {
if (newValue === this.cacheState2) {
return
}
params.switches.push({ outlet: 1, switch: value ? 'on' : 'off' })
break
}
default:
return
}
await this.platform.sendDeviceUpdate(this.accessory, params)
switch (service) {
case this.service1: {
this.cacheState1 = newValue
if (this.enableLogging) {
this.log(
'[%s] [%s] %s [%s].',
this.name,
service.displayName,
this.lang.curState,
this.cacheState1,
)
}
break
}
case this.service2: {
this.cacheState2 = newValue
if (this.enableLogging) {
this.log(
'[%s] [%s] %s [%s].',
this.name,
service.displayName,
this.lang.curState,
this.cacheState2,
)
}
break
}
default:
}
} catch (err) {
this.platform.deviceUpdateError(this.accessory, err, true)
setTimeout(() => {
service.updateCharacteristic(
this.hapChar.On,
service.getCharacteristic(this.hapChar.On).value,
)
}, 2000)
throw new this.hapErr(-70402)
}
}
async externalUpdate(params) {
try {
// Switches
if (params.switches && Array.isArray(params.switches)) {
params.switches.forEach((switchEntry) => {
const newValue = switchEntry.switch
switch (switchEntry.outlet) {
case 0: {
if (newValue !== this.cacheState1) {
this.cacheState1 = newValue
this.service1.updateCharacteristic(this.hapChar.On, this.cacheState1 === 'on')
if (params.updateSource && this.enableLogging) {
this.log(
'[%s] [%s] %s [%s].',
this.name,
this.service1.displayName,
this.lang.curState,
this.cacheState1,
)
}
}
break
}
case 1: {
if (newValue !== this.cacheState2) {
this.cacheState2 = newValue
this.service2.updateCharacteristic(this.hapChar.On, this.cacheState2 === 'on')
if (params.updateSource && this.enableLogging) {
this.log(
'[%s] [%s] %s [%s].',
this.name,
this.service2.displayName,
this.lang.curState,
this.cacheState2,
)
}
}
break
}
default:
}
})
}
// Current temperature
if (hasProperty(params, 'temperature')) {
let newTemp = Number(params.temperature)
if (this.tempOffsetFactor) {
newTemp *= this.tempOffset
} else {
newTemp += this.tempOffset
}
if (newTemp !== this.cacheTemp) {
this.cacheTemp = newTemp
this.tempService.updateCharacteristic(this.hapChar.CurrentTemperature, this.cacheTemp)
this.accessory.eveService.addEntry({ temp: this.cacheTemp })
if (params.updateSource && this.enableLogging) {
this.log('[%s] %s [%s°C].', this.name, this.lang.curTemp, this.cacheTemp)
}
// Update the cache file with the new temperature
this.updateCache()
}
}
} catch (err) {
this.platform.deviceUpdateError(this.accessory, err, false)
}
}
async updateCache() {
// Don't continue if the storage client hasn't initialised properly
if (!this.platform.storageClientData) {
return
}
// Attempt to save the new temperature to the cache
try {
await this.platform.storageData.setItem(
`${this.accessory.context.eweDeviceId}_temp`,
this.cacheTemp,
)
} catch (err) {
if (this.enableLogging) {
this.log.warn('[%s] %s %s.', this.name, this.lang.storageWriteErr, parseError(err))
}
}
}
currentState() {
const toReturn = {}
toReturn.services = ['temperature']
toReturn.temperature = {
current: this.tempService.getCharacteristic(this.hapChar.CurrentTemperature).value,
}
return toReturn
}
markStatus(isOnline) {
this.isOnline = isOnline
}
}