rpi-io 1.1.3 → 1.1.5

package/README.md

@@ -1,5 +1,5 @@
 # rpi-io
-![Static Badge](https://img.shields.io/badge/rpi--io-_1.1_-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-_1.1.4_-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)
 
 
 **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.
@@ -12,7 +12,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.
 
-## Installation
+## Installation 
 
 ````shell
 npm install rpi-io
@@ -24,7 +24,7 @@ By default rpi-io does not require specific configuration.
 
 If you want to use [hardware-based PWM](https://pinout.xyz/pinout/pwm) peripherals, some configuration is required:
 
-- Open the file  `/boot/firmware/config.txt` and add the required [dtoverlay](https://www.raspberrypi.com/documentation/computers/configuration.html#part3.1) configuration for PWM as showned in the examples below.
+- Open the file  `/boot/firmware/config.txt` and add the required [dtoverlay](https://www.raspberrypi.com/documentation/computers/configuration.html#part3.1) configuration for PWM as showed in the examples below.
 
 ```shell
 # Examples of PWM configuration to add to/boot/firmware/config.txt
@@ -273,7 +273,7 @@ console.log("servo position = 0°");
 
 ##### Parameters
 
-All time parameters are defined in nano-seconds (ns).
+All time parameters are defined in nanoseconds (ns).
 
 - **period** *{Number}* Time period in which [duty cycle](https://en.wikipedia.org/wiki/Pulse-width_modulation) varies.
 - **duty** *{Number}* Initial duty cycle.
@@ -331,6 +331,16 @@ servo.pwmDuty(1500000)
 
 
 ### Utility functions
+#### Rio.stopMonitoring()
+
+To stop monitoring subprocess when leaving your app script or in case of failure. This prevents having a runaway subprocess that could block a new call to the `monitor()` method.
+
+##### Example
+
+```javascript
+Rio.stopMonitoring()
+```
+
 #### Rio.config(gpio)
 
 To return configuration of some GPIO
@@ -379,7 +389,7 @@ console.log(Rio.version())
 
 #### Rio.os()
 
-To retrieve Rapsberry Pi OS info.
+To retrieve Raspberry Pi OS info.
 
 ##### Example
 
@@ -418,10 +428,10 @@ Rio.isSystemSupported() // See console below
 
 ## Benchmark
 
-The following table summarizes GPIO *set* average times with rpi-io v1.1.0 and various hardwares and OS.
+The following table summarizes GPIO *set* average times with rpi-io v1.1.0 and various hardware and OS.
 
 |          | RPi 5B  | RPi 4B     | RPi Zero2  |
-| -------- | ------- | ---------- | ---------- |
+|----------|---------|------------|------------|
 | Bookworm | 1.37 ms | 4.56 ms    | 9.07 ms    |
 | Trixie   | 3.82 ms | not tested | not tested |
 ---

package/package.json

@@ -1,13 +1,16 @@
 {
   "name": "rpi-io",
-  "version": "1.1.3",
-  "description": "Nodejs module to control Raspbbery Pi GPIO",
+  "version": "1.1.5",
+  "description": "Nodejs module to control Raspberry Pi GPIO",
   "keywords": [
     "raspberry",
     "gpio",
+    "libgpiod",
     "nodejs",
     "esm",
-    "pwm"
+    "pwm",
+    "bookworm",
+    "trixie"
   ],
   "homepage": "https://github.com/gdorbes/rpi-io#readme",
   "bugs": {