rpi-io 2.0.10 → 2.1.0

package/README.md

@@ -1,6 +1,7 @@
 # rpi-io
-![Static Badge](https://img.shields.io/badge/rpi--io-_2.0.x_-FF5500?style=flat) ![Static Badge](https://img.shields.io/badge/Nodejs-%3E_23-66cc33?logo=nodedotjs&logoColor=white) ![Static Badge](https://img.shields.io/badge/NPM-%3E_10-CC3534?logo=npm&logoColor=white) ![Static Badge](https://img.shields.io/badge/Raspberry_Pi-Zero2_4B_5B-C51A4A?logo=raspberrypi&logoColor=white) ![Static Badge](https://img.shields.io/badge/OS-Bookworm_Trixie-0D7AB9?style=flat)
+![Static Badge](https://img.shields.io/badge/rpi--io-_2.1.x_-FF5500?style=flat) ![Static Badge](https://img.shields.io/badge/Nodejs-%3E_23-66cc33?logo=nodedotjs&logoColor=white) ![Static Badge](https://img.shields.io/badge/NPM-%3E_10-CC3534?logo=npm&logoColor=white) ![Static Badge](https://img.shields.io/badge/Raspberry_Pi-Zero2_4B_5B-C51A4A?logo=raspberrypi&logoColor=white) ![Static Badge](https://img.shields.io/badge/OS-Bookworm_Trixie-0D7AB9?style=flat)
 
+Current version is 2.1.0. See latest updates in *history.md*.
 
 **rpi-io** is a lite [ESM](https://nodejs.org/api/esm.html#modules-ecmascript-modules) module for **Node.js** to control **Raspberry Pi** GPIO: access (in, out), input event detection and [PWM](https://en.wikipedia.org/wiki/Pulse-width_modulation) peripheral control.
 
@@ -14,7 +15,7 @@
     - Input/Output - [libgpiod](https://libgpiod.readthedocs.io/en/stable/) v1.6.3 (*Bookworm*) and v2.2.1 (*Trixie*)
     - PWM - [sysfs](https://en.wikipedia.org/wiki/Sysfs) interface.
 
-  
+
 ## Prerequisites
 
 ### libgpiod
@@ -40,9 +41,9 @@ sudo apt-get install -y build-essential python3
 
 ### Node.js
 
-Please make sure that you a recent version of Node.js (v23+) and NPM (v10+).
-
+Please make sure that you a recent version of Node.js.  Recommended tested versions are v23 and further as they support `require(esm)` by default.
 
+Older versions starting at v20.19 where `require(esm)` has been backported should work as well, but they haven't been tested extensively.
 
 ## Installation
 
@@ -244,7 +245,7 @@ const btn = new RIO(18, "input", {bias: "pull-up"})
 
 #### Servo motor
 
-REMINDER: PWM peripherals used in hardware mode need some specific [configuration](## Configuration for PWM-based peripherals).
+REMINDER: PWM peripherals used in hardware mode need some specific [configuration](# Configuration for PWM-based peripherals).
 
 ##### Diagram for servo-motor *SG90*
 ```
@@ -304,7 +305,7 @@ import {RIO, sleep, ctrlC, } from "rpi-io"
 })()
 ```
 
-##### Fade-in LED
+#### Fade-in LED
 
 PWM can also be used for progressive LED light with the same electronic circuit as write operations. See example below.
 
@@ -382,20 +383,23 @@ const myOutput = new RIO(17, "output")
 
 ```javascript
 {
-  // output - Initial value
+  // For 'output' mode: Initial value {0,1}.
   value: 0,
-  // input - Circuit bias: "disable", "pull-up", "pull-down"
+    
+  // For 'input' mode: Circuit bias {"disable", "pull-up", "pull-down"}.
   bias: "disable",
-  // pwm - Delay time (ms) required on instance creation
-  //			 depending on device performance. If this value is
-  //       too small, the PWM instance creation fails.
-  //			 Can be reduced for latest RPi 5
-  //			 Must be increased for old RPi Zero.
-  exportTime: 100,
-  // pwm - period defined in μs. Default value is equivalent
-  //			 to a 50 Hz frequency.
+    
+  // For 'pwm' mode: Delay (ms) required on instance creation
+  // to prevent failure due to device performance.
+  //
+  // Since v2.1.0 the default value is set to -1, which means auto delay.
+  // It is computed according to device model e.g. 50 ms for 5Pi or 1000 ms RPi Zero.
+  exportTime: -1,
+    
+  // For 'pwm' mode: Period defined in μs. Default value is equivalent to 50 Hz.
   period: 20000,
-  // pwm - dutyMin and dutyMax defines the duty cycle use range in µs
+    
+  //  For 'pwm' mode: dutyMin and dutyMax defines the duty cycle use range in µs
   // 		   especially for servo-motors (See their specs!).
   dutyMin: 0,
   dutyMax: 20000
@@ -530,7 +534,7 @@ servo.pwmDuty(50)
 
 
 
-### Utilities
+### Static functions
 
 ####  RIO.closeAll()
 Function to close all instances
@@ -545,6 +549,20 @@ RIO.closeAll()
 
 
 
+#### RIO.model()
+
+Function to return current model of RPi.
+
+```javascript
+import {RIO} from "rpi-io"
+console.log("model:", RIO.model())
+// Returns '5B', '4B', '3B', 'Zero2', 'Zero' or '' when unknown.
+```
+
+
+
+### Utilities
+
 ####  log(args)
 
 Function similar to `console.log` but with timestamped prompt. Must be enabled or not by function `traceCfg` defined thereafter.

package/esm/main.mjs

@@ -2,9 +2,9 @@
 // RPI-IO: Nodejs GPIO control module
 // -------------------------------------------------------------------
 import {createRequire} from "node:module"
-import {writeFileSync} from "node:fs"
+import {writeFileSync, readFileSync} from "node:fs"
 import {traceCfg, log, warn} from "./log.mjs"
-import {sleep, ctrlC,lineNumber} from "./ctl.mjs"
+import {sleep, ctrlC, lineNumber} from "./ctl.mjs"
 import {wait, lineConfig} from "./nut.mjs"
 
 export {traceCfg, log, warn, sleep, ctrlC, lineConfig, lineNumber}
@@ -45,7 +45,7 @@ export class RIO {
             // input, output
             bias: "disable", // "disable", "pull-up", "pull-down"
             // pwm
-            exportTime: 100,
+            exportTime: -1,
             period: 20000, // μs ~50Hz
             dutyMin: 0, // μs
             dutyMax: 20000 // µs
@@ -69,6 +69,26 @@ export class RIO {
         this.config = lineConfig(this.line) // Required for pwm
         this.pwmExported = false
         this.pwmEnabled = false
+        // Define exportTime when defined to automatic by default
+        if (opt.exportTime === -1) {
+            switch (RIO.model()) {
+                case "5B":
+                    opt.exportTime = 50
+                    break
+                case "4B":
+                    opt.exportTime = 200
+                    break
+                case "3B":
+                    opt.exportTime = 500
+                    break
+                case "Zero2":
+                    opt.exportTime = 1000
+                    break
+                case "Zero":
+                    opt.exportTime = 1500
+                    break
+            }
+        }
 
         switch (this.mode) {
             case "output":
@@ -293,8 +313,10 @@ export class RIO {
         writeFileSync(this.pwmPathChannel + "duty_cycle", (this.dutyMin + ((percent / 100) * (this.dutyMax - this.dutyMin))).toString())
     }
 
+    // -------------------------------------------------------------------
+    // STATIC FUNCTIONS
     /** ------------------------------------------------------------------
-     * @method RIO.closeAll
+     * @function RIO.closeAll
      * @description Static method to close all instances
      */
     static closeAll() {
@@ -302,6 +324,27 @@ export class RIO {
             instance.close()
         }
     }
+
+
+    /** ------------------------------------------------------------------
+     * @function RIO.model
+     * @description Return Raspberry Pi model or empty string if not RPi
+     * @return {String}
+     */
+    static model() {
+        try {
+            const model = readFileSync("/proc/device-tree/model", "utf8")
+            if (!model.includes("Raspberry Pi")) return ""
+            if (model.includes("5 Model B")) return "5B"
+            if (model.includes("4 Model B")) return "4B"
+            if (model.includes("3 Model B")) return "3B"
+            if (model.includes("Zero 2")) return "Zero2"
+            if (model.includes("Zero")) return "Zero"
+            return ""
+        } catch (e) {
+            return ""
+        }
+    }
 }
 
 // -------------------------------------------------------------------

package/history.md

@@ -1,6 +1,16 @@
-2.0.10 - Feb 11, 2026
+2.1.0 - March 26, 2026
 ===================
-* `README.md`: In code examples, imported class is *RIO*, not *Rio*.
+
+* New default option in *constructor* method: `exporTime: -1` for automatic configuration of `exportTime` depending on device performance.
+* New static method *Rio.model()* to return current RPi model.
+
+2.0.11 - Feb 13, 2026
+===================
+
+* Minor updates in `README.md`: 
+  * Fixes in code examples, where imported class is *RIO*, not *Rio*.
+  * Details about Node.js pre-requisites.
+
 
 2.0.9 - Feb 03, 2026
 ===================

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rpi-io",
-  "version": "2.0.10",
+  "version": "2.1.0",
   "description": "Nodejs module to control Raspberry Pi GPIO",
   "keywords": [
     "raspberry",

package/test/model.js

@@ -0,0 +1,10 @@
+// -------------------------------------------------------------------
+// TEST - Simple write
+// -------------------------------------------------------------------
+import {RIO} from "../esm/main.mjs"
+
+console.log("model:", RIO.model())
+
+// -------------------------------------------------------------------
+// EoF
+// -------------------------------------------------------------------

package/test/pwm-led.js

@@ -10,7 +10,7 @@ import {RIO, traceCfg, log, sleep, ctrlC, lineNumber} from "../esm/main.mjs"
 
     // Init pwm line and set duty = 0%
     const led = new RIO(line, "pwm", {
-        exportTime: 50,// delay for export on init
+        exportTime: -1,// delay for export on init
         period: 1000,  // 1,000,000 ns ~ 1 KHz
         dutyMin: 0,
         dutyMax: 1000

package/test/pwm-motor.js

@@ -11,7 +11,7 @@ import {RIO, traceCfg, log, sleep, ctrlC, lineNumber} from "../esm/main.mjs"
 
     // Init pwm line and set duty = 0%
     const servo = new RIO(line, "pwm", {
-        exportTime: 100,// delay for export on init
+        exportTime: -1, // delay for export on init
         period: 20000,  // 20,000,000 ns ~ 50 Hz
         dutyMin: 500,   //    500,000 ns ~ 0.5 ms
         dutyMax: 2500   //  2,500,000 ns ~ 2.5 ms