homebridge-lib 6.3.18 → 6.4.0

package/index.js

@@ -238,6 +238,15 @@ class homebridgeLib {
     * @memberof module:homebridgeLib
     */
   static get semver () { return hbLibTools.semver }
+
+  /** Return the recommended version of NodeJS from package.json.
+    * This is the version used to develop and test the software,
+    * typically the latest LTS version.
+    * @param {string} packageJson - The contents of package.json
+    * #return {string} - The recommended version.
+    * @memberof module:hbLibTools
+    */
+  static get recommendedNodeVersion () { return hbLibTools.recommendedNodeVersion }
 }
 
 module.exports = homebridgeLib

package/lib/Platform.js

@@ -7,7 +7,7 @@
 
 const homebridgeLib = require('../index')
 const {
-  HttpClient, SystemInfo, UpnpClient, formatError, semver
+  HttpClient, SystemInfo, UpnpClient, formatError, recommendedNodeVersion, semver
 } = homebridgeLib
 
 const events = require('events')
@@ -25,8 +25,7 @@ const context = {
   libName: libPackageJson.name,
   libVersion: libPackageJson.version,
   nodeVersion: process.version.slice(1),
-  recommendedNodeVersion:
-    semver.minVersion(libPackageJson.engines.node).toString(),
+  recommendedNodeVersion: recommendedNodeVersion(libPackageJson),
   recommendedHomebridgeVersion:
     semver.minVersion(libPackageJson.engines.homebridge).toString(),
   saveInterval: 3600,
@@ -354,7 +353,7 @@ class Platform extends homebridgeLib.Delegate {
     )
     if (context.nodeVersion !== context.recommendedNodeVersion) {
       this.warn(
-        'recommended version: node v%s LTS', context.recommendedNodeVersion
+        'recommended version: node v%s', context.recommendedNodeVersion
       )
     }
     if (context.homebridgeVersion !== context.recommendedHomebridgeVersion) {
@@ -460,6 +459,10 @@ class Platform extends homebridgeLib.Delegate {
       * @event Platform#accessoryRestored
       * @param {!string} className - The name of the
       * {@link AccessoryDelegate#className class} of the accessory delegate.
+      * @param {!string} version - The version of the plugin that stored the
+      * cached accessory.
+      * @param {!string} id - The accessory ID.
+      * @param {!string} name - The accessory name.
       * @param {object} context - The accessory
       * {@link AccessoryDelegate#context context}.
       */

package/lib/ServiceDelegate/Battery.js

@@ -17,9 +17,18 @@ const { ServiceDelegate } = require('../../index')
   * `name`             | `Characteristics.hap.Name`             |
   * `batteryLevel`     | `Characteristics.hap.BatteryLevel`     | Y
   * `chargingState`    | `Characteristics.hap.ChargingState`    | Y
-  * `statusLowBattery` | `Characteristics.hap.StatusLowBattery` | Y
+  * `statusLowBattery` | `Characteristics.hap.StatusLowBattery` |
   * `lowBatteryThreshold`| `Characteristics.my.LowBatteryThreshold` | Y
   *
+  * Depending on the capabilities of the device, the `Battery` service should
+  * be configured:
+  * - With only `statusLowBattery`, for devices that only report status low
+  * battery;
+  * - With `statusLowBattery` and `batteryLevel`, for devices that report both
+  * battery level and status low battery;
+  * - With `statusLowBattery`, `batteryLevel`, and `lowBatteryThreshold`, for
+  * devices that only report battery level.
+  *
   * @extends ServiceDelegate
   * @memberof ServiceDelegate
   */
@@ -29,47 +38,58 @@ class Battery extends ServiceDelegate {
     * corresponding HomeKit accessory.
     * @param {object} params - The parameters for the
     * _AccessoryInformation_ HomeKit service.
-    * @param {integer} [params.batteryLevel=100] - Initial value for
+    * @param {?integer} [params.batteryLevel=100] - Initial value for
     * `Characteristics.hap.BatteryLevel`.
-    * @param {integer} [params.chargingState=NOT_CHARGEABLE] - Initial value for
+    * <br>When set to `undefined`, the `BatteryLevel` characteristic is not exposed.
+    * @param {?integer} [params.chargingState=NOT_CHARGING] - Initial value for
     * `Characteristics.hap.ChargingState`.
+    * <br>When set to `undefined`, the `ChargingState` characteristic is not exposed.
     * @param {integer} [params.statusLowBattery=BATTERY_LEVEL_NORMAL] - Initial
     * value for `Characteristics.hap.StatusLowBattery`.
-    * @param {integer} [params.lowBatteryThreshold=20] - Initial value for
+    * @param {?integer} [params.lowBatteryThreshold=20] - Initial value for
     * low battery threshold.
+    * <br>When set to `undefined`, the value of `StatusLowBattery` is not derived
+    * from the value of `BatteryLevel`.
     */
   constructor (accessoryDelegate, params = {}) {
     params.name = accessoryDelegate.name + ' Battery'
     params.Service = accessoryDelegate.Services.hap.BatteryService
     super(accessoryDelegate, params)
-    this.addCharacteristicDelegate({
-      key: 'batteryLevel',
-      Characteristic: this.Characteristics.hap.BatteryLevel,
-      unit: '%',
-      value: params.batteryLevel ?? 100
-    }).on('didSet', (value) => {
-      this.updateStatusLowBattery()
-    })
-    this.addCharacteristicDelegate({
-      key: 'chargingState',
-      Characteristic: this.Characteristics.hap.ChargingState,
-      value: params.chargingState ??
-        this.Characteristics.hap.ChargingState.NOT_CHARGEABLE
-    })
+    if (params.batteryLevel !== undefined) {
+      this.addCharacteristicDelegate({
+        key: 'batteryLevel',
+        Characteristic: this.Characteristics.hap.BatteryLevel,
+        unit: '%',
+        value: params.batteryLevel ?? 100
+      }).on('didSet', (value) => {
+        this.updateStatusLowBattery()
+      })
+    }
+    if (params.chargingState !== undefined) {
+      this.addCharacteristicDelegate({
+        key: 'chargingState',
+        Characteristic: this.Characteristics.hap.ChargingState,
+        value: params.chargingState ??
+          this.Characteristics.hap.ChargingState.NOT_CHARGING
+          // this.Characteristics.hap.ChargingState.NOT_CHARGEABLE
+      })
+    }
     this.addCharacteristicDelegate({
       key: 'statusLowBattery',
       Characteristic: this.Characteristics.hap.StatusLowBattery,
       value: params.statusLowBattery ??
         this.Characteristics.hap.StatusLowBattery.BATTERY_LEVEL_NORMAL
     })
-    this.addCharacteristicDelegate({
-      key: 'lowBatteryThreshold',
-      // Characteristic: this.Characteristics.my.LowBatteryThreshold,
-      unit: '%',
-      value: params.lowBatteryThreshold ?? 20
-    }).on('didSet', (value) => {
-      this.updateStatusLowBattery()
-    })
+    if (params.lowBatteryThreshold !== undefined) {
+      this.addCharacteristicDelegate({
+        key: 'lowBatteryThreshold',
+        // Characteristic: this.Characteristics.my.LowBatteryThreshold,
+        unit: '%',
+        value: params.lowBatteryThreshold ?? 20
+      }).on('didSet', (value) => {
+        this.updateStatusLowBattery()
+      })
+    }
 
     accessoryDelegate.propertyDelegate('name')
       .on('didSet', (value) => {

package/package.json

@@ -3,7 +3,7 @@
   "description": "Library for homebridge plugins",
   "author": "Erik Baauw",
   "license": "Apache-2.0",
-  "version": "6.3.18",
+  "version": "6.4.0",
   "keywords": [
     "homekit",
     "homebridge"
@@ -22,11 +22,11 @@
   },
   "engines": {
     "homebridge": "^1.6.1",
-    "node": "^18.16.1"
+    "node": "18.17.0||^18||^16"
   },
   "dependencies": {
     "@homebridge/plugin-ui-utils": "~0.0.19",
-    "hb-lib-tools": "~1.0.10"
+    "hb-lib-tools": "~1.0.11"
   },
   "scripts": {
     "prepare": "standard && rm -rf out && jsdoc -c jsdoc.json",