How to fix LIBUSB_ERROR_NOT_SUPPORTED in node-usb on Windows?

This error usually means the device lacks a WinUSB driver. Install one using Zadig or call usb.useUsbDkBackend() to switch to the UsbDk backend, but note that drivers grant exclusive access, so you may need to uninstall others.

node-usb vs serialport: which should I use for USB communication?

Use node-usb for low-level USB device control and WebUSB compliance, ideal for custom hardware. Use serialport for simple serial communication over USB-CDC, as it abstracts away USB complexities and is easier for basic tasks.

How to handle USB device hotplug events in node-usb?

In the legacy API, use usb.on('attach', callback) and usb.on('detach', callback). For WebUSB, events are handled via the standard WebUSB event model, but both APIs support dynamic device monitoring as shown in the examples.

Can I use node-usb in a web browser?

No, node-usb is a Node.js library and requires a Node.js or Electron environment. For browser-based USB access, use the native WebUSB API if the browser supports it, but note that node-usb implements the same API server-side.

How to migrate from node-usb-detection to node-usb?

Replace usbDetect methods with node-usb equivalents: use usb.getDeviceList() for device enumeration, and switch from 'add'/'remove' events to 'attach'/'detach'. The README includes a detailed migration guide to ease the transition.

Open-Awesome

usb

MITTypeScriptv2.19.1

A Node.js library for communicating with USB devices, supporting both WebUSB and legacy APIs.

Visit Website GitHub

1.7k stars284 forks0 contributors

What is usb?

node-usb is a Node.js library that enables JavaScript applications to communicate with USB devices. It provides native bindings to the libusb library, allowing developers to enumerate, control, and transfer data to and from USB hardware directly from Node.js. The library solves the problem of accessing low-level USB devices in a high-level JavaScript environment.

Target Audience

Node.js developers building applications that need to interact with USB hardware, such as IoT devices, custom peripherals, or industrial equipment. It's also suitable for Electron app developers requiring USB access.

Value Proposition

Developers choose node-usb because it offers both a modern WebUSB-compliant API and a stable legacy API, ensuring compatibility with existing code while embracing web standards. Its prebuilt binaries simplify installation, and active maintenance provides reliability for production use.

Overview

Improved USB library for Node.js

Use Cases

Best For

Building Node.js applications that control custom USB hardware
Developing Electron apps that need USB device communication
Migrating from node-usb-detection to a maintained library
Implementing WebUSB-compatible device interfaces in Node.js
Creating tools for USB device enumeration and diagnostics
Prototyping USB-based IoT or embedded system controllers

Not Ideal For

Projects requiring isochronous USB transfers for real-time audio or video streaming
Web browser-based applications that need direct WebUSB API access without a Node.js backend
Simple serial communication tasks where higher-level libraries like serialport are more appropriate
Environments where manual driver installation on Windows or udev rule edits on Linux are not feasible

Pros & Cons

Pros

WebUSB Standards Compliance

Implements the full W3C WebUSB specification, providing a modern, standardized API for device enumeration and control, as evidenced by the detailed implementation status table in the README.

Dual API Flexibility

Offers both a legacy non-blocking API for backward compatibility and a modern WebUSB API for new projects, ensuring developers can choose based on their needs without sacrificing functionality.

Cross-Platform Support

Works on Windows, Linux, and macOS with prebuilt binaries and platform-specific setup instructions, reducing build issues and simplifying deployment across different operating systems.

Electron Integration Ready

Includes prebuilt binaries and clear packaging guidance for Electron applications, making it straightforward to use in desktop apps without recompilation hassles.

Cons

Missing Isochronous Transfers

The library explicitly does not support isochronous transfers, which are critical for real-time data streaming applications like audio or video, limiting its use cases.

Complex Windows Driver Setup

On Windows, users often encounter LIBUSB_ERROR_NOT_SUPPORTED and must manually install drivers using tools like Zadig, adding deployment overhead and potential compatibility issues.

Linux Permission Hurdles

Requires modifying udev rules and group permissions to access devices, which can be a barrier for non-administrator users and complicates production deployments.

Frequently Asked Questions

Related Projects

johnny-five

JavaScript Robotics and IoT programming framework, developed at Bocoup.

Stars13,412

Forks1,723

Last commit3 years ago

serialport

Access serial ports with JavaScript. Linux, OSX and Windows. Welcome your robotic JavaScript overlords. Better yet, program them!

Stars5,993

Forks1,007

Last commit9 months ago

onoff

GPIO access and interrupt detection with Node.js

Stars1,258

Forks122

Last commit2 years ago

pigpio

Fast GPIO, PWM, servo control, state change notification and interrupt handling with Node.js on the Raspberry Pi

Stars968

Forks87