rpi-io 1.2.4 → 2.0.0

package/script/check-env.sh

@@ -0,0 +1,192 @@
+#!/bin/bash
+# -------------------------------------------------------------------
+# RPI-IO: Script to check environment for libgpiod
+# source: claude.ai/chat/f3139163-e976-47a4-8e46-01fee65686f2
+# Check: OS, Node.js, npm, node-gyp, gcc, make, Python, libgpiod
+#        gpio permissions, pthread
+# -------------------------------------------------------------------
+echo "=== Check environment for libgpiod ==="
+echo ""
+
+RED="\033[0;31m"
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+NC='\033[0m' # No Color
+
+check_ok() {
+    echo -e "${GREEN}✓${NC} $1"
+}
+
+check_fail() {
+    echo -e "${RED}✗${NC} $1"
+}
+
+check_warn() {
+    echo -e "${YELLOW}⚠${NC} $1"
+}
+
+# Check OS
+echo "1. Operating system"
+if [ -f /etc/os-release ]; then
+    . /etc/os-release
+    check_ok "OS: $PRETTY_NAME"
+else
+    check_warn "Impossible to detect OS"
+fi
+echo ""
+
+# Check Node.js
+echo "2. Node.js"
+if command -v node &> /dev/null; then
+    NODE_VERSION=$(node --version)
+    check_ok "Node.js installed: $NODE_VERSION"
+else
+    check_fail "Node.js is not installed"
+    echo "   Install it with: sudo apt-get install nodejs"
+fi
+echo ""
+
+# Check npm
+echo "3. npm"
+if command -v npm &> /dev/null; then
+    NPM_VERSION=$(npm --version)
+    check_ok "npm installed: v$NPM_VERSION"
+else
+    check_fail "npm is not installed"
+fi
+echo ""
+
+# Check node-gyp
+echo "4. node-gyp"
+if npm list -g node-gyp &> /dev/null; then
+    check_ok "node-gyp is installed globally"
+elif npm list node-gyp &> /dev/null; then
+    check_ok "node-gyp is installed locally"
+else
+    check_warn "node-gyp is not detected (it will be installed by npm install)"
+fi
+echo ""
+
+# Check gcc
+echo "5. Compile tools"
+if command -v gcc &> /dev/null; then
+    GCC_VERSION=$(gcc --version | head -n1)
+    check_ok "gcc is installed: $GCC_VERSION"
+else
+    check_fail "gcc is not installed"
+    echo "   Install it with: sudo apt-get install build-essential"
+fi
+
+if command -v make &> /dev/null; then
+    check_ok "make is installed"
+else
+    check_fail "make is not installed"
+fi
+echo ""
+
+# Check Python (required by node-gyp)
+echo "6. Python (required by node-gyp)"
+if command -v python3 &> /dev/null; then
+    PYTHON_VERSION=$(python3 --version)
+    check_ok "$PYTHON_VERSION"
+else
+    check_fail "Python 3 is not installed"
+fi
+echo ""
+
+# Check libgpiod
+echo "7. libgpiod"
+if command -v gpioinfo &> /dev/null; then
+    GPIOD_VERSION=$(gpioinfo --version 2>&1 | head -n1)
+    check_ok "libgpiod is installed: $GPIOD_VERSION"
+else
+    check_fail "libgpiod is not installed"
+    echo "   Install with: sudo apt-get install gpiod"
+fi
+
+if [ -f /usr/include/gpiod.h ]; then
+    check_ok "Headers libgpiod trouvés: /usr/include/gpiod.h"
+
+    # Détect header version
+    if grep -q "GPIOD_API_VERSION" /usr/include/gpiod.h; then
+        check_ok "libgpiod v2.x detected (GPIOD_API_VERSION found)"
+    else
+        check_ok "libgpiod v1.x detected"
+    fi
+else
+    check_fail "libgpiod headers not found"
+    echo "   Install it with: sudo apt-get install libgpiod-dev"
+fi
+
+if [ -f /usr/lib/aarch64-linux-gnu/libgpiod.so ] || [ -f /usr/lib/arm-linux-gnueabihf/libgpiod.so ] || [ -f /usr/lib/x86_64-linux-gnu/libgpiod.so ]; then
+    check_ok "libgpiod lib found"
+else
+    check_fail "libgpiod lib not found"
+fi
+echo ""
+
+# Check GPIO permissions
+echo "8. Permissions GPIO"
+if [ -e /dev/gpiochip0 ]; then
+    check_ok "/dev/gpiochip0 found"
+
+    if groups $USER | grep -q gpio; then
+        check_ok "User $USER is in the gpio group"
+    else
+        check_warn "User $USER is not in the gpio group"
+        echo "   Add him/her with: sudo usermod -a -G gpio $USER"
+        echo "   Then log back in."
+    fi
+
+    ls -l /dev/gpiochip0
+else
+    check_warn "/dev/gpiochip0 is not found (==> not a Raspberry Pi)"
+fi
+echo ""
+
+# Check pthread
+echo "9. pthread"
+if [ -f /usr/include/pthread.h ]; then
+    check_ok "pthread.h found"
+else
+    check_warn "pthread.h not found ⚠️"
+fi
+echo ""
+
+# Summary
+echo "=== Summary ==="
+echo ""
+
+MISSING=0
+
+if ! command -v node &> /dev/null; then
+    echo "➤ Install Node.js:"
+    echo "  sudo apt-get install nodejs npm"
+    MISSING=1
+fi
+
+if ! command -v gcc &> /dev/null; then
+    echo "➤ Install compilation tools:"
+    echo "  sudo apt-get install build-essential python3"
+    MISSING=1
+fi
+
+if ! [ -f /usr/include/gpiod.h ]; then
+    echo "➤ Install libgpiod and related headers:"
+    echo "  sudo apt-get install libgpiod-dev gpiod"
+    MISSING=1
+fi
+
+if [ $MISSING -eq 0 ]; then
+    echo -e "${GREEN}✓ All the prerequisites seem to be in place!${NC}"
+    echo ""
+    echo "Now you can compile with:"
+    echo "  npm install"
+else
+    echo -e "${YELLOW}⚠️ Some prerequisites are missing (see above)${NC}"
+fi
+
+echo ""
+echo "To force recompilation:"
+echo "  npm run clean"
+echo "  npm run build"

