homebridge-deconz 0.0.6 → 0.0.11

package/lib/DeconzService/Humidity.js

@@ -0,0 +1,37 @@
+// homebridge-deconz/lib/DeconzService/Humidity.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const DeconzService = require('../DeconzService')
+
+/**
+  * @memberof DeconzService
+  */
+class Humidity extends DeconzService.SensorsResource {
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.hap.HumiditySensor
+    super(accessory, resource, params)
+
+    this.addCharacteristicDelegate({
+      key: 'humidity',
+      Characteristic: this.Characteristics.hap.CurrentRelativeHumidity,
+      unit: '%'
+    })
+
+    this.addCharacteristicDelegates()
+
+    this.update(resource.body)
+  }
+
+  updateState (state) {
+    if (state.humidity != null) {
+      this.values.humidity = Math.round(state.humidity / 10) / 10
+    }
+    super.updateState(state)
+  }
+}
+
+module.exports = Humidity

package/lib/DeconzService/Leak.js

@@ -0,0 +1,38 @@
+// homebridge-deconz/lib/DeconzService/Leak.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const DeconzService = require('../DeconzService')
+
+/**
+  * @memberof DeconzService
+  */
+class Leak extends DeconzService.SensorsResource {
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.hap.LeakSensor
+    super(accessory, resource, params)
+
+    this.addCharacteristicDelegate({
+      key: 'leak',
+      Characteristic: this.Characteristics.hap.LeakDetected
+    })
+
+    super.addCharacteristicDelegates()
+
+    this.update(resource.body)
+  }
+
+  updateState (state) {
+    if (state.water != null || state.test != null) {
+      this.values.leak = state.water || state.test
+        ? this.Characteristics.hap.LeakDetected.LEAK_DETECTED
+        : this.Characteristics.hap.LeakDetected.LEAK_NOT_DETECTED
+    }
+    super.updateState(state)
+  }
+}
+
+module.exports = Leak

package/lib/DeconzService/Light.js

