homebridge-deconz 0.0.10 → 0.0.13

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

package/lib/DeconzService/Motion.js

@@ -0,0 +1,101 @@
+// homebridge-deconz/lib/DeconzService/Motion.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const DeconzService = require('../DeconzService')
+
+/**
+  * @memberof DeconzService
+  */
+class Motion extends DeconzService.SensorsResource {
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.hap.MotionSensor
+    super(accessory, resource, params)
+
+    this.durationKey = resource.body.config.delay !== null ? 'delay' : 'duration'
+    this.sensitivitymax = resource.body.config.sensitivitymax
+
+    this.addCharacteristicDelegate({
+      key: 'motion',
+      Characteristic: this.Characteristics.hap.MotionDetected,
+      value: 0
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'sensitivity',
+      Characteristic: this.Characteristics.eve.Sensitivity,
+      value: this.Characteristics.hap.TemperatureDisplayUnits.CELSIUS
+    }).on('didSet', async (value, fromHomeKit) => {
+      if (fromHomeKit) {
+        const sensitivity = value === this.Characteristics.eve.Sensitivity.HIGH
+          ? this.sensitivitymax
+          : value === this.Characteristics.eve.Sensitivity.LOW
+            ? 0
+            : Math.round(this.sensitivitymax / 2)
+        await this.put('/config', { sensitivity: sensitivity })
+      }
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'duration',
+      Characteristic: this.Characteristics.eve.Duration,
+      unit: 's'
+    }).on('didSet', async (value, fromHomeKit) => {
+      if (fromHomeKit) {
+        const config = {}
+        config[this.durationKey] =
+          value === this.Characteristics.eve.Duration.VALID_VALUES[0] ? 0 : value
+        await this.put('/config', config)
+      }
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'lastActivation',
+      Characteristic: this.Characteristics.eve.LastActivation,
+      silent: true
+    })
+
+    this.addCharacteristicDelegates()
+
+    this.update(resource.body)
+  }
+
+  updateState (state) {
+    if (state.presence != null) {
+      this.values.motion = state.presence
+    }
+    if (state.vibration != null) {
+      this.values.motion = state.vibration
+    }
+    if (state.tampered != null) {
+      this.values.tampered = state.tampered
+    }
+    super.updateState(state)
+  }
+
+  updateConfig (config) {
+    if (config[this.durationKey] != null) {
+      let duration
+      for (const value of this.Characteristics.eve.Duration.VALID_VALUES) {
+        duration = value
+        if (config[this.durationKey] <= value) {
+          break
+        }
+      }
+      this.values.duration = duration
+    }
+    if (config.sensitivity != null) {
+      this.values.sensitivity = config.sensitivity === this.sensitivitymax
+        ? this.Characteristics.eve.Sensitivity.HIGH
+        : config.sensitivity === 0
+          ? this.Characteristics.eve.Sensitivity.LOW
+          : this.Characteristics.eve.Sensitivity.MEDIUM
+    }
+    super.updateConfig(config)
+  }
+}
+
+module.exports = Motion

package/lib/DeconzService/Outlet.js

@@ -0,0 +1,76 @@
+// homebridge-deconz/lib/DeconzService/Outlet.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const DeconzService = require('../DeconzService')
+
+class Outlet extends DeconzService.LightsResource {
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.hap.Outlet
+    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 })
+      }
+    })
+
+    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.addCharacteristicDelegate({
+      key: 'outletInUse',
+      Characteristic: this.Characteristics.hap.OutletInUse,
+      value: 1
+    })
+
+    this.addCharacteristicDelegates()
+
+    this.settings = {
+      resetTimeout: this.platform.config.resetTimeout,
+      waitTimeUpdate: this.platform.config.waitTimeUpdate,
+      wallSwitch: false
+    }
+  }
+
+  updateState (state, rpath) {
+    for (const key in state) {
+      const value = state[key]
+      this.resource.body.state[key] = value
+      switch (key) {
+        case 'all_on':
+          this.values.on = value
+          break
+        case 'any_on':
+          this.values.anyOn = value
+          break
+        case 'on':
+          this.values.on = value
+          break
+        default:
+          break
+      }
+    }
+    super.updateState(state)
+  }
+}
+
+module.exports = Outlet

package/lib/DeconzService/Power.js

