Electron USB Driver

Cross-platform USB device metadata and events.

Platforms

• OSX
• Windows
• Linux (Planned)

Requirements

• Node.js v0.12.x

Install

npm install electron-usb-driver

Usage

var usbDriver = require('electron-usb-driver');

Functions returning promises

Get a list of attached devices

Use getAll():

usbDriver.getAll().then(function(devices) {
  /* ... do something with devices ... */
}).catch(function(err) { /* ... error handling */ });

devices is an array of device objects. See Device Objects, below.

Get a device by ID

Use get():

usbDriver.get(deviceId).then(function(device) {
  /* ... do something with device ... */
}).catch(function(err) { /* ... error handling ... */ });

deviceId is the id provided in the device objects from getAll(), and device is a resulting device object. See Device Objects, below.

Unmount a (mass storage) device

Use unmount():

Note that the promise will be rejected only if a mounted volume could not be unmounted by this invocation. If it's already unmounted, the promise will be resolved.

usbDriver.unmount(deviceId).then(function() {
  /* ... success ... */
}).catch(function(err) { /* ... failure ... */ });

deviceId is the id provided in the device objects from get() or getAll(). See Device Objects, below.

Events

Watch for attach events

usbDriver.on('attach', function(device) { /* ... */ });

device is a device object. See Device Objects, below.

Watch for detach events

usbDriver.on('detach', function(device) { /* ... */ });

device is a device object. See Device Objects, below.

Watch for mount events

When a USB device is mounted.

usbDriver.on('mount', function(device) { /* ... */ });

device is a device object. See Device Objects, below.

Watch for unmount events

When a USB device is unmounted.

usbDriver.on('unmount', function(device) { /* ... */ });

device is a device object. See Device Objects, below.

Device Objects

Device objects represent attached USB devices and model the data about them.

Here's an example:

{
  id: '0x0a-0x12-IDQFB0023AB', // VID-PID-(SERIAL|INCREMENTED_ID)
  vendorCode: '0x0a',
  productCode: '0x12',
  manufacturer: 'Foo Bar Technologies',
  product: 'Baz Sensing Quux',
  serialNumber: 'IDQFB0023AB',
  mount: '/Volumes/FOOBAR1'
}

id

REQUIRED, String | Integer

The id is a unique identifier for an attached device. This is made up of the product code, vendor code -- and the serial number, if available. If the serial number is not available, an incremented value is provided as the last component.

vendorCode

REQUIRED, String

The hex for the USB vendor ID.

productCode

REQUIRED, String

The hex for the USB product ID.

manufacturer

OPTIONAL, String

The name of the manufacturer/vendor, if available as a USB descriptor.

product

OPTIONAL, String

The name of the product, if available as a USB descriptor.

serialNumber

OPTIONAL, String

The serial number of the device, if available as a USB descriptor.

mount

OPTIONAL, String

The path to the volume mount point, if mounted.

Test

npm test

License

See LICENSE