homebridge-deconz 0.1.9 → 0.1.11

package/lib/DeconzService/Label.js

@@ -0,0 +1,103 @@
+// homebridge-deconz/lib/DeconzService/Label.js
+// Copyright© 2022-2023 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const DeconzService = require('.')
+
+/**
+  * @memberof DeconzService
+  */
+class Label extends DeconzService.SensorsResource {
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.hap.ServiceLabel
+    super(accessory, resource, params)
+
+    this.addCharacteristicDelegate({
+      key: 'namespace',
+      Characteristic: this.Characteristics.hap.ServiceLabelNamespace,
+      value: resource.capabilities.namespace
+    })
+
+    this.addCharacteristicDelegates({ noLastUpdated: true })
+
+    this.buttonResources = {}
+    this.buttonServices = {}
+    this.hasRepeat = false
+  }
+
+  createButtonServices (resource) {
+    if (resource.body.type.endsWith('Switch')) {
+      this.buttonResources[resource.rpath] = {
+        buttonEvent: resource.body.state.buttonevent,
+        lastUpdated: '',
+        toButtonEvent: resource.capabilities.toButtonEvent
+      }
+    } else if (resource.body.type.endsWith('RelativeRotary')) {
+      const keys = Object.keys(resource.capabilities.buttons)
+      this.buttonResources[resource.rpath] = {
+        lastUpdated: '',
+        right: keys[0],
+        left: keys[1]
+      }
+    }
+    for (const i in resource.capabilities.buttons) {
+      const { label, events, hasRepeat } = resource.capabilities.buttons[i]
+      if (hasRepeat) {
+        this.hasRepeat = hasRepeat
+      }
+      this.buttonServices[i] = new DeconzService.Button(this.accessoryDelegate, {
+        name: this.name + ' ' + label,
+        button: Number(i),
+        events,
+        hasRepeat
+      })
+    }
+  }
+
+  updateState (state, rpath) {
+    const buttonResource = this.buttonResources[rpath]
+    if (buttonResource.lastUpdated === '') {
+      buttonResource.lastUpdated = state.lastupdated
+    } else if (
+      state.lastupdated != null &&
+      state.lastupdated !== buttonResource.lastUpdated
+    ) {
+      buttonResource.lastUpdated = state.lastupdated
+      if (buttonResource.buttonEvent !== undefined) {
+        const oldValue = buttonResource.buttonEvent
+        if (state.buttonevent != null) {
+          buttonResource.buttonEvent = buttonResource.toButtonEvent == null
+            ? state.buttonevent
+            : buttonResource.toButtonEvent(state.buttonevent)
+        }
+        // TODO handle repeat
+        const i = Math.floor(buttonResource.buttonEvent / 1000)
+        this.buttonServices[i]?.update(
+          buttonResource.buttonEvent, oldValue,
+          false // this.accessoryDelegate.settingsService.values.repeat
+        )
+      } else {
+        const i = state.expectedrotation >= 0
+          ? buttonResource.right
+          : buttonResource.left
+        this.buttonServices[i].updateRotation()
+      }
+    }
+    super.updateState(state)
+  }
+
+  updateConfig (config) {
+    // TODO handle change in devicemode
+    super.updateConfig(config)
+  }
+
+  async identify () {
+    this.debug('hasRepeat: %j', this.hasRepeat)
+    return super.identify()
+  }
+}
+
+module.exports = Label

package/lib/DeconzService/Light.js

@@ -8,14 +8,31 @@
 const { AdaptiveLighting, Colour, ServiceDelegate, timeout } = require('homebridge-lib')
 const DeconzService = require('../DeconzService')
 