package/script/detect-gpiod-version.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+# -------------------------------------------------------------------
+# RPI-IO: To detect the libgpiod version
+# -------------------------------------------------------------------
+
+VERSION=$(pkg-config --modversion libgpiod 2>/dev/null)
+
+if [ -z "$VERSION" ]; then
+    echo "Error: Cannot detect libgpiod version" >&2
+    exit 1
+fi
+
+MAJOR=$(echo $VERSION | cut -d. -f1)
+
+echo "Detected libgpiod version: $VERSION (major: $MAJOR)" >&2
+
+if [ "$MAJOR" -ge 2 ]; then
+    echo "LIBGPIOD_V2"
+else
+    echo "LIBGPIOD_V1"
+fi

package/test/benchmark-pwm.js

@@ -0,0 +1,44 @@
+// -------------------------------------------------------------------
+// TEST - Benchmark pwm duty update x1,000,000
+// -------------------------------------------------------------------
+import {RIO, traceCfg, log, lineNumber, ctrlC} from "../esm/main.mjs"
+(async () => {
+    traceCfg(2)
+    const line = lineNumber(2)
+    if (line < 0) return
+
+    // Init pwm line and set duty = 0%
+    const led = new RIO(line, "pwm", {
+        period: 1000,  // 1,000,000 ns ~ 1 KHz
+        dutyMin: 0,
+        dutyMax: 1000
+    })
+
+    ctrlC(() => {
+        led.close()
+    })
+
+    // pwm update loop x1,000,000
+    let len = 1000000
+    log("Benchmark pwm update x1,000,000")
+    const start = new Date()
+    while (len--) {
+        led.pwmDuty(50)
+    }
+    const stop = new Date()
+    log("Elapse time:", stop - start, "ms")
+    led.close()
+})()
+
+
+
+
+
+
+
+
+
+
+// -------------------------------------------------------------------
+// EoF
+// -------------------------------------------------------------------

package/test/benchmark-read.js

@@ -0,0 +1,37 @@
+// -------------------------------------------------------------------
+// TEST - Benchmark read x1,000,000
+// -------------------------------------------------------------------
+import {RIO, traceCfg, log, lineNumber} from "../esm/main.mjs"
+(async () => {
+    traceCfg(2)
+    const line = lineNumber(2)
+    if (line < 0) return
+
+    // Init input line
+    const btn = new RIO(line, "input", {bias: "pull-down"})
+    log("button:", btn)
+
+    // read loop x1,000,000
+    let len = 1000000
+    log("Benchmark read x1,000,000")
+    const start = new Date()
+    while (len--) {
+        btn.read()
+    }
+    const stop = new Date()
+    btn.close();
+    log("Elapse time:", stop - start, "ms")
+})()
+
+
+
+
+
+
+
+
+
+
+// -------------------------------------------------------------------
+// EoF
+// -------------------------------------------------------------------

package/test/benchmark-write.js

