homebridge-deconz 0.0.13 → 0.0.16

package/README.md

@@ -1,11 +1,13 @@
 <p align="center">
-  <img src="homebridge-deconz.png" height="200px">  
-</p><span align="center">
+  <img src="homebridge-ui/public/homebridge-deconz.png" height="200px">  
+</p>
+<span align="center">
 
 # Homebridge deCONZ
 [![Downloads](https://img.shields.io/npm/dt/homebridge-deconz)](https://www.npmjs.com/package/homebridge-deconz)
 [![Version](https://img.shields.io/npm/v/homebridge-deconz)](https://www.npmjs.com/package/homebridge-deconz)
-[![Homebridge Discord](https://img.shields.io/discord/432663330281226270?color=728ED5&logo=discord&label=discord)](https://discord.gg/hZubhrz)
+[![Homebridge Discord](https://img.shields.io/discord/432663330281226270?color=728ED5&logo=discord&label=discord)](https://discord.gg/zUhSZSNb4P)
+[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
 
 [![GitHub issues](https://img.shields.io/github/issues/ebaauw/homebridge-deconz)](https://github.com/ebaauw/homebridge-deconz/issues)
 [![GitHub pull requests](https://img.shields.io/github/issues-pr/ebaauw/homebridge-deconz)](https://github.com/ebaauw/homebridge-deconz/pulls)
@@ -22,7 +24,7 @@ See [Future Development of Homebridge Hue](https://github.com/ebaauw/homebridge-
 Homebridge deCONZ is still under development.
 See [Releases](https://github.com/ebaauw/homebridge-deconz/releases) for more details.
 
-If you have a question, please post a message to the **#hue** channel of the Homebridge community on [Discord](https://discord.gg/hZubhrz).
+If you have a question, please post a message to the **#deconz** channel of the Homebridge community on [Discord](https://discord.gg/zUhSZSNb4P).
 
 ### Introduction
 This [Homebridge](https://github.com/homebridge/homebridge) plugin exposes to Apple's [HomeKit](http://www.apple.com/ios/home/) ZigBee devices (lights, plugs, sensors, switches, ...) and virtual devices on a deCONZ gateway by dresden elektronik.

package/cli/deconz.js

@@ -703,7 +703,7 @@ class Main extends homebridgeLib.CommandLineTool {
     const { websocketport } = await this.client.get('/config')
     options.host = this.client.host + ':' + websocketport
     this.wsMonitor = new Deconz.WsClient(options)
-    this.setOptions({ mode: mode })
+    this.setOptions({ mode })
     this.wsMonitor
       .on('error', (error) => { this.error(error) })
       .on('listening', (url) => { this.log('listening on %s', url) })
@@ -813,7 +813,7 @@ class Main extends homebridgeLib.CommandLineTool {
       .parse(...args)
     const apiKey = await this.client.getApiKey('deconz')
     this.print(jsonFormatter.stringify(apiKey))
-    this.gateways[this.bridgeid] = { apiKey: apiKey }
+    this.gateways[this.bridgeid] = { apiKey }
     if (this.client.fingerprint != null) {
       this.gateways[this.bridgeid].fingerprint = this.client.fingerprint
     }

package/config.schema.json

@@ -2,7 +2,7 @@
   "pluginAlias": "deCONZ",
   "pluginType": "platform",
   "singular": true,
-  "customUi": true,
+  "customUi": false,
   "headerDisplay": "Homebridge plugin for deCONZ",
   "footerDisplay": "For a detailed description, see the [wiki](https://github.com/ebaauw/homebridge-deconz/wiki/Configuration).",
   "schema": {
@@ -77,7 +77,7 @@
       }
     }
   },
-  "form": [
+  "layout": [
     "name",
     {
       "key": "hosts",

package/homebridge-ui/public/index.html

@@ -6,19 +6,499 @@ Copyright © 2022 Erik Baauw. All rights reserved.
 -->
 
 <link rel="stylesheet" href="style.css">
+<p align="center">
+  <a href="https://github.com/ebaauw/homebridge-deconz/wiki/Configuration" target="_blank">
+    <img src="homebridge-deconz.png" height="200px">
+  </a>
+</p>
 
 <script>
-(async () => {
-  try {
+
+async function showFormPluginConfig () {
+  homebridge.showSpinner()
+  const pluginConfig = await homebridge.getPluginConfig()
+  console.log('pluginConfig: %o', pluginConfig)
+  // const pluginConfigSchema = await homebridge.getPluginConfigSchema()
+  // console.log('pluginConfigSchema: %o', pluginConfigSchema)
+  // const cachedAccessories = await homebridge.getCachedAccessories()
+  // console.log('cachedAccessories: %o', cachedAccessories)
+  // const discoveredGateways = await homebridge.request('discover')
+  // console.log('discovered gateways: %o', discoveredGateways)
+  for (const config of pluginConfig) {
+    if (config._bridge != null) {
+      const cachedAccessories = await homebridge.request('cachedAccessories', {
+        username: config._bridge.username
+      })
+      console.log('%s: cachedAccessories: %o', config.name, cachedAccessories)
+      const cachedGateways = cachedAccessories.filter((accessory) => {
+        return accessory.plugin === 'homebridge-deconz' &&
+          accessory.context != null &&
+          accessory.context.className === 'Gateway'
+      })
+      const result = {}
+      for (const gateway of cachedGateways) {
+        if (gateway.context.uiPort == null) {
+          continue
+        }
+        const pong = await homebridge.request(
+          'get', { uiPort: gateway.context.uiPort, path: '/ping' }
+        )
+        if (pong === 'pong') {
+          result[gateway.context.host] = gateway.context
+        }
+      }
+      const gateways = Object.keys(result).sort()
+      console.log('%s: gateways: %j',config.name, gateways)
+    }
+  }
+  homebridge.hideSpinner()
+
+  const form = homebridge.createForm(
+    {
+      schema: {
+        type: 'object',
+        properties: {
+          config: {
+            title: 'Gateways',
+            description: 'Configure a child bridge per deCONZ gateway.  See <a href="https://github.com/ebaauw/homebridge-deconz/wiki/Configuration" target="_blank">wiki</a> for details.',
+            type: 'array',
+            disabled: true,
+            items: {
+              type: 'object',
+              properties: {
+                host: {
+                  description: 'Gateway hostname and port.',
+                  default: 'localhost:80',
+                  type: 'string',
+                  required: true
+                },
+                name: {
+                  description: 'Homebridge log plugin name.',
+                  default: 'deCONZ',
+                  type: 'string'
+                },
+                _bridge: {
+                  type: 'object',
+                  required: true,
+                  properties: {
+                    name: {
+                      type: 'string',
+                      required: true
+                    },
+                    username: {
+                      type: 'string',
+                      pattern: '^([A-F0-9]{2}:){5}[A-F0-9]{2}$',
+                      placeholder: 'AA:BB:CC:DD:EE:FF',
+                      required: true
+                    },
+                    port: {
+                      type: 'integer',
+                      minimum: 1025,
+                      // maximum: 65535,
+                      required: true
+                    },
+                    manufacturer: {
+                      type: 'string',
+                      enabled: false,
+                      required: true
+                    },
+                    model: {
+                      type: 'string',
+                      required: true
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      // layout: null
+      layout: [
+        {
+          type: 'tabarray',
+          title: '{{ value.name }}',
+          items: [
+            {
+              type: 'fieldset',
+              title: 'Gateway Settings',
+              key: 'config[]',
+              items: [
+                {
+                  type: 'flex',
+                  'flex-flow': 'row',
+                  items: [
+                    'config[].host',
+                    'config[].name',
+                  ]
+                }
+              ]
+            },
+            {
+              type: 'flex',
+              'flex-flow': 'row',
+              key: 'config[]',
+              items: [
+                {
+                  type: 'button',
+                  title: 'Connect',
+                  key: 'config[].connect'
+                },
+                {
+                  type: 'button',
+                  title: 'Get API Key',
+                  key: 'config[].getApiKey'
+                },
+                {
+                  type: 'submit',
+                  title: 'Configure',
+                  key: 'config[].configure'
+                }
+              ]
+            },
+            {
+              type: 'fieldset',
+              key: 'config[]._bridge',
+              // expandable: true,
+              title: 'Child Bridge Accessory Settings',
+              items: [
+                {
+                  type: 'flex',
+                  'flex-flow': 'row',
+                  items: [
+                    'config[]._bridge.username',
+                    'config[]._bridge.port'
+                  ]
+                },
+                'config[]._bridge.name',
+                {
+                  type: 'flex',
+                  'flex-flow': 'row',
+                  items: [
+                    'config[]._bridge.manufacturer',
+                    'config[]._bridge.model'
+                  ]
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    }, {
+      config: pluginConfig,
+    },
+    'Gateway Settings',
+    'Homebridge Settings'
+  )
+  form.onChange(async (form) => {
+    console.log('change: %o', form)
+  })
+  form.onSubmit(async (form) => {
+    console.log('submit: %o', form)
+  })
+  form.onCancel(async (form) => {
+    console.log('cancel: %o', form)
+  })
+
+}
+
+async function showFormGateways (gateway) {
+  homebridge.showSpinner()
+  const cachedAccessories = await homebridge.getCachedAccessories()
+  const cachedGateways = cachedAccessories.filter((accessory) => {
+    return accessory.plugin === 'homebridge-deconz' &&
+      accessory.context != null &&
+      accessory.context.className === 'Gateway'
+  })
+  const result = {}
+  for (const gateway of cachedGateways) {
+    if (gateway.context.uiPort == null) {
+      continue
+    }
+    const pong = await homebridge.request(
+      'get', { uiPort: gateway.context.uiPort, path: '/ping' }
+    )
+    if (pong === 'pong') {
+      result[gateway.context.host] = gateway.context
+    }
+  }
+  const gateways = Object.keys(result).sort()
+  homebridge.hideSpinner()
+  if (gateways.length === 0) {
     homebridge.showSchemaForm()
+    return
+  }
+  // const form = homebridge.createForm({
+  //   schema: {
+  //     type: 'object',
+  //     properties: {
+  //       gateway: {
+  //         title: 'Connected Gateways',
+  //         type: 'string',
+  //         oneOf: gateways.map((name) => {
+  //           const config = result[name].context.config
+  //           return {
+  //             title: `${name}: dresden elektronik ${config.modelid} gateway v${config.swversion} / ${config.devicename} ${config.bridgeid}`,
+  //             enum: [name]
+  //           }
+  //         }),
+  //         required: true
+  //       }
+  //     }
+  //   },
+  //   layout: null,
+  //   form: null
+  // }, {
+  //   gateway: gateway != null ? gateway : gateways[0]
+  // }, 'Gateway Settings', 'Homebridge Settings')
+  const form = homebridge.createForm({
+    footerDisplay: 'For a detailed description, see the [wiki](https://github.com/ebaauw/homebridge-deconz/wiki/Configuration).',
+    schema: {
+      type: 'object',
+      properties: {
+        name: {
+          description: 'Plugin name as displayed in the Homebridge log.',
+          type: 'string',
+          required: true,
+          default: 'deCONZ'
+        },
+        gateways: {
+          title: 'Gateways',
+          type: 'array',
+          disabled: true,
+          items: {
+            type: 'object',
+            properties: {
+              host: {
+                description: 'Hostname and port of the deCONZ gateway.',
+                type: 'string'
+              },
+              expose: {
+                description: 'Expose gateway to HomeKit.',
+                type: 'boolean'
+              }
+            }
+          }
+
+        }
+      }
+    } //,
+    // layout: [
+    //   'name',
+    //   {
+    //     key: 'gateways',
+    //     type: 'array',
+    //     buttonText: 'Add Gateway',
+    //     items: [
+    //       {
+    //         type: 'section',
+    //         htmlClass: 'row',
+    //         items: [
+    //           {
+    //             type: 'section',
+    //             htmlClass: 'col',
+    //             items: [
+    //               'gateways[].host'
+    //             ]
+    //           },
+    //           {
+    //             type: 'section',
+    //             htmlClass: 'col',
+    //             items: [
+    //             {
+    //               key: 'gateways[].expose',
+    //               disabled: true
+    //             }
+    //             ]
+    //           }
+    //         ]
+    //       }
+    //     ]
+    //   }
+    // ]
+  }, {
 
-    // const pluginConfig = await homebridge.getPluginConfig()
-    // const pluginConfigSchema = await homebridge.getPluginConfigSchema()
-    const cachedAccessories = await homebridge.getCachedAccessories()
+  }, 'Gateway Settings', 'Homebridge Settings')
+  form.onChange(async (form) => {
+    // showFormGatewaySettings(result[form.gateway])
+  })
+  form.onSubmit(async (form) => {
+    await showFormGatewaySettings(result[form.gateways])
+  })
+  form.onCancel(() => { homebridge.showSchemaForm() })
+}
+
+async function showFormGatewaySettings (gateway, device) {
+  homebridge.showSpinner()
+  const data = await homebridge.request(
+    'get', {
+      uiPort: gateway.uiPort,
+      path: '/gateways/' + gateway.id
+    }
+  )
+  const values = {}
+  for (const rtype in data.deviceByRidByRtype) {
+    values[rtype] = []
+    for (const rid in data.deviceByRidByRtype[rtype]) {
+      const device = data.deviceByRidByRtype[rtype][rid]
+      values[rtype].push({
+        title: ['', rtype, rid].join('/') + ': ' +
+          device.resourceBySubtype[device.primary].body.name,
+        enum: [device.id]
+      })
+    }
+  }
+  data.lightsDevice = values.lights[0].enum[0]
+  data.sensorsDevice = values.sensors[0].enum[0]
+  data.groupsDevice = values.groups[0].enum[0]
+  homebridge.hideSpinner()
+  const form = homebridge.createForm({
+    schema: {
+      type: 'object',
+      properties: {
+        expose: {
+          title: 'Expose',
+          type: 'boolean'
+        },
+        lights: {
+          title: 'Lights',
+          type: 'boolean',
+        },
+        sensors: {
+          title: 'Sensors',
+          type: 'boolean',
+        },
+        groups: {
+          title: 'Groups',
+          type: 'boolean',
+        },
+        schedules: {
+          title: 'Schedules',
+          type: 'boolean',
+        },
+        logLevel: {
+          title: 'Log Level',
+          type: 'string',
+          oneOf: ['0', '1', '2', '3'].map((level) => { return { title: level, enum: [level] } }),
+          required: true,
+          condition: {
+            functionBody: 'return model.expose'
+          }
+        },
+        lightsDevice: {
+          title: 'Device',
+          type: 'string',
+          oneOf: values.lights,
+          required: true
+        },
+        sensorsDevice: {
+          title: 'Device',
+          type: 'string',
+          oneOf: values.sensors,
+          required: true
+        },
+        groupsDevice: {
+          title: 'Device',
+          type: 'string',
+          oneOf: values.groups,
+          required: true
+        }
+      }
+    },
+    layout: [
+      {
+        type: 'fieldset',
+        title: `${gateway.context.host} Gateway Settings`
+      },
+      'expose',
+      'logLevel',
+      {
+        type: 'flex',
+        'flex-flow': 'row',
+        title: 'Automatically Expose New',
+        items: [
+          'lights',
+          'sensors',
+          'groups',
+          'schedules'
+        ],
+        condition: {
+          functionBody: 'return model.expose'
+        }
+      },
+      {
+        type: 'fieldset',
+        items: [
+          {
+            type: 'tabs',
+            tabs: [
+              {
+                title: 'Lights',
+                items: [
+                  'lightsDevice'
+                ]
+              },
+              {
+                title: 'Sensors',
+                items: [
+                  'sensorsDevice'
+                ]
+              },
+              {
+                title: 'Groups',
+                items: [
+                  'groupsDevice'
+                ]
+              }
+            ]
+          }
+        ],
+        condition: {
+          functionBody: 'return model.expose'
+        }
+      }
+    ]
+  }, data, 'Device Settings', 'Done')
+  form.onChange((form) => {})
+  form.onSubmit((form) => {
+    showFormDeviceSettings(gateway, form.lightsDevice)
+  })
+  form.onCancel((form) => {
+    showFormGateways(gateway.context.host)
+  })
+}
 
-    const result = await homebridge.request('/cachedAccessories', cachedAccessories)
-    const nGateways = Object.keys(result).length
-    homebridge.toast.success(`${nGateways} gateways`)
+async function showFormDeviceSettings (gateway, device) {
+  homebridge.showSpinner()
+  homebridge.hideSpinner()
+  const form = homebridge.createForm({
+    schema: {
+      type: 'object',
+      properties: {
+        gateway: {
+          type: 'string'
+        },
+        device: {
+          type: 'string'
+        }
+      }
+    }
+  }, {
+    gateway: gateway.context.host,
+    device: device
+  }, 'OK', 'Cancel')
+  form.onChange((form) => {})
+  form.onSubmit((form) => {
+    showFormGatewaySettings(gateway)
+  })
+  form.onCancel((form) => {
+    showFormGatewaySettings(gateway)
+  })
+}
+
+(async () => {
+  try {
+    await showFormPluginConfig()
   } catch (error) {
     console.error(error)
   }

package/homebridge-ui/server.js

@@ -5,39 +5,54 @@
 
 'use strict'
 
-const {
-  HomebridgePluginUiServer, RequestError
-} = require('@homebridge/plugin-ui-utils')
+const { UiServer } = require('homebridge-lib')
+const Deconz = require('../lib/Deconz')
 
-class UiServer extends HomebridgePluginUiServer {
+class DeconzUiServer extends UiServer {
   constructor () {
     super()
 
-    this.onRequest('/cachedAccessories', async (cachedAccessories) => {
-      try {
-        // console.log('%d accessories', cachedAccessories.length)
-        const gateways = cachedAccessories.filter((accessory) => {
-          return accessory.plugin === 'homebridge-deconz' &&
-            accessory.context != null &&
-            accessory.context.className === 'Gateway'
+    this.onRequest('discover', async (params) => {
+      if (this.discovery == null) {
+        this.discovery = new Deconz.Discovery({
+          // forceHttp: this.config.forceHttp,
+          // timeout: this.config.timeout
         })
-        // console.log('%d gateways', gateways.length)
-        const result = {}
-        for (const gateway of gateways) {
-          const { host, apiKey } = gateway.context
-          if (apiKey != null) {
-            result[host] = apiKey
-          }
-        }
-        console.log('%d gateways: %j', Object.keys(result).length, result)
-        return result
-      } catch (error) {
-        throw new RequestError(error)
+        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
+            )
+          })
+          .on('request', (request) => {
+            this.debug(
+              '%s: request %d: %s %s', request.name,
+              request.id, request.method, request.resource
+            )
+          })
+          .on('response', (response) => {
+            this.debug(
+              '%s: request %d: %d %s', response.request.name,
+              response.request.id, response.statusCode, response.statusMessage
+            )
+          })
+          .on('found', (name, id, address) => {
+            this.debug('%s: found %s at %s', name, id, address)
+          })
+          .on('searching', (host) => {
+            this.debug('upnp: listening on %s', host)
+          })
+          .on('searchDone', () => { this.debug('upnp: search done') })
       }
+      const configs = await this.discovery.discover()
+      return configs
     })
-
     this.ready()
   }
 }
 
-new UiServer() // eslint-disable-line no-new
+new DeconzUiServer() // eslint-disable-line no-new

package/lib/Deconz/ApiClient.js

@@ -149,7 +149,7 @@ class ApiClient extends homebridgeLib.HttpClient {
       maxSockets: _options.maxSockets,
       path: '/api',
       timeout: _options.timeout,
-      validStatusCodes: [200, 400, 403, 404]
+      validStatusCodes: [200, 400, 403] //, 404]
     }
     if (_options.phoscon) {
       // options.headers = { Accept: 'application/vnd.ddel.v1' }

package/lib/Deconz/Discovery.js

@@ -44,7 +44,7 @@ class Discovery extends events.EventEmitter {
     */
   async config (host) {
     const client = new homebridgeLib.HttpClient({
-      host: host,
+      host,
       json: true,
       path: '/api',
       timeout: this._options.timeout
@@ -96,7 +96,7 @@ class Discovery extends events.EventEmitter {
     */
   async description (host) {
     const options = {
-      host: host,
+      host,
       timeout: this._options.timeout
     }
     const client = new homebridgeLib.HttpClient(options)