usb 1.9.2 → 2.0.2

package/dist/usb/device.d.ts

@@ -0,0 +1,94 @@
+/// <reference types="node" />
+import * as usb from './bindings';
+import { Interface } from './interface';
+import { Capability } from './capability';
+import { BosDescriptor, ConfigDescriptor } from './descriptors';
+export declare class ExtendedDevice {
+    /**
+     * List of Interface objects for the interfaces of the default configuration of the device.
+     */
+    interfaces: Interface[] | undefined;
+    private _timeout;
+    /**
+     * Timeout in milliseconds to use for control transfers.
+     */
+    get timeout(): number;
+    set timeout(value: number);
+    /**
+     * Object with properties for the fields of the active configuration descriptor.
+     */
+    get configDescriptor(): ConfigDescriptor | undefined;
+    /**
+     * Contains all config descriptors of the device (same structure as .configDescriptor above)
+     */
+    get allConfigDescriptors(): ConfigDescriptor[];
+    /**
+     * Contains the parent of the device, such as a hub. If there is no parent this property is set to `null`.
+     */
+    get parent(): usb.Device;
+    /**
+     * Open the device.
+     * @param defaultConfig
+     */
+    open(this: usb.Device, defaultConfig?: boolean): void;
+    /**
+     * Close the device.
+     *
+     * The device must be open to use this method.
+     */
+    close(this: usb.Device): void;
+    /**
+     * 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.
+     *
+     * The device must be open to use this method.
+     * @param desired
+     * @param callback
+     */
+    setConfiguration(this: usb.Device, desired: number, callback?: (error: usb.LibUSBException | undefined) => void): void;
+    /**
+     * Perform a control transfer with `libusb_control_transfer`.
+     *
+     * Parameter `data_or_length` can be an 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.
+     *
+     * The `data` parameter of the callback is actual transferred for OUT transfers, or will be passed a Buffer for IN transfers.
+     *
+     * The device must be open to use this method.
+     * @param bmRequestType
+     * @param bRequest
+     * @param wValue
+     * @param wIndex
+     * @param data_or_length
+     * @param callback
+     */
+    controlTransfer(this: usb.Device, bmRequestType: number, bRequest: number, wValue: number, wIndex: number, data_or_length: number | Buffer, callback?: (error: usb.LibUSBException | undefined, buffer: Buffer | number | undefined) => void): usb.Device;
+    /**
+     * Return the interface with the specified interface number.
+     *
+     * The device must be open to use this method.
+     * @param addr
+     */
+    interface(this: usb.Device, addr: number): Interface;
+    /**
+     * Perform a control transfer to retrieve a string descriptor
+     *
+     * The device must be open to use this method.
+     * @param desc_index
+     * @param callback
+     */
+    getStringDescriptor(this: usb.Device, desc_index: number, callback: (error?: usb.LibUSBException, value?: string) => void): void;
+    /**
+     * Perform a control transfer to retrieve an object with properties for the fields of the Binary Object Store descriptor.
+     *
+     * The device must be open to use this method.
+     * @param callback
+     */
+    getBosDescriptor(this: usb.Device, callback: (error?: usb.LibUSBException, descriptor?: BosDescriptor) => void): void;
+    /**
+     * Retrieve a list of Capability objects for the Binary Object Store capabilities of the device.
+     *
+     * The device must be open to use this method.
+     * @param callback
+     */
+    getCapabilities(this: usb.Device, callback: (error: usb.LibUSBException | undefined, capabilities?: Capability[]) => void): void;
+}

package/dist/usb/device.js

