homebridge-deconz 0.0.10 → 0.0.11

package/lib/DeconzService/Temperature.js

@@ -0,0 +1,63 @@
+// homebridge-deconz/lib/DeconzService/Temperature.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const DeconzService = require('../DeconzService')
+
+/**
+  * @memberof DeconzService
+  */
+class Temperature extends DeconzService.SensorsResource {
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.hap.TemperatureSensor
+    super(accessory, resource, params)
+
+    this.addCharacteristicDelegate({
+      key: 'temperature',
+      Characteristic: this.Characteristics.hap.CurrentTemperature,
+      unit: '°C',
+      props: { minValue: -40, maxValue: 100, minStep: 0.1 },
+      value: 0
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'offset',
+      Characteristic: this.Characteristics.my.Offset,
+      unit: '°C',
+      value: 0
+    }).on('didSet', async (value, fromHomeKit) => {
+      if (fromHomeKit) {
+        await this.put('/config', { offset: Math.round(value * 100) })
+      }
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'displayUnits',
+      Characteristic: this.Characteristics.hap.TemperatureDisplayUnits,
+      value: this.Characteristics.hap.TemperatureDisplayUnits.CELSIUS
+    })
+
+    this.addCharacteristicDelegates()
+
+    this.update(resource.body, resource.rpath)
+  }
+
+  updateState (state) {
+    if (state.temperature != null) {
+      this.values.temperature = Math.round(state.temperature / 10) / 10
+    }
+    super.updateState(state)
+  }
+
+  updateConfig (config) {
+    if (config.offset != null) {
+      this.values.offset = Math.round(config.offset / 10) / 10
+    }
+    super.updateConfig(config)
+  }
+}
+
+module.exports = Temperature

package/lib/DeconzService/Thermostat.js

