usb - npm Package Compare versions

Comparing version 1.4.0 to 1.5.0

package.json

 {
   "name": "usb",
   "description": "Library to access USB devices",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "engines": {
-    "node": ">=0.12.x"
+    "node": ">=6"
   },
@@ -46,6 +46,6 @@ "keywords": [
     "nan": "^2.8.0",
-    "node-pre-gyp": "^0.6.30"
+    "node-pre-gyp": "^0.11.0"
   },
   "devDependencies": {
-    "coffee-script": "~1.6.2",
+    "coffeescript": "~1.6.2",
     "mocha": "~1.8.2",
@@ -52,0 +52,0 @@ "aws-sdk": "~2.0.0-rc.15"

Readme.md

 USB Library for Node.JS
 ===============================
 
-**POSIX:** [![Build Status](https://travis-ci.org/nonolith/node-usb.svg?branch=tcr-usb)](https://travis-ci.org/nonolith/node-usb)     **Windows:** [![Build status](https://ci.appveyor.com/api/projects/status/b23kn1pi386nguya/branch/master)](https://ci.appveyor.com/project/kevinmehall/node-usb/branch/master)
+**POSIX:** [![Build Status](https://travis-ci.org/tessel/node-usb.svg?branch=master)](https://travis-ci.org/tessel/node-usb)    
+**Windows:** [![Build status](https://ci.appveyor.com/api/projects/status/b23kn1pi386nguya/branch/master)](https://ci.appveyor.com/project/kevinmehall/node-usb/branch/master)
 
@@ -24,3 +25,3 @@ Node.JS library for communicating with USB devices in JavaScript / CoffeeScript.
 ### Windows
-Use [Zadig](http://sourceforge.net/projects/libwdi/files/zadig/) to install the WinUSB driver for your USB device. Otherwise you will get `LIBUSB_ERROR_NOT_SUPPORTED` when attempting to open devices.
+Use [Zadig](http://zadig.akeo.ie/) to install the WinUSB driver for your USB device. Otherwise you will get `LIBUSB_ERROR_NOT_SUPPORTED` when attempting to open devices.
 
@@ -95,10 +96,2 @@
 
-### .bosDescriptor
-Object with properties for the fields of the Binary Object Store descriptor:
-
-  - bLength
-  - bDescriptorType
-  - wTotalLength
-  - bNumDeviceCaps
-
 ### .allConfigDescriptors
@@ -132,2 +125,13 @@ Contains all config descriptors of the device (same structure as .configDescriptor above)
 
+### .getBosDescriptor(callback(error, bosDescriptor))
+Perform a control transfer to retrieve an object with properties for the fields of the Binary Object Store descriptor:
+
+  - bLength
+  - bDescriptorType
+  - wTotalLength
+  - bNumDeviceCaps
+
+### .getCapabilities(callback(error, capabilities))
+Retrieve a list of Capability objects for the Binary Object Store capabilities of the device.
+
 ### .interface(interface)
@@ -139,5 +143,2 @@ Return the interface with the specified interface number.
 
-### .capabilities
-List of Capability objects for the Binary Object Store capabilities of the device.
-
 ### .timeout
@@ -199,2 +200,3 @@ Timeout in milliseconds to use for control transfers.
 
+
 Capability
@@ -211,3 +213,2 @@ ---------
 Object with fields from the capability descriptor -- see libusb documentation or USB spec.
-
   - bLength
@@ -217,2 +218,3 @@ - bDescriptorType
 
+
 Endpoint
@@ -245,2 +247,5 @@ --------
 
+### .clearHalt(callback(error))
+Clear the halt/stall condition for this endpoint.
+
 InEndpoint
@@ -276,3 +281,3 @@ ----------
 ### Event: error(error)
-Emitted when polling encounters an error.
+Emitted when polling encounters an error. All in flight transfers will be automatically canceled and no further polling will be done. You have to wait for the `end` event before you can start polling again.
 
@@ -279,0 +284,0 @@ ### Event: end

usb.js

@@ -9,5 +9,10 @@ var binary = require('node-pre-gyp');
 
-// Check that libusb was initialized.
 if (usb.INIT_ERROR) {
-	throw new Error('Could not initialize libusb. Check that your system has a usb controller.');
+	console.warn("Failed to initialize libusb.")
+	usb.Device = function () { throw new Error("Device cannot be instantiated directly.") };
+	usb.Transfer = function () { throw new Error("Transfer cannot be instantiated directly.") };
+	usb.setDebugLevel = function () { };
+	usb.getDeviceList = function () { return []; };
+	usb._enableHotplugEvents = function () { };
+	usb._disableHotplugEvents = function () { };
 }
@@ -41,7 +46,2 @@
 	}
-	this.capabilities = [];
-	len = this.bosDescriptor ? this.bosDescriptor.capabilities.length : 0
-	for (var i=0; i<len; i++){
-		this.capabilities[i] = new Capability(this, i)
-	}
 }
@@ -52,3 +52,2 @@
 	this.interfaces = null
-	this.capabilities = null;
 }
@@ -61,3 +60,5 @@
 		} catch(e) {
-			return null;
+			// Check descriptor exists
+			if (e.errno == usb.LIBUSB_ERROR_NOT_FOUND) return null;
+			throw e;
 		}
@@ -67,12 +68,2 @@ }
 
-Object.defineProperty(usb.Device.prototype, "bosDescriptor", {
-	get: function() {
-		try {
-			return this._bosDescriptor || (this._bosDescriptor = this.__getBosDescriptor())
-		} catch(e) {
-			return null;
-		}
-	}
-});
-
 Object.defineProperty(usb.Device.prototype, "allConfigDescriptors", {
@@ -83,3 +74,5 @@ get: function() {
 		} catch(e) {
-			return null;
+			// Check descriptors exist
+			if (e.errno == usb.LIBUSB_ERROR_NOT_FOUND) return [];
+			throw e;
 		}
@@ -129,3 +122,3 @@ }
 	// http://libusbx.sourceforge.net/api-1.0/structlibusb__control__setup.html
-	var buf = new Buffer(wLength + SETUP_SIZE)
+	var buf = Buffer.alloc(wLength + SETUP_SIZE)
 	buf.writeUInt8(   bmRequestType, 0)
@@ -179,2 +172,87 @@ buf.writeUInt8(   bRequest,      1)
 
+usb.Device.prototype.getBosDescriptor = function (callback) {
+
+	if (this._bosDescriptor) {
+		// Cached descriptor
+		return callback(undefined, this._bosDescriptor);
+	}
+
+	if (this.deviceDescriptor.bcdUSB < 0x201) {
+		// BOS is only supported from USB 2.0.1
+		return callback(undefined, null);
+	}
+
+	this.controlTransfer(
+		usb.LIBUSB_ENDPOINT_IN,
+		usb.LIBUSB_REQUEST_GET_DESCRIPTOR,
+		(usb.LIBUSB_DT_BOS << 8),
+		0,
+		usb.LIBUSB_DT_BOS_SIZE,
+		function (error, buffer) {
+			if (error) {
+				// Check BOS descriptor exists
+				if (error.errno == usb.LIBUSB_TRANSFER_STALL) return callback(undefined, null);
+				return callback(error, null);
+			}
+
+			var totalLength = buffer.readUInt16LE(2);
+			this.controlTransfer(
+				usb.LIBUSB_ENDPOINT_IN,
+				usb.LIBUSB_REQUEST_GET_DESCRIPTOR,
+				(usb.LIBUSB_DT_BOS << 8),
+				0,
+				totalLength,
+				function (error, buffer) {
+					if (error) {
+						// Check BOS descriptor exists
+						if (error.errno == usb.LIBUSB_TRANSFER_STALL) return callback(undefined, null);
+						return callback(error, null);
+					}
+
+					var descriptor = {
+						bLength: buffer.readUInt8(0),
+						bDescriptorType: buffer.readUInt8(1),
+						wTotalLength: buffer.readUInt16LE(2),
+						bNumDeviceCaps: buffer.readUInt8(4),
+						capabilities: []
+					};
+
+					var i = usb.LIBUSB_DT_BOS_SIZE;
+					while (i < descriptor.wTotalLength) {
+						var capability = {
+							bLength: buffer.readUInt8(i + 0),
+							bDescriptorType: buffer.readUInt8(i + 1),
+							bDevCapabilityType: buffer.readUInt8(i + 2)
+						};
+
+						capability.dev_capability_data = buffer.slice(i + 3, i + capability.bLength);
+						descriptor.capabilities.push(capability);
+						i += capability.bLength;
+					}
+
+					// Cache descriptor
+					this._bosDescriptor = descriptor;
+					callback(undefined, this._bosDescriptor);
+				}
+			);
+		}
+	);
+}
+
+usb.Device.prototype.getCapabilities = function (callback) {
+	var capabilities = [];
+	var self = this;
+
+	this.getBosDescriptor(function(error, descriptor) {
+		if (error) return callback(error, null);
+
+		var len = descriptor ? descriptor.capabilities.length : 0
+		for (var i=0; i<len; i++){
+			capabilities.push(new Capability(self, i))
+		}
+
+		callback(undefined, capabilities);
+	});
+}
+
 usb.Device.prototype.setConfiguration = function(desired, cb) {
@@ -189,7 +267,2 @@ var self = this;
 			}
-			this.capabilities = [];
-			len = this.bosDescriptor ? this.bosDescriptor.capabilities.length : 0
-			for (var i=0; i<len; i++){
-				this.capabilities[i] = new Capability(this, i)
-			}
 		}
@@ -292,9 +365,5 @@ cb.call(self, err)
 	this.id = id
-	this.__refresh()
-}
-
-Capability.prototype.__refresh = function(){
-	this.descriptor = this.device.bosDescriptor.capabilities[this.id]
+	this.descriptor = this.device._bosDescriptor.capabilities[this.id]
 	this.type = this.descriptor.bDevCapabilityType
-	this.data = this.descriptor.data
+	this.data = this.descriptor.dev_capability_data
 }
@@ -312,2 +381,6 @@
 
+Endpoint.prototype.clearHalt = function(callback){
+	return this.device.__clearHalt(this.address, callback);
+}
+
 Endpoint.prototype.makeTransfer = function(timeout, callback){
@@ -359,3 +432,3 @@ return new usb.Transfer(this.device, this.address, this.transferType, timeout, callback)
 	var self = this
-	var buffer = new Buffer(length)
+	var buffer = Buffer.alloc(length)
 
@@ -392,2 +465,3 @@ function callback(error, buf, actual){
 			if (self.pollPending == 0){
+				delete self.pollTransfers;
 				self.emit('end')
@@ -400,3 +474,3 @@ }
 		try {
-			t.submit(new Buffer(self.pollTransferSize), transferDone);
+			t.submit(Buffer.alloc(self.pollTransferSize), transferDone);
 		} catch (e) {
@@ -424,5 +498,5 @@ self.emit("error", e);
 	if (!buffer){
-		buffer = new Buffer(0)
+		buffer = Buffer.alloc(0)
 	}else if (!Buffer.isBuffer(buffer)){
-		buffer = new Buffer(buffer)
+		buffer = Buffer.from(buffer)
 	}
@@ -446,3 +520,3 @@
 		this.transfer(buf);
-		this.transfer(new Buffer(0), cb);
+		this.transfer(Buffer.alloc(0), cb);
 	} else {
@@ -456,3 +530,5 @@ this.transfer(buf, cb);
 	if (name !== 'attach' && name !== 'detach') return;
-	if (++hotplugListeners === 1) usb._enableHotplugEvents();
+	if (++hotplugListeners === 1) {
+		usb._enableHotplugEvents();
+	}
 });
@@ -462,3 +538,5 @@
 	if (name !== 'attach' && name !== 'detach') return;
-	if (--hotplugListeners === 0) usb._disableHotplugEvents();
+	if (--hotplugListeners === 0) {
+		usb._disableHotplugEvents();
+	}
 });

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1832709

increased by0.05%

Lines of code

448

increased by17.28%

Number of medium maintenance alerts

0

decreased by-100%

Number of lines in readme file

336

increased by1.51%

Number of medium supply chain risk alerts

1

decreased by-50%

Worsened metrics

Number of package files

186

decreased by-0.53%

Dependency changes

• + Addedchownr@1.1.4(transitive)

• + Addeddebug@3.2.7(transitive)

• + Addedfs-minipass@1.2.7(transitive)

• + Addediconv-lite@0.4.24(transitive)

• + Addedignore-walk@3.0.4(transitive)

• + Addedminipass@2.9.0(transitive)

• + Addedminizlib@1.3.3(transitive)

• + Addedms@2.1.3(transitive)

• + Addedneedle@2.9.1(transitive)

• + Addednode-pre-gyp@0.11.0(transitive)

• + Addednpm-bundled@1.1.2(transitive)

• + Addednpm-normalize-package-bin@1.0.1(transitive)

• + Addednpm-packlist@1.4.8(transitive)

• + Addedsafe-buffer@5.2.1(transitive)

• + Addedsax@1.4.1(transitive)

• + Addedtar@4.4.19(transitive)

• + Addedyallist@3.1.1(transitive)

• - Removedajv@4.11.8(transitive)

• - Removedasn1@0.2.6(transitive)

• - Removedassert-plus@0.2.01.0.0(transitive)

• - Removedasynckit@0.4.0(transitive)

• - Removedaws-sign2@0.6.0(transitive)

• - Removedaws4@1.13.2(transitive)

• - Removedbcrypt-pbkdf@1.0.2(transitive)

• - Removedblock-stream@0.0.9(transitive)

• - Removedboom@2.10.1(transitive)

• - Removedcall-bind@1.0.7(transitive)

• - Removedcaseless@0.12.0(transitive)

• - Removedco@4.6.0(transitive)

• - Removedcombined-stream@1.0.8(transitive)

• - Removedcore-util-is@1.0.2(transitive)

• - Removedcryptiles@2.0.5(transitive)

• - Removeddashdash@1.14.1(transitive)

• - Removeddebug@2.6.9(transitive)

• - Removeddefine-data-property@1.1.4(transitive)

• - Removeddelayed-stream@1.0.0(transitive)

• - Removedecc-jsbn@0.1.2(transitive)

• - Removedes-define-property@1.0.0(transitive)

• - Removedes-errors@1.3.0(transitive)

• - Removedextend@3.0.2(transitive)

• - Removedextsprintf@1.3.0(transitive)

• - Removedforever-agent@0.6.1(transitive)

• - Removedform-data@2.1.4(transitive)

• - Removedfstream@1.0.12(transitive)

• - Removedfstream-ignore@1.0.5(transitive)

• - Removedfunction-bind@1.1.2(transitive)

• - Removedget-intrinsic@1.2.4(transitive)

• - Removedgetpass@0.1.7(transitive)

• - Removedgopd@1.0.1(transitive)

• - Removedgraceful-fs@4.2.11(transitive)

• - Removedhar-schema@1.0.5(transitive)

• - Removedhar-validator@4.2.1(transitive)

• - Removedhas-property-descriptors@1.0.2(transitive)

• - Removedhas-proto@1.0.3(transitive)

• - Removedhas-symbols@1.0.3(transitive)

• - Removedhasown@2.0.2(transitive)

• - Removedhawk@3.1.3(transitive)

• - Removedhoek@2.16.3(transitive)

• - Removedhttp-signature@1.1.1(transitive)

• - Removedis-typedarray@1.0.0(transitive)

• - Removedisarray@2.0.5(transitive)

• - Removedisstream@0.1.2(transitive)

• - Removedjsbn@0.1.1(transitive)

• - Removedjson-schema@0.4.0(transitive)

• - Removedjson-stable-stringify@1.1.1(transitive)

• - Removedjson-stringify-safe@5.0.1(transitive)

• - Removedjsonify@0.0.1(transitive)

• - Removedjsprim@1.4.2(transitive)

• - Removedmime-db@1.52.0(transitive)

• - Removedmime-types@2.1.35(transitive)

• - Removedms@2.0.0(transitive)

• - Removednode-pre-gyp@0.6.39(transitive)

• - Removedoauth-sign@0.8.2(transitive)

• - Removedobject-keys@1.1.1(transitive)

• - Removedperformance-now@0.2.0(transitive)

• - Removedpunycode@1.4.1(transitive)

• - Removedqs@6.4.1(transitive)

• - Removedrequest@2.81.0(transitive)

• - Removedset-function-length@1.2.2(transitive)

• - Removedsntp@1.0.9(transitive)

• - Removedsshpk@1.18.0(transitive)

• - Removedstringstream@0.0.6(transitive)

• - Removedtar@2.2.2(transitive)

• - Removedtar-pack@3.4.1(transitive)

• - Removedtough-cookie@2.3.4(transitive)

• - Removedtunnel-agent@0.6.0(transitive)

• - Removedtweetnacl@0.14.5(transitive)

• - Removeduid-number@0.0.6(transitive)

• - Removeduuid@3.4.0(transitive)

• - Removedverror@1.10.0(transitive)

• Updatednode-pre-gyp@^0.11.0