Add Serial support for Windows OS #62

ghost · 2018-05-26T20:30:11Z

Fix #36

Add Serial support for Windows OS

Alternative to #50

ghost · 2018-05-26T20:31:28Z

Hi,
@jasondana & @MadLittleMods could you please try this code and tell me what you think about the code.
Regards,

MadLittleMods

Thanks for the contribution! Seems to work well 👍

Mostly small nits and I am curious if @jasondana has any comments

Here is the output from a Windows 10 PC for example,

find 17 [ { locationId: 0,
    vendorId: 0,
    productId: 0,
    deviceName: 'USB Root Hub (USB 3.0)',
    manufacturer: '(Standard USB HUBs)',
    serialNumber: '',
    deviceAddress: 10 },
  { locationId: 0,
    vendorId: 0,
    productId: 0,
    deviceName: 'USB Root Hub (USB 3.0)',
    manufacturer: '(Standard USB HUBs)',
    serialNumber: '',
    deviceAddress: 15 },
  { locationId: 0,
    vendorId: 1118,
    productId: 746,
    deviceName: 'Xbox One Controller',
    manufacturer: 'Microsoft',
    serialNumber: '3032363030303739393032363336',
    deviceAddress: 17 },
  { locationId: 0,
    vendorId: 1118,
    productId: 767,
    deviceName: 'USB Input Device',
    manufacturer: '(Standard system devices)',
    serialNumber: '00&00&00009D605980ED7E',
    deviceAddress: 7 },
  { locationId: 0,
    vendorId: 1133,
    productId: 49742,
    deviceName: 'USB Composite Device',
    manufacturer: '(Standard USB Host Controller)',
    serialNumber: '9025267AF90009',
    deviceAddress: 1 },
  { locationId: 0,
    vendorId: 1133,
    productId: 49742,
    deviceName: 'USB Input Device',
    manufacturer: '(Standard system devices)',
    serialNumber: '',
    deviceAddress: 2 },
  { locationId: 0,
    vendorId: 1133,
    productId: 49742,
    deviceName: 'USB Input Device',
    manufacturer: '(Standard system devices)',
    serialNumber: '',
    deviceAddress: 4 },
  { locationId: 0,
    vendorId: 2652,
    productId: 8680,
    deviceName: 'Broadcom BCM20702 Bluetooth 4.0 USB Device',
    manufacturer: 'Broadcom',
    serialNumber: '5CF3707AD674',
    deviceAddress: 9 },
  { locationId: 0,
    vendorId: 6720,
    productId: 257,
    deviceName: 'Generic USB Hub',
    manufacturer: '(Standard USB HUBs)',
    serialNumber: '',
    deviceAddress: 5 },
  { locationId: 0,
    vendorId: 8457,
    productId: 10257,
    deviceName: 'Generic USB Hub',
    manufacturer: '(Standard USB HUBs)',
    serialNumber: '',
    deviceAddress: 16 },
  { locationId: 0,
    vendorId: 8457,
    productId: 10257,
    deviceName: 'Generic USB Hub',
    manufacturer: '(Standard USB HUBs)',
    serialNumber: '',
    deviceAddress: 6 },
  { locationId: 0,
    vendorId: 8457,
    productId: 33040,
    deviceName: 'Generic SuperSpeed USB Hub',
    manufacturer: '(Standard USB HUBs)',
    serialNumber: '',
    deviceAddress: 3 },
  { locationId: 0,
    vendorId: 8457,
    productId: 33040,
    deviceName: 'Generic SuperSpeed USB Hub',
    manufacturer: '(Standard USB HUBs)',
    serialNumber: '',
    deviceAddress: 14 },
  { locationId: 0,
    vendorId: 9494,
    productId: 60,
    deviceName: 'USB Composite Device',
    manufacturer: '(Standard USB Host Controller)',
    serialNumber: '',
    deviceAddress: 8 },
  { locationId: 0,
    vendorId: 9494,
    productId: 60,
    deviceName: 'USB Input Device',
    manufacturer: '(Standard system devices)',
    serialNumber: '',
    deviceAddress: 12 },
  { locationId: 0,
    vendorId: 9494,
    productId: 60,
    deviceName: 'USB Input Device',
    manufacturer: '(Standard system devices)',
    serialNumber: '',
    deviceAddress: 11 },
  { locationId: 0,
    vendorId: 9494,
    productId: 60,
    deviceName: 'USB Input Device',
    manufacturer: '(Standard system devices)',
    serialNumber: '',
    deviceAddress: 13 } ]