@@ -0,0 +1,376 @@
+// homebridge-deconz/lib/DeconzService/Light.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const homebridgeLib = require('homebridge-lib')
+const DeconzService = require('../DeconzService')
+
+const { timeout } = homebridgeLib
+const { xyToHsv, hsvToXy, ctToXy } = homebridgeLib.Colour
+
+class Light extends DeconzService.LightsResource {
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.hap.Lightbulb
+    super(accessory, resource, params)
+
+    this.addCharacteristicDelegate({
+      key: 'on',
+      Characteristic: this.Characteristics.hap.On,
+      value: this.capabilities.on
+        ? this.resource.body.state.on
+        : this.resource.body.state.all_on
+    }).on('didSet', (value, fromHomeKit) => {
+      if (fromHomeKit) {
+        this.put({ on: value })
+        this.updateAdaptiveLighting()
+      }
+    })
+
+    if (!this.capabilities.on) {
+      this.addCharacteristicDelegate({
+        key: 'anyOn',
+        Characteristic: this.Characteristics.my.AnyOn,
+        value: this.resource.body.state.any_on
+      }).on('didSet', (value, fromHomeKit) => {
+        if (fromHomeKit) {
+          this.put({ on: value })
+          this.updateAdaptiveLighting()
+        }
+      })
+    }
+
+    if (this.capabilities.bri) {
+      this.brightnessDelegate = this.addCharacteristicDelegate({
+        key: 'brightness',
+        Characteristic: this.Characteristics.hap.Brightness,
+        unit: '%',
+        value: Math.round(this.resource.body.state.bri / 2.54)
+      }).on('didSet', (value, fromHomeKit) => {
+        if (fromHomeKit) {
+          const bri = Math.round(value * 2.54)
+          this.put({ bri: bri })
+          this.updateAdaptiveLighting()
+        }
+      })
+
+      this.addCharacteristicDelegate({
+        key: 'brightnessChange',
+        Characteristic: this.Characteristics.my.BrightnessChange,
+        value: 0
+      }).on('didSet', async (value) => {
+        this.put({ bri_inc: Math.round(value * 254.0 / 100.0) })
+        await timeout(this.platform.config.waitTimeReset)
+        this.values.brightnessChange = 0
+      })
+      this.values.brightnessChange = 0
+    }
+
+    if (this.capabilities.ct || this.capabilities.xy || this.capabilities.hs) {
+      this.addCharacteristicDelegate({
+        key: 'colormode',
+        value: this.resource.body.state.colormode,
+        silent: true
+      }).on('didSet', (value) => {
+        this.resource.body.colormode = value
+        if (value !== 'ct') {
+          this.checkAdaptiveLighting()
+        }
+      })
+    }
+
+    if (this.capabilities.ct) {
+      this.colorTemperatureDelegate = this.addCharacteristicDelegate({
+        key: 'colorTemperature',
+        Characteristic: this.Characteristics.hap.ColorTemperature,
+        unit: ' mired',
+        props: {
+          minValue: this.capabilities.ctMin,
+          maxValue: this.capabilities.ctMax
+        },
+        value: this.resource.body.state.ct
+      }).on('didSet', (value, fromHomeKit) => {
+        this.checkAdaptiveLighting()
+        const ct = Math.max(
+          this.capabilities.ctMin, Math.min(value, this.capabilities.ctMax)
+        )
+        if (fromHomeKit) {
+          this.put({ ct: ct })
+          this.values.colormode = 'ct'
+        }
+        if (this.capabilities.xy && this.values.colormode === 'ct') {
+          const { h, s } = xyToHsv(ctToXy(ct), this.capabilities.gamut)
+          this.values.hue = h
+          this.values.saturation = s
+        }
+      })
+    }
+
+    if (this.capabilities.xy) {
+      this.addCharacteristicDelegate({
+        key: 'hue',
+        Characteristic: this.Characteristics.hap.Hue,
+        unit: '°'
+      }).on('didSet', (value, fromHomeKit) => {
+        if (fromHomeKit) {
+          const xy = hsvToXy(
+            value, this.values.saturation, this.capabilities.gamut
+          )
+          this.put({ xy: xy })
+          this.values.colormode = 'xy'
+        }
+      })
+      this.addCharacteristicDelegate({
+        key: 'saturation',
+        Characteristic: this.Characteristics.hap.Saturation,
+        unit: '%'
+      }).on('didSet', (value, fromHomeKit) => {
+        if (fromHomeKit) {
+          const xy = hsvToXy(this.values.hue, value, this.capabilities.gamut)
+          this.put({ xy: xy })
+          this.values.colormode = 'xy'
+        }
+      })
+    } else if (this.capabilities.hs) {
+      this.addCharacteristicDelegate({
+        key: 'hue',
+        Characteristic: this.Characteristics.hap.Hue,
+        unit: '°'
+      }).on('didSet', (value, fromHomeKit) => {
+        if (fromHomeKit) {
+          const hue = Math.round(this.hk.hue * 65535.0 / 360.0)
+          this.put({ hue: hue })
+          this.values.colormode = 'hs'
+        }
+      })
+      this.addCharacteristicDelegate({
+        key: 'saturation',
+        Characteristic: this.Characteristics.hap.Saturation,
+        unit: '%'
+      }).on('didSet', (value, fromHomeKit) => {
+        if (fromHomeKit) {
+          const sat = Math.round(this.hk.sat * 254.0 / 100.0)
+          this.put({ sat: sat })
+          this.values.colormode = 'hs'
+        }
+      })
+    }
+
+    if (this.capabilities.colorLoop) {
+      this.addCharacteristicDelegate({
+        key: 'colorLoop',
+        Characteristic: this.Characteristics.my.ColorLoop
+      }).on('didSet', (value, fromHomeKit) => {
+        if (fromHomeKit) {
+          const effect = value ? 'colorloop' : 'none'
+          const state = { effect: effect }
+          if (value) {
+            state.colorloopspeed = this.values.colorLoopSpeed
+          }
+          this.put(state)
+          this.values.colormode = 'hs'
+        }
+      })
+      this.addCharacteristicDelegate({
+        key: 'colorLoopSpeed',
+        Characteristic: this.Characteristics.my.ColorLoopSpeed,
+        unit: 's',
+        value: 25
+      }).on('didSet', (value, fromHomeKit) => {
+        if (fromHomeKit) {
+          const effect = 'colorloop'
+          this.put({ effect: effect, colorloopspeed: value })
+          this.values.colormode = 'hs'
+        }
+      })
+    }
+
+    this.addCharacteristicDelegates()
+
+    if (this.capabilities.bri && this.capabilities.ct && !this.capabilities.hs) {
+      this.addCharacteristicDelegate({
+        key: 'supportedTransitionConfiguration',
+        Characteristic: this.Characteristics.hap
+          .SupportedCharacteristicValueTransitionConfiguration,
+        silent: true
+      })
+      this.addCharacteristicDelegate({
+        key: 'transitionControl',
+        Characteristic: this.Characteristics.hap
+          .CharacteristicValueTransitionControl,
+        silent: true,
+        getter: async () => {
+          this.initAdaptiveLighting()
+          return this.adaptiveLighting.generateControl()
+        },
+        setter: async (value) => {
+          this.initAdaptiveLighting()
+          const control = this.adaptiveLighting.parseControl(value)
+          this.context.transitionControl = value
+          const response = this.adaptiveLighting.generateControlResponse()
+          const parsedResponse = this.adaptiveLighting.parseControl(response)
+          this.vdebug(
+            'Adaptive Lighting: control update: %j => %j',
+            control, parsedResponse
+          )
+          this.values.activeTransitionCount = parsedResponse === '' ? 0 : 1
+          return response
+        }
+      })
+      this.addCharacteristicDelegate({
+        key: 'activeTransitionCount',
+        Characteristic: this.Characteristics.hap
+          .CharacteristicValueActiveTransitionCount,
+        silent: true,
+        value: 0
+      }).on('didSet', (value) => {
+        this.log('Adaptive Lighting: %sabled', value > 0 ? 'en' : 'dis')
+        if (value) {
+          this.updateAdaptiveLighting()
+        }
+      })
+      if (this.values.supportedTransitionConfiguration != null) {
+        this.initAdaptiveLighting()
+      }
+    }
+
+    this.settings = {
+      brightnessAdjustment: 1,
+      resetTimeout: this.platform.config.resetTimeout,
+      waitTimeUpdate: this.platform.config.waitTimeUpdate,
+      wallSwitch: false
+    }
+  }
+
+  updateState (state) {
+    let updateAdaptiveLighting = false
+    for (const key in state) {
+      const value = state[key]
+      this.resource.body.state[key] = value
+      switch (key) {
+        case 'all_on':
+          this.values.on = value
+          updateAdaptiveLighting = true
+          break
+        case 'any_on':
+          this.values.anyOn = value
+          updateAdaptiveLighting = true
+          break
+        case 'bri':
+          if (!this.recentlyUpdated) {
+            this.values.brightness = Math.round(value / 2.54)
+            updateAdaptiveLighting = true
+          }
+          break
+        case 'colormode':
+          this.values.colormode = value
+          break
+        case 'ct':
+          if (!this.recentlyUpdated && this.values.colormode === 'ct') {
+            this.values.colorTemperature = value
+          }
+          break
+        case 'effect':
+          this.values.colorLoop = value === 'colorloop'
+          break
+        case 'hue':
+          if (!this.capabilities.xy) {
+            this.values.hue = value
+          }
+          break
+        case 'on':
+          this.values.on = value
+          break
+        case 'sat':
+          if (!this.capabilities.xy) {
+            this.values.hue = value
+          }
+          break
+        case 'xy':
+          if (
+            !this.recentlyUpdated &&
+            (this.values.colormode !== 'ct' || this.capabilities.computesXy)
+          ) {
+            const { h, s } = xyToHsv(value, this.capabilities.gamut)
+            this.values.hue = h
+            this.values.saturation = s
+          }
+          break
+        default:
+          break
+      }
+    }
+    if (updateAdaptiveLighting) {
+      this.updateAdaptiveLighting()
+    }
+    super.updateState(state)
+  }
+
+  initAdaptiveLighting () {
+    if (this.adaptiveLighting == null) {
+      this.adaptiveLighting = new homebridgeLib.AdaptiveLighting(
+        this.brightnessDelegate, this.colorTemperatureDelegate
+      )
+      this.values.supportedTransitionConfiguration =
+        this.adaptiveLighting.generateConfiguration()
+      if (this.values.activeTransitionCount > 0) {
+        const control = this.adaptiveLighting.parseControl(
+          this.context.transitionControl
+        )
+        this.vdebug('Adaptive Lighting: restore control: %j', control)
+        this.adaptiveLighting.parseControl(this.context.transitionControl)
+      }
+      this.log(
+        'Adaptive Lighting: %sabled',
+        this.values.activeTransitionCount > 0 ? 'en' : 'dis'
+      )
+    }
+  }
+
+  async updateAdaptiveLighting () {
+    if (
+      this.adaptiveLighting == null || // not supported
+      this.values.activeTransitionCount === 0 || // disabled
+      !this.values.on // light is off
+    ) {
+      return
+    }
+    const ct = this.adaptiveLighting.getCt(
+      this.values.brightness * this.settings.brightnessAdjustment
+    )
+    if (ct == null) {
+      this.warn('assertion failed')
+      return
+    }
+    this.debug(
+      '/%s/%d: adaptive lighting: {"state":{"ct": %d}}',
+      this.rtype, this.rid, ct
+    )
+    if (this.values.colormode === 'ct' && ct === this.values.colorTemperature) {
+      return
+    }
+    this.put({ ct: ct })
+    this.fromAdaptiveLighting = true
+    this.values.colormode = 'ct'
+    if (ct !== this.values.colorTemperature) {
+      this.values.colorTemperature = ct
+    } else if (this.capabilities.xy) { // colormode changed
+      const { h, s } = xyToHsv(ctToXy(ct), this.capabilities.gamut)
+      this.values.hue = h
+      this.values.saturation = s
+    }
+    this.fromAdaptiveLighting = false
+  }
+
+  checkAdaptiveLighting (key, value) {
+    if (this.fromAdaptiveLighting) {
+      return
+    }
+    this.adaptiveLighting.deactivate()
+    this.values.activeTransitionCount = 0
+  }
+}
+
+module.exports = Light

