usb-detection

usb-detection allows you to listen for insert/remove events of USB devices on your system.

$3

Install

``sh
npm install usb-detection
`

Install for Electron

This module uses native extensions and needs to be compiled for your target version of Electron. Precompiled binaries for recent Node.js and Electron versions are built and published using [prebuild][] and can be installed automatically using [electron-rebuild][].

See the [Electron docs for using native modules][electron-native-modules] to ensure your project is set up to correctly use the prebuilt binaries for your version of Electron.

[prebuild]: https://github.com/prebuild/prebuild
[electron-rebuild]: https://github.com/electron/electron-rebuild
[electron-native-modules]: https://www.electronjs.org/docs/tutorial/using-native-node-modules

---

If you run into the following error, here are the exact steps you can use:

`
detection.node was compiled against a different Node.js version using NODE_MODULE_VERSION 72. This version of Node.js requires NODE_MODULE_VERSION 80. Please try re-compiling or re-installing
`

1. npm i electron-rebuild --save-dev
1. ./node_modules/.bin/electron-rebuild

Usage

`js
var usbDetect = require('usb-detection');

usbDetect.startMonitoring();

// Detect add/insert
usbDetect.on('add', function(device) { console.log('add', device); });
usbDetect.on('add:vid', function(device) { console.log('add', device); });
usbDetect.on('add:vid:pid', function(device) { console.log('add', device); });

// Detect remove
usbDetect.on('remove', function(device) { console.log('remove', device); });
usbDetect.on('remove:vid', function(device) { console.log('remove', device); });
usbDetect.on('remove:vid:pid', function(device) { console.log('remove', device); });

// Detect add or remove (change)
usbDetect.on('change', function(device) { console.log('change', device); });
usbDetect.on('change:vid', function(device) { console.log('change', device); });
usbDetect.on('change:vid:pid', function(device) { console.log('change', device); });

// Get a list of USB devices on your system, optionally filtered by vid or pid
usbDetect.find(function(err, devices) { console.log('find', devices, err); });
usbDetect.find(vid, function(err, devices) { console.log('find', devices, err); });
usbDetect.find(vid, pid, function(err, devices) { console.log('find', devices, err); });
// Promise version of find:
usbDetect.find().then(function(devices) { console.log(devices); }).catch(function(err) { console.log(err); });

// Allow the process to exit
//usbDetect.stopMonitoring()
`

API

usbDetect.startMonitoring()

Start listening for USB add/remove/change events. This will cause the Node.js process to stay open until you call usbDetect.stopMonitoring() (see below).

usbDetect.stopMonitoring()

Stop listening for USB add/remove/change events. This will also allow the Node.js process to exit.

This is really only meant to be called once on exit. No guarantees if you start/stop monitoring multiple times, see https://github.com/MadLittleMods/node-usb-detection/issues/53

usbDetect.on(eventName, callback)

- eventName
- add: also aliased as insert
- add:vid
- add:vid:pid
- remove
- remove:vid
- remove:vid:pid
- change
- change:vid
- change:vid:pid
- callback: Function that is called whenever the event occurs
- Takes a device


`js
var usbDetect = require('usb-detection');
usbDetect.startMonitoring();

usbDetect.on('add', function(device) {
console.log(device);
});

/* Console output:
{
locationId: 0,
vendorId: 5824,
productId: 1155,
deviceName: 'Teensy USB Serial (COM3)',
manufacturer: 'PJRC.COM, LLC.',
serialNumber: '',
deviceAddress: 11
}
*/
`

usbDetect.find(vid, pid, callback)

Note: All find calls return a promise even with the node-style callback flavors.

- find()
- find(vid)
- find(vid, pid)
- find(callback)
- find(vid, callback)
- find(vid, pid, callback)

Parameters:

- vid: restrict search to a certain vendor id
- pid: restrict search to s certain product id
- callback: Function that is called whenever the event occurs
- Takes a err and devices parameter.


`js
var usbDetect = require('usb-detection');
usbDetect.startMonitoring();

usbDetect.find(function(err, devices) {
console.log(devices, err);
});
// Equivalent to:
// usbDetect.find().then(function(devices) { console.log(devices); }).catch(function(err) { console.log(err); });

/* Console output:
[
{
locationId: 0,
vendorId: 0,
productId: 0,
deviceName: 'USB Root Hub',
manufacturer: '(Standard USB Host Controller)',
serialNumber: '',
deviceAddress: 2
},
{
locationId: 0,
vendorId: 5824,
productId: 1155,
deviceName: 'Teensy USB Serial (COM3)',
manufacturer: 'PJRC.COM, LLC.',
serialNumber: '',
deviceAddress: 11
}
]
*/
`

FAQ

$3

`js
var usbDetect = require('usb-detection');

// Do some detection
usbDetect.startMonitoring();

// After this call, the process will be able to quit
usbDetect.stopMonitoring();
`

$3

Make sure you call usbDetect.startMonitoring() before any calls to usbDetect.find().

$3

If you are running into the The system cannot find the path specified. error when running npm run rebuild,
make sure you have Python 2 installed and on your PATH.

You can verify node-gyp is configured correctly by looking at the output of node-gyp configure --verbose.

`sh
$ node-gyp configure --verbose
...
gyp verb check python checking for Python executable "python2" in the PATH
gyp verb which succeeded python2 C:\Python27\python2.EXE
`

If you already have Python 3 installed, you can install Python 2 alongside and
create a symlink called python2.exe via mklink "C:\Python27\python2.exe" "C:\Python27\python.exe"
and add the directory to your path.

$3

`sh
$ npm run rebuild --debug
`

Development (compile from source)

This assumes you also have everything on your system necessary to compile ANY native module for Node.js. This may not be the case, though, so please ensure the following requirements are satisfied before filing an issue about "Does not install". For all operating systems, please ensure you have Python 2.x installed AND not 3.0, node-gyp (what we use to compile) requires Python 2.x.

$3

- Visual Studio 2013/2015 Community
- Visual Studio 2010
- Visual C++ Build Tools 2015: https://github.com/nodejs/node-gyp/issues/629#issuecomment-153196245

If you are having problems building, please read this.

$3

Ensure that you have at a minimum, the xCode Command Line Tools installed appropriate for your system configuration. If you recently upgraded your OS, it probably removed your installation of Command Line Tools, please verify before submitting a ticket.

$3

You know what you need for you system, basically your appropriate analog of build-essential. Keep rocking!

To compile and install native addons from npm you may also need to install build tools (source):

`sh
sudo apt-get install -y build-essential
`

Also install libudev:

`sh
sudo apt-get install libudev-dev
`

Testing

We have a suite of Mocha/Chai tests.

The tests require some manual interaction of plugging/unplugging a USB device. Follow the cyan background text instructions.

`sh
npm test
``