hb-rpi-tools 0.0.3 → 1.0.0

package/index.js

@@ -4,6 +4,7 @@
 // Homebridge RPi Tools.
 
 /** Homebridge RPi Tools.
+  * see the {@tutorial hb-rpi-tools} tutorial.
   *
   * @module hb-rpi-tools
   */

package/lib/{GpioDhtClient.js → DhtClient.js}

@@ -1,4 +1,4 @@
-// hb-rpi-tools/lib/GpioDhtClient.js
+// hb-rpi-tools/lib/DhtClient.js
 // Copyright © 2019-2026 Erik Baauw.  All rights reserved.
 //
 // Homebridge RPi Tools.
@@ -7,9 +7,10 @@ import { EventEmitter, once } from 'node:events'
 
 /** Class to read a DHTxx sensor connected to a GPIO pin.
   *
+  * @class
   * @extends EventEmitter
   */
-class GpioDhtClient extends EventEmitter {
+class DhtClient extends EventEmitter {
   constructor (parent, pi, gpio) {
     super()
     this.debug = parent.debug.bind(parent)
@@ -88,4 +89,4 @@ class GpioDhtClient extends EventEmitter {
   }
 }
 
-export { GpioDhtClient }
+export { DhtClient }

package/lib/GpioClient/{PigpioClient.js → Pigpio.js}

@@ -1,4 +1,4 @@
-// hb-rpi-tools/lib/GpioClient/PigpioClient.js
+// hb-rpi-tools/lib/GpioClient/Pigpio.js
 // Copyright © 2019-2026 Erik Baauw.  All rights reserved.
 //
 // Homebridge RPi Tools.
@@ -328,9 +328,11 @@ const extCommands = [
 
 /** Client to pigpio's (remote) socket interface.
   *
+  * @class
   * @extends GpioClient
+  * @memberOf GpioClient
   */
-class PigpioClient extends GpioClient {
+class Pigpio extends GpioClient {
   /** Create a new PigpioClient instance.
     *
     * @param {object} params - Parameters.
@@ -758,4 +760,4 @@ class PigpioClient extends GpioClient {
   }
 }
 
-GpioClient.Pigpio = PigpioClient
+GpioClient.Pigpio = Pigpio

package/lib/GpioClient/{RgpioClient.js → Rgpio.js}

@@ -1,4 +1,4 @@
-// hb-rpi-tools/lib/GpioClient/RgpioClient.js
+// hb-rpi-tools/lib/GpioClient/Rgpio.js
 // Copyright © 2019-2026 Erik Baauw.  All rights reserved.
 //
 // Homebridge RPi Tools.
@@ -286,20 +286,22 @@ const pudValues = Object.freeze({
 
 /** Client to rgpio's (remote) socket interface.
   *
+  * @class
   * @extends GpioClient
+  * @memberOf GpioClient
   */
-class RgpioClient extends GpioClient {
+class Rgpio extends GpioClient {
   /** Create a new RgpioClient instance.
     *
     * @param {object} params - Parameters.
     * @param {string} [params.host='localhost:8889'] - Hostname and port of
     * the rgpio server.<br>
     * Can also be specified through the environment variable LG_ADDR.
+    * @param {string} [params.user='homebridge-rpi'] - User name for rgpio server.<br>
+    * Can also be specified through the environment variable LG_USER.
     * @param {string} [params.password=''] - Password for rgpio server.<br>
     * Can also be specified through the environment variable LG_PASS.
     * @param {int} [timeout=15] - Timeout in seconds for socket operations.
-    * @param {string} [params.user='homebridge-rpi'] - User name for rgpio server.<br>
-    * Can also be specified through the environment variable LG_USER.
     */
   constructor (params = {}) {
     super()
@@ -769,4 +771,4 @@ class RgpioClient extends GpioClient {
   }
 }
 
-GpioClient.Rgpio = RgpioClient
+GpioClient.Rgpio = Rgpio

package/lib/GpioClient.js

@@ -8,6 +8,7 @@ import { createConnection } from 'node:net'
 
 /** Abstract superclass class for a client to a GPIO server.
   *
+  * @abstract
   * @extends EventEmitter
   * @hideconstructor
   */
@@ -94,9 +95,9 @@ class GpioClient extends EventEmitter {
   }
 
   /** Handle `data` events from the command socket.
-  * @param {Buffer} data - The data.
-  * @emits GpioClient#data
-  */
+    * @param {Buffer} data - The data.
+    * @emits GpioClient#data
+    */
   #onCmdData (data) {
     /** Emitted when data from the pigpio socket has been received.
       * @event GpioClient#data

package/lib/{GpioLedChain → LedChainClient}/Blinkt.js

@@ -1,18 +1,20 @@
-// hb-rpi-tools/lib/GpioLedChain/Blinkt.js
+// hb-rpi-tools/lib/LedChainClient/Blinkt.js
 // Copyright © 2019-2026 Erik Baauw.  All rights reserved.
 //
 // Homebridge RPi Tools.
 
-import { GpioLedChain } from '../GpioLedChain.js'
+import { LedChainClient } from '../LedChainClient.js'
 
 /** Class to control a Pimoroni Blinkt! (or similar devices, like the LED of
   * the Pimoroni FanShim).
   * @see https://shop.pimoroni.com/products/blinkt
   * @see https://shop.pimoroni.com/products/fan-shim
   *
-  * @extends GpioLedChain
+  * @class
+  * @extends LedChainClient
+  * @memberOf LedChainClient
   */
-class Blinkt extends GpioLedChain {
+class Blinkt extends LedChainClient {
   /** Encode LED state.
     * @param {int} [bri=0] - Brightness between 0 and 255.
     * @param {int} [r=0] - Red, between 0 and 255.
@@ -53,4 +55,4 @@ class Blinkt extends GpioLedChain {
   }
 }
 
-GpioLedChain.Blinkt = Blinkt
+LedChainClient.Blinkt = Blinkt

package/lib/{GpioLedChain → LedChainClient}/P9813.js

@@ -3,7 +3,7 @@
 //
 // Homebridge RPi Tools.
 
-import { GpioLedChain } from '../GpioLedChain.js'
+import { LedChainClient } from '../LedChainClient.js'
 
 function adjust (c, bri) {
   return (((c & 0xFF) * (bri & 0xFF)) / 0xFF) & 0xFF
@@ -11,9 +11,11 @@ function adjust (c, bri) {
 /** Class to control a chain of P9813-based LEDs, like the Grove Chainable LED.
   * @see https://github.com/Seeed-Studio/Grove_Chainable_RGB_LED
   *
-  * @extends GpioLedChain
+  * @class
+  * @extends LedChainClient
+  * @memberOf LedChainClient
   */
-class P9813 extends GpioLedChain {
+class P9813 extends LedChainClient {
   /** Encode LED state.
     * @param {int} [bri=0] - Brightness between 0 and 255.
     * @param {int} [r=0] - Red, between 0 and 255.
@@ -53,4 +55,4 @@ class P9813 extends GpioLedChain {
   }
 }
 
-GpioLedChain.P9813 = P9813
+LedChainClient.P9813 = P9813

package/lib/{GpioLedChain.js → LedChainClient.js}

@@ -1,4 +1,4 @@
-// hb-rpi-tools/lib/GpioLedChain.js
+// hb-rpi-tools/lib/LedChainClient.js
 // Copyright © 2019-2026 Erik Baauw.  All rights reserved.
 //
 // Homebridge RPi Tools.
@@ -9,9 +9,11 @@ import { timeout } from 'hb-lib-tools'
 
 /** Abstract superclass to control a chain of LEDs using data and clock signals.
   *
+  * @class
+  * @abstract
   * @extends EventEmitter
   */
-class GpioLedChain extends EventEmitter {
+class LedChainClient extends EventEmitter {
   /** Create a new socket to pigpiod for controlling the LED chain
     *
     * @param {GpioClient} pi - The Raspberry Pi with the LED chain.
@@ -261,4 +263,4 @@ class GpioLedChain extends EventEmitter {
   }
 }
 
-export { GpioLedChain }
+export { LedChainClient }

package/lib/RpiTool.js

@@ -23,7 +23,7 @@ const usage = {
   eventlog: `${b('eventlog')} [${b('-h')}] [${u('gpio')}...]`,
   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')}]`,
+  ledchain: `${b('ledchain')} [${b('-h')}] [${b('-B')}|${b('-F')}|${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')}]`
 }
@@ -250,10 +250,14 @@ Parameters:
   Control Pimoroni Blinkt! LED chain (default).
   Sets clock to GPIO 24, data to GPIO 23, and number of LEDs to 8.
   You can change these with the ${b('-c')}, ${b('-d')}, and ${b('-n')} options.
-  The Pimoroni FanShim uses GPIO 14 for clock, GPIO 15 for data, and has 1 LED.
+
+  ${b('-F')}, ${b('--fanshim')}
+  Control Pimoroni FanShim LED.
+  Sets clock to GPIO 14, data to GPIO 15, and number of LEDs to 1.
+  You can change these with the ${b('-c')}, ${b('-d')}, and ${b('-n')} options.
 
   ${b('-P')}, ${b('--p9813')}
-  Use P9813-based LED chain.
+  Control P9813-based LED chain.
   Sets clock to GPIO 10, data to GPIO 11, and number of LEDs to 2.
   You can change these with the ${b('-c')}, ${b('-d')}, and ${b('-n')} options.
 
@@ -295,12 +299,12 @@ class RpiTool extends CommandLineTool {
       this._clargs = this.parseArguments()
       let Client
       if (this._clargs.port === 8888) {
-        await import('../lib/GpioClient/PigpioClient.js')
+        await import('../lib/GpioClient/Pigpio.js')
         Client = GpioClient.Pigpio
         delete this._clargs.options.user
         delete this._clargs.options.password
       } else {
-        await import('../lib/GpioClient/RgpioClient.js')
+        await import('../lib/GpioClient/Rgpio.js')
         Client = GpioClient.Rgpio
       }
       this.pi = new Client(this._clargs.options)
@@ -670,8 +674,8 @@ class RpiTool extends CommandLineTool {
     }
     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)
+    const { DhtClient } = await import('../lib/DhtClient.js')
+    const dht = new DhtClient(this, this.pi, clargs.gpio)
     this.pi.mask = 1 << clargs.gpio
     await this.pi.listen()
     const { temperature, humidity } = await dht.read()
@@ -701,6 +705,14 @@ class RpiTool extends CommandLineTool {
           nLeds: 8
         }
       })
+      .flag('F', 'fanshim', () => {
+        clargs.type = 'Blinkt'
+        clargs.config = {
+          gpioClock: 14,
+          gpioData: 15,
+          nLeds: 1
+        }
+      })
       .flag('P', 'p9813', () => {
         clargs.type = 'P9813'
         clargs.config = {
@@ -742,9 +754,9 @@ class RpiTool extends CommandLineTool {
       )
     }
 
-    const { GpioLedChain } = await import('../lib/GpioLedChain.js')
-    await import(`../lib/GpioLedChain/${clargs.type}.js`)
-    this.ledChain = new GpioLedChain[clargs.type](this.pi, clargs.config)
+    const { LedChainClient } = await import('../lib/LedChainClient.js')
+    await import(`../lib/LedChainClient/${clargs.type}.js`)
+    this.ledChain = new LedChainClient[clargs.type](this.pi, clargs.config)
     this.ledChain
       .on('led', (id, led) => {
         this.vdebug('led %d: %j', id, led)

package/package.json

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