Giter VIP home page Giter VIP logo

node-red-contrib-usbhid's Introduction

node-red-contrib-usbhid

A node-hid (USB HID device access library) wrapper for nodered

Credit goes to node-hid.

You can look up either git to find information on setup, Prerequisites and Platforms to get the node working: https://github.com/node-hid/node-hid

Prerequisites:

  • Node.js v0.8 - v4.x+
  • Mac OS X 10.8, Linux (kernel 2.6+), and Windows XP+
  • libudev-dev, libusb-1.0-0-dev (if Linux, see Compile below)
  • git

node-hid uses node-pre-gyp to store pre-built binary bundles, so usually no compiler is needed to install.

Platforms we pre-build binaries for:

  • Mac OS X x64: v0.10, v0.12, v4.2.x
  • Windows x64 & x86: v0.10, v0.12, v4.2.x
  • Linux Debian/Ubuntu x64: v4.2.x
  • Raspberry Pi arm: v4.2.x

How to Install on Windows

This package works natively with Windows.

Manual installation is the current way to get the node. It will be added to the pallette manager in the future.

Install from source

From github: Navigate to the your home directory on linux and windows it is typically ~/.node-red/node-modules

git clone https://github.com/gdziuba/node-red-contrib-usbhid.git
cd node-red-contrib-usbhid
npm install

How to Install on Linux

HID ( USB ) read/write access for non root users ( in my case for user pi on an raspberry pi 2 running nodered )

Install libraries for Linux

sudo apt install libusb-1.0-0 libusb-1.0-0-dev libudev-dev

The Pd-extended [hid] object allows you to access Human Interface Devices such as mice, keyboards, and joysticks. However, in most Linux distributions, these devices are setup to where they cannot be read/written directly by Pd unless you run it as root.

Running a non-system process as root is considered a security risk, so an alternative is to change the permissions of the input devices so that pd can read/write them.

sudo mkdir -p /etc/udev/rules.d
sudo nano /etc/udev/rules.d/85-pure-data.rules

Now add the following rules to /etc/udev/rules.d/85-pure-data.rules making sure to updated KERNEL to your hidraw* device:

SUBSYSTEM=="input", GROUP="input", MODE="0777"
SUBSYSTEM=="usb", MODE:="777", GROUP="input"
KERNEL=="hidraw<<put HID Number Here>>", MODE="0777", GROUP="input"

Example:

SUBSYSTEM=="input", GROUP="input", MODE="0777"
SUBSYSTEM=="usb", MODE:="777", GROUP="input"
KERNEL=="hidraw0", MODE="0777", GROUP="input"

Make sure no existing rules compete. I found existing file on Raspberry pi that needed updating. I added above code instead of creating a new file

Then create an "input" group and add yourself to it:

sudo groupadd -f input
sudo gpasswd -a $USER input

Reloads rules:

udevadm control --reload-rules

Reboot your machine for the rules to take effect. Your nodejs / nodered has now FULL ACCESS !! to you usb devides. Feel free to adjust the permissions to fit your needs.

How to Use

Leverage this Flow to get started.

node-red-contrib-usbhid's People

Contributors

gdziuba avatar somebuddy87 avatar fedme avatar

Stargazers

Ian Bernardo avatar blanpa avatar  avatar

node-red-contrib-usbhid's Issues

unable to duplicate the output of the provided example

Device: Raspberry Pi Zero W
OS: Raspberry Pi Imager recommended RPi OS (Legacy, 32 bit) Debian/Bullseye
Barcode Scanners: Honeywell 1990iXR & Nadamoo Bur3003
Process:

  1. Fresh install of recommended RPi OS (Legacy, 32 bit) Debian/Bullseye
  2. Library installation of node-red-contrib-usbhid
  3. Resolved Raspberry Pi/Node Red crashing by implementing the following
  4. After locating VID & PID, the “HIDdevice” flow would error with “TypeError: Cannot write to hid device”
  5. Ignoring this error & scanning would output individual characters as shown below (& not as a continuous string).
    Request:
    What am I currently missing that is preventing me from duplicating the results shown in the original article?

