homebridge-deconz 1.3.5 → 1.3.6-0

package/cli/deconz.js

@@ -5,10 +5,9 @@
 //
 // Command line interface to deCONZ gateway.
 
-import { createRequire } from 'node:module'
-
 import { DeconzTool } from 'hb-deconz-tools/DeconzTool'
 
+import { createRequire } from 'node:module'
 const require = createRequire(import.meta.url)
 const packageJson = require('../package.json')
 

package/cli/otau.js

@@ -5,10 +5,9 @@
 //
 // Command line interface to deCONZ gateway.
 
-import { createRequire } from 'node:module'
-
 import { OtauTool } from 'hb-deconz-tools/OtauTool'
 
+import { createRequire } from 'node:module'
 const require = createRequire(import.meta.url)
 const packageJson = require('../package.json')
 

package/cli/ui.js

@@ -1,24 +1,21 @@
 #!/usr/bin/env node
 
-// homebridge-deconz/cli/deconz.js
+// homebridge-deconz/cli/ui.js
 // Copyright © 2018-2026 Erik Baauw. All rights reserved.
 //
 // Command line interface to Homebridge deCONZ UI Server.
 
 import { readFile } from 'node:fs/promises'
-import { createRequire } from 'node:module'
 
-import { CommandLineParser } from 'hb-lib-tools/CommandLineParser'
-import { CommandLineTool } from 'hb-lib-tools/CommandLineTool'
+import { CommandLineTool, CommandLineParser, UsageError, b, u } from 'hb-lib-tools/CommandLineTool'
 import { HttpClient } from 'hb-lib-tools/HttpClient'
 import { JsonFormatter } from 'hb-lib-tools/JsonFormatter'
-import { OptionParser } from 'hb-lib-tools/OptionParser'
+import { patterns, toInt, toPath, toString } from 'hb-lib-tools/OptionParser'
 
+import { createRequire } from 'node:module'
 const require = createRequire(import.meta.url)
