usb 2.4.3 → 2.5.0

package/.gitmodules

@@ -1,3 +1,3 @@
 [submodule "libusb"]
-	path = libusb
-	url = https://github.com/libusb/libusb.git
+    path = libusb
+    url = https://github.com/libusb/libusb.git

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## [2.5.0] - 2022-07-30
+
+### Fixed
+- Native USB device plug/unplug detection on Windows - [`524`](https://github.com/node-usb/node-usb/pull/524) ([Julian Waller](https://github.com/Julusian))
+
 ## [2.4.3] - 2022-06-21
 
 ### Fixed

package/README.md

@@ -547,6 +547,40 @@ Restore (re-reference) the hotplug events unreferenced by `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.
 
+# Migrating from node-usb-detection
+
+If you have been referred here by `node-usb-detection`, the following may be helpful for you to update your existing code.
+
+## usbDetect.startMonitoring() & usbDetect.stopMonitoring()
+
+There is no direct equivalent to these methods. This is handled automatically for you when you add and remove event listeners.
+
+You may find `usb.unrefHotplugEvents()` useful as it is intended to help with exit conditions.
+
+## usbDetect.find()
+
+You can instead use `usb.getDeviceList()`. Be aware that this will do an enumeration to find all of the devices, and not look at a cache of the known devices. If you call it too often it may have a performance impact.
+
+To find a specific device by vid and pid, call `usb.findByIds`. e.g. `usb.findByIds(0x12, 0x34)`.
+
+## usbDetect.on('add', function(device) { ... })
+
+These should be changed to `usb.on('attach', function(device) { ... })`.
+
+There is no equivalent to filter based on the vid or pid, instead you should do a check inside the callback you provide.  
+The contents of the device object has also changed.
+
+## usbDetect.on('remove', function(device) { ... })
+
+These should be changed to `usb.on('detach', function(device) { ... })`.
+
+There is no equivalent to filter based on the vid or pid, instead you should do a check inside the callback you provide.  
+The contents of the device object has also changed.
+
+## usbDetect.on('change', function(device) { ... })
+
+There is no direct equivalent to this. Instead you can listen to both `attach` and `detach` to get the same behaviour.
+
 # Development
 The library is based on native bindings wrapping the [libusb](https://github.com/libusb/libusb) library.
 

package/binding.gyp

@@ -1,25 +1,32 @@
 {
   'variables': {
     'use_udev%': 1,
-    'use_system_libusb%': 'false',
+    'use_system_libusb%': 'false'
   },
   'targets': [
     {
       'target_name': 'usb_bindings',
-      'cflags!': [ '-fno-exceptions' ],
-      'cflags_cc!': [ '-fno-exceptions' ],
-      'xcode_settings': { 'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',
+      'cflags!': [
+        '-fno-exceptions'
+      ],
+      'cflags_cc!': [
+        '-fno-exceptions'
+      ],
+      'xcode_settings': {
+        'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',
         'CLANG_CXX_LIBRARY': 'libc++',
-        'MACOSX_DEPLOYMENT_TARGET': '10.7',
+        'MACOSX_DEPLOYMENT_TARGET': '10.7'
       },
       'msvs_settings': {
-        'VCCLCompilerTool': { 'ExceptionHandling': 1 },
+        'VCCLCompilerTool': {
+          'ExceptionHandling': 1
+        }
       },
       'sources': [
-        './src/node_usb.cc',
-        './src/device.cc',
-        './src/transfer.cc',
-        './src/thread_name.cc',
+        'src/node_usb.cc',
+        'src/device.cc',
+        'src/transfer.cc',
+        'src/thread_name.cc'
       ],
       'cflags_cc': [
         '-std=c++14'
@@ -27,7 +34,7 @@
       'defines': [
         '_FILE_OFFSET_BITS=64',
         '_LARGEFILE_SOURCE',
-        'NAPI_VERSION=6',
+        'NAPI_VERSION=6'
       ],
       'include_dirs+': [
         'src/',
@@ -37,7 +44,7 @@
           ['use_system_libusb=="false" and OS!="freebsd"', {
             'dependencies': [
               'libusb.gypi:libusb',
-            ],
+            ]
           }],
           ['use_system_libusb=="true" or OS=="freebsd"', {
             'include_dirs+': [
@@ -45,7 +52,7 @@
             ],
             'libraries': [
               '<!@(pkg-config libusb-1.0 --libs)'
-            ],
+            ]
           }],
           ['OS=="mac"', {
             'xcode_settings': {
@@ -62,40 +69,56 @@
                 '-arch arm64'
               ],
               'SDKROOT': 'macosx',
-              'MACOSX_DEPLOYMENT_TARGET': '10.7',
-            },
+              'MACOSX_DEPLOYMENT_TARGET': '10.7'
+            }
+          }],
+          ['OS!="win"', {
+            'sources': [
+              'src/hotplug/libusb.cc'
+            ],
           }],
           ['OS=="win"', {
+            'sources': [
+              'src/hotplug/windows.cc'
+            ],
             'defines':[
               'WIN32_LEAN_AND_MEAN'
             ],
+            'libraries': [
+              'cfgmgr32.lib'
+            ],
             'default_configuration': 'Debug',
             'configurations': {
               'Debug': {
-                'defines': [ 'DEBUG', '_DEBUG' ],
+                'defines': [
+                  'DEBUG',
+                  '_DEBUG'
+                ],
                 'msvs_settings': {
                   'VCCLCompilerTool': {
                     'RuntimeLibrary': 1, # static debug
-                  },
-                },
+                  }
+                }
               },
               'Release': {
-                'defines': [ 'NDEBUG' ],
+                'defines': [
+                  'NDEBUG'
+                ],
                 'msvs_settings': {
                   'VCCLCompilerTool': {
                     'RuntimeLibrary': 0, # static release
-                  },
-                },
+                  }
+                }
               }
             },
             'msvs_settings': {
               'VCCLCompilerTool': {
-                'AdditionalOptions': [ '/EHsc' ],
-              },
-            },
+                'AdditionalOptions': [ '/EHsc' ]
+              }
+            }
           }
         ]
       ]
-    },
+    }
   ]
 }

package/dist/usb/bindings.d.ts

@@ -17,6 +17,7 @@ export declare function setDebugLevel(level: number): void;
  * Use USBDK Backend (Windows only)
  */
 export declare function useUsbDkBackend(): void;
+export declare function _supportedHotplugEvents(): number;
 export declare function _enableHotplugEvents(): void;
 export declare function _disableHotplugEvents(): void;
 export declare function _getLibusbCapability(capability: number): number;

package/dist/usb/index.d.ts

@@ -10,6 +10,8 @@ declare module './bindings' {
     interface DeviceEvents extends EventListeners<DeviceEvents> {
         attach: Device;
         detach: Device;
+        attachIds: undefined;
+        detachIds: undefined;
     }
     function addListener<K extends keyof DeviceEvents>(event: K, listener: (arg: DeviceEvents[K]) => void): void;
     function removeListener<K extends keyof DeviceEvents>(event: K, listener: (arg: DeviceEvents[K]) => void): void;

package/dist/usb/index.js

@@ -21,21 +21,13 @@ Object.setPrototypeOf(usb, events_1.EventEmitter.prototype);
 Object.getOwnPropertyNames(device_1.ExtendedDevice.prototype).forEach(function (name) {
     Object.defineProperty(usb.Device.prototype, name, Object.getOwnPropertyDescriptor(device_1.ExtendedDevice.prototype, name) || Object.create(null));
 });
-// Polling mechanism for discovering device changes until this is fixed:
-// https://github.com/libusb/libusb/issues/86
+// Polling mechanism for discovering device changes where hotplug detection is not available
 var pollTimeout = 500;
-var hotplugSupported = usb._getLibusbCapability(usb.LIBUSB_CAP_HAS_HOTPLUG) > 0;
+var hotplugSupported = usb._supportedHotplugEvents();
 var pollingHotplug = false;
 var pollDevices = new Set();
-var pollHotplug = function (start) {
+var pollHotplugOnce = function (start) {
     var e_1, _a, e_2, _b;
-    if (start === void 0) { start = false; }
-    if (start) {
-        pollingHotplug = true;
-    }
-    else if (!pollingHotplug) {
-        return;
-    }
     // Collect current devices
     var devices = new Set(usb.getDeviceList());
     if (!start) {
@@ -71,10 +63,30 @@ var pollHotplug = function (start) {
         }
     }
     pollDevices = devices;
+};
+var pollHotplugLoop = function (start) {
+    if (start === void 0) { start = false; }
+    if (start) {
+        pollingHotplug = true;
+    }
+    else if (!pollingHotplug) {
+        return;
+    }
+    pollHotplugOnce(start);
     setTimeout(function () {
-        pollHotplug();
+        pollHotplugLoop();
     }, pollTimeout);
 };
+var hotplugModeIsIdsOnly = hotplugSupported === 2;
+if (hotplugModeIsIdsOnly) {
+    // The hotplug backend doesnt emit 'attach' or 'detach', so we need to do some conversion
+    var hotplugEventConversion = function () {
+        // Future: This might want a debounce, to avoid doing multiple polls when attaching a usb hub or something
+        pollHotplugOnce(false);
+    };
+    usb.on('attachIds', hotplugEventConversion);
+    usb.on('detachIds', hotplugEventConversion);
+}
 usb.on('newListener', function (event) {
     if (event !== 'attach' && event !== 'detach') {
         return;
@@ -85,7 +97,7 @@ usb.on('newListener', function (event) {
             usb._enableHotplugEvents();
         }
         else {
-            pollHotplug(true);
+            pollHotplugLoop(true);
         }
     }
 });

package/dist/usb/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../tsc/usb/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iCAAsC;AACtC,mCAA0C;AAC1C,gCAAkC;AAElC,IAAI,GAAG,CAAC,UAAU,EAAE;IAChB,+BAA+B;IAC/B,OAAO,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;CAChD;AAED,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,qBAAY,CAAC,SAAS,CAAC,CAAC;AAEnD,MAAM,CAAC,mBAAmB,CAAC,uBAAc,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,UAAA,IAAI;IAC7D,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,EAAE,MAAM,CAAC,wBAAwB,CAAC,uBAAc,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;AAC9I,CAAC,CAAC,CAAC;AA6BH,wEAAwE;AACxE,6CAA6C;AAC7C,IAAM,WAAW,GAAG,GAAG,CAAC;AACxB,IAAM,gBAAgB,GAAG,GAAG,CAAC,oBAAoB,CAAC,GAAG,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;AAClF,IAAI,cAAc,GAAG,KAAK,CAAC;AAC3B,IAAI,WAAW,GAAG,IAAI,GAAG,EAAc,CAAC;AAExC,IAAM,WAAW,GAAG,UAAC,KAAa;;IAAb,sBAAA,EAAA,aAAa;IAC9B,IAAI,KAAK,EAAE;QACP,cAAc,GAAG,IAAI,CAAC;KACzB;SAAM,IAAI,CAAC,cAAc,EAAE;QACxB,OAAO;KACV;IAED,0BAA0B;IAC1B,IAAM,OAAO,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC;IAE7C,IAAI,CAAC,KAAK,EAAE;;YACR,wBAAwB;YACxB,KAAqB,IAAA,YAAA,SAAA,OAAO,CAAA,gCAAA,qDAAE;gBAAzB,IAAM,MAAM,oBAAA;gBACb,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC;oBACxB,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;aAClC;;;;;;;;;;YAED,wBAAwB;YACxB,KAAqB,IAAA,gBAAA,SAAA,WAAW,CAAA,wCAAA,iEAAE;gBAA7B,IAAM,MAAM,wBAAA;gBACb,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC;oBACpB,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;aAClC;;;;;;;;;KACJ;IAED,WAAW,GAAG,OAAO,CAAC;IACtB,UAAU,CAAC;QACP,WAAW,EAAE,CAAC;IAClB,CAAC,EAAE,WAAW,CAAC,CAAC;AACpB,CAAC,CAAC;AAEF,GAAG,CAAC,EAAE,CAAC,aAAa,EAAE,UAAA,KAAK;IACvB,IAAI,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,QAAQ,EAAE;QAC1C,OAAO;KACV;IACD,IAAM,aAAa,GAAG,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChF,IAAI,aAAa,KAAK,CAAC,EAAE;QACrB,IAAI,gBAAgB,EAAE;YAClB,GAAG,CAAC,oBAAoB,EAAE,CAAC;SAC9B;aAAM;YACH,WAAW,CAAC,IAAI,CAAC,CAAC;SACrB;KACJ;AACL,CAAC,CAAC,CAAC;AAEH,GAAG,CAAC,EAAE,CAAC,gBAAgB,EAAE,UAAA,KAAK;IAC1B,IAAI,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,QAAQ,EAAE;QAC1C,OAAO;KACV;IACD,IAAM,aAAa,GAAG,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChF,IAAI,aAAa,KAAK,CAAC,EAAE;QACrB,IAAI,gBAAgB,EAAE;YAClB,GAAG,CAAC,qBAAqB,EAAE,CAAC;SAC/B;aAAM;YACH,cAAc,GAAG,KAAK,CAAC;SAC1B;KACJ;AACL,CAAC,CAAC,CAAC;AAEH,iBAAS,GAAG,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../tsc/usb/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iCAAsC;AACtC,mCAA0C;AAC1C,gCAAkC;AAElC,IAAI,GAAG,CAAC,UAAU,EAAE;IAChB,+BAA+B;IAC/B,OAAO,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;CAChD;AAED,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,qBAAY,CAAC,SAAS,CAAC,CAAC;AAEnD,MAAM,CAAC,mBAAmB,CAAC,uBAAc,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,UAAA,IAAI;IAC7D,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,EAAE,MAAM,CAAC,wBAAwB,CAAC,uBAAc,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;AAC9I,CAAC,CAAC,CAAC;AA+BH,4FAA4F;AAC5F,IAAM,WAAW,GAAG,GAAG,CAAC;AACxB,IAAM,gBAAgB,GAAG,GAAG,CAAC,uBAAuB,EAAE,CAAC;AACvD,IAAI,cAAc,GAAG,KAAK,CAAC;AAC3B,IAAI,WAAW,GAAG,IAAI,GAAG,EAAc,CAAC;AAExC,IAAM,eAAe,GAAG,UAAC,KAAc;;IACnC,0BAA0B;IAC1B,IAAM,OAAO,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC;IAE7C,IAAI,CAAC,KAAK,EAAE;;YACR,wBAAwB;YACxB,KAAqB,IAAA,YAAA,SAAA,OAAO,CAAA,gCAAA,qDAAE;gBAAzB,IAAM,MAAM,oBAAA;gBACb,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC;oBACxB,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;aAClC;;;;;;;;;;YAED,wBAAwB;YACxB,KAAqB,IAAA,gBAAA,SAAA,WAAW,CAAA,wCAAA,iEAAE;gBAA7B,IAAM,MAAM,wBAAA;gBACb,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC;oBACpB,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;aAClC;;;;;;;;;KACJ;IAED,WAAW,GAAG,OAAO,CAAC;AAC1B,CAAC,CAAC;AAEF,IAAM,eAAe,GAAG,UAAC,KAAa;IAAb,sBAAA,EAAA,aAAa;IAClC,IAAI,KAAK,EAAE;QACP,cAAc,GAAG,IAAI,CAAC;KACzB;SAAM,IAAI,CAAC,cAAc,EAAE;QACxB,OAAO;KACV;IAED,eAAe,CAAC,KAAK,CAAC,CAAC;IAEvB,UAAU,CAAC;QACP,eAAe,EAAE,CAAC;IACtB,CAAC,EAAE,WAAW,CAAC,CAAC;AACpB,CAAC,CAAC;AAEF,IAAM,oBAAoB,GAAG,gBAAgB,KAAK,CAAC,CAAC;AACpD,IAAI,oBAAoB,EAAE;IACtB,yFAAyF;IACzF,IAAM,sBAAsB,GAAG;QAC3B,0GAA0G;QAC1G,eAAe,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC,CAAC;IAEF,GAAG,CAAC,EAAE,CAAC,WAAW,EAAE,sBAAsB,CAAC,CAAC;IAC5C,GAAG,CAAC,EAAE,CAAC,WAAW,EAAE,sBAAsB,CAAC,CAAC;CAC/C;AAED,GAAG,CAAC,EAAE,CAAC,aAAa,EAAE,UAAA,KAAK;IACvB,IAAI,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,QAAQ,EAAE;QAC1C,OAAO;KACV;IACD,IAAM,aAAa,GAAG,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChF,IAAI,aAAa,KAAK,CAAC,EAAE;QACrB,IAAI,gBAAgB,EAAE;YAClB,GAAG,CAAC,oBAAoB,EAAE,CAAC;SAC9B;aAAM;YACH,eAAe,CAAC,IAAI,CAAC,CAAC;SACzB;KACJ;AACL,CAAC,CAAC,CAAC;AAEH,GAAG,CAAC,EAAE,CAAC,gBAAgB,EAAE,UAAA,KAAK;IAC1B,IAAI,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,QAAQ,EAAE;QAC1C,OAAO;KACV;IACD,IAAM,aAAa,GAAG,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChF,IAAI,aAAa,KAAK,CAAC,EAAE;QACrB,IAAI,gBAAgB,EAAE;YAClB,GAAG,CAAC,qBAAqB,EAAE,CAAC;SAC/B;aAAM;YACH,cAAc,GAAG,KAAK,CAAC;SAC1B;KACJ;AACL,CAAC,CAAC,CAAC;AAEH,iBAAS,GAAG,CAAC"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "usb",
   "description": "Library to access USB devices",
   "license": "MIT",
-  "version": "2.4.3",
+  "version": "2.5.0",
   "main": "dist/index.js",
   "engines": {
     "node": ">=10.20.0 <11.x || >=12.17.0 <13.0 || >=14.0.0"