homebridge-nb 1.4.4 → 1.4.5

package/lib/NbAccessory.js

@@ -17,16 +17,15 @@ class NbAccessory extends homebridgeLib.AccessoryDelegate {
       category: params.category,
       manufacturer: 'Nuki Home Solutions GmbH',
       model: params.model,
-      firmware: params.firmware
+      firmware: params.device.firmwareVersion
     })
     this.inheritLogLevel(bridge)
     this.id = params.id
     this.bridge = bridge
     this.client = this.bridge.client
     this.context.bridgeId = this.bridge.id
-    this.context.firmware = params.firmware
-    this.context.deviceType = params.deviceType
-    this.log('Nuki %s v%s %s', params.model, params.firmware, params.id)
+    this.deviceType = params.device
+    this.log('Nuki %s v%s %s', params.model, params.device.firmwareVersion, params.id)
     this.on('identify', this.identify)
     setImmediate(() => { this.emit('initialised') })
   }
@@ -39,15 +38,13 @@ class NbAccessory extends homebridgeLib.AccessoryDelegate {
 
 class Bridge extends homebridgeLib.AccessoryDelegate {
   constructor (platform, context) {
-    const params = {
+    super(platform, {
       id: context.id,
       name: context.name,
       category: platform.Accessory.Categories.RANGE_EXTENDER,
-      manufacturer: 'Nuki Home Solutions GmbH',
       model: 'Bridge',
       firmware: context.firmware
-    }
-    super(platform, params)
+    })
     this.id = context.id
     this.context.host = context.host
     this.context.token = context.token
@@ -245,72 +242,58 @@ class Bridge extends homebridgeLib.AccessoryDelegate {
         this.service.update(response.body)
         response = await this.client.list()
         for (const device of response.body) {
-          this.debug('device: %j', device)
-          if (device.firmwareVersion == null) { // Issue 93.
-            continue
-          }
-          const id = device.nukiId.toString(16).toUpperCase()
-          if (!this.platform.isWhitelisted(id)) {
-            continue
-          }
-          switch (device.deviceType) {
-            case NbClient.DeviceTypes.SMARTLOCK:
-            case NbClient.DeviceTypes.SMARTDOOR:
-            case NbClient.DeviceTypes.SMARTLOCK3:
-              if (this.smartLocks[id] == null) {
-                this.addSmartLock(id, {
-                  id,
-                  name: device.name,
-                  firmware: device.firmwareVersion,
-                  deviceType: device.deviceType
-                })
-              }
-              this.smartLocks[id].values.firmware = device.firmwareVersion
-              this.smartLocks[id].context.deviceType = device.deviceType
-              if (device.lastKnownState == null) {
-                this.smartLocks[id].warn('no last known state')
-                continue
-              }
-              this.smartLocks[id].update(device.lastKnownState)
-              if (
-                device.lastKnownState.doorsensorState != null &&
-                device.lastKnownState.doorsensorState !== NbClient.DoorSensorStates.DEACTIVATED
-              ) {
-                if (this.doorSensors[id + '-S'] == null) {
-                  this.addDoorSensor(id + '-S', {
-                    id: id + '-S',
-                    name: device.name + ' Sensor',
-                    firmware: device.firmwareVersion,
-                    deviceType: device.deviceType
-                  })
+          try {
+            this.debug('device: %j', device)
+            if (device.firmwareVersion == null) { // Issue 93.
+              continue
+            }
+            const id = device.nukiId.toString(16).toUpperCase()
+            if (!this.platform.isWhitelisted(id)) {
+              continue
+            }
+            switch (device.deviceType) {
+              case NbClient.DeviceTypes.SMARTLOCK:
+              case NbClient.DeviceTypes.SMARTDOOR:
+              case NbClient.DeviceTypes.SMARTLOCK3:
+                if (device.lastKnownState == null) {
+                  this.warn('%s: no last known state', id)
+                  continue
+                }
+                if (this.smartLocks[id] == null) {
+                  this.addSmartLock(id, { id, device })
+                }
+                this.smartLocks[id].context.device = device
+                this.smartLocks[id].update(device.lastKnownState)
+                if (
+                  device.lastKnownState.doorsensorState != null &&
+                  device.lastKnownState.doorsensorState !== NbClient.DoorSensorStates.DEACTIVATED
+                ) {
+                  if (this.doorSensors[id + '-S'] == null) {
+                    this.addDoorSensor(id + '-S', { id: id + '-S', device })
+                  }
+                  this.doorSensors[id + '-S'].context.device = device
+                  this.doorSensors[id + '-S'].update(device.lastKnownState)
+                } else if (this.doorSensors[id + '-S'] != null) {
+                  this.doorSensors[id + '-S'].destroy()
+                  delete this.doorSensors[id + '-S']
                 }
-                this.doorSensors[id + '-S'].values.firmware = device.firmwareVersion
-                this.doorSensors[id + '-S'].context.deviceType = device.deviceType
-                this.doorSensors[id + '-S'].update(device.lastKnownState)
-              } else if (this.doorSensors[id + '-S'] != null) {
-                this.doorSensors[id + '-S'].destroy()
-                delete this.doorSensors[id + '-S']
-              }
-              break
-            case NbClient.DeviceTypes.OPENER:
-              if (this.openers[id] == null) {
-                this.addOpener(id, {
-                  id,
-                  name: device.name,
-                  firmware: device.firmwareVersion,
-                  deviceType: device.deviceType
-                })
-              }
-              this.openers[id].values.firmware = device.firmwareVersion
-              this.openers[id].context.deviceType = device.deviceType
-              if (device.lastKnownState == null) {
-                this.openers[id].warn('no last known state')
-                continue
-              }
-              this.openers[id].update(device.lastKnownState)
-              break
-            default:
-              break
+                break
+              case NbClient.DeviceTypes.OPENER:
+                if (device.lastKnownState == null) {
+                  this.warn('%s: no last known state', id)
+                  continue
+                }
+                if (this.openers[id] == null) {
+                  this.addOpener(id, { id, device })
+                }
+                this.openers[id].context.device = device
+                this.openers[id].update(device.lastKnownState)
+                break
+              default:
+                break
+            }
+          } catch (error) {
+            this.warn('heartbeat error: %s', error)
           }
         }
       } catch (error) {
@@ -322,14 +305,24 @@ class Bridge extends homebridgeLib.AccessoryDelegate {
 
 class SmartLock extends NbAccessory {
   constructor (bridge, params) {
-    params.category = bridge.Accessory.Categories.DOOR_LOCK
-    params.model = NbClient.modelName(params.deviceType, params.firmware)
-    super(bridge, params)
-    this.batteryService = new homebridgeLib.ServiceDelegate.Battery(this)
+    super(bridge, {
+      id: params.id,
+      name: params.device.name,
+      device: params.device,
+      category: bridge.Accessory.Categories.DOOR_LOCK,
+      model: NbClient.modelName(params.device.deviceType, params.device.firmwareVersion)
+    })
     this.service = new NbService.SmartLock(this)
     if (this.platform.config.latch) {
       this.latchService = new NbService.Latch(this)
     }
+    this.batteryService = new homebridgeLib.ServiceDelegate.Battery(this, {
+      batteryLevel: params.device.lastKnownState.batteryChargeState,
+      chargingState: params.device.lastKnownState.batteryCharging,
+      statusLowBattery: params.device.lastKnownState.batteryCritical
+        ? this.Characteristics.hap.StatusLowBattery.BATTERY_LEVEL_LOW
+        : this.Characteristics.hap.StatusLowBattery.BATTERY_LEVEL_NORMAL
+    })
   }
 
   update (state) {
@@ -340,6 +333,11 @@ class SmartLock extends NbAccessory {
     if (state.batteryChargeState) {
       this.batteryService.values.batteryLevel = state.batteryChargeState
     }
+    if (state.batteryCharging != null) {
+      this.batteryService.values.chargingState = state.batteryCharging
+        ? this.Characteristics.hap.ChargingState.CHARGING
+        : this.Characteristics.hap.ChargingState.NOT_CHARGING
+    }
     if (state.batteryCritical != null) {
       this.batteryService.values.statusLowBattery = state.batteryCritical
         ? this.Characteristics.hap.StatusLowBattery.BATTERY_LEVEL_LOW
@@ -361,8 +359,21 @@ class DoorSensor extends NbAccessory {
   constructor (bridge, params) {
     params.category = bridge.Accessory.Categories.DOOR
     params.model = 'Door Sensor'
-    super(bridge, params)
+    super(bridge, {
+      id: params.id,
+      name: params.device.name + ' Sensor',
+      device: params.device,
+      category: bridge.Accessory.Categories.DOOR,
+      model: 'Door Sensor'
+    })
     this.service = new NbService.DoorSensor(this)
+    if (params.device.lastKnownState.doorsensorBatteryCritical) {
+      this.batteryService = new homebridgeLib.ServiceDelegate.Battery(this, {
+        statusLowBattery: params.device.lastKnownState.doorsensorBatteryCritical
+          ? this.Characteristics.hap.StatusLowBattery.BATTERY_LEVEL_LOW
+          : this.Characteristics.hap.StatusLowBattery.BATTERY_LEVEL_NORMAL
+      })
+    }
     this.historyService = new homebridgeLib.ServiceDelegate.History(this, {
       contactDelegate: this.service.characteristicDelegate('contact'),
       lastContactDelegate: this.service.characteristicDelegate('lastActivation'),
@@ -372,6 +383,11 @@ class DoorSensor extends NbAccessory {
 
   update (state) {
     this.service.update(state)
+    if (state.doorsensorBatteryCritical != null) {
+      this.batteryService.values.statusLowBattery = state.doorsensorBatteryCritical
+        ? this.Characteristics.hap.StatusLowBattery.BATTERY_LEVEL_LOW
+        : this.Characteristics.hap.StatusLowBattery.BATTERY_LEVEL_NORMAL
+    }
   }
 
   async identify () {
@@ -387,26 +403,30 @@ class DoorSensor extends NbAccessory {
 class Opener extends NbAccessory {
   constructor (bridge, params) {
     params.category = bridge.Accessory.Categories.DOOR_LOCK
-    params.model = NbClient.modelName(params.deviceType, params.firmware)
-    super(bridge, params)
-    this.batteryService = new homebridgeLib.ServiceDelegate.Battery(this)
-    this.doorBellService = new NbService.DoorBell(this)
+    params.model = NbClient.modelName(params.device.deviceType, params.device.firmwareVersion)
+    super(bridge, {
+      id: params.id,
+      name: params.device.name,
+      device: params.device,
+      category: bridge.Accessory.Categories.DOOR_LOCK,
+      model: NbClient.modelName(params.device.deviceType, params.device.firmwareVersion)
+    })
     this.openerService = new NbService.Opener(this)
+    this.doorBellService = new NbService.DoorBell(this)
+    this.batteryService = new homebridgeLib.ServiceDelegate.Battery(this, {
+      statusLowBattery: params.device.lastKnownState.doorsensorBatteryCritical
+        ? this.Characteristics.hap.StatusLowBattery.BATTERY_LEVEL_LOW
+        : this.Characteristics.hap.StatusLowBattery.BATTERY_LEVEL_NORMAL
+    })
   }
 
   update (state) {
     this.doorBellService.update(state)
     this.openerService.update(state)
     if (state.batteryCritical != null) {
-      if (state.batteryCritical) {
-        this.batteryService.values.statusLowBattery =
-          this.Characteristics.hap.StatusLowBattery.BATTERY_LEVEL_LOW
-        this.batteryService.values.batteryLevel = 10
-      } else {
-        this.batteryService.values.statusLowBattery =
-          this.Characteristics.hap.StatusLowBattery.BATTERY_LEVEL_NORMAL
-        this.batteryService.values.batteryLevel = 90
-      }
+      this.batteryService.values.statusLowBattery = state.batteryCritical
+        ? this.Characteristics.hap.StatusLowBattery.BATTERY_LEVEL_LOW
+        : this.Characteristics.hap.StatusLowBattery.BATTERY_LEVEL_NORMAL
     }
   }
 

package/lib/NbPlatform.js

@@ -96,20 +96,19 @@ class NbPlatform extends homebridgeLib.Platform {
 
   async init (beat) {
     try {
-      if (Object.keys(this.bridges).length === 0) {
-        const jobs = []
-        const bridges = await this.discovery.discover()
-        this.debug('discovery: %j', bridges)
-        for (const bridge of bridges) {
-          jobs.push(this.foundBridge(bridge))
-        }
-        for (const job of jobs) {
-          try {
-            await job
-          } catch (error) {
-            if (!(error instanceof homebridgeLib.HttpClient.HttpError)) {
-              this.error(error)
-            }
+      const jobs = []
+      for (const id in this.bridges) {
+        jobs.push(events.once(this.bridges[id], 'initialised'))
+      }
+      if (jobs.length === 0) {
+        jobs.push(this.discover())
+      }
+      for (const job of jobs) {
+        try {
+          await job
+        } catch (error) {
+          if (!(error instanceof homebridgeLib.HttpClient.HttpError)) {
+            this.error(error)
           }
         }
       }
@@ -123,24 +122,28 @@ class NbPlatform extends homebridgeLib.Platform {
     this.emit('initialised')
   }
 
+  async discover () {
+    const bridges = await this.discovery.discover()
+    this.debug('discovery: %j', bridges)
+    const jobs = []
+    for (const bridge of bridges) {
+      jobs.push(this.foundBridge(bridge))
+    }
+    for (const job of jobs) {
+      try {
+        await job
+      } catch (error) {
+        if (!(error instanceof homebridgeLib.HttpClient.HttpError)) {
+          this.error(error)
+        }
+      }
+    }
+  }
+
   async heartbeat (beat) {
     if (beat % discoveryInterval === discoveryInterval - 5) {
       try {
-        const bridges = await this.discovery.discover()
-        this.debug('discovery: %j', bridges)
-        const jobs = []
-        for (const bridge of bridges) {
-          jobs.push(this.foundBridge(bridge))
-        }
-        for (const job of jobs) {
-          try {
-            await job
-          } catch (error) {
-            if (!(error instanceof homebridgeLib.HttpClient.HttpError)) {
-              this.error(error)
-            }
-          }
-        }
+        await this.discover()
       } catch (error) {
         if (!(error instanceof homebridgeLib.HttpClient.HttpError)) {
           this.error(error)
@@ -247,6 +250,10 @@ class NbPlatform extends homebridgeLib.Platform {
             )
             break
           }
+          if (context.device == null) {
+            // Old plugin version - re-create accessory delegate on bridge initialisation
+            break
+          }
           context.id = id
           context.name = name
           bridge['add' + className](context.id, context)
@@ -254,7 +261,7 @@ class NbPlatform extends homebridgeLib.Platform {
         break
       default:
         this.warn(
-          '%s: ignore unknown %s %v accesssory', name, className, version
+          '%s: ignore unknown %s v%s accesssory', name, className, version
         )
         break
     }

package/lib/NbService.js

@@ -105,7 +105,7 @@ class SmartLock extends homebridgeLib.ServiceDelegate {
           return
         }
         const response = await nbAccessory.client.lockAction(
-          nbAccessory.id, nbAccessory.context.deviceType,
+          nbAccessory.id, nbAccessory.deviceType,
           value === this.Characteristics.hap.LockTargetState.UNSECURED
             ? NbClient.LockActions.UNLOCK
             : NbClient.LockActions.LOCK
@@ -122,7 +122,7 @@ class SmartLock extends homebridgeLib.ServiceDelegate {
         }
         if (value === this.Characteristics.hap.LockTargetState.UNSECURED) {
           await nbAccessory.client.lockAction(
-            nbAccessory.id, nbAccessory.context.deviceType,
+            nbAccessory.id, nbAccessory.deviceType,
             NbClient.LockActions.UNLATCH
           )
         }
@@ -143,7 +143,7 @@ class SmartLock extends homebridgeLib.ServiceDelegate {
             nbAccessory.update({ state: NbClient.LockStates.UNLATCHED })
           }, 3000)
           const response = await nbAccessory.client.lockAction(
-            nbAccessory.id, nbAccessory.context.deviceType,
+            nbAccessory.id, nbAccessory.deviceType,
             NbClient.LockActions.UNLATCH
           )
           if (response != null && response.body.success) {
@@ -162,6 +162,13 @@ class SmartLock extends homebridgeLib.ServiceDelegate {
       Characteristic: this.Characteristics.hap.StatusFault,
       value: this.Characteristics.hap.StatusFault.NO_FAULT
     })
+    if (this.platform.config.latch) {
+      this.addCharacteristicDelegate({
+        key: 'label',
+        Characteristic: this.Characteristics.hap.ServiceLabelIndex,
+        value: 1
+      })
+    }
   }
 
   update (state) {
@@ -233,7 +240,7 @@ class Latch extends homebridgeLib.ServiceDelegate {
             nbAccessory.update({ state: NbClient.LockStates.UNLATCHED })
           }, 3000)
           const response = await nbAccessory.client.lockAction(
-            nbAccessory.id, nbAccessory.context.deviceType,
+            nbAccessory.id, nbAccessory.deviceType,
             NbClient.LockActions.UNLATCH
           )
           if (response != null && response.body.success) {
@@ -243,6 +250,11 @@ class Latch extends homebridgeLib.ServiceDelegate {
         }
       } catch (error) { this.error(error) }
     })
+    this.addCharacteristicDelegate({
+      key: 'label',
+      Characteristic: this.Characteristics.hap.ServiceLabelIndex,
+      value: 2
+    })
   }
 
   update (state) {
@@ -280,6 +292,7 @@ class DoorSensor extends homebridgeLib.ServiceDelegate {
   constructor (nbAccessory, params = {}) {
     params.name = nbAccessory.name
     params.Service = nbAccessory.Services.hap.ContactSensor
+    params.primaryService = true
     super(nbAccessory, params)
 
     this.addCharacteristicDelegate({
@@ -374,6 +387,7 @@ class Opener extends homebridgeLib.ServiceDelegate {
   constructor (nbAccessory, params = {}) {
     params.name = nbAccessory.name
     params.Service = nbAccessory.Services.hap.LockMechanism
+    params.primaryService = true
     super(nbAccessory, params)
 
     this.addCharacteristicDelegate({
@@ -392,7 +406,7 @@ class Opener extends homebridgeLib.ServiceDelegate {
         }
         if (value === this.Characteristics.hap.LockTargetState.UNSECURED) {
           const response = await nbAccessory.client.lockAction(
-            nbAccessory.id, nbAccessory.context.deviceType,
+            nbAccessory.id, nbAccessory.deviceType,
             NbClient.OpenerActions.OPEN
           )
           if (response != null && response.body.success) {
@@ -417,7 +431,7 @@ class Opener extends homebridgeLib.ServiceDelegate {
           return
         }
         await nbAccessory.client.lockAction(
-          nbAccessory.id, nbAccessory.context.deviceType, value
+          nbAccessory.id, nbAccessory.deviceType, value
             ? NbClient.OpenerActions.ACTIVATE_RTO
             : NbClient.OpenerActions.DEACTIVATE_RTO
         )
@@ -432,7 +446,7 @@ class Opener extends homebridgeLib.ServiceDelegate {
           return
         }
         await nbAccessory.client.lockAction(
-          nbAccessory.id, nbAccessory.context.deviceType, value
+          nbAccessory.id, nbAccessory.deviceType, value
             ? NbClient.OpenerActions.ACTIVATE_CM
             : NbClient.OpenerActions.DEACTIVATE_CM
         )

package/package.json

@@ -4,7 +4,7 @@
   "displayName": "Homebridge NB",
   "author": "Erik Baauw",
   "license": "Apache-2.0",
-  "version": "1.4.4",
+  "version": "1.4.5",
   "keywords": [
     "homebridge-plugin",
     "homekit",
@@ -19,12 +19,12 @@
   },
   "engines": {
     "homebridge": "^1.6.1",
-    "node": "^18.16.1",
+    "node": "18.17.0||^18||^16",
     "nuki": "2.15.0"
   },
   "dependencies": {
-    "homebridge-lib": "~6.3.18",
-    "hb-nb-tools": "~1.1.3"
+    "homebridge-lib": "~6.4.0",
+    "hb-nb-tools": "~1.1.4"
   },
   "scripts": {
     "prepare": "standard",