package/lib/DeconzService/LightLevel.js

@@ -0,0 +1,54 @@
+// homebridge-deconz/lib/DeconzService/LightLevel.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const DeconzService = require('../DeconzService')
+const Deconz = require('../Deconz')
+
+const { lightLevelToLux } = Deconz.ApiClient
+
+/**
+  * @memberof DeconzService
+  */
+class LightLevel extends DeconzService.SensorsResource {
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.hap.LightSensor
+    super(accessory, resource, params)
+
+    this.addCharacteristicDelegate({
+      key: 'lightlevel',
+      Characteristic: this.Characteristics.hap.CurrentAmbientLightLevel,
+      unit: ' lux'
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'dark',
+      Characteristic: this.Characteristics.my.Dark
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'daylight',
+      Characteristic: this.Characteristics.my.Daylight
+    })
+
+    this.addCharacteristicDelegates()
+  }
+
+  updateState (state) {
+    if (state.lightlevel != null) {
+      this.values.lightlevel = lightLevelToLux(state.lightlevel)
+    }
+    if (state.dark != null) {
+      this.values.dark = state.dark
+    }
+    if (state.daylight != null) {
+      this.values.daylight = state.daylight
+    }
+    super.updateState(state)
+  }
+}
+
+module.exports = LightLevel

