rpi-io 2.1.0 → 2.1.2

package/CHANGELOG.md

@@ -0,0 +1,53 @@
+# Changelog
+## [2.1.2] - 2026-06-04
+### Changed
+- License MIT replaced by EUPL
+
+## [2.1.1] - 2026-03-26
+### Changed
+- Updated doc organization and content
+
+## [2.1.0] - 2026-03-26
+### Added
+- Default option in *constructor* method: `exporTime: -1` for automatic configuration of `exportTime` depending on device performance.
+- Static method *Rio.model()* to return current RPi model.
+
+## [2.0.11] - 2026-02-13
+### Changed
+- Minor updates in `README.md`: 
+  * Typos in code examples, where imported class is *RIO*, not *Rio*.
+  * Details about Node.js pre-requisites.
+
+## [2.0.9] - 2026-02-03
+### Changed
+- `package.json`: node-gyp version update to fix *tar* vulnerabilities
+- `README.md`: Explanations for *tar* warnings.
+
+## [2.0.5] - 2025-12-01
+### Changed
+- Typos
+- Internal refactoring
+
+## [2.0.0] - 2025-11-26
+### Added
+* Hybrid architecture Javascript + C addon to improve performances
+* New API
+
+## [1.2.2] - 2025-11-10
+### Changed
+* Utility API function name:  `Rio.log` renamed to `Rio.logCfg`.
+
+## [1.2.2] - 2025-11-07
+### Added
+* Option parameter for method `monitor` to take care of bias and bounces.
+### Fixed
+* Minor bugs and optimization
+
+## [1.1.0] - 2025-10-31
+### Added
+* Support libgpiod 2.2.1
+* Tested with *Trixie*
+
+## [1.0.0] - 2025-10-23
+### Added
+Initial release: *Bookworm*, libgpiod 1.63

package/README.md

