homebridge-nb 1.2.1 → 1.2.5

package/README.md

@@ -16,7 +16,7 @@
 </span>
 
 ## Homebridge plugin for Nuki Bridge
-Copyright © 2020-2021 Erik Baauw. All rights reserved.
+Copyright © 2020-2022 Erik Baauw. All rights reserved.
 
 This [Homebridge](https://github.com/homebridge/homebridge) plugin exposes
 [Nuki Smart Lock](https://nuki.io/nl/smart-lock/) and

package/cli/nb.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 // homebridge-nb/cli/nb.js
-// Copyright © 2020-2021 Erik Baauw. All rights reserved.
+// Copyright © 2020-2022 Erik Baauw. All rights reserved.
 //
 // Homebridge plug-in for Nuki Bridge.
 
@@ -27,6 +27,7 @@ const usage = {
   getlog: `${b('getlog')} [${b('-h')}]`,
   clearlog: `${b('clearlog')} [${b('-h')}]`,
   reboot: `${b('reboot')} [${b('-h')}]`,
+  fwupdate: `${b('fwupdate')} [${b('-h')}]`,
   list: `${b('list')} [${b('-h')}]`,
 
   lockState: `${b('lockState')} [${b('-h')}] ${u('nukiId')} ${u('deviceType')}`,
@@ -49,6 +50,7 @@ const description = {
   getlog: 'Get Nuki bridge log.',
   clearlog: 'Clear Nuki bridge log.',
   reboot: 'Reboot Nuki bridge.',
+  fwupdate: 'Trigger a firmware update of the bridge and connected devices.',
   list: 'Get list of paired Nuki devices.',
 
   lockState: 'Refresh state from paired Nuki device.',
@@ -77,10 +79,12 @@ Parameters:
   Print debug messages for communication with Nuki bridge.
 
   ${b('-H')} ${u('hostname')}[${b(':')}${u('port')}], ${b('--host=')}${u('hostname')}[${b(':')}${u('port')}]
-  Connect to ${u('hostname')}${b(':8080')} or ${u('hostname')}${b(':')}${u('port')}.
+  Connect to Nuki bridge at ${u('hostname')}${b(':8080')} or ${u('hostname')}${b(':')}${u('port')}.
+  You can also specify the hostname and port in the ${b('NB_HOST')} environment variable.
 
   ${b('-T')} ${u('token')}, ${b('--token=')}${u('token')}
-  Use ${u('token')} instead of the token saved in ${b('~/.nb')}.
+  Use token ${u('token')} to connect to the Nuki bridge.
+  You can also specify the token in the ${b('NB_TOKEN')} environment variable.
 
 Commands:
   ${usage.discover}
@@ -101,6 +105,9 @@ Commands:
   ${usage.reboot}
   ${description.reboot}
 
+  ${usage.fwupdate}
+  ${description.fwupdate}
+
   ${usage.list}
   ${description.list}
 
@@ -165,6 +172,13 @@ Parameters:
 
 Usage: ${usage.reboot}
 
+Parameters:
+  ${b('-h')}, ${b('--help')}
+  Print this help and exit.`,
+  fwupdate: `${description.fwupdate}
+
+Usage: ${usage.fwupdate}
+
 Parameters:
   ${b('-h')}, ${b('--help')}
   Print this help and exit.`,
@@ -188,8 +202,10 @@ Parameters:
 
   ${u('deviceType')}
   The type of the Nuki device (from ${b('nb list')}):
-    0: smartlock
-    2: opener`,
+    0: Smart Lock 1.0 or 2.0
+    2: Opener
+    3: Smart Door
+    4: Smart Lock 3.0`,
   lock: `${description.lock}
 
 Usage: ${usage.lock}
@@ -203,8 +219,10 @@ Parameters:
 
   ${u('deviceType')}
   The type of the Nuki device (from ${b('nb list')}):
-    0: smartlock
-    2: opener`,
+    0: Smart Lock 1.0 or 2.0
+    2: Opener
+    3: Smart Door
+    4: Smart Lock 3.0`,
   unlock: `${description.unlock}
 
 Usage: ${usage.unlock}
@@ -218,8 +236,10 @@ Parameters:
 
   ${u('deviceType')}
   The type of the Nuki device (from ${b('nb list')}):
-    0: smartlock
-    2: opener`,
+    0: Smart Lock 1.0 or 2.0
+    2: Opener
+    3: Smart Door
+    4: Smart Lock 3.0`,
   lockAction: `${description.lockAction}
 
 Usage: ${usage.lockAction}
@@ -233,12 +253,14 @@ Parameters:
 
   ${u('deviceType')}
   The type of the Nuki device (from ${b('nb list')}):
-    0: smartlock
-    2: opener
+    0: Smart Lock 1.0 or 2.0
+    2: Opener
+    3: Smart Door
+    4: Smart Lock 3.0
 
   ${u('action')}
   The action to send to the Nuki device:
-      smartlock                opener
+      Smart Lock, Smart Door   Opener
     - ------------------------ -------------------------
     1 unlock                   activate rto
     2 lock                     deactivate rto
@@ -376,7 +398,7 @@ class Main extends homebridgeLib.CommandLineTool {
             args += ' -H ' + clargs.options.host
           }
           await this.fatal(
-            `Missing token.  Run ${b('nb' + args + ' auth')} and press bridge button.`
+            `Missing token.  Set ${b('NB_TOKEN')} or specify ${b('-T')}.  Run ${b('nb' + args + ' auth')} to obtain the token.`
           )
         }
       }
@@ -465,6 +487,12 @@ class Main extends homebridgeLib.CommandLineTool {
     this.print(this.jsonFormatter.stringify(response.body))
   }
 
+  async fwupdate (...args) {
+    this.parser.parse(...args)
+    const response = await this.client.fwupdate()
+    this.print(this.jsonFormatter.stringify(response.body))
+  }
+
   async list (...args) {
     this.parser.parse(...args)
     const response = await this.client.list()

package/config.schema.json

@@ -8,7 +8,7 @@
     "type": "object",
     "properties": {
       "name": {
-        "description": "Plugin name as displayed in the homebridge log.",
+        "description": "Plugin name as displayed in the Homebridge log.",
         "type": "string",
         "required": true,
         "default": "Nuki"
@@ -22,8 +22,7 @@
         "type": "integer",
         "maximum": 65535
       },
-      "timeout":
-      {
+      "timeout": {
         "description": "The timeout in seconds to wait for a response from a Nuki bridge.  Default: 15.",
         "type": "integer",
         "minimum": 1,

package/index.js

@@ -1,5 +1,5 @@
 // homebridge-nb/index.js
-// Copyright © 2020-2021 Erik Baauw. All rights reserved.
+// Copyright © 2020-2022 Erik Baauw. All rights reserved.
 //
 // Homebridge plug-in for Nuki Bridge.
 

package/lib/NbAccessory.js

@@ -1,5 +1,5 @@
 // homebridge-nb/lib/NbAccessory.js
-// Copyright © 2020-2021 Erik Baauw. All rights reserved.
+// Copyright © 2020-2022 Erik Baauw. All rights reserved.
 //
 // Homebridge plug-in for Nuki Bridge.
 
@@ -63,6 +63,7 @@ class Bridge extends homebridgeLib.AccessoryDelegate {
     this.doorSensors = {}
     this.openers = {}
     this.service = new NbService.Bridge(this)
+    this.manageLogLevel(this.service.characteristicDelegate('logLevel'))
     this.dummyService = new homebridgeLib.ServiceDelegate.Dummy(this)
 
     this.client = new NbClient({
@@ -133,6 +134,9 @@ class Bridge extends homebridgeLib.AccessoryDelegate {
   async init (beat) {
     try {
       await this.client.init()
+      this.values.firmware = this.client.firmware
+      this.context.firmware = this.values.firmware
+      // TODO firmware version check
     } catch (error) {
       return
     }
@@ -220,6 +224,9 @@ class Bridge extends homebridgeLib.AccessoryDelegate {
         await this.checkSubscription()
         let response = await this.client.info()
         this.debug('bridge: %j', response.body)
+        // this.values.firmware = response.body.versions.firmwareVersion
+        // this.context.firmware = this.values.firmware
+        // TODO firmware check
         this.service.update(response.body)
         response = await this.client.list()
         for (const device of response.body) {

package/lib/NbClient.js

@@ -1,5 +1,5 @@
 // homebridge-nb/lib/NbClient.js
-// Copyright © 2020-2021 Erik Baauw. All rights reserved.
+// Copyright © 2020-2022 Erik Baauw. All rights reserved.
 //
 // Homebridge plug-in for Nuki Bridge.
 
@@ -136,9 +136,10 @@ class NbClient extends homebridgeLib.HttpClient {
   }
 
   async info () { return this._get('/info') }
+  async list () { return this._get('/list') }
   async log () { return this._get('/log') }
   async reboot () { return this._get('/reboot') }
-  async list () { return this._get('/list') }
+  async fwupdate () { return this._get('/fwupdate') }
 
   async lockState (nukiId, deviceType) {
     return this._get('/lockState', { nukiId: nukiId, deviceType: deviceType })

package/lib/NbDiscovery.js

@@ -1,5 +1,5 @@
 // homebridge-nb/lib/NbDiscovery.js
-// Copyright © 2020-2021 Erik Baauw. All rights reserved.
+// Copyright © 2020-2022 Erik Baauw. All rights reserved.
 //
 // Homebridge plug-in for Nuki Bridge.
 

package/lib/NbListener.js

@@ -1,5 +1,5 @@
 // homebridge-nb/lib/NbListener.js
-// Copyright © 2020-2021 Erik Baauw. All rights reserved.
+// Copyright © 2020-2022 Erik Baauw. All rights reserved.
 //
 // Homebridge plug-in for Nuki Bridge.
 

package/lib/NbPlatform.js

@@ -1,5 +1,5 @@
 // homebridge-nb/lib/NbPlatform.js
-// Copyright © 2020-2021 Erik Baauw. All rights reserved.
+// Copyright © 2020-2022 Erik Baauw. All rights reserved.
 //
 // Homebridge plug-in for Nuki Bridge.
 

package/lib/NbService.js

@@ -1,5 +1,5 @@
 // homebridge-nb/lib/NbAccessory.js
-// Copyright © 2020-2021 Erik Baauw. All rights reserved.
+// Copyright © 2020-2022 Erik Baauw. All rights reserved.
 //
 // Homebridge plug-in for Nuki Bridge.
 
@@ -63,8 +63,6 @@ class Bridge extends homebridgeLib.ServiceDelegate {
       key: 'logLevel',
       Characteristic: this.Characteristics.my.LogLevel,
       value: nbAccessory.platform.logLevel
-    }).on('didSet', (value) => {
-      nbAccessory.logLevel = value
     })
     this.addCharacteristicDelegate({
       key: 'statusFault',

package/package.json

@@ -4,7 +4,7 @@
   "displayName": "Homebridge NB",
   "author": "Erik Baauw",
   "license": "Apache-2.0",
-  "version": "1.2.1",
+  "version": "1.2.5",
   "keywords": [
     "homebridge-plugin",
     "homekit",
@@ -18,11 +18,11 @@
     "nb": "cli/nb.js"
   },
   "engines": {
-    "homebridge": "^1.3.8",
-    "node": "^16.13.0"
+    "homebridge": "^1.4.0",
+    "node": "^16.14.0"
   },
   "dependencies": {
-    "homebridge-lib": "~5.1.18"
+    "homebridge-lib": "~5.2.3"
   },
   "scripts": {
     "prepare": "standard",