@@ -0,0 +1,300 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtendedDevice = void 0;
+var usb = require("./bindings");
+var interface_1 = require("./interface");
+var capability_1 = require("./capability");
+var isBuffer = function (obj) { return !!obj && obj instanceof Uint8Array; };
+var DEFAULT_TIMEOUT = 1000;
+var ExtendedDevice = /** @class */ (function () {
+    function ExtendedDevice() {
+        this._timeout = DEFAULT_TIMEOUT;
+    }
+    Object.defineProperty(ExtendedDevice.prototype, "timeout", {
+        /**
+         * Timeout in milliseconds to use for control transfers.
+         */
+        get: function () {
+            return this._timeout || DEFAULT_TIMEOUT;
+        },
+        set: function (value) {
+            this._timeout = value;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ExtendedDevice.prototype, "configDescriptor", {
+        /**
+         * Object with properties for the fields of the active configuration descriptor.
+         */
+        get: function () {
+            try {
+                return this.__getConfigDescriptor();
+            }
+            catch (e) {
+                // Check descriptor exists
+                if (e.errno === usb.LIBUSB_ERROR_NOT_FOUND) {
+                    return undefined;
+                }
+                throw e;
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ExtendedDevice.prototype, "allConfigDescriptors", {
+        /**
+         * Contains all config descriptors of the device (same structure as .configDescriptor above)
+         */
+        get: function () {
+            try {
+                return this.__getAllConfigDescriptors();
+            }
+            catch (e) {
+                // Check descriptors exist
+                if (e.errno === usb.LIBUSB_ERROR_NOT_FOUND) {
+                    return [];
+                }
+                throw e;
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ExtendedDevice.prototype, "parent", {
+        /**
+         * Contains the parent of the device, such as a hub. If there is no parent this property is set to `null`.
+         */
+        get: function () {
+            return this.__getParent();
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Open the device.
+     * @param defaultConfig
+     */
+    ExtendedDevice.prototype.open = function (defaultConfig) {
+        if (defaultConfig === void 0) { defaultConfig = true; }
+        this.__open();
+        if (defaultConfig === false) {
+            return;
+        }
+        this.interfaces = [];
+        var len = this.configDescriptor ? this.configDescriptor.interfaces.length : 0;
+        for (var i = 0; i < len; i++) {
+            this.interfaces[i] = new interface_1.Interface(this, i);
+        }
+    };
+    /**
+     * Close the device.
+     *
+     * The device must be open to use this method.
+     */
+    ExtendedDevice.prototype.close = function () {
+        this.__close();
+        this.interfaces = undefined;
+    };
+    /**
+     * 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.
+     *
+     * The device must be open to use this method.
+     * @param desired
+     * @param callback
+     */
+    ExtendedDevice.prototype.setConfiguration = function (desired, callback) {
+        var _this = this;
+        this.__setConfiguration(desired, function (error) {
+            if (!error) {
+                _this.interfaces = [];
+                var len = _this.configDescriptor ? _this.configDescriptor.interfaces.length : 0;
+                for (var i = 0; i < len; i++) {
+                    _this.interfaces[i] = new interface_1.Interface(_this, i);
+                }
+            }
+            if (callback) {
+                callback.call(_this, error);
+            }
+        });
+    };
+    /**
+     * Perform a control transfer with `libusb_control_transfer`.
+     *
+     * Parameter `data_or_length` can be an 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.
+     *
+     * The `data` parameter of the callback is actual transferred for OUT transfers, or will be passed a Buffer for IN transfers.
+     *
+     * The device must be open to use this method.
+     * @param bmRequestType
+     * @param bRequest
+     * @param wValue
+     * @param wIndex
+     * @param data_or_length
+     * @param callback
+     */
+    ExtendedDevice.prototype.controlTransfer = function (bmRequestType, bRequest, wValue, wIndex, data_or_length, callback) {
+        var _this = this;
+        var isIn = !!(bmRequestType & usb.LIBUSB_ENDPOINT_IN);
+        var wLength = isIn ? data_or_length : data_or_length.length;
+        if (isIn) {
+            if (!(data_or_length >= 0)) {
+                throw new TypeError('Expected size number for IN transfer (based on bmRequestType)');
+            }
+        }
+        else {
+            if (!isBuffer(data_or_length)) {
+                throw new TypeError('Expected buffer for OUT transfer (based on bmRequestType)');
+            }
+        }
+        // Buffer for the setup packet
+        // http://libusbx.sourceforge.net/api-1.0/structlibusb__control__setup.html
+        var buf = Buffer.alloc(wLength + usb.LIBUSB_CONTROL_SETUP_SIZE);
+        buf.writeUInt8(bmRequestType, 0);
+        buf.writeUInt8(bRequest, 1);
+        buf.writeUInt16LE(wValue, 2);
+        buf.writeUInt16LE(wIndex, 4);
+        buf.writeUInt16LE(wLength, 6);
+        if (!isIn) {
+            buf.set(data_or_length, usb.LIBUSB_CONTROL_SETUP_SIZE);
+        }
+        var transfer = new usb.Transfer(this, 0, usb.LIBUSB_TRANSFER_TYPE_CONTROL, this.timeout, function (error, buf, actual) {
+            if (callback) {
+                if (isIn) {
+                    callback.call(_this, error, buf.slice(usb.LIBUSB_CONTROL_SETUP_SIZE, usb.LIBUSB_CONTROL_SETUP_SIZE + actual));
+                }
+                else {
+                    callback.call(_this, error, actual);
+                }
+            }
+        });
+        try {
+            transfer.submit(buf);
+        }
+        catch (e) {
+            if (callback) {
+                process.nextTick(function () { return callback.call(_this, e, undefined); });
+            }
+        }
+        return this;
+    };
+    /**
+     * Return the interface with the specified interface number.
+     *
+     * The device must be open to use this method.
+     * @param addr
+     */
+    ExtendedDevice.prototype.interface = function (addr) {
+        if (!this.interfaces) {
+            throw new Error('Device must be open before searching for interfaces');
+        }
+        addr = addr || 0;
+        for (var i = 0; i < this.interfaces.length; i++) {
+            if (this.interfaces[i].interfaceNumber === addr) {
+                return this.interfaces[i];
+            }
+        }
+        throw new Error("Interface not found for address: " + addr);
+    };
+    /**
+     * Perform a control transfer to retrieve a string descriptor
+     *
+     * The device must be open to use this method.
+     * @param desc_index
+     * @param callback
+     */
+    ExtendedDevice.prototype.getStringDescriptor = function (desc_index, callback) {
+        var langid = 0x0409;
+        var length = 255;
+        this.controlTransfer(usb.LIBUSB_ENDPOINT_IN, usb.LIBUSB_REQUEST_GET_DESCRIPTOR, ((usb.LIBUSB_DT_STRING << 8) | desc_index), langid, length, function (error, buffer) {
+            if (error) {
+                return callback(error);
+            }
+            callback(undefined, isBuffer(buffer) ? buffer.toString('utf16le', 2) : undefined);
+        });
+    };
+    /**
+     * Perform a control transfer to retrieve an object with properties for the fields of the Binary Object Store descriptor.
+     *
+     * The device must be open to use this method.
+     * @param callback
+     */
+    ExtendedDevice.prototype.getBosDescriptor = function (callback) {
+        var _this = this;
+        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, undefined);
+        }
+        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, undefined);
+                return callback(error, undefined);
+            }
+            if (!isBuffer(buffer)) {
+                return callback(undefined, undefined);
+            }
+            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, undefined);
+                    return callback(error, undefined);
+                }
+                if (!isBuffer(buffer)) {
+                    return callback(undefined, undefined);
+                }
+                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),
+                        dev_capability_data: buffer.slice(i + 3, i + buffer.readUInt8(i + 0))
+                    };
+                    descriptor.capabilities.push(capability);
+                    i += capability.bLength;
+                }
+                // Cache descriptor
+                _this._bosDescriptor = descriptor;
+                callback(undefined, _this._bosDescriptor);
+            });
+        });
+    };
+    /**
+     * Retrieve a list of Capability objects for the Binary Object Store capabilities of the device.
+     *
+     * The device must be open to use this method.
+     * @param callback
+     */
+    ExtendedDevice.prototype.getCapabilities = function (callback) {
+        var _this = this;
+        var capabilities = [];
+        this.getBosDescriptor(function (error, descriptor) {
+            if (error)
+                return callback(error, undefined);
+            var len = descriptor ? descriptor.capabilities.length : 0;
+            for (var i = 0; i < len; i++) {
+                capabilities.push(new capability_1.Capability(_this, i));
+            }
+            callback(undefined, capabilities);
+        });
+    };
+    return ExtendedDevice;
+}());
+exports.ExtendedDevice = ExtendedDevice;
+//# sourceMappingURL=device.js.map