@@ -0,0 +1,175 @@
+// homebridge-deconz/lib/DeconzService/Thermostat.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const DeconzService = require('../DeconzService')
+
+/**
+  * @memberof DeconzService
+  */
+class Thermostat extends DeconzService.SensorsResource {
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.hap.TemperatureSensor
+    super(accessory, resource, params)
+
+    this.addCharacteristicDelegate({
+      key: 'currentTemperature',
+      Characteristic: this.Characteristics.hap.CurrentTemperature,
+      unit: '°C',
+      props: { minValue: -40, maxValue: 100, minStep: 0.1 },
+      value: 0
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'targetTemperature',
+      Characteristic: this.Characteristics.hap.TargetTemperature,
+      unit: '°C',
+      props: { minValue: 5, maxValue: 30, minStep: 0.5 },
+      value: 0
+    }).on('didSet', async (value, fromHomeKit) => {
+      if (fromHomeKit) {
+        await this.put('/config', { heatsetpoint: Math.round(value * 100) })
+      }
+    })
+
+    if (resource.body.state.valve !== undefined) {
+      this.addCharacteristicDelegate({
+        key: 'valvePosition',
+        Characteristic: this.Characteristics.eve.ValvePosition,
+        unit: '%'
+      })
+    }
+
+    this.addCharacteristicDelegate({
+      key: 'currentState',
+      Characteristic: this.Characteristics.hap.CurrentHeatingCoolingState,
+      props: {
+        validValues: [
+          this.Characteristics.hap.CurrentHeatingCoolingState.OFF,
+          this.Characteristics.hap.CurrentHeatingCoolingState.HEAT
+        ]
+      }
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'targetState',
+      Characteristic: this.Characteristics.hap.TargetHeatingCoolingState,
+      props: {
+        validValues: [
+          this.Characteristics.hap.TargetHeatingCoolingState.OFF,
+          this.Characteristics.hap.TargetHeatingCoolingState.HEAT
+        ]
+      }
+    }).on('didSet', async (value, fromHomeKit) => {
+      if (fromHomeKit) {
+        await this.put('/mode', {
+          mode: value === this.Characteristics.hap.TargetHeatingCoolingState.OFF
+            ? 'off'
+            : this.capabilities.heatValue
+        })
+      }
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'offset',
+      Characteristic: this.Characteristics.my.Offset,
+      unit: '°C',
+      value: 0
+    }).on('didSet', async (value, fromHomeKit) => {
+      if (fromHomeKit) {
+        await this.put('/config', { offset: Math.round(value * 100) })
+      }
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'displayUnits',
+      Characteristic: this.Characteristics.hap.TemperatureDisplayUnits,
+      value: this.Characteristics.hap.TemperatureDisplayUnits.CELSIUS
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'programData',
+      Characteristic: this.Characteristics.eve.ProgramData,
+      silent: true,
+      value: Buffer.from('ff04f6', 'hex').toString('base64')
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'programCommand',
+      Characteristic: this.Characteristics.eve.ProgramCommand,
+      silent: true
+    })
+
+    if (resource.body.config.displayflipped !== undefined) {
+      this.addCharacteristicDelegate({
+        key: 'imageMirroring',
+        Characteristic: this.Characteristics.hap.ImageMirroring
+      }).on('didSet', async (value, fromHomeKit) => {
+        if (fromHomeKit) {
+          await this.put('/config', { displayflipped: value })
+        }
+      })
+    }
+
+    if (resource.body.config.locked !== undefined) {
+      this.addCharacteristicDelegate({
+        key: 'lockPhysicalControls',
+        Characteristic: this.Characteristics.hap.LockPhysicalControls
+      }).on('didSet', async (value, fromHomeKit) => {
+        if (fromHomeKit) {
+          await this.put('/config', {
+            locked: value === this.Characteristics.hap.LockPhysicalControls
+              .CONTROL_LOCK_ENABLED
+          })
+        }
+      })
+    }
+
+    super.addCharacteristicDelegates()
+
+    this.update(resource.body, resource.rpath)
+  }
+
+  updateState (state) {
+    if (state.on != null) {
+      this.values.currentState = state.on
+        ? this.Characteristics.hap.CurrentHeatingCoolingState.HEAT
+        : this.Characteristics.hap.CurrentHeatingCoolingState.OFF
+    }
+    if (state.temperature != null) {
+      this.values.currentTemperature = Math.round(state.temperature / 10) / 10
+    }
+    if (state.valve != null) {
+      this.values.valvePosition = Math.round(state.valve / 2.55)
+    }
+    super.updateState(state)
+  }
+
+  updateConfig (config) {
+    if (config.displayflipped != null) {
+      this.values.imageMirroring = config.displayflipped
+    }
+    if (config.heatsetpoint != null) {
+      this.values.targetTemperature = Math.round(config.heatsetpoint / 50) / 2
+    }
+    if (config.locked != null) {
+      this.values.lockPhysicalControls = config.locked
+        ? this.Characteristics.hap.LockPhysicalControls.CONTROL_LOCK_ENABLED
+        : this.Characteristics.hap.LockPhysicalControls.CONTROL_LOCK_DISABLED
+    }
+    if (config.mode != null) {
+      this.values.targetState = config.mode === 'off'
+        ? this.Characteristics.hap.TargetHeatingCoolingState.OFF
+        : this.Characteristics.hap.TargetHeatingCoolingState.HEAT
+    }
+    if (config.offset != null) {
+      this.values.offset = Math.round(config.offset / 10) / 10
+    }
+    super.updateConfig(config)
+  }
+}
+
+module.exports = Thermostat

package/lib/DeconzService/WarningDevice.js

