homebridge-deconz 0.1.9 → 0.1.11

package/cli/deconz.js

@@ -514,10 +514,7 @@ class Main extends CommandLineTool {
 
     this.bridgeid = this.gatewayConfig.bridgeid
     if (this.clargs.options.apiKey == null) {
-      if (
-        this.gateways[this.bridgeid] != null &&
-        this.gateways[this.bridgeid].apiKey != null
-      ) {
+      if (this.gateways[this.bridgeid]?.apiKey != null) {
         this.clargs.options.apiKey = this.gateways[this.bridgeid].apiKey
       } else if (process.env.DECONZ_API_KEY != null) {
         this.clargs.options.apiKey = process.env.DECONZ_API_KEY

package/homebridge-ui/public/index.old.html

@@ -32,8 +32,7 @@ async function showFormPluginConfig () {
       console.log('%s: cachedAccessories: %o', config.name, cachedAccessories)
       const cachedGateways = cachedAccessories.filter((accessory) => {
         return accessory.plugin === 'homebridge-deconz' &&
-          accessory.context != null &&
-          accessory.context.className === 'Gateway'
+          accessory.context?.className === 'Gateway'
       })
       const result = {}
       for (const gateway of cachedGateways) {
@@ -207,8 +206,7 @@ async function showFormGateways (gateway) {
   const cachedAccessories = await homebridge.getCachedAccessories()
   const cachedGateways = cachedAccessories.filter((accessory) => {
     return accessory.plugin === 'homebridge-deconz' &&
-      accessory.context != null &&
-      accessory.context.className === 'Gateway'
+      accessory.context?.className === 'Gateway'
   })
   const result = {}
   for (const gateway of cachedGateways) {
@@ -249,7 +247,7 @@ async function showFormGateways (gateway) {
   //   layout: null,
   //   form: null
   // }, {
-  //   gateway: gateway != null ? gateway : gateways[0]
+  //   gateway: gateway ?? gateways[0]
   // }, 'Gateway Settings', 'Homebridge Settings')
   const form = homebridge.createForm({
     footerDisplay: 'For a detailed description, see the [wiki](https://github.com/ebaauw/homebridge-deconz/wiki/Configuration).',

package/lib/Deconz/Resource.js

@@ -5,13 +5,12 @@
 
 'use strict'
 
-const { Colour, OptionParser } = require('homebridge-lib')
+const { OptionParser } = require('homebridge-lib')
 const Deconz = require('../Deconz')
 const DeconzAccessory = require('../DeconzAccessory')
 const DeconzService = require('../DeconzService')
 
 const { toInstance, toInt, toObject, toString } = OptionParser
-const { defaultGamut } = Colour
 const { buttonEvent } = Deconz.ApiClient
 const { SINGLE, DOUBLE, LONG } = DeconzService.Button
 const rtypes = ['lights', 'sensors', 'groups']
@@ -30,51 +29,6 @@ const sensorsPrios = [
 
 // =============================================================================
 
-// See: http://www.developers.meethue.com/documentation/supported-lights
-
-const hueGamutType = { // Color gamut per light model.
-  A: { // Color Lights
-    r: [0.7040, 0.2960],
-    g: [0.2151, 0.7106],
-    b: [0.1380, 0.0800]
-  },
-  B: { // Extended Color Lights
-    r: [0.6750, 0.3220],
-    g: [0.4090, 0.5180],
-    b: [0.1670, 0.0400]
-  },
-  C: { // next gen Extended Color Lights
-    r: [0.6920, 0.3080],
-    g: [0.1700, 0.7000],
-    b: [0.1530, 0.0480]
-  }
-}
-
-const hueGamutTypeByModel = {
-  LCT001: 'B', // Hue bulb A19
-  LCT002: 'B', // Hue Spot BR30
-  LCT003: 'B', // Hue Spot GU10
-  LCT007: 'B', // Hue bulb A19
-  LCT010: 'C', // Hue bulb A19
-  LCT011: 'C', // Hue BR30
-  LCT012: 'C', // Hue Color Candle
-  LCT014: 'C', // Hue bulb A19
-  LCT015: 'C', // Hue bulb A19
-  LCT016: 'C', // Hue bulb A19
-  LLC005: 'A', // Living Colors Gen3 Bloom, Aura
-  LLC006: 'A', // Living Colors Gen3 Iris
-  LLC007: 'A', // Living Colors Gen3 Bloom, Aura
-  LLC010: 'A', // Hue Living Colors Iris
-  LLC011: 'A', // Hue Living Colors Bloom
-  LLC012: 'A', // Hue Living Colors Bloom
-  LLC013: 'A', // Disney Living Colors
-  LLC014: 'A', // Living Colors Gen3 Bloom, Aura
-  LLC020: 'C', // Hue Go
-  LLM001: 'B', // Color Light Module
-  LST001: 'A', // Hue LightStrips
-  LST002: 'C' // Hue LightStrips Plus
-}
-
 const hueTapMap = {
   34: 1002, // press 1
   16: 2002, // press 2
@@ -99,9 +53,9 @@ class Resource {
     toString('uniqueid', uniqueid, true)
     const a = uniqueid.replace(/:/g, '').toUpperCase().split('-')
     return {
-      mac: a.length > 0 ? a[0] : null,
-      endpoint: a.length > 1 ? a[1] : null,
-      cluster: a.length > 2 ? a[2] : null
+      mac: a?.[0],
+      endpoint: a?.[1],
+      cluster: a?.[2]
     }
   }
 
@@ -175,6 +129,11 @@ class Resource {
         * @type {boolean}
         */
       this.zigbee = true
+    } else if (this.isDeconzClip()) {
+      const a = body.uniqueid.split('-')
+      this.id = gateway.id + '-M' + a?.[0]
+      this.subtype = a?.[1]
+      this.zigbee = false
     } else {
       this.subtype = rtype[0].toUpperCase() + rid
       this.id = gateway.id + '-' + this.subtype
@@ -211,60 +170,16 @@ class Resource {
       ? body.swversion == null ? '0.0.0' : body.swversion
       : gateway.values.software
 
-    switch (this.serviceName) {
-      case 'Light': {
-        if (body.action != null) {
-          Object.assign(body.state, body.action)
-          delete body.state.on
-        }
-        this.capabilities = {
-          on: body.state.on !== undefined,
-          bri: body.state.bri !== undefined,
-          ct: body.state.ct !== undefined,
-          ctMax: (body.ctmax != null && body.ctmax !== 0 && body.ctmax !== 65535)
-            ? body.ctmax
-            : 500,
-          ctMin: (body.ctmin != null && body.ctmin !== 0)
-            ? body.ctmin
-            : 153,
-          xy: body.state.xy !== undefined,
-          gamut: defaultGamut,
-          alert: body.state.alert !== undefined,
-          colorLoop: body.state.effect !== undefined
-        }
-        if (body.capabilities != null) {
-          const cap = body.capabilities
-          if (cap.color != null) {
-            if (cap.color.ct != null) {
-              this.capabilities.ctMax = cap.color.ct.max
-              this.capabilities.ctMin = cap.color.ct.min
-            }
-            if (cap.color.effects != null && cap.color.effects.length > 2) {
-              this.capabilities.effects = cap.color.effects.slice(2).map((effect) => {
-                return effect[0].toUpperCase() + effect.slice(1)
-              })
-            }
-            if (cap.color.xy != null) {
-              this.capabilities.gamut = {
-                r: cap.color.xy.red,
-                g: cap.color.xy.green,
-                b: cap.color.xy.blue
-              }
-            }
-          }
-        }
-        break
-      }
-      case 'WarningDevice':
-        this.capabilities = {}
-        break
-      case 'WindowCovering':
-        this.capabilities = {}
-        break
-      default:
-        this.capabilities = {}
-        break
-    }
+    /** The name of the {@link DeconzService} subclass of the delegate of the
+      * corresponding HomeKit service, or `null` for unsupported and unknown
+      * resources.
+      *
+      * This is derived from the resource type and `type` in the resource body.
+      * @type {string}
+      */
+    this.serviceName = this._serviceName
+
+    this.capabilities = {}
 
     const f = 'patch' + this.serviceName
     if (typeof this[f] === 'function') {
@@ -277,8 +192,12 @@ class Resource {
     * @type {integer}
     */
   get prio () {
-    if (this.rtype === 'groups') return -1
-    if (this.rtype === 'lights') return 0xFF - this.endpoint
+    if (this.rtype === 'groups') {
+      return -1
+    }
+    if (this.rtype === 'lights' || this.isDeconzClip()) {
+      return 0xFF - this.endpoint
+    }
     return sensorsPrios.indexOf(this.serviceName)
   }
 
@@ -289,14 +208,7 @@ class Resource {
     */
   get rpath () { return '/' + this.rtype + '/' + this.rid }
 
-  /** The name of the {@link DeconzService} subclass of the delegate of the
-    * corresponding HomeKit service, or `null` for unsupported and unknown
-    * resources.
-    *
-    * This is derived from the resource type and `type` in the resource body.
-    * @type {string}
-    */
-  get serviceName () {
+  get _serviceName () {
     if (this.rtype === 'groups') {
       return 'Light'
     } else if (this.rtype === 'lights') {
@@ -314,11 +226,11 @@ class Resource {
         // case 'Door Lock': return null
         // case 'Door Lock Unit': return null
         case 'Fan': return 'Light'
-        case 'On/Off light switch': return 'Light'
+        case 'On/Off light switch': return 'Switch'
         case 'On/Off light': return 'Light'
-        case 'On/Off output': return 'Light'
-        case 'On/Off plug-in unit': return 'Light'
-        case 'Smart plug': return 'Light'
+        case 'On/Off output': return 'Outlet'
+        case 'On/Off plug-in unit': return 'Outlet'
+        case 'Smart plug': return 'Outlet'
         case 'Configuration tool': return ''
         case 'Range extender': return ''
         case 'Warning device': return 'WarningDevice'
@@ -327,55 +239,34 @@ class Resource {
         default: return null
       }
     } else { // (this.rtype === 'sensors')
-      switch (this.body.type) {
-        case 'CLIPAirPurifier':
-        case 'ZHAAirPurifier': return 'AirPurifier'
-        case 'ZHAAirQuality':
-        case 'CLIPAirQuality': return 'AirQuality'
-        case 'ZHAAlarm':
-        case 'CLIPAlarm': return 'Alarm'
-        case 'ZHABattery':
-        case 'CLIPBattery': return 'Battery'
-        case 'ZHACarbonMonoxide':
-        case 'CLIPCarbonMonoxide': return 'CarbonMonoxide'
-        case 'ZHAConsumption':
-        case 'CLIPConsumption': return 'Consumption'
-        // case 'ZHADoorLock':
-        // case 'CLIPDoorLock': return null
+      const type = /^(CLIP|ZHA|ZGP)?([A-Za-z]*)$/.exec(this.body.type)?.[2]
+      switch (type) {
+        case 'AirPurifier': return 'AirPurifier'
+        case 'AirQuality': return 'AirQuality'
+        case 'Alarm': return 'Alarm'
+        case 'Battery': return 'Battery'
+        case 'CarbonMonoxide': return 'CarbonMonoxide'
+        case 'Consumption': return 'Consumption'
+        // case 'DoorLock': return null
         case 'Daylight': return 'Daylight'
-        case 'ZHAFire':
-        case 'CLIPFire': return 'Smoke'
-        case 'CLIPGenericFlag': return 'Flag'
-        case 'CLIPGenericStatus': return 'Status'
-        case 'ZHAHumidity':
-        case 'CLIPHumidity': return 'Humidity'
-        case 'ZHALightLevel':
-        case 'CLIPLightLevel': return 'LightLevel'
-        // case 'ZHAMoisture':
-        // case 'CLIPMoisture': return null
-        case 'ZHAOpenClose':
-        case 'CLIPOpenClose': return 'Contact'
-        case 'ZHAPower':
-        case 'CLIPPower': return 'Power'
-        case 'ZHAPresence':
-        case 'CLIPPresence': return 'Motion'
-        case 'ZHAPressure':
-        case 'CLIPPressure': return 'AirPressure'
-        case 'ZHARelativeRotary': return 'Switch'
-        case 'ZHASpectral': return ''
-        case 'ZGPSwitch':
-        case 'ZHASwitch':
-        case 'CLIPSwitch': return 'Switch'
-        case 'ZHATemperature':
-        case 'CLIPTemperature': return 'Temperature'
-        case 'ZHAThermostat':
-        case 'CLIPThermostat': return 'Thermostat'
-        case 'ZHATime':
-        case 'CLIPTime': return ''
-        case 'ZHAVibration':
-        case 'CLIPVibration': return 'Motion'
-        case 'ZHAWater':
-        case 'CLIPWater': return 'Leak'
+        case 'Fire': return 'Smoke'
+        case 'GenericFlag': return 'Flag'
+        case 'GenericStatus': return 'Status'
+        case 'Humidity': return 'Humidity'
+        case 'LightLevel': return 'LightLevel'
+        case 'Moisture': return 'Humidity'
+        case 'OpenClose': return 'Contact'
+        case 'Power': return 'Power'
+        case 'Presence': return 'Motion'
+        case 'Pressure': return 'AirPressure'
+        case 'RelativeRotary': return 'Label'
+        case 'Spectral': return ''
+        case 'Switch': return 'Label'
+        case 'Temperature': return 'Temperature'
+        case 'Thermostat': return 'Thermostat'
+        case 'Time': return ''
+        case 'Vibration': return 'Motion'
+        case 'Water': return 'Leak'
         default: return null
       }
     }
@@ -386,34 +277,7 @@ class Resource {
     */
   patchLight (gateway) {
     switch (this.manufacturer) {
-      case 'Busch-Jaeger':
-        // See: https://www.busch-jaeger.de/en/products/product-solutions/dimmer/busch-radio-controlled-dimmer-zigbee-light-link/
-        if (
-          this.model === 'RM01' && // 6715 U-500 with 6736-84.
-          this.capabilities.bri && this.body.type === 'On/Off light' // Issue #241
-        ) {
-          gateway.vdebug(
-            '%s: ignoring state.bri for %s', this.rpath, this.body.type
-          )
-          this.capabilities.bri = false
-        }
-        break
-      case 'dresden elektronik':
-        // See: https://www.dresden-elektronik.de/funktechnik/solutions/wireless-light-control/wireless-ballasts/?L=1
-        this.capabilities.computesXy = true
-        break
-      case 'FeiBit':
-        if (this.model === 'FNB56-SKT1EHG1.2') { // issue #361
-          this.body.type = 'On/Off plug-in unit'
-        }
-        break
       case 'GLEDOPTO':
-        // See: https://www.led-trading.de/zigbee-kompatibel-controller-led-lichtsteuerung
-        this.capabilities.gamut = {
-          r: [0.7006, 0.2993],
-          g: [0.1387, 0.8148],
-          b: [0.1510, 0.0227]
-        }
         if (this.model === 'GLEDOPTO') { // Issue #244
           if (
             this.endpoint === '0A' &&
@@ -444,37 +308,6 @@ class Resource {
           gateway.vdebug('%s: set model to %j', this.rpath, this.model)
         }
         break
-      case 'IKEA of Sweden':
-        // See: http://www.ikea.com/us/en/catalog/categories/departments/lighting/smart_lighting/
-        this.capabilities.gamut = defaultGamut // Issue #956
-        this.capabilities.noTransition = true
-        if (this.model === 'TRADFRI bulb E27 CWS 806lm') {
-          this.capabilities.computesXy = true
-          this.capabilities.gamut = {
-            r: [0.68, 0.31],
-            g: [0.11, 0.82],
-            b: [0.13, 0.04]
-          }
-        }
-        break
-      case 'innr':
-        // See: https://shop.innrlighting.com/en/shop
-        this.capabilities.gamut = { // Issue #152
-          r: [0.8817, 0.1033],
-          g: [0.2204, 0.7758],
-          b: [0.0551, 0.1940]
-        }
-        if (this.model === 'SP 120') { // smart plug
-          this.capabilities.bri = false
-        }
-        break
-      case 'LEDVANCE':
-        this.capabilities.gamut = {
-          r: [0.6972, 0.3027],
-          g: [0.1737, 0.6991],
-          b: [0.1227, 0.0959]
-        }
-        break
       case 'LIDL Livarno Lux':
         this.capabilities.ctMax = 454 // 2200 K
         this.capabilities.ctMin = 153 // 6500 K
@@ -489,98 +322,53 @@ class Resource {
           ]
         }
         break
-      case 'MLI': // Issue #439
-        this.capabilities.gamut = {
-          r: [0.68, 0.31],
-          g: [0.11, 0.82],
-          b: [0.13, 0.04]
-        }
-        if (this.capabilities.colorLoop) {
-          this.capabilities.effects = [
-            'Sunset', 'Party', 'Worklight', 'Campfire', 'Romance', 'Nightlight'
-          ]
-        }
-        break
-      case 'OSRAM':
-        this.capabilities.gamut = {
-          r: [0.6850, 0.3149],
-          g: [0.1780, 0.7253],
-          b: [0.1241, 0.0578]
-        }
-        break
-      case 'Philips':
-      case 'Signify Netherlands B.V.':
-        // See: http://www.developers.meethue.com/documentation/supported-lights
-        this.manufacturer = 'Signify Netherlands B.V.'
-        this.capabilities.breathe = true
-        this.capabilities.computesXy = true
-        if (this.body.capabilities == null) {
-          const gamut = hueGamutTypeByModel[this.model] || 'C'
-          this.capabilities.gamut = hueGamutType[gamut]
-        }
-        break
       default:
         break
     }
   }
 
+  /** Check whether resource is a CLIP sensor for Homebridge deCONZ.
+    * For these, we use the following conventions:
+    * - Use `uniqueid` to indicate device ID and subtype;
+    * - Use `swversion` to indicate readonly and range for `Flag` and `Status`.
+    */
+  isDeconzClip () {
+    return this.rtype === 'sensors' &&
+    this.body.type.startsWith('CLIP') &&
+    this.body.modelid === this.body.type && (
+      this.body.manufacturername === 'homebridge-deconz' ||
+      this.body.manufacturername === 'homebridge-hue'
+    )
+  }
+
   /** Patch a resource corresponding to a `Flag` service.
-  * @param {DeconzAccessory.Gateway} gateway - The gateway.
     */
-  patchFlag (gateway) {
-    if (
-      this.body.manufacturername === 'homebridge-hue' &&
-      this.body.modelid === 'CLIPGenericFlag' &&
-      this.body.swversion === '0'
-    ) {
+  patchFlag () {
+    if (this.isDeconzClip() && this.body.swversion === '0') {
       this.capabilities.readonly = true
     }
   }
 
-  /** Patch a resource corresponding to a `Flag` service.
-  * @param {DeconzAccessory.Gateway} gateway - The gateway.
+  /** Patch a resource corresponding to a `Status` service.
     */
-  patchStatus (gateway) {
-    if (
-      this.body.manufacturername === 'homebridge-hue' &&
-      this.body.modelid === 'CLIPGenericStatus'
-    ) {
+  patchStatus () {
+    if (this.isDeconzClip()) {
       const a = this.body.swversion.split(',')
       const min = parseInt(a[0])
       const max = parseInt(a[1])
-      const step = parseInt(a[2])
-      // Eve 3.1 displays the following controls, depending on the properties:
-      // 1. {minValue: 0, maxValue: 1, minStep: 1}                    switch
-      // 2. {minValue: a, maxValue: b, minStep: 1}, 1 < b - a <= 20   down|up
-      // 3. {minValue: a, maxValue: b}, (a, b) != (0, 1)              slider
-      // 4. {minValue: a, maxValue: b, minStep: 1}, b - a > 20        slider
-      // Avoid the following bugs:
-      // 5. {minValue: 0, maxValue: 1}                                nothing
-      // 6. {minValue: a, maxValue: b, minStep: 1}, b - a = 1         switch*
-      //    *) switch sends values 0 and 1 instead of a and b;
       if (min === 0 && max === 0) {
         this.capabilities.readonly = true
       } else if (min >= -127 && max <= 127 && min < max) {
-        if (min === 0 && max === 1) {
-          // Workaround Eve bug (case 5 above).
-          this.capabilities.props = { minValue: min, maxValue: max, minStep: 1 }
-        } else if (max - min === 1) {
-          // Workaround Eve bug (case 6 above).
-          this.capabilities.props = { minValue: min, maxValue: max }
-        } else if (step !== 1) {
-          // Default to slider for backwards compatibility.
-          this.capabilities.props = { minValue: min, maxValue: max }
-        } else {
-          this.capabilities.props = { minValue: min, maxValue: max, minStep: 1 }
-        }
+        this.capabilities.min = min
+        this.capabilities.max = max
       }
     }
   }
 
-  /** Patch a resource corresponding to a `Switch` service.
+  /** Patch a resource corresponding to a `Label` service.
   * @param {DeconzAccessory.Gateway} gateway - The gateway.
     */
-  patchSwitch (gateway) {
+  patchLabel (gateway) {
     const buttons = []
     let dots = false
     switch (this.manufacturer) {
@@ -671,6 +459,15 @@ class Resource {
               buttons.push([3, 'Turn Left', SINGLE])
             }
             break
+          case 'SYMFONISK sound remote gen2':
+            buttons.push([1, 'Play', SINGLE])
+            buttons.push([2, 'Plus', SINGLE | LONG, true])
+            buttons.push([3, 'Minus', SINGLE | LONG, true])
+            buttons.push([4, 'Previous', SINGLE])
+            buttons.push([5, 'Next', SINGLE])
+            buttons.push([6, 'One Dot', SINGLE | DOUBLE | LONG])
+            buttons.push([7, 'Two Dots', SINGLE | DOUBLE | LONG])
+            break
           case 'TRADFRI SHORTCUT Button':
             buttons.push([1, 'Button', SINGLE | DOUBLE | LONG])
             break
@@ -784,12 +581,16 @@ class Resource {
               }
             }
             break
-          case 'lumi.sensor_86sw1': // Xiaomi wall switch (single button)
           case 'lumi.ctrl_ln1.aq1':
+          case 'lumi.sensor_86sw1': // Xiaomi wall switch (single button).
+          case 'lumi.switch.l1aeu1': // Xiaomi Aqara H1, see #1149.
+          case 'lumi.switch.n1aeu1': // Xiaomi Aqara H1, see #1149.
             buttons.push([1, 'Button', SINGLE | DOUBLE])
             break
-          case 'lumi.sensor_86sw2': // Xiaomi wall switch (two buttons)
           case 'lumi.ctrl_ln2.aq1':
+          case 'lumi.sensor_86sw2': // Xiaomi wall switch (two buttons).
+          case 'lumi.switch.l2aeu1': // Xiaomi Aqara H2, see #1149.
+          case 'lumi.switch.n2aeu1': // Xiaomi Aqara H2, see #1149.
             buttons.push([1, 'Left', SINGLE | DOUBLE])
             buttons.push([2, 'Right', SINGLE | DOUBLE])
             buttons.push([3, 'Both', SINGLE | DOUBLE])
@@ -1255,9 +1056,8 @@ class Resource {
   }
 
   /** Patch a resource corresponding to a `Thermostat` service.
-  * @param {DeconzAccessory.Gateway} gateway - The gateway.
     */
-  patchThermostat (gateway) {
+  patchThermostat () {
     if (this.manufacturer === 'ELKO' && this.model === 'Super TR') {
       this.capabilities.heatValue = 'heat'
     } else {
@@ -1266,9 +1066,8 @@ class Resource {
   }
 
   /** Patch a resource corresponding to a `WindowCovering` service.
-  * @param {DeconzAccessory.Gateway} gateway - The gateway.
     */
-  patchWindowCovering (gateway) {
+  patchWindowCovering () {
     if (this.manufacturer === 'LUMI' && this.model === 'lumi.curtain.acn002') {
       this.capabilities.maxSpeed = 2
       this.capabilities.positionChange = true