MadLittleMods · 2018-05-27T06:25:15Z

src/detection_win.cpp

+		// If device has a CM_DEVCAP_UNIQUEID capability, then we assume it has a serial number
+		if ((dwCap & CM_DEVCAP_UNIQUEID) == CM_DEVCAP_UNIQUEID) {
+			if (DllSetupDiGetDeviceInstanceId(hDevInfo, pspDevInfoData, buf, buffSize, &nSize)) {
+				// extract Serial Number


Let's add a comment about what we are trying to parse

// Format: <device-ID>\<instance-specific-ID> // // Ex. `USB\VID_2109&PID_8110\5&376ABA2D&0&21` // - `<device-ID>`: `USB\VID_2109&PID_8110` // - `<instance-specific-ID>`: `5&376ABA2D&0&21` // // [Device instance IDs](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/device-instance-ids) -> // - [Device IDs](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/device-ids) -> [Hardware IDs](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/hardware-ids) -> [Device identifier formats](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/device-identifier-formats) -> [Identifiers for USB devices](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/identifiers-for-usb-devices) // - [Standard USB Identifiers](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/standard-usb-identifiers) // - [Special USB Identifiers](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/special-usb-identifiers) // - [Instance specific ID](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/instance-ids)

From #50 (comment)

I am OK with that

MadLittleMods · 2018-05-27T06:27:03Z

src/detection_win.cpp

+			if (DllSetupDiGetDeviceInstanceId(hDevInfo, pspDevInfoData, buf, buffSize, &nSize)) {
+				// extract Serial Number
+				string str = buf;
+				size_t t = str.find_last_of("\\\\");


We are parsing strings like USB\VID_046D&PID_C24E\9025267AF90009

Why are we using a double backslash \\\\? It seems to work just fine with str.find_last_of("\\");. According to the docs, we should only need to define the backslash once, http://www.cplusplus.com/reference/string/string/find_last_of/ 🤷‍♂️

Let's rename this variable to size_t serialNumberIndex = ... to make this more clear

Why double backslash?
I have no idea :) just miswritten.

MadLittleMods · 2018-05-27T06:31:38Z

src/detection_win.cpp

+		if ((dwCap & CM_DEVCAP_UNIQUEID) == CM_DEVCAP_UNIQUEID) {
+			if (DllSetupDiGetDeviceInstanceId(hDevInfo, pspDevInfoData, buf, buffSize, &nSize)) {
+				// extract Serial Number
+				string str = buf;


Let's rename this variable to string deviceInstanceId = buf; so it better represents what it holds

I am OK with that

MadLittleMods · 2018-05-27T06:35:28Z

src/detection_win.cpp

@@ -7,6 +7,7 @@

 // Include Windows headers
 #include <windows.h>
+#include <Cfgmgr32.h>


Why is this needed now?

CM_DEVCAP_UNIQUEID is defined in that header file, so we have to include it.
I added a comment near header file for future reference.

I don't see it listed here

https://msdn.microsoft.com/en-us/library/windows/hardware/mt813619%28v=vs.85%29.aspx?f=255&MSPPError=-2147217396

https://github.com/msysgit/msysgit/blob/e6cc6bf1bba06c7029b2d59aedb0c975a0c4f6fe/mingw/include/ddk/cfgmgr32.h

But the docs seem to indicate it should be 👍

SPDRP_CAPABILITIES

The function retrieves a bitwise OR of the following CM_DEVCAP_Xxx flags in a DWORD. The device capabilities that are represented by these flags correspond to the device capabilities that are represented by the members of the DEVICE_CAPABILITIES structure. The CM_DEVCAP_Xxx constants are defined in Cfgmgr32.h.

https://msdn.microsoft.com/en-us/library/windows/hardware/ff551967(v=vs.85).aspx

MadLittleMods · 2018-05-27T06:37:07Z

src/detection_win.cpp

@@ -423,6 +424,21 @@ void ExtractDeviceInfo(HDEVINFO hDevInfo, SP_DEVINFO_DATA* pspDevInfoData, TCHAR
 		// Use this to extract VID / PID
 		extractVidPid(buf, resultItem);
 	}
+
+	DWORD dwCap = 0x0;
+	if (DllSetupDiGetDeviceRegistryProperty(hDevInfo, pspDevInfoData, SPDRP_CAPABILITIES, &DataT, (PBYTE)&dwCap, 4, &nSize)) {


Why 4 instead of buffSize like the other instances we call DllSetupDiGetDeviceRegistryProperty?

Because we are trying to get a DWORD, so it is exactly 4.

Can we use sizeOf(DWORD) or something similar?

Why do we use buffSize for all other instances? What's different about this one?

Actually it is defined as;
typedef unsigned long DWORD;
And will not change in the future.
But no problem we can use sizeof(DWORD).

Why do we use buffSize for all other instances? What's different about this one?
In other instances we are reading data to buf variable. In this instance we are reading data to dwCapabilities which is a DWORD.

Forget to push (no sizeof in the code atm)?

Perhaps even better sizeof(dwCapabilities)

MadLittleMods · 2018-05-27T06:40:51Z

src/detection_win.cpp

@@ -423,6 +424,21 @@ void ExtractDeviceInfo(HDEVINFO hDevInfo, SP_DEVINFO_DATA* pspDevInfoData, TCHAR
 		// Use this to extract VID / PID
 		extractVidPid(buf, resultItem);
 	}
+
+	DWORD dwCap = 0x0;


dwCapabilities

I am OK with that

MadLittleMods · 2018-05-27T06:42:13Z

src/detection_win.cpp

+	DWORD dwCap = 0x0;
+	if (DllSetupDiGetDeviceRegistryProperty(hDevInfo, pspDevInfoData, SPDRP_CAPABILITIES, &DataT, (PBYTE)&dwCap, 4, &nSize)) {
+		// If device has a CM_DEVCAP_UNIQUEID capability, then we assume it has a serial number
+		if ((dwCap & CM_DEVCAP_UNIQUEID) == CM_DEVCAP_UNIQUEID) {


Just for reference, I found this other usage,

https://github.com/Fedict/eid-edt/blob/79dd4cfe7373714dbfbb645ea63e370e357e9cad/Win/src/devices.cpp#L292

I think our way is better & more clear.

ghost · 2018-05-28T07:11:03Z

Hi,
I reviewed my code & tested again.

MadLittleMods · 2018-05-28T07:14:58Z

src/detection_win.cpp

@@ -7,6 +7,7 @@

 // Include Windows headers
 #include <windows.h>
+#include <Cfgmgr32.h>		// CM_DEVCAP_UNIQUEID


Let's put the comment above

// Include `CM_DEVCAP_UNIQUEID`

MadLittleMods · 2018-05-28T07:17:36Z

src/detection_win.cpp

@@ -7,6 +7,7 @@

 // Include Windows headers
 #include <windows.h>
+#include <Cfgmgr32.h>


I don't see it listed here

https://msdn.microsoft.com/en-us/library/windows/hardware/mt813619%28v=vs.85%29.aspx?f=255&MSPPError=-2147217396

https://github.com/msysgit/msysgit/blob/e6cc6bf1bba06c7029b2d59aedb0c975a0c4f6fe/mingw/include/ddk/cfgmgr32.h

But the docs seem to indicate it should be 👍

SPDRP_CAPABILITIES

The function retrieves a bitwise OR of the following CM_DEVCAP_Xxx flags in a DWORD. The device capabilities that are represented by these flags correspond to the device capabilities that are represented by the members of the DEVICE_CAPABILITIES structure. The CM_DEVCAP_Xxx constants are defined in Cfgmgr32.h.

https://msdn.microsoft.com/en-us/library/windows/hardware/ff551967(v=vs.85).aspx

MadLittleMods

Thanks for the updates!

One nit comment and question here #62 (comment)

MadLittleMods · 2018-05-28T07:31:34Z

@doganmurat Still a question here, #62 (comment)

ghost · 2018-05-28T08:04:01Z

Hi @MadLittleMods ,
Any other comment or question?

MadLittleMods · 2018-05-28T19:25:47Z

@doganmurat Same comment, #62 (comment)

ghost · 2018-05-28T19:43:34Z

Hi,
You mean header file comment?
It is already in commit.

MadLittleMods · 2018-05-28T20:31:55Z

@doganmurat I linked the specific sizeof comment. We are still using 4 instead of sizeof(dwCapabilities), #62 (comment)

ghost · 2018-05-30T06:55:58Z

Hi,
Commit 13a0166 changes code to sizeof(DWORD), and
last commit 3ea0c32 changes code to sizeof(dwCapabilities).

Please check it.

MadLittleMods · 2018-06-04T07:26:25Z

@doganmurat Thanks for the contribution 💖

I merged and created v3.1.0, https://github.com/MadLittleMods/node-usb-detection/releases/tag/v3.1.0

I am going to wait for the prebuild binaries to trickle in from Travis and AppVeyor and publish the release to npm in the morning 🚢

ghost · 2018-06-04T07:31:52Z

Hi @MadLittleMods ,

Good news! ✌️
Thank you.

MadLittleMods · 2018-06-05T16:40:58Z

@doganmurat v3.1.0 published to npm 🚀, https://www.npmjs.com/package/usb-detection

Add Serial support for Windows OS

e4a7c59

MadLittleMods added enhancement Windows labels May 27, 2018

MadLittleMods suggested changes May 27, 2018

View reviewed changes

MadLittleMods mentioned this pull request May 27, 2018

Extract Serial Number from Device Instance ID/Path on Windows. #50

Closed

Fix variable names & add comments

b3da8c7

MadLittleMods reviewed May 28, 2018

View reviewed changes

MadLittleMods suggested changes May 28, 2018

View reviewed changes

Change header file comment location

dff0346

Add sizeof(DWORD) instead of 4

13a0166

Change sizeof(DWORD) to sizeof(dwCapabilities)

3ea0c32

MadLittleMods approved these changes Jun 4, 2018

View reviewed changes

MadLittleMods merged commit 9aaa036 into MadLittleMods:master Jun 4, 2018

MadLittleMods mentioned this pull request Sep 10, 2018

How to get USB Intance ID? #68

Closed

Add Serial support for Windows OS #62

Add Serial support for Windows OS #62

Conversation

ghost commented May 26, 2018 • edited by MadLittleMods Loading

ghost commented May 26, 2018 • edited by ghost Loading

MadLittleMods left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost May 28, 2018 • edited by ghost Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MadLittleMods May 28, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MadLittleMods May 28, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MadLittleMods May 27, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost commented May 28, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MadLittleMods left a comment

Choose a reason for hiding this comment

MadLittleMods commented May 28, 2018

ghost commented May 28, 2018

MadLittleMods commented May 28, 2018

ghost commented May 28, 2018

MadLittleMods commented May 28, 2018

ghost commented May 30, 2018

MadLittleMods commented Jun 4, 2018

ghost commented Jun 4, 2018

MadLittleMods commented Jun 5, 2018

ghost commented May 26, 2018 •

edited by MadLittleMods

Loading

ghost commented May 26, 2018 •

edited by ghost

Loading

MadLittleMods left a comment •

edited

Loading

ghost May 28, 2018 •

edited by ghost

Loading

MadLittleMods May 28, 2018 •

edited

Loading

MadLittleMods May 28, 2018 •

edited

Loading

MadLittleMods May 27, 2018 •

edited

Loading