homebridge-deconz 0.0.6 → 0.0.11

package/lib/{DeconzWsClient.js → Deconz/WsClient.js}

@@ -1,4 +1,4 @@
-// homebridge-deconz/lib/DeconzWsClient.js
+// homebridge-deconz/lib/Deconz/WsClient.js
 //
 // Homebridge plug-in for deCONZ.
 // Copyright © 2018-2022 Erik Baauw. All rights reserved.
@@ -9,15 +9,15 @@ const events = require('events')
 const homebridgeLib = require('homebridge-lib')
 const WebSocket = require('ws')
 
-/** Client for deCONZ web socket notifications.
+/** Client for web socket notifications by a deCONZ gateway.
   *
   * See the
   * [deCONZ](https://dresden-elektronik.github.io/deconz-rest-doc/endpoints/websocket/)
   * documentation for a better understanding of the web socket notifications.
-  * @copyright © 2018-2021 Erik Baauw. All rights reserved.
+  * @memberof Deconz
   */
-class DeconzWsClient extends events.EventEmitter {
-  /** Create a new web socket client instance.
+class WsClient extends events.EventEmitter {
+  /** Instantiate a new web socket client.
     * @param {object} params - Parameters.
     * @param {string} [params.host='localhost:443'] - IP address or hostname
     * and port of the web socket server.
@@ -35,7 +35,7 @@ class DeconzWsClient extends events.EventEmitter {
     this.config = {
       hostname: 'localhost',
       port: 443,
-      retryTime: 10
+      retryTime: 15
     }
     const optionParser = new homebridgeLib.OptionParser(this.config)
     optionParser
@@ -45,19 +45,17 @@ class DeconzWsClient extends events.EventEmitter {
       .parse(params)
   }
 
-  /** Websocket hostname and port.
+  /** The hostname or IP address and port of the web socket server.
     * @type {string}
     */
   get host () { return this.config.hostname + ':' + this.config.port }
   set host (host) {
-    if (host !== this.host) {
-      const { hostname, port } = homebridgeLib.optionParser.toHost(host)
-      this.config.hostname = hostname
-      this.config.port = port
-    }
+    const { hostname, port } = homebridgeLib.OptionParser.toHost('host', host)
+    this.config.hostname = hostname
+    this.config.port = port
   }
 
-  /** Listen for web socket notifications.
+  /** Connect to the web socket server, and listen notifications.
     */
   listen () {
     this.reconnect = true
@@ -73,7 +71,7 @@ class DeconzWsClient extends events.EventEmitter {
         this.emit('error', error)
       })
       .on('open', () => {
-        /** Emitted when connection to web socket server is opened.
+        /** Emitted when connection to web socket server has been made.
           * @event DeconzWsClient#listening
           * @param {string} url - The URL of the web socket server.
           */
@@ -91,46 +89,61 @@ class DeconzWsClient extends events.EventEmitter {
             if (obj.t === 'event') {
               switch (obj.e) {
                 case 'changed':
-                  if (obj.r && obj.id && obj.state) {
-                    const resource = '/' + obj.r + '/' + obj.id + '/state'
+                  if (obj.r !== null && obj.id !== null) {
+                    let body
+                    if (obj.state != null) {
+                      body = { state: obj.state }
+                    } else if (obj.config != null) {
+                      body = { config: obj.config }
+                    } else if (obj.attr != null) {
+                      body = obj.attr
+                    }
                     /** Emitted when a `changed` notification has been received.
+                      *
+                      * Note that the deCONZ gateway sends different
+                      * notifications for top-level, `state`, and `config`
+                      * attributes.
+                      * Consequenly, the `body` only contains one of these.
                       * @event DeconzWsClient#changed
-                      * @param {string} resource - The changed resource.<br>
-                      * This can be a `/lights`, `/groups`, or `/sensors`
-                      * resource for top-level attributes, or a `state` or
-                      * `config` sub-resource.
-                      * @param {object} attributes - The top-level, `state`, or
-                      * `config` attributes.
+                      * @param {string} rtype - The resource type of the changed
+                      * resource.
+                      * @param {integer} rid - The resource ID of the changed
+                      * resource.
+                      * @param {object} body - The body of the changed resource.
                       */
-                    this.emit('changed', resource, obj.state)
-                    return
-                  }
-                  if (obj.r && obj.id && obj.config) {
-                    const resource = '/' + obj.r + '/' + obj.id + '/config'
-                    this.emit('changed', resource, obj.config)
-                    return
-                  }
-                  if (obj.r && obj.id && obj.attr) {
-                    const resource = '/' + obj.r + '/' + obj.id
-                    this.emit('changed', resource, obj.attr)
+                    this.emit('changed', obj.r, obj.id, body)
                     return
                   }
                   break
                 case 'added':
-                  if (obj.r && obj.id) {
-                    const resource = '/' + obj.r + '/' + obj.id
+                  if (obj.r !== null && obj.id !== null) {
                     /** Emitted when an `added` notification has been received.
                       * @event DeconzWsClient#added
-                      * @param {string} resource - The added resource.
-                      * @param {object} attributes - The full attributes of the
-                      * added resource.
+                      * @param {string} rtype - The resource type of the added
+                      * resource.
+                      * @param {integer} rid - The resource ID of the added
+                      * resource.
+                      * @param {object} body - The body of the added resource.
                       */
-                    this.emit('added', resource, obj[obj.r.slice(0, -1)])
+                    this.emit('added', obj.r, obj.id, obj[obj.r.slice(0, -1)])
+                    return
+                  }
+                  break
+                case 'deleted':
+                  if (obj.r !== null && obj.id !== null) {
+                    /** Emitted when an `deleted` notification has been received.
+                      * @event DeconzWsClient#deleted
+                      * @param {string} rtype - The resource type of the deleted
+                      * resource.
+                      * @param {integer} rid - The resource ID of the deleted
+                      * resource.
+                      */
+                    this.emit('deleted', obj.r, obj.id)
                     return
                   }
                   break
                 case 'scene-called':
-                  if (obj.gid && obj.scid) {
+                  if (obj.gid != null && obj.scid != null) {
                     const resource = '/groups/' + obj.gid + '/scenes/' + obj.scid
                     /** Emitted when an `sceneRecall` notification has been received.
                       * @event DeconzWsClient#sceneRecall
@@ -157,8 +170,10 @@ class DeconzWsClient extends events.EventEmitter {
         }
       })
       .on('close', async () => {
-        this.ws.removeAllListeners()
-        delete this.ws
+        if (this.ws != null) {
+          this.ws.removeAllListeners()
+          delete this.ws
+        }
         const retryTime = this.reconnect ? this.config.retryTime : 0
         /** Emitted when the connection to the web socket server has been closed.
           * @event DeconzWsClient#closed
@@ -174,7 +189,7 @@ class DeconzWsClient extends events.EventEmitter {
       })
   }
 
-  /** Close the websocket.
+  /** Close the web socket connection.
     */
   async close () {
     if (this.ws != null) {
@@ -185,4 +200,4 @@ class DeconzWsClient extends events.EventEmitter {
   }
 }
 
-module.exports = DeconzWsClient
+module.exports = WsClient

package/lib/Deconz/index.js

@@ -0,0 +1,21 @@
+// homebridge-deconz/lib/Deconz/index.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+/** Library to discover, monitor, and interact with a deCONZ gateway.
+  * @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/Contact.js

@@ -0,0 +1,54 @@
+// homebridge-deconz/lib/DeconzAccessory/Contact.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const homebridgeLib = require('homebridge-lib')
+const DeconzAccessory = require('../DeconzAccessory')
+
+const { History } = homebridgeLib.ServiceDelegate
+
+/** Delegate class for a HomeKit accessory corresponding to a contact sensor,
+  * with Eve Door & Window history.
+  * @extends DeconzAccessory
+  * @memberof DeconzAccessory
+  */
+class Contact extends DeconzAccessory {
+  /** Instantiate a contact sensor delegate.
+    * @param {DeconzAccessory.Gateway} gateway - The gateway.
+    * @param {Deconz.Device} device - The device.
+    */
+  constructor (gateway, device) {
+    super(gateway, device, gateway.Accessory.Categories.SENSOR)
+
+    this.identify()
+
+    this.service = this.createService(device.resource, { primaryService: true })
+
+    for (const subtype in device.resourceBySubtype) {
+      const resource = device.resourceBySubtype[subtype]
+      if (subtype === device.primary) {
+        continue
+      }
+      this.createService(resource)
+    }
+
+    this.historyService = new History.Contact(
+      this, {},
+      this.service.characteristicDelegate('contact'),
+      this.service.characteristicDelegate('timesOpened'),
+      this.service.characteristicDelegate('lastActivation')
+    )
+
+    this.createSettingsService()
+
+    setImmediate(() => {
+      this.debug('initialised')
+      this.emit('initialised')
+    })
+  }
+}
+
+module.exports = Contact