usb 1.9.1 → 2.0.1

package/README.md

@@ -1,112 +1,340 @@
-USB Library for Node.JS
-===============================
+# USB Library for Node.JS
 
 [![Build Status](https://github.com/node-usb/node-usb/workflows/prebuild/badge.svg)](https://github.com/node-usb/node-usb/actions)
+[![npm](https://img.shields.io/npm/dm/usb.svg)](https://www.npmjs.com/package/usb)
+[![Licence MIT](https://img.shields.io/badge/licence-MIT-blue.svg)](http://opensource.org/licenses/MIT)
 
-Node.JS library for communicating with USB devices in JavaScript / CoffeeScript.
+Node.JS library for communicating with USB devices.
 
-This is a refactoring / rewrite of Christopher Klein's [node-usb](https://github.com/schakko/node-usb). The API is not compatible (hopefully you find it an improvement).
+This is a refactoring / rewrite of Christopher Klein's [node-usb](https://github.com/schakko/node-usb).
 
-It's based entirely on libusb's asynchronous API for better efficiency, and provides a stream API for continuously streaming data or events.
+# Prerequisites
 
-Installation
-============
+[Node.js >= v10.16.0](https://nodejs.org), which includes `npm`.
 
-Libusb is included as a submodule. On Linux, you'll need libudev to build libusb. On Ubuntu/Debian: `sudo apt-get install build-essential libudev-dev`
+On Windows, 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.
 
-Then, just run
+# Installation
 
-	npm install usb
+Native modules are bundled using `prebuildify`, so installation should be as simple as installing the package.
 
-to install from npm. See the bottom of this page for instructions for building from a git checkout.
+With `npm`:
 
-### Windows
-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.
+```bash
+npm install usb
+```
 
+With `yarn`:
 
-API
-===
+```bash
+yarn add usb
+```
 
-	var usb = require('usb')
+__Note:__ the library is now written in `TypeScript`, so a separate types file is not longer required to be installed.
 
-usb
----
+# License
+[MIT](LICENSE.md)
 
-Top-level object.
+Note that the compiled Node extension includes [libusb](https://github.com/libusb/libusb), and is thus subject to the [LGPL](https://github.com/libusb/libusb/blob/master/COPYING).
 
-### usb.getDeviceList()
-Return a list of `Device` objects for the USB devices attached to the system.
+# Limitations
+Does not support:
+
+- Configurations other than the default one
+- Isochronous transfers
+
+# Getting Started
+Use the following examples to kickstart your development. Once you have a desired device, use the APIs below to interact with it.
+
+## Migrating to `v2.0.0`
+The legacy API exists on an object called `usb` on the main import and the convenience functions exist as top level objects.
+
+To use `v2.0.0` simply update your import statements and the function calls;
+
+```typescript
+// import * as usb from 'usb';
+// const devices: usb.Device[] = usb.getDeviceList();
+
+import { usb, getDeviceList } from 'usb';
+const devices: usb.Device[] = getDeviceList();
+```
+
+## List all legacy devices
+```typescript
+import { getDeviceList } from 'usb';
+
+const devices = getDeviceList();
+
+for (const device of devices) {
+    console.log(device); // Legacy device
+}
+```
+
+## Find legacy device by vid/pid
+```typescript
+import { findByIds } from 'usb';
+
+const device = findByIds(0x59e3, 0x0a23);
+
+if (device) {
+    console.log(device); // Legacy device
+}
+```
+
+## Find legacy device by SerialNumber
+```typescript
+import { findBySerialNumber } from 'usb';
+
+(async () => {
+    // Uses a blocking call, so is async
+    const device = await findBySerialNumber('TEST_DEVICE');
+
+    if (device) {
+        console.log(device); // Legacy device
+    }
+})();
+```
+
+## Turn legacy Device into WebUSB compatible device
+```typescript
+import { findBySerialNumber, WebUSBDevice } from 'usb';
+
+(async () => {
+    // Uses a blocking call, so is async
+    const device = await findBySerialNumber('TEST_DEVICE');
+
+    // Uses blocking calls, so is async
+    const webDevice = await WebUSBDevice.createInstance(device);
+
+    if (webDevice) {
+        console.log(webDevice); // WebUSB device
+    }
+})();
+```
+
+## Use WebUSB approach to find a device
+```typescript
+import { webusb } from 'usb';
+
+(async () => {
+    // Returns first matching device
+    const device = await webusb.requestDevice({
+        filters: [{}]
+    })
+
+    if (device) {
+        console.log(device); // WebUSB device
+    }
+})();
+```
+
+## Use WebUSB approach to find a device with custom selection method
+```typescript
+import { WebUSB } from 'usb';
+
+(async () => {
+    const customWebUSB = new WebUSB({
+        // This function can return a promise which allows a UI to be displayed if required
+        devicesFound: devices => devices.find(device => device.serialNumber === 'TEST_DEVICE')
+    });
+
+    // Returns device based on injected 'devicesFound' function
+    const device = await customWebUSB.requestDevice({
+        filters: [{}]
+    })
+
+    if (device) {
+        console.log(device); // WebUSB device
+    }
+})();
+```
+
+## Use WebUSB approach to list authorised devices
+```typescript
+import { webusb } from 'usb';
+
+(async () => {
+    // The default webusb instance follows the WebUSB spec and only returns authorised devices
+    const devices = await webusb.getDevices();
+
+    for (const device of devices) {
+        console.log(device); // WebUSB device
+    }
+})();
+```
+
+## Use WebUSB approach to list all devices
+```typescript
+import { WebUSB } from 'usb';
+
+(async () => {
+    const customWebUSB = new WebUSB({
+        // Bypass cheking for authorised devices
+        allowAllDevices: true
+    });
+
+    // Uses blocking calls, so is async
+    const devices = await customWebUSB.getDevices();
+
+    for (const device of devices) {
+        console.log(device); // WebUSB device
+    }
+})();
+```
+
+## Electron
+Please refer to the maintained example for using `node-usb` in electron:
+
+https://github.com/node-usb/node-usb-example-electron
+
+# APIs
+Since `v2.0.0`, the `node-usb` library supports two APIs:
+
+- `WebUSB` which follows the [WebUSB Specification](https://wicg.github.io/webusb/) (recommended)
+- `Legacy API` which retains the previous 'non-blocking' API
+
+Convenience methods also exist to easily list or find devices as well as convert between a legacy usb.Device device and WebUSB device.
+
+Full auto-generated API documentation can be seen here:
+
+https://node-usb.github.io/node-usb/
+
+## Convenience Functions
+
+### getDeviceList()
+Return a list of legacy `Device` objects for the USB devices attached to the system.
+
+### findByIds(vid, pid)
+Convenience method to get the first legacy device with the specified VID and PID, or `undefined` if no such device is present.
+
+### findBySerialNumber(serialNumber)
+Convenience method to get a promise of the legacy device with the specified serial number, or `undefined` if no such device is present.
+
+### WebUSBDevice
+WebUSB Device class for wrapping a legacy Device into a WebUSB device
+
+#### WebUSBDevice.createInstance(device)
+Convenience method to return a promise of a WebUSB device based on a legacy device
+
+## WebUSB
+
+Please refer to the WebUSB specification which be found here:
+
+https://wicg.github.io/webusb/
+
+### Implementation Status
+
+#### USB
 
-### usb.findByIds(vid, pid)
-Convenience method to get the first device with the specified VID and PID, or `undefined` if no such device is present.
+- [x] getDevices()
+- [x] requestDevice()
 
-### usb.LIBUSB_*
+#### USBDevice
+
+- [x] usbVersionMajor
+- [x] usbVersionMinor
+- [x] usbVersionSubminor
+- [x] deviceClass
+- [x] deviceSubclass
+- [x] deviceProtocol
+- [x] vendorId
+- [x] productId
+- [x] deviceVersionMajor
+- [x] deviceVersionMinor
+- [x] deviceVersionSubminor
+- [x] manufacturerName
+- [x] productName
+- [x] serialNumber
+- [x] configuration
+- [x] configurations
+- [x] opened
+- [x] open()
+- [x] close()
+- [x] selectConfiguration()
+- [x] claimInterface()
+- [x] releaseInterface()
+- [x] selectAlternateInterface()
+- [x] controlTransferIn()
+- [x] controlTransferOut() - `bytesWritten` always equals the initial buffer length
+- [x] transferIn()
+- [x] transferOut() - `bytesWritten` always equals the initial buffer length
+- [x] clearHalt()
+- [x] reset()
+- [ ] isochronousTransferIn()
+- [ ] isochronousTransferOut()
+
+#### Events
+
+- [x] connect
+- [x] disconnect
+
+## Legacy API
+
+### usb
+Legacy usb object.
+
+#### usb.LIBUSB_*
 Constant properties from libusb
 
-### usb.setDebugLevel(level : int)
+#### usb.setDebugLevel(level : int)
 Set the libusb debug level (between 0 and 4)
 
-Device
-------
-
+### Device
 Represents a USB device.
 
-### .busNumber
+#### .busNumber
 Integer USB device number
 
-### .deviceAddress
+#### .deviceAddress
 Integer USB device address
 
-### .portNumbers
+#### .portNumbers
 Array containing the USB device port numbers, or `undefined` if not supported on this platform.
 
-### .deviceDescriptor
+#### .deviceDescriptor
 Object with properties for the fields of the device descriptor:
 
-  - bLength
-  - bDescriptorType
-  - bcdUSB
-  - bDeviceClass
-  - bDeviceSubClass
-  - bDeviceProtocol
-  - bMaxPacketSize0
-  - idVendor
-  - idProduct
-  - bcdDevice
-  - iManufacturer
-  - iProduct
-  - iSerialNumber
-  - bNumConfigurations
-
-### .configDescriptor
+- bLength
+- bDescriptorType
+- bcdUSB
+- bDeviceClass
+- bDeviceSubClass
+- bDeviceProtocol
+- bMaxPacketSize0
+- idVendor
+- idProduct
+- bcdDevice
+- iManufacturer
+- iProduct
+- iSerialNumber
+- bNumConfigurations
+
+#### .configDescriptor
 Object with properties for the fields of the configuration descriptor:
 
-  - bLength
-  - bDescriptorType
-  - wTotalLength
-  - bNumInterfaces
-  - bConfigurationValue
-  - iConfiguration
-  - bmAttributes
-  - bMaxPower
-  - extra (Buffer containing any extra data or additional descriptors)
-
-### .allConfigDescriptors
-	Contains all config descriptors of the device (same structure as .configDescriptor above)
+- bLength
+- bDescriptorType
+- wTotalLength
+- bNumInterfaces
+- bConfigurationValue
+- iConfiguration
+- bmAttributes
+- bMaxPower
+- extra (Buffer containing any extra data or additional descriptors)
 
-### .parent
-	Contains the parent of the device, such as a hub. If there is no parent this property is set to `null`.
+#### .allConfigDescriptors
+Contains all config descriptors of the device (same structure as .configDescriptor above)
 
-### .open()
+#### .parent
+Contains the parent of the device, such as a hub. If there is no parent this property is set to `null`.
 
+#### .open()
 Open the device. All methods below require the device to be open before use.
 
-### .close()
-
+#### .close()
 Close the device.
 
-### .controlTransfer(bmRequestType, bRequest, wValue, wIndex, data_or_length, callback(error, data))
-
+#### .controlTransfer(bmRequestType, bRequest, wValue, wIndex, data_or_length, callback(error, data))
 Perform a control transfer with `libusb_control_transfer`.
 
 Parameter `data_or_length` can be a integer length for an IN transfer, or a Buffer for an out transfer. The type must match the direction specified in the MSB of bmRequestType.
@@ -115,145 +343,137 @@ The `data` parameter of the callback is always undefined for OUT transfers, or w
 
 A [package is available to calculate bmRequestType](https://www.npmjs.com/package/bmrequesttype) if needed.
 
-### .setConfiguration(id, callback(error))
+#### .setConfiguration(id, callback(error))
 Set the device configuration to something other than the default (0). To use this, first call `.open(false)` (which tells it not to auto configure), then before claiming an interface, call this method.
 
-### .getStringDescriptor(index, callback(error, data))
+#### .getStringDescriptor(index, callback(error, data))
 Perform a control transfer to retrieve a string descriptor
 
-### .getBosDescriptor(callback(error, bosDescriptor))
+#### .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
+- bLength
+- bDescriptorType
+- wTotalLength
+- bNumDeviceCaps
 
-### .getCapabilities(callback(error, capabilities))
+#### .getCapabilities(callback(error, capabilities))
 Retrieve a list of Capability objects for the Binary Object Store capabilities of the device.
 
-### .interface(interface)
+#### .interface(interface)
 Return the interface with the specified interface number.
 
-### .interfaces
+#### .interfaces
 List of Interface objects for the interfaces of the default configuration of the device.
 
-### .timeout
+#### .timeout
 Timeout in milliseconds to use for control transfers.
 
-### .reset(callback(error))
+#### .reset(callback(error))
 Performs a reset of the device. Callback is called when complete.
 
+### Interface
 
-Interface
----------
-
-### .endpoint(address)
+#### .endpoint(address)
 Return the InEndpoint or OutEndpoint with the specified address.
 
-### .endpoints
+#### .endpoints
 List of endpoints on this interface: InEndpoint and OutEndpoint objects.
 
-### .interface
+#### .interface
 Integer interface number.
 
-### .altSetting
+#### .altSetting
 Integer alternate setting number.
 
-### .setAltSetting(altSetting, callback(error))
+#### .setAltSetting(altSetting, callback(error))
 Sets the alternate setting. It updates the `interface.endpoints` array to reflect the endpoints found in the alternate setting.
 
-### .claim()
+#### .claim()
 Claims the interface. This method must be called before using any endpoints of this interface.
 
-### .release([closeEndpoints], callback(error))
+#### .release([closeEndpoints], callback(error))
 Releases the interface and resets the alternate setting. Calls callback when complete.
 
 It is an error to release an interface with pending transfers. If the optional closeEndpoints parameter is true, any active endpoint streams are stopped (see `Endpoint.stopStream`), and the interface is released after the stream transfers are cancelled. Transfers submitted individually with `Endpoint.transfer` are not affected by this parameter.
 
-### .isKernelDriverActive()
+#### .isKernelDriverActive()
 Returns `false` if a kernel driver is not active; `true` if active.
 
-### .detachKernelDriver()
+#### .detachKernelDriver()
 Detaches the kernel driver from the interface.
 
-### .attachKernelDriver()
+#### .attachKernelDriver()
 Re-attaches the kernel driver for the interface.
 
-### .descriptor
+#### .descriptor
 Object with fields from the interface descriptor -- see libusb documentation or USB spec.
 
-  - bLength
-  - bDescriptorType
-  - bInterfaceNumber
-  - bAlternateSetting
-  - bNumEndpoints
-  - bInterfaceClass
-  - bInterfaceSubClass
-  - bInterfaceProtocol
-  - iInterface
-  - extra (Buffer containing any extra data or additional descriptors)
-
+- bLength
+- bDescriptorType
+- bInterfaceNumber
+- bAlternateSetting
+- bNumEndpoints
+- bInterfaceClass
+- bInterfaceSubClass
+- bInterfaceProtocol
+- iInterface
+- extra (Buffer containing any extra data or additional descriptors)
 
-Capability
----------
+### Capability
 
-### .type
+#### .type
 Integer capability type.
 
-### .data
+#### .data
 Buffer capability data.
 
-### .descriptor
+#### .descriptor
 Object with fields from the capability descriptor -- see libusb documentation or USB spec.
-  - bLength
-  - bDescriptorType
-  - bDevCapabilityType
-
-
-Endpoint
---------
+  
+- bLength
+- bDescriptorType
+- bDevCapabilityType
 
+### Endpoint
 Common base for InEndpoint and OutEndpoint, see below.
 
-### .direction
+#### .direction
 Endpoint direction: `"in"` or `"out"`.
 
-### .transferType
+#### .transferType
 Endpoint type: `usb.LIBUSB_TRANSFER_TYPE_BULK`, `usb.LIBUSB_TRANSFER_TYPE_INTERRUPT`, or `usb.LIBUSB_TRANSFER_TYPE_ISOCHRONOUS`.
 
-###  .descriptor
+#### .descriptor
 Object with fields from the endpoint descriptor -- see libusb documentation or USB spec.
 
-  - bLength
-  - bDescriptorType
-  - bEndpointAddress
-  - bmAttributes
-  - wMaxPacketSize
-  - bInterval
-  - bRefresh
-  - bSynchAddress
-  - extra (Buffer containing any extra data or additional descriptors)
-
-### .timeout
+- bLength
+- bDescriptorType
+- bEndpointAddress
+- bmAttributes
+- wMaxPacketSize
+- bInterval
+- bRefresh
+- bSynchAddress
+- extra (Buffer containing any extra data or additional descriptors)
+
+#### .timeout
 Sets the timeout in milliseconds for transfers on this endpoint. The default, `0`, is infinite timeout.
 
-### .clearHalt(callback(error))
+#### .clearHalt(callback(error))
 Clear the halt/stall condition for this endpoint.
 
-InEndpoint
-----------
-
+### InEndpoint
 Endpoints in the IN direction (device->PC) have this type.
 
-### .transfer(length, callback(error, data))
+#### .transfer(length, callback(error, data))
 Perform a transfer to read data from the endpoint.
 
 If length is greater than maxPacketSize, libusb will automatically split the transfer in multiple packets, and you will receive one callback with all data once all packets are complete.
 
 `this` in the callback is the InEndpoint object.
 
-### .startPoll(nTransfers=3, transferSize=maxPacketSize)
+#### .startPoll(nTransfers=3, transferSize=maxPacketSize)
 Start polling the endpoint.
 
 The library will keep `nTransfers` transfers of size `transferSize` pending in
@@ -261,85 +481,90 @@ the kernel at all times to ensure continuous data flow. This is handled by the
 libusb event thread, so it continues even if the Node v8 thread is busy. The
 `data` and `error` events are emitted as transfers complete.
 
-### .stopPoll(cb)
+#### .stopPoll(cb)
 Stop polling.
 
 Further data may still be received. The `end` event is emitted and the callback
 is called once all transfers have completed or canceled.
 
-### Event: data(data : Buffer)
+#### Event: data(data : Buffer)
 Emitted with data received by the polling transfers
 
-### Event: error(error)
+#### Event: error(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.
 
-### Event: end
+#### Event: end
 Emitted when polling has been canceled
 
-OutEndpoint
------------
-
+### OutEndpoint
 Endpoints in the OUT direction (PC->device) have this type.
 
-### .transfer(data, callback(error))
+#### .transfer(data, callback(error))
 Perform a transfer to write `data` to the endpoint.
 
 If length is greater than maxPacketSize, libusb will automatically split the transfer in multiple packets, and you will receive one callback once all packets are complete.
 
 `this` in the callback is the OutEndpoint object.
 
-### Event: error(error)
+#### Event: error(error)
 Emitted when the stream encounters an error.
 
-### Event: end
+#### Event: end
 Emitted when the stream has been stopped and all pending requests have been completed.
 
+### UsbDetection
 
-UsbDetection
-------------
-
-### usb.on('attach', function(device) { ... });
+#### usb.on('attach', function(device) { ... });
 Attaches a callback to plugging in a `device`.
 
-### usb.on('detach', function(device) { ... });
+#### usb.on('detach', function(device) { ... });
 Attaches a callback to unplugging a `device`.
 
-### usb.refHotplugEvents();
+#### usb.refHotplugEvents();
 Restore (re-reference) the hotplug events unreferenced by `unrefHotplugEvents()`
 
-### usb.unrefHotplugEvents();
+#### usb.unrefHotplugEvents();
 Listening to events will prevent the process to exit. By calling this function, hotplug events will be unreferenced by the event loop, allowing the process to exit even when listening for the `attach` and `detach` events.
 
+# Development
+The library is based on native bindings wrapping the [libusb](https://github.com/libusb/libusb) library.
 
-Development and testing
-=======================
-
-To build from git:
+## Setup
+Libusb is included as a submodule, clone this repository and then the submodule as follows:
 
-	git clone --recursive https://github.com/node-usb/node-usb.git
-	cd node-usb
-	npm install
+```bash
+git clone https://github.com/node-usb/node-usb
+cd node-usb
+git submodule update --init
+```
 
-To execute the unit tests, [CoffeeScript](http://coffeescript.org) is required. Run
+## Building
+The package uses `yarn` for the typescript code and `prebuildify` to generate the native binaries. These can be executed as follows:
 
-	npm test
+```bash
+yarn
+yarn prebuild
+```
 
-Some tests require an [attached STM32F103 Microprocessor USB device with specific firmware](https://github.com/thegecko/node-usb-test-firmware).
+__Note:__ On Linux, you'll need libudev to build libusb. On Ubuntu/Debian:
 
-	npm run --silent full-test
-	npm run --silent valgrind
+```bash
+sudo apt-get install build-essential libudev-dev
+```
 
-Limitations
-===========
-
-Does not support:
+## Testing
+To execute the unit tests, Run:
 
-  - Configurations other than the default one
-  - Isochronous transfers
+```bash
+yarn test
+```
 
-License
-=======
+Some tests require an [attached STM32F103 Microprocessor USB device with specific firmware](https://github.com/node-usb/node-usb-test-firmware).
 
-MIT
+```bash
+yarn full-test
+yarn valgrind
+```
 
-Note that the compiled Node extension includes Libusb, and is thus subject to the LGPL.
+## Releasing
+Please refer to the [Wiki](https://github.com/node-usb/node-usb/wiki/Release-Process) for release instructions.