homebridge-deconz 1.0.13 → 1.0.17

package/lib/Deconz/Device.js

@@ -61,6 +61,11 @@ class Device {
       * @type {boolean}
       */
     this.zigbee = resource.zigbee
+
+    /** Device has a resource with `config.battery` in their `body`.
+      * @type {boolean}
+      */
+    this.hasBattery = resource.body.config?.battery !== undefined
   }
 
   /** The delegate of the primary resource of the device.
@@ -105,6 +110,9 @@ class Device {
       this.subtypesByServiceName[resource.serviceName].push(resource.subtype)
     }
     this.resourceBySubtype[subtype] = resource
+    if (resource.body.config?.battery !== undefined) {
+      this.hasBattery = true
+    }
     const p = this.resourceBySubtype[this.primary]
     if (p.rtype === rtype && p.prio < prio) {
       this.primary = resource.subtype

package/lib/Deconz/Resource.js

@@ -112,6 +112,9 @@ class Resource {
       */
     this.body = toObject('body', body)
     toString('body.name', body.name, true)
+    body.name = body.name.replace(/[^\p{L}\p{N} ']/ug, ' ')
+      .replace(/^[ ']*/, '')
+      .replace(/[ ']*$/, '')
     toString('body.type', body.type, true)
 
     let realDevice = false
@@ -132,6 +135,9 @@ class Resource {
         * @type {string}
         */
       this.id = mac
+      if (gateway.splitdevice[this.rtype]?.[this.rid]) {
+        this.id += '-' + endpoint
+      }
 
       /** The subtype of the corresponding HomeKit service.
         *
@@ -302,6 +308,7 @@ class Resource {
         case 'Consumption': return 'Consumption'
         // case 'DoorLock': return null
         case 'Daylight': return 'Daylight'
+        case 'DaylightOffset': return ''
         case 'Fire': return 'Smoke'
         case 'GenericFlag': return 'Flag'
         case 'GenericStatus': return 'Status'
@@ -536,7 +543,7 @@ class Resource {
             buttons.push([2, 'Close', SINGLE | LONG])
             break
           case 'TRADFRI remote control':
-            buttons.push([1, 'On/Off', SINGLE])
+            buttons.push([1, 'Power', SINGLE])
             buttons.push([2, 'Dim Up', SINGLE | LONG])
             buttons.push([3, 'Dim Down', SINGLE | LONG])
             buttons.push([4, 'Previous', SINGLE | LONG])
@@ -580,7 +587,7 @@ class Resource {
       case 'LDS':
         switch (this.model) {
           case 'ZBT-DIMController-D0800':
-            buttons.push([1, 'On/Off', SINGLE])
+            buttons.push([1, 'Power', SINGLE])
             buttons.push([2, 'Dim Up', SINGLE | LONG])
             buttons.push([3, 'Dim Down', SINGLE | LONG])
             buttons.push([4, 'Scene', SINGLE | LONG])
@@ -719,7 +726,7 @@ class Resource {
       case 'MLI':
         switch (this.model) {
           case 'ZBT-Remote-ALL-RGBW': // Tint remote control by Müller-Licht see deconz-rest-plugin#1209
-            buttons.push([1, 'On/Off', SINGLE])
+            buttons.push([1, 'Power', SINGLE])
             buttons.push([2, 'Dim Up', SINGLE | LONG])
             buttons.push([3, 'Dim Down', SINGLE | LONG])
             buttons.push([4, 'Warm', SINGLE])
@@ -802,7 +809,7 @@ class Resource {
             buttons.push([4, 'Off', SINGLE | LONG])
             break
           case 'RWL022': // Hue dimmer switch (2021)
-            buttons.push([1, 'On/Off', SINGLE | LONG])
+            buttons.push([1, 'Power', SINGLE | LONG])
             buttons.push([2, 'Dim Up', SINGLE | LONG, true])
             buttons.push([3, 'Dim Down', SINGLE | LONG, true])
             buttons.push([4, 'Hue', SINGLE | LONG])
@@ -1055,7 +1062,7 @@ class Resource {
         switch (this.model) {
           case 'RC 110':
             if (this.endpoint === '01') {
-              buttons.push([1, 'On/Off', SINGLE])
+              buttons.push([1, 'Power', SINGLE])
               buttons.push([2, 'Dim Up', SINGLE | LONG])
               buttons.push([3, 'Dim Down', SINGLE | LONG])
               buttons.push([4, '1', SINGLE])
@@ -1066,7 +1073,7 @@ class Resource {
               buttons.push([9, '6', SINGLE])
               for (let i = 1; i <= 6; i++) {
                 const button = 7 + i * 3
-                buttons.push([button, `On/Off ${i}`, SINGLE])
+                buttons.push([button, `Power ${i}`, SINGLE])
                 buttons.push([button + 1, `Dim Up ${i}`, SINGLE | LONG])
                 buttons.push([button + 2, `Dim Down ${i}`, SINGLE | LONG])
               }

package/lib/DeconzAccessory/Gateway.js

@@ -16,14 +16,10 @@ import '../Deconz/Resource.js'
 import '../Deconz/Device.js'
 
 import { DeconzAccessory } from '../DeconzAccessory/index.js'
-import '../DeconzAccessory/AirPurifier.js'
-import '../DeconzAccessory/Light.js'
-import '../DeconzAccessory/Sensor.js'
-import '../DeconzAccessory/Thermostat.js'
-import '../DeconzAccessory/WarningDevice.js'
-import '../DeconzAccessory/WindowCovering.js'
 
 import { DeconzService } from '../DeconzService/index.js'
+import '../DeconzService/Button.js'
+import '../DeconzService/Gateway.js'
 
 const { HttpError } = ApiClient
 
@@ -153,7 +149,7 @@ class Gateway extends AccessoryDelegate {
 
     this.addPropertyDelegate({
       key: 'periodicEvents',
-      value: true,
+      value: false,
       silent: true
     })
 
@@ -571,7 +567,6 @@ class Gateway extends AccessoryDelegate {
       this.exposeErrors = {}
       this.context.settingsById = {}
       this.context.fullState = null
-      this.values.logLevel = 2
     } catch (error) { this.error(error) }
   }
 
@@ -615,11 +610,47 @@ class Gateway extends AccessoryDelegate {
     this.pollNext = true
   }
 
+  /** On-demand import of a DeconzAccessory subclass.
+    * @params {string} type - The name of the class.
+    */
+  async importAccessoryType (type) {
+    switch (type) {
+      case 'AirPurifier':
+      case 'Light':
+      case 'Sensor':
+      case 'Thermostat':
+      case 'WarningDevice':
+      case 'WindowCovering':
+        break
+      case 'Outlet':
+      case 'Switch':
+        type = 'Light'
+        break
+      default:
+        type = 'Sensor'
+        break
+    }
+    if (DeconzAccessory[type] == null) {
+      this.vdebug('importing DeconzAccessory.%s', type)
+      await import('../DeconzAccessory/' + type + '.js')
+    }
+  }
+
+  /** On-demand import of a a DeconzService subclass.
+    * @params {string} type - The name of the class.
+    */
+  async importServiceType (type) {
+    if (DeconzService[type] == null) {
+      this.vdebug('importing DeconzService.%s', type)
+      await import('../DeconzService/' + type + '.js')
+    }
+  }
+
   /** Add the accessory for the device.
     * @params {string} id - The device ID.
     * @return {?DeconzAccessory} - The accessory delegate.
     */
-  addAccessory (id) {
+  async addAccessory (id) {
     if (id === this.id) {
       throw new RangeError(`${id}: gateway ID`)
     }
@@ -632,10 +663,17 @@ class Gateway extends AccessoryDelegate {
       const { body } = device.resource
       this.log('%s: add accessory', body.name)
       let { serviceName } = device.resource
+      await this.importAccessoryType(serviceName)
       if (DeconzAccessory[serviceName] == null) {
         // this.warn('%s: %s: not yet supported %s type', body.name, body.type, rtype)
         serviceName = 'Sensor'
       }
+      for (const resourceServiceName of Object.keys(device.subtypesByServiceName)) {
+        await this.importServiceType(resourceServiceName)
+      }
+      if (device.hasBattery) {
+        await this.importServiceType('Battery')
+      }
       const accessory = new DeconzAccessory[serviceName](this, device)
       this.accessoryById[id] = accessory
       this.monitorResources(accessory, true)
@@ -969,6 +1007,7 @@ class Gateway extends AccessoryDelegate {
         this.context.fullState.config = config
         this.context.fullState.lights = await this.client.get('/lights')
         this.context.fullState.sensors = await this.client.get('/sensors')
+        this.context.fullState.resourcelinks = await this.client.get('/resourcelinks')
         if (this.nDevicesByRtype.groups > 0) {
           this.context.fullState.groups = await this.client.get('/groups')
           this.context.fullState.groups[0] = await this.client.get('/groups/0')
@@ -992,6 +1031,54 @@ class Gateway extends AccessoryDelegate {
     }
   }
 
+  /* Analyse blacklist resourcelinks.
+   */
+  analyseResourcelinks (logUnsupported = false) {
+    const warn = (logUnsupported ? this.warn : this.vdebug).bind(this)
+    /** Blacklisted resources.
+      *
+      * Updated by
+      * {@link DeconzAccessory.Gateway#analyseBlacklist analyseBlacklist()}.
+      * @type {Object<string, boolean>}
+      */
+    this.blacklist = {
+      lights: {},
+      sensors: {}
+    }
+    this.splitdevice = {
+      lights: {},
+      sensors: {}
+    }
+    for (const key in this.context.fullState.resourcelinks) {
+      const link = this.context.fullState.resourcelinks[key]
+      if (
+        link.name === 'homebridge-deconz' && link.links != null &&
+        link.description != null
+      ) {
+        const type = link.description.toLowerCase()
+        switch (type) {
+          case 'migration':
+            break
+          case 'splitdevice':
+          case 'blacklist':
+            this.debug('/resourcelinks/%d: %d %s entries', key, link.links.length, type)
+            for (const resource of link.links) {
+              const rtype = resource.split('/')[1]
+              const rid = resource.split('/')[2]
+              if (this[type][rtype] == null) {
+                warn('/resourcelinks/%d: %s: ignoring unsupported %s resource', key, resource, type)
+                continue
+              }
+              this[type][rtype][rid] = true
+            }
+            break
+          default:
+            warn('/resourcelinks/%d: %s: ignoring unsupported resourcelink', key, type)
+        }
+      }
+    }
+  }
+
   /** Analyse the peristed full state of the gateway,
     * adding, re-configuring, and deleting delegates for corresponding HomeKit
     * accessories and services.
@@ -1056,6 +1143,7 @@ class Gateway extends AccessoryDelegate {
     this.nDevicesByRtype = {}
 
     this.vdebug('analysing resources...')
+    this.analyseResourcelinks(params.logUnsupported)
     for (const rtype of rtypes) {
       this.deviceByRidByRtype[rtype] = {}
       for (const rid in fullState[rtype]) {
@@ -1213,10 +1301,16 @@ class Gateway extends AccessoryDelegate {
     * unsupported resources.
     */
   analyseResource (rtype, rid, body, logUnsupported) {
+    const warn = (logUnsupported ? this.warn : this.vdebug).bind(this)
+    const debug = (logUnsupported ? this.debug : this.vdebug).bind(this)
+
     const resource = new Deconz.Resource(this, rtype, rid, body)
     const { id, serviceName } = resource
+    if (this.blacklist[rtype]?.[rid]) {
+      debug('%s: /%s/%d: ignoring blacklisted resource', id, rtype, rid)
+      return
+    }
     if (id === this.id || serviceName === '') {
-      const debug = (logUnsupported ? this.debug : this.vdebug).bind(this)
       debug(
         '%s: /%s/%d: %s: ignoring unsupported %s type',
         id, rtype, rid, body.type, rtype
@@ -1224,7 +1318,6 @@ class Gateway extends AccessoryDelegate {
       return
     }
     if (serviceName == null) {
-      const warn = (logUnsupported ? this.warn : this.vdebug).bind(this)
       warn(
         '%s: /%s/%d: %s: ignoring unknown %s type',
         id, rtype, rid, body.type, rtype

package/lib/DeconzAccessory/index.js

@@ -9,35 +9,7 @@ import { OptionParser } from 'homebridge-lib/OptionParser'
 import { ApiClient } from 'hb-deconz-tools/ApiClient'
 
 import { DeconzService } from '../DeconzService/index.js'
-import '../DeconzService/AirPressure.js'
-import '../DeconzService/AirPurifier.js'
-import '../DeconzService/AirQuality.js'
-import '../DeconzService/Alarm.js'
-import '../DeconzService/Battery.js'
 import '../DeconzService/Button.js'
-import '../DeconzService/CarbonMonoxide.js'
-import '../DeconzService/Consumption.js'
-import '../DeconzService/Contact.js'
-import '../DeconzService/Daylight.js'
-import '../DeconzService/Flag.js'
-import '../DeconzService/Gateway.js'
-import '../DeconzService/Humidity.js'
-import '../DeconzService/Label.js'
-import '../DeconzService/Leak.js'
-import '../DeconzService/Light.js'
-import '../DeconzService/LightLevel.js'
-import '../DeconzService/Motion.js'
-import '../DeconzService/Outlet.js'
-import '../DeconzService/Power.js'
-import '../DeconzService/Schedule.js'
-import '../DeconzService/Status.js'
-import '../DeconzService/Smoke.js'
-import '../DeconzService/Switch.js'
-import '../DeconzService/Temperature.js'
-import '../DeconzService/Thermostat.js'
-import '../DeconzService/Valve.js'
-import '../DeconzService/WarningDevice.js'
-import '../DeconzService/WindowCovering.js'
 
 const { HttpError } = ApiClient
 const { SINGLE, DOUBLE, LONG } = DeconzService.Button
@@ -264,7 +236,6 @@ class DeconzAccessory extends AccessoryDelegate {
             lowBatteryThreshold: this.servicesByServiceName?.Battery?.[0].values.lowBatteryThreshold,
             // offset: this.servicesByServiceName?.Temperature?.[0].values.offset,
             serviceName: this.values.serviceName,
-            splitLight: undefined,
             venetianBlind: this.service.values.venetianBlind,
             useExternalTemperature: this.service.values.useExternalTemperature,
             wallSwitch: this.service.values.wallSwitch

package/lib/DeconzService/LightsResource.js

@@ -15,7 +15,6 @@ class LightsResource extends DeconzService {
 
     this.updating = 0
     this.targetState = {}
-    this.deferrals = []
   }
 
   addCharacteristicDelegates (params = {}) {

package/lib/DeconzService/Motion.js

@@ -23,6 +23,15 @@ class Motion extends DeconzService.SensorsResource {
       value: false
     })
 
+    if (resource.body.state.distance !== undefined) {
+      this.addCharacteristicDelegate({
+        key: 'distance',
+        Characteristic: this.Characteristics.my.Distance,
+        unit: ' cm',
+        value: 0
+      })
+    }
+
     this.addCharacteristicDelegate({
       key: 'sensitivity',
       Characteristic: this.Characteristics.eve.Sensitivity
@@ -50,6 +59,32 @@ class Motion extends DeconzService.SensorsResource {
       }
     })
 
+    if (resource.body.config.detectionrange !== undefined) {
+      this.addCharacteristicDelegate({
+        key: 'detectionRange',
+        Characteristic: this.Characteristics.my.DetectionRange,
+        unit: ' cm',
+        value: 600
+      }).on('didSet', async (value, fromHomeKit) => {
+        if (fromHomeKit) {
+          const detectionrange = Math.max(0, Math.min(value, 600))
+          await this.putConfig({ detectionrange })
+        }
+      })
+    }
+
+    if (resource.body.config.resetpresence !== undefined) {
+      this.addCharacteristicDelegate({
+        key: 'reset',
+        Characteristic: this.Characteristics.my.Reset,
+        value: false
+      }).on('didSet', async (value, fromHomeKit) => {
+        if (fromHomeKit) {
+          await this.put('/config', { resetpresence: value })
+        }
+      })
+    }
+
     this.addCharacteristicDelegates()
 
     this.update(resource.body, resource.rpath)
@@ -59,6 +94,9 @@ class Motion extends DeconzService.SensorsResource {
     if (state.presence != null) {
       this.values.motion = state.presence
     }
+    if (state.distance != null) {
+      this.values.distance = state.distance
+    }
     if (state.vibration != null) {
       this.values.motion = state.vibration
     }
@@ -83,6 +121,12 @@ class Motion extends DeconzService.SensorsResource {
           ? this.Characteristics.eve.Sensitivity.LOW
           : this.Characteristics.eve.Sensitivity.MEDIUM
     }
+    if (config.detectionrange != null) {
+      this.values.detectionRange = config.detectionrange
+    }
+    if (config.resetpresence != null) {
+      this.values.reset = config.resetpresence
+    }
     super.updateConfig(config)
   }
 }

package/lib/DeconzService/SensorsResource.js

@@ -3,6 +3,8 @@
 //
 // Homebridge plugin for deCONZ.
 
+import { timeout } from 'homebridge-lib'
+
 import { ApiClient } from 'hb-deconz-tools/ApiClient'
 
 import { DeconzService } from '../DeconzService/index.js'
@@ -13,9 +15,12 @@ const { dateToString } = ApiClient
   * @memberof DeconzService
   */
 class SensorsResource extends DeconzService {
-  // constructor (accessory, resource, params) {
-  //   super(accessory, resource, params)
-  // }
+  constructor (accessory, resource, params) {
+    super(accessory, resource, params)
+
+    this.updating = 0
+    this.targetConfig = {}
+  }
 
   addCharacteristicDelegates (params = {}) {
     if (!params.noLastUpdated) {
@@ -83,6 +88,34 @@ class SensorsResource extends DeconzService {
       return this.put('/config', { alert: 'select' })
     }
   }
+
+  // Collect config changes into a combined request.
+  async putConfig (config) {
+    for (const key in config) {
+      this.resource.body.config[key] = config[key]
+      this.targetConfig[key] = config[key]
+    }
+    return this._putConfig()
+  }
+
+  // Send the request (for the combined state changes) to the gateway.
+  async _putConfig () {
+    try {
+      if (this.platform.config.waitTimeUpdate > 0) {
+        this.updating++
+        await timeout(this.platform.config.waitTimeUpdate)
+        if (--this.updating > 0) {
+          return
+        }
+      }
+      const targetConfig = this.targetConfig
+      this.targetConfig = {}
+      await this.put('/config', targetConfig)
+      // this.recentlyUpdated = true
+      // await timeout(500)
+      // this.recentlyUpdated = false
+    } catch (error) { this.warn(error) }
+  }
 }
 
 DeconzService.SensorsResource = SensorsResource

package/package.json

@@ -7,7 +7,7 @@
     "ebaauw"
   ],
   "license": "Apache-2.0",
-  "version": "1.0.13",
+  "version": "1.0.17",
   "keywords": [
     "homebridge-plugin",
     "homekit",
@@ -26,13 +26,13 @@
     "ui": "cli/ui.js"
   },
   "engines": {
-    "deCONZ": "2.27.6",
+    "deCONZ": "2.28.1",
     "homebridge": "^1.8.4||^2.0.0-beta",
     "node": "^20||^18"
   },
   "dependencies": {
     "hb-deconz-tools": "~2.0.3",
-    "homebridge-lib": "~7.0.5"
+    "homebridge-lib": "~7.0.8"
   },
   "scripts": {
     "prepare": "standard && rm -rf out && jsdoc -c jsdoc.json",