node package manager


USB HID device access library

node-hid - Access USB HID devices from node.js

npm install node-hid
  • 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 now uses node-pre-gyp to store pre-built binary bundles, so usually no compiler is needed to install!

Platforms we pre-build node-hid 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

If node-hid doesn't have a pre-built binary for your system, it will attempt to compile locally. In which case you'll need the Compiler tools mentioned below.

In the src/ directory, various JavaScript programs can be found that talk to specific devices in some way. Some interesting ones:

To try them out, call them like node src/showdevices.js from the node-hid directory.

var HID = require('node-hid');
var devices = HID.devices()

devices will contain an array of objects, one for each HID device available. Of particular interest are the vendorId and productId, as they uniquely identify a device, and the path, which is needed to open a particular device.

Here is some sample output:

[ { vendorId: 1452,
    productId: 595,
    path: 'USB_05ac_0253_0x100a148e0',
    serialNumber: '',
    manufacturer: 'Apple Inc.',
    product: 'Apple Internal Keyboard / Trackpad',
    release: 280,
    interface: -1 },
  { vendorId: 1452,
    productId: 595,
    path: 'USB_05ac_0253_0x100a14e20',
    serialNumber: '',
    manufacturer: 'Apple Inc.',
    product: 'Apple Internal Keyboard / Trackpad',
    release: 280,
    interface: -1 },
<and more>

Before a device can be read from or written to, it must be opened. The path can be determined by a prior HID.devices() call. Use either the path from the list returned by a prior call to HID.devices():

var device = new HID.HID(path);

or open the first device matching a VID/PID pair:

var device = new HID.HID(vid,pid);

device will contain a handle to the device. If an error occurs opening the device, an exception will be thrown.

Reading from a device is performed by registering a "data" event handler:

device.on("data", function(data) {});

You can also listen for errors like this:

device.on("error", function(err) {});

All reading is asynchronous.

Writing to a device is performed using the write call in a device handle. All writing is synchronous.

device.write([0x00, 0x01, 0x01, 0x05, 0xff, 0xff]);


  • The write() method sends OUTPUT reports. To send Feature reports, see the sendFeatureReport() method below.
  • Some devices use reportIds for OUTPUT reports. If that is the case, the first byte of the array to write() should be the reportId.
var device = new HID.HID(path);
  • chunk - Buffer - the data read from the device
  • error - The error Object emitted
  • data - the data to be synchronously written to the device

Closes the device. Subsequent reads will raise an error.

Pauses reading and the emission of data events.

This method will cause the HID device to resume emmitting data events. If no listeners are registered for the data event, data will be lost.

When a data event is registered for this HID device, this method will be automatically called.

Low-level function call to initiate an asynchronous read from the device. callback is of the form callback(err, data)

  • data - data of HID feature report, with 0th byte being report_id ([report_id,...])
  • report_id - HID feature report id to get
  • report_length - length of report

To compile & develop locally (or if node-pre-gyp cannot find a pre-built binary for you), you will need the following tools:

  • Mac OS X 10.8+
  • Windows XP+
  • Linux (kernel 2.6+)
    • Compiler tools (apt-get install build-essential git for Debin/Ubuntu/Raspian)
    • libudev-dev (Fedora: yum install libusbx-devel)
    • libusb-1.0-0-dev (Ubuntu versions missing libusb.h only)
    • gcc-4.8+ (apt-get install gcc-4.8 g++-4.8 && export CXX=g++-4.8)

You'll also need to issue the following command in the 'node-hid' directory:

git submodule update --init   # done on publish automatically
npm install       # rebuilds the module

Please use the node-hid github issues page for support questions and issues.