homebridge-lib 5.1.17 → 5.1.19

package/README.md

@@ -28,11 +28,12 @@ See [Homebridge WS](https://github.com/ebaauw/homebridge-ws) for an example plug
 ### Command-Line Tools
 The Homebridge Lib library comes with a number of command-line tools for troubleshooting Homebridge installations.
 
-Tool    | Description
-------- | -----------
-`hap`   | Logger for HomeKit accessory announcements.
-`json`  | JSON formatter.
-`upnp`  | UPnP tool.
+Tool      | Description
+--------- | -----------
+`hap`     | Logger for HomeKit accessory announcements.
+`json`    | JSON formatter.
+`sysinfo` | Print hardware and operating system information.
+`upnp`    | UPnP tool.
 
 Each command-line tool takes a `-h` or `--help` argument to provide a brief overview of its functionality and command-line arguments.
 

package/cli/sysinfo.js

@@ -0,0 +1,81 @@
+#!/usr/bin/env node
+
+// homebridge-lib/cli/sysinfo.js
+//
+// Library for Homebridge plugins.
+// Copyright © 2021 Erik Baauw. All rights reserved.
+//
+// Show system info.
+
+'use strict'
+
+const homebridgeLib = require('../index')
+
+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()

package/index.js

@@ -30,6 +30,8 @@ function isNodejsError (e) {
   return typeof e.code === 'string' && e.code.startsWith('ERR_')
 }
 
+const zeroes = '00000000000000000000000000000000'
+
 /** Library for Homebridge plugins.
   * see the {@tutorial homebridgeLib} tutorial.
   *
@@ -180,6 +182,13 @@ class homebridgeLib {
     */
   static get ServiceDelegate () { return require('./lib/ServiceDelegate') }
 
+  /** System information.
+    * <br>See {@link SystemInfo}.
+    * @type {Class}
+    * @memberof module:homebridgeLib
+    */
+  static get SystemInfo () { return require('./lib/SystemInfo') }
+
   /** Universal Plug and Play client.
     * <br>See {@link UpnpClient}.
     * @type {Class}
@@ -258,6 +267,16 @@ class homebridgeLib {
     }
     return e.message
   }
+
+  /** Convert integer to hex string.
+    * @param {integer} i - The integer.
+    * @param {integer} [length=4] - The number of digits in the hex string.
+    * @returns {string} - The hex string.
+    * @memberof module:homebridgeLib
+    */
+  static toHexString (i, length = 4) {
+    return (zeroes + i.toString(16)).slice(-length).toUpperCase()
+  }
 }
 
 module.exports = homebridgeLib

package/lib/CommandLineTool.js

@@ -53,10 +53,15 @@ class CommandLineTool {
         .on('SIGINT', this._onSignal.bind(this))
         .on('SIGTERM', this._onSignal.bind(this))
         .on('SIGABRT', this._onSignal.bind(this))
-        .on('uncaughtException', (error) => { this.fatal(error) })
-        .on('unhandledRejection', (error) => { this.fatal(error) })
+        .on('uncaughtException', async (error) => {
+          await this.fatal('uncaught exception: %s', error.stack)
+        })
+        .removeAllListeners('unhandledRejection')
+        .on('unhandledRejection', async (error) => {
+          await this.fatal('unhandled rejection: %s', error.stack)
+        })
     } catch (error) {
-      this.fatal(error)
+      this._log({ label: 'fatal', chalk: chalk.bold.red }, error)
     }
   }
 

package/lib/MyHomeKitTypes.js

