homebridge-deconz 0.0.10 → 0.0.11

package/cli/deconz.js

@@ -301,6 +301,18 @@ Usage: ${b('deconz')} ${usage.unlock}
 
 ${description.unlock}
 
+Parameters:
+  ${b('-h')}, ${b('--help')}
+  Print this help and exit.
+
+  ${b('-v')}, ${b('--verbose')}
+  Print full API output.`,
+  search: `${description.search}
+
+Usage: ${b('deconz')} ${usage.search}
+
+${description.search}
+
 Parameters:
   ${b('-h')}, ${b('--help')}
   Print this help and exit.

package/lib/Deconz/ApiClient.js

@@ -9,7 +9,7 @@ const events = require('events')
 const homebridgeLib = require('homebridge-lib')
 const os = require('os')
 
-const Deconz = require('./index')
+const Deconz = require('../Deconz')
 
 // Estmate the number of Zigbee messages resulting from PUT body.
 function numberOfZigbeeMessages (body = {}) {
@@ -43,6 +43,29 @@ function numberOfZigbeeMessages (body = {}) {
   * @memberof Deconz
   */
 class ApiClient extends homebridgeLib.HttpClient {
+  /** Events reported through `buttonevent`.
+    * @type {Object<string, integer>}
+    */
+  static get buttonEvent () {
+    return {
+      PRESS: 0,
+      HOLD: 1,
+      SHORT_RELEASE: 2,
+      LONG_RELEASE: 3,
+      DOUBLE_PRESS: 4,
+      TRIPLE_PRESS: 5,
+      QUADRUPLE_PRESS: 6,
+      SHAKE: 7,
+      DROP: 8,
+      TILT: 9
+    }
+  }
+
+  /** Convert date as reported by deCONZ to human readable string.
+    * @param {string} date - The ISO-8601 date string.
+    * @param {boolean} [utc=true] - Treat date as UTC, even with missing `Z`.
+    * @param {string} date - The human readable date string.
+    */
   static dateToString (date, utc = true) {
     if (date == null || date === 'none') {
       return 'n/a'
@@ -53,6 +76,16 @@ class ApiClient extends homebridgeLib.HttpClient {
     return String(new Date(date)).slice(0, 24)
   }
 
+  /** Convert `lightlevel` to lux.
+    * @param {integer} lightLevel - The `lightlevel` as reported by deCONZ.
+    * @return {integer} lux - The value in lux.
+    */
+  static lightLevelToLux (v) {
+    let lux = v ? Math.pow(10, (v - 1) / 10000) : 0.0001
+    lux = Math.round(lux * 10000) / 10000
+    return Math.max(0.0001, Math.min(lux, 100000))
+  }
+
   /** Create a new instance of a Deconz.Client.
     *
     * The caller is expected to verify that the given host is a reachable

package/lib/Deconz/ApiResponse.js

@@ -7,7 +7,7 @@
 
 const homebridgeLib = require('homebridge-lib')
 
-const Deconz = require('./index')
+const Deconz = require('../Deconz')
 
 /** Deconz API response.
   * @hideconstructor

package/lib/Deconz/Device.js

@@ -92,13 +92,6 @@ class Device {
     this.resourceBySubtype[subtype] = resource
     const p = this.resourceBySubtype[this.primary]
     if (p.rtype === rtype && p.prio < prio) {
-      /** The key of the delegate for the primary resource for the device in
-        * {@link DeconzDevice#resourceBySubtype resourceBySubtype}
-        *
-        * This is the {@link DeconzDevice.Resource#subtype subtype} of the
-        * HomeKit service corresponding to the primary resource.
-        * @type {string}
-        */
       this.primary = resource.subtype
     }
   }