homebridge-deconz 0.0.6 → 0.0.11

package/lib/DeconzAccessory/Light.js

@@ -0,0 +1,72 @@
+// homebridge-deconz/lib/DeconzAccessory/Light.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 light device
+  * or groups resource.
+  * @extends DeconzAccessory
+  * @memberof DeconzAccessory
+  */
+class Light 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.LIGHTBULB)
+
+    this.identify()
+
+    this.addPropertyDelegate({
+      key: 'serviceName',
+      value: device.resource.capabilities.bri ? 'Light' : 'Outlet'
+    })
+
+    this.service = this.createService(device.resource, {
+      primaryService: true,
+      serviceName: this.values.serviceName
+    })
+
+    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')
+    })
+  }
+}
+
+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

package/lib/DeconzAccessory/WarningDevice.js

@@ -0,0 +1,56 @@
+// homebridge-deconz/lib/DeconzAccessory/WarningDevice.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 light device
+  * or groups resource.
+  * @extends DeconzAccessory
+  * @memberof DeconzAccessory
+  */
+class WarningDevice 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.Temperature != null) {
+      this.historyService = new History.Weather(
+        this, {},
+        this.serviceByServiceName.Temperature.characteristicDelegate('temperature'),
+        null,
+        null
+      )
+    }
+
+    this.createSettingsService()
+
+    setImmediate(() => {
+      this.debug('initialised')
+      this.emit('initialised')
+    })
+  }
+}
+
+module.exports = WarningDevice

package/lib/DeconzAccessory/WindowCovering.js

@@ -0,0 +1,47 @@
+// homebridge-deconz/lib/DeconzAccessory/WindowCovering.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const DeconzAccessory = require('../DeconzAccessory')
+
+/** Delegate class for a HomeKit accessory, corresponding to a light device
+  * or groups resource.
+  * @extends DeconzAccessory
+  * @memberof DeconzAccessory
+  */
+class WindowCovering 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.WINDOW_COVERING)
+
+    this.identify()
+
+    this.service = this.createService(device.resource, {
+      primaryService: true,
+      serviceName: this.values.serviceName
+    })
+
+    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 = WindowCovering

package/lib/DeconzAccessory/index.js

@@ -0,0 +1,216 @@
+// homebridge-deconz/lib/DeconzAccessory/index.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const homebridgeLib = require('homebridge-lib')
+const Deconz = require('../Deconz')
+const DeconzService = require('../DeconzService')
+
+const { HttpError } = Deconz.ApiClient
+const { SINGLE, DOUBLE, LONG } = DeconzService.Button
+
+/** Abstract superclass for a delegate of a HomeKit accessory,
+  * corresponding to a Zigbee or virtual device on a deCONZ gateway.
+  * @extends AccessoryDelegate
+  */
+class DeconzAccessory extends homebridgeLib.AccessoryDelegate {
+  static get Contact () { return require('./Contact') }
+  static get Light () { return require('./Light') }
+  static get Gateway () { return require('./Gateway') }
+  static get Motion () { return require('./Motion') }
+  static get Sensor () { return require('./Sensor') }
+  static get Temperature () { return require('./Temperature') }
+  static get WarningDevice () { return require('./WarningDevice') }
+  static get WindowCovering () { return require('./WindowCovering') }
+
+  /** Instantiate a delegate for an accessory corresponding to a device.
+    * @param {DeconzAccessory.Gateway} gateway - The gateway.
+    * @param {Deconz.Device} device - The device.
+    * @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,
+      manufacturer: device.resource.manufacturer,
+      model: device.resource.model,
+      firmware: device.resource.firmware,
+      category: category
+    })
+
+    this.context.gid = gateway.id
+
+    this.serviceByRpath = {}
+    this.serviceBySubtype = {}
+    this.serviceByServiceName = {}
+
+    /** The gateway.
+      * @type {DeconzAccessory.Gateway}
+      */
+    this.gateway = gateway
+
+    /** The accessory ID.
+      *
+      * This is the {@link Deconz.Device#id id} of the corresponding device.
+      * @type {string}
+      */
+    this.id = device.id
+
+    /** The corresponding device.
+      * @type {Deconz.Device}
+      */
+    this.device = device
+
+    /** The API client instance for the gateway.
+      * @type {Deconz.ApiClient}
+      */
+    this.client = gateway.client
+
+    this
+      .on('polled', (device) => {
+        this.values.firmware = device.resource.firmware
+        for (const subtype in this.serviceBySubtype) {
+          try {
+            const service = this.serviceBySubtype[subtype]
+            const resource = device.resourceBySubtype[subtype]
+            this.debug('%s: polled: %j', resource.rpath, resource.body)
+            service.update(resource.body, resource.rpath)
+          } catch (error) { this.error(error) }
+        }
+      })
+      .on('changed', (rpath, body) => {
+        this.debug('%s: changed: %j', rpath, body)
+        const service = this.serviceByRpath[rpath]
+        if (service != null) {
+          service.update(body, rpath)
+        }
+      })
+      .on('identify', async () => {
+        try {
+          await this.identify()
+        } catch (error) {
+          if (!(error instanceof HttpError)) {
+            this.warn(error)
+          }
+        }
+      })
+  }
+
+  /** The primary resource of the device.
+    * @type {Deconz.Resource}
+    */
+  get resource () { return this.device.resource }
+
+  /** List of resource paths of associated resources in order of prio.
+    * @type {string[]}
+    */
+  get rpaths () { return this.device.rpaths }
+
+  async identify () {
+    this.log(
+      '%s %s v%s (%d resources)', this.values.manufacturer, this.values.model,
+      this.values.firmware, this.rpaths.length
+    )
+    this.debug('%d resources: %s', this.rpaths.length, this.rpaths.join(', '))
+    if (this.service != null) {
+      await this.service.identify()
+    }
+  }
+
+  createService (resource, params = {}) {
+    if (resource == null) {
+      return
+    }
+    if (params.serviceName == null) {
+      params.serviceName = resource.serviceName
+    }
+    if (DeconzService[params.serviceName] == null) {
+      this.warn(
+        '%s: %s: not yet supported %s type',
+        resource.rpath, resource.body.type, resource.rtype
+      )
+      return
+    }
+    this.debug(
+      '%s: capabilities: %j', resource.rpath, resource.capabilities
+    )
+    this.debug('%s: params: %j', resource.rpath, params)
+
+    let service
+    if (params.serviceName === 'Battery') {
+      service = this.serviceByServiceName.Battery
+    } else if (params.serviceName === 'Consumption') {
+      service = this.serviceByServiceName.Light ||
+        this.serviceByServiceName.Power
+      if (service != null) {
+        service.addResource(resource)
+      }
+    } else if (params.serviceName === 'Power') {
+      service = this.serviceByServiceName.Light ||
+        this.serviceByServiceName.Consumption
+      if (service != null) {
+        service.addResource(resource)
+      }
+      this.consumptionService = service
+    } else if (params.serviceName === 'Switch') {
+      // Default button
+      if (resource.capabilities.buttons == null) {
+        this.warn(
+          '%s: unknown %s: %j', resource.rpath, resource.body.type,
+          resource.body
+        )
+        resource.capabilities.buttons = {
+          1: {
+            label: 'Unknown Button',
+            events: SINGLE | DOUBLE | LONG
+          }
+        }
+        resource.capabilities.namespace =
+          this.Characteristics.hap.ServiceLabelNamespace.ARABIC_NUMERALS
+      }
+      service = this.serviceByServiceName.Switch
+      if (service == null) {
+        service = new DeconzService.Switch(this, resource, {
+          primaryService: params.primaryService
+        })
+      }
+      service.createButtonServices(resource, params)
+    }
+    if (service == null) {
+      service = new DeconzService[params.serviceName](this, resource, {
+        primaryService: params.primaryService
+      })
+    }
+    this.serviceBySubtype[resource.subtype] = service
+    this.serviceByRpath[resource.rpath] = service
+    if (this.serviceByServiceName[resource.serviceName] == null) {
+      this.serviceByServiceName[resource.serviceName] = service
+    }
+    if (
+      this.serviceByServiceName.Battery == null &&
+      resource.body.config != null &&
+      resource.body.config.battery !== undefined
+    ) {
+      this.serviceByServiceName.Battery = new DeconzService.Battery(this, resource)
+    }
+    return service
+  }
+
+  createSettingsService (params = {}) {
+    this.settingsService = new DeconzService.DeviceSettings(this, {
+      name: this.name + ' Settings',
+      subtype: this.id,
+      resource: this.device.rpaths.join(', '),
+      expose: true,
+      logLevel: this.gateway.logLevel,
+      hasRepeat: this.service.hasRepeat
+    })
+    this.manageLogLevel(this.settingsService.characteristicDelegate('logLevel'))
+  }
+}
+
+module.exports = DeconzAccessory