package/dist/usb/device.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"device.js","sourceRoot":"","sources":["../../tsc/usb/device.ts"],"names":[],"mappings":";;;AAAA,gCAAkC;AAClC,yCAAwC;AACxC,2CAA0C;AAG1C,IAAM,QAAQ,GAAG,UAAC,GAAoC,IAAwB,OAAA,CAAC,CAAC,GAAG,IAAI,GAAG,YAAY,UAAU,EAAlC,CAAkC,CAAC;AACjH,IAAM,eAAe,GAAG,IAAI,CAAC;AAE7B;IAAA;QAMY,aAAQ,GAAG,eAAe,CAAC;IAsTvC,CAAC;IAlTG,sBAAW,mCAAO;QAHlB;;WAEG;aACH;YACI,OAAO,IAAI,CAAC,QAAQ,IAAI,eAAe,CAAC;QAC5C,CAAC;aACD,UAAmB,KAAa;YAC5B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QAC1B,CAAC;;;OAHA;IAQD,sBAAW,4CAAgB;QAH3B;;WAEG;aACH;YACI,IAAI;gBACA,OAAQ,IAA8B,CAAC,qBAAqB,EAAE,CAAC;aAClE;YAAC,OAAO,CAAC,EAAE;gBACR,0BAA0B;gBAC1B,IAAI,CAAC,CAAC,KAAK,KAAK,GAAG,CAAC,sBAAsB,EAAE;oBACxC,OAAO,SAAS,CAAC;iBACpB;gBACD,MAAM,CAAC,CAAC;aACX;QACL,CAAC;;;OAAA;IAKD,sBAAW,gDAAoB;QAH/B;;WAEG;aACH;YACI,IAAI;gBACA,OAAQ,IAA8B,CAAC,yBAAyB,EAAE,CAAC;aACtE;YAAC,OAAO,CAAC,EAAE;gBACR,0BAA0B;gBAC1B,IAAI,CAAC,CAAC,KAAK,KAAK,GAAG,CAAC,sBAAsB,EAAE;oBACxC,OAAO,EAAE,CAAC;iBACb;gBACD,MAAM,CAAC,CAAC;aACX;QACL,CAAC;;;OAAA;IAKD,sBAAW,kCAAM;QAHjB;;WAEG;aACH;YACI,OAAQ,IAA8B,CAAC,WAAW,EAAE,CAAC;QACzD,CAAC;;;OAAA;IAED;;;OAGG;IACI,6BAAI,GAAX,UAA8B,aAAoB;QAApB,8BAAA,EAAA,oBAAoB;QAC9C,IAAI,CAAC,MAAM,EAAE,CAAC;QACd,IAAI,aAAa,KAAK,KAAK,EAAE;YACzB,OAAO;SACV;QACD,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAM,GAAG,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAChF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE;YAC1B,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,qBAAS,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;SAC/C;IACL,CAAC;IAED;;;;OAIG;IACI,8BAAK,GAAZ;QACI,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAChC,CAAC;IAED;;;;;;;OAOG;IACI,yCAAgB,GAAvB,UAA0C,OAAe,EAAE,QAA2D;QAAtH,iBAaC;QAZG,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,UAAA,KAAK;YAClC,IAAI,CAAC,KAAK,EAAE;gBACR,KAAI,CAAC,UAAU,GAAG,EAAE,CAAC;gBACrB,IAAM,GAAG,GAAG,KAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,KAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;gBAChF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE;oBAC1B,KAAI,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,qBAAS,CAAC,KAAI,EAAE,CAAC,CAAC,CAAC;iBAC/C;aACJ;YACD,IAAI,QAAQ,EAAE;gBACV,QAAQ,CAAC,IAAI,CAAC,KAAI,EAAE,KAAK,CAAC,CAAC;aAC9B;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,wCAAe,GAAtB,UAAyC,aAAqB,EAAE,QAAgB,EAAE,MAAc,EAAE,MAAc,EAAE,cAA+B,EAC7I,QAAgG;QADpG,iBAgDC;QA9CG,IAAM,IAAI,GAAG,CAAC,CAAC,CAAC,aAAa,GAAG,GAAG,CAAC,kBAAkB,CAAC,CAAC;QACxD,IAAM,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,cAAwB,CAAC,CAAC,CAAE,cAAyB,CAAC,MAAM,CAAC;QAEpF,IAAI,IAAI,EAAE;YACN,IAAI,CAAC,CAAC,cAAc,IAAI,CAAC,CAAC,EAAE;gBACxB,MAAM,IAAI,SAAS,CAAC,+DAA+D,CAAC,CAAC;aACxF;SACJ;aAAM;YACH,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE;gBAC3B,MAAM,IAAI,SAAS,CAAC,2DAA2D,CAAC,CAAC;aACpF;SACJ;QAED,8BAA8B;QAC9B,2EAA2E;QAC3E,IAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,GAAG,GAAG,CAAC,yBAAyB,CAAC,CAAC;QAClE,GAAG,CAAC,UAAU,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;QACjC,GAAG,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;QAC5B,GAAG,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC7B,GAAG,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC7B,GAAG,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QAE9B,IAAI,CAAC,IAAI,EAAE;YACP,GAAG,CAAC,GAAG,CAAC,cAAwB,EAAE,GAAG,CAAC,yBAAyB,CAAC,CAAC;SACpE;QAED,IAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,4BAA4B,EAAE,IAAI,CAAC,OAAO,EACrF,UAAC,KAAK,EAAE,GAAG,EAAE,MAAM;YACf,IAAI,QAAQ,EAAE;gBACV,IAAI,IAAI,EAAE;oBACN,QAAQ,CAAC,IAAI,CAAC,KAAI,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,yBAAyB,EAAE,GAAG,CAAC,yBAAyB,GAAG,MAAM,CAAC,CAAC,CAAC;iBAChH;qBAAM;oBACH,QAAQ,CAAC,IAAI,CAAC,KAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;iBACtC;aACJ;QACL,CAAC,CACJ,CAAC;QAEF,IAAI;YACA,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SACxB;QAAC,OAAO,CAAC,EAAE;YACR,IAAI,QAAQ,EAAE;gBACV,OAAO,CAAC,QAAQ,CAAC,cAAM,OAAA,QAAQ,CAAC,IAAI,CAAC,KAAI,EAAE,CAAC,EAAE,SAAS,CAAC,EAAjC,CAAiC,CAAC,CAAC;aAC7D;SACJ;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACI,kCAAS,GAAhB,UAAmC,IAAY;QAC3C,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;SAC1E;QAED,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC;QACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC7C,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,eAAe,KAAK,IAAI,EAAE;gBAC7C,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;aAC7B;SACJ;QAED,MAAM,IAAI,KAAK,CAAC,sCAAoC,IAAM,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;OAMG;IACI,4CAAmB,GAA1B,UAA6C,UAAkB,EAAE,QAA+D;QAC5H,IAAM,MAAM,GAAG,MAAM,CAAC;QACtB,IAAM,MAAM,GAAG,GAAG,CAAC;QACnB,IAAI,CAAC,eAAe,CAChB,GAAG,CAAC,kBAAkB,EACtB,GAAG,CAAC,6BAA6B,EACjC,CAAC,CAAC,GAAG,CAAC,gBAAgB,IAAI,CAAC,CAAC,GAAG,UAAU,CAAC,EAC1C,MAAM,EACN,MAAM,EACN,UAAC,KAAK,EAAE,MAAM;YACV,IAAI,KAAK,EAAE;gBACP,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC;aAC1B;YACD,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QACtF,CAAC,CACJ,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACI,yCAAgB,GAAvB,UAA0C,QAA2E;QAArH,iBA0EC;QAzEG,IAAI,IAAI,CAAC,cAAc,EAAE;YACrB,oBAAoB;YACpB,OAAO,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;SACnD;QAED,IAAI,IAAI,CAAC,gBAAgB,CAAC,MAAM,GAAG,KAAK,EAAE;YACtC,uCAAuC;YACvC,OAAO,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;SACzC;QAED,IAAI,CAAC,eAAe,CAChB,GAAG,CAAC,kBAAkB,EACtB,GAAG,CAAC,6BAA6B,EACjC,CAAC,GAAG,CAAC,aAAa,IAAI,CAAC,CAAC,EACxB,CAAC,EACD,GAAG,CAAC,kBAAkB,EACtB,UAAC,KAAK,EAAE,MAAM;YACV,IAAI,KAAK,EAAE;gBACP,8BAA8B;gBAC9B,IAAI,KAAK,CAAC,KAAK,KAAK,GAAG,CAAC,qBAAqB;oBAAE,OAAO,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;gBACrF,OAAO,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;aACrC;YAED,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;gBACnB,OAAO,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;aACzC;YAED,IAAM,WAAW,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAC3C,KAAI,CAAC,eAAe,CAChB,GAAG,CAAC,kBAAkB,EACtB,GAAG,CAAC,6BAA6B,EACjC,CAAC,GAAG,CAAC,aAAa,IAAI,CAAC,CAAC,EACxB,CAAC,EACD,WAAW,EACX,UAAC,KAAK,EAAE,MAAM;gBACV,IAAI,KAAK,EAAE;oBACP,8BAA8B;oBAC9B,IAAI,KAAK,CAAC,KAAK,KAAK,GAAG,CAAC,qBAAqB;wBAAE,OAAO,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;oBACrF,OAAO,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;iBACrC;gBAED,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;oBACnB,OAAO,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;iBACzC;gBAED,IAAM,UAAU,GAAkB;oBAC9B,OAAO,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;oBAC5B,eAAe,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;oBACpC,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;oBACpC,cAAc,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;oBACnC,YAAY,EAAE,EAAE;iBACnB,CAAC;gBAEF,IAAI,CAAC,GAAG,GAAG,CAAC,kBAAkB,CAAC;gBAC/B,OAAO,CAAC,GAAG,UAAU,CAAC,YAAY,EAAE;oBAChC,IAAM,UAAU,GAAG;wBACf,OAAO,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC;wBAChC,eAAe,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC;wBACxC,kBAAkB,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC;wBAC3C,mBAAmB,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;qBACxE,CAAC;oBAEF,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;oBACzC,CAAC,IAAI,UAAU,CAAC,OAAO,CAAC;iBAC3B;gBAED,mBAAmB;gBACnB,KAAI,CAAC,cAAc,GAAG,UAAU,CAAC;gBACjC,QAAQ,CAAC,SAAS,EAAE,KAAI,CAAC,cAAc,CAAC,CAAC;YAC7C,CAAC,CACJ,CAAC;QACN,CAAC,CACJ,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACI,wCAAe,GAAtB,UAAyC,QAAuF;QAAhI,iBAaC;QAZG,IAAM,YAAY,GAAiB,EAAE,CAAC;QAEtC,IAAI,CAAC,gBAAgB,CAAC,UAAC,KAAK,EAAE,UAAU;YACpC,IAAI,KAAK;gBAAE,OAAO,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;YAE7C,IAAM,GAAG,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE;gBAC1B,YAAY,CAAC,IAAI,CAAC,IAAI,uBAAU,CAAC,KAAI,EAAE,CAAC,CAAC,CAAC,CAAC;aAC9C;YAED,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;IACP,CAAC;IACL,qBAAC;AAAD,CAAC,AA5TD,IA4TC;AA5TY,wCAAc"}