@@ -120,6 +120,8 @@ class MyHomeKitTypes extends homebridgeLib.CustomHomeKitTypes {
       * <br>Used by: homebridge-otgw.
       * @property {Class} PumpStarts - Number of pump starts.
       * <br>Used by: homebridge-otgw.
+      * @property {Class} Recall - Recall a scene.
+      * <br>Used by: homebridge-hue.
       * @property {Class} Repeat - Repeat tracks (off, 1, all).
       * <br>Used by: homebridge-zp.
       * @property {Class} Resource - REST API resource corresponding for
@@ -133,6 +135,8 @@ class MyHomeKitTypes extends homebridgeLib.CustomHomeKitTypes {
       * <br>Used by: homebridge-otgw.
       * @property {Class} RingToOpen - Ring to Open active.
       * <br> Used by: homebridge-nb.
+      * @property {Class} Search - Search for new devices.
+      * <br>Used by: homebridge-hue.
       * @property {Class} Sensitivity - Motion sensor sensitivity.
       * <br>See also: {@link EveHomeKitTypes#Characteristics eve.Sensitivity}.
       * <br>Previously used by: homebridge-hue in MotionSensor service.
@@ -664,6 +668,17 @@ class MyHomeKitTypes extends homebridgeLib.CustomHomeKitTypes {
       perms: [this.Perms.READ, this.Perms.NOTIFY, this.Perms.WRITE]
     }, 'Motor Speed')
 
+    this.createCharacteristicClass('Search', uuid('073'), {
+      format: this.Formats.BOOL,
+      perms: [this.Perms.READ, this.Perms.NOTIFY, this.Perms.WRITE],
+      adminOnlyAccess: [this.Access.WRITE]
+    })
+
+    this.createCharacteristicClass('Recall', uuid('074'), {
+      format: this.Formats.BOOL,
+      perms: [this.Perms.READ, this.Perms.NOTIFY, this.Perms.WRITE]
+    })
+
     // Characteristic for Unique ID, used by homebridge-hue.
     // Source: as exposed by the Philips Hue bridge.  This characteristic is
     // used by the Hue app to select the accessories when syncing Hue bridge

package/lib/Platform.js

@@ -210,6 +210,18 @@ class Platform extends homebridgeLib.Delegate {
       //   this.error('unhandled rejection: %s', error.stack)
       // })
       global[globalKey].Platform.heartbeat = this
+      /** System information.
+        * @type {SystemInfo}
+        * @readonly
+        */
+      this.systemInfo = new homebridgeLib.SystemInfo()
+      this.systemInfo
+        .on('error', (error) => { this.warn(error) })
+        .on('exec', (command) => { this.debug('exec: %s', command) })
+        .on('readFile', (filename) => { this.debug('read file: %s', filename) })
+      await this.systemInfo.init()
+      this.log('hardware: %s', this.systemInfo.hwInfo.prettyName)
+      this.log('os: %s', this.systemInfo.osInfo.prettyName)
       this.heartbeatClients = Object.keys(global[globalKey]).filter((key) => {
         return global[globalKey][key].platform != null
       })
@@ -221,6 +233,8 @@ class Platform extends homebridgeLib.Delegate {
         this._homebridge.updatePlatformAccessories()
         this.log('goodbye')
       })
+    } else {
+      this.systemInfo = global[globalKey].Platform.heartbeat.systemInfo
     }
     if (this._isHomebridgeLib) {
       const jobs = []

package/lib/SystemInfo.js

@@ -0,0 +1,419 @@
+// homebridge-lib/lib/SystemInfo.js
+//
+// Library for Homebridge plugins.
+// Copyright © 2019-2021 Erik Baauw. All rights reserved.
+
+'use strict'
+
+const events = require('events')
+const { exec, execFile } = require('child_process')
+const fs = require('fs').promises
+const os = require('os')
+const semver = require('semver')
+
+const homebridgeLib = require('../index')
+
+const rpiInfo = {
+  manufacturers: {
+    0: 'Sony UK',
+    1: 'Egoman',
+    2: 'Embest',
+    3: 'Sony Japan',
+    4: 'Embest',
+    5: 'Stadium'
+  },
+  memorySizes: {
+    0: '256MB',
+    1: '512MB',
+    2: '1GB',
+    3: '2GB',
+    4: '4GB',
+    5: '8GB'
+  },
+  models: {
+    0: 'A',
+    1: 'B',
+    2: 'A+',
+    3: 'B+',
+    4: '2B',
+    5: 'Alpha', // early prototype
+    6: 'CM1',
+    8: '3B',
+    9: 'Zero',
+    10: 'CM3',
+    12: 'Zero W',
+    13: '3B+',
+    14: '3A+',
+    // 15: '', // Internal use only
+    16: 'CM3+',
+    17: '4B',
+    18: 'Zero 2 W',
+    19: '400',
+    20: 'CM4'
+  },
+  processors: {
+    0: 'BCM2835',
+    1: 'BCM2836',
+    2: 'BCM2837',
+    3: 'BCM2711'
+  },
+  oldRevisions: {
+    2: { model: 'B', revision: '1.0', memory: '256MB', manufacturer: 'Egoman' },
+    3: { model: 'B', revision: '1.0', memory: '256MB', manufacturer: 'Egoman' },
+    4: { model: 'B', revision: '2.0', memory: '256MB', manufacturer: 'Sony UK' },
+    5: { model: 'B', revision: '2.0', memory: '256MB', manufacturer: 'Qisda' },
+    6: { model: 'B', revision: '2.0', memory: '256MB', manufacturer: 'Egoman' },
+    7: { model: 'A', revision: '2.0', memory: '256MB', manufacturer: 'Egoman' },
+    8: { model: 'A', revision: '2.0', memory: '256MB', manufacturer: 'Sony UK' },
+    9: { model: 'A', revision: '2.0', memory: '256MB', manufacturer: 'Qisda' },
+    13: { model: 'B', revision: '2.0', memory: '512MB', manufacturer: 'Egoman' },
+    14: { model: 'B', revision: '2.0', memory: '512MB', manufacturer: 'Sony UK' },
+    15: { model: 'B', revision: '2.0', memory: '512MB', manufacturer: 'Egoman' },
+    16: { model: 'B+', revision: '1.2', memory: '512MB', manufacturer: 'Sony UK' },
+    17: { model: 'CM1', revision: '1.0', memory: '512MB', manufacturer: 'Sony UK' },
+    18: { model: 'A+', revision: '1.1', memory: '256MB', manufacturer: 'Sony UK' },
+    19: { model: 'B+', revision: '1.2', memory: '512MB', manufacturer: 'Embest' },
+    20: { model: 'CM1', revision: '1.0', memory: '512MB', manufacturer: 'Embest' },
+    21: { model: 'A+', revision: '1.1', memory: '256MB/512MB', manufacturer: 'Embest' }
+  }
+}
+
+// See: https://en.wikipedia.org/wiki/MacOS_version_history
+const macOsInfo = {
+  versionNames: {
+    '10.0': 'Cheetah',
+    10.1: 'Puma',
+    10.2: 'Jaguar',
+    10.3: 'Panther',
+    10.4: 'Tiger',
+    10.5: 'Leopard',
+    10.6: 'Snow Leopard',
+    10.7: 'Lion',
+    10.8: 'Mountain Lion',
+    10.9: 'Mavericks',
+    '10.10': 'Yosemite',
+    10.11: 'El Capitan',
+    10.12: 'Sierra',
+    10.13: 'High Sierra',
+    10.14: 'Mojave',
+    10.15: 'Catalina',
+    11: 'Big Sur',
+    12: 'Monterey'
+  }
+}
+
+/** System information.
+  * @extends EventEmitter
+  */
+class SystemInfo extends events.EventEmitter {
+  /** Extract Raspberry Pi serial number and hardware revision info from the
+    * contents of `/proc/cpuinfo`.
+    * @param {string} cpuInfo - The contents of `/proc/cpuinfo`.
+    * @return {object} - The extracted info.
+    */
+  static parseRpiCpuInfo (cpuInfo) {
+    const id = /Serial\s*: ([0-9a-f]{16})/.exec(cpuInfo)[1].toUpperCase()
+    const revision = parseInt(
+      /Revision\s*: ([0-9a-f]{4,})/.exec(cpuInfo)[1], 16
+    ) & 0x00FFFFFF
+    let gpioMask, manufacturer, memory, model, modelRevision, processor
+    if ((revision & 0x00800000) !== 0) { // New revision scheme.
+      manufacturer = rpiInfo.manufacturers[(revision & 0x000F0000) >> 16]
+      memory = rpiInfo.memorySizes[(revision & 0x00700000) >> 20]
+      model = rpiInfo.models[(revision & 0x00000FF0) >> 4]
+      modelRevision = '1.' + ((revision & 0x0000000F) >> 0).toString()
+      processor = rpiInfo.processors[(revision & 0x0000F000) >> 12]
+    } else if (rpiInfo.oldRevisions[revision] != null) { // Old incremental revisions.
+      manufacturer = rpiInfo.oldRevisions[revision].manufacturer
+      memory = rpiInfo.oldRevisions[revision].memory
+      model = rpiInfo.oldRevisions[revision].model
+      modelRevision = rpiInfo.oldRevisions[revision].revision
+      processor = 'BCM2835'
+    }
+    if (model != null && model.startsWith('CM')) {
+      // Compute module
+      gpioMask = 0xFFFFFFFF // 0-31
+    } else if (revision >= 16) {
+      // Type 3
+      gpioMask = 0x0FFFFFFC // 2-27
+    } else if (revision >= 4) {
+      // Type 2
+      gpioMask = 0xFBC6CF9C // 2-4, 7-11, 14-15, 17-18, 22-25, 27-31
+    } else {
+      // Type 1
+      gpioMask = 0x03E6CF93 // 0-1, 4, 7-11, 14-15, 17-18, 21-25
+    }
+    return {
+      gpioMask: gpioMask,
+      gpioMaskSerial: (1 << 15) | (1 << 14),
+      id: id,
+      isRpi: true,
+      manufacturer: manufacturer,
+      memory: memory,
+      model: model,
+      modelRevision: modelRevision,
+      prettyName: [
+        'Raspberry Pi', model, modelRevision, '(' + memory + ')'
+      ].join(' '),
+      powerLed: !(['A', 'B', 'Zero', 'Zero W', 'Zero 2 W'].includes(model)),
+      processor: processor,
+      revision: homebridgeLib.toHexString(revision, 6),
+      usbPower: ['B+', '2B', '3B', '3B+'].includes(model)
+    }
+  }
+
+  /** Initialise SystemInfo instance.
+    */
+  async init () {
+    switch (process.platform) {
+      case 'linux':
+        try {
+          this.osInfo = await this.getPiOsInfo()
+        } catch (error) { this.emit('error', error) }
+        if (['arm', 'arm64'].includes(process.arch)) {
+          try {
+            this.hwInfo = await this.getRpiInfo()
+          } catch (error) { this.emit('error', error) }
+        }
+        break
+      case 'darwin':
+        try {
+          this.osInfo = await this.getMacOsInfo()
+        } catch (error) { this.emit('error', error) }
+        try {
+          this.hwInfo = await this.getMacInfo()
+        } catch (error) { this.emit('error', error) }
+        break
+      default:
+        break
+    }
+    if (this.osInfo == null) {
+      this.osInfo = {
+        name: process.platform,
+        platform: process.platform,
+        prettyName: process.platform
+      }
+    }
+    if (this.hwInfo == null) {
+      this.hwInfo = {
+        nCores: os.cpus().length,
+        prettyName: process.arch,
+        processor: process.arch
+      }
+    }
+    this.platform = this.osInfo.platform
+  }
+
+  /** Extract serial number and hardware revision info from `/proc/cpuinfo`.
+    * @return {object} - The extracted info.
+    */
+  async getRpiInfo () {
+    const cpuInfo = await this.readTextFile('/proc/cpuinfo')
+    return SystemInfo.parseRpiCpuInfo(cpuInfo)
+  }
+
+  /** Extract OS info from /etc/os-release.
+    * @return {object} - The extracted info.
+    */
+  async getPiOsInfo () {
+    let name, platform, prettyName, version, versionName
+    const text = await this.readTextFile('/etc/os-release')
+    const lines = text.replace(/"/g, '').split('\n')
+    for (const line of lines) {
+      const fields = line.split('=')
+      if (fields.length === 2) {
+        switch (fields[0]) {
+          case 'ID':
+            platform = fields[1] // e.g. 'raspbian'
+            break
+          case 'NAME':
+            name = fields[1] // e.g. 'Raspbian GNU/Linux'
+            break
+          case 'PRETTY_NAME':
+            prettyName = fields[1] // e.g. 'Raspbian GNU/Linux 11 (bullseye)'
+            break
+          case 'VERSION_CODENAME':
+            versionName = fields[1] // e.g. 'bullseye'
+            break
+          case 'VERSION_ID':
+            version = fields[1] // e.g. '11'
+            break
+          default:
+            break
+        }
+      }
+    }
+    return {
+      name: name,
+      platform: platform,
+      prettyName: prettyName,
+      version: version,
+      versionName: versionName
+    }
+  }
+
+  /** Extract Apple Mac hardware info from `system_profiler` command.
+    * @return {object} - The extracted info.
+    */
+  async getMacInfo () {
+    let id, memory, model, nCores, prettyName, processor, revision
+    let text = await this.exec('system_profiler', 'SPHardwareDataType')
+    const lines = text.split('\n')
+    for (const line of lines) {
+      const fields = line.split(': ')
+      if (fields.length === 2) {
+        switch (fields[0].trim()) {
+          case 'Memory':
+            memory = fields[1].replace(/ /g, '')
+            break
+          case 'Model Identifier':
+            revision = fields[1]
+            break
+          case 'Model Name':
+            model = fields[1]
+            break
+          case 'Chip':
+          case 'Processor Name':
+            processor = fields[1]
+            break
+          case 'Serial Number (system)':
+            id = fields[1]
+            break
+          case 'Total Number of Cores':
+            nCores = fields[1].split(' ')[0]
+            break
+          default:
+            break
+        }
+      }
+    }
+    text = await this.exec(
+      'plutil', '-convert', 'json', '-o', '-',
+      process.env.HOME + '/Library/Preferences/com.apple.SystemProfiler.plist'
+    )
+    const s = JSON.parse(text)['CPU Names']
+    if (s != null) {
+      // This is empty on my MacBook Pro (14-inch, 2021).
+      for (const key of Object.keys(s)) {
+        if (key.startsWith(id.slice(-4))) {
+          prettyName = s[key]
+        }
+      }
+    } else {
+      // text = await this.exec(
+      //   'ioreg', '-c', 'IOPlatformDevice', '-d', '4', '-n', 'product'
+      // )
+      text = await this.execShell('ioreg -l | grep product-description')
+      // This is empty on my Intel Macs - I think the key is registered for
+      // running iPad apps on Apple chips.
+      const a = /"product-description" = <"([^"]*)">/.exec(text)
+      if (a != null) {
+        prettyName = a[1]
+      }
+    }
+    return {
+      id: id,
+      isMac: true,
+      manufacturer: 'Apple Inc.',
+      memory: memory,
+      model: model,
+      nCores: nCores,
+      prettyName: prettyName || model,
+      processor: processor,
+      revision: revision
+    }
+  }
+
+  /** Extract macOS info from `sw_vers` command.
+    * @return {object} - The extracted info.
+    */
+  async getMacOsInfo () {
+    let name, version, build
+    const text = await this.exec('sw_vers')
+    const lines = text.split('\n')
+    for (const line of lines) {
+      const fields = line.split(':\t')
+      if (fields.length === 2) {
+        switch (fields[0]) {
+          case 'ProductName': // e.g. 'macOS' or 'Mac OS X'
+            name = fields[1]
+            break
+          case 'ProductVersion': // e.g. '12.0.1'
+            version = fields[1]
+            break
+          case 'BuildVersion': // e.g. '21A559'
+            build = fields[1]
+            break
+          default:
+            break
+        }
+      }
+    }
+    let v = semver.major(version)
+    if (v === 10) {
+      v += '.' + semver.minor(version)
+    }
+    const versionName = macOsInfo.versionNames[v] // e.g. 'Monterey'
+    return {
+      build: build,
+      catalina: semver.gte(version, '10.15.0'),
+      name: name,
+      platform: process.platform,
+      prettyName: [name, versionName, version, '(' + build + ')'].join(' '),
+      version: version,
+      versionName: versionName
+    }
+  }
+
+  /** Execute a command on the local machine.
+    * @param {string} command - The command.
+    * @param {...string} ...args - The command parameters.
+    * @return {string} - The output of the command.
+    */
+  async exec (command, ...args) {
+    return new Promise((resolve, reject) => {
+      /** Emitted when a command is executed.
+        * @event SystemInfo#exec
+        * @param {string} command - The command.
+        */
+      this.emit('exec', command + ' ' + args.join(' '))
+      execFile(command, args, null, (error, stdout, stderr) => {
+        if (error != null) {
+          reject(error)
+        }
+        resolve(stdout)
+      })
+    })
+  }
+
+  /** Execute a shell command on the local machine.
+    * @param {string} command - The command.
+    * @return {string} - The output of the command.
+    */
+  async execShell (command) {
+    return new Promise((resolve, reject) => {
+      this.emit('exec', command)
+      exec(command, (error, stdout, stderr) => {
+        if (error != null) {
+          reject(error)
+        }
+        resolve(stdout)
+      })
+    })
+  }
+
+  /** Read a text file.
+    * @param {string} fileName - The file name.
+    * @return {string} - The contents of the file.
+    */
+  async readTextFile (fileName) {
+    /** Emitted when a file is read.
+      * @event SystemInfo#readFile
+      * @param {string} fileName - The file name.
+      */
+    this.emit('readFile', fileName)
+    return fs.readFile(fileName, 'utf8')
+  }
+}
+
+module.exports = SystemInfo

package/package.json

@@ -3,7 +3,7 @@
   "description": "Library for homebridge plugins",
   "author": "Erik Baauw",
   "license": "Apache-2.0",
-  "version": "5.1.17",
+  "version": "5.1.19",
   "keywords": [
     "homekit",
     "homebridge"
@@ -17,10 +17,11 @@
   "bin": {
     "hap": "cli/hap.js",
     "json": "cli/json.js",
+    "sysinfo": "cli/sysinfo.js",
     "upnp": "cli/upnp.js"
   },
   "engines": {
-    "homebridge": "^1.3.6",
+    "homebridge": "^1.3.8",
     "node": "^16.13.0"
   },
   "dependencies": {