homebridge-deconz 0.0.10 → 0.0.13

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

@@ -6,14 +6,25 @@
 '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 Device () { return require('./Device') }
+  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.
@@ -31,6 +42,12 @@ class DeconzAccessory extends homebridgeLib.AccessoryDelegate {
       category: category
     })
 
+    this.context.gid = gateway.id
+
+    this.serviceByRpath = {}
+    this.serviceBySubtype = {}
+    this.serviceByServiceName = {}
+
     /** The gateway.
       * @type {DeconzAccessory.Gateway}
       */
@@ -52,6 +69,35 @@ class DeconzAccessory extends homebridgeLib.AccessoryDelegate {
       * @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.
@@ -64,12 +110,108 @@ class DeconzAccessory extends homebridgeLib.AccessoryDelegate {
     */
   get rpaths () { return this.device.rpaths }
 
-  identify () {
+  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 (
+      resource.body.config != null &&
+      resource.body.config.battery !== undefined
+    ) {
+      if (this.serviceByServiceName.Battery == null) {
+        this.serviceByServiceName.Battery = new DeconzService.Battery(this, resource)
+      }
+      service.batteryService = this.serviceByServiceName.Battery
+    }
+    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'))
   }
 }
 

package/lib/DeconzPlatform.js

@@ -21,8 +21,6 @@ class DeconzPlatform extends homebridgeLib.Platform {
       .on('accessoryRestored', this.accessoryRestored)
       .once('heartbeat', this.init)
       .on('heartbeat', this.heartbeat)
-
-    this.warn('This plugin is work in progress')
   }
 
   parseConfigJson (configJson) {
@@ -190,6 +188,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

package/lib/DeconzService/AirQuality.js

@@ -10,21 +10,26 @@ const DeconzService = require('../DeconzService')
 /**
   * @memberof DeconzService
   */
-class AirQuality extends DeconzService.Sensor {
-  constructor (deconzAccessory, params = {}) {
-    params.Service = deconzAccessory.Services.hap.AirQualitySensor
-    super(deconzAccessory, params)
+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
     })
+
     this.addCharacteristicDelegate({
       key: 'vocDensity',
-      Characteristic: this.Characteristics.hap.VOCDensity
+      Characteristic: this.Characteristics.hap.VOCDensity,
+      unit: ' µg/m³',
+      props: { minValue: 0, maxValue: 65535, minStep: 1 }
     })
-    super.addCharacteristicDelegates(params)
-    this.update(params.sensor)
+
+    super.addCharacteristicDelegates()
+
+    this.update(resource.body)
   }
 
   airQualityValue (value) {
@@ -44,10 +49,14 @@ class AirQuality extends DeconzService.Sensor {
     }
   }
 
-  update (sensor) {
-    this.values.airQuality = this.airQualityValue(sensor.state.airquality)
-    this.values.vocDensity = Math.round(sensor.state.airqualityppb * 4.56)
-    super.update(sensor)
+  updateState (state) {
+    if (state.airquality != null) {
+      this.values.airQuality = this.airQualityValue(state.airquality)
+    }
+    if (state.airqualityppb != null) {
+      this.values.vocDensity = Math.round(state.airqualityppb * 4.57)
+    }
+    super.updateState(state)
   }
 }
 

package/lib/DeconzService/Alarm.js

@@ -10,22 +10,26 @@ const DeconzService = require('../DeconzService')
 /**
   * @memberof DeconzService
   */
-class Alarm extends DeconzService.Sensor {
-  constructor (deconzAccessory, params = {}) {
-    params.Service = deconzAccessory.Services.hap.AirQualitySensor
-    super(deconzAccessory, params)
+class Alarm extends DeconzService.SensorsResource {
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.my.Resource
+    super(accessory, resource, params)
 
     this.addCharacteristicDelegate({
       key: 'alarm',
-      Characteristic: this.Characteristics.hap.my.Alamrm
+      Characteristic: this.Characteristics.my.Alarm
     })
+
     super.addCharacteristicDelegates(params)
-    this.update(params.sensor)
+
+    this.update(resource.body)
   }
 
-  update (sensor) {
-    this.value.alarm = sensor.state.alarm || sensor.state.test
-    super.update(sensor)
+  updateState (state) {
+    if (state.alarm != null || state.test != null) {
+      this.values.alarm = state.alarm || state.test
+    }
+    super.updateState(state)
   }
 }
 

package/lib/DeconzService/Battery.js

@@ -0,0 +1,53 @@
+// homebridge-deconz/lib/DeconzService/Battery.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const homebridgeLib = require('homebridge-lib')
+// const Deconz = require('../Deconz')
+
+// const { dateToString } = Deconz.ApiClient
+
+/**
+  * @memberof DeconzService
+  */
+class Battery extends homebridgeLib.ServiceDelegate.Battery {
+  constructor (accessory, resource, params = {}) {
+    super(accessory, {
+      name: accessory.name + ' Battery'
+    })
+  }
+
+  update (body) {
+    if (this.updating) {
+      return
+    }
+    if (body.config != null) {
+      this.updateConfig(body.config)
+    }
+    if (body.state != null) {
+      this.updateState(body.state)
+    }
+  }
+
+  updateState (state) {
+    if (state.battery != null) {
+      this.values.batteryLevel = state.battery
+    }
+    if (state.charging != null) {
+      this.values.chargingState = state.charging
+        ? this.Characteristics.hap.ChargingState.CHARGING
+        : this.Characteristics.hap.ChargingState.NOT_CHARGING
+    }
+  }
+
+  updateConfig (config) {
+    if (config.battery != null) {
+      this.values.batteryLevel = config.battery
+    }
+  }
+}
+
+module.exports = Battery

package/lib/DeconzService/Button.js

@@ -115,6 +115,12 @@ class Button extends homebridgeLib.ServiceDelegate {
       Characteristic: this.Characteristics.hap.ProgrammableSwitchEvent,
       props: this.props(params.events)
     })
+
+    this.addCharacteristicDelegate({
+      key: 'index',
+      Characteristic: this.Characteristics.hap.ServiceLabelIndex,
+      value: params.button
+    })
   }
 
   homeKitValue (value, oldValue = 0, repeat = false) {
@@ -132,11 +138,12 @@ class Button extends homebridgeLib.ServiceDelegate {
       case deconzEvent.SHORT_RELEASE:
         return homeKitEvent.SINGLE_PRESS
       case deconzEvent.HOLD:
-      case deconzEvent.LONG_RELEASE:
         if (repeat) {
           return homeKitEvent.SINGLE_PRESS
         }
-        if (button === oldButton && oldEvent === deconzEvent.HOLD) {
+        // falls through
+      case deconzEvent.LONG_RELEASE:
+        if (repeat || (button === oldButton && oldEvent === deconzEvent.HOLD)) {
           // Already issued action on previous Hold.
           return null
         }

package/lib/DeconzService/CarbonMonoxide.js

@@ -0,0 +1,38 @@
+// homebridge-deconz/lib/DeconzService/CarbonMonoxide.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const DeconzService = require('../DeconzService')
+
+/**
+  * @memberof DeconzService
+  */
+class CarbonMonoxide extends DeconzService.SensorsResource {
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.hap.CarbonMonoxideSensor
+    super(accessory, resource, params)
+
+    this.addCharacteristicDelegate({
+      key: 'carbonmonoxide',
+      Characteristic: this.Characteristics.hap.CarbonMonoxideDetected
+    })
+
+    super.addCharacteristicDelegates(params)
+
+    this.update(resource.body)
+  }
+
+  updateState (state) {
+    if (state.carbonmonoxide != null || state.test != null) {
+      this.values.carbonmonoxide = state.carbonmonoxide || state.test
+        ? this.Characteristics.hap.CarbonMonoxideDetected.CO_LEVELS_ABNORMAL
+        : this.Characteristics.hap.CarbonMonoxideDetected.CO_LEVELS_NORMAL
+    }
+    super.updateState(state)
+  }
+}
+
+module.exports = CarbonMonoxide

package/lib/DeconzService/Consumption.js

@@ -0,0 +1,65 @@
+// homebridge-deconz/lib/DeconzService/Consumption.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const Deconz = require('../Deconz')
+const DeconzService = require('../DeconzService')
+
+const { dateToString } = Deconz.ApiClient
+
+/**
+  * @memberof DeconzService
+  */
+class Consumption extends DeconzService.SensorsResource {
+  static addResource (service, resource) {
+    service.addCharacteristicDelegate({
+      key: 'totalConsumption',
+      Characteristic: service.Characteristics.eve.TotalConsumption,
+      unit: ' kWh'
+    })
+
+    if (
+      resource.body.state.power !== undefined &&
+      service.values.currentConsumption === undefined
+    ) {
+      service.addCharacteristicDelegate({
+        key: 'currentConsumption',
+        Characteristic: service.Characteristics.eve.CurrentConsumption,
+        unit: ' W'
+      })
+    }
+  }
+
+  static updateResourceState (service, state) {
+    if (state.consumption != null) {
+      service.values.totalConsumption = state.consumption / 1000
+    }
+    if (state.power != null) {
+      service.values.currentConsumption = state.power
+    }
+    if (state.lastupdated != null) {
+      service.values.lastUpdated = dateToString(state.lastupdated)
+    }
+  }
+
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.my.Resource
+    super(accessory, resource, params)
+
+    Consumption.addResource(this, resource)
+
+    super.addCharacteristicDelegates()
+
+    this.update(resource.body)
+  }
+
+  updateState (state) {
+    Consumption.updateResourceState(this.service, state)
+    super.updateState(state)
+  }
+}
+
+module.exports = Consumption

package/lib/DeconzService/Contact.js

@@ -0,0 +1,60 @@
+// homebridge-deconz/lib/DeconzService/Contact.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const DeconzService = require('../DeconzService')
+
+/**
+  * @memberof DeconzService
+  */
+class Contact extends DeconzService.SensorsResource {
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.hap.ContactSensor
+    super(accessory, resource, params)
+
+    this.addCharacteristicDelegate({
+      key: 'contact',
+      Characteristic: this.Characteristics.hap.ContactSensorState
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'timesOpened',
+      Characteristic: this.Characteristics.eve.TimesOpened,
+      value: 0
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'openDuration',
+      Characteristic: this.Characteristics.eve.OpenDuration,
+      value: 0
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'closedDuration',
+      Characteristic: this.Characteristics.eve.ClosedDuration,
+      value: 0
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'lastActivation',
+      Characteristic: this.Characteristics.eve.LastActivation,
+      silent: true
+    })
+
+    this.addCharacteristicDelegates({ noTampered: true })
+  }
+
+  updateState (state) {
+    if (state.open != null) {
+      this.values.contact = state.open
+        ? this.Characteristics.hap.ContactSensorState.CONTACT_NOT_DETECTED
+        : this.Characteristics.hap.ContactSensorState.CONTACT_DETECTED
+    }
+    super.updateState(state)
+  }
+}
+
+module.exports = Contact