homebridge-deconz 0.1.16 → 0.1.18

package/homebridge-ui/server.js

@@ -6,7 +6,7 @@
 'use strict'
 
 const { UiServer } = require('homebridge-lib')
-const Deconz = require('../lib/Deconz')
+const { Discovery } = require('hb-deconz-tools')
 
 class DeconzUiServer extends UiServer {
   constructor () {
@@ -14,7 +14,7 @@ class DeconzUiServer extends UiServer {
 
     this.onRequest('discover', async (params) => {
       if (this.discovery == null) {
-        this.discovery = new Deconz.Discovery({
+        this.discovery = new Discovery({
           // forceHttp: this.config.forceHttp,
           // timeout: this.config.timeout
         })

package/lib/Deconz/Resource.js

@@ -6,15 +6,21 @@
 'use strict'
 
 const { OptionParser } = require('homebridge-lib')
-const Deconz = require('../Deconz')
+const { ApiClient } = require('hb-deconz-tools')
 const DeconzAccessory = require('../DeconzAccessory')
 const DeconzService = require('../DeconzService')
 
 const { toInstance, toInt, toObject, toString } = OptionParser
-const { buttonEvent } = Deconz.ApiClient
+const { buttonEvent } = 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,14 +58,43 @@ 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.
     *
     * @param {DeconzAccessory.Gateway} gateway - The gateway.
@@ -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,16 +167,30 @@ class Resource {
         * @type {boolean}
         */
       this.zigbee = true
+
+      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 == null ? '' : '-' + cluster)
+        this.subtype = endpoint + '-' + cluster
         this.endpoint = endpoint
         this.cluster = cluster
+        realDevice = true
       } else {
-        this.subtype = rtype[0].toUpperCase() + rid
-        this.id = gateway.id + '-' + this.subtype
+        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 {
@@ -154,7 +206,7 @@ class Resource {
       * For virtual devices, this is the _Manufacturer_ for the gateway.
       * @type {string}
       */
-    this.manufacturer = this.endpoint != null
+    this.manufacturer = realDevice
       ? body.manufacturername.replace(/\//g, '')
       : gateway.values.manufacturer
 
@@ -165,7 +217,7 @@ class Resource {
       * For virtual devices, this is the `type` in the resource body.
       * @type {string}
       */
-    this.model = this.endpoint != null ? body.modelid : body.type
+    this.model = realDevice ? body.modelid : body.type
 
     /** The associated HomeKit _Firmware Version_.
       *
@@ -173,8 +225,8 @@ class Resource {
       * resource body.
       * For virtual devices, this is the _Firmware Version_ for the gateway.
       */
-    this.firmware = this.endpoint != null
-      ? 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
@@ -237,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 ''

package/lib/Deconz/index.js

@@ -9,13 +9,8 @@
   * @hideconstructor
   */
 class Deconz {
-  static get ApiClient () { return require('./ApiClient') }
-  static get ApiError () { return require('./ApiError') }
-  static get ApiResponse () { return require('./ApiResponse') }
   static get Device () { return require('./Device') }
-  static get Discovery () { return require('./Discovery') }
   static get Resource () { return require('./Resource') }
-  static get WsClient () { return require('./WsClient') }
 }
 
 module.exports = Deconz

package/lib/DeconzAccessory/Gateway.js

@@ -8,7 +8,7 @@
 const {
   AccessoryDelegate, HttpClient, OptionParser, timeout
 } = require('homebridge-lib')
-
+const { ApiClient, ApiError, WsClient } = require('hb-deconz-tools')
 const Deconz = require('../Deconz')
 const DeconzAccessory = require('../DeconzAccessory')
 const DeconzService = require('../DeconzService')
@@ -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) {
@@ -365,7 +381,7 @@ class Gateway extends AccessoryDelegate {
     /** REST API client for the gateway.
       * @type {DeconzClient}
       */
-    this.client = new Deconz.ApiClient({
+    this.client = new ApiClient({
       apiKey: this.values.apiKey,
       config: this.context.config,
       host: this.values.host,
@@ -421,7 +437,7 @@ class Gateway extends AccessoryDelegate {
     /** Client for gateway web socket notifications.
       * @type {DeconzWsClient}
       */
-    this.wsClient = new Deconz.WsClient({
+    this.wsClient = new WsClient({
       host: this.values.host.split(':')[0] + ':' + this.values.wsPort,
       retryTime: 15
     })
@@ -498,7 +514,7 @@ class Gateway extends AccessoryDelegate {
       this.pollFullState = true
     } catch (error) {
       if (
-        error instanceof Deconz.ApiError && error.type === 101 && retry < 8
+        error instanceof ApiError && error.type === 101 && retry < 8
       ) {
         this.log('unlock gateway to obtain API key - retrying in 15s')
         await timeout(15000)
@@ -772,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,
@@ -830,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')
@@ -846,6 +864,7 @@ class Gateway extends AccessoryDelegate {
             responseBody[key] = this.values[key]
             break
           case 'expose':
+          case 'exposeSchedules':
           case 'heartrate':
           case 'logLevel':
           case 'periodicEvents':
@@ -919,7 +938,7 @@ class Gateway extends AccessoryDelegate {
           await this.wsClient.close()
           return
         }
-        if (config.fwversion === '0x00000000') {
+        if (config.bridgeid === '0000000000000000' || config.fwversion === '0x00000000') {
           this.warn('deCONZ not ready')
           return
         }
@@ -930,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')
         }
       }
@@ -1114,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/index.js

@@ -6,10 +6,10 @@
 'use strict'
 
 const { AccessoryDelegate, OptionParser } = require('homebridge-lib')
-const Deconz = require('../Deconz')
+const { ApiClient } = require('hb-deconz-tools')
 const DeconzService = require('../DeconzService')
 
-const { HttpError } = Deconz.ApiClient
+const { HttpError } = ApiClient
 const { SINGLE, DOUBLE, LONG } = DeconzService.Button
 
 /** Abstract superclass for a delegate of a HomeKit accessory,
@@ -65,7 +65,7 @@ class DeconzAccessory extends AccessoryDelegate {
     this.device = device
 
     /** The API client instance for the gateway.
-      * @type {Deconz.ApiClient}
+      * @type {ApiClient}
       */
     this.client = gateway.client
 

package/lib/DeconzPlatform.js

@@ -7,7 +7,7 @@
 
 const events = require('events')
 const { HttpClient, OptionParser, Platform, timeout } = require('homebridge-lib')
-const Deconz = require('./Deconz')
+const { Discovery } = require('hb-deconz-tools')
 const DeconzAccessory = require('./DeconzAccessory')
 
 class DeconzPlatform extends Platform {
@@ -65,7 +65,7 @@ class DeconzPlatform extends Platform {
       if (this.config.host != null) {
         this.config.hosts.push(this.config.host)
       }
-      this.discovery = new Deconz.Discovery({
+      this.discovery = new Discovery({
         forceHttp: this.config.forceHttp,
         timeout: this.config.timeout
       })

package/lib/DeconzService/AirQuality.js

@@ -5,10 +5,10 @@
 
 'use strict'
 
-const Deconz = require('../Deconz')
+const { ApiClient } = require('hb-deconz-tools')
 const DeconzService = require('../DeconzService')
 
-const { dateToString } = Deconz.ApiClient
+const { dateToString } = ApiClient
 
 /**
   * @memberof DeconzService

package/lib/DeconzService/Battery.js

@@ -5,9 +5,9 @@
 
 'use strict'
 
-const Deconz = require('../Deconz')
+const { ApiClient } = require('hb-deconz-tools')
 const { ServiceDelegate } = require('homebridge-lib')
-const { dateToString } = Deconz.ApiClient
+const { dateToString } = ApiClient
 
 /**
   * @memberof DeconzService

package/lib/DeconzService/Consumption.js

@@ -5,10 +5,10 @@
 
 'use strict'
 
-const Deconz = require('../Deconz')
+const { ApiClient } = require('hb-deconz-tools')
 const DeconzService = require('../DeconzService')
 
-const { dateToString } = Deconz.ApiClient
+const { dateToString } = ApiClient
 
 /**
   * @memberof DeconzService

package/lib/DeconzService/Daylight.js

@@ -5,10 +5,10 @@
 
 'use strict'
 
+const { ApiClient } = require('hb-deconz-tools')
 const DeconzService = require('../DeconzService')
-const Deconz = require('../Deconz')
 
-const { dateToString } = Deconz.ApiClient
+const { dateToString } = ApiClient
 
 const daylightEvents = {
   100: { name: 'Solar Midnight', period: 'Night' },

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/LightLevel.js

@@ -5,10 +5,10 @@
 
 'use strict'
 
+const { ApiClient } = require('hb-deconz-tools')
 const DeconzService = require('../DeconzService')
-const Deconz = require('../Deconz')
 
-const { lightLevelToLux } = Deconz.ApiClient
+const { lightLevelToLux } = ApiClient
 
 /**
   * @memberof DeconzService

package/lib/DeconzService/LightsResource.js

@@ -6,10 +6,10 @@
 'use strict'
 
 const { timeout } = require('homebridge-lib')
-const Deconz = require('../Deconz')
+const { ApiClient } = require('hb-deconz-tools')
 const DeconzService = require('../DeconzService')
 
-const { HttpError } = Deconz.ApiClient
+const { HttpError } = ApiClient
 
 class LightsResource extends DeconzService {
   constructor (accessory, resource, params) {

package/lib/DeconzService/Power.js

@@ -5,10 +5,10 @@
 
 'use strict'
 
-const Deconz = require('../Deconz')
 const DeconzService = require('../DeconzService')
+const { ApiClient } = require('hb-deconz-tools')
 
-const { dateToString } = Deconz.ApiClient
+const { dateToString } = ApiClient
 
 /**
   * @memberof DeconzService

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 { ApiClient } = require('hb-deconz-tools')
+const { ServiceDelegate } = require('homebridge-lib')
+
+const { HttpError } = 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/SensorsResource.js

@@ -5,10 +5,10 @@
 
 'use strict'
 
-const Deconz = require('../Deconz')
+const { ApiClient } = require('hb-deconz-tools')
 const DeconzService = require('../DeconzService')
 
-const { dateToString, HttpError } = Deconz.ApiClient
+const { dateToString, HttpError } = ApiClient
 
 /**
   * @memberof DeconzService

package/lib/DeconzService/index.js

@@ -5,10 +5,10 @@
 
 'use strict'
 
+const { ApiClient } = require('hb-deconz-tools')
 const { ServiceDelegate } = require('homebridge-lib')
-const Deconz = require('../Deconz')
 
-const { dateToString } = Deconz.ApiClient
+const { dateToString } = ApiClient
 
 /** Service delegates.
   * @extends ServiceDelegate
@@ -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.16",
+  "version": "0.1.18",
   "keywords": [
     "homebridge-plugin",
     "homekit",
@@ -26,6 +26,7 @@
     "node": "^18.16.0"
   },
   "dependencies": {
+    "hb-deconz-tools": "~1.0.2",
     "homebridge-lib": "~6.3.17",
     "ws": "^8.13.0",
     "xml2js": "~0.5.0"