@@ -0,0 +1,83 @@
+// homebridge-deconz/lib/DeconzService/Power.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const Deconz = require('../Deconz')
+const DeconzService = require('../DeconzService')
+
+const { dateToString } = Deconz.ApiClient
+
+/**
+  * @memberof DeconzService
+  */
+class Power extends DeconzService.SensorsResource {
+  static addResource (service, resource) {
+    if (service.values.currentConsumption === undefined) {
+      service.addCharacteristicDelegate({
+        key: 'currentConsumption',
+        Characteristic: service.Characteristics.eve.CurrentConsumption,
+        unit: ' W'
+      })
+    }
+
+    if (resource.body.state.current !== undefined) {
+      service.addCharacteristicDelegate({
+        key: 'electricCurrent',
+        Characteristic: service.Characteristics.eve.ElectricCurrent,
+        unit: ' A'
+      })
+    }
+
+    if (resource.body.state.voltage !== undefined) {
+      service.addCharacteristicDelegate({
+        key: 'voltage',
+        Characteristic: service.Characteristics.eve.Voltage,
+        unit: ' V'
+      })
+    }
+
+    if (service.values.lastUpdated === undefined) {
+      service.addCharacteristicDelegate({
+        key: 'lastUpdated',
+        Characteristic: service.Characteristics.my.LastUpdated,
+        silent: true
+      })
+    }
+  }
+
+  static updateResourceState (service, state) {
+    if (state.power != null) {
+      service.values.currentConsumption = state.power
+    }
+    if (state.current != null) {
+      service.values.electricCurrent = state.current / 1000
+    }
+    if (state.voltage != null) {
+      service.values.voltage = state.voltage
+    }
+    if (state.lastupdated != null) {
+      service.values.lastUpdated = dateToString(state.lastupdated)
+    }
+  }
+
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.my.Resource
+    super(accessory, resource, params)
+
+    Power.addResource(this, resource)
+
+    super.addCharacteristicDelegates()
+
+    this.update(resource.body)
+  }
+
+  updateState (state) {
+    Power.updateResourceState(this.service, state)
+    super.updateState(state)
+  }
+}
+
+module.exports = Power

package/lib/DeconzService/SensorsResource.js

@@ -0,0 +1,96 @@
+// homebridge-deconz/lib/DeconzService/SensorsResource.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const Deconz = require('../Deconz')
+const DeconzService = require('../DeconzService')
+
+const { dateToString, HttpError } = Deconz.ApiClient
+
+/**
+  * @memberof DeconzService
+  */
+class SensorsResource extends DeconzService {
+  // constructor (accessory, resource, params) {
+  //   super(accessory, resource, params)
+  // }
+
+  addCharacteristicDelegates (params = {}) {
+    if (!params.noLastUpdated) {
+      this.addCharacteristicDelegate({
+        key: 'lastUpdated',
+        Characteristic: this.Characteristics.my.LastUpdated,
+        silent: true
+      })
+    }
+
+    this.addCharacteristicDelegate({
+      key: 'enabled',
+      Characteristic: this.Characteristics.my.Enabled
+    }).on('didSet', (value) => {
+      this.values.statusActive = value
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'statusActive',
+      Characteristic: this.Characteristics.hap.StatusActive
+    })
+
+    if (this.resource.body.config.reachable !== undefined) {
+      this.addCharacteristicDelegate({
+        key: 'statusFault',
+        Characteristic: this.Characteristics.hap.StatusFault
+      })
+    }
+
+    if (this.resource.body.state.tampered !== undefined && !params.noTampered) {
+      this.addCharacteristicDelegate({
+        key: 'tampered',
+        Characteristic: this.Characteristics.hap.StatusTampered
+      })
+    }
+  }
+
+  async identify () {
+    if (this.resource.body.config.alert) {
+      return this.put('/config', { alert: 'select' })
+    }
+  }
+
+  updateState (state) {
+    if (state.lastupdated != null) {
+      this.values.lastUpdated = dateToString(state.lastupdated)
+    }
+    if (state.tampered != null) {
+      this.values.tampered = state.tampered
+        ? this.Characteristics.hap.StatusTampered.TAMPERED
+        : this.Characteristics.hap.StatusTampered.NOT_TAMPERED
+    }
+  }
+
+  updateConfig (config) {
+    if (config.on != null) {
+      this.values.enabled = !!config.on
+    }
+    if (config.reachable != null) {
+      this.values.statusFault = config.reachable
+        ? this.Characteristics.hap.StatusFault.NO_FAULT
+        : this.Characteristics.hap.StatusFault.GENERAL_FAULT
+    }
+  }
+
+  async put (resource, body) {
+    try {
+      await this.client.put(this.rpath + resource, body)
+    } catch (error) {
+      if (!(error instanceof HttpError)) {
+        this.warn(error)
+      }
+    }
+  }
+}
+
+module.exports = SensorsResource

