homebridge-lib 5.1.22 → 5.1.24-2

package/README.md

@@ -13,7 +13,7 @@
 </span>
 
 ## Library for Homebridge Plugins
-Copyright © 2018-2021 Erik Baauw. All rights reserved.
+Copyright © 2018-2022 Erik Baauw. All rights reserved.
 
 While developing a number of [Homebridge](https://github.com/homebridge/homebridge) plugins, I find myself duplicating a lot of code.
 The idea behind this library is to ease developing and maintaining Homebridge plugins by separating this generic code, dealing with [HomeKit](http://www.apple.com/ios/home/) and Homebridge, from the specific code, dealing with the actual devices being exposed to HomeKit.

package/cli/hap.js

@@ -3,7 +3,7 @@
 // homebridge-lib/cli/hap.js
 //
 // Library for Homebridge plugins.
-// Copyright © 2018-2021 Erik Baauw. All rights reserved.
+// Copyright © 2018-2022 Erik Baauw. All rights reserved.
 //
 // Logger for HomeKit accessory announcements.
 

package/cli/json.js

@@ -3,7 +3,7 @@
 // homebridge-lib/cli/json.js
 //
 // Library for Homebridge plugins.
-// Copyright © 2018-2021 Erik Baauw. All rights reserved.
+// Copyright © 2018-2022 Erik Baauw. All rights reserved.
 //
 // JSON formatter.
 

package/cli/sysinfo.js

@@ -3,7 +3,7 @@
 // homebridge-lib/cli/sysinfo.js
 //
 // Library for Homebridge plugins.
-// Copyright © 2021 Erik Baauw. All rights reserved.
+// Copyright © 2021-2022 Erik Baauw. All rights reserved.
 //
 // Show system info.
 

package/cli/upnp.js

@@ -3,7 +3,7 @@
 // homebridge-lib/cli/upnp.js
 //
 // Library for Homebridge plugins.
-// Copyright © 2018-2021 Erik Baauw. All rights reserved.
+// Copyright © 2018-2022 Erik Baauw. All rights reserved.
 //
 // Logger for UPnP device announcements.
 

package/index.js

@@ -1,7 +1,7 @@
 // homebridge-lib/index.js
 //
 // Library for Homebridge plugins.
-// Copyright © 2017-2021 Erik Baauw. All rights reserved.
+// Copyright © 2017-2022 Erik Baauw. All rights reserved.
 
 'use strict'
 

package/lib/AccessoryDelegate.js

@@ -1,7 +1,7 @@
 // homebridge-lib/lib/AccessoryDelegate.js
 //
 // Library for Homebridge plugins.
-// Copyright © 2017-2021 Erik Baauw. All rights reserved.
+// Copyright © 2017-2022 Erik Baauw. All rights reserved.
 
 'use strict'
 
@@ -103,8 +103,7 @@ class AccessoryDelegate extends homebridgeLib.Delegate {
 
   // Remove associated accessory from platform
   destroy () {
-    this.removeAllListeners('heartbeat')
-    this.removeAllListeners('shutdown')
+    this.removeAllListeners()
     this._platform._removeAccessory(this._accessory)
   }
 

package/lib/AdaptiveLighting.js

@@ -1,7 +1,7 @@
 // homebridge-lib/lib/AdaptiveLighting.js
 //
 // Library for Homebridge plugins.
-// Copyright © 2020-2021 Erik Baauw. All rights reserved.
+// Copyright © 2020-2022 Erik Baauw. All rights reserved.
 
 'use strict'
 

package/lib/CharacteristicDelegate.js

@@ -1,7 +1,7 @@
 // homebridge-lib/lib/CharacteristicDelegate.js
 //
 // Library for Homebridge plugins.
-// Copyright © 2017-2021 Erik Baauw. All rights reserved.
+// Copyright © 2017-2022 Erik Baauw. All rights reserved.
 
 'use strict'
 

package/lib/Colour.js

@@ -1,7 +1,7 @@
 // homebridge-lib/lib/Colour.js
 //
 // Library for Homebridge plugins.
-// Copyright © 2016-2021 Erik Baauw. All rights reserved.
+// Copyright © 2016-2022 Erik Baauw. All rights reserved.
 
 'use strict'
 

package/lib/CommandLineParser.js

@@ -1,7 +1,7 @@
 // homebridge-lib/lib/CommandLineParser.js
 //
 // Library for Homebridge plugins.
-// Copyright © 2017-2021 Erik Baauw. All rights reserved.
+// Copyright © 2017-2022 Erik Baauw. All rights reserved.
 
 // TODO:
 // - Change parameters to (params, callback) with:

package/lib/CommandLineTool.js

@@ -1,7 +1,7 @@
 // homebridge-lib/lib/CommandLineUtility.js
 //
 // Library for Homebridge plugins.
-// Copyright © 2018-2021 Erik Baauw. All rights reserved.
+// Copyright © 2018-2022 Erik Baauw. All rights reserved.
 
 'use strict'
 

package/lib/CustomHomeKitTypes.js

@@ -1,7 +1,7 @@
 // homebridge-lib/lib/CustomeHomeKitTypes.js
 //
 // Library for Homebridge plugins.
-// Copyright © 2017-2021 Erik Baauw. All rights reserved.
+// Copyright © 2017-2022 Erik Baauw. All rights reserved.
 
 const regExps = {
   uuid: /^[0-9A-F]{8}-[0-9A-F]{4}-[1-5][0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$/,

package/lib/Delegate.js

@@ -1,7 +1,7 @@
 // homebridge-lib/lib/Delegate.js
 //
 // Library for Homebridge plugins.
-// Copyright © 2017-2021 Erik Baauw. All rights reserved.
+// Copyright © 2017-2022 Erik Baauw. All rights reserved.
 
 'use strict'
 

package/lib/EveHomeKitTypes.js

@@ -1,7 +1,7 @@
 // homebridge-lib/lib/EveHomeKitTypes.js
 //
 // Library for Homebridge plugins.
-// Copyright © 2017-2021 Erik Baauw. All rights reserved.
+// Copyright © 2017-2022 Erik Baauw. All rights reserved.
 
 const homebridgeLib = require('../index')
 

package/lib/HttpClient.js

@@ -1,7 +1,7 @@
 // homebridge-lib/lib/HttpClient.js
 //
 // Library for Homebridge plugins.
-// Copyright © 2018-2021 Erik Baauw. All rights reserved.
+// Copyright © 2018-2022 Erik Baauw. All rights reserved.
 
 'use strict'
 
@@ -19,8 +19,7 @@ const https = require('https')
 class HttpError extends Error {
   constructor (message, request, statusCode, statusMessage) {
     super(message)
-    /** @member {HttpRequest} - The request that caused the error.
-      * See {@link HttpClient.HttpRequest HttpRequest}.
+    /** @member {HttpClient.HttpRequest} - The request that caused the error.
       */
     this.request = request
 
@@ -76,8 +75,7 @@ class HttpRequest {
   */
 class HttpResponse {
   constructor (request, statusCode, statusMessage, headers, body, parsedBody) {
-    /** @member {HttpRequest} - The request that generated the response.
-      * See {@link HttpClient.HttpRequest HttpRequest}.
+    /** @member {HttpClient.HttpRequest} - The request that generated the response.
       */
     this.request = request
 
@@ -423,7 +421,8 @@ class HttpClient extends events.EventEmitter {
                 request: requestInfo,
                 headers: response.headers,
                 statusCode: response.statusCode,
-                statusMessage: response.statusMessage
+                statusMessage: response.statusMessage,
+                body: null
               }
               if (buffer != null && buffer.length > 0) {
                 responseInfo.body = buffer

package/lib/JsonFormatter.js

@@ -1,7 +1,7 @@
 // homebridge-lib/lib/JsonFormatter.js
 //
 // Library for Homebridge plugins.
-// Copyright © 2018-2021 Erik Baauw. All rights reserved.
+// Copyright © 2018-2022 Erik Baauw. All rights reserved.
 
 'use strict'
 

package/lib/MyHomeKitTypes.js

@@ -1,7 +1,7 @@
 // homebridge-lib/lib/MyHomeKitTypes.js
 //
 // Library for Homebridge plugins.
-// Copyright © 2017-2021 Erik Baauw. All rights reserved.
+// Copyright © 2017-2022 Erik Baauw. All rights reserved.
 //
 // My own collection of custom HomeKit Services and Characteristics.
 
@@ -83,6 +83,8 @@ class MyHomeKitTypes extends homebridgeLib.CustomHomeKitTypes {
       * <br>Used by: homebridge-hue.
       * @property {Class} Enabled - Enable/disable service.
       * <br>Used by: homebridge-hue.
+      * @property {Class} Expose - Expose to HomeKit.
+      * <br>Used by: homebridge-deconz.
       * @property {Class} Heartrate - Refresh rate.
       * <br>Used by: homebridge-hue in HueBridge service,
       * by Homebridge-soma, by Homebridge-rpi, by Homebridge-ws.
@@ -191,6 +193,8 @@ class MyHomeKitTypes extends homebridgeLib.CustomHomeKitTypes {
       * for lights.
       * @property {Class} Unlatch - Unlatch the door.
       * <br>Used by: homebridge-nb in the Smart Lock service.
+      * @property {Class} Unlock - Unlock gateway
+      * <br>Used by: homebridge-deconz.
       * @property {Class} WaterPressure - Water pressure (in bar) of the central
       * heating system.
       * <br>Used by: homebridge-otgw.
@@ -698,6 +702,18 @@ class MyHomeKitTypes extends homebridgeLib.CustomHomeKitTypes {
       perms: [this.Perms.READ, this.Perms.NOTIFY, this.Perms.WRITE]
     }, 'Position Change')
 
+    this.createCharacteristicClass('Unlock', uuid('077'), {
+      format: this.Formats.BOOL,
+      perms: [this.Perms.READ, this.Perms.NOTIFY, this.Perms.WRITE],
+      adminOnlyAccess: [this.Access.WRITE]
+    })
+
+    this.createCharacteristicClass('Expose', uuid('078'), {
+      format: this.Formats.BOOL,
+      perms: [this.Perms.READ, this.Perms.NOTIFY, this.Perms.WRITE],
+      adminOnlyAccess: [this.Access.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
@@ -726,6 +742,11 @@ class MyHomeKitTypes extends homebridgeLib.CustomHomeKitTypes {
     /** @member MyHomeKitTypes#Services
       * @property {Class} Alarm - Service for an alarm clock.
       * <br>Used by: homebridge-zp.
+      * @property {Class} DeconzGateway - Service for deCONZ gateway config.
+      * <br>Used by homebridge-deconz.
+      * @property {Class} DeconzDevice - Service for config of device exposed
+      * by deCONZ gateway.
+      * <br>Used by homebridge-deconz.
       * @property {Class} HueBridge - Service for a Hue bridge.
       * <br>Used by: homebridge-hue for a Hue bridge or deCONZ gateway.
       * @property {Class} Resource - Generic service for resource.
@@ -760,6 +781,22 @@ class MyHomeKitTypes extends homebridgeLib.CustomHomeKitTypes {
       this.Characteristics.Status
     ])
 
+    this.createServiceClass('DeconzGateway', uuid('014'), [
+      this.Characteristics.LogLevel,
+      this.Characteristics.Expose,
+      this.Characteristics.Heartrate,
+      this.Characteristics.LastUpdated,
+      this.Characteristics.Restart,
+      this.Characteristics.Search,
+      this.Characteristics.TransitionTime,
+      this.Characteristics.Unlock
+    ])
+
+    this.createServiceClass('DeconzDevice', uuid('015'), [
+      this.Characteristics.Expose,
+      this.Characteristics.Resource
+    ])
+
     this.createServiceClass('Alarm', uuid('048'), [
       this.Characteristics.Enabled,
       this.Characteristics.CurrentTrack,

package/lib/OptionParser.js

@@ -1,7 +1,7 @@
 // homebridge-lib/lib/OptionParser.js
 //
 // Library for Homebridge plugins.
-// Copyright © 2018-2021 Erik Baauw. All rights reserved.
+// Copyright © 2018-2022 Erik Baauw. All rights reserved.
 
 'use strict'
 

package/lib/Platform.js

@@ -1,7 +1,7 @@
 // homebridge-lib/lib/Platform.js
 //
 // Library for Homebridge plugins.
-// Copyright © 2017-2021 Erik Baauw. All rights reserved.
+// Copyright © 2017-2022 Erik Baauw. All rights reserved.
 
 'use strict'
 
@@ -454,7 +454,8 @@ class Platform extends homebridgeLib.Delegate {
     const id = accessory.context.id
     const name = accessory.context.name
     const context = accessory.context.context
-    this.debug('%s: cached %s v%s %s: %j', name, className, version, id, context)
+    this.debug('%s: cached %s v%s %s', name, className, version, id)
+    this.vdebug('%s: cached %s v%s %s: %j', name, className, version, id, context)
     this._accessories[id] = accessory
     // Fix homebridge overwrites firmware with package version.
     const uuid = this.Services.hap.AccessoryInformation.UUID
@@ -511,7 +512,20 @@ class Platform extends homebridgeLib.Delegate {
             )
           }
         } catch (error) {
-          this.error(error)
+          this.warn(error)
+          try {
+            // Make sure the accessory won't be persisted, since it will fail
+            // to be exposed again on restore, causing `configureAccessory()`
+            // not to be called.
+            this._homebridge.unregisterPlatformAccessories(
+              this._pluginName, this._platformName, [accessory]
+            )
+          } catch (error) {}
+          /** Emitted when associated accessory could not be exposed.
+            * @event AccessoryDelegate#exposeError
+            * @param {Error} error - The error trying to expose the accessory.
+            */
+          delegate.emit('exposeError', error)
         }
       })
     } else {
@@ -538,14 +552,16 @@ class Platform extends homebridgeLib.Delegate {
       this.debug('remove history file %s', historyFile)
       fs.unlink(historyFile, (error) => {
         if (error) {
-          this.error(error)
+          this.warn(error)
         }
       })
     }
     this.debug('%s: remove %s %s', name, className, id)
-    this._homebridge.unregisterPlatformAccessories(
-      this._pluginName, this._platformName, [accessory]
-    )
+    try {
+      this._homebridge.unregisterPlatformAccessories(
+        this._pluginName, this._platformName, [accessory]
+      )
+    } catch (error) { this.warn(error) }
     delete this._accessoryDelegates[id]
     delete this._accessories[id]
   }

package/lib/ServiceDelegate.js

@@ -1,7 +1,7 @@
 // homebridge-lib/lib/ServiceDelegate.js
 //
 // Library for Homebridge plugins.
-// Copyright © 2017-2021 Erik Baauw. All rights reserved.
+// Copyright © 2017-2022 Erik Baauw. All rights reserved.
 //
 // The logic for handling Eve history was copied from Simone Tisa's
 // fakagato-history repository, copyright © 2017 simont77.
@@ -401,14 +401,14 @@ class AccessoryInformation extends ServiceDelegate {
       Characteristic: this.Characteristics.hap.FirmwareRevision,
       value: params.firmware
     })
-    if (params.hardware != null) {
+    if (params.hardware != null || this._context.hardware != null) {
       this.addCharacteristicDelegate({
         key: 'hardware',
         Characteristic: this.Characteristics.hap.HardwareRevision,
         value: params.hardware
       })
     }
-    if (params.software != null) {
+    if (params.software != null || this._context.software != null) {
       this.addCharacteristicDelegate({
         key: 'software',
         Characteristic: this.Characteristics.hap.SoftwareRevision,

package/lib/SystemInfo.js

@@ -1,7 +1,7 @@
 // homebridge-lib/lib/SystemInfo.js
 //
 // Library for Homebridge plugins.
-// Copyright © 2019-2021 Erik Baauw. All rights reserved.
+// Copyright © 2019-2022 Erik Baauw. All rights reserved.
 
 'use strict'
 

package/lib/UpnpClient.js

@@ -1,7 +1,7 @@
 // homebridge-lib/lib/UpnpClient.js
 //
 // Library for Homebridge plugins.
-// Copyright © 2018-2021 Erik Baauw. All rights reserved.
+// Copyright © 2018-2022 Erik Baauw. All rights reserved.
 
 'use strict'
 

package/package.json

@@ -3,7 +3,7 @@
   "description": "Library for homebridge plugins",
   "author": "Erik Baauw",
   "license": "Apache-2.0",
-  "version": "5.1.22",
+  "version": "5.1.24-2",
   "keywords": [
     "homekit",
     "homebridge"
@@ -21,7 +21,7 @@
     "upnp": "cli/upnp.js"
   },
   "engines": {
-    "homebridge": "^1.3.8",
+    "homebridge": "^1.3.9",
     "node": "^16.13.1"
   },
   "dependencies": {