hb-rpi-tools 0.0.2 → 0.0.3

package/lib/GpioClient/PigpioClient.js

@@ -650,12 +650,17 @@ class PigpioClient extends GpioClient {
     await this.command(this.commands.WDOG, gpio, timeout)
   }
 
-  async dhtPoll (gpio) {
+  async dhtRead (gpio) {
     await this.write(gpio, 0)
     await timeout(18)
     await this.setInput(gpio, this.pudValues.up)
   }
 
+  async read (gpio) {
+    const response = await this.command(this.commands.READ, gpio)
+    return response.status !== 0
+  }
+
   async write (gpio, value) {
     await this.command(this.commands.WRITE, gpio, (value ? 1 : 0))
   }

package/lib/GpioClient/RgpioClient.js

@@ -380,12 +380,20 @@ class RgpioClient extends GpioClient {
     await this.command(commands.PASSW, { string: hash.digest('hex') })
     this.emit('message', `user ${this._params.user} logged in`)
 
-    this.gpioChipHandle = (await (this.command(commands.GO, { longs: [0] }))).status
-    if (this.gpioChipHandle !== 0) {
-      this.emit('warning', new Error(`got GPIO chip handle ${this.gpioChipHandle}`))
+    await this.command(commands.SHARE, { longs: [42] })
+    this.gpioChipHandle = 0
+    try {
+      const result = await this.command(commands.GIC, { longs: [this.gpioChipHandle] })
+      this.emit('message', `${result.name}: ${result.label}`)
+    } catch (error) {
+      this.emit('message', `warning: ${error.message}`)
+      this.gpioChipHandle = (await (this.command(commands.GO, { longs: [0] }))).status
+      if (this.gpioChipHandle !== 0) {
+        this.emit('warning', new Error(`got GPIO chip handle ${this.gpioChipHandle}`))
+      }
+      const result = await this.command(commands.GIC, { longs: [this.gpioChipHandle] })
+      this.emit('message', `${result.name}: ${result.label}`)
     }
-    const result = await this.command(commands.GIC, { longs: [this.gpioChipHandle] })
-    this.emit('message', `${result.name}: ${result.label}`)
   }
 
   /** Subscribe to notifications for changed GPIO values.
@@ -405,9 +413,9 @@ class RgpioClient extends GpioClient {
 
     await super.listen()
 
-    if (this.dataHandle !== 0) {
-      this.emit('warning', new Error(`got data handle ${this.dataHandle}`))
-    }
+    // if (this.dataHandle !== 0) {
+    //   this.emit('warning', new Error(`got data handle ${this.dataHandle}`))
+    // }
 
     const { tick, date } = await this.command(commands.TICK)
     this.emit('message', `tick: ${tick} (${date})`)
@@ -450,7 +458,7 @@ class RgpioClient extends GpioClient {
       }
       delete this.fileHandle
     }
-    if (this.gpioChipHandle != null) {
+    if (this.gpioChipHandle != null && this.gpioChipHandle !== 0) {
       try {
         await this.command(commands.GC, { longs: [this.gpioChipHandle] })
       } catch (error) {
@@ -644,9 +652,10 @@ class RgpioClient extends GpioClient {
       value = (await this.command(this.commands.GR, { longs: [this.gpioChipHandle, gpio] })).status
     }
     await this.command(this.commands.GSOX, { longs: [this.gpioChipHandle, gpioModes.none, gpio, value] })
+    // this.mask |= (1 << gpio)
   }
 
-  async dhtPoll (gpio) {
+  async dhtRead (gpio) {
     await this.setOutput(gpio, 0)
     await timeout(18)
     await this.command(this.commands.GSAX, {
@@ -655,6 +664,11 @@ class RgpioClient extends GpioClient {
     })
   }
 
+  async read (gpio) {
+    const result = await this.command(this.commands.GR, { longs: [this.gpioChipHandle, gpio] })
+    return result.status === 1
+  }
+
   async write (gpio, value) {
     await this.command(this.commands.GW, { longs: [this.gpioChipHandle, gpio, value ? 1 : 0] })
     this.emit('gpio' + gpio, { value, tick: 0 })
@@ -666,7 +680,7 @@ class RgpioClient extends GpioClient {
 
   async writePwm (gpio, dutyCycle) {
     await this.command(this.commands.PX, {
-      longs: [this.gpioChipHandle, gpio, 1024000, dutyCycle * 1000, 0, 0]
+      longs: [this.gpioChipHandle, gpio, dutyCycle === 0 ? 0 : 10000000, dutyCycle * 100, 0, 0]
     })
   }
 
@@ -715,9 +729,9 @@ class RgpioClient extends GpioClient {
       delete this.fileHandle
     }
     this.fileHandle = (await this.command(commands.FO, { longs: [1], string: filename })).status
-    if (this.fileHandle !== 1) {
-      this.emit('warning', new Error(`got file handle ${this.fileHandle}`))
-    }
+    // if (this.fileHandle !== 1) {
+    //   this.emit('warning', new Error(`got file handle ${this.fileHandle}`))
+    // }
     let s = ''
     let result
     do {
@@ -746,9 +760,9 @@ class RgpioClient extends GpioClient {
       delete this.fileHandle
     }
     this.fileHandle = (await this.command(commands.FO, { longs: [2], string: filename })).status
-    if (this.fileHandle !== 1) {
-      this.emit('warning', new Error(`got file handle ${this.fileHandle}`))
-    }
+    // if (this.fileHandle !== 1) {
+    //   this.emit('warning', new Error(`got file handle ${this.fileHandle}`))
+    // }
     await this.command(commands.FW, { longs: [this.fileHandle], string: text })
     await this.command(commands.FC, { longs: [this.fileHandle] })
     delete this.fileHandle

package/lib/GpioDhtClient.js

@@ -0,0 +1,91 @@
+// hb-rpi-tools/lib/GpioDhtClient.js
+// Copyright © 2019-2026 Erik Baauw.  All rights reserved.
+//
+// Homebridge RPi Tools.
+
+import { EventEmitter, once } from 'node:events'
+
+/** Class to read a DHTxx sensor connected to a GPIO pin.
+  *
+  * @extends EventEmitter
+  */
+class GpioDhtClient extends EventEmitter {
+  constructor (parent, pi, gpio) {
+    super()
+    this.debug = parent.debug.bind(parent)
+    this.vdebug = parent.vdebug.bind(parent)
+    this.pi = pi
+    this.gpio = gpio
+
+    this.pi.on('gpio' + this.gpio, (payload) => {
+      if (payload.value) {
+        const duration = payload.tick - (this._previousTick ?? 0)
+        this._previousTick = payload.tick
+        this.#update(duration)
+      }
+    })
+  }
+
+  async read () {
+    const timeout = setTimeout(() => {
+      this.emit('error', new Error(`gpio ${this.gpio}: timeout`))
+    }, this.pi._params.timeout * 1000)
+    this.pi.dhtRead(this.gpio)
+    const a = await once(this, 'dht')
+    clearTimeout(timeout)
+    return a[0]
+  }
+
+  #update (duration) {
+    this.vdebug('gpio %d: rise after %d µs', this.gpio, duration)
+    if (duration > 10000) {
+      this.receiving = true
+      this.bit = this.pi.port === 8888 ? -2 : 0
+      this.data = 0n
+    } else if (this.receiving) {
+      if (++this.bit >= 1) {
+        this.data <<= 1n
+        if (duration >= 60 && duration <= 100) {
+          // 0 bit
+          this.vdebug('gpio %d: bit %d: 0', this.gpio, this.bit)
+        } else if (duration > 100 && duration <= 160) {
+          this.data += 1n // 1 bit
+          this.vdebug('gpio %d: bit %d: 1', this.gpio, this.bit)
+        } else {
+          this.receiving = false // invalid
+          this.debug('gpio %d: invalid signal', this.gpio)
+        }
+        if (this.receiving && this.bit === 40) {
+          const buf = Buffer.alloc(8)
+          buf.writeBigUint64LE(this.data)
+          if (((buf[1] + buf[2] + buf[3] + buf[4]) & 0xFF) !== buf[0]) {
+            this.debug('gpio %d: bad checksum', this.gpio)
+            return
+          }
+          let ok = false
+          let sensor = 'DHTxx'
+          let temperature = buf.readInt16LE(1) / 10
+          let humidity = buf.readUint16LE(3) / 10
+          ok = temperature >= -40 && temperature <= 125 && humidity <= 100
+          if (!ok) {
+            sensor = 'DHT11'
+            temperature = buf[2]
+            humidity = buf[4]
+            ok = temperature <= 50 && humidity >= 20 && humidity <= 80
+          }
+          if (!ok) {
+            this.debug('gpio %d: invalid data', this.gpio)
+            return
+          }
+          this.debug(
+            'gpio %d: %s: temperature: %d, humidity: %d',
+            this.gpio, sensor, temperature, humidity
+          )
+          this.emit('dht', { temperature, humidity })
+        }
+      }
+    }
+  }
+}
+
+export { GpioDhtClient }

package/lib/GpioLedChain.js

@@ -31,10 +31,14 @@ class GpioLedChain extends EventEmitter {
     this._nLeds = params.nLeds ?? 8
 
     this._leds = []
+    this._bri = 0xFF
 
     this._initWordBuffer()
   }
 
+  get bri () { return this._bri }
+  set bri (value) { this._bri = value & 0xFF }
+
   /** Initialise GPIO pins and update all LEDs.
     * @param {boolean} [turnOff=false] - Turn LEDs off.
     */
@@ -177,7 +181,7 @@ class GpioLedChain extends EventEmitter {
     await once(this, 'stopped')
   }
 
-  async colorloop (bri = 0xFF) {
+  async colorloop () {
     let r = 0
     let g = 1
     let b = 255
@@ -196,14 +200,14 @@ class GpioLedChain extends EventEmitter {
       } else if (r === 0 && g > 0 && b === 255) {
         g--
       }
-      this.setAllLeds(bri, r, g, b)
+      this.setAllLeds(this._bri, r, g, b)
       await this.update()
     }
     this.emit('stopped')
   }
 
   // Inspired by: https://github.com/pimoroni/blinkt/blob/master/examples/larson.py
-  async cylon (bri = 0xFF) {
+  async cylon () {
     let eye = -2 // eye centre goes from -2 to nLeds + 1
     let up = true
 
@@ -219,25 +223,25 @@ class GpioLedChain extends EventEmitter {
     this._continue = true
     while (this._continue) {
       if (eye - 3 >= 0) {
-        this.setLed(eye - 3, bri, 0, 0, 0)
+        this.setLed(eye - 3, this._bri, 0, 0, 0)
       }
       if (eye - 2 >= 0) {
-        this.setLed(eye - 2, bri, 16, 0, 0)
+        this.setLed(eye - 2, this._bri, 16, 0, 0)
       }
       if (eye - 1 >= 0) {
-        this.setLed(eye - 1, bri, 64, 0, 0)
+        this.setLed(eye - 1, this._bri, 64, 0, 0)
       }
       if (eye >= 0 && eye < this._nLeds) {
-        this.setLed(eye, bri, 255, 0, 0)
+        this.setLed(eye, this._bri, 255, 0, 0)
       }
       if (eye + 1 < this._nLeds) {
-        this.setLed(eye + 1, bri, 64, 0, 0)
+        this.setLed(eye + 1, this._bri, 64, 0, 0)
       }
       if (eye + 2 < this._nLeds) {
-        this.setLed(eye + 2, bri, 16, 0, 0)
+        this.setLed(eye + 2, this._bri, 16, 0, 0)
       }
       if (eye + 3 < this._nLeds) {
-        this.setLed(eye + 3, bri, 0, 0, 0)
+        this.setLed(eye + 3, this._bri, 0, 0, 0)
       }
       await this.update()
       const delay = (eye <= 2)

package/lib/RpiInfo.js

@@ -21,9 +21,8 @@ const fansPwm = [
   * - Retrieve the state through spawning `vcgencmd`.
   *
   * For remote Rapsberry Pi computers:
-  * - Parse the contents of `/proc/cpuinfo` as returned through PigpioClient.
-  * - Parse the state as returned by the `getState` script, called through
-  * the PigpioClient.
+  * - Parse the contents of `/proc/cpuinfo`.
+  * - Parse the state as returned by the `getState` script.
   *
   * @extends EventEmitter
   * @see https://www.raspberrypi.org/documentation/hardware/raspberrypi/revision-codes/README.md

package/lib/RpiTool.js

@@ -21,7 +21,11 @@ const usage = {
   test: `${b('test')} [${b('-hns')}]`,
   led: `${b('led')} [${b('-h')}] [${b('on')}|${b('off')}]`,
   eventlog: `${b('eventlog')} [${b('-h')}] [${u('gpio')}...]`,
-  ledchain: `${b('ledchain')} [${b('-h')}] [${b('-B')}|${b('-P')}] [${b('-c')} ${u('gpio')} ${b('-d')} ${u('gpio')} ${b('-n')} ${u('nLeds')}] [${b('-b')} ${u('brightness')}] [${u('mode')}]`
+  gpio: `${b('gpio')} [${b('-h')}] ${u('gpio')} [${b('high')}|${b('low')}]`,
+  dht: `${b('dht')} [${b('-h')}] ${u('gpio')}`,
+  ledchain: `${b('ledchain')} [${b('-h')}] [${b('-B')}|${b('-P')}] [${b('-c')} ${u('gpio')} ${b('-d')} ${u('gpio')} ${b('-n')} ${u('nLeds')}] [${b('-b')} ${u('brightness')}] [${u('mode')}]`,
+  pwm: `${b('pwm')} [${b('-h')}] ${u('gpio')} [${u('dutyCycle')}]`,
+  servo: `${b('servo')} [${b('-h')}] ${u('gpio')} [${u('pulseWidth')}]`
 }
 
 const description = {
@@ -29,8 +33,12 @@ const description = {
   info: 'Get Raspberry Pi properties.',
   state: 'Get Raspberry Pi state.',
   test: 'Repeatedly get Raspberry Pi state.',
-  led: 'Get/set/clear power LED state.',
+  led: 'Read/write power LED state.',
   eventlog: 'Monitor GPIO state changes.',
+  gpio: 'Read/write GPIO state.',
+  pwm: 'Read/write PWM duty cycle.',
+  servo: 'Read/write servo pulse width.',
+  dht: 'Read DHTxx temperature/humidity sensor.',
   ledchain: 'Control Blinkt! or P9813 LED chain.'
 }
 
@@ -66,7 +74,7 @@ Parameters:
   ${b('-P')} ${u('password')}, ${b('--password=')}${u('password')}
   Authenticate to the ${b('rgpio')} daemon with ${u('password')}.
   Default is ${b('')} (empty).
-  The password can also be set tgrough the environment variable ${b('LG_PASS')}.
+  The password can also be set through the environment variable ${b('LG_PASS')}.
 
 Commands:
   ${usage.info}
@@ -84,6 +92,18 @@ Commands:
   ${usage.eventlog}
   ${description.eventlog}
 
+  ${usage.gpio}
+  ${description.gpio}
+
+  ${usage.pwm}
+  ${description.pwm}
+
+  ${usage.servo}
+  ${description.servo}
+
+  ${usage.dht}
+  ${description.dht}
+
   ${usage.ledchain}
   ${description.ledchain}
 
@@ -128,6 +148,8 @@ Parameters:
   ${b('-s')}, ${b('--sortKeys')}
   Sort object key/value pairs alphabetically on key.`,
   led: `${description.led}
+Note that this command only works on Raspberry Pi models
+that support controlling the power LED, as reported by ${b('rpi info')}.
 
 Usage: ${b('rpi')} ${usage.led}
 
@@ -139,7 +161,10 @@ Parameters:
   Turn power LED on.
 
   ${b('off')}
-  Turn power LED off.`,
+  Turn power LED off.
+  
+  When neither ${b('on')} nor ${b('off')} is specified,
+  the current state of the power LED is reported.`,
   eventlog: `${description.eventlog}
 
 Usage: ${b('rpi')} ${usage.eventlog}
@@ -150,7 +175,69 @@ Paramerers:
 
   ${u('gpio')}
   Log events for GPIO ${u('gpio')}.
-  Default: all user GPIOs on the Rapberry Pi model.`,
+  Default: all user GPIOs on the Rapberry Pi model.
+  Note that ${b('rgpio')} only report state changes to input GPIOs.`,
+  gpio: `${description.gpio}
+
+Usage: ${b('rpi')} ${usage.gpio}
+
+Paramerers:
+  ${b('-h')}, ${b('--help')}
+  Print this help and exit.
+
+  ${u('gpio')}
+  Read or control GPIO ${u('gpio')}.
+
+  ${b('high')}
+  Set GPIO high.
+
+  ${b('low')}
+  Set GPIO low.
+  
+  When neither ${b('high')} nor ${b('low')} is specified,
+  the current state of the GPIO is reported.`,
+  pwm: `${description.pwm}
+
+Usage: ${b('rpi')} ${usage.pwm}
+
+Paramerers:
+  ${b('-h')}, ${b('--help')}
+  Print this help and exit.
+
+  ${u('gpio')}
+  Read or control GPIO ${u('gpio')}.
+
+  ${u('dutyCycle')}
+  Set PWM duty cycle to ${u('dutyCycle')} (between 0% and 100%).
+
+  When no duty cycle is specified, the current duty clycle of the GPIO is reported.
+  Note that ${b('rgpio')} doesn't support reading the duty cycle.`,
+  servo: `${description.servo}
+
+Usage: ${b('rpi')} ${usage.servo}
+
+Paramerers:
+  ${b('-h')}, ${b('--help')}
+  Print this help and exit.
+
+  ${u('gpio')}
+  Read or control GPIO ${u('gpio')}.
+
+  ${u('pulseWidth')}
+  Set servo pulse width to ${u('pulseWidth')} (between 500 and 2500, or 0 for off).
+
+  When no pulse width is specified, the current pulse width of the GPIO is reported.
+  Note that ${b('rgpio')} doesn't support reading the pulse width.`,
+  dht: `${description.dht}
+
+Usage: ${b('rpi')} ${usage.dht}
+
+Paramerers:
+  ${b('-h')}, ${b('--help')}
+  Print this help and exit.
+
+  ${u('gpio')}
+  GPIO pin for DHTxx sensor.`,
   ledchain: `${description.ledchain}
 
 Usage: ${b('rpi')} ${usage.ledchain}
@@ -455,10 +542,143 @@ class RpiTool extends CommandLineTool {
         )
       })
     }
-    await this.pi.listen(mask === 0 ? gpioMask : mask)
+    this.pi.mask = mask === 0 ? gpioMask : mask
+    await this.pi.listen()
     await new Promise(() => {})
   }
 
+  async gpio (...args) {
+    const clargs = {}
+    const parser = new CommandLineParser(this.pkgJson)
+    parser
+      .help('h', 'help', this.help)
+      .parameter('gpio', (value) => {
+        clargs.gpio = OptionParser.toInt('gpio', value)
+      })
+      .remaining((value) => {
+        if (value.length > 1) {
+          throw new UsageError('too many parameters')
+        }
+        if (value.length === 1) {
+          if (value[0] !== 'high' && value[0] !== 'low') {
+            throw new UsageError(`${value[0]}: unknown state`)
+          }
+          clargs.value = value[0] === 'high' ? 1 : 0
+        }
+      })
+      .parse(...args)
+    const { gpioMask, model } = await this._getInfo()
+    const bit = 1 << clargs.gpio
+    if ((bit & gpioMask) === 0) {
+      throw new UsageError(`gpio: GPIO ${clargs.gpio}: not available on Raspberry Pi ${model}`)
+    }
+    if (clargs.value != null) {
+      await this.pi.write(clargs.gpio, clargs.value)
+    }
+    const value = await this.pi.read(clargs.gpio)
+    this.print(value ? 'high' : 'low')
+  }
+
+  async pwm (...args) {
+    const clargs = {}
+    const parser = new CommandLineParser(this.pkgJson)
+    parser
+      .help('h', 'help', this.help)
+      .parameter('gpio', (value) => {
+        clargs.gpio = OptionParser.toInt('gpio', value)
+      })
+      .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)
+        }
+      })
+      .parse(...args)
+    const { gpioMask, model } = await this._getInfo()
+    const bit = 1 << clargs.gpio
+    if ((bit & gpioMask) === 0) {
+      throw new UsageError(`gpio: GPIO ${clargs.gpio}: not available on Raspberry Pi ${model}`)
+    }
+    if (clargs.value != null) {
+      await this.pi.writePwm(clargs.gpio, clargs.value)
+    }
+    if (this.pi.port === 8888) {
+      const value = Math.round((await this.pi.command(
+        this.pi.commands.GDC, clargs.gpio
+      )).status / 2.55)
+      this.print(value)
+    } else if (clargs.value == null) {
+      this.warn('reading of duty cycle not supported by rgpio')
+    } else {
+      this.print(clargs.value)
+    }
+  }
+
+  async servo (...args) {
+    const clargs = {}
+    const parser = new CommandLineParser(this.pkgJson)
+    parser
+      .help('h', 'help', this.help)
+      .parameter('gpio', (value) => {
+        clargs.gpio = OptionParser.toInt('gpio', value)
+      })
+      .remaining((value) => {
+        if (value.length > 1) {
+          throw new UsageError('too many parameters')
+        }
+        if (value.length === 1) {
+          clargs.value = OptionParser.toInt('pulseWidth', value[0], 0)
+          if (clargs.value !== 0) {
+            clargs.value = OptionParser.toInt('pulseWidth', value[0], 500, 2500)
+          }
+        }
+      })
+      .parse(...args)
+    const { gpioMask, model } = await this._getInfo()
+    const bit = 1 << clargs.gpio
+    if ((bit & gpioMask) === 0) {
+      throw new UsageError(`gpio: GPIO ${clargs.gpio}: not available on Raspberry Pi ${model}`)
+    }
+    if (clargs.value != null) {
+      await this.pi.writeServo(clargs.gpio, clargs.value)
+    }
+    if (this.pi.port === 8888) {
+      const value = (await this.pi.command(this.pi.commands.GPW, clargs.gpio)).status
+      this.print(value)
+    } else if (clargs.value == null) {
+      this.warn('reading of pulse width not supported by rgpio')
+    } else {
+      this.print(clargs.value)
+    }
+  }
+
+  async dht (...args) {
+    const clargs = {}
+    const parser = new CommandLineParser(this.pkgJson)
+    parser
+      .help('h', 'help', this.help)
+      .parameter('gpio', (value) => {
+        clargs.gpio = OptionParser.toInt('gpio', value)
+      })
+      .parse(...args)
+    const { gpioMask, model } = await this._getInfo()
+    const bit = 1 << clargs.gpio
+    if ((bit & gpioMask) === 0) {
+      throw new UsageError(`gpio: GPIO ${clargs.gpio}: not available on Raspberry Pi ${model}`)
+    }
+    this.pi
+      .on('listen', (mask) => { this.debug('listening for %s', this.pi.vmap(mask)) })
+    const { GpioDhtClient } = await import('../lib/GpioDhtClient.js')
+    const dht = new GpioDhtClient(this, this.pi, clargs.gpio)
+    this.pi.mask = 1 << clargs.gpio
+    await this.pi.listen()
+    const { temperature, humidity } = await dht.read()
+    this.print('temperature: %dº', temperature)
+    this.print('humidity: %d%%', humidity)
+  }
+
   async ledchain (...args) {
     const clargs = {
       mode: 'cylon',

package/package.json

@@ -2,7 +2,7 @@
   "name": "hb-rpi-tools",
   "description": "Homebridge RPi Tools",
   "license": "Apache-2.0",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "keywords": [
     "raspberrypi",
     "raspberry",