[ { "id": "e7bfae6b93c713bf", "type": "tab", "label": "Flow 1", "disabled": false, "info": "", "env": [] }, { "id": "7213798195f1c63d", "type": "group", "z": "e7bfae6b93c713bf", "name": "USBHID", "style": { "label": true }, "nodes": [ "c5f5f7e78d547a66", "0ed45f133c95bb55", "8a4dd18c70dca5d2", "06b8086b8b687eb9", "911ec5f175e778cf", "fbaea9ab03cbe2a2", "27114005a81dc1e2" ], "x": 194, "y": 59, "w": 692, "h": 122 }, { "id": "c5f5f7e78d547a66", "type": "debug", "z": "e7bfae6b93c713bf", "g": "7213798195f1c63d", "name": "debug 2", "active": true, "tosidebar": true, "console": false, "tostatus": false, "complete": "false", "statusVal": "", "statusType": "auto", "x": 620, "y": 100, "wires": [] }, { "id": "0ed45f133c95bb55", "type": "getHIDdevices", "z": "e7bfae6b93c713bf", "g": "7213798195f1c63d", "name": "", "x": 460, "y": 100, "wires": [ [ "c5f5f7e78d547a66" ] ] }, { "id": "8a4dd18c70dca5d2", "type": "inject", "z": "e7bfae6b93c713bf", "g": "7213798195f1c63d", "name": "", "props": [ { "p": "payload" }, { "p": "topic", "vt": "str" } ], "repeat": "", "crontab": "", "once": false, "onceDelay": 0.1, "topic": "", "payload": "", "payloadType": "date", "x": 300, "y": 100, "wires": [ [ "0ed45f133c95bb55" ] ] }, { "id": "06b8086b8b687eb9", "type": "HIDdevice", "z": "e7bfae6b93c713bf", "g": "7213798195f1c63d", "connection": "68a0ec4b6af1dcb1", "name": "", "x": 470, "y": 140, "wires": [ [ "fbaea9ab03cbe2a2" ], [] ] }, { "id": "911ec5f175e778cf", "type": "debug", "z": "e7bfae6b93c713bf", "g": "7213798195f1c63d", "name": "debug 3", "active": true, "tosidebar": true, "console": false, "tostatus": false, "complete": "true", "targetType": "full", "statusVal": "", "statusType": "auto", "x": 780, "y": 140, "wires": [] }, { "id": "fbaea9ab03cbe2a2", "type": "function", "z": "e7bfae6b93c713bf", "g": "7213798195f1c63d", "name": "Hex to String", "func": "const hexBuffer = msg.payload;\n\n// Convert the hex buffer to a Buffer object\nconst buffer = Buffer.from(hexBuffer, 'hex');\n\n// Convert the Buffer to a string\nconst string = buffer.toString();\n\n// Assign the string to msg.payload for further processing\nmsg.payload = string;\n\nreturn msg;", "outputs": 1, "timeout": 0, "noerr": 0, "initialize": "", "finalize": "", "libs": [], "x": 630, "y": 140, "wires": [ [ "911ec5f175e778cf" ] ] }, { "id": "27114005a81dc1e2", "type": "inject", "z": "e7bfae6b93c713bf", "g": "7213798195f1c63d", "name": "", "props": [ { "p": "payload" }, { "p": "topic", "vt": "str" } ], "repeat": "", "crontab": "", "once": false, "onceDelay": 0.1, "topic": "", "payload": "", "payloadType": "date", "x": 300, "y": 140, "wires": [ [ "06b8086b8b687eb9" ] ] }, { "id": "68a0ec4b6af1dcb1", "type": "HIDConfig", "vid": "3118", "pid": "4097", "name": "Barcode Scanner" } ]

Picture1
Picture2
Picture3
Picture4

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.