homebridge-deconz 0.1.7 → 0.1.9

package/cli/ui.js

@@ -19,12 +19,14 @@ const { UsageError } = CommandLineParser
 
 const usage = {
   ui: `${b('ui')} [${b('-hVD')}] [${b('-U')} ${u('username')}] [${b('-G')} ${u('gateway')}] [${b('-t')} ${u('timeout')}] ${u('command')} [${u('argument')} ...]`,
-  get: `${b('get')} [${b('-hsnjuatlkv')}] [${b('/devices')}[${b('/')}${u('id')}] | ${b('/accessories')}[${b('/')}${u('id')}]]`,
-  put: `${b('put')} [${b('-hsnjuatlkv')}] [${b('/devices/')}${u('id')}] | ${b('/accessories/')}${u('id')}]] ${u('body')}`
+  discover: `${b('discover')} [${b('-hsnjuatlkv')}]`,
+  get: `${b('get')} [${b('-hsnjuatlkv')}] ${u('resource')}`,
+  put: `${b('put')} [${b('-h')}] ${u('resource')} ${u('body')}`
 }
 
 const description = {
   ui: 'Command line interface to Homebridge deCONZ UI Server for dynamic settings.',
+  discover: 'Discover UI servers and gateways.',
   get: 'Get dynamic settings.',
   put: 'Update dynamic settings.'
 }
@@ -54,6 +56,9 @@ Parameters:
   Set timeout to ${u('timeout')} seconds instead of default ${b(5)}.
 
 Commands:
+  ${usage.discover}
+  ${description.discover}
+
   ${usage.get}
   ${description.get}
 
@@ -61,6 +66,44 @@ Commands:
   ${description.put}
 
 For more help, issue: ${b('ui')} ${u('command')} ${b('-h')}`,
+  discover: `${description.discover}
+
+Usage: ${b('ui')} ${usage.discover}
+
+Parameters:
+  ${b('-h')}, ${b('--help')}
+  Print this help and exit.
+  
+  ${b('-s')}, ${b('--sortKeys')}
+  Sort object key/value pairs alphabetically on key.
+
+  ${b('-n')}, ${b('-noWhiteSpace')}
+  Do not include spaces nor newlines in the output.
+
+  ${b('-j')}, ${b('--jsonArray')}
+  Output a JSON array of objects for each key/value pair.
+  Each object contains two key/value pairs: key "keys" with an array
+  of keys as value and key "value" with the value as value.
+
+  ${b('-u')}, ${b('--joinKeys')}
+  Output JSON array of objects for each key/value pair.
+  Each object contains one key/value pair: the path (concatenated
+  keys separated by '/') as key and the value as value.
+
+  ${b('-a')}, ${b('--ascii')}
+  Output path:value in plain text instead of JSON.
+
+  ${b('-t')}, ${b('--topOnly')}
+  Limit output to top-level key/values.
+
+  ${b('-l')}, ${b('--leavesOnly')}
+  Limit output to leaf (non-array, non-object) key/values.
+
+  ${b('-k')}, ${b('--keysOnly')}
+  Limit output to keys. With ${b('-u')}, output a JSON array of paths.
+
+  ${b('-v')}, ${b('--valuesOnly')}
+  Limit output to values. With ${b('-u')}, output a JSON array of values.`,
   get: `${description.get}
 
 Usage: ${b('ui')} ${usage.get}
@@ -98,13 +141,40 @@ Parameters:
   Limit output to keys. With ${b('-u')}, output a JSON array of paths.
 
   ${b('-v')}, ${b('--valuesOnly')}