package/lib/DeconzService/LightsResource.js

@@ -0,0 +1,112 @@
+// homebridge-deconz/lib/DeconzService/LightsResource.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const homebridgeLib = require('homebridge-lib')
+const Deconz = require('../Deconz')
+const DeconzService = require('../DeconzService')
+
+const { HttpError } = Deconz.ApiClient
+const { timeout } = homebridgeLib
+
+class LightsResource extends DeconzService {
+  constructor (accessory, resource, params) {
+    super(accessory, resource, params)
+    this.rpath += resource.rtype === 'groups' ? '/action' : '/state'
+
+    this.targetState = {}
+    this.deferrals = []
+  }
+
+  addCharacteristicDelegates (params = {}) {
+    this.addCharacteristicDelegate({
+      key: 'lastSeen',
+      Characteristic: this.Characteristics.my.LastSeen,
+      silent: true
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'statusFault',
+      Characteristic: this.Characteristics.hap.StatusFault
+    })
+  }
+
+  updateState (state) {
+    if (state.reachable != null) {
+      this.values.statusFault = state.reachable
+        ? this.Characteristics.hap.StatusFault.NO_FAULT
+        : this.Characteristics.hap.StatusFault.GENERAL_FAULT
+    }
+  }
+
+  async identify () {
+    if (this.capabilities.alert) {
+      if (this.capabilities.breathe) {
+        await this.client.put(this.rpath, { alert: 'breathe' })
+        await timeout(1500)
+        await this.client.put(this.rpath, { alert: 'stop' })
+      }
+      await this.put(this.rpath, { alert: 'select' })
+    }
+  }
+
+  // Collect changes into a combined request.
+  put (state) {
+    for (const key in state) {
+      this.resource.body.state[key] = state[key]
+      this.targetState[key] = state[key]
+    }
+    this._put()
+  }
+
+  // Send the request (for the combined changes) to the gateway.
+  async _put () {
+    try {
+      if (this.updating) {
+        return
+      }
+      this.updating = true
+      if (this.platform.config.waitTimeUpdate > 0) {
+        await timeout(this.platform.config.waitTimeUpdate)
+      }
+      const targetState = this.targetState
+      this.targetState = {}
+      this.updating = false
+      if (
+        this.gateway.transitionTime !== this.gateway.defaultTransitionTime &&
+        targetState.transitiontime === undefined
+      ) {
+        targetState.transitiontime = this.gateway.transitionTime * 10
+        this.gateway.resetTransitionTime()
+      }
+      if (this.capabilities.noTransition) {
+        if (
+          (
+            targetState.on != null || targetState.bri != null ||
+            targetState.bri_inc != null
+          ) && (
+            targetState.xy != null || targetState.ct != null ||
+            targetState.hue != null || targetState.sat != null ||
+            targetState.effect != null
+          )
+        ) {
+          targetState.transitiontime = 0
+        }
+      }
+      this.debug('PUT %s %j', this.rpath, targetState)
+      await this.client.put(this.rpath, targetState)
+      this.recentlyUpdated = true
+      await timeout(500)
+      this.recentlyUpdated = false
+    } catch (error) {
+      if (!(error instanceof HttpError)) {
+        this.warn(error)
+      }
+    }
+  }
+}
+
+module.exports = LightsResource