homebridge-deconz 0.0.16 → 0.0.17

package/lib/Deconz/ApiClient.js

@@ -81,9 +81,8 @@ class ApiClient extends homebridgeLib.HttpClient {
     * @return {integer} lux - The value in lux.
     */
   static lightLevelToLux (v) {
-    let lux = v ? Math.pow(10, (v - 1) / 10000) : 0.0001
-    lux = Math.round(lux * 10000) / 10000
-    return Math.max(0.0001, Math.min(lux, 100000))
+    v = Math.max(0, Math.min(v, 60001))
+    return v ? Math.round(Math.pow(10, (v - 1) / 10000) * 10) / 10 : 0.0001
   }
 
   /** Create a new instance of a Deconz.Client.

package/lib/Deconz/Resource.js

@@ -21,8 +21,9 @@ const sensorsPrios = [
   'Power',
   'Consumption',
   'Temperature',
-  'Presence',
+  'Motion',
   'OpenClose',
+  'AirPurifier',
   'Thermostat'
 ]
 
@@ -305,6 +306,8 @@ class Resource {
       }
     } else { // (this.rtype === 'sensors')
       switch (this.body.type) {
+        case 'CLIPAirPurifier':
+        case 'ZHAAirPurifier': return 'AirPurifier'
         case 'ZHAAirQuality':
         case 'CLIPAirQuality': return 'AirQuality'
         case 'ZHAAlarm':

package/lib/DeconzAccessory/AirPurifier.js

@@ -0,0 +1,38 @@
+// homebridge-deconz/lib/DeconzAccessory/Thermostat.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const DeconzAccessory = require('../DeconzAccessory')
+
+class AirPurifier extends DeconzAccessory {
+  /** Instantiate a delegate for an accessory corresponding to a device.
+    * @param {DeconzAccessory.Gateway} gateway - The gateway.
+    * @param {Deconz.Device} device - The device.
+    */
+  constructor (gateway, device, settings = {}) {
+    super(gateway, device, gateway.Accessory.Categories.AIR_PURIFIER)
+    this.identify()
+
+    this.service = this.createService(device.resource, { primaryService: true })
+
+    for (const subtype in device.resourceBySubtype) {
+      const resource = device.resourceBySubtype[subtype]
+      if (subtype === device.primary) {
+        continue
+      }
+      this.createService(resource)
+    }
+
+    this.createSettingsService()
+
+    setImmediate(() => {
+      this.debug('initialised')
+      this.emit('initialised')
+    })
+  }
+}
+
+module.exports = AirPurifier

package/lib/DeconzAccessory/Gateway.js

@@ -54,12 +54,20 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
       * devices.
       * @property {Object} fullState - The gateway's full state, from the
       * last time the gateway was polled.
+      * @property {Object} settings - The persisted settings, maintained through
+      * the Homebridge UI.
       */
     this.context // eslint-disable-line no-unused-expressions
     this.context.host = params.host
     this.context.config = params.config
-    if (this.context.blacklist == null) {
-      this.context.blacklist = {}
+    if (this.context.settingsById == null) {
+      this.context.settingsById = {}
+      // migration
+      for (const id in this.context.blacklist) {
+        this.context.settingsById[id] = { expose: false }
+      }
+      delete this.context.blacklist
+      // end migration
     }
     if (this.context.fullState != null) {
       this.analyseFullState(this.context.fullState, { analyseOnly: true })
@@ -217,9 +225,9 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
         '%d accessories with expose errors: %j', exposeErrors.length,
         exposeErrors
       )
-      const blacklist = Object.keys(this.context.blacklist).sort()
+      const settings = Object.keys(this.context.settingsById).sort()
       this.vdebug(
-        'blacklist: %d devices: %j', blacklist.length, blacklist)
+        'settings: %d devices: %j', settings.length, settings)
     }
   }
 
@@ -465,7 +473,14 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
         this.deleteService(id)
       }
       this.exposeErrors = {}
-      this.context.blacklist = {}
+      this.context.settingsById = {}
+      this.context.settingsById[this.id] = {
+        autoExposeGroups: false,
+        autoExposeLights: false,
+        autoExposeSensors: false,
+        autoExposeSchedules: false,
+        logLevel: 2
+      }
       this.context.fullState = null
       this.context.migration = null
       this.service.values.lights = false