package/dist/usb/endpoint.d.ts

@@ -0,0 +1,91 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import { LibUSBException, Transfer, Device } from './bindings';
+import { EndpointDescriptor } from './descriptors';
+/** Common base for InEndpoint and OutEndpoint. */
+export declare abstract class Endpoint extends EventEmitter {
+    protected device: Device;
+    address: number;
+    /** Endpoint direction: `"in"` or `"out"`. */
+    abstract direction: 'in' | 'out';
+    /** Endpoint type: `usb.LIBUSB_TRANSFER_TYPE_BULK`, `usb.LIBUSB_TRANSFER_TYPE_INTERRUPT`, or `usb.LIBUSB_TRANSFER_TYPE_ISOCHRONOUS`. */
+    transferType: number;
+    /** Sets the timeout in milliseconds for transfers on this endpoint. The default, `0`, is infinite timeout. */
+    timeout: number;
+    /** Object with fields from the endpoint descriptor -- see libusb documentation or USB spec. */
+    descriptor: EndpointDescriptor;
+    constructor(device: Device, descriptor: EndpointDescriptor);
+    /** Clear the halt/stall condition for this endpoint. */
+    clearHalt(callback: (error: LibUSBException | undefined) => void): void;
+    /**
+     * Create a new `Transfer` object for this endpoint.
+     *
+     * The passed callback will be called when the transfer is submitted and finishes. Its arguments are the error (if any), the submitted buffer, and the amount of data actually written (for
+     * OUT transfers) or read (for IN transfers).
+     *
+     * @param timeout Timeout for the transfer (0 means unlimited).
+     * @param callback Transfer completion callback.
+     */
+    makeTransfer(timeout: number, callback: (error: LibUSBException | undefined, buffer: Buffer, actualLength: number) => void): Transfer;
+}
+/** Endpoints in the IN direction (device->PC) have this type. */
+export declare class InEndpoint extends Endpoint {
+    /** Endpoint direction. */
+    direction: 'in' | 'out';
+    protected pollTransfers: Transfer[] | undefined;
+    protected pollTransferSize: number;
+    protected pollPending: number;
+    pollActive: boolean;
+    constructor(device: Device, descriptor: EndpointDescriptor);
+    /**
+     * 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.
+     *
+     * The device must be open to use this method.
+     * @param length
+     * @param callback
+     */
+    transfer(length: number, callback: (error: LibUSBException | undefined, data?: Buffer) => void): InEndpoint;
+    /**
+     * Start polling the endpoint.
+     *
+     * The library will keep `nTransfers` transfers of size `transferSize` pending in 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.
+     *
+     * The device must be open to use this method.
+     * @param nTransfers
+     * @param transferSize
+     */
+    startPoll(nTransfers?: number, transferSize?: number, _callback?: (error: LibUSBException | undefined, buffer: Buffer, actualLength: number) => void): Transfer[];
+    protected startPollTransfers(nTransfers: number | undefined, transferSize: number | undefined, callback: (error: LibUSBException | undefined, buffer: Buffer, actualLength: number) => void): Transfer[];
+    /**
+     * 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.
+     *
+     * The device must be open to use this method.
+     * @param callback
+     */
+    stopPoll(callback?: () => void): void;
+}
+/** Endpoints in the OUT direction (PC->device) have this type. */
+export declare class OutEndpoint extends Endpoint {
+    /** Endpoint direction. */
+    direction: 'in' | 'out';
+    /**
+     * 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.
+     *
+     * The device must be open to use this method.
+     * @param buffer
+     * @param callback
+     */
+    transfer(buffer: Buffer, callback?: (error: LibUSBException | undefined, actual: number) => void): OutEndpoint;
+    transferWithZLP(buffer: Buffer, callback: (error: LibUSBException | undefined) => void): void;
+}