homebridge-lib 5.3.2 → 5.5.0

package/cli/json.js

@@ -12,6 +12,10 @@
 const homebridgeLib = require('../index')
 
 const fs = require('fs')
+const util = require('util')
+const zlib = require('zlib')
+
+const gunzip = util.promisify(zlib.unzip)
 
 const { b, u } = homebridgeLib.CommandLineTool
 
@@ -21,26 +25,59 @@ const help = `JSON formatter.
 Usage: ${usage}
 
 By default, ${b('json')} reads JSON from stdin, formats it, and prints it to stdout.
-The following parameters modify this behaviour:
-  ${b('-h')}          Print this help and exit.
-  ${b('-V')}          Print version and exit.
-  ${b('-s')}          Sort object key/value pairs alphabetically on key.
-  ${b('-n')}          Do not include spaces nor newlines in output.
-  ${b('-j')}          Output JSON array of objects for each key/value pair.
-              Each object contains two key/value pairs: key "keys" with an array
-              of keys as value and key "value" with the value as value.
-  ${b('-u')}          Output JSON array of objects for each key/value pair.
-              Each object contains one key/value pair: the path (concatenated
-              keys separated by '/') as key and the value as value.
-  ${b('-a')}          Output path:value in plain text instead of JSON.
-  ${b('-t')}          Limit output to top-level key/values.
-  ${b('-p')} ${u('path')}     Limit output to key/values under ${u('path')}. Set top level below ${u('path')}.
-  ${b('-d')} ${u('depth')}    Limit output to levels above ${u('depth')}.
-  ${b('-l')}          Limit output to leaf (non-array, non-object) key/values.
-  ${b('-k')}          Limit output to keys. With ${b('-u')} output JSON array of paths.
-  ${b('-v')}          Limit output to values. With ${b('-u')} output JSON array of values.
-  ${b('-c')} ${u('string')}   Read JSON from ${u('string')} instead of from stdin.
-  ${u('file')}        Read JSON from ${u('file')} instead of from stdin.`
+
+Parameters:
+  ${b('-h')}, ${b('--help')}
+  Print this help and exit.
+
+  ${b('-V')}, ${b('--version')}
+  Print version and exit.
+
+  ${b('-s')}, ${b('--sortKeys')}
+  Sort object key/value pairs alphabetically on key.
+
+  ${b('-n')}, ${b('--noWhiteSpace')}
+  Do not include spaces nor newlines in output.
+
+  ${b('-j')}, ${b('--jsonArray')}
+  Output JSON array of objects for each key/value pair.
+  Each object contains two key/value pairs:
+  - key ${b('keys')} with an array of keys as value;
+  - key ${b('value')} with the value as value.
+
+  ${b('-u')}, ${b('--joinKeys')}
+  Output JSON array of objects for each key/value pair.
+  Each object contains one key/value pair:
+  the path (concatenated keys separated by ${b('/')} as key and the value as value.
+
+  ${b('-a')}, ${b('--ascii')}
+  Output ${u('path')}${b(':')}${u('value')} in plain text instead of JSON.
+
+  ${b('-t')}, ${b('--topOnly')}
+  Limit output to top-level key/values.
+
+  ${b('-p')} ${u('path')}, ${b('--fromPath=')}${u('path')}
+  Limit output to key/values under ${u('path')}. Set top level below ${u('path')}.
+
+  ${b('-d')} ${u('depth')}, ${b('--maxDepth=')}${u('depth')}
+  Limit output to levels above ${u('depth')}.
+
+  ${b('-l')}, ${b('--leavesOnly')}
+  Limit output to leaf (non-array, non-object) key/values.
+
+  ${b('-k')}, ${b('--keysOnly')}
+  Limit output to keys. With ${b('-u')} output JSON array of paths.
+
+  ${b('-v')}, ${b('--valuesOnly')}
+  Limit output to values. With ${b('-u')} output JSON array of values.
+
+  ${b('-c')} ${u('string')}, ${b('--string=')}${u('string')}
+  Read JSON from ${u('string')} instead of from stdin.
+
+  ${u('file')}
+  Read JSON from ${u('file')} instead of from stdin.
+  When the file name ends in ${b('.gz')}, it is assumed to be a gzip file and
+  uncompressed automatically.`
 
 class Main extends homebridgeLib.CommandLineTool {
   constructor () {
@@ -110,9 +147,11 @@ class Main extends homebridgeLib.CommandLineTool {
           this.error(error)
         }
       })
-      this.fileList.forEach((file) => {
+      this.fileList.forEach(async (file) => {
         try {
-          const s = fs.readFileSync(file === '-' ? 0 : file, 'utf8')
+          const s = file.endsWith('.gz')
+            ? await gunzip(fs.readFileSync(file))
+            : fs.readFileSync(file === '-' ? 0 : file, 'utf8')
           this.processString(s)
         } catch (error) {
           this.error(error)

package/lib/AdaptiveLighting.js

@@ -172,12 +172,8 @@ class AdaptiveLighting {
     * @param {integer} ct - The IID of the _Color Temperature_ characteristic.
     */
   constructor (bri, ct) {
-    this.bri = bri instanceof homebridgeLib.CharacteristicDelegate
-      ? bri._characteristic.iid
-      : bri
-    this.ct = ct instanceof homebridgeLib.CharacteristicDelegate
-      ? ct._characteristic.iid
-      : ct
+    this._bri = bri
+    this._ct = ct
     this._active = false
   }
 
@@ -187,6 +183,24 @@ class AdaptiveLighting {
     */
   get active () { return this._control != null }
 
+  get briIid () {
+    if (this._briIid == null) {
+      this._briIid = this._bri instanceof homebridgeLib.CharacteristicDelegate
+        ? this._bri._characteristic.iid
+        : this._bri
+    }
+    return this._briIid
+  }
+
+  get ctIid () {
+    if (this._ctIid == null) {
+      this._ctIid = this._ct instanceof homebridgeLib.CharacteristicDelegate
+        ? this._ct._characteristic.iid
+        : this._ct
+    }
+    return this._ctIid
+  }
+
   /** Deactivtate adaptive lighting.
     */
   deactivate () {
@@ -199,12 +213,12 @@ class AdaptiveLighting {
   generateConfiguration () {
     return Buffer.concat([
       tlvFromBuffer(1, Buffer.concat([
-        tlvFromUInt(1, this.bri),
+        tlvFromUInt(1, this.briIid),
         tlvFromUInt(2, 1)
       ])),
       tlvFromNull(0),
       tlvFromBuffer(1, Buffer.concat([
-        tlvFromUInt(1, this.ct),
+        tlvFromUInt(1, this.ctIid),
         tlvFromUInt(2, 2)
       ]))
     ]).toString('base64')
@@ -212,7 +226,7 @@ class AdaptiveLighting {
 
   _generateControl () {
     return tlvFromBuffer(1, Buffer.concat([
-      tlvFromUInt(1, this.ct),
+      tlvFromUInt(1, this.ctIid),
       tlvFromBuffer(2, Buffer.concat([
         tlvFromHexString(1, this._control.transitionParameters['2.1.2.1']),
         tlvFromUInt(2, this._startTime - epoch),
@@ -266,11 +280,11 @@ class AdaptiveLighting {
       value = parseTlv('2', buf)
     }
     const control = value.colorTemperature
-    if (control.iid != null && control.iid !== this.ct) {
+    if (control.iid != null && control.iid !== this.ctIid) {
       throw new Error('%d: bad ColorTemperature iid', control.iid)
     }
     if (control.curve != null) {
-      if (control.curve.adjustmentIid !== this.bri) {
+      if (control.curve.adjustmentIid !== this.briIid) {
         throw new Error('%d: bad Brightness iid', control.curve.adjustmentIid)
       }
       this._control = control

package/lib/CharacteristicDelegate.js

@@ -274,7 +274,7 @@ class CharacteristicDelegate extends homebridgeLib.Delegate {
           break
       }
     }
-    return { value: value, s: s }
+    return { value, s }
   }
 
   /** Value of associated Characteristic.

package/lib/Colour.js

@@ -109,7 +109,7 @@ class Colour {
       case 4: r = x + m; g = m; b = C + m; break
       case 5: r = C + m; g = m; b = x + m; break
     }
-    return { r: r, g: g, b: b }
+    return { r, g, b }
   }
 
   /** Convert {@link Colour.RGB RGB} to {@link Colour.HSV HSV}.

package/lib/CommandLineParser.js

@@ -201,11 +201,7 @@ See ${this._packageJson.homepage.split('#')[0]} for more info.
   parameter (key, callback, optional = false) {
     key = homebridgeLib.OptionParser.toString('key', key, true)
     callback = homebridgeLib.OptionParser.toFunction('callback', callback)
-    this._callbacks.parameters.push({
-      key: key,
-      callback: callback,
-      optional: optional
-    })
+    this._callbacks.parameters.push({ key, callback, optional })
     return this
   }
 

package/lib/HttpClient.js

@@ -349,14 +349,14 @@ class HttpClient extends events.EventEmitter {
       const requestId = ++this.__requestId
       const url = this.__params.url + (resource === '/' ? '' : resource) +
                   this.__params.suffix + suffix
-      const options = Object.assign({ method: method }, this.__options)
+      const options = Object.assign({ method }, this.__options)
       const requestInfo = Object.assign({
         name: this.name,
         id: requestId,
-        method: method,
-        resource: resource,
-        body: body,
-        url: url
+        method,
+        resource,
+        body,
+        url
       }, info)
       const request = this._http.request(url, options)
       request

package/lib/JsonFormatter.js

@@ -185,9 +185,9 @@ class JsonFormatter {
         obj[`/${keys.join('/')}`] = value
         return obj
       } else {
-        if (this.options.keysOnly) { return { keys: keys } }
-        if (this.options.valuesOnly) { return { value: value } }
-        return { keys: keys, value: value }
+        if (this.options.keysOnly) { return { keys } }
+        if (this.options.valuesOnly) { return { value } }
+        return { keys, value }
       }
     })
     if (this.options.ascii) {

package/lib/Platform.js

@@ -12,10 +12,12 @@ const fs = require('fs')
 const http = require('http')
 const semver = require('semver')
 const util = require('util')
+const zlib = require('zlib')
 
 const libPackageJson = require('../package.json')
 
 const uuid = /^[0-9A-F]{8}-[0-9A-F]{4}-[1-5][0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$/
+const gzip = util.promisify(zlib.gzip)
 
 const context = {
   libName: libPackageJson.name,
@@ -114,6 +116,12 @@ class Platform extends homebridgeLib.Delegate {
 
   get Characteristics () { return context.Characteristics }
 
+  /** Content of the plugin's package.json file.
+    * @type {object}
+    * @readonly
+    */
+  get packageJson () { return context.packageJson }
+
   /** Create a new instance of the platform plugin.
     *
     * Called by Homebridge when initialising the plugin from `config.json`.
@@ -210,6 +218,39 @@ class Platform extends homebridgeLib.Delegate {
     }
   }
 
+  /** Create a debug dump file.
+    *
+    * The dump file is a gzipped json file containing
+    * - The hardware and software environment of the server running Homebridge;
+    * - The versions of the plugin and of homebridge-lib;
+    * - The contents of config.json;
+    * - Any plugin-specific information.
+    *
+    * The file is created in the Homebridge user directory, and named after
+    * the plugin.
+    * @param {*} dumpInfo - Plugin-specific information.
+    */
+  async createDumpFile (dumpInfo = {}) {
+    const result = {
+      hardware: this.systemInfo.hwInfo.prettyName,
+      os: this.systemInfo.osInfo.prettyName,
+      node: context.nodeVersion,
+      homebridge: context.homebridgeVersion
+    }
+    result[this._pluginName] = this._pluginVersion
+    result[context.libName] = context.libVersion
+    result.configJson = this._configJson
+    const filename = this._homebridge.user.storagePath() + '/' +
+      this._pluginName + '.json.gz'
+    try {
+      const data = await gzip(JSON.stringify(Object.assign(result, dumpInfo)))
+      await fs.promises.writeFile(filename, data)
+      this.log('created debug dump file %s', filename)
+    } catch (error) {
+      this.error('%s: %s', filename, error)
+    }
+  }
+
   // Write `cachedAccessories` to disk.
   _flushCachedAccessories () {
     this.debug('flush cachedAccessories')
@@ -237,7 +278,7 @@ class Platform extends homebridgeLib.Delegate {
 
     if (beat % context.checkInterval === 0) {
       this._checkLatest(this._pluginName, this._pluginVersion)
-      this._checkLatest(context.libName, context.libVersion)
+      // this._checkLatest(context.libName, context.libVersion)
     }
 
     /** Emitted every second.
@@ -431,10 +472,10 @@ class Platform extends homebridgeLib.Delegate {
       this._accessories[id] = accessory
       accessory.displayName = name
       accessory.context = {
-        className: className,
-        version: version,
-        id: id,
-        name: name,
+        className,
+        version,
+        id,
+        name,
         logLevel: this.logLevel,
         context: {}
       }

package/lib/PropertyDelegate.js

@@ -94,7 +94,7 @@ class PropertyDelegate extends homebridgeLib.Delegate {
 
   validate (value) {
     // Todo: check value against type.
-    return { value: value, s: '' }
+    return { value, s: '' }
   }
 
   /** Value of associated Characteristic.

package/lib/SystemInfo.js

@@ -150,19 +150,19 @@ class SystemInfo extends events.EventEmitter {
       gpioMask = 0x03E6CF93 // 0-1, 4, 7-11, 14-15, 17-18, 21-25
     }
     return {
-      gpioMask: gpioMask,
+      gpioMask,
       gpioMaskSerial: (1 << 15) | (1 << 14),
-      id: id,
+      id,
       isRpi: true,
-      manufacturer: manufacturer,
-      memory: memory,
-      model: model,
-      modelRevision: modelRevision,
+      manufacturer,
+      memory,
+      model,
+      modelRevision,
       prettyName: [
         'Raspberry Pi', model, modelRevision, '(' + memory + ')'
       ].join(' '),
       powerLed: !(['A', 'B', 'Zero', 'Zero W', 'Zero 2 W'].includes(model)),
-      processor: processor,
+      processor,
       revision: homebridgeLib.toHexString(revision, 6),
       usbPower: ['B+', '2B', '3B', '3B+'].includes(model)
     }
@@ -249,13 +249,7 @@ class SystemInfo extends events.EventEmitter {
         }
       }
     }
-    return {
-      name: name,
-      platform: platform,
-      prettyName: prettyName,
-      version: version,
-      versionName: versionName
-    }
+    return { name, platform, prettyName, version, versionName }
   }
 
   /** Extract Apple Mac hardware info from `system_profiler` command.
@@ -315,15 +309,15 @@ class SystemInfo extends events.EventEmitter {
       this.emit('error', error)
     }
     return {
-      id: id,
+      id,
       isMac: true,
       manufacturer: 'Apple Inc.',
-      memory: memory,
-      model: model,
-      nCores: nCores,
+      memory,
+      model,
+      nCores,
       prettyName: prettyName || model,
-      processor: processor,
-      revision: revision
+      processor,
+      revision
     }
   }
 
@@ -361,13 +355,13 @@ class SystemInfo extends events.EventEmitter {
     }
     const versionName = macOsInfo.versionNames[v] // e.g. 'Monterey'
     return {
-      build: build,
+      build,
       catalina: semver.gte(version, '10.15.0'),
-      name: name,
+      name,
       platform: process.platform,
       prettyName: [name, versionName, version, '(' + build + ')'].join(' '),
-      version: version,
-      versionName: versionName
+      version,
+      versionName
     }
   }
 

package/package.json

@@ -3,7 +3,7 @@
   "description": "Library for homebridge plugins",
   "author": "Erik Baauw",
   "license": "Apache-2.0",
-  "version": "5.3.2",
+  "version": "5.5.0",
   "keywords": [
     "homekit",
     "homebridge"
@@ -21,14 +21,14 @@
     "upnp": "cli/upnp.js"
   },
   "engines": {
-    "homebridge": "^1.4.0",
-    "node": "^16.14.2"
+    "homebridge": "^1.4.1",
+    "node": "^16.15.0"
   },
   "dependencies": {
     "@homebridge/plugin-ui-utils": "~0.0.19",
     "bonjour-hap": "^3.6.3",
     "chalk": "^4.1.2",
-    "semver": "^7.3.5"
+    "semver": "^7.3.7"
   },
   "scripts": {
     "prepare": "standard && mocha && rm -rf out && jsdoc -c jsdoc.json",