package/lib/DeconzPlatform.js

@@ -7,7 +7,7 @@
 
 const events = require('events')
 const homebridgeLib = require('homebridge-lib')
-const DeconzDiscovery = require('./DeconzDiscovery')
+const Deconz = require('./Deconz')
 const DeconzAccessory = require('./DeconzAccessory')
 
 class DeconzPlatform extends homebridgeLib.Platform {
@@ -37,7 +37,7 @@ class DeconzPlatform extends homebridgeLib.Platform {
       waitTimePutGroup: 1000,
       waitTimeResend: 300,
       waitTimeReset: 500,
-      waitTimeUpdate: 20
+      waitTimeUpdate: 100
     }
     const optionParser = new homebridgeLib.OptionParser(this.config, true)
     optionParser
@@ -62,7 +62,7 @@ class DeconzPlatform extends homebridgeLib.Platform {
 
     try {
       optionParser.parse(configJson)
-      this.discovery = new DeconzDiscovery({
+      this.discovery = new Deconz.Discovery({
         forceHttp: this.config.forceHttp,
         timeout: this.config.timeout
       })
@@ -190,6 +190,11 @@ class DeconzPlatform extends homebridgeLib.Platform {
         ) {
           this.gatewayMap[id] = new DeconzAccessory.Gateway(this, context)
         }
+      } else {
+        const gateway = this.gatewayMap[context.gid]
+        if (gateway != null) {
+          gateway.addAccessory(id)
+        }
       }
     } catch (error) { this.error(error) }
   }

package/lib/DeconzService/AirPressure.js

@@ -0,0 +1,43 @@
+// homebridge-deconz/lib/DeconzService/AirPressure.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const DeconzService = require('../DeconzService')
+
+/**
+  * @memberof DeconzService
+  */
+class AirPressure extends DeconzService.SensorsResource {
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.eve.AirPressureSensor
+    super(accessory, resource, params)
+
+    this.addCharacteristicDelegate({
+      key: 'airPressure',
+      Characteristic: this.Characteristics.eve.AirPressure,
+      unit: ' hPa'
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'elevation',
+      Characteristic: this.Characteristics.eve.Elevation,
+      value: 0
+    })
+
+    this.addCharacteristicDelegates()
+
+    this.update(resource.body)
+  }
+
+  updateState (state) {
+    if (state.pressure != null) {
+      this.values.airPressure = Math.round(state.pressure * 10) / 10
+    }
+    super.updateState(state)
+  }
+}
+
+module.exports = AirPressure