homebridge-deconz 0.0.25 → 0.0.27

package/cli/deconz.js

@@ -711,12 +711,15 @@ class Main extends homebridgeLib.CommandLineTool {
       .on('changed', (rtype, rid, body) => {
         let resource = '/' + rtype + '/' + rid
         if (Object.keys(body).length === 1) {
-          if (body.state != null) {
-            resource += '/state'
-            body = body.state
+          if (body.capabilities != null) {
+            resource += '/capabilities'
+            body = body.capabilities
           } else if (body.config != null) {
             resource += '/config'
             body = body.config
+          } else if (body.state != null) {
+            resource += '/state'
+            body = body.state
           }
         }
         this.log('%s: %s', resource, this.jsonFormatter.stringify(body))

package/lib/Deconz/ApiError.js

@@ -21,21 +21,28 @@ const nonCriticalApiErrorTypes = [
   * @memberof Deconz
   */
 class ApiError extends homebridgeLib.HttpClient.HttpError {
-  constructor (message, response, type, description) {
-    super(message, response.request, response.statusCode, response.statusMessage)
+  constructor (e, response) {
+    super(
+      `${e.address}: api error ${e.type}: ${e.description}`,
+      response.request, response.statusCode, response.statusMessage
+    )
 
     /** @member {integer} - The API error type.
       */
-    this.type = type
+    this.type = e.type
+
+    /** @member {string} - The address causing the error.
+      */
+    this.address = e.address
 
     /** @member {string} - The API error description.
       */
-    this.description = description
+    this.description = e.description
 
     /** @member {boolean} - Indication that the request might still succeed
       * for other attributes.
       */
-    this.nonCritical = nonCriticalApiErrorTypes.includes(type)
+    this.nonCritical = nonCriticalApiErrorTypes.includes(e.type)
   }
 }
 

package/lib/Deconz/ApiResponse.js

@@ -33,17 +33,20 @@ class ApiResponse extends homebridgeLib.HttpClient.HttpResponse {
       for (const id in response.body) {
         const e = response.body[id].error
         if (e != null && typeof e === 'object') {
-          this.errors.push(new Deconz.ApiError(
-            `api error ${e.type}: ${e.description}`,
-            response, e.type, e.description
-          ))
+          this.errors.push(new Deconz.ApiError(e, response))
         }
         const s = response.body[id].success
         if (s != null && typeof s === 'object') {
           for (const path of Object.keys(s)) {
-            const a = path.split('/')
-            const key = a[a.length - 1]
-            this.success[key] = s[path]
+            const keys = path.split('/')
+            let obj = this.success
+            for (let i = 1; i < keys.length - 1; i++) {
+              if (obj[keys[i]] == null) {
+                obj[keys[i]] = {}
+              }
+              obj = obj[keys[i]]
+            }
+            obj[keys[keys.length - 1]] = s[path]
           }
         }
       }

package/lib/Deconz/WsClient.js

@@ -91,12 +91,14 @@ class WsClient extends events.EventEmitter {
                 case 'changed':
                   if (obj.r !== null && obj.id !== null) {
                     let body
-                    if (obj.state != null) {
-                      body = { state: obj.state }
+                    if (obj.attr != null) {
+                      body = obj.attr
+                    } else if (obj.capabilities != null) {
+                      body = { capabilities: obj.capabilities }
                     } else if (obj.config != null) {
                       body = { config: obj.config }
-                    } else if (obj.attr != null) {
-                      body = obj.attr
+                    } else if (obj.state != null) {
+                      body = { state: obj.state }
                     }
                     /** Emitted when a `changed` notification has been received.
                       *

package/lib/DeconzAccessory/Contact.js

@@ -35,12 +35,11 @@ class Contact extends DeconzAccessory {
       this.createService(resource)
     }
 
-    this.historyService = new History.Contact(
-      this, {},
-      this.service.characteristicDelegate('contact'),
-      this.service.characteristicDelegate('timesOpened'),
-      this.service.characteristicDelegate('lastActivation')
-    )
+    this.historyService = new History.Contact(this, {
+      contactDelegate: this.service.characteristicDelegate('contact'),
+      timesOpenedDelegate: this.service.characteristicDelegate('timesOpened'),
+      lastActivationDelegate: this.service.characteristicDelegate('lastActivation')
+    })
 
     this.createSettingsService()
 

package/lib/DeconzAccessory/Gateway.js

@@ -164,7 +164,8 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
       name: this.name + ' Button',
       button: 1,
       events: DeconzService.Button.SINGLE | DeconzService.Button.DOUBLE |
-        DeconzService.Button.LONG
+        DeconzService.Button.LONG,
+      exposeConfiguredName: true
     })
 
     this.createClient()

package/lib/DeconzAccessory/Light.js

@@ -21,8 +21,6 @@ class Light extends DeconzAccessory {
     * @param {Deconz.Device} device - The device.
     */
   constructor (gateway, device, settings = {}) {
-    // settings.forceEveEnergy = true
-
     super(gateway, device, gateway.Accessory.Categories.LIGHTBULB)
 
     this.identify()
@@ -37,14 +35,12 @@ class Light extends DeconzAccessory {
       serviceName: this.values.serviceName
     })
 
-    let nLights = 1
     for (const subtype in device.resourceBySubtype) {
       const resource = device.resourceBySubtype[subtype]
       if (subtype === device.primary) {
         continue
       }
       if (resource.rtype === 'lights') {
-        nLights++
         this.createService(resource, { serviceName: this.values.serviceName })
       } else {
         this.createService(resource)
@@ -61,12 +57,15 @@ class Light extends DeconzAccessory {
             unit: ' W'
           })
           : null
-      this.historyService = new History.Consumption(
-        this, {},
-        this.service.characteristicDelegate('totalConsumption'),
-        currentConsumption,
-        this.service.characteristicDelegate('on')
-      )
+      this.service.addCharacteristicDelegate({
+        key: 'lockPhysicalControls',
+        Characteristic: this.Characteristics.hap.LockPhysicalControls
+      })
+      this.historyService = new History.Consumption(this, {
+        consumptionDelegate: this.service.characteristicDelegate('totalConsumption'),
+        powerDelegate: currentConsumption,
+        onDelegate: this.service.characteristicDelegate('on')
+      })
     } else if (this.serviceByServiceName.Power != null) {
       // Total Consumption to be computed by history
       const TotalConsumption = this.service.addCharacteristicDelegate({
@@ -75,43 +74,25 @@ class Light extends DeconzAccessory {
         unit: ' kWh',
         value: 0
       })
-      this.historyService = new History.Power(
-        this, {},
-        this.service.characteristicDelegate('currentConsumption'),
-        TotalConsumption,
-        this.service.characteristicDelegate('on')
-      )
-    } else if (this.values.serviceName === 'Outlet' && settings.forceEveEnergy) {
-      if (nLights > 1) {
-        // Eve would recognise device as Eve Energy Strip.
-      } else if (this.serviceByServiceName.Switch != null) {
-        // Eve would recognise device as Eve Button.
-      } else {
-        // Needed for Eve to recognise device as Eve Energy.
-        this.service.addCharacteristicDelegate({
-          key: 'totalConsumption',
-          Characteristic: this.Characteristics.eve.TotalConsumption,
-          unit: ' kWh'
-        })
-        this.historyService = new History.On(
-          this, {},
-          this.service.characteristicDelegate('on')
-        )
-      }
-    }
-
-    if (this.values.serviceName === 'Outlet' && this.historyService != null) {
-      if (nLights > 1) {
-        // Eve would recognise device as Eve Energy Strip.
-      } else if (this.serviceByServiceName.Switch != null) {
-        // Eve would recognise device as Eve Button.
-      } else {
-        // Needed for Eve to show history for On.
-        this.service.addCharacteristicDelegate({
-          key: 'lockPhysicalControls',
-          Characteristic: this.Characteristics.hap.LockPhysicalControls
-        })
-      }
+      this.service.addCharacteristicDelegate({
+        key: 'lockPhysicalControls',
+        Characteristic: this.Characteristics.hap.LockPhysicalControls
+      })
+      this.historyService = new History.Power(this, {
+        powerDelegate: this.service.characteristicDelegate('currentConsumption'),
+        consumptionDelegate: TotalConsumption,
+        onDelegate: this.service.characteristicDelegate('on')
+      })
+    } else {
+      const lastActivation = this.service.addCharacteristicDelegate({
+        key: 'lastActivation',
+        Characteristic: this.Characteristics.eve.LastActivation,
+        silent: true
+      })
+      this.historyService = new History.Light(this, {
+        onDelegate: this.service.characteristicDelegate('on'),
+        lastActivationDelegate: lastActivation
+      })
     }
 
     this.createSettingsService()

package/lib/DeconzAccessory/Motion.js

@@ -30,17 +30,16 @@ class Motion extends DeconzAccessory {
       this.createService(resource)
     }
 
-    this.historyService = new History.Motion(
-      this, {},
-      this.service.characteristicDelegate('motion'),
-      this.service.characteristicDelegate('lastActivation'),
-      this.serviceByServiceName.LightLevel == null
+    this.historyService = new History.Motion(this, {
+      motionDelegate: this.service.characteristicDelegate('motion'),
+      lastActivationDelegate: this.service.characteristicDelegate('lastActivation'),
+      lightLevelDelegate: this.serviceByServiceName.LightLevel == null
         ? null
         : this.serviceByServiceName.LightLevel.characteristicDelegate('lightlevel'),
-      this.serviceByServiceName.Temperature == null
+      temperatureDelegate: this.serviceByServiceName.Temperature == null
         ? null
         : this.serviceByServiceName.Temperature.characteristicDelegate('temperature')
-    )
+    })
 
     this.createSettingsService()
 

package/lib/DeconzAccessory/Temperature.js

@@ -30,25 +30,23 @@ class Temperature extends DeconzAccessory {
     }
 
     if (this.serviceByServiceName.AirQuality == null) {
-      this.historyService = new History.Weather(
-        this, {},
-        this.service.characteristicDelegate('temperature'),
-        this.serviceByServiceName.Humidity == null
+      this.historyService = new History.Weather(this, {
+        temperatureDelegate: this.service.characteristicDelegate('temperature'),
+        humidityDelegate: this.serviceByServiceName.Humidity == null
           ? null
           : this.serviceByServiceName.Humidity.characteristicDelegate('humidity'),
-        this.serviceByServiceName.AirPressure == null
+        airPressureDelegate: 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
+      this.historyService = new History.Room(this, {
+        temperatureDelegate: this.service.characteristicDelegate('temperature'),
+        humidityDelegate: this.serviceByServiceName.Humidity == null
           ? null
           : this.serviceByServiceName.Humidity.characteristicDelegate('humidity'),
-        this.serviceByServiceName.AirQuality.characteristicDelegate('vocDensity')
-      )
+        airQualityDelegate: this.serviceByServiceName.AirQuality.characteristicDelegate('vocDensity')
+      })
     }
 
     this.createSettingsService()

package/lib/DeconzAccessory/Thermostat.js

@@ -30,12 +30,11 @@ class Thermostat extends DeconzAccessory {
     }
 
     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.historyService = new History.Thermo(this, {
+        temperatureDelegate: this.service.characteristicDelegate('currentTemperature'),
+        targetTemperatureDelegate: this.service.characteristicDelegate('targetTemperature'),
+        valvePositionDelegate: this.service.characteristicDelegate('valvePosition')
+      })
     }
 
     this.createSettingsService()

package/lib/DeconzAccessory/WarningDevice.js

@@ -5,10 +5,10 @@
 
 'use strict'
 
-const homebridgeLib = require('homebridge-lib')
+// const homebridgeLib = require('homebridge-lib')
 const DeconzAccessory = require('../DeconzAccessory')
 
-const { History } = homebridgeLib.ServiceDelegate
+// const { History } = homebridgeLib.ServiceDelegate
 
 /** Delegate class for a HomeKit accessory, corresponding to a light device
   * or groups resource.
@@ -35,14 +35,11 @@ class WarningDevice extends DeconzAccessory {
       this.createService(resource)
     }
 
-    if (this.serviceByServiceName.Temperature != null) {
-      this.historyService = new History.Weather(
-        this, {},
-        this.serviceByServiceName.Temperature.characteristicDelegate('temperature'),
-        null,
-        null
-      )
-    }
+    // if (this.serviceByServiceName.Temperature != null) {
+    //   this.historyService = new History.Weather(this, {
+    //     temperatureDelegate: this.serviceByServiceName.Temperature.characteristicDelegate('temperature')
+    //   })
+    // }
 
     this.createSettingsService()
 

package/lib/DeconzService/AirPressure.js

@@ -27,6 +27,12 @@ class AirPressure extends DeconzService.SensorsResource {
       value: 0
     })
 
+    // this.addCharacteristicDelegate({
+    //   key: 'trend',
+    //   Characteristic: this.Characteristics.eve.WeatherTrend,
+    //   value: 0
+    // })
+
     this.addCharacteristicDelegates()
 
     this.update(resource.body)
@@ -36,6 +42,7 @@ class AirPressure extends DeconzService.SensorsResource {
     if (state.pressure != null) {
       this.values.airPressure = Math.round(state.pressure * 10) / 10
     }
+    // this.values.trend = Math.round(new Date().valueOf() / 60000) % 16
     super.updateState(state)
   }
 }

package/lib/DeconzService/Battery.js

@@ -16,7 +16,8 @@ const homebridgeLib = require('homebridge-lib')
 class Battery extends homebridgeLib.ServiceDelegate.Battery {
   constructor (accessory, resource, params = {}) {
     super(accessory, {
-      name: accessory.name + ' Battery'
+      name: accessory.name + ' Battery',
+      exposeConfiguredName: true
     })
   }
 

package/lib/DeconzService/DeviceSettings.js

@@ -6,6 +6,7 @@
 'use strict'
 
 const homebridgeLib = require('homebridge-lib')
+const DeconzAccessory = require('../DeconzAccessory')
 
 /** Delegate class for a DeconzDevice service.
   * @extends ServiceDelegate
@@ -14,6 +15,7 @@ const homebridgeLib = require('homebridge-lib')
 class DeviceSettings extends homebridgeLib.ServiceDelegate {
   constructor (accessory, params = {}) {
     params.Service = accessory.Services.my.DeconzDevice
+    params.exposeConfiguredName = true
     super(accessory, params)
 
     this.debug('settings: %j', params)
@@ -27,7 +29,7 @@ class DeviceSettings extends homebridgeLib.ServiceDelegate {
       accessory.gateway.exposeDevice(params.subtype, value)
     })
 
-    if (params.hasRepeat != null) {
+    if (params.hasRepeat) {
       this.addCharacteristicDelegate({
         key: 'repeat',
         Characteristic: this.Characteristics.my.Repeat,
@@ -50,6 +52,13 @@ class DeviceSettings extends homebridgeLib.ServiceDelegate {
       value: params.resource,
       silent: true
     })
+
+    if (!(accessory instanceof DeconzAccessory.Gateway)) {
+      accessory.propertyDelegate('name')
+        .on('didSet', (name) => {
+          this.values.configuredName = name + ' Settings'
+        })
+    }
   }
 }
 

package/lib/DeconzService/GatewaySettings.js

@@ -14,6 +14,7 @@ const homebridgeLib = require('homebridge-lib')
 class GatewaySettings extends homebridgeLib.ServiceDelegate {
   constructor (gateway, params = {}) {
     params.Service = gateway.Services.my.DeconzGateway
+    params.exposeConfiguredName = true
     super(gateway, params)
     this.gateway = gateway
 

package/lib/DeconzService/Light.js

@@ -243,7 +243,7 @@ class Light extends DeconzService.LightsResource {
     }
 
     if (this.capabilities.effects != null) {
-      this.effectServices = []
+      this.effectServices = {}
       this.addCharacteristicDelegate({
         key: 'effect',
         value: -1,
@@ -253,12 +253,13 @@ class Light extends DeconzService.LightsResource {
           this.effectServices[i].values.on = value === i
         }
       })
-      for (const i in this.capabilities.effects) {
-        const effect = this.capabilities.effects[i]
+      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.Switch,
-          subtype: this.subtype + '-E' + i
+          Service: this.Services.hap.Lightbulb,
+          subtype: this.subtype + '-E' + id,
+          exposeConfiguredName: true
         })
         service.addCharacteristicDelegate({
           key: 'on',
@@ -266,14 +267,27 @@ class Light extends DeconzService.LightsResource {
         }).on('didSet', (value, fromHomeKit) => {
           if (fromHomeKit) {
             this.checkAdaptiveLighting()
-            this.values.effect = value ? i : -1
+            this.values.effect = value ? id : -1
             const newEffect = value
               ? effect.toLowerCase()
               : 'none'
             this.put({ effect: newEffect })
           }
         })
-        this.effectServices.push(service)
+        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.capabilities.effectSpeed) {
       //   this.addCharacteristicDelegate({
@@ -399,8 +413,9 @@ class Light extends DeconzService.LightsResource {
       if (this.sceneServices[scene.id] == null) {
         const service = new homebridgeLib.ServiceDelegate(this.accessoryDelegate, {
           name: this.resource.body.name + ' ' + scene.name,
-          Service: this.Services.hap.Switch,
-          subtype: this.subtype + '-S' + scene.id
+          Service: this.Services.hap.Lightbulb,
+          subtype: this.subtype + '-S' + scene.id,
+          exposeConfiguredName: true
         })
         service.addCharacteristicDelegate({
           key: 'on',
@@ -418,8 +433,15 @@ class Light extends DeconzService.LightsResource {
             service.values.on = false
           }
         })
+        service.addCharacteristicDelegate({
+          key: 'index',
+          Characteristic: this.Characteristics.hap.ServiceLabelIndex,
+          value: Number(scene.id) + 1
+        })
         this.sceneServices[scene.id] = service
       }
+      this.sceneServices[scene.id].values.configuredName =
+        this.resource.body.name + ' ' + scene.name
     }
     for (const id in this.scenesServices) {
       if (sceneById[id] == null) {

package/lib/DeconzService/LightsResource.js

@@ -15,7 +15,7 @@ const { timeout } = homebridgeLib
 class LightsResource extends DeconzService {
   constructor (accessory, resource, params) {
     super(accessory, resource, params)
-    this.rpath += resource.rtype === 'groups' ? '/action' : '/state'
+    this.rpathState = this.rpath + (resource.rtype === 'groups' ? '/action' : '/state')
 
     this.updating = 0
     this.targetState = {}
@@ -23,16 +23,18 @@ class LightsResource extends DeconzService {
   }
 
   addCharacteristicDelegates (params = {}) {
-    this.addCharacteristicDelegate({
-      key: 'lastSeen',
-      Characteristic: this.Characteristics.my.LastSeen,
-      silent: true
-    })
+    if (this.resource.rtype !== 'groups') {
+      this.addCharacteristicDelegate({
+        key: 'lastSeen',
+        Characteristic: this.Characteristics.my.LastSeen,
+        silent: true
+      })
 
-    this.addCharacteristicDelegate({
-      key: 'statusFault',
-      Characteristic: this.Characteristics.hap.StatusFault
-    })
+      this.addCharacteristicDelegate({
+        key: 'statusFault',
+        Characteristic: this.Characteristics.hap.StatusFault
+      })
+    }
   }
 
   updateState (state) {
@@ -43,24 +45,28 @@ class LightsResource extends DeconzService {
     }
   }
 
+  updateConfig (config) {
+  }
+
   async identify () {
     if (this.capabilities.alert) {
       if (this.capabilities.breathe) {
-        await this.client.put(this.rpath, { alert: 'breathe' })
-        await timeout(1500)
-        await this.client.put(this.rpath, { alert: 'stop' })
+        await this.put({ alert: 'breathe' })
+        await timeout(1000)
+        await this.put({ alert: 'stop' })
+      } else {
+        await this.put({ alert: 'select' })
       }
-      await this.put(this.rpath, { alert: 'select' })
     }
   }
 
   // Collect changes into a combined request.
-  put (state) {
+  async put (state) {
     for (const key in state) {
       this.resource.body.state[key] = state[key]
       this.targetState[key] = state[key]
     }
-    this._put()
+    return this._put()
   }
 
   // Send the request (for the combined changes) to the gateway.
@@ -96,8 +102,8 @@ class LightsResource extends DeconzService {
           targetState.transitiontime = 0
         }
       }
-      this.debug('PUT %s %j', this.rpath, targetState)
-      await this.client.put(this.rpath, targetState)
+      this.debug('PUT %s %j', this.rpathState, targetState)
+      await this.client.put(this.rpathState, targetState)
       this.recentlyUpdated = true
       await timeout(500)
       this.recentlyUpdated = false

package/lib/DeconzService/index.js

@@ -50,7 +50,8 @@ class DeconzService extends homebridgeLib.ServiceDelegate {
       name: resource.body.name,
       Service: params.Service,
       subtype: resource.subtype,
-      primaryService: params.primaryService
+      primaryService: params.primaryService,
+      exposeConfiguredName: true
     })
     this.id = resource.id
     this.gateway = accessory.gateway
@@ -62,6 +63,14 @@ class DeconzService extends homebridgeLib.ServiceDelegate {
     this.capabilities = resource.capabilities
 
     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 })
+        }
+      })
   }
 
   addResource (resource) {
@@ -80,6 +89,9 @@ class DeconzService extends homebridgeLib.ServiceDelegate {
       }
       return
     }
+    if (body.name != null) {
+      this.values.configuredName = body.name
+    }
     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.25",
+  "version": "0.0.27",
   "keywords": [
     "homebridge-plugin",
     "homekit",
@@ -22,11 +22,11 @@
   "engines": {
     "deCONZ": "2.19.1",
     "homebridge": "^1.5.1",
-    "node": "^18.12.0"
+    "node": "^18.12.1"
   },
   "dependencies": {
-    "homebridge-lib": "~5.7.1",
-    "ws": "^8.10.0",
+    "homebridge-lib": "~6.0.1",
+    "ws": "^8.11.0",
     "xml2js": "~0.4.23"
   },
   "scripts": {