hb-rpi-tools 1.0.0 → 1.0.2

package/lib/GpioClient/Pigpio.js

@@ -415,11 +415,17 @@ class Pigpio extends GpioClient {
     * for sending commands and receiving responses.
     * @throws `Error` - When connection fails.
     * @emits connect
+    * @emits ready
     */
   async connect () {
     await super.connect()
     await this.command(commands.HWVER)
     this.emit('message', 'connected to pigpio')
+
+    /** Emitted when client is ready to use the pigpio socket.
+      * @event PigpioClient#ready
+      */
+    this.emit('ready')
   }
 
   /** Subscribe to notifications for changed GPIO values.
@@ -689,14 +695,13 @@ class Pigpio extends GpioClient {
     const status = (await this.command(
       commands.SHELL, script.length, 0, script + '\0'
     )).status
-    if (status === 32512) {
-      throw new Error(
-        `${this.commandName(commands.SHELL)}: ${script}: script not found`
-      )
-    } else if (status !== 0) {
-      throw new Error(
-        `${this.commandName(commands.SHELL)}: ${script}: exit status ${status / 256}`
-      )
+    if (status !== 0) {
+      const message = status == null
+        ? 'timeout'
+        : status === 32512
+          ? 'script not found'
+          : `exit status ${status / 256}`
+      throw new Error(`${script}: ${message}`)
     }
     return status
   }

package/lib/GpioClient/Rgpio.js

@@ -364,6 +364,7 @@ class Rgpio extends GpioClient {
     * for sending commands and receiving responses.
     * @throws `Error` - When connection fails.
     * @emits connect
+    * @emits ready
     */
   async connect () {
     await super.connect()
@@ -396,6 +397,11 @@ class Rgpio extends GpioClient {
       const result = await this.command(commands.GIC, { longs: [this.gpioChipHandle] })
       this.emit('message', `${result.name}: ${result.label}`)
     }
+
+    /** Emitted when client is ready to use the rgpio socket.
+      * @event RgpioClient#ready
+      */
+    this.emit('ready')
   }
 
   /** Subscribe to notifications for changed GPIO values.
@@ -702,14 +708,13 @@ class Rgpio extends GpioClient {
     const status = (await this.command(
       commands.SHELL, { longs: [script.length + 1], string: script }
     )).status
-    if (status === 32512) {
-      throw new Error(
-        `${this.commandName(commands.SHELL)}: ${script}: script not found`
-      )
-    } else if (status !== 0) {
-      throw new Error(
-        `${this.commandName(commands.SHELL)}: ${script}: exit status ${status / 256}`
-      )
+    if (status !== 0) {
+      const message = status == null
+        ? 'timeout'
+        : status === 32512
+          ? 'script not found'
+          : `exit status ${status / 256}`
+      throw new Error(`${script}: ${message}`)
     }
     return status
   }

package/lib/RpiTool.js

@@ -15,7 +15,7 @@ const { b, u } = CommandLineTool
 const { UsageError } = CommandLineParser
 
 const usage = {
-  rpi: `${b('rpi')} [${b('-hDV')}] [${b('-H')} ${u('hostname')}[${b(':')}${u('port')}]]] [${b('-U')} ${u('user')}] [${b('-P')} ${u('password')}] ${u('command')} [${u('argument')} ...]`,
+  rpi: `${b('rpi')} [${b('-hDV')}] [${b('-H')} ${u('hostname')}[${b(':')}${u('port')}]]] [${b('-U')} ${u('user')}] [${b('-P')} ${u('password')}] [${b('-t')} ${u('timeout')}] ${u('command')} [${u('argument')} ...]`,
   info: `${b('info')} [${b('-hns')}]`,
   state: `${b('state')} [${b('-hns')}]`,
   test: `${b('test')} [${b('-hns')}]`,
@@ -76,6 +76,10 @@ Parameters:
   Default is ${b('')} (empty).
   The password can also be set through the environment variable ${b('LG_PASS')}.
 
+  ${b('-t')} ${u('timeout')}, ${b('--timeout=')}${u('timeout')}
+  Set the command timeout in seconds.
+  Default is ${b('15')}.
+
 Commands:
   ${usage.info}
   ${description.info}
@@ -352,7 +356,8 @@ class RpiTool extends CommandLineTool {
       options: {
         host: process.env.LG_ADDR || process.env.PIGPIO_ADDR || 'localhost',
         user: process.env.LG_USER || 'homebridge-rpi',
-        password: process.env.LG_PASS || ''
+        password: process.env.LG_PASS || '',
+        timeout: 15
       },
       port: process.env.LG_ADDR == null && process.env.PIGPIO_ADDR != null ? 8888 : 8889
     }
@@ -380,6 +385,9 @@ class RpiTool extends CommandLineTool {
       .option('P', 'password', (value) => {
         clargs.options.password = OptionParser.toString('password', value, true)
       })
+      .option('t', 'timeout', (value) => {
+        clargs.options.timeout = OptionParser.toInt('timeout', value, 1, 60, true)
+      })
       .parameter('command', (value) => {
         if (usage[value] == null || typeof this[value] !== 'function') {
           throw new UsageError(`${value}: unknown command`)
@@ -441,7 +449,7 @@ class RpiTool extends CommandLineTool {
     return state
   }
 
-  async _parseCommandArgs (...args) {
+  _parseCommandArgs (...args) {
     const parser = new CommandLineParser(this.pkgJson)
     const clargs = { options: {} }
     parser
@@ -525,7 +533,7 @@ class RpiTool extends CommandLineTool {
       .help('h', 'help', this.help)
       .remaining((list) => {
         for (const i in list) {
-          const gpio = OptionParser.toInt(`gpio[${i}]`, list[i])
+          const gpio = OptionParser.toInt(`gpio[${i}]`, list[i], 0, 31, true)
           const bit = 1 << gpio
           this.debug('gpio %d, bit %d', gpio, bit)
           if ((bit & gpioMask) === 0) {
@@ -557,7 +565,7 @@ class RpiTool extends CommandLineTool {
     parser
       .help('h', 'help', this.help)
       .parameter('gpio', (value) => {
-        clargs.gpio = OptionParser.toInt('gpio', value)
+        clargs.gpio = OptionParser.toInt('gpio', value, 0, 31, true)
       })
       .remaining((value) => {
         if (value.length > 1) {
@@ -589,14 +597,14 @@ class RpiTool extends CommandLineTool {
     parser
       .help('h', 'help', this.help)
       .parameter('gpio', (value) => {
-        clargs.gpio = OptionParser.toInt('gpio', value)
+        clargs.gpio = OptionParser.toInt('gpio', value, 0, 31, true)
       })
       .remaining((value) => {
         if (value.length > 1) {
           throw new UsageError('too many parameters')
         }
         if (value.length === 1) {
-          clargs.value = OptionParser.toInt('dutyCycle', value[0], 0, 100)
+          clargs.value = OptionParser.toInt('dutyCycle', value[0], 0, 100, true)
         }
       })
       .parse(...args)
@@ -626,16 +634,16 @@ class RpiTool extends CommandLineTool {
     parser
       .help('h', 'help', this.help)
       .parameter('gpio', (value) => {
-        clargs.gpio = OptionParser.toInt('gpio', value)
+        clargs.gpio = OptionParser.toInt('gpio', value, 0, 31, true)
       })
       .remaining((value) => {
         if (value.length > 1) {
           throw new UsageError('too many parameters')
         }
         if (value.length === 1) {
-          clargs.value = OptionParser.toInt('pulseWidth', value[0], 0)
+          clargs.value = OptionParser.toInt('pulseWidth', value[0], 0, 2500, true)
           if (clargs.value !== 0) {
-            clargs.value = OptionParser.toInt('pulseWidth', value[0], 500, 2500)
+            clargs.value = OptionParser.toInt('pulseWidth', value[0], 500, 2500, true)
           }
         }
       })
@@ -664,7 +672,7 @@ class RpiTool extends CommandLineTool {
     parser
       .help('h', 'help', this.help)
       .parameter('gpio', (value) => {
-        clargs.gpio = OptionParser.toInt('gpio', value)
+        clargs.gpio = OptionParser.toInt('gpio', value, 0, 31, true)
       })
       .parse(...args)
     const { gpioMask, model } = await this._getInfo()

package/package.json

@@ -2,7 +2,7 @@
   "name": "hb-rpi-tools",
   "description": "Homebridge RPi Tools",
   "license": "Apache-2.0",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "keywords": [
     "raspberrypi",
     "raspberry",
@@ -28,7 +28,7 @@
     "node": "^24||^22||^20"
   },
   "dependencies": {
-    "hb-lib-tools": "~2.2.17"
+    "hb-lib-tools": "~3.0.0"
   },
   "scripts": {
     "prepare": "standard && rm -rf out && jsdoc -c jsdoc.json",