@@ -0,0 +1,68 @@
+// homebridge-deconz/lib/DeconzService/WarningDevice.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const DeconzService = require('../DeconzService')
+
+class WarningDevice 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: false
+    }).on('didSet', async (value, fromHomeKit) => {
+      if (fromHomeKit) {
+        if (this.timer != null) {
+          clearTimeout(this.timer)
+          delete this.timer
+        }
+        const onTime = this.values.duration > 0 ? this.values.duration : 1
+        let body = { alert: 'none' }
+        if (value) {
+          if (this.values.mute) {
+            body = { alert: 'blink', ontime: onTime }
+          } else if (this.values.duration === 0) {
+            body = { alert: 'select' }
+          } else {
+            body = { alert: 'lselect', ontime: onTime }
+          }
+        }
+        this.put(body)
+        if (value) {
+          this.timer = setTimeout(() => {
+            this.values.on = false
+          }, onTime * 1000)
+        }
+      }
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'duration',
+      Characteristic: this.Characteristics.hap.SetDuration
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'mute',
+      Characteristic: this.Characteristics.hap.Mute
+    })
+
+    this.addCharacteristicDelegates()
+
+    this.update(resource.body, resource.rpath)
+  }
+
+  updateState (state, rpath) {
+    if (state.on != null) {
+      this.values.on = state.on
+    }
+    super.updateState(state)
+  }
+}
+
+module.exports = WarningDevice

package/lib/DeconzService/WindowCovering.js

@@ -0,0 +1,139 @@
+// homebridge-deconz/lib/DeconzService/WindowCovering.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
+
+class WindowCovering extends DeconzService.LightsResource {
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.hap.WindowCovering
+    super(accessory, resource, params)
+
+    this.addCharacteristicDelegate({
+      key: 'currentPosition',
+      Characteristic: this.Characteristics.hap.CurrentPosition,
+      unit: '%'
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'targetPosition',
+      Characteristic: this.Characteristics.hap.TargetPosition,
+      unit: '%'
+    }).on('didSet', async (value, fromHomeKit) => {
+      if (!fromHomeKit) {
+        return
+      }
+      this.values.targetPosition = Math.round(this.values.targetPosition / 5) * 5
+      await this.setPosition()
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'positionState',
+      Characteristic: this.Characteristics.hap.PositionState,
+      value: this.Characteristics.hap.PositionState.STOPPED
+    }).on('didSet', (value) => {
+      if (value === this.Characteristics.hap.PositionState.STOPPED) {
+        this.values.targetPosition = this.values.currentPosition
+      }
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'holdPosition',
+      Characteristic: this.Characteristics.hap.HoldPosition
+    }).on('didSet', () => {
+      this.put({ stop: true })
+      this.values.positionState = this.Characteristics.hap.PositionState.STOPPED
+    })
+
+    if (this.venetianBlind) {
+      this.addCharacteristicDelegate({
+        key: 'closeUpwards',
+        Characteristic: this.Characteristics.my.CloseUpwards
+      }).on('didSet', async (value, fromHomeKit) => {
+        if (!fromHomeKit) {
+          return
+        }
+        await this.setPosition()
+      })
+    }
+
+    if (resource.capabilities.positionChange) {
+      this.addCharacteristicDelegate({
+        key: 'positionChange',
+        Characteristic: this.Characteristics.my.PositionChange
+      }).on('didSet', async (value) => {
+        if (value !== 0) {
+          this.put({ lift_inc: -value })
+          await timeout(this.platform.config.waitTimeReset)
+          this.values.positionChange = 0
+        }
+      })
+      this.values.positionChange = 0
+    }
+
+    this.addCharacteristicDelegates()
+
+    this.update(resource.body, resource.rpath)
+  }
+
+  setPosition () {
+    if (this.timer != null) {
+      clearTimeout(this.timer)
+      delete this.timer
+    }
+    let lift = 100 - this.values.targetPosition // % closed --> % open
+    if (this.venetianBlind) {
+      if (this.values.closeUpwards) {
+        lift *= -1
+      }
+      lift += 100
+      lift /= 2
+      lift = Math.round(lift)
+      this.targetCloseUpwards = this.values.closeUpwards
+    }
+    this.values.positionState =
+      this.values.targetPosition > this.values.currentPosition
+        ? this.Characteristics.hap.PositionState.INCREASING
+        : this.Characteristics.hap.PositionState.DECREASING
+    this.put({ lift: lift })
+    this.timer = setTimeout(() => {
+      this.values.positionState =
+        this.Characteristics.hap.PositionState.STOPPED
+    }, 15000)
+  }
+
+  updateState (state, rpath) {
+    if (state.lift != null) {
+      let position = Math.round(state.lift / 5) * 5
+      let closeUpwards
+      if (this.venetianBlind) {
+        if (position < 0) {
+          position *= -1
+          closeUpwards = true
+        } else if (position > 0) {
+          closeUpwards = false
+        }
+      }
+      position = 100 - position // % open -> % closed
+      if (
+        position === this.values.targetPosition &&
+        (closeUpwards == null || closeUpwards === this.targetCloseUpwards)
+      ) {
+        this.values.positionState = this.Characteristics.hap.PositionState.STOPPED
+      }
+      this.values.currentPosition = position
+      if (closeUpwards != null) {
+        this.values.closeUpwards = closeUpwards
+      }
+    }
+    super.updateState(state)
+  }
+}
+
+module.exports = WindowCovering