@@ -1,7 +1,7 @@
 # rpi-io
 ![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*.
+Current version is 2.1.1. More details in [CHANGELOG.md](CHANGELOG.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.
 
@@ -334,310 +334,12 @@ import {RIO, sleep, ctrlC, } from "rpi-io"
 })()
 ```
 
-### More examples
-
-To get familiar with the module, you might have a glance on examples and play with them with the GPIO lines of your own electronic circuit.
-
-```bash
-# Simple write
-node /your-project/node_modules/rpi-io/test/write.js
-
-# Read and monitor
-node /your-project/node_modules/rpi-io/test/read.js
-
-# LED fade-in on PWM line
-node /your-project/node_modules/rpi-io/test/pwm-led.js
-
-# Servo-motor SG90 controlled by PWM
-node /your-project/node_modules/rpi-io/test/pwm-motor.js
-
-# Test duplicated instance error
-node /your-project/node_modules/rpi-io/test/duplicate-error.js
-
-# Test close of all instances
-node /your-project/node_modules/rpi-io/test/close-all.js
-
-# Test GPIO line configuration
-node /your-project/node_modules/rpi-io/test/line-configuration.js
-```
-
-
-
-## API
-
-The **rpi-io** API is based on the class `RIO` with instance methods.
-
-### RIO class and methods
-
-####  constructor RIO(line, mode, opt)
-To create instance according to parameters.
-##### Example
-```javascript
-import {RIO} from "rpi-io"
-const myOutput = new RIO(17, "output")
-```
-##### Parameter(s)
-- **line** *{Number}*  Must be one of the GPIO number as defined in [pinout.xyz](https://pinout.xyz). 
-- **mode** *{String}* Must be one of the following values: "output", "input", "pwm".
-- **opt** *{Object}* Various options depending on selected mode. See details and default values below.
-
-```javascript
-{
-  // For 'output' mode: Initial value {0,1}.
-  value: 0,
-    
-  // For 'input' mode: Circuit bias {"disable", "pull-up", "pull-down"}.
-  bias: "disable",
-    
-  // 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,
-    
-  //  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
-}
-```
-
-##### Return
-
-*{Object}*  RIO instance
-
-
-
-#### close()
-To close instance i.e.
-
-- to prevent future use of the line with the current instance
-- to stop related monitoring process if any
-- to free PWM resources if any
-
-To reuse a line when closed, a new instance must be created.
-
-##### Example
-
-```javascript
-import {RIO} from "rpi-io"
-const myOutput = new RIO(17, "output")
-myOutput.close()
-```
-
-
-
-#### write(value)
-
-To write some value to "output" instance.
-
-##### Example
-
-```javascript
-import {RIO} from "rpi-io"
-const myOutput = new RIO(17, "output")
-myOuput.write(1)
-```
-
-##### Parameter(s)
-
-- **value** *{Number}*  0 or 1
-
-
-
-#### read()
-
-To read value from "input" instance.
-
-##### Example
-
-```javascript
-import {RIO} from "rpi-io"
-const myInput = new RIO(18, "input")
-const result = myInput.read()
-```
-
-##### Return
-
-*{Number}*  0 or 1
-
-
-
-#### monitoringStart(callback, edge, bounce)
-
-To start event monitoring of "input" instance.
-
-##### Example
-
-```javascript
-import {RIO} from "rpi-io"
-const myButton = new RIO(18, "input")
-const callback = edge => {
-    console.log("edge:", edge)
-}
-myButton.monitoringStart(callback, "both", 30)
-```
-
-##### Parameter(s)
-
-- **callback** *{Function}*  Function triggered by input events where parameter is *edge* that can be either "rising" (input change from 0 to 1) or "falling" (input change from 1 to 0).
-- **edge** *{String}* Filter of monitored events: "rising", "falling", "both" (default value).
-- **bounce** *{Number}* Set threshold in ms to filter consecutive events of same type. Default value is 0.
-
-
-
-#### monitoringStop()
-
-To stop event monitoring of "input" instance.
-
-##### Example
-
-```javascript
-import {RIO} from "rpi-io"
-const myButton = new RIO(18, "input")
-const callback = 
-myButton.monitoringStart(edge => {console.log("edge:", edge)})
-// Stop monitoring after 10s
-setTimeout(() => {
-  myButton.monitoringStop()
-}, 10000)
-```
-
-
-
-#### pwmDuty(percent)
-
-To change the *duty cycle* of a "pwm" instance. The parameter is defined as a percentage to compute a *duty cycle* based on the *dutyMin* and *dutyMax* values of instance definition.
-
-##### Example
-
-```javascript
-import {RIO} from "rpi-io"
-// Servo-motor instance
-const servo = new RIO(13, "pwm", {
-        exportTime: 100,
-        period: 20000,
-        dutyMin: 500,
-        dutyMax: 2500})
-
-// duty cycle = 50% between dutyMin and dutyMax
-servo.pwmDuty(50)
-```
-
-##### Parameter(s)
-
-- **percent** *{Number}*   0 ≤ percent ≤ 100
-
-
-
-### Static functions
-
-####  RIO.closeAll()
-Function to close all instances
-##### Example
-```javascript
-import {RIO} from "rpi-io"
-const led = new RIO(17, "output", {value: 0})
-const btn = new RIO(18, "input")
-RIO.closeAll()
-// led and btn are closed 
-```
-
-
-
-#### 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.
-
-####  warn(args)
-
-Function similar to `log` but colored and prefixed by sign ⚠️.
-
-####  traceCfg(level)
-
-Function to enable functions `log` and `warn`. 
-
-##### Example for log, warn and traceCfg
-
-```javascript
-import {traceCfg, log, warn} from "rpi-io"
-// traceCfg(0) => warn and log are disabled
-// traceCfg(1) => warn is enabled and log is disabled
-// traceCfg(2) => warn and log are enabled
-traceCfg(2)
-warn("This is important info") 
-log("This is useful info")
-```
-
-
-
-####  sleep(time)
-
-Similar to `setTimeout` but in async mode.
-
-####  ctrlC(function)
-
-To run a callback function on ctrl+c event.
-
-##### Example for sleep and ctrlC
-
-```javascript
-import {sleep, ctrlC} from "rpi-io"
-(async () => {
-    ctrlC(() => {
-        console.log("displayed on script interrupt")
-    })
-    await sleep(10000)
-    console.log("displayed after 10s")
-})()
-```
-
-
-
-
-## Benchmark
-
-The following tables summarize main operation times on various devices. Results are in micro-seconds (µs).
-
-**PLEASE NOTE**: As PWM operations rely on files, performance of microSD cards installed on RPi may have a significant impact on results for `pwmDuty()`.
-
-**OS Bookworm with libgpiod v1.6.3**
-
-|                 | RPi 5B  | RPi 4B  | RPi Zero2 |
-| --------------- | ------- | ------- | --------- |
-| write           | 0.72 µs | 1.30 µs | 2,37 µs   |
-| read            | 1.32 µs | 1,09 µs | 1,90 µs   |
-| pwmDuty (1 KHz) | 15.6 µs | 25,6 µs | 48,4 µs   |
-
-**OS Trixie with libgpiod v2.2.1**
-
-|                 | RPi 5B       | RPi 4B  | RPi Zero2    |
-| --------------- | ------------ | ------- | ------------ |
-| write           | *not tested* | 1.20 µs | *not tested* |
-| read            | *not tested* | 1.37 µs | *not tested* |
-| pwmDuty (1 KHz) | *not tested* | 24,9 µs | *not tested* |
-
-
+## More documentation
+- [Examples](documentation/examples.md)
+- [API reference guide](documentation/api.md)
+- [Benchmark](documentation/benchmark.md)
 
 ## Licence
 
-MIT
+[EUPL](https://interoperable-europe.ec.europa.eu/collection/eupl)
 

package/documentation/api.md

@@ -0,0 +1,244 @@
+# rpi-io API reference
+The **rpi-io** API is based on the class `RIO` with instance methods and a few static functions and utilities
+
+## RIO class and methods
+
+### constructor RIO(line, mode, opt)
+
+To create instance according to parameters.
+#### Example
+```javascript
+import {RIO} from "rpi-io"
+const myOutput = new RIO(17, "output")
+```
+#### Parameter(s)
+- **line** *{Number}*  Must be one of the GPIO number as defined in [pinout.xyz](https://pinout.xyz). 
+- **mode** *{String}* Must be one of the following values: "output", "input", "pwm".
+- **opt** *{Object}* Various options depending on selected mode. See details and default values below.
+
+```javascript
+{
+  // For 'output' mode: Initial value {0,1}.
+  value: 0,
+    
+  // For 'input' mode: Circuit bias {"disable", "pull-up", "pull-down"}.
+  bias: "disable",
+    
+  // 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,
+    
+  //  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
+}
+```
+
+#### Return
+
+*{Object}*  RIO instance
+
+
+
+### close()
+To close instance i.e.
+
+- to prevent future use of the line with the current instance
+- to stop related monitoring process if any
+- to free PWM resources if any
+
+To reuse a line when closed, a new instance must be created.
+
+#### Example
+
+```javascript
+import {RIO} from "rpi-io"
+const myOutput = new RIO(17, "output")
+myOutput.close()
+```
+
+
+
+### write(value)
+
+To write some value to "output" instance.
+
+#### Example
+
+```javascript
+import {RIO} from "rpi-io"
+const myOutput = new RIO(17, "output")
+myOuput.write(1)
+```
+
+#### Parameter(s)
+
+- **value** *{Number}*  0 or 1
+
+
+
+### read()
+
+To read value from "input" instance.
+
+#### Example
+
+```javascript
+import {RIO} from "rpi-io"
+const myInput = new RIO(18, "input")
+const result = myInput.read()
+```
+
+#### Return
+
+*{Number}*  0 or 1
+
+
+
+### monitoringStart(callback, edge, bounce)
+
+To start event monitoring of "input" instance.
+
+#### Example
+
+```javascript
+import {RIO} from "rpi-io"
+const myButton = new RIO(18, "input")
+const callback = edge => {
+    console.log("edge:", edge)
+}
+myButton.monitoringStart(callback, "both", 30)
+```
+
+#### Parameter(s)
+
+- **callback** *{Function}*  Function triggered by input events where parameter is *edge* that can be either "rising" (input change from 0 to 1) or "falling" (input change from 1 to 0).
+- **edge** *{String}* Filter of monitored events: "rising", "falling", "both" (default value).
+- **bounce** *{Number}* Set threshold in ms to filter consecutive events of same type. Default value is 0.
+
+
+
+### monitoringStop()
+
+To stop event monitoring of "input" instance.
+
+#### Example
+
+```javascript
+import {RIO} from "rpi-io"
+const myButton = new RIO(18, "input")
+const callback = 
+myButton.monitoringStart(edge => {console.log("edge:", edge)})
+// Stop monitoring after 10s
+setTimeout(() => {
+  myButton.monitoringStop()
+}, 10000)
+```
+
+
+
+### pwmDuty(percent)
+
+To change the *duty cycle* of a "pwm" instance. The parameter is defined as a percentage to compute a *duty cycle* based on the *dutyMin* and *dutyMax* values of instance definition.
+
+#### Example
+
+```javascript
+import {RIO} from "rpi-io"
+// Servo-motor instance
+const servo = new RIO(13, "pwm", {
+        exportTime: 100,
+        period: 20000,
+        dutyMin: 500,
+        dutyMax: 2500})
+
+// duty cycle = 50% between dutyMin and dutyMax
+servo.pwmDuty(50)
+```
+
+#### Parameter(s)
+
+- **percent** *{Number}*   0 ≤ percent ≤ 100
+
+## Static functions
+
+###  RIO.closeAll()
+Function to close all instances
+#### Example
+```javascript
+import {RIO} from "rpi-io"
+const led = new RIO(17, "output", {value: 0})
+const btn = new RIO(18, "input")
+RIO.closeAll()
+// led and btn are closed 
+```
+
+
+
+### 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.
+
+###  warn(args)
+
+Function similar to `log` but colored and prefixed by sign ⚠️.
+
+###  traceCfg(level)
+
+Function to enable functions `log` and `warn`. 
+
+#### Example for log, warn and traceCfg
+
+```javascript
+import {traceCfg, log, warn} from "rpi-io"
+// traceCfg(0) => warn and log are disabled
+// traceCfg(1) => warn is enabled and log is disabled
+// traceCfg(2) => warn and log are enabled
+traceCfg(2)
+warn("This is important info") 
+log("This is useful info")
+```
+
+
+
+###  sleep(time)
+
+Similar to `setTimeout` but in async mode.
+
+###  ctrlC(function)
+
+To run a callback function on ctrl+c event.
+
+#### Example for sleep and ctrlC
+
+```javascript
+import {sleep, ctrlC} from "rpi-io"
+(async () => {
+    ctrlC(() => {
+        console.log("displayed on script interrupt")
+    })
+    await sleep(10000)
+    console.log("displayed after 10s")
+})()
+```
+
+# End of File

package/documentation/benchmark.md

@@ -0,0 +1,22 @@
+# Benchmark
+
+The following tables summarize main operation times on various devices. Results are in micro-seconds (µs).
+
+**PLEASE NOTE**: As PWM operations rely on files, performance of microSD cards installed on RPi may have a significant impact on results for `pwmDuty()`.
+
+**OS Bookworm with libgpiod v1.6.3**
+
+|                 | RPi 5B  | RPi 4B  | RPi Zero2 |
+| --------------- | ------- | ------- | --------- |
+| write           | 0.72 µs | 1.30 µs | 2,37 µs   |
+| read            | 1.32 µs | 1,09 µs | 1,90 µs   |
+| pwmDuty (1 KHz) | 15.6 µs | 25,6 µs | 48,4 µs   |
+
+**OS Trixie with libgpiod v2.2.1**
+
+|                 | RPi 5B       | RPi 4B  | RPi Zero2    |
+| --------------- | ------------ | ------- | ------------ |
+| write           | *not tested* | 1.20 µs | *not tested* |
+| read            | *not tested* | 1.37 µs | *not tested* |
+| pwmDuty (1 KHz) | *not tested* | 24,9 µs | *not tested* |
+

package/documentation/examples.md

@@ -0,0 +1,25 @@
+# Examples
+To get familiar with the **rpi-io**, you might have a glance on examples and play with them with the GPIO lines of your own electronic circuit.
+
+```bash
+# Simple write
+node /your-project/node_modules/rpi-io/test/write.js
+
+# Read and monitor
+node /your-project/node_modules/rpi-io/test/read.js
+
+# LED fade-in on PWM line
+node /your-project/node_modules/rpi-io/test/pwm-led.js
+
+# Servo-motor SG90 controlled by PWM
+node /your-project/node_modules/rpi-io/test/pwm-motor.js
+
+# Test duplicated instance error
+node /your-project/node_modules/rpi-io/test/duplicate-error.js
+
+# Test close of all instances
+node /your-project/node_modules/rpi-io/test/close-all.js
+
+# Test GPIO line configuration
+node /your-project/node_modules/rpi-io/test/line-configuration.js
+```

package/package.json

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

package/history.md

@@ -1,48 +0,0 @@
-2.1.0 - March 26, 2026
-===================
-
-* 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.json`: node-gyp version update to fix *tar* vulnerabilities
-* `README.md`: Explanations for *tar* warnings.
-
-2.0.5 - Dec 01, 2025
-  ===================
-* Typos
-* Internal refactoring
-
-2.0.0 - Nov 26, 2025
-===================
-* New hybrid architecture Javascript + C addon to improve performances
-* New API
-* Fixes
-
-1.2.2 - Nov 10, 2025
-===================
-* Change utility API function name from `Rio.log` to `Rio.logCfg`.
-* Minor fixes
-
-1.2.0 - Nov 07, 2025
-===================
-* New option parameter for method `monitor` to take care of bias and bounces.
-* Fixes and optimization
-
-1.1.0 - Oct 31, 2025
-===================
-* Added support libgpiod 2.2.1
-* Tested with *Trixie*
-
-1.0.0 - Oct 23, 2025
-===================
-Initial release: *Bookworm*, libgpiod 1.63