homebridge-deconz 0.0.27 → 0.1.1

package/lib/DeconzService/Daylight.js

@@ -8,7 +8,7 @@
 const DeconzService = require('../DeconzService')
 const Deconz = require('../Deconz')
 
-const { dateToString, lightLevelToLux } = Deconz.ApiClient
+const { dateToString } = Deconz.ApiClient
 
 const daylightEvents = {
   100: { name: 'Solar Midnight', period: 'Night' },
@@ -27,15 +27,22 @@ const daylightEvents = {
   230: { name: 'Astronomical Dusk', period: 'Night' }
 }
 
+// Eve uses the following thresholds:
+const VERY_BRIGHT = 1000
+const BRIGHT = 300
+const NORMAL = 100
+const DIM = 10
+const DARK = 0
+
 const daylightPeriods = {
-  Night: { lightlevel: 0, daylight: false, dark: true },
-  'Astronomical Twilight': { lightlevel: 100, daylight: false, dark: true },
-  'Nautical Twilight': { lightlevel: 1000, daylight: false, dark: true },
-  Twilight: { lightlevel: 10000, daylight: false, dark: false },
-  Sunrise: { lightlevel: 15000, daylight: true, dark: false },
-  Sunset: { lightlevel: 20000, daylight: true, dark: false },
-  'Golden Hour': { lightlevel: 40000, daylight: true, dark: false },
-  Day: { lightlevel: 65535, daylight: true, dark: false }
+  Night: { lightLevel: DARK, dark: true, daylight: false },
+  'Astronomical Twilight': { lightLevel: DIM, dark: true, daylight: false },
+  'Nautical Twilight': { lightLevel: DIM, dark: true, daylight: false },
+  Twilight: { lightLevel: NORMAL, dark: false, daylight: false },
+  Sunrise: { lightLevel: BRIGHT, dark: false, daylight: true },
+  Sunset: { lightLevel: BRIGHT, dark: false, daylight: true },
+  'Golden Hour': { lightLevel: BRIGHT, dark: false, daylight: true },
+  Day: { lightLevel: VERY_BRIGHT, dark: false, daylight: true }
 }
 
 /**
@@ -47,7 +54,7 @@ class Daylight extends DeconzService.SensorsResource {
     super(accessory, resource, params)
 
     this.addCharacteristicDelegate({
-      key: 'lightlevel',
+      key: 'lightLevel',
       Characteristic: this.Characteristics.hap.CurrentAmbientLightLevel,
       unit: ' lux'
     })
@@ -101,7 +108,7 @@ class Daylight extends DeconzService.SensorsResource {
       this.warn('%s: %s not configured', resource.rpath, resource.body.type)
     }
 
-    this.update(resource.body)
+    this.update(resource.body, resource.rpath)
   }
 
   updateState (state) {
@@ -110,14 +117,10 @@ class Daylight extends DeconzService.SensorsResource {
       const { name, period } = daylightEvents[state.status]
       this.values.lastEvent = name
       this.values.period = period
-      const { lightlevel } = daylightPeriods[period]
-      this.values.lightlevel = lightLevelToLux(lightlevel)
-    }
-    if (state.dark != null) {
-      this.values.dark = state.dark
-    }
-    if (state.daylight != null) {
-      this.values.daylight = state.daylight
+      const { lightLevel, dark, daylight } = daylightPeriods[period]
+      this.values.lightLevel = lightLevel
+      this.values.dark = dark
+      this.values.daylight = daylight
     }
     if (state.sunrise != null) {
       this.values.sunrise = dateToString(state.sunrise)

package/lib/DeconzService/Flag.js

@@ -38,7 +38,7 @@ class Flag extends DeconzService.SensorsResource {
 
     this.addCharacteristicDelegates()
 
-    this.update(resource.body)
+    this.update(resource.body, resource.rpath)
   }
 
   updateState (state) {

package/lib/DeconzService/Gateway.js

@@ -0,0 +1,48 @@
+// homebridge-deconz/lib/DeconzService/Gateway.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const homebridgeLib = require('homebridge-lib')
+
+/** Delegate class for a DeconzGateway service.
+  * @extends ServiceDelegate
+  * @memberof DeconzService
+  */
+class Gateway extends homebridgeLib.ServiceDelegate {
+  constructor (gateway, params = {}) {
+    params.Service = gateway.Services.my.DeconzGateway
+    params.exposeConfiguredName = true
+    super(gateway, params)
+    this.gateway = gateway
+
+    this.addCharacteristicDelegate({
+      key: 'lastUpdated',
+      Characteristic: this.Characteristics.my.LastUpdated,
+      silent: true
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'statusActive',
+      Characteristic: this.Characteristics.hap.StatusActive,
+      value: true,
+      silent: true
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'transitionTime',
+      Characteristic: this.Characteristics.my.TransitionTime,
+      value: this.gateway.defaultTransitionTime
+    })
+    this.values.transitionTime = this.gateway.defaultTransitionTime
+  }
+
+  update (config) {
+    this.values.expose = true
+    this.values.lastUpdated = new Date().toString().slice(0, 24)
+  }
+}
+
+module.exports = Gateway

package/lib/DeconzService/Humidity.js

@@ -23,7 +23,7 @@ class Humidity extends DeconzService.SensorsResource {
 
     this.addCharacteristicDelegates()
 
-    this.update(resource.body)
+    this.update(resource.body, resource.rpath)
   }
 
   updateState (state) {

package/lib/DeconzService/Leak.js

@@ -22,7 +22,7 @@ class Leak extends DeconzService.SensorsResource {
 
     super.addCharacteristicDelegates()
 
-    this.update(resource.body)
+    this.update(resource.body, resource.rpath)
   }
 
   updateState (state) {

package/lib/DeconzService/Light.js

@@ -8,6 +8,7 @@
 const homebridgeLib = require('homebridge-lib')
 const DeconzService = require('../DeconzService')
 
+const { History } = homebridgeLib.ServiceDelegate
 const { timeout } = homebridgeLib
 const { xyToHsv, hsvToXy, ctToXy } = homebridgeLib.Colour
 
@@ -207,6 +208,7 @@ class Light extends DeconzService.LightsResource {
           .CharacteristicValueTransitionControl,
         silent: true,
         getter: async () => {
+          this.initAdaptiveLighting()
           return this.adaptiveLighting.generateControl()
         },
         setter: async (value) => {
@@ -238,95 +240,24 @@ class Light extends DeconzService.LightsResource {
     }
 
     if (this.resource.rtype === 'groups') {
-      this.sceneServices = {}
-      this.updateScenes(this.resource.body.scenes)
+      this.addCharacteristicDelegate({
+        key: 'exposeScenes',
+        value: true
+      })
+      if (this.values.exposeScenes) {
+        this.sceneServices = {}
+        this.updateScenes(this.resource.body.scenes)
+      }
     }
 
     if (this.capabilities.effects != null) {
-      this.effectServices = {}
       this.addCharacteristicDelegate({
-        key: 'effect',
-        value: -1,
-        silent: true
-      }).on('didSet', (value) => {
-        for (const i in this.capabilities.effects) {
-          this.effectServices[i].values.on = value === i
-        }
+        key: 'exposeEffects',
+        value: true
       })
-      for (const id in this.capabilities.effects) {
-        const effect = this.capabilities.effects[id]
-        const service = new homebridgeLib.ServiceDelegate(accessory, {
-          name: this.resource.body.name + ' ' + effect,
-          Service: this.Services.hap.Lightbulb,
-          subtype: this.subtype + '-E' + id,
-          exposeConfiguredName: true
-        })
-        service.addCharacteristicDelegate({
-          key: 'on',
-          Characteristic: this.Characteristics.hap.On
-        }).on('didSet', (value, fromHomeKit) => {
-          if (fromHomeKit) {
-            this.checkAdaptiveLighting()
-            this.values.effect = value ? id : -1
-            const newEffect = value
-              ? effect.toLowerCase()
-              : 'none'
-            this.put({ effect: newEffect })
-          }
-        })
-        service.addCharacteristicDelegate({
-          key: 'index',
-          Characteristic: this.Characteristics.hap.ServiceLabelIndex,
-          value: Number(id) + 1
-        })
-        this.effectServices[id] = service
-
-        this.characteristicDelegate('configuredName')
-          .on('didSet', (value) => {
-            for (const id in this.capabilities.effects) {
-              this.effectServices[id].values.configuredName = value +
-                ' ' + this.capabilities.effects[id]
-            }
-          })
+      if (this.values.exposeEffects) {
+        this.exposeEffects()
       }
-      // if (this.capabilities.effectSpeed) {
-      //   this.addCharacteristicDelegate({
-      //     key: 'effectSpeed',
-      //     Characteristic: this.Characteristics.my.EffectSpeed,
-      //     value: 50
-      //   }).on('didSet', (value) => {
-      //     this.setEffectSpeed(value)
-      //   })
-      //   this.hk.effectColours = []
-      //   for (let i = 0; i <= 5; i++) {
-      //     const service = new this.Service.Lightbulb(
-      //       this.name + ' Effect Color ' + (i + 1), this.subtype + '-C' + i
-      //     )
-      //     service.addCharacteristicDelegate({
-      //       key: 'on',
-      //       Characteristic: this.Characteristics.hap.On,
-      //       value: true
-      //     }).on('didSet', (value) => {
-      //       this.setEffectOn(i, value)
-      //     })
-      //     service.addCharacteristicDelegate({
-      //       key: 'hue',
-      //       Characteristic: this.Characteristics.hap.Hue,
-      //       value: i * 60
-      //     }).on('didSet', (value) => {
-      //       this.setEffectHue(i, value)
-      //     })
-      //     service.addCharacteristicDelegate({
-      //       key: 'saturation',
-      //       Characteristic: this.Characteristics.hap.Saturation,
-      //       value: 100
-      //     }).on('didSet', (value) => {
-      //       this.setEffectSat(i, value)
-      //     })
-      //     this.effectServices.push(service)
-      //   }
-      // }
-      // this.checkEffect(this.obj.state.effect)
     }
 
     this.settings = {
@@ -336,6 +267,100 @@ class Light extends DeconzService.LightsResource {
     }
   }
 
+  exposeEffects () {
+    this.effectServices = {}
+    this.addCharacteristicDelegate({
+      key: 'effect',
+      value: -1,
+      silent: true
+    }).on('didSet', (value) => {
+      for (const i in this.capabilities.effects) {
+        this.effectServices[i].values.on = value === i
+      }
+    })
+    for (const id in this.capabilities.effects) {
+      const effect = this.capabilities.effects[id]
+      const service = new homebridgeLib.ServiceDelegate(this.accessoryDelegate, {
+        name: this.resource.body.name + ' ' + effect,
+        Service: this.Services.hap.Lightbulb,
+        subtype: this.subtype + '-E' + id,
+        exposeConfiguredName: true
+      })
+      service.addCharacteristicDelegate({
+        key: 'on',
+        Characteristic: this.Characteristics.hap.On
+      }).on('didSet', (value, fromHomeKit) => {
+        service.values.lastActivation =
+          this.accessoryDelegate.historyService.lastActivationValue(History.now())
+        if (fromHomeKit) {
+          this.checkAdaptiveLighting()
+          this.values.effect = value ? id : -1
+          const newEffect = value
+            ? effect.toLowerCase()
+            : 'none'
+          this.put({ effect: newEffect })
+        }
+      })
+      service.addCharacteristicDelegate({
+        key: 'index',
+        Characteristic: this.Characteristics.hap.ServiceLabelIndex,
+        value: Number(id) + 1
+      })
+      service.addCharacteristicDelegate({
+        key: 'lastActivation',
+        Characteristic: this.Characteristics.eve.LastActivation,
+        silent: true
+      })
+      this.effectServices[id] = service
+
+      this.characteristicDelegate('configuredName')
+        .on('didSet', (value) => {
+          for (const id in this.capabilities.effects) {
+            this.effectServices[id].values.configuredName = value +
+              ' ' + this.capabilities.effects[id]
+          }
+        })
+    }
+    // if (this.capabilities.effectSpeed) {
+    //   this.addCharacteristicDelegate({
+    //     key: 'effectSpeed',
+    //     Characteristic: this.Characteristics.my.EffectSpeed,
+    //     value: 50
+    //   }).on('didSet', (value) => {
+    //     this.setEffectSpeed(value)
+    //   })
+    //   this.hk.effectColours = []
+    //   for (let i = 0; i <= 5; i++) {
+    //     const service = new this.Service.Lightbulb(
+    //       this.name + ' Effect Color ' + (i + 1), this.subtype + '-C' + i
+    //     )
+    //     service.addCharacteristicDelegate({
+    //       key: 'on',
+    //       Characteristic: this.Characteristics.hap.On,
+    //       value: true
+    //     }).on('didSet', (value) => {
+    //       this.setEffectOn(i, value)
+    //     })
+    //     service.addCharacteristicDelegate({
+    //       key: 'hue',
+    //       Characteristic: this.Characteristics.hap.Hue,
+    //       value: i * 60
+    //     }).on('didSet', (value) => {
+    //       this.setEffectHue(i, value)
+    //     })
+    //     service.addCharacteristicDelegate({
+    //       key: 'saturation',
+    //       Characteristic: this.Characteristics.hap.Saturation,
+    //       value: 100
+    //     }).on('didSet', (value) => {
+    //       this.setEffectSat(i, value)
+    //     })
+    //     this.effectServices.push(service)
+    //   }
+    // }
+    // this.checkEffect(this.obj.state.effect)
+  }
+
   updateState (state) {
     this.initAdaptiveLighting()
     let updateAdaptiveLighting = false
@@ -474,13 +499,13 @@ class Light extends DeconzService.LightsResource {
   async updateAdaptiveLighting () {
     if (
       this.adaptiveLighting == null || // not supported
-      this.values.activeTransitionCount === 0 || // disabled
-      !this.values.on // light is off
+      this.values.activeTransitionCount === 0 // disabled
+      // !this.values.on // light is off
     ) {
       return
     }
     const ct = this.adaptiveLighting.getCt(
-      this.values.brightness * this.platform.config.brightnessAdjustment
+      this.values.brightness * this.gateway.values.brightnessAdjustment
     )
     if (ct == null) {
       this.warn('adaptive lighting: cannot compute Color Temperature')

package/lib/DeconzService/LightLevel.js

@@ -19,7 +19,7 @@ class LightLevel extends DeconzService.SensorsResource {
     super(accessory, resource, params)
 
     this.addCharacteristicDelegate({
-      key: 'lightlevel',
+      key: 'lightLevel',
       Characteristic: this.Characteristics.hap.CurrentAmbientLightLevel,
       unit: ' lux'
     })
@@ -36,12 +36,12 @@ class LightLevel extends DeconzService.SensorsResource {
 
     this.addCharacteristicDelegates()
 
-    this.update(resource.body)
+    this.update(resource.body, resource.rpath)
   }
 
   updateState (state) {
     if (state.lightlevel != null) {
-      this.values.lightlevel = lightLevelToLux(state.lightlevel)
+      this.values.lightLevel = lightLevelToLux(state.lightlevel)
     }
     if (state.dark != null) {
       this.values.dark = state.dark

package/lib/DeconzService/Motion.js

@@ -15,13 +15,13 @@ class Motion extends DeconzService.SensorsResource {
     params.Service = accessory.Services.hap.MotionSensor
     super(accessory, resource, params)
 
-    this.durationKey = resource.body.config.delay !== null ? 'delay' : 'duration'
+    this.durationKey = resource.body.config.delay != null ? 'delay' : 'duration'
     this.sensitivitymax = resource.body.config.sensitivitymax
 
     this.addCharacteristicDelegate({
       key: 'motion',
       Characteristic: this.Characteristics.hap.MotionDetected,
-      value: 0
+      value: false
     })
 
     this.addCharacteristicDelegate({
@@ -52,15 +52,9 @@ class Motion extends DeconzService.SensorsResource {
       }
     })
 
-    this.addCharacteristicDelegate({
-      key: 'lastActivation',
-      Characteristic: this.Characteristics.eve.LastActivation,
-      silent: true
-    })
-
     this.addCharacteristicDelegates()
 
-    this.update(resource.body)
+    this.update(resource.body, resource.rpath)
   }
 
   updateState (state) {

package/lib/DeconzService/Power.js

@@ -46,6 +46,7 @@ class Power extends DeconzService.SensorsResource {
         silent: true
       })
     }
+    service.update(resource.body, resource.rpath)
   }
 
   static updateResourceState (service, state) {
@@ -71,7 +72,7 @@ class Power extends DeconzService.SensorsResource {
 
     super.addCharacteristicDelegates({ noLastUpdated: true })
 
-    this.update(resource.body)
+    this.update(resource.body, resource.rpath)
   }
 
   updateState (state) {

package/lib/DeconzService/Status.js

@@ -39,7 +39,7 @@ class Status extends DeconzService.SensorsResource {
 
     this.addCharacteristicDelegates()
 
-    this.update(resource.body)
+    this.update(resource.body, resource.rpath)
   }
 
   updateState (state) {

package/lib/DeconzService/Switch.js

@@ -78,7 +78,7 @@ class Switch extends DeconzService.SensorsResource {
         if (this.buttonServices[i] != null) {
           this.buttonServices[i].update(
             buttonResource.buttonEvent, oldValue,
-            this.accessoryDelegate.settingsService.values.repeat
+            false // this.accessoryDelegate.settingsService.values.repeat
           )
         }
       } else {

package/lib/DeconzService/WindowCovering.js

@@ -15,6 +15,12 @@ class WindowCovering extends DeconzService.LightsResource {
     params.Service = accessory.Services.hap.WindowCovering
     super(accessory, resource, params)
 
+    this.addCharacteristicDelegate({
+      key: 'venetianBlind',
+      value: false,
+      silent: true
+    })
+
     this.addCharacteristicDelegate({
       key: 'currentPosition',
       Characteristic: this.Characteristics.hap.CurrentPosition,
@@ -47,7 +53,7 @@ class WindowCovering extends DeconzService.LightsResource {
       this.values.positionState = this.Characteristics.hap.PositionState.STOPPED
     })
 
-    if (this.venetianBlind) {
+    if (this.values.venetianBlind) {
       this.addCharacteristicDelegate({
         key: 'closeUpwards',
         Characteristic: this.Characteristics.my.CloseUpwards
@@ -55,7 +61,9 @@ class WindowCovering extends DeconzService.LightsResource {
         if (!fromHomeKit) {
           return
         }
-        await this.setPosition()
+        if (this.values.currentPosition !== 100) {
+          await this.setPosition()
+        }
       })
     }
 
@@ -100,7 +108,7 @@ class WindowCovering extends DeconzService.LightsResource {
 
   async setPosition () {
     let lift = 100 - this.values.targetPosition // % closed --> % open
-    if (this.venetianBlind) {
+    if (this.values.venetianBlind) {
       if (this.values.closeUpwards) {
         lift *= -1
       }
@@ -121,7 +129,9 @@ class WindowCovering extends DeconzService.LightsResource {
     if (state.lift != null) {
       let position = Math.round(state.lift / 5) * 5
       let closeUpwards
-      if (this.venetianBlind) {
+      if (this.values.venetianBlind) {
+        position *= 2
+        position -= 100
         if (position < 0) {
           position *= -1
           closeUpwards = true

package/lib/DeconzService/index.js

@@ -24,9 +24,8 @@ class DeconzService extends homebridgeLib.ServiceDelegate {
   static get Consumption () { return require('./Consumption') }
   static get Contact () { return require('./Contact') }
   static get Daylight () { return require('./Daylight') }
-  static get DeviceSettings () { return require('./DeviceSettings') }
   static get Flag () { return require('./Flag') }
-  static get GatewaySettings () { return require('./GatewaySettings') }
+  static get Gateway () { return require('./Gateway') }
   static get Humidity () { return require('./Humidity') }
   static get Leak () { return require('./Leak') }
   static get Light () { return require('./Light') }
@@ -64,13 +63,13 @@ class DeconzService extends homebridgeLib.ServiceDelegate {
 
     this.serviceNameByRpath = {}
 
-    this.characteristicDelegate('configuredName')
-      .on('didSet', async (value, fromHomeKit) => {
-        if (fromHomeKit && value != null && value !== '') {
-          this.debug('PUT %s %j', this.rpath, { name: value })
-          await this.client.put(this.rpath, { name: value })
-        }
-      })
+    // this.characteristicDelegate('configuredName')
+    //   .on('didSet', async (value, fromHomeKit) => {
+    //     if (fromHomeKit && value != null && value !== '') {
+    //       this.debug('PUT %s %j', this.rpath, { name: value })
+    //       await this.client.put(this.rpath, { name: value })
+    //     }
+    //   })
   }
 
   addResource (resource) {
@@ -89,9 +88,9 @@ class DeconzService extends homebridgeLib.ServiceDelegate {
       }
       return
     }
-    if (body.name != null) {
-      this.values.configuredName = body.name
-    }
+    // if (body.name != null) {
+    //   this.values.configuredName = body.name.slice(0, 31).trim()
+    // }
     if (body.lastseen != null && this.rtype === 'lights') {
       this.values.lastSeen = dateToString(body.lastseen)
     }

package/package.json

@@ -4,7 +4,7 @@
   "displayName": "Homebridge deCONZ",
   "author": "Erik Baauw",
   "license": "Apache-2.0",
-  "version": "0.0.27",
+  "version": "0.1.1",
   "keywords": [
     "homebridge-plugin",
     "homekit",
@@ -20,13 +20,13 @@
     "deconz": "cli/deconz.js"
   },
   "engines": {
-    "deCONZ": "2.19.1",
-    "homebridge": "^1.5.1",
-    "node": "^18.12.1"
+    "deCONZ": "2.19.3",
+    "homebridge": "^1.6.0",
+    "node": "^18.13.0"
   },
   "dependencies": {
-    "homebridge-lib": "~6.0.1",
-    "ws": "^8.11.0",
+    "homebridge-lib": "~6.3.4",
+    "ws": "^8.12.0",
     "xml2js": "~0.4.23"
   },
   "scripts": {

package/lib/DeconzAccessory/Contact.js

@@ -1,53 +0,0 @@
-// 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, {
-      contactDelegate: this.service.characteristicDelegate('contact'),
-      timesOpenedDelegate: this.service.characteristicDelegate('timesOpened'),
-      lastActivationDelegate: this.service.characteristicDelegate('lastActivation')
-    })
-
-    this.createSettingsService()
-
-    setImmediate(() => {
-      this.debug('initialised')
-      this.emit('initialised')
-    })
-  }
-}
-
-module.exports = Contact