@@ -494,11 +509,7 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
     if (this.deviceById[id] == null) {
       throw new RangeError(`${id}: unknown device ID`)
     }
-    if (expose) {
-      delete this.context.blacklist[id]
-    } else {
-      this.context.blacklist[id] = true
-    }
+    this.context.settingsById[id].expose = expose
     this.pollNext = true
   }
 
@@ -614,7 +625,7 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
         name: body.name + ' Settings',
         subtype: id,
         resource: rpaths.join(', '),
-        expose: this.context.blacklist[id] == null
+        expose: this.context.settingsById[id].expose
       })
       this.serviceById[id] = service
     }
@@ -854,7 +865,7 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
         if (
           this.deviceById[id] == null
         ) {
-          delete this.context.blacklist[id]
+          delete this.context.settingsById[id]
           this.deleteAccessory(id)
           this.deleteService(id)
           changed = true
@@ -888,7 +899,10 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
       for (const rid of rids) {
         try {
           const { id } = this.deviceByRidByRtype[rtype][rid]
-          if (this.context.blacklist[id] == null) {
+          if (this.context.settingsById[id] == null) {
+            this.context.settingsById[id] = { expose: true }
+          }
+          if (this.context.settingsById[id].expose) {
             if (this.accessoryById[id] == null) {
               this.addAccessory(id)
               changed = true

package/lib/DeconzAccessory/Motion.js

@@ -34,6 +34,9 @@ class Motion extends DeconzAccessory {
       this, {},
       this.service.characteristicDelegate('motion'),
       this.service.characteristicDelegate('lastActivation'),
+      this.serviceByServiceName.LightLevel == null
+        ? null
+        : this.serviceByServiceName.LightLevel.characteristicDelegate('lightlevel'),
       this.serviceByServiceName.Temperature == null
         ? null
         : this.serviceByServiceName.Temperature.characteristicDelegate('temperature')

package/lib/DeconzService/AirPurifier.js

@@ -0,0 +1,216 @@
+// homebridge-deconz/lib/DeconzService/AirPurifier.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const DeconzService = require('../DeconzService')
+
+class FilterMaintenance extends DeconzService.SensorsResource {
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.hap.FilterMaintenance
+    super(accessory, resource, params)
+
+    this.addCharacteristicDelegate({
+      key: 'filterChange',
+      Characteristic: this.Characteristics.hap.FilterChangeIndication
+    })
+
+    if (
+      resource.body.config.filterlifetime !== undefined &&
+      resource.body.state.filterruntime !== undefined
+    ) {
+      this.addCharacteristicDelegate({
+        key: 'filterLifeLevel',
+        Characteristic: this.Characteristics.hap.FilterLifeLevel,
+        unit: '%'
+      })
+      this.addCharacteristicDelegate({
+        key: 'resetFilter',
+        Characteristic: this.Characteristics.hap.ResetFilterIndication,
+        props: { adminOnlyAccess: [this.Characteristic.Access.WRITE] },
+        value: 0
+      }).on('didSet', async (value, fromHomeKit) => {
+        await this.put('/config', { filterlifetime: 6 * 30 * 24 * 60 })
+      })
+      this.values.filterLifeTime = resource.body.config.filterlifetime
+    }
+
+    this.update(resource.body)
+  }
+
+  updateState (state) {
+    if (this.values.filterLifeTime != null && state.filterruntime != null) {
+      this.values.filterLifeLevel = 100 - Math.round(
+        100 * state.filterruntime / this.values.filterLifeTime
+      )
+    }
+    if (state.replacefilter != null) {
+      this.values.filterChange = state.filterChange
+        ? this.Characteristics.hap.FilterChangeIndication.CHANGE_FILTER
+        : this.Characteristics.hap.FilterChangeIndication.FILTER_OK
+    }
+  }
+
+  updateConfig (config) {
+    if (config.filterlifetime != null) {
+      this.values.filterLifeTime = config.filterlifetime
+    }
+  }
+}
+
+/**
+  * @memberof DeconzService
+  */
+class AirPurifier extends DeconzService.SensorsResource {
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.hap.AirPurifier
+    super(accessory, resource, params)
+
+    this.addCharacteristicDelegate({
+      key: 'active',
+      Characteristic: this.Characteristics.hap.Active
+    }).on('didSet', async (value, fromHomeKit) => {
+      if (fromHomeKit) {
+        await this.put('/config', { mode: this.modeValue(value) })
+      }
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'currentState',
+      Characteristic: this.Characteristics.hap.CurrentAirPurifierState
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'targetState',
+      Characteristic: this.Characteristics.hap.TargetAirPurifierState
+    }).on('didSet', async (value, fromHomeKit) => {
+      if (fromHomeKit) {
+        await this.put('/config', { mode: this.modeValue(null, value) })
+      }
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'rotationSpeed',
+      Characteristic: this.Characteristics.hap.RotationSpeed,
+      unit: '%'
+    }).on('didSet', async (value, fromHomeKit) => {
+      if (fromHomeKit) {
+        await this.put('/config', { mode: this.modeValue(null, null, value) })
+      }
+    })
+
+    if (resource.body.state.airquality !== undefined) {
+      this.airQualityService = new DeconzService.AirQuality(accessory, resource, {
+        linkedServiceDelegate: this
+      })
+    }
+
+    if (resource.body.state.replacefilter !== undefined) {
+      this.filterService = new FilterMaintenance(accessory, resource, {
+        linkedServiceDelegate: this
+      })
+    }
+
+    if (resource.body.state.deviceruntime !== undefined) {
+      // TODO
+    }
+
+    if (resource.body.config.ledindication !== undefined) {
+      // TODO
+    }
+
+    if (resource.body.config.locked !== undefined) {
+      this.addCharacteristicDelegate({
+        key: 'lockPhysicalControls',
+        Characteristic: this.Characteristics.hap.LockPhysicalControls
+      }).on('didSet', async (value, fromHomeKit) => {
+        if (fromHomeKit) {
+          await this.put('/config', {
+            locked: value === this.Characteristics.hap.LockPhysicalControls
+              .CONTROL_LOCK_ENABLED
+          })
+        }
+      })
+    }
+
+    super.addCharacteristicDelegates()
+
+    this.update(resource.body)
+  }
+
+  modeValue (
+    active = this.values.active,
+    targetState = this.values.targetState,
+    rotationSpeed = this.values.rotationSpeed
+  ) {
+    if (active === this.Characteristics.hap.Active.INACTIVE) {
+      return 'off'
+    }
+    if (
+      targetState === this.Characteristics.hap.TargetAirPurifierState.AUTO ||
+      rotationSpeed === 0
+    ) {
+      return 'auto'
+    }
+    return 'speed_' + Math.round(rotationSpeed / 20)
+  }
+
+  updateState (state) {
+    if (this.values.filterLifeTime != null && state.filterruntime != null) {
+      this.values.filterLifeLevel = 100 - Math.round(
+        100 * state.filterruntime / this.values.filterLifeTime
+      )
+    }
+    if (state.replacefilter != null) {
+      this.values.filterChange = state.filterChange
+        ? this.Characteristics.hap.FilterChangeIndication.CHANGE_FILTER
+        : this.Characteristics.hap.FilterChangeIndication.FILTER_OK
+    }
+    if (state.speed != null) {
+      this.values.active = state.speed > 0
+        ? this.Characteristics.hap.Active.ACTIVE
+        : this.Characteristics.hap.Active.INACTIVE
+      this.values.currentState = state.speed === 0
+        ? this.Characteristics.hap.CurrentAirPurifierState.INACTIVE
+        : this.Characteristics.hap.CurrentAirPurifierState.PURIFYING_AIR
+      this.values.rotationSpeed = state.speed
+    }
+    super.updateState(state)
+    if (this.airQualityService != null) {
+      this.airQualityService.updateState(state)
+    }
+    if (this.filterService != null) {
+      this.filterService.updateState(state)
+    }
+  }
+
+  updateConfig (config) {
+    if (config.filterlifetime != null) {
+      this.values.filterLifeTime = config.filterlifetime
+    }
+    if (config.ledindication != null) {
+      // TODO
+    }
+    if (config.locked != null) {
+      this.values.lockPhysicalControls = config.locked
+        ? this.Characteristics.hap.LockPhysicalControls.CONTROL_LOCK_ENABLED
+        : this.Characteristics.hap.LockPhysicalControls.CONTROL_LOCK_DISABLED
+    }
+    if (config.mode != null) {
+      this.values.targetState = config.mode === 'auto'
+        ? this.Characteristics.hap.TargetAirPurifierState.AUTO
+        : this.Characteristics.hap.TargetAirPurifierState.MANUAL
+    }
+    super.updateConfig(config)
+    if (this.airQualityService != null) {
+      this.airQualityService.updateConfig(config)
+    }
+    if (this.filterService != null) {
+      this.filterService.updateConfig(config)
+    }
+  }
+}
+
+module.exports = AirPurifier

package/lib/DeconzService/AirQuality.js

@@ -20,14 +20,27 @@ class AirQuality extends DeconzService.SensorsResource {
       Characteristic: this.Characteristics.hap.AirQuality
     })
 
-    this.addCharacteristicDelegate({
-      key: 'vocDensity',
-      Characteristic: this.Characteristics.hap.VOCDensity,
-      unit: ' µg/m³',
-      props: { minValue: 0, maxValue: 65535, minStep: 1 }
-    })
+    if (resource.body.state.airqualityppb !== undefined) {
+      this.addCharacteristicDelegate({
+        key: 'vocDensity',
+        Characteristic: this.Characteristics.hap.VOCDensity,
+        unit: ' µg/m³',
+        props: { minValue: 0, maxValue: 65535, minStep: 1 }
+      })
+    }
 
-    super.addCharacteristicDelegates()
+    if (resource.body.state.pm2_5 !== undefined) {
+      this.addCharacteristicDelegate({
+        key: 'pm2_5Density',
+        Characteristic: this.Characteristics.hap.PM2_5Density,
+        unit: ' µg/m³',
+        props: { minValue: 0, maxValue: 65535, minStep: 1 }
+      })
+    }
+
+    if (params.linkedServiceDelegate == null) {
+      super.addCharacteristicDelegates()
+    }
 
     this.update(resource.body)
   }
@@ -56,6 +69,9 @@ class AirQuality extends DeconzService.SensorsResource {
     if (state.airqualityppb != null) {
       this.values.vocDensity = Math.round(state.airqualityppb * 4.57)
     }
+    if (state.pm2_5 != null) {
+      this.values.pm2_5Density = state.pm2_5
+    }
     super.updateState(state)
   }
 }

package/lib/DeconzService/Contact.js

@@ -45,6 +45,8 @@ class Contact extends DeconzService.SensorsResource {
     })
 
     this.addCharacteristicDelegates({ noTampered: true })
+
+    this.update(resource.body)
   }
 
   updateState (state) {

package/lib/DeconzService/LightLevel.js

@@ -35,6 +35,8 @@ class LightLevel extends DeconzService.SensorsResource {
     })
 
     this.addCharacteristicDelegates()
