homebridge-deconz 0.0.10 → 0.0.13

package/lib/DeconzAccessory/Contact.js

@@ -0,0 +1,54 @@
+// homebridge-deconz/lib/DeconzAccessory/Contact.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const homebridgeLib = require('homebridge-lib')
+const DeconzAccessory = require('../DeconzAccessory')
+
+const { History } = homebridgeLib.ServiceDelegate
+
+/** Delegate class for a HomeKit accessory corresponding to a contact sensor,
+  * with Eve Door & Window history.
+  * @extends DeconzAccessory
+  * @memberof DeconzAccessory
+  */
+class Contact extends DeconzAccessory {
+  /** Instantiate a contact sensor delegate.
+    * @param {DeconzAccessory.Gateway} gateway - The gateway.
+    * @param {Deconz.Device} device - The device.
+    */
+  constructor (gateway, device) {
+    super(gateway, device, gateway.Accessory.Categories.SENSOR)
+
+    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.historyService = new History.Contact(
+      this, {},
+      this.service.characteristicDelegate('contact'),
+      this.service.characteristicDelegate('timesOpened'),
+      this.service.characteristicDelegate('lastActivation')
+    )
+
+    this.createSettingsService()
+
+    setImmediate(() => {
+      this.debug('initialised')
+      this.emit('initialised')
+    })
+  }
+}
+
+module.exports = Contact

package/lib/DeconzAccessory/Gateway.js

@@ -8,7 +8,7 @@
 const homebridgeLib = require('homebridge-lib')
 
 const Deconz = require('../Deconz')
-const DeconzAccessory = require('.')
+const DeconzAccessory = require('../DeconzAccessory')
 const DeconzService = require('../DeconzService')
 
 const rtypes = ['lights', 'sensors', 'groups']
@@ -20,8 +20,6 @@ const periodicEvents = [
 ]
 
 /** Delegate class for a deCONZ gateway.
-  *
-  * @class
   * @extends AccessoryDelegate
   * @memberof DeconzAccessory
   */
@@ -41,7 +39,7 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
       model: params.config.modelid + ' / ' + params.config.devicename,
       firmware: '0.0.0',
       software: params.config.swversion,
-      category: platform.Accessory.Categories.Bridge
+      category: platform.Accessory.Categories.BRIDGE
     })
 
     this.gateway = this
@@ -62,6 +60,9 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
     if (this.context.blacklist == null) {
       this.context.blacklist = {}
     }
