homebridge-deconz 0.1.15 → 0.1.17

package/lib/Deconz/Resource.js

@@ -15,6 +15,12 @@ const { buttonEvent } = Deconz.ApiClient
 const { SINGLE, DOUBLE, LONG } = DeconzService.Button
 const rtypes = ['lights', 'sensors', 'groups']
 
+const patterns = {
+  uniqueid: /^([0-9a-f]{1,2}(?:[:-]?(?:[0-9a-f]{1,2})){7})-([0-9a-z]{2})(?:-([0-9a-z]{4}))?$/i,
+  clipId: /^(S[0-9]{1,3})-([0-9a-z]{2})-([0-9a-z]{4})$/i,
+  swversion: /^([0-9]+)(?:\.([0-9]+)(?:\.([0-9]+)(?:_([0-9]{4}))?)?)?$/
+}
+
 // From low to high.
 const sensorsPrios = [
   'Power',
@@ -24,7 +30,8 @@ const sensorsPrios = [
   'Motion',
   'Contact',
   'AirPurifier',
-  'Thermostat'
+  'Thermostat',
+  'Flag'
 ]
 
 // =============================================================================
@@ -51,12 +58,41 @@ class Resource {
     */
   static parseUniqueid (uniqueid) {
     toString('uniqueid', uniqueid, true)
-    const a = uniqueid.replace(/:/g, '').toUpperCase().split('-')
+    const a = patterns.uniqueid.exec(uniqueid.replace(/:/g, '').toUpperCase())
+    return {
+      mac: a?.[1],
+      endpoint: a?.[2],
+      cluster: a?.[3]
+    }
+  }
+
+  /** Parse the `uniqueid` in the resource body of a resource for a CLIP sensor.
+    * @param {string} uniqueid - The `uniqueid`.
+    * @return {object} The MultiCLIP `id`, `endpoint`, and `cluster`.
+    */
+  static parseClipId (uniqueid) {
+    toString('uniqueid', uniqueid, true)
+    const a = patterns.clipId.exec(uniqueid.replace(/:/g, '').toUpperCase())
     return {
-      mac: a?.[0],
-      endpoint: a?.[1],
-      cluster: a?.[2]
+      id: a?.[1],
+      endpoint: a?.[2],
+      cluster: a?.[3]
+    }
+  }
+
+  /** Parse the `swversion` in the resource body of a resource for a Zigbee device.
+    * @param {string} swversion - The `swversion`.
+    * @return {string} The normalised version in semver format.
+    */
+  static parseSwversion (swversion) {
+    if (swversion == null) {
+      return '0.0.0'
+    }
+    const a = patterns.swversion.exec(swversion)
+    if (a?.[1] === '0' && a?.[2] === '0' && a?.[3] === '0' && a?.[4] != null) {
+      return '0.0.' + Number(a[4]).toString()
     }
+    return swversion
   }
 
   /** Create a new instance of a delegate of a resource.
@@ -90,6 +126,8 @@ class Resource {
     toString('body.name', body.name, true)
     toString('body.type', body.type, true)
 
+    let realDevice = false
+
     if (
       this.rtype === 'lights' ||
       (this.rtype === 'sensors' && this.body.type.startsWith('Z'))
@@ -129,10 +167,31 @@ class Resource {
         * @type {boolean}
         */
       this.zigbee = true
-    } else if (this.isMultiClip()) {
-      const a = body.uniqueid.split('-')
-      this.id = gateway.id + '-M' + a[0]
-      this.subtype = a[1]
+
+      realDevice = true
+    } else if (this.rtype === 'sensors') {
+      const { mac, endpoint, cluster } = Resource.parseUniqueid(body.uniqueid)
+      if (mac != null && endpoint != null && cluster != null) {
+        // uniqueid for proxy device has proper mac, endpoint, cluster
+        this.id = mac
+        this.subtype = endpoint + '-' + cluster
+        this.endpoint = endpoint
+        this.cluster = cluster
+        realDevice = true
+      } else {
+        const { id, endpoint, cluster } = Resource.parseClipId(body.uniqueid)
+        if (id != null && endpoint != null && cluster != null) {
+          // uniqueid for MultiCLIP has proper id, endpoint, cluster
+          this.id = gateway.id + '-' + id
+          this.subtype = endpoint + '-' + cluster
+          this.endpoint = endpoint
+          this.cluster = cluster
+        } else {
+          // ignore uniqueid for regular CLIP
+          this.subtype = rtype[0].toUpperCase() + rid
+          this.id = gateway.id + '-' + this.subtype
+        }
+      }
       this.zigbee = false
     } else {
       this.subtype = rtype[0].toUpperCase() + rid
@@ -147,8 +206,8 @@ class Resource {
       * For virtual devices, this is the _Manufacturer_ for the gateway.
       * @type {string}
       */
-    this.manufacturer = this.zigbee
-      ? body.manufacturername
+    this.manufacturer = realDevice
+      ? body.manufacturername.replace(/\//g, '')
       : gateway.values.manufacturer
 
     /** The associated HomeKit _Model_.
@@ -158,7 +217,7 @@ class Resource {
       * For virtual devices, this is the `type` in the resource body.
       * @type {string}
       */
-    this.model = this.zigbee ? body.modelid : body.type
+    this.model = realDevice ? body.modelid : body.type
 
     /** The associated HomeKit _Firmware Version_.
       *
@@ -166,8 +225,8 @@ class Resource {
       * resource body.
       * For virtual devices, this is the _Firmware Version_ for the gateway.
       */
-    this.firmware = this.zigbee
-      ? body.swversion == null ? '0.0.0' : body.swversion
+    this.firmware = realDevice
+      ? Resource.parseSwversion(body.swversion)
       : gateway.values.software
 
     /** The name of the {@link DeconzService} subclass of the delegate of the
@@ -195,7 +254,7 @@ class Resource {
     if (this.rtype === 'groups') {
       return -1
     }
-    if (this.rtype === 'lights' || this.isMultiClip()) {
+    if (this.rtype === 'lights') {
       return 0xFF - this.endpoint
     }
     return sensorsPrios.indexOf(this.serviceName)
@@ -230,6 +289,7 @@ class Resource {
         case 'On/Off light': return 'Light'
         case 'On/Off output': return 'Outlet'
         case 'On/Off plug-in unit': return 'Outlet'
+        case 'On/Off switch': return 'Switch'
         case 'Smart plug': return 'Outlet'
         case 'Configuration tool': return ''
         case 'Range extender': return ''
@@ -327,36 +387,20 @@ class Resource {
     }
   }
 
-  /** Check whether resource is a CLIP sensor for Homebridge deCONZ.
-    * For these, we use the following conventions:
-    * - Use `uniqueid` to indicate device ID and subtype;
-    * - Use `swversion` to indicate readonly and range for `Flag` and `Status`.
-    */
-  isDeconzClip () {
-    return this.rtype === 'sensors' &&
-    this.body.type.startsWith('CLIP') &&
-    this.body.modelid === this.body.type && (
-      this.body.manufacturername === 'homebridge-deconz' ||
-      this.body.manufacturername === 'homebridge-hue'
-    )
-  }
-
-  isMultiClip () {
-    return this.isDeconzClip() && /^[0-9]+-[0-9]+$/.test(this.body.uniqueid)
-  }
-
   /** Patch a resource corresponding to a `Flag` service.
     */
   patchFlag () {
-    if (this.isDeconzClip() && this.body.swversion === '0') {
-      this.capabilities.readonly = true
+    if (this.endpoint != null && this.cluster === '0006') {
+      if (this.body.swversion === '0') {
+        this.capabilities.readonly = true
+      }
     }
   }
 
   /** Patch a resource corresponding to a `Status` service.
     */
   patchStatus () {
-    if (this.isDeconzClip()) {
+    if (this.endpoint != null && this.cluster === '0012') {
       const a = this.body.swversion.split(',')
       const min = parseInt(a[0])
       const max = parseInt(a[1])
@@ -1059,11 +1103,13 @@ class Resource {
     }
   }
 
-  /** Patch a resource corresponding to a `Temperature` service.
+  /** Patch a resource corresponding to a `Motion` service.
     */
-  patchTemperature () {
-    if (this.manufacturer === 'Develco Products A/S' && this.model === 'SMSZB-120') {
-      this.id += '-T'
+  patchMotion () {
+    if (this.manufacturer === 'Aqara' && this.model === 'PS-S02D') {
+      if (this.endpoint !== '01') {
+        this.id += '-' + this.endpoint
+      }
     }
   }
 

package/lib/DeconzAccessory/Gateway.js

@@ -103,6 +103,14 @@ class Gateway extends AccessoryDelegate {
       } catch (error) { this.error(error) }
     })
 
+    this.addPropertyDelegate({
+      key: 'exposeSchedules',
+      value: false,
+      silent: true
+    }).on('didSet', async (value) => {
+      this.pollNext = true
+    })
+
     this.addPropertyDelegate({
       key: 'heartrate',
       value: 30,
@@ -149,6 +157,7 @@ class Gateway extends AccessoryDelegate {
       value: false,
       silent: true
     }).on('didSet', async (value) => {
+      this.service.values.search = value
       if (value) {
         try {
           await this.client.search()
@@ -229,6 +238,11 @@ class Gateway extends AccessoryDelegate {
         DeconzService.Button.LONG
     })
 
+    /** The service delegates for the Schedule services.
+      * @type {Object<string, DeconzService.Schedule>}
+      */
+    this.scheduleServicesByRid = {}
+
     this.createClient()
     this.createWsClient()
     this.heartbeatEnabled = true
@@ -342,7 +356,9 @@ class Gateway extends AccessoryDelegate {
 
   update (config) {
     this.values.software = config.swversion
-    this.values.firmware = config.fwversion
+    this.values.firmware = parseInt(config.fwversion.slice(6, 8)) + '.' +
+      parseInt(config.fwversion.slice(2, 4), 16) + '.' +
+      parseInt(config.fwversion.slice(4, 6), 16)
     this.values.wsPort = config.websocketport
     this.service.update(config)
     if (this.checkApiKeys) {
@@ -637,7 +653,6 @@ class Gateway extends AccessoryDelegate {
             '%s: resetting after expose error: %s', id, this.exposeErrorById[id]
           )
           this.deleteAccessory(id)
-          this.deleteService(id)
         }
       }
     }
@@ -672,7 +687,6 @@ class Gateway extends AccessoryDelegate {
       '%s: resetting after expose error: %s', id, this.exposeErrorById[id]
     )
     this.deleteAccessory(id)
-    this.deleteService(id)
   }
 
   /** Assert that migration resourcelink exists and is valid.
@@ -774,6 +788,7 @@ class Gateway extends AccessoryDelegate {
           : {
               brightnessAdjustment: this.values.brightnessAdjustment * 100,
               expose: this.values.expose,
+              exposeSchedules: this.values.exposeSchedules,
               heartrate: this.values.heartrate,
               logLevel: this.values.logLevel,
               periodicEvents: this.values.periodicEvents,
@@ -832,6 +847,7 @@ class Gateway extends AccessoryDelegate {
       if (this.values.apiKey != null) {
         optionParser
           .intKey('brightnessAdjustment', 10, 100)
+          .boolKey('exposeSchedules')
           .intKey('heartrate', 1, 60)
           .boolKey('periodicEvents')
           .boolKey('restart')
@@ -848,6 +864,7 @@ class Gateway extends AccessoryDelegate {
             responseBody[key] = this.values[key]
             break
           case 'expose':
+          case 'exposeSchedules':
           case 'heartrate':
           case 'logLevel':
           case 'periodicEvents':
@@ -921,6 +938,10 @@ class Gateway extends AccessoryDelegate {
           await this.wsClient.close()
           return
         }
+        if (config.bridgeid === '0000000000000000' || config.fwversion === '0x00000000') {
+          this.warn('deCONZ not ready')
+          return
+        }
         this.context.fullState.config = config
         this.context.fullState.lights = await this.client.get('/lights')
         this.context.fullState.sensors = await this.client.get('/sensors')
@@ -928,7 +949,7 @@ class Gateway extends AccessoryDelegate {
           this.context.fullState.groups = await this.client.get('/groups')
           this.context.fullState.groups[0] = await this.client.get('/groups/0')
         }
-        if (this.nDevicesByRtype.schedules) {
+        if (this.values.exposeSchedules) {
           this.context.fullState.schedules = await this.client.get('/schedules')
         }
       }
@@ -964,16 +985,10 @@ class Gateway extends AccessoryDelegate {
     * {@link DeconzAccessory.Gateway#deleteAccessory deleteAccessory()} for
     * stale accessories, corresponding to devices that have been deleted from
     * the gateway, blacklisted, or excluded by device primary resource type.
-    * 3. Analyse (pre-existing) _Device Settings_ services, calling
-    * {@link DeconzAccessory.Gateway#deleteService deleteService()}
-    * for stale services, corresponding to devices that have been deleted from
-    * the gateway, un-blacklisted, or excluded by device primary resource type.
-    * 4. Analysing supported devices with enabled device primary resource types,
-    * calling {@link DeconzAccessory.Gateway#addAccessory addAccessory()} and
-    * {@link DeconzAccessory.Gateway#deleteService deleteService()} for new
+    * 3. Analysing supported devices with enabled device primary resource types,
+    * calling {@link DeconzAccessory.Gateway#addAccessory addAccessory()} for new
     * _Device_ accessories, corresponding to devices added to the gateway,
     * un-blacklisted, or included by device primary resource type, and calling
-    * {@link DeconzAccessory.Gateway#addService addService()} and
     * {@link DeconzAccessory.Gateway#deleteAccessory deleteAccessory()} for
     * accessories, corresponding to devices have been blacklisted.
     * @param {Object} fullState - The gateway full state, as returned by
@@ -1072,7 +1087,6 @@ class Gateway extends AccessoryDelegate {
         ) {
           delete this.context.settingsById[id]
           this.deleteAccessory(id)
-          // this.deleteService(id)
           changed = true
         } else {
           /** Emitted when the gateway has been polled.
@@ -1119,6 +1133,24 @@ class Gateway extends AccessoryDelegate {
       )
     }
 
+    this.vdebug('analysing schedules...')
+    if (this.values.exposeSchedules) {
+      for (const rid in fullState.schedules) {
+        if (this.scheduleServicesByRid[rid] == null) {
+          this.scheduleServicesByRid[rid] = new DeconzService.Schedule(
+            this, rid, fullState.schedules[rid]
+          )
+        }
+        this.scheduleServicesByRid[rid].update(fullState.schedules[rid])
+      }
+    }
+    for (const rid in this.scheduleServicesByRid) {
+      if (!this.values.exposeSchedules || fullState.schedules[rid] == null) {
+        this.scheduleServicesByRid[rid].destroy()
+        delete this.scheduleServicesByRid[rid]
+      }
+    }
+
     if (changed) {
       await this.updateMigration()
       this.identify()

package/lib/DeconzAccessory/WarningDevice.js

@@ -5,6 +5,7 @@
 
 'use strict'
 
+const { ServiceDelegate } = require('homebridge-lib')
 const DeconzAccessory = require('../DeconzAccessory')
 
 /** Delegate class for a HomeKit accessory, corresponding to a light device
@@ -32,6 +33,23 @@ class WarningDevice extends DeconzAccessory {
       this.createService(resource)
     }
 
+    const params = {}
+    if (this.servicesByServiceName.WarningDevice?.length === 1) {
+      params.switchOnDelegate = this.service.characteristicDelegate('on')
+      params.lastSwitchOnDelegate = this.service.addCharacteristicDelegate({
+        key: 'lastActivation',
+        Characteristic: this.Characteristics.eve.LastActivation,
+        silent: true
+      })
+    }
+    if (this.servicesByServiceName.Temperature?.length === 1) {
+      const service = this.servicesByServiceName.Temperature[0]
+      params.temperatureDelegate = service.characteristicDelegate('temperature')
+    }
+    if (Object.keys(params).length > 0) {
+      this.historyService = new ServiceDelegate.History(this, params)
+    }
+
     setImmediate(() => {
       this.debug('initialised')
       this.emit('initialised')

package/lib/DeconzService/Gateway.js

@@ -31,6 +31,16 @@ class Gateway extends ServiceDelegate {
       silent: true
     })
 
+    this.addCharacteristicDelegate({
+      key: 'search',
+      Characteristic: this.Characteristics.my.Search,
+      value: false
+    }).on('didSet', (value, fromHomeKit) => {
+      if (fromHomeKit) {
+        this.gateway.values.search = value
+      }
+    })
+
     this.addCharacteristicDelegate({
       key: 'transitionTime',
       Characteristic: this.Characteristics.my.TransitionTime,

package/lib/DeconzService/Schedule.js

@@ -0,0 +1,69 @@
+// homebridge-deconz/lib/DeconzService/Schedule.js
+// Copyright© 2022-2023 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const Deconz = require('../Deconz')
+const { ServiceDelegate } = require('homebridge-lib')
+
+const { HttpError } = Deconz.ApiClient
+
+/**
+  * @memberof DeconzService
+  */
+class Schedule extends ServiceDelegate {
+  constructor (accessory, rid, body) {
+    super(accessory, {
+      id: accessory.gateway.id + '-T' + rid,
+      name: body.name,
+      Service: accessory.Services.my.Resource,
+      subtype: 'T' + rid,
+      exposeConfiguredName: true
+    })
+    this.id = accessory.gateway.id + '-T' + rid
+    this.gateway = accessory.gateway
+    this.accessory = accessory
+    this.client = accessory.client
+    this.rtype = 'schedules'
+    this.rid = rid
+    this.rpath = '/' + this.rtype + '/' + this.rid
+
+    this.addCharacteristicDelegate({
+      key: 'enabled',
+      Characteristic: this.Characteristics.my.Enabled
+    }).on('didSet', async (value, fromHomeKit) => {
+      await this.put({ status: value ? 'enabled' : 'disabled' })
+      this.values.statusActive = value
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'statusActive',
+      Characteristic: this.Characteristics.hap.StatusActive
+    })
+
+    // this.addCharacteristicDelegate({
+    //   key: 'index',
+    //   Characteristic: this.Characteristics.hap.ServiceLabelIndex,
+    //   value: rid
+    // })
+  }
+
+  update (body) {
+    this.values.enabled = body.status === 'enabled'
+    this.values.statusActive = this.values.enabled
+  }
+
+  async put (body) {
+    try {
+      await this.client.put(this.rpath, body)
+    } catch (error) {
+      if (!(error instanceof HttpError)) {
+        this.warn(error)
+      }
+    }
+  }
+}
+
+module.exports = Schedule

package/lib/DeconzService/Smoke.js

@@ -16,10 +16,15 @@ class Smoke extends DeconzService.SensorsResource {
     super(accessory, resource, params)
 
     this.addCharacteristicDelegate({
-      key: 'fire',
+      key: 'smoke',
       Characteristic: this.Characteristics.hap.SmokeDetected
     })
 
+    this.addCharacteristicDelegate({
+      key: 'deviceStatus',
+      Characteristic: this.Characteristics.eve.ElgatoDeviceStatus
+    })
+
     super.addCharacteristicDelegates(params)
 
     this.update(resource.body, resource.rpath)
@@ -27,9 +32,17 @@ class Smoke extends DeconzService.SensorsResource {
 
   updateState (state) {
     if (state.fire != null || state.test != null) {
-      this.values.fire = state.fire || state.test
+      this.values.smoke = state.fire
         ? this.Characteristics.hap.SmokeDetected.SMOKE_DETECTED
         : this.Characteristics.hap.SmokeDetected.SMOKE_NOT_DETECTED
+      let status = 0
+      if (state.fire) {
+        status |= this.Characteristics.eve.ElgatoDeviceStatus.SMOKE_DETECTED
+      }
+      if (state.test) {
+        status |= this.Characteristics.eve.ElgatoDeviceStatus.ALARM_TEST_ACTIVE
+      }
+      this.values.deviceStatus = status
     }
     super.updateState(state)
   }

package/lib/DeconzService/WarningDevice.js

@@ -9,7 +9,7 @@ const DeconzService = require('../DeconzService')
 
 class WarningDevice extends DeconzService.LightsResource {
   constructor (accessory, resource, params = {}) {
-    params.Service = accessory.Services.hap.Outlet
+    params.Service = accessory.Services.hap.Switch
     super(accessory, resource, params)
 
     this.addCharacteristicDelegate({

package/lib/DeconzService/index.js

@@ -35,6 +35,7 @@ class DeconzService extends ServiceDelegate {
   static get Motion () { return require('./Motion') }
   static get Outlet () { return require('./Outlet') }
   static get Power () { return require('./Power') }
+  static get Schedule () { return require('./Schedule') }
   static get SensorsResource () { return require('./SensorsResource') }
   static get Status () { return require('./Status') }
   static get Smoke () { return require('./Smoke') }

package/package.json

@@ -4,7 +4,7 @@
   "displayName": "Homebridge deCONZ",
   "author": "Erik Baauw",
   "license": "Apache-2.0",
-  "version": "0.1.15",
+  "version": "0.1.17",
   "keywords": [
     "homebridge-plugin",
     "homekit",
@@ -26,7 +26,7 @@
     "node": "^18.16.0"
   },
   "dependencies": {
-    "homebridge-lib": "~6.3.16",
+    "homebridge-lib": "~6.3.17",
     "ws": "^8.13.0",
     "xml2js": "~0.5.0"
   },