homebridge-deconz 0.0.13 → 0.0.16

package/lib/Deconz/Resource.js

@@ -256,7 +256,7 @@ class Resource {
   get prio () {
     if (this.rtype === 'groups') return -1
     if (this.rtype === 'lights') return this.endpoint
-    return sensorsPrios.indexOf(this.type)
+    return sensorsPrios.indexOf(this.serviceName)
   }
 
   /** The resource path of the resource, e.g. `/lights/1`.
@@ -270,7 +270,7 @@ class Resource {
     * corresponding HomeKit service, or `null` for unsupported and unknown
     * resources.
     *
-    * This is derived from the resource type and`type` in the resource body.
+    * This is derived from the resource type and `type` in the resource body.
     * @type {string}
     */
   get serviceName () {
@@ -656,7 +656,7 @@ class Resource {
             buttons.push([5, 'Next', SINGLE | LONG])
             break
           case 'TRADFRI wireless dimmer':
-            if (this.obj.mode === 1) {
+            if (this.body.mode === 1) {
               buttons.push([1, 'Turn Right', SINGLE | LONG])
               buttons.push([2, 'Turn Left', SINGLE | LONG])
             } else {

package/lib/DeconzAccessory/Gateway.js

@@ -44,6 +44,7 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
 
     this.gateway = this
     this.id = params.config.bridgeid
+    this.recommendedSoftware = this.platform.packageJson.engines.deCONZ
 
     /** Persisted properties.
       * @type {Object}
@@ -109,6 +110,9 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
       '%s %s gateway v%s', this.values.manufacturer, this.values.model,
       this.values.software
     )
+    if (this.values.software !== this.recommendedSoftware) {
+      this.warn('recommended version: deCONZ v%s', this.recommendedSoftware)
+    }
 
     /** Map of Accessory delegates by id for the gateway.
       * @type {Object<string, DeconzAccessory.Device>}
@@ -157,7 +161,7 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
     this.heartbeatEnabled = true
     this
       .on('identify', this.identify)
-      .once('heartbeat', this.init)
+      .once('heartbeat', (beat) => { this.initialBeat = beat })
       .on('heartbeat', this.heartbeat)
       .on('shutdown', this.shutdown)
   }
@@ -182,6 +186,15 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
       this.values.manufacturer, this.values.model, this.values.software,
       this.nAccessories, this.nDevices, this.nResourcesMonitored
     )
+    if (this.values.software !== this.recommendedSoftware) {
+      this.warn('recommended version: deCONZ v%s', this.recommendedSoftware)
+    }
+    if (this.context.migration != null) {
+      this.log(
+        'migration: %s: %d resources',
+        this.context.migration, this.nResourcesMonitored
+      )
+    }
     if (this.logLevel > 2) {
       this.vdebug(
         '%d gateway resouces: %j', this.nResources,
@@ -210,28 +223,24 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
     }
   }
 
-  /** Initialise the gateway delegate.
-    */
-  async init (beat) {
-    try {
-      this.debug('initialising...')
-      this.initialBeat = beat
-      await this.connect()
-      this.initialised = true
-      this.debug('initialised')
-      this.emit('initialised')
-    } catch (error) { this.error(error) }
-  }
-
   /** Update properties from gateway announcement.
     * @param {string} host - The gateway hostname or IP address and port.
     * @param {Object} config - The response body of an unauthenticated
     * GET `/config` (from {@link DeconzDiscovery#config config()}.
     */
-  found (host, config) {
-    this.values.host = host
-    this.context.config = config
-    this.values.software = config.swversion
+  async found (host, config) {
+    try {
+      this.context.host = host
+      this.values.host = host
+      this.context.config = config
+      this.values.software = config.swversion
+      if (!this.initialised) {
+        this.debug('initialising...')
+        await this.connect()
+      }
+    } catch (error) {
+      this.error(error)
+    }
   }
 
   async shutdown () {
@@ -412,8 +421,8 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
       for (const id in this.exposeErrorById) {
         this.resetExposeError(id)
       }
-      this.context.fullState = null
       this.pollNext = true
+      this.pollFullState = true
     } catch (error) {
       if (
         error instanceof Deconz.ApiError && error.type === 101 && retry < 8
@@ -627,6 +636,45 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
 
   // ===========================================================================
 
+  async onUiGet (a) {
+    this.debug('ui request: GET %s', a.join('/'))
+    if (a.length === 0) {
+      return {
+        status: 200,
+        body: {
+          expose: this.service.values.expose,
+          groups: this.service.values.groups,
+          heartrate: this.service.values.heartrate,
+          lights: this.service.values.lights,
+          logLevel: this.service.values.logLevel,
+          schedules: this.service.values.schedules,
+          sensors: this.service.values.sensors
+          // deviceByRidByRtype: this.deviceByRidByRtype
+        }
+      }
+    }
+    if (a[0] !== 'accessories') {
+      return { status: 403 } // Forbidden
+    }
+    if (a.length === 1) {
+      return { status: 200, body: this.deviceByRidByRtype }
+    }
+    if (this.deviceById[a[1]] == null) {
+      return { status: 404 } // Not Found
+    }
+    if (a.length === 2) {
+      return { status: 200, body: this.deviceById[a[1]] }
+    }
+    return { status: 403 } // Forbidden
+  }
+
+  async onUiPut (a, body) {
+    this.debug('ui request: PUT %s %j', a.join('/'), body)
+    return { status: 501 } // Not Implented
+  }
+
+  // ===========================================================================
+
   /** Poll the gateway.
     *
     * Periodically get the gateway full state and call
@@ -639,9 +687,11 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
     try {
       this.polling = true
       this.vdebug('%spolling...', this.pollNext ? 'priority ' : '')
-      if (this.context.fullState == null) {
-        this.context.fullState = await this.client.get('/')
-        this.context.fullState.groups[0] = await this.client.get('/groups/0')
+      if (this.context.fullState == null || this.pollFullState) {
+        const fullState = await this.client.get('/')
+        fullState.groups[0] = await this.client.get('/groups/0')
+        this.context.fullState = fullState
+        this.pollFullState = false
       } else {
         const config = await this.client.get('/config')
         if (config.bridgeid === this.id && config.UTC == null) {
@@ -674,6 +724,11 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
       this.pollNext = false
       this.polling = false
     }
+    if (!this.initialised) {
+      this.initialised = true
+      this.debug('initialised')
+      this.emit('initialised')
+    }
   }
 
   /** Analyse the peristed full state of the gateway,
@@ -857,6 +912,7 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
     }
 
     this.nAccessories = Object.keys(this.accessoryById).length
+    this.nResourcesMonitored = Object.keys(this.accessoryByRpath).length
     this.nExposeErrors = Object.keys(this.exposeErrorById).length
     if (this.nExposeErrors === 0) {
       this.vdebug('%d accessories', this.nAccessories)
@@ -867,8 +923,6 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
     }
 
     if (changed) {
-      this.nResourcesMonitored = Object.keys(this.accessoryByRpath).length
-      this.identify()
       if (this.context.migration == null) {
         const response = await this.client.post('/resourcelinks', {
           name: 'homebridge-deconz',
@@ -882,10 +936,7 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
           links: Object.keys(this.accessoryByRpath).sort()
         })
       }
-      this.log(
-        'migration: %s: %d resources',
-        this.context.migration, this.nResourcesMonitored
-      )
+      this.identify()
     }
   }
 

package/lib/DeconzAccessory/index.js

@@ -39,7 +39,7 @@ class DeconzAccessory extends homebridgeLib.AccessoryDelegate {
       manufacturer: device.resource.manufacturer,
       model: device.resource.model,
       firmware: device.resource.firmware,
-      category: category
+      category
     })
 
     this.context.gid = gateway.id

package/lib/DeconzPlatform.js

@@ -45,6 +45,7 @@ class DeconzPlatform extends homebridgeLib.Platform {
       .stringKey('name')
       .stringKey('platform')
       .boolKey('forceHttp')
+      .stringKey('host')
       .arrayKey('hosts')
       .boolKey('noResponse')
       .intKey('parallelRequests', 1, 30)
@@ -60,19 +61,26 @@ class DeconzPlatform extends homebridgeLib.Platform {
 
     try {
       optionParser.parse(configJson)
+      if (this.config.host != null) {
+        this.config.hosts.push(this.config.host)
+      }
       this.discovery = new Deconz.Discovery({
         forceHttp: this.config.forceHttp,
         timeout: this.config.timeout
       })
       this.discovery
         .on('error', (error) => {
-          this.log(
-            '%s: request %d: %s %s', error.request.name,
-            error.request.id, error.request.method, error.request.resource
-          )
-          this.warn(
-            '%s: request %d: %s', error.request.name, error.request.id, error
-          )
+          if (error instanceof homebridgeLib.HttpClient.HttpError) {
+            this.log(
+              '%s: request %d: %s %s', error.request.name,
+              error.request.id, error.request.method, error.request.resource
+            )
+            this.warn(
+              '%s: request %d: %s', error.request.name, error.request.id, error
+            )
+            return
+          }
+          this.warn(error)
         })
         .on('request', (request) => {
           this.debug(
@@ -101,12 +109,10 @@ class DeconzPlatform extends homebridgeLib.Platform {
   async foundGateway (host, config) {
     const id = config.bridgeid
     if (this.gatewayMap[id] == null) {
-      this.gatewayMap[id] = new DeconzAccessory.Gateway(this, {
-        config: config,
-        host: host
-      })
+      this.gatewayMap[id] = new DeconzAccessory.Gateway(this, { config, host })
     }
-    this.gatewayMap[id].found(host, config)
+    await this.gatewayMap[id].found(host, config)
+    await events.once(this.gatewayMap[id], 'initialised')
     this.emit('found')
   }
 
@@ -124,17 +130,25 @@ class DeconzPlatform extends homebridgeLib.Platform {
   async init () {
     try {
       const jobs = []
-      this.debug('job %d: find at least one gateway', jobs.length)
-      jobs.push(events.once(this, 'found'))
       if (this.config.hosts.length > 0) {
         for (const host of this.config.hosts) {
           this.debug('job %d: find gateway at %s', jobs.length, host)
           jobs.push(this.findHost(host))
         }
       } else {
+        this.debug('job %d: find at least one gateway', jobs.length)
+        jobs.push(events.once(this, 'found'))
         for (const id in this.gatewayMap) {
+          const gateway = this.gatewayMap[id]
+          const host = gateway.context.host
           this.debug('job %d: find gateway %s', jobs.length, id)
-          jobs.push(this.gatewayMap[id].init())
+          jobs.push(events.once(gateway, 'initialised'))
+          try {
+            const config = await this.discovery.config(host)
+            await this.foundGateway(host, config)
+          } catch (error) {
+            this.warn('%s: %s', id, error)
+          }
         }
       }
 
@@ -150,9 +164,61 @@ class DeconzPlatform extends homebridgeLib.Platform {
 
       this.log('%d gateways', Object.keys(this.gatewayMap).length)
       this.emit('initialised')
+      const dumpInfo = {
+        config: this.config,
+        gatewayMap: {}
+      }
+      for (const id in this.gatewayMap) {
+        const gateway = this.gatewayMap[id]
+        dumpInfo.gatewayMap[id] = gateway.context
+      }
+      await this.createDumpFile(dumpInfo)
     } catch (error) { this.error(error) }
   }
 
+  async onUiRequest (method, url, body) {
+    const a = url.split('/').slice(1)
+    if (a.length < 1) {
+      return { status: 403 } // Forbidden
+    }
+    if (a[0] === 'gateways') {
+      if (a.length === 1) {
+        if (method === 'GET') {
+          // const gatewayByHost = await this.discovery.discover()
+          const gatewayByHost = {}
+          for (const id in this.gatewayMap) {
+            const gateway = this.gatewayMap[id]
+            gatewayByHost[gateway.context.host] = {
+              config: gateway.context.config,
+              host: gateway.context.host,
+              id
+            }
+          }
+          return {
+            status: 200,
+            body: Object.keys(gatewayByHost).sort().map((host) => {
+              return gatewayByHost[host]
+            })
+          }
+        }
+        return { status: 405 } // Method Not Allowed
+      }
+      const gateway = this.gatewayMap[a[1]]
+      const path = a.slice(2)
+      if (gateway == null) {
+        return { status: 404 } // Not Found
+      }
+      if (method === 'GET') {
+        return gateway.onUiGet(path)
+      }
+      if (method === 'PUT') {
+        return gateway.onUiPut(path, body)
+      }
+      return { status: 405 } // Method Not Allowed
+    }
+    return { status: 403 } // Forbidden
+  }
+
   async heartbeat (beat) {
     try {
       if (beat % 300 === 5 && this.config.hosts.length === 0) {

package/lib/DeconzService/Consumption.js

@@ -57,7 +57,7 @@ class Consumption extends DeconzService.SensorsResource {
   }
 
   updateState (state) {
-    Consumption.updateResourceState(this.service, state)
+    Consumption.updateResourceState(this, state)
     super.updateState(state)
   }
 }

package/lib/DeconzService/Light.js

@@ -51,7 +51,7 @@ class Light extends DeconzService.LightsResource {
       }).on('didSet', (value, fromHomeKit) => {
         if (fromHomeKit) {
           const bri = Math.round(value * 2.54)
-          this.put({ bri: bri })
+          this.put({ bri })
           this.updateAdaptiveLighting()
         }
       })
@@ -97,7 +97,7 @@ class Light extends DeconzService.LightsResource {
           this.capabilities.ctMin, Math.min(value, this.capabilities.ctMax)
         )
         if (fromHomeKit) {
-          this.put({ ct: ct })
+          this.put({ ct })
           this.values.colormode = 'ct'
         }
         if (this.capabilities.xy && this.values.colormode === 'ct') {
@@ -118,7 +118,7 @@ class Light extends DeconzService.LightsResource {
           const xy = hsvToXy(
             value, this.values.saturation, this.capabilities.gamut
           )
-          this.put({ xy: xy })
+          this.put({ xy })
           this.values.colormode = 'xy'
         }
       })
@@ -129,7 +129,7 @@ class Light extends DeconzService.LightsResource {
       }).on('didSet', (value, fromHomeKit) => {
         if (fromHomeKit) {
           const xy = hsvToXy(this.values.hue, value, this.capabilities.gamut)
-          this.put({ xy: xy })
+          this.put({ xy })
           this.values.colormode = 'xy'
         }
       })
@@ -140,8 +140,8 @@ class Light extends DeconzService.LightsResource {
         unit: '°'
       }).on('didSet', (value, fromHomeKit) => {
         if (fromHomeKit) {
-          const hue = Math.round(this.hk.hue * 65535.0 / 360.0)
-          this.put({ hue: hue })
+          const hue = Math.round(this.values.hue * 65535.0 / 360.0)
+          this.put({ hue })
           this.values.colormode = 'hs'
         }
       })
@@ -151,8 +151,8 @@ class Light extends DeconzService.LightsResource {
         unit: '%'
       }).on('didSet', (value, fromHomeKit) => {
         if (fromHomeKit) {
-          const sat = Math.round(this.hk.sat * 254.0 / 100.0)
-          this.put({ sat: sat })
+          const sat = Math.round(this.values.saturation * 254.0 / 100.0)
+          this.put({ sat })
           this.values.colormode = 'hs'
         }
       })
@@ -165,7 +165,7 @@ class Light extends DeconzService.LightsResource {
       }).on('didSet', (value, fromHomeKit) => {
         if (fromHomeKit) {
           const effect = value ? 'colorloop' : 'none'
-          const state = { effect: effect }
+          const state = { effect }
           if (value) {
             state.colorloopspeed = this.values.colorLoopSpeed
           }
@@ -181,7 +181,7 @@ class Light extends DeconzService.LightsResource {
       }).on('didSet', (value, fromHomeKit) => {
         if (fromHomeKit) {
           const effect = 'colorloop'
-          this.put({ effect: effect, colorloopspeed: value })
+          this.put({ effect, colorloopspeed: value })
           this.values.colormode = 'hs'
         }
       })
@@ -236,31 +236,8 @@ class Light extends DeconzService.LightsResource {
     }
 
     if (this.resource.rtype === 'groups') {
-      this.sceneServices = []
-      for (const scene of this.resource.body.scenes) {
-        const service = new homebridgeLib.ServiceDelegate(accessory, {
-          name: this.resource.body.name + ' ' + scene.name,
-          Service: this.Services.hap.Switch,
-          subtype: this.subtype + '-S' + scene.id
-        })
-        service.addCharacteristicDelegate({
-          key: 'on',
-          Characteristic: this.Characteristics.hap.On,
-          value: false
-        }).on('didSet', async (value, fromHomeKit) => {
-          this.checkAdaptiveLighting()
-          if (fromHomeKit && value) {
-            try {
-              const path = this.resource.rpath + '/scenes/' + scene.id + '/recall'
-              this.debug('PUT %s', path)
-              await this.client.put(path)
-            } catch (error) { this.error(error) }
-            await timeout(this.platform.config.waitTimeReset)
-            service.values.on = false
-          }
-        })
-        this.sceneServices.push(service)
-      }
+      this.sceneServices = {}
+      this.updateScenes(this.resource.body.scenes)
     }
 
     if (this.capabilities.effects != null) {
@@ -412,6 +389,43 @@ class Light extends DeconzService.LightsResource {
     super.updateState(state)
   }
 
+  updateScenes (scenes) {
+    const sceneById = {}
+    for (const scene of scenes) {
+      sceneById[scene.id] = scene
+      if (this.sceneServices[scene.id] == null) {
+        const service = new homebridgeLib.ServiceDelegate(this.accessoryDelegate, {
+          name: this.resource.body.name + ' ' + scene.name,
+          Service: this.Services.hap.Switch,
+          subtype: this.subtype + '-S' + scene.id
+        })
+        service.addCharacteristicDelegate({
+          key: 'on',
+          Characteristic: this.Characteristics.hap.On,
+          value: false
+        }).on('didSet', async (value, fromHomeKit) => {
+          this.checkAdaptiveLighting()
+          if (fromHomeKit && value) {
+            try {
+              const path = this.resource.rpath + '/scenes/' + scene.id + '/recall'
+              this.debug('PUT %s', path)
+              await this.client.put(path)
+            } catch (error) { this.error(error) }
+            await timeout(this.platform.config.waitTimeReset)
+            service.values.on = false
+          }
+        })
+        this.sceneServices[scene.id] = service
+      }
+    }
+    for (const id in this.scenesServices) {
+      if (sceneById[id] == null) {
+        this.scenesSerices[id].destroy()
+        delete this.scenesService[id]
+      }
+    }
+  }
+
   initAdaptiveLighting () {
     if (this.adaptiveLighting == null) {
       this.adaptiveLighting = new homebridgeLib.AdaptiveLighting(
@@ -453,7 +467,7 @@ class Light extends DeconzService.LightsResource {
     if (this.values.colormode === 'ct' && ct === this.values.colorTemperature) {
       return
     }
-    this.put({ ct: ct })
+    this.put({ ct })
     this.fromAdaptiveLighting = true
     this.values.colormode = 'ct'
     if (ct !== this.values.colorTemperature) {

package/lib/DeconzService/Motion.js

@@ -35,7 +35,7 @@ class Motion extends DeconzService.SensorsResource {
           : value === this.Characteristics.eve.Sensitivity.LOW
             ? 0
             : Math.round(this.sensitivitymax / 2)
-        await this.put('/config', { sensitivity: sensitivity })
+        await this.put('/config', { sensitivity })
       }
     })
 

package/lib/DeconzService/Power.js

@@ -75,7 +75,7 @@ class Power extends DeconzService.SensorsResource {
   }
 
   updateState (state) {
-    Power.updateResourceState(this.service, state)
+    Power.updateResourceState(this, state)
     super.updateState(state)
   }
 }

package/lib/DeconzService/Switch.js

@@ -42,8 +42,8 @@ class Switch extends DeconzService.SensorsResource {
       this.buttonServices[i] = new DeconzService.Button(this.accessoryDelegate, {
         name: this.name + ' ' + label,
         button: Number(i),
-        events: events,
-        hasRepeat: hasRepeat
+        events,
+        hasRepeat
       })
     }
   }

package/lib/DeconzService/Temperature.js

@@ -27,6 +27,7 @@ class Temperature extends DeconzService.SensorsResource {
       key: 'offset',
       Characteristic: this.Characteristics.my.Offset,
       unit: '°C',
+      props: { minValue: -5, maxValue: 5, minStep: 0.1 },
       value: 0
     }).on('didSet', async (value, fromHomeKit) => {
       if (fromHomeKit) {

package/lib/DeconzService/Thermostat.js

@@ -65,7 +65,7 @@ class Thermostat extends DeconzService.SensorsResource {
       }
     }).on('didSet', async (value, fromHomeKit) => {
       if (fromHomeKit) {
-        await this.put('/mode', {
+        await this.put('/config', {
           mode: value === this.Characteristics.hap.TargetHeatingCoolingState.OFF
             ? 'off'
             : this.capabilities.heatValue
@@ -77,6 +77,7 @@ class Thermostat extends DeconzService.SensorsResource {
       key: 'offset',
       Characteristic: this.Characteristics.my.Offset,
       unit: '°C',
+      props: { minValue: -5, maxValue: 5, minStep: 0.1 },
       value: 0
     }).on('didSet', async (value, fromHomeKit) => {
       if (fromHomeKit) {

package/lib/DeconzService/WindowCovering.js

@@ -37,10 +37,6 @@ class WindowCovering extends DeconzService.LightsResource {
       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({
@@ -103,10 +99,6 @@ class WindowCovering extends DeconzService.LightsResource {
   }
 
   async 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) {
@@ -121,11 +113,8 @@ class WindowCovering extends DeconzService.LightsResource {
       this.values.targetPosition > this.values.currentPosition
         ? this.Characteristics.hap.PositionState.INCREASING
         : this.Characteristics.hap.PositionState.DECREASING
-    await this.put({ lift: lift })
-    this.timer = setTimeout(() => {
-      this.values.positionState =
-        this.Characteristics.hap.PositionState.STOPPED
-    }, 15000)
+    this.moving = new Date()
+    await this.put({ lift })
   }
 
   updateState (state) {
@@ -146,9 +135,13 @@ class WindowCovering extends DeconzService.LightsResource {
         this.values.closeUpwards = closeUpwards
       }
       if (
-        position === this.values.targetPosition &&
-        (closeUpwards == null || closeUpwards === this.targetCloseUpwards)
+        this.moving == null || new Date() - this.moving >= 30000 || (
+          position === this.values.targetPosition &&
+          (closeUpwards == null || closeUpwards === this.targetCloseUpwards)
+        )
       ) {
+        this.moving = null
+        this.values.targetPosition = position
         this.values.positionState = this.Characteristics.hap.PositionState.STOPPED
       }
     }

package/lib/DeconzService/index.js

@@ -91,6 +91,9 @@ class DeconzService extends homebridgeLib.ServiceDelegate {
     if (body.state != null) {
       this.updateState(body.state, rpath)
     }
+    if (body.scenes != null && this.rtype === 'groups') {
+      this.updateScenes(body.scenes)
+    }
   }
 }