@@ -0,0 +1,38 @@
+// -------------------------------------------------------------------
+// TEST - Benchmark write x1,000,000
+// -------------------------------------------------------------------
+import {RIO, traceCfg, log, lineNumber} from "../esm/main.mjs"
+(async () => {
+    traceCfg(2)
+    const line = lineNumber(2)
+    if (line < 0) return
+
+    // Init output line and ctrl+c to close it
+    const led = new RIO(line, "output", {value: 0})
+    log("led:", led)
+
+    // write loop x1,000,000
+    let len = 500000
+    log("Benchmark write x1,000,000")
+    const start = new Date()
+    while (len--) {
+        led.write(1)
+        led.write(0)
+    }
+    const stop = new Date()
+    led.close();
+    log("Elapse time:", stop - start, "ms")
+})()
+
+
+
+
+
+
+
+
+
+
+// -------------------------------------------------------------------
+// EoF
+// -------------------------------------------------------------------

package/test/close-all.js

@@ -0,0 +1,27 @@
+// -------------------------------------------------------------------
+// TEST - closeAll
+// -------------------------------------------------------------------
+import {RIO, traceCfg, log, sleep, ctrlC, lineNumber} from "../esm/main.mjs"
+
+(async () => {
+    traceCfg(2)
+
+    const line1 = lineNumber(2)
+    if (line1 < 0) return
+
+    const line2 = lineNumber(3)
+    if (line2 < 0) return
+
+    const led = new RIO(line1, "output", {value: 0})
+    const btn = new RIO(line2, "input")
+    log("led:", led)
+    log("btn:", btn)
+
+    await sleep(1000)
+    RIO.closeAll()
+})()
+
+
+// -------------------------------------------------------------------
+// EoF
+// -------------------------------------------------------------------

package/test/duplicate-error.js

@@ -0,0 +1,29 @@
+// -------------------------------------------------------------------
+// TEST - Duplicate instance
+// -------------------------------------------------------------------
+import {RIO, traceCfg, log, sleep, ctrlC, lineNumber} from "../esm/main.mjs"
+
+(async () => {
+    traceCfg(2)
+
+    const line = lineNumber(2)
+    if (line < 0) return
+
+
+    let led = new RIO(line, "output", {value: 0})
+    led.close()
+
+    // It works
+    led = new RIO(line, "output", {value: 0})
+    log("lead again:", led)
+
+    // It doesn't work!
+    log("now an error 🤓")
+    const ooops = new RIO(line, "output", {value: 0})
+
+})()
+
+
+// -------------------------------------------------------------------
+// EoF
+// -------------------------------------------------------------------

package/test/line-configuration.js

@@ -0,0 +1,16 @@
+// -------------------------------------------------------------------
+// TEST - Line configuration
+// -------------------------------------------------------------------
+import {traceCfg, log, lineNumber, lineConfig} from "../esm/main.mjs"
+
+(async () => {
+    traceCfg(2)
+    const line = lineNumber(2)
+    if (line < 0) return
+    log("line", line, "-->", lineConfig(line))
+})()
+
+
+// -------------------------------------------------------------------
+// EoF
+// -------------------------------------------------------------------

package/test/pwm-led.js

@@ -0,0 +1,36 @@
+// -------------------------------------------------------------------
+// TEST - PWM for led
+// -------------------------------------------------------------------
+import {RIO, traceCfg, log, sleep, ctrlC, lineNumber} from "../esm/main.mjs"
+
+(async () => {
+    traceCfg(2)
+    const line = lineNumber(2)
+    if (line < 0) return
+
+    // Init pwm line and set duty = 0%
+    const led = new RIO(line, "pwm", {
+        exportTime: 50,// delay for export on init
+        period: 1000,  // 1,000,000 ns ~ 1 KHz
+        dutyMin: 0,
+        dutyMax: 1000
+    })
+    log("led:", led)
+    ctrlC(() => {
+        led.close()
+    })
+
+    for (let i = 1; i < 101; i++) {
+        led.pwmDuty(i)
+        await sleep(30, false)
+    }
+    await sleep(2000)
+    led.pwmDuty(0)
+    led.close()
+    log("led closed")
+})()
+
+
+// -------------------------------------------------------------------
+// EoF
+// -------------------------------------------------------------------

package/test/pwm-motor.js

