homebridge-deconz 0.0.26 → 0.1.0

package/lib/DeconzAccessory/Gateway.js

@@ -50,24 +50,15 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
       * @type {Object}
       * @property {Object} config - Response body of unauthenticated
       * GET `/config` (from {@link DeconzDiscovery#config config()}.
-      * @property {Object.<string, boolean>} blacklist - Map of blacklisted
-      * devices.
       * @property {Object} fullState - The gateway's full state, from the
       * last time the gateway was polled.
-      * @property {Object} settings - The persisted settings, maintained through
+      * @property {Object.<String, Object>} settingsById - The persisted settings, maintained through
       * the Homebridge UI.
       */
     this.context // eslint-disable-line no-unused-expressions
-    this.context.host = params.host
     this.context.config = params.config
     if (this.context.settingsById == null) {
       this.context.settingsById = {}
-      // migration
-      for (const id in this.context.blacklist) {
-        this.context.settingsById[id] = { expose: false }
-      }
-      delete this.context.blacklist
-      // end migration
     }
     if (this.context.fullState != null) {
       this.analyseFullState(this.context.fullState, {
@@ -83,6 +74,41 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
       this.client.apiKey = value
     })
 
+    this.addPropertyDelegate({
+      key: 'autoExpose',
+      value: { groups: false, lights: true, schedules: false, sensors: true },
+      silent: true
+    }).on('didSet', async () => {
+      this.pollNext = true
+    })
+
+    this.addPropertyDelegate({
+      key: 'brightnessAdjustment',
+      value: 1,
+      silent: true
+    })
+
+    this.addPropertyDelegate({
+      key: 'expose',
+      value: true,
+      silent: true
+    }).on('didSet', async (value) => {
+      try {
+        this.service.values.statusActive = value
+        if (value) {
+          await this.connect()
+        } else {
+          await this.reset()
+        }
+      } catch (error) { this.error(error) }
+    })
+
+    this.addPropertyDelegate({
+      key: 'heartrate',
+      value: 30,
+      silent: true
+    })
+
     this.addPropertyDelegate({
       key: 'host',
       value: params.host,
@@ -99,11 +125,54 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
     this.values.host = params.host
 
     this.addPropertyDelegate({
-      key: 'rtypes',
-      value: [],
+      key: 'periodicEvents',
+      value: true,
       silent: true
-    }).on('didSet', async () => {
-      this.pollNext = true
+    })
+
+    this.addPropertyDelegate({
+      key: 'restart',
+      value: false,
+      silent: true
+    }).on('didSet', async (value) => {
+      if (value) {
+        try {
+          await this.client.restart()
+          this.values.search = false
+          this.values.unlock = false
+          return
+        } catch (error) { this.warn(error) }
+      }
+    })
+
+    this.addPropertyDelegate({
+      key: 'search',
+      value: false,
+      silent: true
+    }).on('didSet', async (value) => {
+      if (value) {
+        try {
+          await this.client.search()
+          await homebridgeLib.timeout(120000)
+          this.values.search = false
+          return
+        } catch (error) { this.warn(error) }
+      }
+    })
+
+    this.addPropertyDelegate({
+      key: 'unlock',
+      value: false,
+      silent: true
+    }).on('didSet', async (value) => {
+      if (value) {
+        try {
+          await this.client.unlock()
+          await homebridgeLib.timeout(60000)
+          this.values.unlock = false
+          return
+        } catch (error) { this.warn(error) }
+      }
     })
 
     this.addPropertyDelegate({
@@ -142,20 +211,14 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
       */
     this.exposeErrorById = {}
 
-    /** Map of services to un-blacklist a gateway device.
-      * @type {Object<string, DeconzService.DeviceSettings>}
-      */
-    this.serviceById = {}
-
     /** The service delegate for the Gateway Settings settings.
       * @type {DeconzService.GatewaySettings}
       */
-    this.service = new DeconzService.GatewaySettings(this, {
-      name: this.name + ' Gateway Settings',
+    this.service = new DeconzService.Gateway(this, {
+      name: this.name + ' Gateway',
       primaryService: true,
       host: params.host
     })
-    this.manageLogLevel(this.service.characteristicDelegate('logLevel'))
 
     /** The service delegate for the Stateless Programmable Switch service.
       * @type {DeconzService.Button}
@@ -241,7 +304,6 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
     */
   async found (host, config) {
     try {
-      this.context.host = host
       this.values.host = host
       this.context.config = config
       this.values.software = config.swversion
@@ -255,6 +317,7 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
   }
 
   async shutdown () {
+    this.service.values.statusActive = false
     return this.wsClient.close()
   }
 
@@ -264,14 +327,14 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
   async heartbeat (beat) {
     beat -= this.initialBeat
     try {
-      if (beat > 0) {
+      if (this.values.periodicEvents && beat > 0) {
         for (const { rate, event } of periodicEvents) {
           if (beat % rate === 0) {
             this.buttonService.update(event)
           }
         }
       }
-      if (beat - this.pollBeat >= this.service.values.heartrate || this.pollNext) {
+      if (beat - this.pollBeat >= this.values.heartrate || this.pollNext) {
         this.pollBeat = beat
         await this.poll()
       }
@@ -390,13 +453,13 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
       })
       .on('added', (rtype, rid, body) => {
         this.vdebug('/%s/%d: added: %j', rtype, rid, body)
-        if (this.service.values[rtype]) {
+        if (this.values.autoExpose[rtype]) {
           this.pollNext = true
         }
       })
       .on('deleted', (rtype, rid) => {
         this.vdebug('/%s/%d: deleted', rtype, rid)
-        if (this.service.values[rtype]) {
+        if (this.values.autoExpose[rtype]) {
           this.pollNext = true
         }
       })
@@ -418,7 +481,7 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
     * gateway, and analyse the full state.
     */
   async connect (retry = 0) {
-    if (!this.service.values.expose) {
+    if (!this.values.expose) {
       this.warn('unlock gateway and set Expose to obtain an API key')
       return
     }
@@ -428,6 +491,8 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
           await this.client.getApiKey('homebridge-deconz')
       }
       this.wsClient.listen()
+      this.service.values.restart = false
+      this.service.values.statusActive = true
       this.checkApiKeys = true
       for (const id in this.exposeErrorById) {
         this.resetExposeError(id)
@@ -443,7 +508,7 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
         return this.connect(retry + 1)
       }
       this.error(error)
-      this.service.values.expose = false
+      this.values.expose = false
     }
   }
 
@@ -472,26 +537,14 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
           this.deleteAccessory(id)
         }
       }
-      for (const id in this.serviceById) {
-        this.deleteService(id)
-      }
       this.exposeErrors = {}
       this.context.settingsById = {}
-      this.context.settingsById[this.id] = {
-        autoExposeGroups: false,
-        autoExposeLights: false,
-        autoExposeSensors: false,
-        autoExposeSchedules: false,
-        logLevel: 2
-      }
       this.context.fullState = null
       this.context.migration = null
-      this.service.values.lights = false
-      this.service.values.sensors = false
-      this.service.values.groups = false
-      this.service.values.schedules = false
-      this.service.values.logLevel = 2
-      this.values.rtypes = []
+      this.values.logLevel = 2
+      this.values.autoExpose = {
+        groups: false, lights: true, schedules: false, sensors: true
+      }
     } catch (error) { this.error(error) }
   }
 
@@ -516,6 +569,25 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
     this.pollNext = true
   }
 
+  /** Re-expose an accessory.
+    *
+    * Delete the accessory delegate, but keep the HAP accessory, including
+    * the persisted context.
+    * The delegate will be re-created when the gateway is next polled.
+    * @params {string} id - The device ID.
+    * @params {boolean} expose - Set to `false` to blacklist the device.
+    */
+  reExposeAccessory (id) {
+    if (id === this.id) {
+      throw new RangeError(`${id}: gateway ID`)
+    }
+    if (this.accessoryById[id] == null) {
+      throw new RangeError(`${id}: unknown accessory ID`)
+    }
+    this.deleteAccessory(id, true)
+    this.pollNext = true
+  }
+
   /** Add the accessory for the device.
     * @params {string} id - The device ID.
     * @return {?DeconzAccessory} - The accessory delegate.
@@ -531,7 +603,7 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
       const device = this.deviceById[id]
       delete this.exposeErrorById[id]
       const { body } = device.resource
-      this.log('%s: add accessory', body.name)
+      this.debug('%s: add accessory', body.name)
       let { serviceName } = device.resource
       if (DeconzAccessory[serviceName] == null) {
         // this.warn('%s: %s: not yet supported %s type', body.name, body.type, rtype)
@@ -548,19 +620,23 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
     return this.accessoryById[id]
   }
 
-  /** Delete the accessory for the device.
+  /** Delete the accessory delegate and associated HomeKit accessory.
     * @params {string} id - The device ID.
+    * @params {boolean} [delegateOnly=false] - Delete the delegate, but keep the
+    * associated HomeKit accessory (including context).
     */
-  deleteAccessory (id) {
+  deleteAccessory (id, delegateOnly = false) {
     if (id === this.id) {
       throw new RangeError(`${id}: gateway ID`)
     }
     if (this.accessoryById[id] != null) {
-      this.log('%s: delete accessory', this.accessoryById[id].name)
       this.monitorResources(this.accessoryById[id], false)
-      this.accessoryById[id].destroy()
+      this.log('%s: delete accessory', this.accessoryById[id].name)
+      this.accessoryById[id].destroy(delegateOnly)
       delete this.accessoryById[id]
-      if (this.exposeErrorById[id] == null) {
+      if (this.exposeErrorById[id] != null) {
+        delete this.exposeErrorById[id]
+      } else if (!delegateOnly) {
         const id = Object.keys(this.exposeErrorById)[0]
         if (id != null) {
           this.log(
@@ -569,8 +645,6 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
           this.deleteAccessory(id)
           this.deleteService(id)
         }
-      } else {
-        delete this.exposeErrorById[id]
       }
     }
   }
@@ -607,86 +681,182 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
     this.deleteService(id)
   }
 
-  /** Add a service to the gateway accessory to un-blacklist a device.
-    * @params {string} id - The device ID.
-    * @return {DeconzService.DeviceSettings} - The service delegate.
-    */
-  addService (id) {
-    if (id === this.id) {
-      throw new RangeError(`${id}: gateway ID`)
-    }
-    if (this.deviceById[id] == null) {
-      throw new RangeError(`${id}: unknown device ID`)
+  // ===========================================================================
+
+  _deviceToMap (id, details = false) {
+    const device = this.deviceById[id]
+    if (device == null) {
+      return { status: 404 } // Not Found
     }
-    if (this.serviceById[id] == null) {
-      if (Object.keys(this.serviceById).length >= 97) {
-        return null
-      }
-      const { resource, rpaths } = this.deviceById[id]
-      const { body } = resource
-      const service = new DeconzService.DeviceSettings(this, {
-        name: body.name + ' Settings',
-        subtype: id,
-        resource: rpaths.join(', '),
-        expose: this.context.settingsById[id].expose
-      })
-      this.serviceById[id] = service
+    const body = {
+      expose: details ? undefined : this.accessoryById[device.id] != null,
+      id: details ? device.id : undefined,
+      manufacturer: device.resource.manufacturer,
+      model: device.resource.model,
+      name: device.resource.body.name,
+      resources: device.rpaths,
+      settings: details
+        ? {
+            expose: this.accessoryById[device.id] != null,
+            outlet: undefined, // expose as _Outlet_
+            switch: undefined, // expose as _Switch
+            valve: undefined // expose as _Valve_
+          }
+        : undefined,
+      type: device.resource.rtype,
+      zigbee: device.zigbee
     }
-    return this.serviceById[id]
+    return { status: 200, body }
   }
 
-  /** Delete the service on the gateway accessory to un-blacklist a device.
-    * @params {string} id - The device ID.
-    */
-  deleteService (id) {
-    if (id === this.id) {
-      throw new RangeError(`${id}: gateway ID`)
+  async onUiGet (path) {
+    this.debug('ui request: GET %s', path.join('/'))
+    if (path.length === 0) {
+      const body = {
+        host: this.values.host,
+        id: this.id,
+        manufacturer: this.values.manufacturer,
+        model: this.values.model,
+        name: this.name,
+        settings: {
+          autoExpose: this.values.autoExpose,
+          brightnessAdjustment: this.values.brightnessAdjustment * 100,
+          expose: this.values.expose,
+          heartrate: this.values.heartrate,
+          logLevel: this.values.logLevel,
+          periodicEvents: this.values.periodicEvents,
+          restart: this.values.restart,
+          search: this.values.search,
+          unlock: this.values.unlock
+        }
+      }
+      return { status: 200, body }
     }
-    if (this.serviceById[id] != null) {
-      this.serviceById[id].destroy()
-      delete this.serviceById[id]
+    if (path[0] === 'accessories') {
+      if (path.length === 1) {
+        const body = {}
+        for (const id of Object.keys(this.accessoryById).sort()) {
+          body[id] = this.accessoryById[id].onUiGet().body
+        }
+        return { status: 200, body }
+      }
+      if (path.length === 2) {
+        const id = path[1]
+        if (this.accessoryById[id] == null) {
+          return { status: 404 } // Not Found
+        }
+        return this.accessoryById[id].onUiGet(true)
+      }
     }
-  }
-
-  // ===========================================================================
-
-  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 (path[0] === 'devices') {
+      if (path.length === 1) {
+        const body = {}
+        for (const id of Object.keys(this.deviceById).sort()) {
+          body[id] = this._deviceToMap(id).body
         }
+        return { status: 200, body }
+      }
+      if (path.length === 2) {
+        return this._deviceToMap(path[1], true)
       }
     }
-    if (a[0] !== 'accessories') {
-      return { status: 403 } // Forbidden
+    return { status: 403 } // Forbidden
+  }
+
+  async onUiPut (path, body) {
+    this.debug('ui request: PUT %s %j', path.join('/'), body)
+    if (path.length === 0) {
+      return { status: 405 } // Method Not Allowed
     }
-    if (a.length === 1) {
-      return { status: 200, body: this.deviceByRidByRtype }
+    if (path[0] === 'settings') {
+      const settings = {}
+      const optionParser = new homebridgeLib.OptionParser(settings, true)
+      optionParser
+        .on('userInputError', (error) => {
+          this.warn(error)
+        })
+        .objectKey('autoExpose')
+        .intKey('brightnessAdjustment', 10, 100)
+        .boolKey('expose')
+        .intKey('heartrate', 1, 60)
+        .intKey('logLevel', 0, 3)
+        .boolKey('periodicEvents')
+        .boolKey('restart')
+        .boolKey('search')
+        .boolKey('unlock')
+      await optionParser.parse(body)
+
+      const responseBody = {}
+      for (const key in settings) {
+        switch (key) {
+          case 'autoExpose':
+            for (const rtype in settings[key]) {
+              if (this.values[key][rtype] == null) {
+                this.warn('ui error: %s.%s: invalid key', key, rtype)
+                continue
+              }
+              try {
+                settings[key][rtype] = homebridgeLib.OptionParser.toBool(
+                  key + '.' + rtype, settings[key][rtype], true
+                )
+              } catch (error) {
+                this.warn(error)
+                continue
+              }
+              this.values[key][rtype] = settings[key][rtype]
+              if (responseBody[key] == null) {
+                responseBody[key] = {}
+              }
+              responseBody[key][rtype] = this.values[key][rtype]
+            }
+            break
+          case 'brightnessAdjustment':
+            this.values[key] = settings[key] / 100
+            responseBody[key] = this.values[key]
+            break
+          case 'expose':
+          case 'heartrate':
+          case 'logLevel':
+          case 'periodicEvents':
+          case 'restart':
+          case 'search':
+          case 'unlock':
+            this.values[key] = settings[key]
+            responseBody[key] = this.values[key]
+            break
+          default:
+            break
+        }
+      }
+      return { status: 200, body: responseBody }
     }
-    if (this.deviceById[a[1]] == null) {
-      return { status: 404 } // Not Found
+    if (path[0] === 'accessories') {
+      if (path.length === 3 && path[2] === 'settings') {
+        const id = path[1]
+        if (this.accessoryById[id] == null) {
+          return { status: 404 } // Not Found
+        }
+        return this.accessoryById[id].onUiPut(body)
+      }
+      return { status: 405 } // Method Not Allowed
     }
-    if (a.length === 2) {
-      return { status: 200, body: this.deviceById[a[1]] }
+    if (path[0] === 'devices') {
+      if (path.length === 3 && path[2] === 'settings') {
+        const id = path[1]
+        if (this.deviceById[id] == null) {
+          return { status: 404 } // Not Found
+        }
+        if (body.expose != null) {
+          this.exposeDevice(id, body.expose)
+          return { status: 200, body: { expose: body.expose } }
+        }
+        return { status: 200 }
+      }
+      return { status: 405 } // Method Not Allowed
     }
     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.
@@ -709,24 +879,24 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
       } else {
         const config = await this.client.get('/config')
         if (config.bridgeid === this.id && config.UTC == null) {
-          this.service.values.expose = false
+          this.values.expose = false
           this.values.apiKey = null
           await this.wsClient.close()
           return
         }
         this.context.fullState.config = config
         if (
-          this.service.values.lights || this.nDevicesByRtype.lights > 0 ||
-          this.service.values.sensors || this.nDevicesByRtype.sensors > 0
+          this.values.autoExpose.lights || this.nDevicesByRtype.lights > 0 ||
+          this.values.autoExpose.sensors || this.nDevicesByRtype.sensors > 0
         ) {
           this.context.fullState.lights = await this.client.get('/lights')
           this.context.fullState.sensors = await this.client.get('/sensors')
         }
-        if (this.service.values.groups || this.nDevicesByRtype.groups > 0) {
+        if (this.values.autoExpose.groups || this.nDevicesByRtype.groups > 0) {
           this.context.fullState.groups = await this.client.get('/groups')
           this.context.fullState.groups[0] = await this.client.get('/groups/0')
         }
-        if (this.service.values.schedules) {
+        if (this.values.autoExpose.schedules) {
           this.context.fullState.schedules = await this.client.get('/schedules')
         }
       }
@@ -870,7 +1040,7 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
         ) {
           delete this.context.settingsById[id]
           this.deleteAccessory(id)
-          this.deleteService(id)
+          // this.deleteService(id)
           changed = true
         } else {
           /** Emitted when the gateway has been polled.
@@ -882,43 +1052,23 @@ class Gateway extends homebridgeLib.AccessoryDelegate {
       } catch (error) { this.error(error) }
     }
 
-    this.vdebug('analysing services...')
-    for (const id in this.serviceById) {
-      try {
-        if (
-          this.deviceById[id] == null ||
-          !this.values.rtypes.includes(this.deviceById[id].resource.rtype)
-        ) {
-          delete this.exposeErrorById[id]
-          this.deleteService(id)
-          changed = true
-        }
-      } catch (error) { this.error(error) }
-    }
-
-    for (const rtype of this.values.rtypes) {
+    for (const rtype of rtypes) {
       this.vdebug('analysing %s devices...', rtype)
       const rids = Object.keys(this.deviceByRidByRtype[rtype]).sort()
       for (const rid of rids) {
         try {
           const { id } = this.deviceByRidByRtype[rtype][rid]
           if (this.context.settingsById[id] == null) {
-            this.context.settingsById[id] = { expose: true }
+            this.context.settingsById[id] = {
+              expose: this.values.autoExpose[rtype]
+            }
           }
           if (this.context.settingsById[id].expose) {
             if (this.accessoryById[id] == null) {
               this.addAccessory(id)
               changed = true
             }
-            if (this.serviceById[id] != null) {
-              this.deleteService(id)
-              changed = true
-            }
           } else {
-            if (this.serviceById[id] == null) {
-              this.addService(id)
-              changed = true
-            }
             if (this.accessoryById[id] != null) {
               this.deleteAccessory(id)
               changed = true