-const packageJson = require('../package.json')
-
-const { b, u } = CommandLineTool
-const { UsageError } = CommandLineParser
+const defaultPackageJson = require('../package.json')
+// import defaultPackageJson from '../package.json' with { type: 'json' }
 
 const usage = {
   ui: `${b('ui')} [${b('-hVD')}] [${b('-U')} ${u('username')}] [${b('-G')} ${u('gateway')}] [${b('-t')} ${u('timeout')}] ${u('command')} [${u('argument')} ...]`,
@@ -181,38 +178,38 @@ Parameters:
 }
 
 class Main extends CommandLineTool {
-  constructor () {
-    super({ mode: 'command', debug: false })
+  constructor (packageJson) {
+    super(packageJson ?? defaultPackageJson, { mode: 'command', debug: false })
     this.usage = usage.deconz
   }
 
   parseArguments () {
-    const parser = new CommandLineParser(packageJson)
+    const parser = new CommandLineParser(this)
     const clargs = {
       options: {
         timeout: 5
       }
     }
     parser
-      .help('h', 'help', help.ui)
-      .version('V', 'version')
-      .debug('D', 'debug', this)
+      .helpFlag('h', 'help', help.ui)
+      .versionFlag('V', 'version')
+      .debugFlag('D', 'debug')
       .option('U', 'username', (value) => {
-        clargs.username = OptionParser.toString(
-          'username', value, true, true
+        clargs.username = toString(
+          value, { key: 'username', nonEmpty: true, userInput: true }
         ).toUpperCase()
-        if (!OptionParser.patterns.mac.test(clargs.username)) {
+        if (!patterns.mac.test(clargs.username)) {
           throw new UsageError(`${clargs.username}: invalid username`)
         }
       })
       .option('G', 'gateway', (value) => {
-        clargs.gateway = OptionParser.toString(
-          'gateway', value, true, true
+        clargs.gateway = toString(
+          value, { key: 'gateway', nonEmpty: true, userInput: true }
         ).toUpperCase()
       })
       .option('t', 'timeout', (value) => {
-        clargs.options.timeout = OptionParser.toInt(
-          'timeout', value, 1, 60, true
+        clargs.options.timeout = toInt(
+          value, { key: 'timeout', min: 1, max: 60, userInput: true }
         )
       })
       .parameter('command', (value) => {
@@ -342,7 +339,7 @@ class Main extends CommandLineTool {
       timeout: this.clargs.options.timeout
     })
     const response = await client.get('/ping')
-    if (response.body !== 'pong') {
+    if (response.jsonBody !== 'pong') {
       throw new Error(`${host}: cannot ping`)
     }
     return client
@@ -382,12 +379,12 @@ class Main extends CommandLineTool {
   }
 
   async discover (platforms, ...args) {
-    const parser = new CommandLineParser(packageJson)
+    const parser = new CommandLineParser(this)
     const clargs = {
       options: {}
     }
     parser
-      .help('h', 'help', help.get)
+      .helpFlag('h', 'help', help.get)
       .flag('s', 'sortKeys', () => { clargs.options.sortKeys = true })
       .flag('n', 'noWhiteSpace', () => {
         clargs.options.noWhiteSpace = true
@@ -405,12 +402,12 @@ class Main extends CommandLineTool {
   }
 
   async get (...args) {
-    const parser = new CommandLineParser(packageJson)
+    const parser = new CommandLineParser(this)
     const clargs = {
       options: {}
     }
     parser
-      .help('h', 'help', help.get)
+      .helpFlag('h', 'help', help.get)
       .flag('s', 'sortKeys', () => { clargs.options.sortKeys = true })
       .flag('n', 'noWhiteSpace', () => {
         clargs.options.noWhiteSpace = true
@@ -423,7 +420,7 @@ class Main extends CommandLineTool {
       .flag('k', 'keysOnly', () => { clargs.options.keysOnly = true })
       .flag('v', 'valuesOnly', () => { clargs.options.valuesOnly = true })
       .parameter('resource', (value) => {
-        clargs.resource = OptionParser.toPath('resource', value)
+        clargs.resource = toPath(value, { key: 'resource', userInput: true })
       })
       .parse(...args)
     if (clargs.resource === '/') {
@@ -434,23 +431,23 @@ class Main extends CommandLineTool {
     ) {
       clargs.resource = '/gateways/' + this.gid + clargs.resource
     }
-    const { body } = await this.client.get(clargs.resource)
+    const { jsonBody } = await this.client.get(clargs.resource)
     const jsonFormatter = new JsonFormatter(clargs.options)
-    this.print(jsonFormatter.stringify(body))
+    this.print(jsonFormatter.stringify(jsonBody))
   }
 
   async put (...args) {
-    const parser = new CommandLineParser(packageJson)
+    const parser = new CommandLineParser(this)
     const clargs = {
       options: {}
     }
     parser
-      .help('h', 'help', help.put)
+      .helpFlag('h', 'help', help.put)
       .parameter('resource', (value) => {
-        clargs.resource = OptionParser.toPath('resource', value)
+        clargs.resource = toPath(value, { key: 'resource', userInput: true })
       })
       .parameter('body', (value) => {
-        value = OptionParser.toString('body', value, true, true)
+        value = toString(value, { key: 'body', nonEmpty: true, userInput: true })
         try {
           clargs.body = JSON.parse(value)
         } catch (error) {
@@ -468,8 +465,11 @@ class Main extends CommandLineTool {
     }
     clargs.resource += '/settings'
     const jsonFormatter = new JsonFormatter(clargs.options)
-    const { body } = await this.client.put(clargs.resource, clargs.body)
-    this.print(jsonFormatter.stringify(body))
+    const { jsonBody } = await this.client.put(clargs.resource, clargs.body)
+    for (const error of jsonBody.errors || []) {
+      this.warn(error) // TODO: include request details.
+    }
+    this.print(jsonFormatter.stringify(jsonBody.success))
   }
 }
 

package/jsdoc.json

@@ -11,7 +11,7 @@
       "cli",
       "node_modules/hb-deconz-tools/index.js",
       "node_modules/hb-deconz-tools/lib",
-      "node_modules/hb-lib-tools/lib/HttpClient.js"
+      "node_modules/hb-lib-tools/dist/HttpClient.js"
     ]
   },
   "opts": {

package/lib/Deconz/Resource.js

@@ -3,7 +3,7 @@
 //
 // Homebridge plugin for deCONZ.
 
-import { OptionParser } from 'homebridge-lib/OptionParser'
+import { toInstance, toInt, toObject, toString } from 'homebridge-lib/OptionParser'
 
 import { ApiClient } from 'hb-deconz-tools/ApiClient'
 
@@ -13,7 +13,6 @@ import '../DeconzAccessory/Gateway.js'
 import { DeconzService } from '../DeconzService/index.js'
 import '../DeconzService/Button.js'
 
-const { toInstance, toInt, toObject, toString } = OptionParser
 const { buttonEvent } = ApiClient
 const { SINGLE, DOUBLE, LONG } = DeconzService.Button
 const rtypes = ['lights', 'sensors', 'groups', 'alarmsystems']
@@ -91,7 +90,7 @@ class Resource {
     * @return {object} The MultiCLIP `id`, `endpoint`, and `cluster`.
     */
   static parseClipId (uniqueid) {
-    toString('uniqueid', uniqueid, true)
+    toString(uniqueid, { key: 'uniqueid', nonEmpty: true })
     const a = patterns.clipId.exec(uniqueid.replace(/:/g, '').toUpperCase())
     return {
       id: a?.[1],
@@ -124,12 +123,12 @@ class Resource {
     * @param {object} body - The body of the resource.
     */
   constructor (gateway, rtype, rid, body) {
-    toInstance('gateway', gateway, DeconzAccessory.Gateway)
+    toInstance(gateway, { key: 'gateway', class: DeconzAccessory.Gateway })
 
     /** The resource type of the resource: `groups`, `lights`, or `sensors`.
       * @type {string}
       */
-    this.rtype = toString('rtype', rtype, true)
+    this.rtype = toString(rtype, { key: 'rtype', nonEmpty: true })
     if (!(rtypes.includes(rtype))) {
       throw new RangeError(`rtype: ${rtype}: not a valid resource type`)
     }
@@ -137,20 +136,20 @@ class Resource {
     /** The resource ID of the resource.
       * @type {integer}
       */
-    this.rid = toInt('rid', rid)
+    this.rid = toInt(rid, { key: 'rid' })
 
     /** The body of the resource.
       * @type {object}
       */
-    this.body = toObject('body', body)
-    toString('body.name', body.name, true)
+    this.body = toObject(body, { key: 'body' })
+    toString(body.name, { key: 'body.name', nonEmpty: true })
     body.name = body.name.replace(/[^\p{L}\p{N} ']/ug, ' ')
       .replace(/^[ ']*/, '')
       .replace(/[ ']*$/, '')
     if (rtype === 'alarmsystems') {
       body.type = 'AlarmSystem'
     }
-    toString('body.type', body.type, true)
+    toString(body.type, { key: 'body.type', nonEmpty: true })
 
     let realDevice = false
 

package/lib/DeconzAccessory/Gateway.js

@@ -5,7 +5,7 @@
 
 import { timeout } from 'homebridge-lib'
 import { AccessoryDelegate } from 'homebridge-lib/AccessoryDelegate'
-import { OptionParser } from 'homebridge-lib/OptionParser'
+import { OptionParser, toBool } from 'homebridge-lib/OptionParser'
 
 import { ApiClient } from 'hb-deconz-tools/ApiClient'
 import { ApiError } from 'hb-deconz-tools/ApiError'
@@ -882,12 +882,17 @@ class Gateway extends AccessoryDelegate {
     if (path.length === 0) {
       return { status: 405 } // Method Not Allowed
     }
+    const responseBody = {
+      success: {},
+      errors: []
+    }
     if (path[0] === 'settings') {
       const settings = {}
       const optionParser = new OptionParser(settings, true)
       optionParser
         .on('userInputError', (error) => {
-          this.warn(error)
+          this.warn('ui error: %s', error)
+          responseBody.errors.push(error.message)
         })
         .boolKey('autoExpose')
         .boolKey('expose')
@@ -904,12 +909,11 @@ class Gateway extends AccessoryDelegate {
       }
       optionParser.parse(body)
 
-      const responseBody = {}
       for (const key in settings) {
         switch (key) {
           case 'brightnessAdjustment':
             this.values[key] = settings[key] / 100
-            responseBody[key] = this.values[key]
+            responseBody.success[key] = this.values[key]
             break
           case 'autoExpose':
           case 'expose':
@@ -921,7 +925,7 @@ class Gateway extends AccessoryDelegate {
           case 'search':
           case 'unlock':
             this.values[key] = settings[key]
-            responseBody[key] = this.values[key]
+            responseBody.success[key] = this.values[key]
             break
           default:
             break
@@ -951,10 +955,16 @@ class Gateway extends AccessoryDelegate {
           return { status: 404 } // Not Found
         }
         if (body.expose != null) {
-          this.exposeDevice(id, body.expose)
-          return { status: 200, body: { expose: body.expose } }
+          try {
+            toBool(body.expose, { key: 'expose', userInput: true })
+            this.exposeDevice(id, body.expose)
+            responseBody.success.expose = body.expose
+          } catch (error) {
+            this.warn('ui error: %s', error)
+            responseBody.errors.push(error.message)
+          }
         }
-        return { status: 200 }
+        return { status: 200, body: responseBody }
       }
     }
     return { status: 403 } // Forbidden

package/lib/DeconzAccessory/index.js

@@ -4,7 +4,7 @@
 // Homebridge plugin for deCONZ.
 
 import { AccessoryDelegate } from 'homebridge-lib/AccessoryDelegate'
-import { OptionParser } from 'homebridge-lib/OptionParser'
+import { toBool, toInt, toString, UserInputError } from 'homebridge-lib/OptionParser'
 
 import { ApiClient } from 'hb-deconz-tools/ApiClient'
 
@@ -262,21 +262,25 @@ class DeconzAccessory extends AccessoryDelegate {
     return { status: 200, body }
   }
 
+  // TODO: userInputErrors are logged in Homebridge log, but not returned in the UI response.
   onUiPut (body) {
     let reExpose = false
-    const responseBody = {}
+    const responseBody = {
+      success: {},
+      errors: []
+    }
     for (const key in body) {
       try {
         let value
         switch (key) {
           case 'expose':
-            value = OptionParser.toBool(key, body[key])
+            value = toBool(body[key], { key, userInput: true })
             if (value) {
               reExpose = true
             } else {
               this.gateway.exposeDevice(this.id, value)
             }
-            responseBody[key] = value
+            responseBody.success[key] = value
             continue
           // Settings for the primary service.
           case 'anyOn':
@@ -284,52 +288,52 @@ class DeconzAccessory extends AccessoryDelegate {
           case 'exposeScenes':
           case 'venetianBlind':
             if (this.service.values[key] != null) {
-              value = OptionParser.toBool(key, body[key])
+              value = toBool(body[key], { key, userInput: true })
               this.service.values[key] = value
               reExpose = true
-              responseBody[key] = value
+              responseBody.success[key] = value
               continue
             }
             break
           case 'logLevel':
-            value = OptionParser.toInt(key, body[key], 0, 3)
+            value = toInt(body[key], { key, min: 0, max: 3, userInput: true })
             this.values[key] = value
-            responseBody[key] = value
+            responseBody.success[key] = value
             continue
           case 'lowBatteryThreshold':
             if (this.servicesByServiceName.Battery?.[0] != null) {
-              value = OptionParser.toInt(key, body[key], 10, 100)
+              value = toInt(body[key], { key, min: 10, max: 100, userInput: true })
               this.servicesByServiceName.Battery[0].values[key] = value
-              responseBody[key] = value
+              responseBody.success[key] = value
               continue
             }
             break
           case 'pin':
             if (this.service.values[key] != null) {
-              value = OptionParser.toString(key, body[key])
+              value = toString(body[key], { key, userInput: true })
               this.service.values[key] = value
-              responseBody[key] = value
+              responseBody.success[key] = value
               continue
             }
             break
           case 'serviceName':
             if (this.values.serviceName != null) {
-              value = OptionParser.toString(key, body[key])
-              if (['Light', 'Outlet', 'Switch', 'Valve'].includes(value) == null) {
-                throw new Error(`${value}: illegal serviceName`)
+              value = toString(body[key], { key, nonEmpty: true, userInput: true })
+              if (!['Light', 'Outlet', 'Switch', 'Valve'].includes(value)) {
+                throw new UserInputError(`${value}: not a valid serviceName`)
               }
               this.values.serviceName = value
               reExpose = true
-              responseBody[key] = value
+              responseBody.success[key] = value
               continue
             }
             break
           case 'useExternalTemperature':
           case 'wallSwitch':
             if (this.service.values[key] != null) {
-              value = OptionParser.toBool(key, body[key])
+              value = toBool(body[key], { key, userInput: true })
               this.service.values[key] = value
-              responseBody[key] = value
+              responseBody.success[key] = value
               continue
             }
             break
@@ -337,7 +341,11 @@ class DeconzAccessory extends AccessoryDelegate {
             break
         }
         this.warn('ui error: %s: invalid key', key)
-      } catch (error) { this.warn('ui error: %s', error) }
+        responseBody.errors.push(`${key}: invalid key`)
+      } catch (error) {
+        this.warn('ui error: %s', error)
+        responseBody.errors.push(error.message)
+      }
     }
     if (reExpose) {
       this.gateway.reExposeAccessory(this.id)

package/lib/DeconzService/Light.js

@@ -5,14 +5,12 @@
 
 import { timeout } from 'homebridge-lib'
 import { AdaptiveLighting } from 'homebridge-lib/AdaptiveLighting'
-import { Colour } from 'homebridge-lib/Colour'
+import { defaultGamut, xyToHsv, hsvToXy, ctToXy, hsvToRgb } from 'homebridge-lib/Colour'
 import { ServiceDelegate } from 'homebridge-lib/ServiceDelegate'
 
 import { DeconzService } from '../DeconzService/index.js'
 import '../DeconzService/LightsResource.js'
 
-const { defaultGamut, xyToHsv, hsvToXy, ctToXy, hsvToRgb } = Colour
-
 class Light extends DeconzService.LightsResource {
   constructor (accessory, resource, params = {}) {
     params.Service = accessory.Services.hap.Lightbulb

package/package.json

@@ -7,7 +7,7 @@
     "ebaauw"
   ],
   "license": "Apache-2.0",
-  "version": "1.3.5",
+  "version": "1.3.6-0",
   "keywords": [
     "homebridge-plugin",
     "homekit",
@@ -28,11 +28,11 @@
   "engines": {
     "deCONZ": "2.33.2",
     "homebridge": "^2.4.0",
-    "node": "^24||^22"
+    "node": "^26||^24||^22"
   },
   "dependencies": {
-    "hb-deconz-tools": "~3.0.7",
-    "homebridge-lib": "~8.1.5"
+    "hb-deconz-tools": "~3.0.8-0",
+    "homebridge-lib": "~9.0.0-0"
   },
   "scripts": {
     "prepare": "standard && rm -rf out && jsdoc -c jsdoc.json",