package/lib/DeconzService/Smoke.js

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

package/lib/DeconzService/Status.js

@@ -0,0 +1,53 @@
+// homebridge-deconz/lib/DeconzService/Status.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const DeconzService = require('../DeconzService')
+
+/**
+  * @memberof DeconzService
+  */
+class Status extends DeconzService.SensorsResource {
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.my.Status
+    super(accessory, resource, params)
+
+    if (resource.capabilities.readonly) {
+      this.addCharacteristicDelegate({
+        key: 'status',
+        Characteristic: this.Characteristics.my.Status,
+        props: {
+          perms: [
+            this.Characteristic.Perms.READ, this.Characteristic.Perms.NOTIFY
+          ]
+        }
+      })
+    } else {
+      this.addCharacteristicDelegate({
+        key: 'status',
+        Characteristic: this.Characteristics.my.Status,
+        props: resource.capabilities.props
+      }).on('didSet', async (value, fromHomeKit) => {
+        if (fromHomeKit) {
+          await this.put('/state', { status: value })
+        }
+      })
+    }
+
+    this.addCharacteristicDelegates()
+
+    this.update(resource.body)
+  }
+
+  updateState (state) {
+    if (state.status != null) {
+      this.values.status = state.status
+    }
+    super.updateState(state)
+  }
+}
+
+module.exports = Status

package/lib/DeconzService/Switch.js

@@ -0,0 +1,93 @@
+// homebridge-deconz/lib/DeconzService/Switch.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const DeconzService = require('../DeconzService')
+
+/**
+  * @memberof DeconzService
+  */
+class Switch extends DeconzService.SensorsResource {
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.hap.ServiceLabel
+    super(accessory, resource, params)
+
+    this.addCharacteristicDelegate({
+      key: 'namespace',
+      Characteristic: this.Characteristics.hap.ServiceLabelNamespace,
+      value: resource.capabilities.namespace
+    })
+
+    this.addCharacteristicDelegates({ noLastUpdated: true })
+
+    this.buttonResources = {}
+    this.buttonServices = {}
+    this.hasRepeat = false
+  }
+
+  createButtonServices (resource) {
+    this.buttonResources[resource.rpath] = {
+      buttonEvent: resource.body.state.buttonevent,
+      lastUpdated: '',
+      toButtonEvent: resource.capabilities.toButtonEvent
+    }
+    for (const i in resource.capabilities.buttons) {
+      const { label, events, hasRepeat } = resource.capabilities.buttons[i]
+      if (hasRepeat) {
+        this.hasRepeat = hasRepeat
+      }
+      this.buttonServices[i] = new DeconzService.Button(this.accessoryDelegate, {
+        name: this.name + ' ' + label,
+        button: Number(i),
+        events: events,
+        hasRepeat: hasRepeat
+      })
+    }
+  }
+
+  updateState (state, rpath) {
+    const buttonResource = this.buttonResources[rpath]
+    if (buttonResource.lastUpdated === '') {
+      buttonResource.lastUpdated = state.lastupdated
+    } else if (
+      state.lastupdated != null &&
+      state.lastupdated !== buttonResource.lastUpdated
+    ) {
+      buttonResource.lastUpdated = state.lastupdated
+      const oldValue = buttonResource.buttonEvent
+      if (state.buttonevent != null) {
+        buttonResource.buttonEvent = buttonResource.toButtonEvent == null
+          ? state.buttonevent
+          : buttonResource.toButtonEvent(state.buttonevent)
+      }
+      // TODO handle repeat
+      this.updateButtonEvent(
+        buttonResource.buttonEvent, oldValue,
+        this.accessoryDelegate.settingsService.values.repeat
+      )
+    }
+    super.updateState(state)
+  }
+
+  updateConfig (config) {
+    // TODO handle change in devicemode
+    super.updateConfig(config)
+  }
+
+  updateButtonEvent (value, oldValue, repeat) {
+    const i = Math.floor(value / 1000)
+    if (this.buttonServices[i] != null) {
+      this.buttonServices[i].update(value, oldValue, repeat)
+    }
+  }
+
+  async identify () {
+    this.debug('hasRepeat: %j', this.hasRepeat)
+    return super.identify()
+  }
+}
+
+module.exports = Switch