homebridge-deconz 0.0.15 → 0.0.18

package/lib/DeconzAccessory/Gateway.js

@@ -44,6 +44,7 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
 
     this.gateway = this
     this.id = params.config.bridgeid
+    this.recommendedSoftware = this.platform.packageJson.engines.deCONZ
 
     /** Persisted properties.
       * @type {Object}
@@ -53,15 +54,26 @@ 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 })
+      this.analyseFullState(this.context.fullState, {
+        analyseOnly: true,
+        logUnsupported: true
+      })
     }
 
     this.addPropertyDelegate({
@@ -109,6 +121,9 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
       '%s %s gateway v%s', this.values.manufacturer, this.values.model,
       this.values.software
     )
+    if (this.values.software !== this.recommendedSoftware) {
+      this.warn('recommended version: deCONZ v%s', this.recommendedSoftware)
+    }
 
     /** Map of Accessory delegates by id for the gateway.
       * @type {Object<string, DeconzAccessory.Device>}
@@ -182,6 +197,9 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
       this.values.manufacturer, this.values.model, this.values.software,
       this.nAccessories, this.nDevices, this.nResourcesMonitored
     )
+    if (this.values.software !== this.recommendedSoftware) {
+      this.warn('recommended version: deCONZ v%s', this.recommendedSoftware)
+    }
     if (this.context.migration != null) {
       this.log(
         'migration: %s: %d resources',
@@ -210,9 +228,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)
     }
   }
 
@@ -458,7 +476,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
@@ -487,11 +512,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
   }
 
@@ -607,7 +628,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
     }
@@ -716,11 +737,11 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
       this.vdebug('polling done')
       this.pollNext = false
       this.polling = false
-      if (!this.initialised) {
-        this.initialised = true
-        this.debug('initialised')
-        this.emit('initialised')
-      }
+    }
+    if (!this.initialised) {
+      this.initialised = true
+      this.debug('initialised')
+      this.emit('initialised')
     }
   }
 
@@ -756,7 +777,7 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
     * @param {Object} fullState - The gateway full state, as returned by
     * {@link DeconzAccessory.Gateway#poll poll()}.
     * @param {Object} params - Parameters
-    * @param {boolean} [params.logUnsupportedResources=false] - Issue debug
+    * @param {boolean} [params.logUnsupported=false] - Issue debug
     * messsages for unsupported resources.
     * @param {boolean} [params.analyseOnly=false]
     */
@@ -847,7 +868,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
@@ -881,7 +902,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/DeconzAccessory/index.js

@@ -39,7 +39,7 @@ class DeconzAccessory extends homebridgeLib.AccessoryDelegate {
       manufacturer: device.resource.manufacturer,
       model: device.resource.model,
       firmware: device.resource.firmware,
-      category: category
+      category
     })
 
     this.context.gid = gateway.id
@@ -187,8 +187,8 @@ class DeconzAccessory extends homebridgeLib.AccessoryDelegate {
     }
     this.serviceBySubtype[resource.subtype] = service
     this.serviceByRpath[resource.rpath] = service