package/lib/DeconzService/index.js

@@ -5,39 +5,90 @@
 
 'use strict'
 
+const homebridgeLib = require('homebridge-lib')
+const Deconz = require('../Deconz')
+
+const { dateToString } = Deconz.ApiClient
+
 /** Service delegates.
-  * @hideconstructor
+  * @extends ServiceDelegate
   */
-class DeconzService {
+class DeconzService extends homebridgeLib.ServiceDelegate {
+  static get AirPressure () { return require('./AirPressure') }
   static get AirQuality () { return require('./AirQuality') }
   static get Alarm () { return require('./Alarm') }
-  // static get Battery () { return require('./Battery') }
+  static get Battery () { return require('./Battery') }
   static get Button () { return require('./Button') }
-  // static get CarbonMonoxide () { return require('./CarbonMonoxide') }
-  // static get Consumption () { return require('./Consumption') }
-  // static get Daylight () { return require('./Daylight') }
+  static get CarbonMonoxide () { return require('./CarbonMonoxide') }
+  static get Consumption () { return require('./Consumption') }
+  static get Contact () { return require('./Contact') }
+  static get Daylight () { return require('./Daylight') }
   static get DeviceSettings () { return require('./DeviceSettings') }
-  // static get Flag () { return require('./Flag') }
-  // static get Fire () { return require('./Fire') }
+  static get Flag () { return require('./Flag') }
   static get GatewaySettings () { return require('./GatewaySettings') }
-  // static get Humidity () { return require('./Humidity') }
-  // static get Light () { return require('./Light') }
+  static get Humidity () { return require('./Humidity') }
+  static get Leak () { return require('./Leak') }
   static get Light () { return require('./Light') }
-  // static get LightLevel () { return require('./LightLevel') }
-  // static get Outlet () { return require('./Outlet') }
-  // static get OpenClose () { return require('./OpenClose') }
-  // static get Power () { return require('./Power') }
-  // static get Presence () { return require('./Presence') }
-  // static get Pressure () { return require('./Pressure') }
-  static get Sensor () { return require('./Sensor') }
-  // static get Status () { return require('./Status') }
-  // static get Switch () { return require('./Switch') }
-  // static get Temperature () { return require('./Temperature') }
-  // static get Thermostat () { return require('./Thermostat') }
-  // static get Vibration () { return require('./Vibration') }
-  // static get Water () { return require('./Water') }
-  // static get WarningDevice () { return require('./WarningDevice') }
-  // static get WindowCovering () { return require('./WindowCovering') }
+  static get LightsResource () { return require('./LightsResource') }
+  static get LightLevel () { return require('./LightLevel') }
+  static get Motion () { return require('./Motion') }
+  static get Outlet () { return require('./Outlet') }
+  static get Power () { return require('./Power') }
+  static get SensorsResource () { return require('./SensorsResource') }
+  static get Status () { return require('./Status') }
+  static get Smoke () { return require('./Smoke') }
+  static get Switch () { return require('./Switch') }
+  static get Temperature () { return require('./Temperature') }
+  static get Thermostat () { return require('./Thermostat') }
+  static get WarningDevice () { return require('./WarningDevice') }
+  static get WindowCovering () { return require('./WindowCovering') }
+
+  constructor (accessory, resource, params) {
+    super(accessory, {
+      id: resource.id,
+      name: resource.body.name,
+      Service: params.Service,
+      subtype: resource.subtype,
+      primaryService: params.primaryService
+    })
+    this.id = resource.id
+    this.gateway = accessory.gateway
+    this.client = accessory.client
+    this.resource = resource
+    this.rtype = resource.rtype
+    this.rid = resource.rid
+    this.rpath = resource.rpath
+    this.capabilities = resource.capabilities
+
+    this.serviceNameByRpath = {}
+  }
+
+  addResource (resource) {
+    this.serviceNameByRpath[resource.rpath] = resource.serviceName
+    DeconzService[resource.serviceName].addResource(this, resource)
+  }
+
+  update (body, rpath) {
+    if (this.updating) {
+      return
+    }
+    const serviceName = this.serviceNameByRpath[rpath]
+    if (serviceName != null) {
+      if (body.state != null) {
+        DeconzService[serviceName].updateResourceState(this, body.state)
+      }
+      return
+    }
+    if (body.lastseen != null && this.rtype === 'lights') {
+      this.values.lastSeen = dateToString(body.lastseen)
+    }
+    if (body.config != null) {
+      this.updateConfig(body.config)
+    }
+    if (body.state != null) {
+      this.updateState(body.state, rpath)
+    }
+  }
 }
 
 module.exports = DeconzService

package/package.json

@@ -4,7 +4,7 @@
   "displayName": "Homebridge deCONZ",
   "author": "Erik Baauw",
   "license": "Apache-2.0",
-  "version": "0.0.10",
+  "version": "0.0.11",
   "keywords": [
     "homebridge-plugin",
     "homekit",
@@ -25,7 +25,7 @@
     "node": "^16.13.2"
   },
   "dependencies": {
-    "homebridge-lib": "~5.2.0",
+    "homebridge-lib": "~5.2.2",
     "semver": "^7.3.5",
     "ws": "^8.4.2",
     "xml2js": "~0.4.23"

package/lib/DeconzAccessory/Device.js

@@ -1,69 +0,0 @@
-// homebridge-deconz/lib/DeconzAccessory/Device.js
-// Copyright © 2022 Erik Baauw. All rights reserved.
-//
-// Homebridge plugin for deCONZ.
-
-'use strict'
-
-const DeconzAccessory = require('.')
-const DeconzService = require('../DeconzService')
-
-/** Delegate class for a HomeKit accessory,
-  * corresponding to a Zigbee or virtual device on a deCONZ gateway,
-  * that is not yet supported.
-  * @extends DeconzAccessory
-  * @memberof DeconzAccessory
-  */
-class Device extends DeconzAccessory {
-  /** Instantiate a delegate for an accessory corresponding to a device.
-    * @param {DeconzAccessory.Gateway} gateway - The gateway.
-    * @param {Deconz.Device} device - The device.
-    */
-  constructor (gateway, device) {
-    super(gateway, device)
-
-    this.identify()
-
-    this.service = new DeconzService.Button(this, {
-      name: this.name + ' Button',
-      button: 1,
-      events: DeconzService.Button.SINGLE | DeconzService.Button.LONG,
-      primaryService: true
-    })
-
-    this.settingsService = new DeconzService.DeviceSettings(this, {
-      name: this.name + ' Settings',
-      subtype: this.id,
-      resource: this.device.rpaths.join(', '),
-      expose: true,
-      logLevel: gateway.logLevel
-    })
-
-    this
-      .on('polled', (device) => {
-        this.vdebug('%s: polled', this.device.rpaths.join(', '))
-        this.service.update(1003)
-      })
-      .on('changed', (rpath, body) => {
-        if (Object.keys(body).length === 1) {
-          if (body.state != null) {
-            rpath += '/state'
-            body = body.state
-          } else if (body.config != null) {
-            rpath += '/config'
-            body = body.config
-          }
-        }
-        this.debug('%s: changed: %j', rpath, body)
-        this.service.update(1002)
-      })
-      .on('identify', this.identify)
-
-    setImmediate(() => {
-      this.debug('initialised')
-      this.emit('initialised')
-    })
-  }
-}
-
-module.exports = Device