homebridge-lib 8.0.0 → 8.1.0

package/lib/AccessoryDelegate.js

@@ -249,11 +249,6 @@ class AccessoryDelegate extends Delegate {
 
   set heartbeatEnabled (value) { this._heartbeatEnabled = !!value }
 
-  setAlive () {
-    this.warn('setAlive() has been deprecated, use heartbeatEnabled instead')
-    this._heartbeatEnabled = true
-  }
-
   /** Plugin-specific context to be persisted across Homebridge restarts.
     *
     * After restart, this object is passed back to the plugin through the

package/lib/MdnsClient.js

@@ -0,0 +1,12 @@
+// homebridge-lib/lib/MdnsClient.js
+//
+// Library for Homebridge plugins.
+// Copyright © 2020-2026 Erik Baauw. All rights reserved.
+
+/** Multicat DNS (Bonjour) client.
+  * <br>See {@link MdnsClient}.
+  * @name MdnsClient
+  * @type {Class}
+  * @memberof module:homebridge-lib
+  */
+export { MdnsClient } from 'hb-lib-tools/MdnsClient'

package/lib/Platform.js

@@ -5,14 +5,11 @@
 
 import { once } from 'node:events'
 import { writeFile, unlink } from 'node:fs/promises'
-import { Server, STATUS_CODES } from 'node:http'
 import { createRequire } from 'node:module'
 import { format, promisify } from 'node:util'
-import zlib from 'node:zlib'
 
 import { HttpClient } from 'hb-lib-tools/HttpClient'
 import { SystemInfo } from 'hb-lib-tools/SystemInfo'
-import { UpnpClient } from 'hb-lib-tools/UpnpClient'
 
 import { Delegate } from 'homebridge-lib/Delegate'
 import { EveHomeKitTypes } from 'homebridge-lib/EveHomeKitTypes'
@@ -25,15 +22,16 @@ const require = createRequire(import.meta.url)
 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 = promisify(zlib.gzip)
+
+let gzip
 
 const context = {
   libName: libPackageJson.name,
   libVersion: libPackageJson.version,
   nodeVersion: process.version.slice(1),
   recommendedNodeVersion: recommendedNodeVersion(libPackageJson),
-  // recommendedHomebridgeVersion:
-  //   semver.minVersion(libPackageJson.engines.homebridge).toString(),
+  recommendedHomebridgeVersion:
+    semver.minVersion(libPackageJson.engines.homebridge).toString(),
   saveInterval: 3600,
   checkInterval: 7 * 24 * 3600,
   driftDebugThreshold: 250,
@@ -80,8 +78,8 @@ class Platform extends Delegate {
       context.homebridge = homebridge
       context.homebridgeVersion = homebridge.serverVersion
       context.PlatformAccessory = homebridge.platformAccessory
-      context.recommendedHomebridgeVersion =
-        semver.minVersion(libPackageJson.engines.homebridge).toString()
+      // context.recommendedHomebridgeVersion =
+      //   semver.minVersion(libPackageJson.engines.homebridge).toString()
 
       const hap = {
         Services: {},
@@ -178,52 +176,41 @@ class Platform extends Delegate {
       )
     }
     this._myContext.platform = this
-    this._identify()
+    this.#identify()
 
     this._homebridge
-      .on('didFinishLaunching', this._main.bind(this))
-      .on('shutdown', this._shutdown.bind(this))
-    process.on('exit', this._exit.bind(this))
+      .on('didFinishLaunching', this.#main.bind(this))
+      .on('shutdown', this.#shutdown.bind(this))
+    process.on('exit', () => { this.log('goodbye') })
   }
 
   // ===== Main ================================================================
 
   // Main platform function.
   // Called by homebridge after restoring accessories from cache.
-  async _main () {
+  async #main () {
     /** System information.
       * @type {SystemInfo}
       * @readonly
       */
-    this.systemInfo = new 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) })
+    this.systemInfo = new SystemInfo({ logger: this })
     await this.systemInfo.init()
     this.log('hardware: %s', this.systemInfo.hwInfo.prettyName)
     this.log('os: %s', this.systemInfo.osInfo.prettyName)
     this._heartbeatStart = new Date()
-    setTimeout(() => { this._beat(-1) }, 1000)
-    this.on('exit', () => { this._flushCachedAccessories() })
+    setTimeout(() => { this.#beat(-1) }, 1000)
 
     const n = Object.keys(this._accessories).length
     if (n > 0) {
       this.log('restored %d accessories from cache', n)
     }
-    if (this.listenerCount('upnpDeviceAlive') > 0) {
-      this._upnpMonitor.listen()
-    }
-    if (this.listenerCount('upnpDeviceFound') > 0) {
-      this._upnpMonitor.search()
-    }
     if (typeof this.onUiRequest === 'function') {
       try {
-        await this._createUiServer()
+        await this.#createUiServer()
       } catch (error) { this.error(error) }
     }
     await once(this, 'initialised')
-    this._flushCachedAccessories()
+    this.#flushCachedAccessories()
     for (const id in this._accessories) {
       if (this._accessoryDelegates[id] == null) {
         const accessory = this._accessories[id]
@@ -253,6 +240,10 @@ class Platform extends Delegate {
     * @param {*} dumpInfo - Plugin-specific information.
     */
   async createDumpFile (dumpInfo = {}) {
+    if (gzip == null) {
+      const zlib = await import('node:zlib')
+      gzip = promisify(zlib.gzip)
+    }
     const result = {
       hardware: this.systemInfo.hwInfo.prettyName,
       os: this.systemInfo.osInfo.prettyName,
@@ -274,13 +265,13 @@ class Platform extends Delegate {
   }
 
   // Write `cachedAccessories` to disk.
-  _flushCachedAccessories () {
+  #flushCachedAccessories () {
     this.debug('flush cachedAccessories')
     this._homebridge.updatePlatformAccessories([])
   }
 
   // Called every second.
-  _beat (beat) {
+  #beat (beat) {
     beat += 1
     const drift = new Date() - this._heartbeatStart - 1000 * (beat + 1)
     if (this._shuttingDown) {
@@ -295,16 +286,16 @@ class Platform extends Delegate {
       }
     }
     setTimeout(() => {
-      this._beat(beat)
+      this.#beat(beat)
     }, drift < 1000 ? 1000 - drift : 1)
 
     if (beat % context.saveInterval === 30) {
-      this._flushCachedAccessories()
+      this.#flushCachedAccessories()
     }
 
     if (beat % context.checkInterval === 0) {
-      this._checkLatest(this._pluginName, this._pluginVersion)
-      // this._checkLatest(context.libName, context.libVersion)
+      this.#checkLatest(this._pluginName, this._pluginVersion)
+      // this.#checkLatest(context.libName, context.libVersion)
     }
 
     /** Emitted every second.
@@ -324,46 +315,47 @@ class Platform extends Delegate {
   }
 
   // Called by homebridge when shutting down.
-  _shutdown () {
+  async #shutdown () {
     if (this._shuttingDown) {
       return
     }
     this._shuttingDown = true
-    this.removeAllListeners('upnpDeviceAlive')
-    this.removeAllListeners('upnpDeviceFound')
     if (this._ui?.abortController != null) {
       this._ui.abortController.abort()
     }
+    const jobs = []
     for (const id in this._accessoryDelegates) {
       /** Emitted when Homebridge is shutting down.
         *
-        * On receiving this event, the plugin should cleanup (close connections,
-        * flush peristent storage, ...).
+        * On receiving this event, the accessory delegate should cleanup
+        * (close connections, flush peristent storage, ...).
         * @event AccessoryDelegate#shutdown
         */
       this._accessoryDelegates[id].emit('shutdown')
+      if (typeof this._accessoryDelegates[id].shutdown === 'function') {
+        jobs.push(this._accessoryDelegates[id].shutdown())
+      }
     }
     /** Emitted when Homebridge is shutting down.
       *
-      * On receiving this event, the plugin should cleanup (close connections,
-      * flush peristent storage, ...).
+      * On receiving this event, the plugin should cleanup
+      * (close connections, flush peristent storage, ...).
       * @event Platform#shutdown
       */
     this.emit('shutdown')
-  }
-
-  // Called by NodeJS when process is exiting.
-  _exit () {
-    /** Emitted when Homebridge is exiting.
-      *
-      * Note: asynchronous calls made when handling this event will not be executed.
-      * @event Platform#exit
-      */
-    this.emit('exit')
+    if (typeof this.shutdown === 'function') {
+      jobs.push(this.shutdown())
+    }
+    for (const job of jobs) {
+      try {
+        await job
+      } catch (error) { this.warn(error) }
+    }
+    this.#flushCachedAccessories()
   }
 
   // Issue an identity message.
-  _identify () {
+  #identify () {
     this.log(
       '%s v%s, node v%s, homebridge v%s, %s v%s',
       this._pluginName, this._pluginVersion, context.nodeVersion,
@@ -388,7 +380,7 @@ class Platform extends Delegate {
   }
 
   // Check the NPM registry for the latest version of this plugin.
-  async _checkLatest (name, version) {
+  async #checkLatest (name, version) {
     try {
       if (this.npmRegistry == null) {
         this.npmRegistry = new HttpClient({
@@ -534,60 +526,6 @@ class Platform extends Delegate {
     delete this._accessories[id]
   }
 
-  // ===== UPnP Device Discovery ===============================================
-
-  /** Configure UPnP discovery.
-    *
-    * @param {!object} config - ...
-    * @param {?string} config.class - Filter on UPnP device class.
-    * Default `upnp:rootdevice`.  Use `ssdp:all` for all device classes.
-    * @param {?string} config.host - UPnP address and port.
-    * Default: `239.255.255.250:1900`.
-    * @param {function} config.filter - Filter on UPnP message content.
-    * The function takes the message as argument and returns a boolean.
-    * Default: `(message) => { return true }`, return all messages.
-    * @param {integer} config.timeout - Timeout (in seconds) for UPnP search.
-    * Default: `5`.
-    */
-  upnpConfig (config) {
-    if (this._upnpMonitor != null) {
-      throw new SyntaxError('upnpConfig(): already called')
-    }
-    this._upnpMonitor = new UpnpClient(config)
-    this._upnpMonitor
-      .on('error', (error) => {
-        this.error('upnp: error')
-        this.error(error)
-      })
-      .on('listening', (host) => {
-        this.debug('upnp: listening on %s', host)
-      })
-      .on('searching', (host) => {
-        this.debug('upnp: searching on %s', host)
-      })
-      .on('searchDone', () => {
-        this.debug('upnp: search done')
-      })
-      .on('deviceAlive', (address, message) => {
-        // this.debug('upnp: device %s is alive: %j', address, message)
-        /** Emitted when a UPnP device sends an alive message.
-          * @event Platform#upnpDeviceAlive
-          * @param {string} address - The device's IP address.
-          * @param {object} message - The contents of the alive message.
-          */
-        this.emit('upnpDeviceAlive', address, message)
-      })
-      .on('deviceFound', (address, message) => {
-        // this.debug('upnp: found device %s: %j', address, message)
-        /** Emitted when a UPnP device responds to a search request.
-          * @event Platform#upnpDeviceFound
-          * @param {string} address - The device's IP address.
-          * @param {object} message - The contents of the search response message.
-          */
-        this.emit('upnpDeviceFound', address, message)
-      })
-  }
-
   // ===== Dynamic Configuration through Homebridge UI =========================
 
   /** Handler for requests from the Homebridge Plugin UI Server.
@@ -601,7 +539,8 @@ class Platform extends Delegate {
     */
 
   // Create HTTP server for Homebridge Plugin UI Settings.
-  async _createUiServer () {
+  async #createUiServer () {
+    const { Server, STATUS_CODES } = await import('node:http')
     this._ui = {}
     this._ui.server = new Server()
     this._ui.server

package/package.json

@@ -6,7 +6,7 @@
     "ebaauw"
   ],
   "license": "Apache-2.0",
-  "version": "8.0.0",
+  "version": "8.1.0",
   "keywords": [
     "homekit",
     "homebridge"
@@ -29,12 +29,12 @@
     "upnp": "cli/upnp.js"
   },
   "engines": {
-    "homebridge": "^1.11.4||^2.0.0-beta",
-    "node": "24.14.1||^24||^22||^20"
+    "homebridge": "^2.0.1",
+    "node": "24.15.0||^24||^22"
   },
   "dependencies": {
     "@homebridge/plugin-ui-utils": "~2.2.3",
-    "hb-lib-tools": "~3.0.0"
+    "hb-lib-tools": "~3.0.5"
   },
   "scripts": {
     "prepare": "standard && rm -rf out && jsdoc -c jsdoc.json",

package/lib/Bonjour.js

@@ -1,12 +0,0 @@
-// homebridge-lib/lib/Bonjour.js
-//
-// Library for Homebridge plugins.
-// Copyright © 2020-2026 Erik Baauw. All rights reserved.
-
-/** Return the `Bonjour` class from [`bonjour-hap`](https://github.com/homebridge/bonjour),
-  * so plugins don't have to list this as a separate dependency.
-  * @name Bonjour
-  * @type {Class}
-  * @memberof module:homebridge-lib
-  */
-export { Bonjour } from 'hb-lib-tools/Bonjour'