homebridge-deconz 0.0.6 → 0.0.11

package/lib/DeconzService/AirQuality.js

@@ -7,21 +7,27 @@
 
 const DeconzService = require('../DeconzService')
 
-class AirQuality extends DeconzService.Sensor {
-  constructor (deconzAccessory, params = {}) {
-    params.Service = deconzAccessory.Services.hap.AirQualitySensor
-    super(deconzAccessory, params)
+/**
+  * @memberof DeconzService
+  */
+class AirQuality extends DeconzService.SensorsResource {
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.hap.AirQualitySensor
+    super(accessory, resource, params)
 
     this.addCharacteristicDelegate({
       key: 'airQuality',
       Characteristic: this.Characteristics.hap.AirQuality
     })
+
     this.addCharacteristicDelegate({
       key: 'vocDensity',
       Characteristic: this.Characteristics.hap.VOCDensity
     })
-    super.addCharacteristicDelegates(params)
-    this.update(params.sensor)
+
+    super.addCharacteristicDelegates()
+
+    this.update(resource.body)
   }
 
   airQualityValue (value) {
@@ -41,10 +47,14 @@ class AirQuality extends DeconzService.Sensor {
     }
   }
 
-  update (sensor) {
-    this.values.airQuality = this.airQualityValue(sensor.state.airquality)
-    this.values.vocDensity = Math.round(sensor.state.airqualityppb * 4.56)
-    super.update(sensor)
+  updateState (state) {
+    if (this.values.airQuality != null) {
+      this.values.airQuality = this.airQualityValue(state.airquality)
+    }
+    if (this.values.vocDensity != null) {
+      this.values.vocDensity = Math.round(state.airqualityppb * 4.57)
+    }
+    super.updateState(state)
   }
 }
 

package/lib/DeconzService/Alarm.js

@@ -7,22 +7,29 @@
 
 const DeconzService = require('../DeconzService')
 
-class Alarm extends DeconzService.Sensor {
-  constructor (deconzAccessory, params = {}) {
-    params.Service = deconzAccessory.Services.hap.AirQualitySensor
-    super(deconzAccessory, params)
+/**
+  * @memberof DeconzService
+  */
+class Alarm extends DeconzService.SensorsResource {
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.my.Resource
+    super(accessory, resource, params)
 
     this.addCharacteristicDelegate({
       key: 'alarm',
-      Characteristic: this.Characteristics.hap.my.Alamrm
+      Characteristic: this.Characteristics.my.Alarm
     })
+
     super.addCharacteristicDelegates(params)
-    this.update(params.sensor)
+
+    this.update(resource.body)
   }
 
-  update (sensor) {
-    this.value.alarm = sensor.state.alarm || sensor.state.test
-    super.update(sensor)
+  updateState (state) {
+    if (state.alarm != null || state.test != null) {
+      this.values.alarm = state.alarm || state.test
+    }
+    super.updateState(state)
   }
 }
 

package/lib/DeconzService/Battery.js

@@ -0,0 +1,43 @@
+// homebridge-deconz/lib/DeconzService/Battery.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const homebridgeLib = require('homebridge-lib')
+// const Deconz = require('../Deconz')
+
+// const { dateToString } = Deconz.ApiClient
+
+/**
+  * @memberof DeconzService
+  */
+class Battery extends homebridgeLib.ServiceDelegate.Battery {
+  constructor (accessory, resource, params = {}) {
+    super(accessory, {
+      name: accessory.name + ' Battery'
+    })
+  }
+
+  updateState (state) {
+    if (state.battery != null) {
+      this.values.batteryLevel = state.battery
+    }
+    if (state.charging != null) {
+      this.values.chargingState = state.charging
+        ? this.Characteristics.hap.ChargingState.CHARGING
+        : this.Characteristics.hap.ChargingState.NOT_CHARGING
+    }
+    super.updateState(state)
+  }
+
+  updateConfig (config) {
+    if (config.battery != null) {
+      this.values.batteryLevel = config.battery
+    }
+    super.updateConfig(config)
+  }
+}
+
+module.exports = Battery

package/lib/DeconzService/Button.js

@@ -22,6 +22,9 @@ const deconzEvent = {
 
 let homeKitEvent
 
+/**
+  * @memberof DeconzService
+  */
 class Button extends homebridgeLib.ServiceDelegate {
   static get SINGLE () { return 0x01 }
   static get DOUBLE () { return 0x02 }
@@ -112,6 +115,12 @@ class Button extends homebridgeLib.ServiceDelegate {
       Characteristic: this.Characteristics.hap.ProgrammableSwitchEvent,
       props: this.props(params.events)
     })
+
+    this.addCharacteristicDelegate({
+      key: 'index',
+      Characteristic: this.Characteristics.hap.ServiceLabelIndex,
+      value: params.button
+    })
   }
 
   homeKitValue (value, oldValue = 0, repeat = false) {
@@ -129,11 +138,12 @@ class Button extends homebridgeLib.ServiceDelegate {
       case deconzEvent.SHORT_RELEASE:
         return homeKitEvent.SINGLE_PRESS
       case deconzEvent.HOLD:
-      case deconzEvent.LONG_RELEASE:
         if (repeat) {
           return homeKitEvent.SINGLE_PRESS
         }
-        if (button === oldButton && oldEvent === deconzEvent.HOLD) {
+        // falls through
+      case deconzEvent.LONG_RELEASE:
+        if (repeat || (button === oldButton && oldEvent === deconzEvent.HOLD)) {
           // Already issued action on previous Hold.
           return null
         }

package/lib/DeconzService/CarbonMonoxide.js

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

package/lib/DeconzService/Consumption.js

@@ -0,0 +1,65 @@
+// homebridge-deconz/lib/DeconzService/Consumption.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 Consumption extends DeconzService.SensorsResource {
+  static addResource (service, resource) {
+    service.addCharacteristicDelegate({
+      key: 'totalConsumption',
+      Characteristic: service.Characteristics.eve.TotalConsumption,
+      unit: ' kWh'
+    })
+
+    if (
+      resource.body.state.power !== undefined &&
+      service.values.currentConsumption === undefined
+    ) {
+      service.addCharacteristicDelegate({
+        key: 'currentConsumption',
+        Characteristic: service.Characteristics.eve.CurrentConsumption,
+        unit: ' W'
+      })
+    }
+  }
+
+  static updateResourceState (service, state) {
+    if (state.consumption != null) {
+      service.values.totalConsumption = state.consumption / 1000
+    }
+    if (state.power != null) {
+      service.values.currentConsumption = state.power
+    }
+    if (state.lastupdated != null) {
+      service.values.lastUpdated = dateToString(state.lastupdated)
+    }
+  }
+
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.my.Resource
+    super(accessory, resource, params)
+
+    Consumption.addResource(this, resource)
+
+    super.addCharacteristicDelegates()
+
+    this.update(resource.body)
+  }
+
+  updateState (state) {
+    Consumption.updateResourceState(this.service, state)
+    super.updateState(state)
+  }
+}
+
+module.exports = Consumption

package/lib/DeconzService/Contact.js

@@ -0,0 +1,60 @@
+// homebridge-deconz/lib/DeconzService/Contact.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const DeconzService = require('../DeconzService')
+
+/**
+  * @memberof DeconzService
+  */
+class Contact extends DeconzService.SensorsResource {
+  constructor (accessory, resource, params = {}) {
+    params.Service = accessory.Services.hap.ContactSensor
+    super(accessory, resource, params)
+
+    this.addCharacteristicDelegate({
+      key: 'contact',
+      Characteristic: this.Characteristics.hap.ContactSensorState
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'timesOpened',
+      Characteristic: this.Characteristics.eve.TimesOpened,
+      value: 0
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'openDuration',
+      Characteristic: this.Characteristics.eve.OpenDuration,
+      value: 0
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'closedDuration',
+      Characteristic: this.Characteristics.eve.ClosedDuration,
+      value: 0
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'lastActivation',
+      Characteristic: this.Characteristics.eve.LastActivation,
+      silent: true
+    })
+
+    this.addCharacteristicDelegates({ noTampered: true })
+  }
+
+  updateState (state) {
+    if (state.open != null) {
+      this.values.contact = state.open
+        ? this.Characteristics.hap.ContactSensorState.CONTACT_NOT_DETECTED
+        : this.Characteristics.hap.ContactSensorState.CONTACT_DETECTED
+    }
+    super.updateState(state)
+  }
+}
+
+module.exports = Contact

package/lib/DeconzService/Daylight.js

@@ -0,0 +1,132 @@
+// homebridge-deconz/lib/DeconzService/Daylight.js
+// Copyright © 2022 Erik Baauw. All rights reserved.
+//
+// Homebridge plugin for deCONZ.
+
+'use strict'
+
+const DeconzService = require('../DeconzService')
+const Deconz = require('../Deconz')
+
+const { dateToString, lightLevelToLux } = Deconz.ApiClient
+
+const daylightEvents = {
+  100: { name: 'Solar Midnight', period: 'Night' },
+  110: { name: 'Astronomical Dawn', period: 'Astronomical Twilight' },
+  120: { name: 'Nautical Dawn', period: 'Nautical Twilight' },
+  130: { name: 'Dawn', period: 'Twilight' },
+  140: { name: 'Sunrise', period: 'Sunrise' },
+  150: { name: 'End Sunrise', period: 'Golden Hour' },
+  160: { name: 'End Golden Hour', period: 'Day' },
+  170: { name: 'Solar Noon', period: 'Day' },
+  180: { name: 'Start Golden Hour', period: 'Golden Hour' },
+  190: { name: 'Start Sunset', period: 'Sunset' },
+  200: { name: 'Sunset', period: 'Twilight' },
+  210: { name: 'Dusk', period: 'Nautical Twilight' },
+  220: { name: 'Nautical Dusk', period: 'Astronomical Twilight' },
+  230: { name: 'Astronomical Dusk', period: 'Night' }
+}
+
+const daylightPeriods = {
+  Night: { lightlevel: 0, daylight: false, dark: true },
+  'Astronomical Twilight': { lightlevel: 100, daylight: false, dark: true },
+  'Nautical Twilight': { lightlevel: 1000, daylight: false, dark: true },
+  Twilight: { lightlevel: 10000, daylight: false, dark: false },
+  Sunrise: { lightlevel: 15000, daylight: true, dark: false },
+  Sunset: { lightlevel: 20000, daylight: true, dark: false },
+  'Golden Hour': { lightlevel: 40000, daylight: true, dark: false },
+  Day: { lightlevel: 65535, daylight: true, dark: false }
+}
+
+/**
+  * @memberof DeconzService
+  */
+class Daylight 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.addCharacteristicDelegate({
+      key: 'status',
+      Characteristic: this.Characteristics.my.Status,
+      props: {
+        minValue: 100,
+        maxValue: 230,
+        perms: [
+          this.Characteristic.Perms.READ,
+          this.Characteristic.Perms.NOTIFY]
+      },
+      value: resource.body.state.status
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'lastEvent',
+      Characteristic: this.Characteristics.my.LastEvent
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'period',
+      Characteristic: this.Characteristics.my.Period
+    })
+
+    this.addCharacteristicDelegates()
+
+    this.addCharacteristicDelegate({
+      key: 'sunrise',
+      Characteristic: this.Characteristics.my.Sunrise
+    })
+
+    this.addCharacteristicDelegate({
+      key: 'sunset',
+      Characteristic: this.Characteristics.my.Sunset
+    })
+
+    if (!resource.body.config.configured) {
+      this.warn('%s: %s not configured', resource.rpath, resource.body.type)
+    }
+
+    this.update(resource.body)
+  }
+
+  updateState (state) {
+    if (state.status != null) {
+      this.values.status = state.status
+      const { name, period } = daylightEvents[state.status]
+      this.values.lastEvent = name
+      this.values.period = period
+      const { lightlevel } = daylightPeriods[period]
+      this.values.lightlevel = lightLevelToLux(lightlevel)
+    }
+    if (state.dark != null) {
+      this.values.dark = state.dark
+    }
+    if (state.daylight != null) {
+      this.values.daylight = state.daylight
+    }
+    if (state.sunrise != null) {
+      this.values.sunrise = dateToString(state.sunrise)
+    }
+    if (state.sunset != null) {
+      this.values.sunset = dateToString(state.sunset)
+    }
+    super.updateState(state)
+  }
+}
+
+module.exports = Daylight

package/lib/DeconzService/DeviceSettings.js

@@ -9,13 +9,15 @@ const homebridgeLib = require('homebridge-lib')
 
 /** Delegate class for a DeconzDevice service.
   * @extends ServiceDelegate
+  * @memberof DeconzService
   */
 class DeviceSettings extends homebridgeLib.ServiceDelegate {
   constructor (accessory, params = {}) {
     params.Service = accessory.Services.my.DeconzDevice
-    params.primaryService = true
     super(accessory, params)
 
+    this.debug('settings: %j', params)
+
     this.addCharacteristicDelegate({
       key: 'expose',
       Characteristic: this.Characteristics.my.Expose,
@@ -25,14 +27,20 @@ class DeviceSettings extends homebridgeLib.ServiceDelegate {
       accessory.gateway.exposeDevice(params.subtype, value)
     })
 
+    if (params.hasRepeat != null) {
+      this.addCharacteristicDelegate({
+        key: 'repeat',
+        Characteristic: this.Characteristics.my.Repeat,
+        props: { minValue: 0, maxValue: 1, minStep: 1 },
+        value: 0
+      })
+    }
+
     if (params.logLevel != null) {
       this.addCharacteristicDelegate({
         key: 'logLevel',
         Characteristic: this.Characteristics.my.LogLevel,
-        value: params.logLevel,
-        silent: true
-      }).on('didSet', (value) => {
-        accessory.logLevel = value
+        value: params.logLevel
       })
     }
 

package/lib/DeconzService/Flag.js

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

package/lib/DeconzService/GatewaySettings.js

@@ -9,11 +9,13 @@ const homebridgeLib = require('homebridge-lib')
 
 /** Delegate class for a DeconzGateway service.
   * @extends ServiceDelegate
+  * @memberof DeconzService
   */
 class GatewaySettings extends homebridgeLib.ServiceDelegate {
   constructor (gateway, params = {}) {
     params.Service = gateway.Services.my.DeconzGateway
     super(gateway, params)
+    this.gateway = gateway
 
     this.addCharacteristicDelegate({
       key: 'expose',
@@ -69,10 +71,7 @@ class GatewaySettings extends homebridgeLib.ServiceDelegate {
     this.addCharacteristicDelegate({
       key: 'logLevel',
       Characteristic: this.Characteristics.my.LogLevel,
-      value: gateway.platform.logLevel,
-      silent: true
-    }).on('didSet', (value) => {
-      gateway.logLevel = value
+      value: gateway.platform.logLevel
     })
 
     this.addCharacteristicDelegate({
@@ -127,10 +126,11 @@ class GatewaySettings extends homebridgeLib.ServiceDelegate {
     })
 
     this.addCharacteristicDelegate({
-      key: 'transitiontime',
+      key: 'transitionTime',
       Characteristic: this.Characteristics.my.TransitionTime,
-      value: 0.4
+      value: this.gateway.defaultTransitionTime
     })
+    this.values.transitionTime = this.gateway.defaultTransitionTime
 
     this.addCharacteristicDelegate({
       key: 'unlock',
@@ -153,72 +153,22 @@ class GatewaySettings extends homebridgeLib.ServiceDelegate {
       } catch (error) { this.error(error) }
     })
     this.values.unlock = false
-
-    this.addCharacteristicDelegate({
-      key: 'host',
-      value: params.host,
-      silent: true
-    }).on('didSet', (value) => {
-      if (gateway.client != null) {
-        gateway.client.host = value
-      }
-      if (gateway.wsClient != null) {
-        gateway.wsClient.host = this.values.wsHost
-      }
-    })
-    this.values.host = params.host
-
-    this.addCharacteristicDelegate({
-      key: 'rtypes',
-      value: [],
-      silent: true
-    }).on('didSet', async () => {
-      gateway.pollNext = true
-    })
-
-    this.addCharacteristicDelegate({
-      key: 'username',
-      silent: true
-    }).on('didSet', (value) => {
-      gateway.client.username = value
-    })
-
-    Object.defineProperty(this.values, 'wsHost', {
-      configurable: true, // make sure we can delete it again
-      get () {
-        const { hostname } = homebridgeLib.OptionParser.toHost(
-          'host', this.host
-        )
-        return hostname + ':' + this.wsPort
-      }
-    })
-
-    this.addCharacteristicDelegate({
-      key: 'wsPort',
-      value: 443,
-      silent: true
-    }).on('didSet', (value) => {
-      if (gateway.wsClient != null) {
-        gateway.wsClient.host = this.values.wsHost
-      }
-    })
   }
 
   async updateRtypes (rtype, value) {
-    const rtypes = this.values.rtypes.slice()
+    const rtypes = this.gateway.values.rtypes.slice()
     if (value) {
       rtypes.push(rtype)
     } else {
       rtypes.splice(rtypes.indexOf(rtype), 1)
     }
-    this.values.rtypes = rtypes
+    this.gateway.values.rtypes = rtypes
   }
 
   update (config) {
     this.values.expose = true
     this.values.lastUpdated = new Date().toString().slice(0, 24)
     this.values.restart = false
-    this.values.wsPort = config.websocketport
   }
 }