-const { xyToHsv, hsvToXy, ctToXy } = Colour
-const { History } = ServiceDelegate
+const { defaultGamut, xyToHsv, hsvToXy, ctToXy } = Colour
 
 class Light extends DeconzService.LightsResource {
   constructor (accessory, resource, params = {}) {
     params.Service = accessory.Services.hap.Lightbulb
     super(accessory, resource, params)
 
+    this.capabilities = {
+      on: this.resource.body.state.on !== undefined,
+      bri: this.resource.body.state.bri !== undefined,
+      ct: this.resource.body.state.ct !== undefined,
+      hs: this.resource.body.state.xy === undefined &&
+        this.resource.body.state.hue !== undefined,
+      xy: this.resource.body.state.xy !== undefined
+    }
+    if (this.resource.body?.capabilities?.color?.effects != null) {
+      const effects = this.resource.body.capabilities.color.effects
+      if (effects.length > 1 && effects[1] === 'colorloop') {
+        this.capabilities.colorLoop = true
+        this.capabilities.effects = effects.length > 2
+      } else if (effects.length > 1) {
+        this.capabilities.effects = effects.length > 1
+      }
+    }
+
     this.addCharacteristicDelegate({
       key: 'on',
       Characteristic: this.Characteristics.hap.On,
@@ -81,11 +98,7 @@ class Light extends DeconzService.LightsResource {
       })
     }
 
-    if (
-      this.resource.body.config != null &&
-      this.resource.body.config.color != null &&
-      this.resource.body.config.color.execute_if_off != null
-    ) {
+    if (this.resource.body?.config?.color?.execute_if_off != null) {
       this.addCharacteristicDelegate({
         key: 'colorExecuteIfOff',
         value: this.resource.body.config.color.execute_if_off
@@ -93,19 +106,27 @@ class Light extends DeconzService.LightsResource {
     }
 
     if (this.capabilities.ct) {
+      if (
+        this.resource.body?.capabilities?.color?.ct?.min == null ||
+        this.resource.body?.capabilities?.color?.ct?.max == null
+      ) {
+        if (this.capabilities.on) {
+          this.warn('using default ct range')
+        }
+      }
+      const ctMin = this.resource.body?.capabilities?.color?.ct?.min ?? 153
+      const ctMax = this.resource.body?.capabilities?.color?.ct?.max ?? 500
       this.colorTemperatureDelegate = this.addCharacteristicDelegate({
         key: 'colorTemperature',
         Characteristic: this.Characteristics.hap.ColorTemperature,
         unit: ' mired',
         props: {
-          minValue: this.capabilities.ctMin,
-          maxValue: this.capabilities.ctMax
+          minValue: ctMin,
+          maxValue: ctMax
         },
         value: this.resource.body.state.ct
       }).on('didSet', (value, fromHomeKit) => {
-        const ct = Math.max(
-          this.capabilities.ctMin, Math.min(value, this.capabilities.ctMax)
-        )
+        const ct = Math.max(ctMin, Math.min(value, ctMax))
         if (fromHomeKit) {
           this.checkAdaptiveLighting()
           this.put({ ct })
@@ -120,6 +141,23 @@ class Light extends DeconzService.LightsResource {
     }
 
     if (this.capabilities.xy) {
+      if (
+        this.resource.body?.capabilities?.color?.xy?.blue == null ||
+        this.resource.body?.capabilities?.color?.xy?.green == null ||
+        this.resource.body?.capabilities?.color?.xy?.red == null
+      ) {
+        if (this.capabilities.on) {
+          this.warn('using default xy gamut')
+        }
+        this.capabilities.gamut = defaultGamut
+      } else {
+        this.capabilities.gamut = {
+          r: this.resource.body.capabilities.color.xy.red,
+          g: this.resource.body.capabilities.color.xy.green,
+          b: this.resource.body.capabilities.color.xy.blue
+        }
+      }
+
       this.addCharacteristicDelegate({
         key: 'hue',
         Characteristic: this.Characteristics.hap.Hue,
@@ -261,13 +299,7 @@ class Light extends DeconzService.LightsResource {
     }
 
     if (this.capabilities.effects != null) {
-      this.addCharacteristicDelegate({
-        key: 'exposeEffects',
-        value: true
-      })
-      if (this.values.exposeEffects) {
-        this.exposeEffects()
-      }
+      this.exposeEffects()
     }
 
     if (this.resource.rtype === 'lights') {
@@ -279,57 +311,29 @@ class Light extends DeconzService.LightsResource {
   }
 
   exposeEffects () {
-    this.effectServices = {}
-    this.addCharacteristicDelegate({
-      key: 'effect',
-      value: -1,
+    const effectString = this.addCharacteristicDelegate({
+      key: 'effectString',
+      value: 'none',
       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 ServiceDelegate(this.accessoryDelegate, {
-        name: this.resource.body.name + ' ' + effect,
-        Service: this.Services.hap.Lightbulb,
-        subtype: (this.subtype == null ? 'E' : this.subtype + '-E') + id
-      })
-      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]
+    for (const id in this.resource.body.capabilities.color.effects) {
+      const effect = this.resource.body.capabilities.color.effects[id]
+      const characteristicName = effect[0].toUpperCase() + effect.slice(1) + 'Effect'
+      if (this.Characteristics.my[characteristicName] != null) {
+        this.addCharacteristicDelegate({
+          key: effect,
+          Characteristic: this.Characteristics.my[characteristicName]
+        }).on('didSet', (value, fromHomeKit) => {
+          if (fromHomeKit) {
+            this.checkAdaptiveLighting()
+            this.put({ effect: value ? effect : 'none' })
+            this.values.effectString = value ? effect : 'none'
           }
         })
+        effectString.on('didSet', (value) => {
+          this.values[effect] = value === effect
+        })
+      }
     }
     // if (this.capabilities.effectSpeed) {
     //   this.addCharacteristicDelegate({
@@ -403,9 +407,8 @@ class Light extends DeconzService.LightsResource {
           break
         case 'effect':
           this.values.colorLoop = value === 'colorloop'
-          if (this.capabilities.effects != null) {
-            const effectName = value[0].toUpperCase() + value.slice(1)
-            this.values.effect = '' + this.capabilities.effects.indexOf(effectName)
+          if (this.capabilities.effects) {
+            this.values.effectString = value
           }
           break
         case 'hue':
@@ -430,8 +433,10 @@ class Light extends DeconzService.LightsResource {
           break
         case 'xy':
           if (
-            !this.recentlyUpdated &&
-            (this.values.colormode !== 'ct' || this.capabilities.computesXy)
+            !this.recentlyUpdated && (
+              this.values.colormode !== 'ct' ||
+              this.resource.body?.capabilities?.color?.ct?.computesXy
+            )
           ) {
             const { h, s } = xyToHsv(value, this.capabilities.gamut)
             this.values.hue = h

package/lib/DeconzService/Outlet.js

@@ -24,7 +24,7 @@ class Outlet extends DeconzService.LightsResource {
       }
     })
 
-    if (!this.capabilities.on) {
+    if (this.resource.body.state.on === undefined) {
       this.addCharacteristicDelegate({
         key: 'anyOn',
         Characteristic: this.Characteristics.my.AnyOn,

package/lib/DeconzService/Power.js

@@ -15,10 +15,10 @@ const { dateToString } = Deconz.ApiClient
   */
 class Power extends DeconzService.SensorsResource {
   static addResource (service, resource) {
-    if (service.values.currentConsumption === undefined) {
+    if (service.values.consumption === undefined) {
       service.addCharacteristicDelegate({
-        key: 'currentConsumption',
-        Characteristic: service.Characteristics.eve.CurrentConsumption,
+        key: 'consumption',
+        Characteristic: service.Characteristics.eve.Consumption,
         unit: ' W'
       })
     }
@@ -46,12 +46,13 @@ class Power extends DeconzService.SensorsResource {
         silent: true
       })
     }
-    service.update(resource.body, resource.rpath)
+
+    Power.updateResourceState(service, resource.body.state)
   }
 
   static updateResourceState (service, state) {
     if (state.power != null) {
-      service.values.currentConsumption = state.power
+      service.values.consumption = state.power
     }
     if (state.current != null) {
       service.values.electricCurrent = state.current / 1000

package/lib/DeconzService/Status.js

@@ -11,6 +11,30 @@ const DeconzService = require('../DeconzService')
   * @memberof DeconzService
   */
 class Status extends DeconzService.SensorsResource {
+  props (caps) {
+    if (caps.min == null || caps.max == null) {
+      return undefined
+    }
+    // Eve 3.1 displays the following controls, depending on the properties:
+    // 1. {minValue: 0, maxValue: 1, minStep: 1}                    switch
+    // 2. {minValue: a, maxValue: b, minStep: 1}, 1 < b - a <= 20   down|up
+    // 3. {minValue: a, maxValue: b}, (a, b) != (0, 1)              slider
+    // 4. {minValue: a, maxValue: b, minStep: 1}, b - a > 20        slider
+    // Avoid the following bugs:
+    // 5. {minValue: 0, maxValue: 1}                                nothing
+    // 6. {minValue: a, maxValue: b, minStep: 1}, b - a = 1         switch*
+    //    *) switch sends values 0 and 1 instead of a and b;
+    if (caps.min === 0 && caps.max === 1) {
+      // Workaround Eve bug (case 5 above).
+      return { minValue: caps.min, maxValue: caps.max, minStep: 1 }
+    }
+    if (caps.max - caps.min === 1) {
+      // Workaround Eve bug (case 6 above).
+      return { minValue: caps.min, maxValue: caps.max }
+    }
+    return { minValue: caps.min, maxValue: caps.max, minStep: 1 }
+  }
+
   constructor (accessory, resource, params = {}) {
     params.Service = accessory.Services.my.Status
     super(accessory, resource, params)
@@ -29,7 +53,7 @@ class Status extends DeconzService.SensorsResource {
       this.addCharacteristicDelegate({
         key: 'status',
         Characteristic: this.Characteristics.my.Status,
-        props: resource.capabilities.props
+        props: this.props(resource.capabilities)
       }).on('didSet', async (value, fromHomeKit) => {
         if (fromHomeKit) {
           await this.put('/state', { status: value })

package/lib/DeconzService/Switch.js

@@ -5,101 +5,66 @@
 
 'use strict'
 
-const DeconzService = require('../DeconzService')
+const DeconzService = require('.')
 
-/**
-  * @memberof DeconzService
-  */
-class Switch extends DeconzService.SensorsResource {
+class Switch extends DeconzService.LightsResource {
   constructor (accessory, resource, params = {}) {
-    params.Service = accessory.Services.hap.ServiceLabel
+    params.Service = accessory.Services.hap.Switch
     super(accessory, resource, params)
 
     this.addCharacteristicDelegate({
-      key: 'namespace',
-      Characteristic: this.Characteristics.hap.ServiceLabelNamespace,
-      value: resource.capabilities.namespace
+      key: 'on',
+      Characteristic: this.Characteristics.hap.On,
+      value: this.capabilities.on
+        ? this.resource.body.state.on
+        : this.resource.body.state.all_on
+    }).on('didSet', (value, fromHomeKit) => {
+      if (fromHomeKit) {
+        this.put({ on: value })
+      }
     })
 
-    this.addCharacteristicDelegates({ noLastUpdated: true })
+    if (this.resource.body.state.on === undefined) {
+      this.addCharacteristicDelegate({
+        key: 'anyOn',
+        Characteristic: this.Characteristics.my.AnyOn,
+        value: this.resource.body.state.any_on
+      }).on('didSet', (value, fromHomeKit) => {
+        if (fromHomeKit) {
+          this.put({ on: value })
+        }
+      })
+    }
 
-    this.buttonResources = {}
-    this.buttonServices = {}
-    this.hasRepeat = false
-  }
+    this.addCharacteristicDelegates()
 
-  createButtonServices (resource) {
-    if (resource.body.type.endsWith('Switch')) {
-      this.buttonResources[resource.rpath] = {
-        buttonEvent: resource.body.state.buttonevent,
-        lastUpdated: '',
-        toButtonEvent: resource.capabilities.toButtonEvent
-      }
-    } else if (resource.body.type.endsWith('RelativeRotary')) {
-      const keys = Object.keys(resource.capabilities.buttons)
-      this.buttonResources[resource.rpath] = {
-        lastUpdated: '',
-        right: keys[0],
-        left: keys[1]
-      }
-    }
-    for (const i in resource.capabilities.buttons) {
-      const { label, events, hasRepeat } = resource.capabilities.buttons[i]
-      if (hasRepeat) {
-        this.hasRepeat = hasRepeat
-      }
-      this.buttonServices[i] = new DeconzService.Button(this.accessoryDelegate, {
-        name: this.name + ' ' + label,
-        button: Number(i),
-        events,
-        hasRepeat
-      })
+    this.settings = {
+      resetTimeout: this.platform.config.resetTimeout,
+      waitTimeUpdate: this.platform.config.waitTimeUpdate,
+      wallSwitch: false
     }
   }
 
   updateState (state, rpath) {
-    const buttonResource = this.buttonResources[rpath]
-    if (buttonResource.lastUpdated === '') {
-      buttonResource.lastUpdated = state.lastupdated
-    } else if (
-      state.lastupdated != null &&
-      state.lastupdated !== buttonResource.lastUpdated
-    ) {
-      buttonResource.lastUpdated = state.lastupdated
-      if (buttonResource.buttonEvent !== undefined) {
-        const oldValue = buttonResource.buttonEvent
-        if (state.buttonevent != null) {
-          buttonResource.buttonEvent = buttonResource.toButtonEvent == null
-            ? state.buttonevent
-            : buttonResource.toButtonEvent(state.buttonevent)
-        }
-        // TODO handle repeat
-        const i = Math.floor(buttonResource.buttonEvent / 1000)
-        if (this.buttonServices[i] != null) {
-          this.buttonServices[i].update(
-            buttonResource.buttonEvent, oldValue,
-            false // this.accessoryDelegate.settingsService.values.repeat
-          )
-        }
-      } else {
-        const i = state.expectedrotation >= 0
-          ? buttonResource.right
-          : buttonResource.left
-        this.buttonServices[i].updateRotation()
+    for (const key in state) {
+      const value = state[key]
+      this.resource.body.state[key] = value
+      switch (key) {
+        case 'all_on':
+          this.values.on = value
+          break
+        case 'any_on':
+          this.values.anyOn = value
+          break
+        case 'on':
+          this.values.on = value
+          break
+        default:
+          break
       }
     }
     super.updateState(state)
   }
-
-  updateConfig (config) {
-    // TODO handle change in devicemode
-    super.updateConfig(config)
-  }
-
-  async identify () {
-    this.debug('hasRepeat: %j', this.hasRepeat)
-    return super.identify()
-  }
 }
 
 module.exports = Switch

package/lib/DeconzService/index.js

@@ -27,6 +27,7 @@ class DeconzService extends ServiceDelegate {
   static get Flag () { return require('./Flag') }
   static get Gateway () { return require('./Gateway') }
   static get Humidity () { return require('./Humidity') }
+  static get Label () { return require('./Label') }
   static get Leak () { return require('./Leak') }
   static get Light () { return require('./Light') }
   static get LightsResource () { return require('./LightsResource') }

package/package.json

@@ -4,7 +4,7 @@
   "displayName": "Homebridge deCONZ",
   "author": "Erik Baauw",
   "license": "Apache-2.0",
-  "version": "0.1.9",
+  "version": "0.1.11",
   "keywords": [
     "homebridge-plugin",
     "homekit",
@@ -21,13 +21,13 @@
     "ui": "cli/ui.js"
   },
   "engines": {
-    "deCONZ": "2.19.3",
+    "deCONZ": "2.21.2",
     "homebridge": "^1.6.0",
-    "node": "^18.14.2"
+    "node": "^18.15.0"
   },
   "dependencies": {
-    "homebridge-lib": "~6.3.11",
-    "ws": "^8.12.1",
+    "homebridge-lib": "~6.3.13",
+    "ws": "^8.13.0",
     "xml2js": "~0.4.23"
   },
   "scripts": {