+
+    this.update(resource.body)
   }
 
   updateState (state) {

package/lib/DeconzService/index.js

@@ -15,6 +15,7 @@ const { dateToString } = Deconz.ApiClient
   */
 class DeconzService extends homebridgeLib.ServiceDelegate {
   static get AirPressure () { return require('./AirPressure') }
+  static get AirPurifier () { return require('./AirPurifier') }
   static get AirQuality () { return require('./AirQuality') }
   static get Alarm () { return require('./Alarm') }
   static get Battery () { return require('./Battery') }

package/package.json

@@ -4,7 +4,7 @@
   "displayName": "Homebridge deCONZ",
   "author": "Erik Baauw",
   "license": "Apache-2.0",
-  "version": "0.0.16",
+  "version": "0.0.17",
   "keywords": [
     "homebridge-plugin",
     "homekit",
@@ -20,14 +20,14 @@
     "deconz": "cli/deconz.js"
   },
   "engines": {
-    "deCONZ": "2.15.3",
-    "homebridge": "^1.4.0",
-    "node": "^16.14.2"
+    "deCONZ": "2.16.1",
+    "homebridge": "^1.4.1",
+    "node": "^16.15.1"
   },
   "dependencies": {
-    "homebridge-lib": "~5.5.0",
+    "homebridge-lib": "~5.6.0",
     "semver": "^7.3.7",
-    "ws": "^8.5.0",
+    "ws": "^8.8.0",
     "xml2js": "~0.4.23"
   },
   "scripts": {