@@ -0,0 +1,40 @@
+// -------------------------------------------------------------------
+// TEST - PWM for servo-motor SG90
+// Info: https://wiki.openelab.io/motors/servo-motor-sg90
+// -------------------------------------------------------------------
+import {RIO, traceCfg, log, sleep, ctrlC, lineNumber} from "../esm/main.mjs"
+
+(async () => {
+    traceCfg(2)
+    const line = lineNumber(2)
+    if (line < 0) return
+
+    // Init pwm line and set duty = 0%
+    const servo = new RIO(line, "pwm", {
+        exportTime: 100,// 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
+    })
+    ctrlC(() => {
+        servo.close()
+    })
+    log("servo initialized --> duty = 0%")
+    await sleep(2000)
+    servo.pwmDuty(50)
+    log("servo duty = 50%")     // ~ 0.5 + (0.5 * (2.5 ms - 0.5 ms)) = 1.5 ms
+    await sleep(2000)
+    servo.pwmDuty(100)
+    log("servo duty = 100%")    // ~ 0.5 + (1.0 * (2.5 ms - 0.5 ms)) = 2.5 ms
+    await sleep(2000)
+    servo.pwmDuty(0)
+    log("servo duty = 0%")      // ~ 0.5 + (0.0 * (2.5 ms - 0.5 ms)) = 0.5 ms
+    await sleep(2000)
+    servo.close()
+    log("servo closed")
+})()
+
+
+// -------------------------------------------------------------------
+// EoF
+// -------------------------------------------------------------------

package/test/read.js

@@ -0,0 +1,30 @@
+// -------------------------------------------------------------------
+// TEST - Simple read
+// -------------------------------------------------------------------
+import {RIO, traceCfg, log, sleep, ctrlC, lineNumber} from "../esm/main.mjs"
+
+(async () => {
+    traceCfg(2)
+    const line = lineNumber(2)
+    if (line < 0) return
+
+    // Init input line
+    const btn = new RIO(line, "input", {bias: "pull-down"})
+    log("button:", btn)
+    ctrlC(() => {
+        btn.close()
+    })
+
+    log("button value:", btn.read())
+    log("input monitoring active for 10s")
+    const callback = edge => {
+        log("edge:", edge)
+    }
+    btn.monitoringStart(callback, "both", 30)
+    await sleep(10000)
+    btn.close()
+})()
+
+// -------------------------------------------------------------------
+// EoF
+// -------------------------------------------------------------------

package/test/write.js

@@ -0,0 +1,29 @@
+// -------------------------------------------------------------------
+// TEST - Simple write
+// -------------------------------------------------------------------
+import {RIO, traceCfg, log, sleep, ctrlC, lineNumber} from "../esm/main.mjs"
+
+(async () => {
+    traceCfg(2)
+
+    const line = lineNumber(2)
+    if (line < 0) return
+
+    // Init output line and ctrl+c to close it
+    const led = new RIO(line, "output", {value: 0})
+    log("led:", led)
+    ctrlC(() => {
+        led.close()
+    })
+
+    // Turn led on for 3s
+    led.write(1)
+    log("led turn on")
+    await sleep(3000)
+    led.write(0)
+    log("led turn off")
+    led.close()
+})()
+// -------------------------------------------------------------------
+// EoF
+// -------------------------------------------------------------------

package/esm/dev.mjs

@@ -1,59 +0,0 @@
-// -------------------------------------------------------------------
-// RPi GPIO CONTROL - DEV TOOLS
-// -------------------------------------------------------------------
-let debug = {
-    log: false,
-    trap: true
-}
-
-// -------------------------------------------------------------------
-// FUNCTIONS
-/** ------------------------------------------------------------------
- * @function nowStr
- * @description Return timestamp as formatted string
- * @return {String}
- */
-export const nowStr = () => {
-    const date = new Date()
-    return date.toLocaleTimeString() + "." + date.getMilliseconds().toLocaleString('en', {
-        minimumIntegerDigits: 3,
-        minimumFractionDigits: 0,
-        useGrouping: false
-    })
-}
-
-/** ------------------------------------------------------------------
- * @function log
- * @description Global customized timestamped console.log
- *              Requires global variable 'debug'
- */
-export const log = function () {
-    if (debug.log)
-        console.log.apply(console, Array.prototype.concat.apply([nowStr(), "🔎 "], arguments))
-}
-
-/** ------------------------------------------------------------------
- * @function trap
- * @description Colored log for error messages ⚠️ nodejs only ~ CSS color #F50
- */
-export const trap = function () {
-    if (debug.trap)
-        console.log.apply(console, Array.prototype.concat.apply([nowStr(), "⚠️", "\x1b[38;2;255;80;0m", ...arguments, "\x1b[0m"]))
-}
-
-/** ------------------------------------------------------------------
- * @function logCfg
- * @description Set log configuration
- * @param {Number} level    0: no log, 1: trap only, 2: trap and log
- */
-export const logCfg = level => {
-    debug = {
-        log: false,
-        trap: false
-    }
-    level > 1 ? debug.log = true : false
-    level > 0 ? debug.trap = true : false
-}
-// -------------------------------------------------------------------
-// EoF
-// -------------------------------------------------------------------