-    if (this.serviceByServiceName[resource.serviceName] == null) {
-      this.serviceByServiceName[resource.serviceName] = service
+    if (this.serviceByServiceName[params.serviceName] == null) {
+      this.serviceByServiceName[params.serviceName] = service
     }
     if (
       resource.body.config != null &&

package/lib/DeconzPlatform.js

@@ -70,13 +70,17 @@ class DeconzPlatform extends homebridgeLib.Platform {
       })
       this.discovery
         .on('error', (error) => {
-          this.log(
-            '%s: request %d: %s %s', error.request.name,
-            error.request.id, error.request.method, error.request.resource
-          )
-          this.warn(
-            '%s: request %d: %s', error.request.name, error.request.id, error
-          )
+          if (error instanceof homebridgeLib.HttpClient.HttpError) {
+            this.log(
+              '%s: request %d: %s %s', error.request.name,
+              error.request.id, error.request.method, error.request.resource
+            )
+            this.warn(
+              '%s: request %d: %s', error.request.name, error.request.id, error
+            )
+            return
+          }
+          this.warn(error)
         })
         .on('request', (request) => {
           this.debug(
@@ -105,10 +109,7 @@ class DeconzPlatform extends homebridgeLib.Platform {
   async foundGateway (host, config) {
     const id = config.bridgeid
     if (this.gatewayMap[id] == null) {
-      this.gatewayMap[id] = new DeconzAccessory.Gateway(this, {
-        config: config,
-        host: host
-      })
+      this.gatewayMap[id] = new DeconzAccessory.Gateway(this, { config, host })
     }
     await this.gatewayMap[id].found(host, config)
     await events.once(this.gatewayMap[id], 'initialised')
@@ -190,7 +191,7 @@ class DeconzPlatform extends homebridgeLib.Platform {
             gatewayByHost[gateway.context.host] = {
               config: gateway.context.config,
               host: gateway.context.host,
-              id: id
+              id
             }
           }
           return {

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.replacefilter
+        ? 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/Button.js

@@ -167,6 +167,10 @@ class Button extends homebridgeLib.ServiceDelegate {
       this.values.event = event
     }
   }
+
+  updateRotation () {
+    this.values.event = homeKitEvent.SINGLE_PRESS
+  }
 }
 
 module.exports = Button

package/lib/DeconzService/Consumption.js

@@ -57,7 +57,7 @@ class Consumption extends DeconzService.SensorsResource {
   }
 
   updateState (state) {
-    Consumption.updateResourceState(this.service, state)
+    Consumption.updateResourceState(this, state)
     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/Light.js

@@ -51,7 +51,7 @@ class Light extends DeconzService.LightsResource {
       }).on('didSet', (value, fromHomeKit) => {
         if (fromHomeKit) {
           const bri = Math.round(value * 2.54)
-          this.put({ bri: bri })
+          this.put({ bri })
           this.updateAdaptiveLighting()
         }
       })
@@ -97,7 +97,7 @@ class Light extends DeconzService.LightsResource {
           this.capabilities.ctMin, Math.min(value, this.capabilities.ctMax)
         )
         if (fromHomeKit) {
-          this.put({ ct: ct })
+          this.put({ ct })
           this.values.colormode = 'ct'
         }
         if (this.capabilities.xy && this.values.colormode === 'ct') {
@@ -118,7 +118,7 @@ class Light extends DeconzService.LightsResource {
           const xy = hsvToXy(
             value, this.values.saturation, this.capabilities.gamut
           )
-          this.put({ xy: xy })
+          this.put({ xy })
           this.values.colormode = 'xy'
         }
       })
@@ -129,7 +129,7 @@ class Light extends DeconzService.LightsResource {
       }).on('didSet', (value, fromHomeKit) => {
         if (fromHomeKit) {
           const xy = hsvToXy(this.values.hue, value, this.capabilities.gamut)
-          this.put({ xy: xy })
+          this.put({ xy })
           this.values.colormode = 'xy'
         }
       })
@@ -141,7 +141,7 @@ class Light extends DeconzService.LightsResource {
       }).on('didSet', (value, fromHomeKit) => {
         if (fromHomeKit) {
           const hue = Math.round(this.values.hue * 65535.0 / 360.0)
-          this.put({ hue: hue })
+          this.put({ hue })
           this.values.colormode = 'hs'
         }
       })
@@ -152,7 +152,7 @@ class Light extends DeconzService.LightsResource {
       }).on('didSet', (value, fromHomeKit) => {
         if (fromHomeKit) {
           const sat = Math.round(this.values.saturation * 254.0 / 100.0)
-          this.put({ sat: sat })
+          this.put({ sat })
           this.values.colormode = 'hs'
         }
       })
@@ -165,7 +165,7 @@ class Light extends DeconzService.LightsResource {
       }).on('didSet', (value, fromHomeKit) => {
         if (fromHomeKit) {
           const effect = value ? 'colorloop' : 'none'
-          const state = { effect: effect }
+          const state = { effect }
           if (value) {
             state.colorloopspeed = this.values.colorLoopSpeed
           }
@@ -181,7 +181,7 @@ class Light extends DeconzService.LightsResource {
       }).on('didSet', (value, fromHomeKit) => {
         if (fromHomeKit) {
           const effect = 'colorloop'
-          this.put({ effect: effect, colorloopspeed: value })
+          this.put({ effect, colorloopspeed: value })
           this.values.colormode = 'hs'
         }
       })
@@ -467,7 +467,7 @@ class Light extends DeconzService.LightsResource {
     if (this.values.colormode === 'ct' && ct === this.values.colorTemperature) {
       return
     }
-    this.put({ ct: ct })
+    this.put({ ct })
     this.fromAdaptiveLighting = true
     this.values.colormode = 'ct'
     if (ct !== this.values.colorTemperature) {

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/Motion.js

@@ -35,7 +35,7 @@ class Motion extends DeconzService.SensorsResource {
           : value === this.Characteristics.eve.Sensitivity.LOW
             ? 0
             : Math.round(this.sensitivitymax / 2)
-        await this.put('/config', { sensitivity: sensitivity })
+        await this.put('/config', { sensitivity })
       }
     })
 

package/lib/DeconzService/Outlet.js

@@ -39,7 +39,7 @@ class Outlet extends DeconzService.LightsResource {
     this.addCharacteristicDelegate({
       key: 'outletInUse',
       Characteristic: this.Characteristics.hap.OutletInUse,
-      value: 1
+      value: 1 // Eve interpretes OutletInUse as: device is physically plugged in.
     })
 
     this.addCharacteristicDelegates()

package/lib/DeconzService/Power.js

@@ -75,7 +75,7 @@ class Power extends DeconzService.SensorsResource {
   }
 
   updateState (state) {
-    Power.updateResourceState(this.service, state)
+    Power.updateResourceState(this, state)
     super.updateState(state)
   }
 }