homebridge-lib 6.3.6 → 6.3.8

package/README.md

@@ -44,14 +44,9 @@ This way, `npm` installs Homebridge Lib automatically when installing the actual
 
 To install the command-line tools, use:
 ```
-$ sudo npm -g i homebridge-lib
+$ sudo npm -g i hb-lib-tools
 ```
 This creates symlinks to these tools in `/usr/bin` or `/usr/local/bin` (depending on how you installed NodeJS).
-Note that, when Homebridge Lib is installed like this, Homebridge might issue a warning at startup:
-```
-Plugin /usr/lib/node_modules/homebridge-lib package.json does not contain the keyword 'homebridge-plugin'
-```
-This warning can be ignored safely.
 
 ### Credits
 The logic for handling [Eve](https://www.evehome.com/en/eve-app) history was copied from Simone Tisa's [`fakegato-history`](https://github.com/simont77/fakegato-history) repository, copyright © 2017 simont77.

package/cli/hap.js

@@ -9,84 +9,6 @@
 
 'use strict'
 
-const homebridgeLib = require('../index')
+const { HapTool } = require('hb-lib-tools')
 
-const Bonjour = require('bonjour-hap')
-
-const { b, u } = homebridgeLib.CommandLineTool
-
-const usage = `${b('hap')} [${b('-hVlrs')}] [${b('-t')} ${u('timeout')}]`
-const help = `Logger for HomeKit accessory announcements.
-
-Usage: ${usage}
-
-Search for HomeKit accessory announcements
-Parameters:
-  ${b('-h')}          Print this help and exit.
-  ${b('-V')}          Print version and exit.
-  ${b('-d')}          Listen for Bonjour alive broadcasts instead of searching.
-  ${b('-s')}          Do not output timestamps (useful when running as service).
-  ${b('-t')} ${u('timeout')}  Search for ${u('timeout')} seconds instead of default ${b('5')}.`
-
-class Main extends homebridgeLib.CommandLineTool {
-  constructor () {
-    super()
-    this.usage = usage
-    this.options = { timeout: 15 }
-  }
-
-  parseArguments () {
-    const parser = new homebridgeLib.CommandLineParser()
-    parser
-      .help('h', 'help', help)
-      .version('V', 'version')
-      .flag('l', 'listen', (key) => { this.options.mode = 'daemon' })
-      .flag('s', 'service', (key) => { this.options.mode = 'service' })
-      .option('t', 'timeout', (value, key) => {
-        this.options.timeout = homebridgeLib.OptionParser.toInt(
-          'timeout', value, 1, 60, true
-        )
-      })
-      .parse()
-  }
-
-  onUp (obj) {
-    delete obj.rawTxt
-    this.log('found accessory: %s', obj.name, this.jsonFormatter.stringify(obj))
-  }
-
-  async main () {
-    try {
-      this.parseArguments()
-      this.jsonFormatter = new homebridgeLib.JsonFormatter(
-        this.options.mode === 'service'
-          ? { noWhiteSpace: true, sortKeys: true }
-          : { sortKeys: true }
-      )
-      if (this.options.mode) {
-        this.setOptions({ mode: this.options.mode })
-      } else {
-        setTimeout(() => {
-          this.log('search done')
-          bonjour4.destroy()
-          // bonjour6.destroy()
-        }, this.options.timeout * 1000)
-      }
-      this.log('searching for HomeKit accessories')
-      const bonjour4 = new Bonjour()
-      const browser4 = bonjour4.find({ type: 'hap' })
-      browser4.on('up', this.onUp.bind(this))
-      // const bonjour6 = new Bonjour({
-      //   type: 'udp6',
-      //   interface: '::%en0', // TODO: how to determine the interface?!
-      //   ip: 'ff02::fb'
-      // })
-      // const browser6 = bonjour6.find({ type: 'hap' })
-      // browser6.on('up', this.onUp.bind(this))
-    } catch (error) {
-      await this.fatal(error)
-    }
-  }
-}
-
-new Main().main()
+new HapTool(require('../package.json')).main()

package/cli/json.js

@@ -9,158 +9,6 @@
 
 'use strict'
 
-const homebridgeLib = require('../index')
+const { JsonTool } = require('hb-lib-tools')
 
-const fs = require('fs')
-const util = require('util')
-const zlib = require('zlib')
-
-const gunzip = util.promisify(zlib.unzip)
-
-const { b, u } = homebridgeLib.CommandLineTool
-
-const usage = `${b('json')} [${b('-hVsnjuatlkv')}] [${b('-p')} path] [${b('-d')} depth] [${b('-c')} ${u('string')}]... [${u('file')}]...`
-const help = `JSON formatter.
-
-Usage: ${usage}
-
-By default, ${b('json')} reads JSON from stdin, formats it, and prints it to stdout.
-
-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 () {
-    super()
-    this.usage = usage
-    this.options = {}
-    this.stringList = []
-    this.fileList = []
-  }
-
-  parseArguments () {
-    const parser = new homebridgeLib.CommandLineParser()
-    parser
-      .help('h', 'help', help)
-      .version('V', 'version')
-      .flag('s', 'sortKeys', () => { this.options.sortKeys = true })
-      .flag('n', 'noWhiteSpace', () => { this.options.noWhiteSpace = true })
-      .flag('j', 'jsonArray', () => { this.options.jsonArray = true })
-      .flag('u', 'joinKeys', () => { this.options.joinKeys = true })
-      .flag('a', 'ascii', () => { this.options.ascii = true })
-      .flag('t', 'topOnly', () => { this.options.topOnly = true })
-      .option('d', 'maxDepth', (value, option) => {
-        this.options.maxDepth = homebridgeLib.OptionParser.toInt(
-          'maxDepth', value, 0, undefined, true)
-      })
-      .option('p', 'fromPath', (value, option) => {
-        this.options.fromPath = homebridgeLib.OptionParser.toPath(
-          'fromPath', value, true
-        )
-      })
-      .flag('l', 'leavesOnly', () => { this.options.leavesOnly = true })
-      .flag('k', 'keysOnly', () => { this.options.keysOnly = true })
-      .flag('v', 'valuesOnly', () => { this.options.valuesOnly = true })
-      .option('c', 'string', (value) => { this.stringList.push(value) })
-      .remaining((list) => { this.fileList = list })
-      .parse()
-  }
-
-  processString (s) {
-    let value
-    try {
-      value = JSON.parse(s)
-    } catch (error) {
-      throw new Error(error.message) // Convert SyntaxError to Error.
-    }
-    const output = this.jsonFormatter.stringify(value)
-    if (this.n++ > 0) {
-      this.print('------')
-    }
-    if (output !== '') {
-      this.print(output)
-    }
-  }
-
-  async main () {
-    try {
-      this.parseArguments()
-      this.jsonFormatter = new homebridgeLib.JsonFormatter(this.options)
-      if (this.fileList.length === 0 && this.stringList.length === 0) {
-        this.fileList = ['-']
-      }
-      this.n = 0
-      this.stringList.forEach((s) => {
-        try {
-          this.processString(s)
-        } catch (error) {
-          this.error(error)
-        }
-      })
-      this.fileList.forEach(async (file) => {
-        try {
-          const s = file.endsWith('.gz')
-            ? await gunzip(fs.readFileSync(file))
-            : fs.readFileSync(file === '-' ? 0 : file, 'utf8')
-          this.processString(s)
-        } catch (error) {
-          this.error(error)
-        }
-      })
-    } catch (error) {
-      await this.fatal(error)
-    }
-  }
-}
-
-new Main().main()
+new JsonTool(require('../package.json')).main()

package/cli/sysinfo.js

@@ -9,73 +9,6 @@
 
 'use strict'
 
-const homebridgeLib = require('../index')
+const { SysinfoTool } = require('hb-lib-tools')
 
-const { b } = homebridgeLib.CommandLineTool
-
-const usage = `${b('sysinfo')} [${b('-hVDj')}]`
-const help = `System information tool.
-
-Print Hardware and Operating System information.
-
-Usage: ${usage}
-
-Parameters:
-  ${b('-h')}, ${b('--help')}
-  Print this help and exit.
-
-  ${b('-V')}, ${b('--version')}
-  Print version and exit.
-
-  ${b('-D')}, ${b('--debug')}
-  Print debug messages.
-
-  ${b('-j')}, ${b('--json')}
-  Print full info in json.`
-
-class Main extends homebridgeLib.CommandLineTool {
-  constructor () {
-    super()
-    this.usage = usage
-    this.options = {
-      noWhiteSpace: false
-    }
-    this.upnp = {}
-  }
-
-  parseArguments () {
-    const parser = new homebridgeLib.CommandLineParser()
-    parser
-      .help('h', 'help', help)
-      .version('V', 'version')
-      .flag('D', 'debug', () => { this.setOptions({ debug: true }) })
-      .flag('j', 'json', () => { this.json = true })
-      .parse()
-  }
-
-  async main () {
-    try {
-      this.parseArguments()
-      this.systemInfo = new homebridgeLib.SystemInfo()
-      this.systemInfo
-        .on('error', (error) => { this.error(error) })
-        .on('exec', (command) => { this.debug('exec: %s', command) })
-        .on('readFile', (fileName) => { this.debug('read file: %s', fileName) })
-      await this.systemInfo.init()
-      if (this.json) {
-        const jsonFormatter = new homebridgeLib.JsonFormatter(this.options)
-        this.print(jsonFormatter.stringify({
-          hardware: this.systemInfo.hwInfo,
-          os: this.systemInfo.osInfo
-        }))
-      } else {
-        this.print(this.systemInfo.hwInfo.prettyName)
-        this.print(this.systemInfo.osInfo.prettyName)
-      }
-    } catch (error) {
-      await this.fatal(error)
-    }
-  }
-}
-
-new Main().main()
+new SysinfoTool(require('../package.json')).main()

package/cli/upnp.js

@@ -9,142 +9,6 @@
 
 'use strict'
 
-const homebridgeLib = require('../index')
+const { UpnpTool } = require('hb-lib-tools')
 
-const { b, u } = homebridgeLib.CommandLineTool
-
-const usage = `${b('upnp')} [${b('-hVDadnprsz')}] [${b('-c')} ${u('class')}] [${b('-t')} ${u('timeout')}]`
-const help = `UPnP tool.
-
-Search for UPnP devices and print found devices as JSON.
-When running as daemon or service, log UPnP alive broadcasts as JSON.
-
-Usage: ${usage}
-
-Parameters:
-  ${b('-h')}, ${b('--help')}
-  Print this help and exit.
-
-  ${b('-V')}, ${b('--version')}
-  Print version and exit.
-
-  ${b('-D')}, ${b('--debug')}
-  Print debug messages.
-
-  ${b('-a')}, ${b('--all')}
-  Short for ${b('-c ssdp:all')}.
-
-  ${b('-c')} ${u('class')}, ${b('--class=')}${u('class')}
-  Search for ${u('class')} instead of default ${b('ssdp:rootdevice')}.
-
-  ${b('-d')}, ${b('--daemon')}
-  Run as daemon.  Listen for UPnP alive broadcasts instead of searching.
-
-  ${b('-n')}, ${b('--noWhiteSpace')}
-  Do not include spaces nor newlines in JSON output.
-
-  ${b('-p')}, ${b('--hue')}
-  Search for Philips Hue bridges and/or deCONZ gateways.
-
-  ${b('-r')}, ${b('--raw')}
-  Do not parse messages, output raw message data instead of JSON.
-
-  ${b('-s')}, ${b('--service')}
-  Run as daemon.  Listen for UPnP alive broadcasts instead of searching.
-
-  ${b('-t')} ${u('timeout')}, ${b('--timeout=')}${u('timeout')}
-  Search for ${u('timeout')} seconds instead of default ${b('5')}.
-
-  ${b('-z')}, ${b('--sonos')}
-  Search for Sonos Zone Players.`
-
-class Main extends homebridgeLib.CommandLineTool {
-  constructor () {
-    super()
-    this.usage = usage
-    this.options = {
-      noWhiteSpace: false
-    }
-    this.upnp = {}
-  }
-
-  parseArguments () {
-    const parser = new homebridgeLib.CommandLineParser()
-    parser
-      .help('h', 'help', help)
-      .version('V', 'version')
-      .flag('D', 'debug', () => { this.setOptions({ debug: true }) })
-      .flag('a', 'all', (key) => { this.upnp.class = 'ssdp:all' })
-      .option('c', 'class', (value, key) => { this.upnp.class = value })
-      .flag('d', 'daemon', (key) => { this.options.mode = 'daemon' })
-      .flag('n', 'noWhiteSpace', () => { this.options.noWhiteSpace = true })
-      .flag('r', 'raw', (key) => { this.options.raw = true })
-      .flag('s', 'service', (key) => { this.options.mode = 'service' })
-      .option('t', 'timeout', (value, key) => {
-        this.upnp.timeout = homebridgeLib.OptionParser.toInt(
-          'timeout', value, 1, 60, true
-        )
-      })
-      .flag('p', 'hue', (key) => {
-        this.upnp.filter = (message) => {
-          return /^[0-9A-F]{16}$/.test(message['hue-bridgeid'])
-        }
-      })
-      .flag('z', 'sonos', (key) => {
-        this.upnp.class = 'urn:schemas-upnp-org:device:ZonePlayer:1'
-      })
-      .parse()
-  }
-
-  async destroy () {
-    if (this.upnpClient == null) {
-      return
-    }
-    return this.upnpClient.stopListen()
-  }
-
-  async main () {
-    try {
-      this.parseArguments()
-      const jsonFormatter = new homebridgeLib.JsonFormatter({
-        noWhiteSpace: this.options.noWhiteSpace
-      })
-      this.upnpClient = new homebridgeLib.UpnpClient(this.upnp)
-      this.upnpClient
-        .on('error', (error) => { this.error(error) })
-        .on('listening', (host) => { this.debug('listening on %s', host) })
-        .on('stopListening', (host) => { this.debug('stopped listening on %s', host) })
-        .on('deviceAlive', (address, obj, message) => {
-          if (!this.options.raw) {
-            message = jsonFormatter.stringify(obj)
-          }
-          this.log('%s: %s', address, message)
-        })
-        .on('searching', (host) => { this.debug('listening on %s', host) })
-        .on('request', (request) => {
-          this.debug(
-            '%s: request %d: %s %s', request.host, request.id,
-            request.method, request.resource
-          )
-        })
-        .on('searchDone', (host) => { this.debug('search done') })
-        .on('deviceFound', (address, obj, message) => {
-          if (!this.options.raw) {
-            message = jsonFormatter.stringify(obj)
-          }
-          this.print('%s: %s', address, message)
-        })
-
-      if (this.options.mode) {
-        this.setOptions({ mode: this.options.mode })
-        this.upnpClient.listen()
-      } else {
-        this.upnpClient.search()
-      }
-    } catch (error) {
-      await this.fatal(error)
-    }
-  }
-}
-
-new Main().main()
+new UpnpTool(require('../package.json')).main()