+    if (this.context.fullState != null) {
+      this.analyseFullState(this.context.fullState, { analyseOnly: true })
+    }
 
     this.addPropertyDelegate({
       key: 'apiKey',
@@ -215,9 +216,6 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
     try {
       this.debug('initialising...')
       this.initialBeat = beat
-      if (this.context.fullState != null) {
-        this.analyseFullState(this.context.fullState, true)
-      }
       await this.connect()
       this.initialised = true
       this.debug('initialised')
@@ -442,6 +440,9 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
     }
     try {
       try {
+        if (this.context.migration != null) {
+          await this.client.delete(this.context.migration)
+        }
         await this.client.deleteApiKey()
       } catch (error) {}
       this.values.apiKey = null
@@ -457,10 +458,12 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
       this.exposeErrors = {}
       this.context.blacklist = {}
       this.context.fullState = null
+      this.context.migration = null
       this.service.values.lights = false
       this.service.values.sensors = false
       this.service.values.groups = false
       this.service.values.schedules = false
+      this.service.values.logLevel = 2
       this.values.rtypes = []
     } catch (error) { this.error(error) }
   }
@@ -504,12 +507,12 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
     if (this.accessoryById[id] == null) {
       const device = this.deviceById[id]
       delete this.exposeErrorById[id]
-      const { body, rtype } = device.resource
+      const { body } = device.resource
       this.log('%s: add accessory', body.name)
       let { serviceName } = device.resource
       if (DeconzAccessory[serviceName] == null) {
-        this.warn('%s: %s: not yet supported %s type', body.name, body.type, rtype)
-        serviceName = 'Device'
+        // this.warn('%s: %s: not yet supported %s type', body.name, body.type, rtype)
+        serviceName = 'Sensor'
       }
       const accessory = new DeconzAccessory[serviceName](this, device)
       this.accessoryById[id] = accessory
@@ -593,6 +596,9 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
       throw new RangeError(`${id}: unknown device ID`)
     }
     if (this.serviceById[id] == null) {
+      if (Object.keys(this.serviceById).length >= 97) {
+        return null
+      }
       const { resource, rpaths } = this.deviceById[id]
       const { body } = resource
       const service = new DeconzService.DeviceSettings(this, {
@@ -645,11 +651,14 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
           return
         }
         this.context.fullState.config = config
-        if (this.service.values.lights || this.service.values.sensors) {
+        if (
+          this.service.values.lights || this.nDevicesByRtype.lights > 0 ||
+          this.service.values.sensors || this.nDevicesByRtype.sensors > 0
+        ) {
           this.context.fullState.lights = await this.client.get('/lights')
           this.context.fullState.sensors = await this.client.get('/sensors')
         }
-        if (this.service.values.groups) {
+        if (this.service.values.groups || this.nDevicesByRtype.groups > 0) {
           this.context.fullState.groups = await this.client.get('/groups')
           this.context.fullState.groups[0] = await this.client.get('/groups/0')
         }
@@ -657,7 +666,7 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
           this.context.fullState.schedules = await this.client.get('/schedules')
         }
       }
-      this.analyseFullState(this.context.fullState)
+      await this.analyseFullState(this.context.fullState)
     } catch (error) {
       this.error(error)
     } finally {
@@ -698,12 +707,12 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
     * accessories, corresponding to devices have been blacklisted.
     * @param {Object} fullState - The gateway full state, as returned by
     * {@link DeconzAccessory.Gateway#poll poll()}.
-    * @param {boolean} [logUnsupportedResources=false] - Issue debug messsages
-    * for unsupported resources.
+    * @param {Object} params - Parameters
+    * @param {boolean} [params.logUnsupportedResources=false] - Issue debug
+    * messsages for unsupported resources.
+    * @param {boolean} [params.analyseOnly=false]
     */
-  analyseFullState (fullState, logUnsupported = false) {
-    this.update(fullState.config)
-
+  async analyseFullState (fullState, params = {}) {
     /** Supported devices by device ID.
       *
       * Updated by
@@ -740,8 +749,10 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
     for (const rtype of rtypes) {
       this.deviceByRidByRtype[rtype] = {}
       for (const rid in fullState[rtype]) {
-        const body = fullState[rtype][rid]
-        this.analyseResource(rtype, rid, body, logUnsupported)
+        try {
+          const body = fullState[rtype][rid]
+          this.analyseResource(rtype, rid, body, params.logUnsupported)
+        } catch (error) { this.error(error) }
       }
     }
 
@@ -774,64 +785,74 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
       this.vdebug('%d %s devices', this.nDevicesByRtype[rtype], rtype)
     }
 
+    if (params.analyseOnly) {
+      return
+    }
+
+    this.update(fullState.config)
+
     let changed = false
 
     this.vdebug('analysing accessories...')
     for (const id in this.accessoryById) {
-      if (
-        this.deviceById[id] == null ||
-        !this.values.rtypes.includes(this.deviceById[id].resource.rtype)
-      ) {
-        delete this.context.blacklist[id]
-        this.deleteAccessory(id)
-        this.deleteService(id)
-        changed = true
-      } else {
-        /** Emitted when the gateway has been polled.
-          * @event DeconzAccessory.Device#polled
-          * @param {Deconz.Device} device - The updated device.
-          */
-        this.accessoryById[id].emit('polled', this.deviceById[id])
-      }
+      try {
+        if (
+          this.deviceById[id] == null
+        ) {
+          delete this.context.blacklist[id]
+          this.deleteAccessory(id)
+          this.deleteService(id)
+          changed = true
+        } else {
+          /** Emitted when the gateway has been polled.
+            * @event DeconzAccessory.Device#polled
+            * @param {Deconz.Device} device - The updated device.
+            */
+          this.accessoryById[id].emit('polled', this.deviceById[id])
+        }
+      } catch (error) { this.error(error) }
     }
 
     this.vdebug('analysing services...')
     for (const id in this.serviceById) {
-      if (
-        this.deviceById[id] == null ||
-        !this.values.rtypes.includes(this.deviceById[id].resource.rtype)
-      ) {
-        delete this.context.blacklist[id]
-        delete this.exposeErrorById[id]
-        this.deleteService(id)
-        changed = true
-      }
+      try {
+        if (
+          this.deviceById[id] == null ||
+          !this.values.rtypes.includes(this.deviceById[id].resource.rtype)
+        ) {
+          delete this.exposeErrorById[id]
+          this.deleteService(id)
+          changed = true
+        }
+      } catch (error) { this.error(error) }
     }
 
     for (const rtype of this.values.rtypes) {
       this.vdebug('analysing %s devices...', rtype)
       const rids = Object.keys(this.deviceByRidByRtype[rtype]).sort()
       for (const rid of rids) {
-        const { id } = this.deviceByRidByRtype[rtype][rid]
-        if (this.context.blacklist[id] == null) {
-          if (this.accessoryById[id] == null) {
-            this.addAccessory(id)
-            changed = true
-          }
-          if (this.serviceById[id] != null) {
-            this.deleteService(id)
-            changed = true
-          }
-        } else {
-          if (this.serviceById[id] == null) {
-            this.addService(id)
-            changed = true
-          }
-          if (this.accessoryById[id] != null) {
-            this.deleteAccessory(id)
-            changed = true
+        try {
+          const { id } = this.deviceByRidByRtype[rtype][rid]
+          if (this.context.blacklist[id] == null) {
+            if (this.accessoryById[id] == null) {
+              this.addAccessory(id)
+              changed = true
+            }
+            if (this.serviceById[id] != null) {
+              this.deleteService(id)
+              changed = true
+            }
+          } else {
+            if (this.serviceById[id] == null) {
+              this.addService(id)
+              changed = true
+            }
+            if (this.accessoryById[id] != null) {
+              this.deleteAccessory(id)
+              changed = true
+            }
           }
-        }
+        } catch (error) { this.error(error) }
       }
     }
 
@@ -848,8 +869,23 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
     if (changed) {
       this.nResourcesMonitored = Object.keys(this.accessoryByRpath).length
       this.identify()
-      this.vdebug('updating resourcelink...')
-      // TOOD create resourcelink for Homebridge Hue migration
+      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()
+        })
+      }
+      this.log(
+        'migration: %s: %d resources',
+        this.context.migration, this.nResourcesMonitored
+      )
     }
   }
 
@@ -862,7 +898,7 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
     * `groups`, `lights`, or `sensors`.
     * @param {integer} rid - The resource ID of the resource.
     * @param {object} body - The body of the resource.
-    * @param {boolean} logUnsupportedResources - Issue a debug message for
+    * @param {boolean} logUnsupported - Issue a debug message for
     * unsupported resources.
     */
   analyseResource (rtype, rid, body, logUnsupported) {

package/lib/DeconzAccessory/Light.js

@@ -1,16 +1,17 @@
-// homebridge-deconz/lib/DeconzAccessory/Device.js
+// homebridge-deconz/lib/DeconzAccessory/Light.js
 // Copyright © 2022 Erik Baauw. All rights reserved.
 //
 // Homebridge plugin for deCONZ.
 
 'use strict'
 
-const DeconzAccessory = require('.')
-const DeconzService = require('../DeconzService')
+const homebridgeLib = require('homebridge-lib')
+const DeconzAccessory = require('../DeconzAccessory')
 
-/** Delegate class for a HomeKit accessory,
-  * corresponding to a Zigbee or virtual device on a deCONZ gateway,
-  * that is not yet supported.
+const { History } = homebridgeLib.ServiceDelegate
+
+/** Delegate class for a HomeKit accessory, corresponding to a light device
+  * or groups resource.
   * @extends DeconzAccessory
   * @memberof DeconzAccessory
   */
@@ -19,49 +20,53 @@ class Light extends DeconzAccessory {
     * @param {DeconzAccessory.Gateway} gateway - The gateway.
     * @param {Deconz.Device} device - The device.
     */
-  constructor (gateway, device) {
-    super(gateway, device)
+  constructor (gateway, device, settings = {}) {
+    super(gateway, device, gateway.Accessory.Categories.LIGHTBULB)
 
     this.identify()
 
-    this.service = new DeconzService.Light(this, device.resource)
+    this.addPropertyDelegate({
+      key: 'serviceName',
+      value: device.resource.capabilities.bri ? 'Light' : 'Outlet'
+    })
 
-    this.settingsService = new DeconzService.DeviceSettings(this, {
-      name: this.name + ' Settings',
-      subtype: this.id,
-      resource: this.device.rpaths.join(', '),
-      expose: true,
-      logLevel: gateway.logLevel
+    this.service = this.createService(device.resource, {
+      primaryService: true,
+      serviceName: this.values.serviceName
     })
-    this.manageLogLevel(this.settingsService.characteristicDelegate('logLevel'))
 
-    this
-      .on('polled', (device) => {
-        this.debug(
-          '%s: polled: %j', device.rpaths.join(', '), device.resource.body
-        )
-        this.service.update(device.resource.body)
-      })
-      .on('changed', (rpath, body) => {
-        if (rpath === device.resource.rpath) {
-          this.debug('%s: changed: %j', rpath, body)
-          this.service.update(body)
-        }
-      })
-      .on('identify', this.identify)
+    for (const subtype in device.resourceBySubtype) {
+      const resource = device.resourceBySubtype[subtype]
+      if (subtype === device.primary) {
+        continue
+      }
+      if (resource.rtype === 'lights') {
+        this.createService(resource, { serviceName: this.values.serviceName })
+      } else {
+        this.createService(resource)
+      }
+    }
+
+    if (this.serviceByServiceName.Consumption != null) {
+      this.historyService = new History.Consumption(
+        this, {},
+        this.serviceByServiceName.Consumption.characteristicDelegate('totalConsumption'),
+        this.serviceByServiceName.Consumption.characteristicDelegate('currentConsumption')
+      )
+    } else if (this.serviceByServiceName.Power != null) {
+      this.historyService = new History.Power(
+        this, {},
+        this.serviceByServiceName.Power.characteristicDelegate('currentConsumption')
+      )
+    }
+
+    this.createSettingsService()
 
     setImmediate(() => {
       this.debug('initialised')
       this.emit('initialised')
     })
   }
-
-  async identify () {
-    super.identify()
-    if (this.service != null) {
-      await this.service.identify()
-    }
-  }
 }
 
 module.exports = Light

package/lib/DeconzAccessory/Motion.js

@@ -0,0 +1,51 @@
+// homebridge-deconz/lib/DeconzAccessory/Motion.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const homebridgeLib = require('homebridge-lib')
+const DeconzAccessory = require('../DeconzAccessory')
+
+const { History } = homebridgeLib.ServiceDelegate
+
+class Motion 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) {
+    super(gateway, device, gateway.Accessory.Categories.SENSOR)
+
+    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.historyService = new History.Motion(
+      this, {},
+      this.service.characteristicDelegate('motion'),
+      this.service.characteristicDelegate('lastActivation'),
+      this.serviceByServiceName.Temperature == null
+        ? null
+        : this.serviceByServiceName.Temperature.characteristicDelegate('temperature')
+    )
+
+    this.createSettingsService()
+
+    setImmediate(() => {
+      this.debug('initialised')
+      this.emit('initialised')
+    })
+  }
+}
+
+module.exports = Motion

package/lib/DeconzAccessory/Sensor.js

@@ -0,0 +1,35 @@
+// homebridge-deconz/lib/DeconzAccessory/Sensor.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const DeconzAccessory = require('../DeconzAccessory')
+
+class Sensor extends DeconzAccessory {
+  constructor (gateway, device) {
+    super(gateway, device, gateway.Accessory.Categories.SENSOR)
+
+    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 = Sensor

package/lib/DeconzAccessory/Temperature.js

@@ -0,0 +1,63 @@
+// homebridge-deconz/lib/DeconzAccessory/Temperature.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const homebridgeLib = require('homebridge-lib')
+const DeconzAccessory = require('../DeconzAccessory')
+
+const { History } = homebridgeLib.ServiceDelegate
+
+class Temperature 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.SENSOR)
+    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)
+    }
+
+    if (this.serviceByServiceName.AirQuality == null) {
+      this.historyService = new History.Weather(
+        this, {},
+        this.service.characteristicDelegate('temperature'),
+        this.serviceByServiceName.Humidity == null
+          ? null
+          : this.serviceByServiceName.Humidity.characteristicDelegate('humidity'),
+        this.serviceByServiceName.AirPressure == null
+          ? null
+          : this.serviceByServiceName.AirPressure.characteristicDelegate('airPressure')
+      )
+    } else {
+      this.historyService = new History.Room(
+        this, {},
+        this.service.characteristicDelegate('temperature'),
+        this.serviceByServiceName.Humidity == null
+          ? null
+          : this.serviceByServiceName.Humidity.characteristicDelegate('humidity'),
+        this.serviceByServiceName.AirQuality.characteristicDelegate('vocDensity')
+      )
+    }
+
+    this.createSettingsService()
+
+    setImmediate(() => {
+      this.debug('initialised')
+      this.emit('initialised')
+    })
+  }
+}
+
+module.exports = Temperature

package/lib/DeconzAccessory/Thermostat.js

@@ -0,0 +1,50 @@
+// homebridge-deconz/lib/DeconzAccessory/Thermostat.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const homebridgeLib = require('homebridge-lib')
+const DeconzAccessory = require('../DeconzAccessory')
+
+const { History } = homebridgeLib.ServiceDelegate
+
+class Thermostat 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.THERMOSTAT)
+    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)
+    }
+
+    if (device.resource.body.state.valve !== undefined) {
+      this.historyService = new History.Thermo(
+        this, {},
+        this.service.characteristicDelegate('currentTemperature'),
+        this.service.characteristicDelegate('targetTemperature'),
+        this.service.characteristicDelegate('valvePosition')
+      )
+    }
+
+    this.createSettingsService()
+
+    setImmediate(() => {
+      this.debug('initialised')
+      this.emit('initialised')
+    })
+  }
+}
+
+module.exports = Thermostat