homebridge-deconz 0.1.9 → 0.1.11

package/lib/DeconzAccessory/Gateway.js

@@ -13,6 +13,12 @@ const Deconz = require('../Deconz')
 const DeconzAccessory = require('../DeconzAccessory')
 const DeconzService = require('../DeconzService')
 
+const migration = {
+  name: 'homebridge-deconz',
+  description: 'migration',
+  classid: 1
+}
+
 const rtypes = ['lights', 'sensors', 'groups']
 
 const periodicEvents = [
@@ -516,9 +522,7 @@ class Gateway extends AccessoryDelegate {
     }
     try {
       try {
-        if (this.context.migration != null) {
-          await this.client.delete(this.context.migration)
-        }
+        await this.deleteMigration()
         await this.client.deleteApiKey()
       } catch (error) {}
       this.values.apiKey = null
@@ -531,7 +535,6 @@ class Gateway extends AccessoryDelegate {
       this.exposeErrors = {}
       this.context.settingsById = {}
       this.context.fullState = null
-      this.context.migration = null
       this.values.logLevel = 2
     } catch (error) { this.error(error) }
   }
@@ -669,6 +672,60 @@ class Gateway extends AccessoryDelegate {
     this.deleteService(id)
   }
 
+  /** Assert that migration resourcelink exists and is valid.
+    */
+  async checkMigration () {
+    if (this.context.migration != null) {
+      try {
+        const response = await this.client.get(this.context.migration)
+        if (
+          response.name !== migration.name ||
+          response.description !== migration.description ||
+          response.classid !== migration.classid ||
+          response.owner !== this.client.apiKey
+        ) {
+          // not my migration resourcelink
+          this.warn('%s: migration resourcelink no longer valid', this.context.migration)
+          this.context.migration = null
+        }
+      } catch (error) {
+        if (error.statusCode === 404) {
+          this.warn('%s: migration resourcelink no longer exists', this.context.migration)
+          this.context.migration = null
+        }
+      }
+    }
+  }
+
+  /** Create or update migration resourcelink.
+    */
+  async updateMigration () {
+    await this.checkMigration()
+    if (this.context.migration == null) {
+      const response = await this.client.post('/resourcelinks', {
+        name: migration.name,
+        description: migration.description,
+        classid: migration.classid,
+        links: Object.keys(this.accessoryByRpath).sort()
+      })
+      this.context.migration = '/resourcelinks/' + response.success.id
+    } else {
+      await this.client.put(this.context.migration, {
+        links: Object.keys(this.accessoryByRpath).sort()
+      })
+    }
+  }
+
+  /** Delete migration resourcelink.
+    */
+  async deleteMigration () {
+    await this.checkMigration()
+    if (this.context.migration != null) {
+      await this.client.delete(this.context.migration)
+      this.context.migration = null
+    }
+  }
+
   // ===========================================================================
 
   _deviceToMap (id, details = false) {
@@ -733,7 +790,7 @@ class Gateway extends AccessoryDelegate {
         return { status: 200, body }
       }
       if (path.length === 2) {
-        const id = path[1]
+        const id = path[1].replace(/:/g, '').toUpperCase()
         if (this.accessoryById[id] == null) {
           return { status: 404 } // Not Found
         }
@@ -749,7 +806,7 @@ class Gateway extends AccessoryDelegate {
         return { status: 200, body }
       }
       if (path.length === 2) {
-        return this._deviceToMap(path[1], true)
+        return this._deviceToMap(path[1].replace(/:/g, '').toUpperCase(), true)
       }
     }
     return { status: 403 } // Forbidden
@@ -808,7 +865,7 @@ class Gateway extends AccessoryDelegate {
         return { status: 405 } // Method Not Allowed
       }
       if (path.length === 3 && path[2] === 'settings') {
-        const id = path[1]
+        const id = path[1].replace(/:/g, '').toUpperCase()
         if (this.accessoryById[id] == null) {
           return { status: 404 } // Not Found
         }
@@ -820,7 +877,7 @@ class Gateway extends AccessoryDelegate {
         return { status: 405 } // Method Not Allowed
       }
       if (path.length === 3 && path[2] === 'settings') {
-        const id = path[1]
+        const id = path[1].replace(/:/g, '').toUpperCase()
         if (this.deviceById[id] == null) {
           return { status: 404 } // Not Found
         }
@@ -1060,19 +1117,7 @@ class Gateway extends AccessoryDelegate {
     }
 
     if (changed) {
-      if (this.context.migration == null) {
-        const response = await this.client.post('/resourcelinks', {
-          name: 'homebridge-deconz',
-          description: 'migration',
-          classid: 1,
-          links: Object.keys(this.accessoryByRpath).sort()
-        })
-        this.context.migration = '/resourcelinks/' + response.success.id
-      } else {
-        await this.client.put(this.context.migration, {
-          links: Object.keys(this.accessoryByRpath).sort()
-        })
-      }
+      await this.updateMigration()
       this.identify()
     }
   }

package/lib/DeconzAccessory/Light.js

@@ -25,7 +25,7 @@ class Light extends DeconzAccessory {
 
     this.addPropertyDelegate({
       key: 'serviceName',
-      value: device.resource.capabilities.bri ? 'Light' : 'Outlet'
+      value: device.resource.serviceName
     })
 
     this.service = this.createService(device.resource, {
@@ -65,20 +65,20 @@ class Light extends DeconzAccessory {
         silent: true
       })
     }
-    if (this.serviceByServiceName.Consumption != null) {
-      params.consumptionDelegate = this.service.characteristicDelegate('totalConsumption')
-      if (this.service.values.currentConsumption === undefined) {
-        // Current Consumption to be computed by history if not exposed by device
-        params.computedPowerDelegate = this.service.addCharacteristicDelegate({
-          key: 'currentConsumption',
-          Characteristic: this.Characteristics.eve.CurrentConsumption,
+    if (this.servicesByServiceName.Consumption?.[0] != null) {
+      params.totalConsumptionDelegate = this.service.characteristicDelegate('totalConsumption')
+      if (this.service.values.consumption === undefined) {
+        // Power to be computed by history if not exposed by device
+        params.computedConsumptionDelegate = this.service.addCharacteristicDelegate({
+          key: 'consumption',
+          Characteristic: this.Characteristics.eve.Consumption,
           unit: ' W'
         })
       }
-    } else if (this.serviceByServiceName.Power != null) {
-      params.powerDelegate = this.service.characteristicDelegate('currentConsumption')
+    } else if (this.servicesByServiceName.Power?.[0] != null) {
+      params.consumptionDelegate = this.service.characteristicDelegate('consumption')
       // Total Consumption to be computed by history
-      params.computedConsumptionDelegate = this.service.addCharacteristicDelegate({
+      params.computedTotalConsumptionDelegate = this.service.addCharacteristicDelegate({
         key: 'totalConsumption',
         Characteristic: this.Characteristics.eve.TotalConsumption,
         unit: ' kWh'

package/lib/DeconzAccessory/Sensor.js

@@ -3,6 +3,11 @@
 //
 // Homebridge plugin for deCONZ.
 
+// Keep separate for Eve History
+// Switch/Outlet/Lightbulb
+// Stateless Programmable Switch (Eve button)
+// Sensors
+
 'use strict'
 
 const { ServiceDelegate } = require('homebridge-lib')
@@ -51,8 +56,8 @@ class Sensor extends DeconzAccessory {
     }
 
     const params = {}
-    if (this.serviceByServiceName.Contact != null) {
-      const service = this.serviceByServiceName.Contact
+    if (this.servicesByServiceName.Contact?.length === 1) {
+      const service = this.servicesByServiceName.Contact[0]
       params.contactDelegate = service.characteristicDelegate('contact')
       params.lastContactDelegate = service.addCharacteristicDelegate({
         key: 'lastActivation',
@@ -66,8 +71,8 @@ class Sensor extends DeconzAccessory {
         silent: true
       })
     }
-    if (this.serviceByServiceName.Motion != null) {
-      const service = this.serviceByServiceName.Motion
+    if (this.servicesByServiceName.Motion?.length === 1) {
+      const service = this.servicesByServiceName.Motion[0]
       params.motionDelegate = service.characteristicDelegate('motion')
       params.lastMotionDelegate = service.addCharacteristicDelegate({
         key: 'lastActivation',
@@ -75,34 +80,34 @@ class Sensor extends DeconzAccessory {
         silent: true
       })
     }
-    if (this.serviceByServiceName.LightLevel != null) {
-      const service = this.serviceByServiceName.LightLevel
+    if (this.servicesByServiceName.LightLevel?.length === 1) {
+      const service = this.servicesByServiceName.LightLevel[0]
       params.lightLevelDelegate = service.characteristicDelegate('lightLevel')
     }
-    if (this.serviceByServiceName.Daylight != null) {
-      const service = this.serviceByServiceName.Daylight
+    if (this.servicesByServiceName.Daylight?.length === 1) {
+      const service = this.servicesByServiceName.Daylight[0]
       params.lightLevelDelegate = service.characteristicDelegate('lightLevel')
     }
-    if (this.serviceByServiceName.Temperature != null) {
-      const service = this.serviceByServiceName.Temperature
+    if (this.servicesByServiceName.Temperature?.length === 1) {
+      const service = this.servicesByServiceName.Temperature[0]
       params.temperatureDelegate = service.characteristicDelegate('temperature')
     }
-    if (this.serviceByServiceName.Humidity != null) {
-      const service = this.serviceByServiceName.Humidity
+    if (this.servicesByServiceName.Humidity?.length === 1) {
+      const service = this.servicesByServiceName.Humidity[0]
       params.humidityDelegate = service.characteristicDelegate('humidity')
     }
-    if (this.serviceByServiceName.AirPressure != null) {
-      const service = this.serviceByServiceName.AirPressure
+    if (this.servicesByServiceName.AirPressure?.length === 1) {
+      const service = this.servicesByServiceName.AirPressure[0]
       params.airPressureDelegate = service.characteristicDelegate('airPressure')
     }
-    if (this.serviceByServiceName.AirQuality != null) {
-      const service = this.serviceByServiceName.AirQuality
+    if (this.servicesByServiceName.AirQuality?.length === 1) {
+      const service = this.servicesByServiceName.AirQuality[0]
       if (service.characteristicDelegate('vocDensity') != null) {
         params.vocDensityDelegate = service.characteristicDelegate('vocDensity')
       }
     }
-    if (this.serviceByServiceName.Flag != null) {
-      const service = this.serviceByServiceName.Flag
+    if (this.servicesByServiceName.Flag != null) {
+      const service = this.servicesByServiceName.Flag[0]
       params.switchOnDelegate = service.characteristicDelegate('on')
       params.lastSwitchOnDelegate = service.addCharacteristicDelegate({
         key: 'lastActivation',

package/lib/DeconzAccessory/index.js

@@ -19,7 +19,9 @@ const { SINGLE, DOUBLE, LONG } = DeconzService.Button
 class DeconzAccessory extends AccessoryDelegate {
   static get Light () { return require('./Light') }
   static get Gateway () { return require('./Gateway') }
+  static get Outlet () { return DeconzAccessory.Light }
   static get Sensor () { return require('./Sensor') }
+  static get Switch () { return DeconzAccessory.Light }
   static get WarningDevice () { return require('./WarningDevice') }
   static get WindowCovering () { return require('./WindowCovering') }
 
@@ -29,7 +31,6 @@ class DeconzAccessory extends AccessoryDelegate {
     * @param {Accessory.Category} category - The HomeKit accessory category.
     */
   constructor (gateway, device, category) {
-    // TODO device settings
     super(gateway.platform, {
       id: device.id,
       name: device.resource.body.name,
@@ -44,7 +45,7 @@ class DeconzAccessory extends AccessoryDelegate {
 
     this.serviceByRpath = {}
     this.serviceBySubtype = {}
-    this.serviceByServiceName = {}
+    this.servicesByServiceName = {}
 
     /** The gateway.
       * @type {DeconzAccessory.Gateway}
@@ -139,23 +140,28 @@ class DeconzAccessory extends AccessoryDelegate {
     this.debug('%s: params: %j', resource.rpath, params)
 
     let service
-    if (params.serviceName === 'Battery') {
-      service = this.serviceByServiceName.Battery
+    if (params.serviceName === 'AirQuality') {
+      service = this.servicesByServiceName.AirQuality?.[0]
+      if (service != null) {
+        service.addResource(resource)
+      }
+    } else if (params.serviceName === 'Battery') {
+      service = this.servicesByServiceName.Battery?.[0]
     } else if (params.serviceName === 'Consumption') {
-      service = this.serviceByServiceName.Outlet ||
-        this.serviceByServiceName.Light ||
-        this.serviceByServiceName.Power
+      service = this.servicesByServiceName.Outlet?.[0] ||
+        this.servicesByServiceName.Light?.[0] ||
+        this.servicesByServiceName.Power?.[0]
       if (service != null) {
         service.addResource(resource)
       }
     } else if (params.serviceName === 'Power') {
-      service = this.serviceByServiceName.Outlet ||
-        this.serviceByServiceName.Light ||
-        this.serviceByServiceName.Consumption
+      service = this.servicesByServiceName.Outlet?.[0] ||
+        this.servicesByServiceName.Light?.[0] ||
+        this.servicesByServiceName.Consumption?.[0]
       if (service != null) {
         service.addResource(resource)
       }
-    } else if (params.serviceName === 'Switch') {
+    } else if (params.serviceName === 'Label') {
       // Default button
       if (resource.capabilities.buttons == null) {
         this.warn(
@@ -171,9 +177,9 @@ class DeconzAccessory extends AccessoryDelegate {
         resource.capabilities.namespace =
           this.Characteristics.hap.ServiceLabelNamespace.ARABIC_NUMERALS
       }
-      service = this.serviceByServiceName.Switch
+      service = this.servicesByServiceName.Label?.[0]
       if (service == null) {
-        service = new DeconzService.Switch(this, resource, {
+        service = new DeconzService.Label(this, resource, {
           primaryService: params.primaryService
         })
       }
@@ -186,17 +192,16 @@ class DeconzAccessory extends AccessoryDelegate {
     }
     this.serviceBySubtype[resource.subtype] = service
     this.serviceByRpath[resource.rpath] = service
-    if (this.serviceByServiceName[params.serviceName] == null) {
-      this.serviceByServiceName[params.serviceName] = service
+    if (this.servicesByServiceName[params.serviceName] == null) {
+      this.servicesByServiceName[params.serviceName] = [service]
+    } else {
+      this.servicesByServiceName[params.serviceName].push(service)
     }
-    if (
-      resource.body.config != null &&
-      resource.body.config.battery !== undefined
-    ) {
-      if (this.serviceByServiceName.Battery == null) {
-        this.serviceByServiceName.Battery = new DeconzService.Battery(this, resource)
+    if (resource.body.config?.battery !== undefined) {
+      if (this.servicesByServiceName.Battery?.[0] == null) {
+        this.servicesByServiceName.Battery = [new DeconzService.Battery(this, resource)]
       }
-      service.batteryService = this.serviceByServiceName.Battery
+      service.batteryService = this.servicesByServiceName.Battery[0]
     }
     return service
   }
@@ -232,12 +237,8 @@ class DeconzAccessory extends AccessoryDelegate {
             multiClip: undefined,
             multiLight: undefined,
             logLevel: this.values.logLevel,
-            lowBatteryThreshold: this.serviceByServiceName.Battery == null
-              ? undefined
-              : this.serviceByServiceName.Battery.values.lowBatteryThreshold,
-            // offset: this.serviceByServiceName.Temperature == null
-            //   ? undefined
-            //   : this.serviceByServiceName.Temperature.values.offset,
+            lowBatteryThreshold: this.servicesByServiceName?.Battery?.[0].values.lowBatteryThreshold,
+            // offset: this.servicesByServiceName?.Temperature?.[0].values.offset,
             serviceName: this.values.serviceName,
             splitLight: undefined,
             venetianBlind: this.service.values.venetianBlind,
@@ -285,21 +286,13 @@ class DeconzAccessory extends AccessoryDelegate {
             responseBody[key] = value
             continue
           case 'lowBatteryThreshold':
-            if (this.serviceByServiceName.Battery != null) {
+            if (this.servicesByServiceName.Battery?.[0] != null) {
               value = OptionParser.toInt(key, body[key], 10, 100)
-              this.serviceByServiceName.Battery.values[key] = value
+              this.servicesByServiceName.Battery[0].values[key] = value
               responseBody[key] = value
               continue
             }
             break
-          // case 'offset': // TODO: doesn't work because of fromHomeKit
-          //   if (this.serviceByServiceName.Temperature != null) {
-          //     const value = OptionParser.toNumber(key, body[key], -5, 5)
-          //     this.serviceByServiceName.Temperature.values[key] = value
-          //     responseBody[key] = value
-          //     continue
-          //   }
-          //   break
           case 'serviceName':
             if (this.values.serviceName != null) {
               value = OptionParser.toString(key, body[key])

package/lib/DeconzService/AirQuality.js

@@ -5,73 +5,104 @@
 
 'use strict'
 
+const Deconz = require('../Deconz')
 const DeconzService = require('../DeconzService')
 
+const { dateToString } = Deconz.ApiClient
+
 /**
   * @memberof DeconzService
   */
 class AirQuality extends DeconzService.SensorsResource {
-  constructor (accessory, resource, params = {}) {
-    params.Service = accessory.Services.hap.AirQualitySensor
-    super(accessory, resource, params)
-
-    this.addCharacteristicDelegate({
-      key: 'airQuality',
-      Characteristic: this.Characteristics.hap.AirQuality
-    })
+  static addResource (service, resource) {
+    if (service.values.airQuality === undefined) {
+      service.addCharacteristicDelegate({
+        key: 'airQuality',
+        Characteristic: service.Characteristics.hap.AirQuality
+      })
+    }
 
     if (resource.body.state.airqualityppb !== undefined) {
-      this.addCharacteristicDelegate({
+      service.addCharacteristicDelegate({
         key: 'vocDensity',
-        Characteristic: this.Characteristics.hap.VOCDensity,
+        Characteristic: service.Characteristics.hap.VOCDensity,
         unit: ' µg/m³',
         props: { minValue: 0, maxValue: 65535, minStep: 1 }
       })
     }
 
     if (resource.body.state.pm2_5 !== undefined) {
-      this.addCharacteristicDelegate({
-        key: 'pm2_5Density',
-        Characteristic: this.Characteristics.hap.PM2_5Density,
+      service.addCharacteristicDelegate({
+        key: 'pm25Density',
+        Characteristic: service.Characteristics.hap.PM2_5Density,
         unit: ' µg/m³',
         props: { minValue: 0, maxValue: 65535, minStep: 1 }
       })
     }
 
-    if (params.linkedServiceDelegate == null) {
-      super.addCharacteristicDelegates()
+    if (service.values.lastUpdated === undefined) {
+      service.addCharacteristicDelegate({
+        key: 'lastUpdated',
+        Characteristic: service.Characteristics.my.LastUpdated,
+        silent: true
+      })
     }
 
-    this.update(resource.body, resource.rpath)
+    AirQuality.updateResourceState(service, resource.body.state)
   }
 
-  airQualityValue (value) {
+  static airQualityValue (service, value) {
     switch (value) {
       case 'excellent':
-        return this.Characteristics.hap.AirQuality.EXCELLENT
+        return service.Characteristics.hap.AirQuality.EXCELLENT
       case 'good':
-        return this.Characteristics.hap.AirQuality.GOOD
+        return service.Characteristics.hap.AirQuality.GOOD
       case 'moderate':
-        return this.Characteristics.hap.AirQuality.FAIR
+        return service.Characteristics.hap.AirQuality.FAIR
       case 'poor':
-        return this.Characteristics.hap.AirQuality.INFERIOR
+        return service.Characteristics.hap.AirQuality.INFERIOR
       case 'unhealthy':
-        return this.Characteristics.hap.AirQuality.POOR
+        return service.Characteristics.hap.AirQuality.POOR
       default:
-        return this.Characteristics.hap.AirQuality.UNKNOWN
+        return service.Characteristics.hap.AirQuality.UNKNOWN
     }
   }
 
-  updateState (state) {
-    if (state.airquality != null) {
-      this.values.airQuality = this.airQualityValue(state.airquality)
-    }
+  static updateResourceState (service, state) {
     if (state.airqualityppb != null) {
-      this.values.vocDensity = Math.round(state.airqualityppb * 4.57)
+      service.values.vocDensity = Math.round(state.airqualityppb * 4.57)
+      if (state.airquality != null) {
+        service.values.airQuality = AirQuality.airQualityValue(
+          service, state.airquality
+        )
+      }
     }
     if (state.pm2_5 != null) {
-      this.values.pm2_5Density = state.pm2_5
+      service.values.pm25Density = state.pm2_5
+      if (state.airquality != null && service.values.vocDensity === undefined) {
+        service.values.airQuality = AirQuality.airQualityValue(
+          service, state.airquality
+        )
+      }
+    }
+    if (state.lastupdated != null) {
+      service.values.lastUpdated = dateToString(state.lastupdated)
     }
+  }
+
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.hap.AirQualitySensor
+    super(accessory, resource, params)
+
+    AirQuality.addResource(this, resource)
+
+    super.addCharacteristicDelegates({ noLastUpdated: true })
+
+    this.update(resource.body, resource.rpath)
+  }
+
+  updateState (state) {
+    AirQuality.updateResourceState(this, state)
     super.updateState(state)
   }
 }

package/lib/DeconzService/Consumption.js

@@ -23,11 +23,11 @@ class Consumption extends DeconzService.SensorsResource {
 
     if (
       resource.body.state.power !== undefined &&
-      service.values.currentConsumption === undefined
+      service.values.consumption === undefined
     ) {
       service.addCharacteristicDelegate({
-        key: 'currentConsumption',
-        Characteristic: service.Characteristics.eve.CurrentConsumption,
+        key: 'consumption',
+        Characteristic: service.Characteristics.eve.Consumption,
         unit: ' W'
       })
     }
@@ -40,7 +40,7 @@ class Consumption extends DeconzService.SensorsResource {
       })
     }
 
-    service.update(resource.body, resource.rpath)
+    Consumption.updateResourceState(service, resource.body.state)
   }
 
   static updateResourceState (service, state) {
@@ -48,7 +48,7 @@ class Consumption extends DeconzService.SensorsResource {
       service.values.totalConsumption = state.consumption / 1000
     }
     if (state.power != null) {
-      service.values.currentConsumption = state.power
+      service.values.consumption = state.power
     }
     if (state.lastupdated != null) {
       service.values.lastUpdated = dateToString(state.lastupdated)

package/lib/DeconzService/Humidity.js

@@ -30,6 +30,9 @@ class Humidity extends DeconzService.SensorsResource {
     if (state.humidity != null) {
       this.values.humidity = Math.round(state.humidity / 10) / 10
     }
+    if (state.moisture != null) {
+      this.values.humidity = Math.round(state.moisture / 10) / 10
+    }
     super.updateState(state)
   }
 }