-  Limit output to values. With ${b('-u')}, output a JSON array of values.`,
+  Limit output to values. With ${b('-u')}, output a JSON array of values.
+  
+  ${u('resource')}
+  The resource to get:
+    ${b('/')}                             Get gateway.
+    ${b('/accessories')}                  List accessories.
+    ${b('/accessories/')}${u('id')}               Get accessory.
+    ${b('/devices')}                      List devices.
+    ${b('/devices/')}${u('id')}                   Get device.
+    ${b('/gateways')}                     List gateways.
+    ${b('/gateways/')}${u('gid')}                 Get gateway.
+    ${b('/gateways/')}${u('gid')}${b('/accessories')}     List accessories.
+    ${b('/gateways/')}${u('gid')}${b('/accessories/')}${u('id')}  Get accessory.
+    ${b('/gateways/')}${u('gid')}${b('/devices')}         List devices.
+    ${b('/gateways/')}${u('gid')}${b('/devices/')}${u('id')}      Get device.`,
   put: `${description.put}
 
 Usage: ${b('ui')} ${usage.put}
   
 Parameters:
-  xxx`
+  ${b('-h')}, ${b('--help')}
+  Print this help and exit.
+
+  ${u('resource')}
+  The resource to update:
+    ${b('/')}                             Update gateway settings.
+    ${b('/accessories/')}${u('id')}               Update accessory settings.
+    ${b('/devices/')}${u('id')}                   Update device settings.
+    ${b('/gateways/')}${u('gid')}                 Update gateway settings.
+    ${b('/gateways/')}${u('gid')}${b('/accessories/')}${u('id')}  Update accessory settings.
+    ${b('/gateways/')}${u('gid')}${b('/devices/')}${u('id')}      Update device settings.
+
+  ${u('body')}
+  The new settings as JSON string.`
 }
 
 class Main extends CommandLineTool {
@@ -217,8 +287,11 @@ class Main extends CommandLineTool {
         continue
       }
       try {
-        const username = platform._bridge == null ? null : platform._bridge.username
-        const cachedAccessories = await this.readCachedAccessories(dir, username, platformName)
+        const childBridge = platform._bridge != null
+        const username = childBridge ? platform._bridge.username : config.bridge.username
+        const cachedAccessories = await this.readCachedAccessories(
+          dir, childBridge ? username : null, platformName
+        )
         const cachedGateways = cachedAccessories.filter((accessory) => {
           return accessory.context.className === 'Gateway'
         })
@@ -226,6 +299,7 @@ class Main extends CommandLineTool {
           gateways.push({
             platformName: platform.name == null ? platform.platform : platform.name,
             username,
+            childBridge,
             uiPort: gateway.context.uiPort,
             gid: gateway.context.id,
             name: gateway.context.name
@@ -350,12 +424,38 @@ class Main extends CommandLineTool {
         throw new Error(`no UI server found for gateway ${this.clargs.gateway}`)
       }
     }
+    if (this.clargs.command === 'discover') {
+      return this.discover(platforms, this.clargs.args)
+    }
     const { gid, uiPort } = platforms[0]
     this.client = await this.createUiClient(uiPort)
     this.gid = gid
     return this[this.clargs.command](this.clargs.args)
   }
 
+  async discover (platforms, ...args) {
+    const parser = new CommandLineParser(packageJson)
+    const clargs = {
+      options: {}
+    }
+    parser
+      .help('h', 'help', help.get)
+      .flag('s', 'sortKeys', () => { clargs.options.sortKeys = true })
+      .flag('n', 'noWhiteSpace', () => {
+        clargs.options.noWhiteSpace = true
+      })
+      .flag('j', 'jsonArray', () => { clargs.options.noWhiteSpace = true })
+      .flag('u', 'joinKeys', () => { clargs.options.joinKeys = true })
+      .flag('a', 'ascii', () => { clargs.options.ascii = true })
+      .flag('t', 'topOnly', () => { clargs.options.topOnly = true })
+      .flag('l', 'leavesOnly', () => { clargs.options.leavesOnly = true })
+      .flag('k', 'keysOnly', () => { clargs.options.keysOnly = true })
+      .flag('v', 'valuesOnly', () => { clargs.options.valuesOnly = true })
+      .parse(...args)
+    const jsonFormatter = new JsonFormatter(clargs.options)
+    this.print(jsonFormatter.stringify(platforms))
+  }
+
   async get (...args) {
     const parser = new CommandLineParser(packageJson)
     const clargs = {
@@ -379,10 +479,15 @@ class Main extends CommandLineTool {
       })
       .parse(...args)
     if (clargs.resource === '/') {
-      clargs.resource = ''
+      clargs.resource = '/gateways/' + this.gid
+    } else if (
+      clargs.resource.startsWith('/devices') ||
+      clargs.resource.startsWith('/accessories')
+    ) {
+      clargs.resource = '/gateways/' + this.gid + clargs.resource
     }
+    const { body } = await this.client.get(clargs.resource)
     const jsonFormatter = new JsonFormatter(clargs.options)
-    const { body } = await this.client.get('/gateways/' + this.gid + clargs.resource)
     this.print(jsonFormatter.stringify(body))
   }
 
@@ -392,7 +497,7 @@ class Main extends CommandLineTool {
       options: {}
     }
     parser
-      .help('h', 'help', help.get)
+      .help('h', 'help', help.put)
       .parameter('resource', (value) => {
         clargs.resource = OptionParser.toPath('resource', value)
       })
@@ -406,12 +511,16 @@ class Main extends CommandLineTool {
       })
       .parse(...args)
     if (clargs.resource === '/') {
-      clargs.resource = ''
+      clargs.resource = '/gateways/' + this.gid
+    } else if (
+      clargs.resource.startsWith('/devices') ||
+      clargs.resource.startsWith('/accessories')
+    ) {
+      clargs.resource = '/gateways/' + this.gid + clargs.resource
     }
+    clargs.resource += '/settings'
     const jsonFormatter = new JsonFormatter(clargs.options)
-    const { body } = await this.client.put(
-      '/gateways/' + this.gid + clargs.resource + '/settings', clargs.body
-    )
+    const { body } = await this.client.put(clargs.resource, clargs.body)
     this.print(jsonFormatter.stringify(body))
   }
 }

package/lib/Deconz/Resource.js

@@ -1034,6 +1034,18 @@ class Resource {
             break
         }
         break
+      case '_TZ3000_mh9px7cq':
+        switch (this.model) {
+          case 'TS0044':
+            buttons.push([1, 'Button 1', SINGLE | DOUBLE | LONG])
+            buttons.push([2, 'Button 2', SINGLE | DOUBLE | LONG])
+            buttons.push([3, 'Button 3', SINGLE | DOUBLE | LONG])
+            buttons.push([4, 'Button 4', SINGLE | DOUBLE | LONG])
+            break
+          default:
+            break
+        }
+        break
       case '_TZ3000_pzui3skt':
         switch (this.model) {
           case 'TS0041': // Tuya 1-button switch

package/lib/DeconzAccessory/Gateway.js

@@ -116,7 +116,6 @@ class Gateway extends AccessoryDelegate {
           ':' + this.values.wsPort
       }
     })
-    this.values.host = params.host
 
     this.addPropertyDelegate({
       key: 'periodicEvents',
@@ -707,16 +706,21 @@ class Gateway extends AccessoryDelegate {
         manufacturer: this.values.manufacturer,
         model: this.values.model,
         name: this.name,
-        settings: {
-          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
-        }
+        settings: this.values.apiKey == null
+          ? {
+              expose: this.values.expose,
+              logLevel: this.values.logLevel
+            }
+          : {
+              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 }
     }
@@ -763,15 +767,18 @@ class Gateway extends AccessoryDelegate {
         .on('userInputError', (error) => {
           this.warn(error)
         })
-        .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)
+      if (this.values.apiKey != null) {
+        optionParser
+          .intKey('brightnessAdjustment', 10, 100)
+          .intKey('heartrate', 1, 60)
+          .boolKey('periodicEvents')
+          .boolKey('restart')
+          .boolKey('search')
+          .boolKey('unlock')
+      }
+      optionParser.parse(body)
 
       const responseBody = {}
       for (const key in settings) {

package/lib/DeconzAccessory/index.js

@@ -241,7 +241,7 @@ class DeconzAccessory extends AccessoryDelegate {
             serviceName: this.values.serviceName,
             splitLight: undefined,
             venetianBlind: this.service.values.venetianBlind,
-            wallSwitch: undefined
+            wallSwitch: this.service.values.wallSwitch
           }
         : undefined,
       type: resource.rtype,
@@ -312,6 +312,14 @@ class DeconzAccessory extends AccessoryDelegate {
               continue
             }
             break
+          case 'wallSwitch':
+            if (this.service.values[key] != null) {
+              value = OptionParser.toBool(key, body[key])
+              this.service.values[key] = value
+              responseBody[key] = value
+              continue
+            }
+            break
           default:
             break
         }

package/lib/DeconzPlatform.js

@@ -141,7 +141,7 @@ class DeconzPlatform extends Platform {
         jobs.push(events.once(this, 'found'))
         for (const id in this.gatewayMap) {
           const gateway = this.gatewayMap[id]
-          const host = gateway.context.host
+          const host = gateway.values.host
           this.debug('job %d: find gateway %s', jobs.length, id)
           jobs.push(events.once(gateway, 'initialised'))
           try {

package/lib/DeconzService/Light.js

@@ -270,10 +270,11 @@ class Light extends DeconzService.LightsResource {
       }
     }
 
-    this.settings = {
-      resetTimeout: this.platform.config.resetTimeout,
-      waitTimeUpdate: this.platform.config.waitTimeUpdate,
-      wallSwitch: false
+    if (this.resource.rtype === 'lights') {
+      this.addCharacteristicDelegate({
+        key: 'wallSwitch',
+        value: false
+      })
     }
   }
 
@@ -413,6 +414,13 @@ class Light extends DeconzService.LightsResource {
           }
           break
         case 'on':
+          if (this.values.wallSwitch && !state.reachable) {
+            if (this.values.on) {
+              this.log('not reachable: force On to false')
+            }
+            this.values.on = false
+            break
+          }
           this.values.on = value
           break
         case 'sat':

package/package.json

@@ -4,7 +4,7 @@
   "displayName": "Homebridge deCONZ",
   "author": "Erik Baauw",
   "license": "Apache-2.0",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "keywords": [
     "homebridge-plugin",
     "homekit",
@@ -23,10 +23,10 @@
   "engines": {
     "deCONZ": "2.19.3",
     "homebridge": "^1.6.0",
-    "node": "^18.14.1"
+    "node": "^18.14.2"
   },
   "dependencies": {
-    "homebridge-lib": "~6.3.10",
+    "homebridge-lib": "~6.3.11",
     "ws": "^8.12.1",
     "xml2js": "~0.4.23"
   },