usb.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305
  1. 'use strict';
  2. // @ts-check
  3. // ==================================================================================
  4. // usb.js
  5. // ----------------------------------------------------------------------------------
  6. // Description: System Information - library
  7. // for Node.js
  8. // Copyright: (c) 2014 - 2022
  9. // Author: Sebastian Hildebrandt
  10. // ----------------------------------------------------------------------------------
  11. // License: MIT
  12. // ==================================================================================
  13. // 16. usb
  14. // ----------------------------------------------------------------------------------
  15. const exec = require('child_process').exec;
  16. // const execSync = require('child_process').execSync;
  17. const util = require('./util');
  18. // const fs = require('fs');
  19. let _platform = process.platform;
  20. const _linux = (_platform === 'linux' || _platform === 'android');
  21. const _darwin = (_platform === 'darwin');
  22. const _windows = (_platform === 'win32');
  23. const _freebsd = (_platform === 'freebsd');
  24. const _openbsd = (_platform === 'openbsd');
  25. const _netbsd = (_platform === 'netbsd');
  26. const _sunos = (_platform === 'sunos');
  27. function getLinuxUsbType(type, name) {
  28. let result = type;
  29. const str = (name + ' ' + type).toLowerCase();
  30. if (str.indexOf('camera') >= 0) { result = 'Camera'; }
  31. else if (str.indexOf('hub') >= 0) { result = 'Hub'; }
  32. else if (str.indexOf('keybrd') >= 0) { result = 'Keyboard'; }
  33. else if (str.indexOf('keyboard') >= 0) { result = 'Keyboard'; }
  34. else if (str.indexOf('mouse') >= 0) { result = 'Mouse'; }
  35. else if (str.indexOf('stora') >= 0) { result = 'Storage'; }
  36. else if (str.indexOf('mic') >= 0) { result = 'Microphone'; }
  37. else if (str.indexOf('headset') >= 0) { result = 'Audio'; }
  38. else if (str.indexOf('audio') >= 0) { result = 'Audio'; }
  39. return result;
  40. }
  41. function parseLinuxUsb(usb) {
  42. const result = {};
  43. const lines = usb.split('\n');
  44. if (lines && lines.length && lines[0].indexOf('Device') >= 0) {
  45. const parts = lines[0].split(' ');
  46. result.bus = parseInt(parts[0], 10);
  47. if (parts[2]) {
  48. result.deviceId = parseInt(parts[2], 10);
  49. } else {
  50. result.deviceId = null;
  51. }
  52. } else {
  53. result.bus = null;
  54. result.deviceId = null;
  55. }
  56. const idVendor = util.getValue(lines, 'idVendor', ' ', true).trim();
  57. let vendorParts = idVendor.split(' ');
  58. vendorParts.shift();
  59. const vendor = vendorParts.join(' ');
  60. const idProduct = util.getValue(lines, 'idProduct', ' ', true).trim();
  61. let productParts = idProduct.split(' ');
  62. productParts.shift();
  63. const product = productParts.join(' ');
  64. const interfaceClass = util.getValue(lines, 'bInterfaceClass', ' ', true).trim();
  65. let interfaceClassParts = interfaceClass.split(' ');
  66. interfaceClassParts.shift();
  67. const usbType = interfaceClassParts.join(' ');
  68. const iManufacturer = util.getValue(lines, 'iManufacturer', ' ', true).trim();
  69. let iManufacturerParts = iManufacturer.split(' ');
  70. iManufacturerParts.shift();
  71. const manufacturer = iManufacturerParts.join(' ');
  72. result.id = (idVendor.startsWith('0x') ? idVendor.split(' ')[0].substr(2, 10) : '') + ':' + (idProduct.startsWith('0x') ? idProduct.split(' ')[0].substr(2, 10) : '');
  73. result.name = product;
  74. result.type = getLinuxUsbType(usbType, product);
  75. result.removable = null;
  76. result.vendor = vendor;
  77. result.manufacturer = manufacturer;
  78. result.maxPower = util.getValue(lines, 'MaxPower', ' ', true);
  79. result.serialNumber = null;
  80. return result;
  81. }
  82. // bus
  83. // deviceId
  84. // id
  85. // name(product)
  86. // type(bInterfaceClass)
  87. // removable / hotplug
  88. // vendor
  89. // manufacturer
  90. // maxpower(linux)
  91. function getDarwinUsbType(name) {
  92. let result = '';
  93. if (name.indexOf('camera') >= 0) { result = 'Camera'; }
  94. else if (name.indexOf('touch bar') >= 0) { result = 'Touch Bar'; }
  95. else if (name.indexOf('controller') >= 0) { result = 'Controller'; }
  96. else if (name.indexOf('headset') >= 0) { result = 'Audio'; }
  97. else if (name.indexOf('keyboard') >= 0) { result = 'Keyboard'; }
  98. else if (name.indexOf('trackpad') >= 0) { result = 'Trackpad'; }
  99. else if (name.indexOf('sensor') >= 0) { result = 'Sensor'; }
  100. else if (name.indexOf('bthusb') >= 0) { result = 'Bluetooth'; }
  101. else if (name.indexOf('bth') >= 0) { result = 'Bluetooth'; }
  102. else if (name.indexOf('rfcomm') >= 0) { result = 'Bluetooth'; }
  103. else if (name.indexOf('usbhub') >= 0) { result = 'Hub'; }
  104. else if (name.indexOf(' hub') >= 0) { result = 'Hub'; }
  105. else if (name.indexOf('mouse') >= 0) { result = 'Mouse'; }
  106. else if (name.indexOf('mic') >= 0) { result = 'Microphone'; }
  107. else if (name.indexOf('removable') >= 0) { result = 'Storage'; }
  108. return result;
  109. }
  110. function parseDarwinUsb(usb, id) {
  111. const result = {};
  112. result.id = id;
  113. usb = usb.replace(/ \|/g, '');
  114. usb = usb.trim();
  115. let lines = usb.split('\n');
  116. lines.shift();
  117. try {
  118. for (let i = 0; i < lines.length; i++) {
  119. lines[i] = lines[i].trim();
  120. lines[i] = lines[i].replace(/=/g, ':');
  121. if (lines[i] !== '{' && lines[i] !== '}' && lines[i + 1] && lines[i + 1].trim() !== '}') {
  122. lines[i] = lines[i] + ',';
  123. }
  124. lines[i] = lines[i].replace(': Yes,', ': "Yes",');
  125. lines[i] = lines[i].replace(': No,', ': "No",');
  126. }
  127. const usbObj = JSON.parse(lines.join('\n'));
  128. const removableDrive = usbObj['Built-In'].toLowerCase() !== 'yes' && usbObj['non-removable'].toLowerCase() === 'no';
  129. result.bus = null;
  130. result.deviceId = null;
  131. result.id = usbObj['USB Address'] || null;
  132. result.name = usbObj['kUSBProductString'] || usbObj['USB Product Name'] || null;
  133. result.type = getDarwinUsbType((usbObj['kUSBProductString'] || usbObj['USB Product Name'] || '').toLowerCase() + (removableDrive ? ' removable' : ''));
  134. result.removable = usbObj['non-removable'].toLowerCase() === 'no';
  135. result.vendor = usbObj['kUSBVendorString'] || usbObj['USB Vendor Name'] || null;
  136. result.manufacturer = usbObj['kUSBVendorString'] || usbObj['USB Vendor Name'] || null;
  137. result.maxPower = null;
  138. result.serialNumber = usbObj['kUSBSerialNumberString'] || null;
  139. if (result.name) {
  140. return result;
  141. } else {
  142. return null;
  143. }
  144. } catch (e) {
  145. return null;
  146. }
  147. }
  148. // function getWindowsUsbType(service) {
  149. // let result = ''
  150. // if (service.indexOf('usbhub3') >= 0) { result = 'Hub'; }
  151. // else if (service.indexOf('usbstor') >= 0) { result = 'Storage'; }
  152. // else if (service.indexOf('hidusb') >= 0) { result = 'Input'; }
  153. // else if (service.indexOf('usbccgp') >= 0) { result = 'Controller'; }
  154. // else if (service.indexOf('usbxhci') >= 0) { result = 'Controller'; }
  155. // else if (service.indexOf('usbehci') >= 0) { result = 'Controller'; }
  156. // else if (service.indexOf('kbdhid') >= 0) { result = 'Keyboard'; }
  157. // else if (service.indexOf('keyboard') >= 0) { result = 'Keyboard'; }
  158. // else if (service.indexOf('pointing') >= 0) { result = 'Mouse'; }
  159. // else if (service.indexOf('disk') >= 0) { result = 'Storage'; }
  160. // else if (service.indexOf('usbhub') >= 0) { result = 'Hub'; }
  161. // else if (service.indexOf('bthusb') >= 0) { result = ''; }
  162. // else if (service.indexOf('bth') >= 0) { result = ''; }
  163. // else if (service.indexOf('rfcomm') >= 0) { result = ''; }
  164. // return result;
  165. // }
  166. function getWindowsUsbTypeCreation(creationclass, name) {
  167. let result = '';
  168. if (name.indexOf('storage') >= 0) { result = 'Storage'; }
  169. else if (name.indexOf('speicher') >= 0) { result = 'Storage'; }
  170. else if (creationclass.indexOf('usbhub') >= 0) { result = 'Hub'; }
  171. else if (creationclass.indexOf('storage') >= 0) { result = 'Storage'; }
  172. else if (creationclass.indexOf('usbcontroller') >= 0) { result = 'Controller'; }
  173. else if (creationclass.indexOf('keyboard') >= 0) { result = 'Keyboard'; }
  174. else if (creationclass.indexOf('pointing') >= 0) { result = 'Mouse'; }
  175. else if (creationclass.indexOf('disk') >= 0) { result = 'Storage'; }
  176. return result;
  177. }
  178. function parseWindowsUsb(lines, id) {
  179. const usbType = getWindowsUsbTypeCreation(util.getValue(lines, 'CreationClassName', ':').toLowerCase(), util.getValue(lines, 'name', ':').toLowerCase());
  180. if (usbType) {
  181. const result = {};
  182. result.bus = null;
  183. result.deviceId = util.getValue(lines, 'deviceid', ':');
  184. result.id = id;
  185. result.name = util.getValue(lines, 'name', ':');
  186. result.type = usbType;
  187. result.removable = null;
  188. result.vendor = null;
  189. result.manufacturer = util.getValue(lines, 'Manufacturer', ':');
  190. result.maxPower = null;
  191. result.serialNumber = null;
  192. return result;
  193. } else {
  194. return null;
  195. }
  196. }
  197. function usb(callback) {
  198. return new Promise((resolve) => {
  199. process.nextTick(() => {
  200. let result = [];
  201. if (_linux) {
  202. const cmd = 'export LC_ALL=C; lsusb -v 2>/dev/null; unset LC_ALL';
  203. exec(cmd, { maxBuffer: 1024 * 1024 * 128 }, function (error, stdout) {
  204. if (!error) {
  205. const parts = ('\n\n' + stdout.toString()).split('\n\nBus ');
  206. for (let i = 1; i < parts.length; i++) {
  207. const usb = parseLinuxUsb(parts[i]);
  208. result.push(usb);
  209. }
  210. }
  211. if (callback) {
  212. callback(result);
  213. }
  214. resolve(result);
  215. });
  216. }
  217. if (_darwin) {
  218. let cmd = 'ioreg -p IOUSB -c AppleUSBRootHubDevice -w0 -l';
  219. exec(cmd, { maxBuffer: 1024 * 1024 * 128 }, function (error, stdout) {
  220. if (!error) {
  221. const parts = (stdout.toString()).split(' +-o ');
  222. for (let i = 1; i < parts.length; i++) {
  223. const usb = parseDarwinUsb(parts[i]);
  224. if (usb) {
  225. result.push(usb);
  226. }
  227. }
  228. if (callback) {
  229. callback(result);
  230. }
  231. resolve(result);
  232. }
  233. if (callback) {
  234. callback(result);
  235. }
  236. resolve(result);
  237. });
  238. }
  239. if (_windows) {
  240. util.powerShell('Get-WmiObject CIM_LogicalDevice | where { $_.Description -match "USB"} | select Name,CreationClassName,DeviceId,Manufacturer | fl').then((stdout, error) => {
  241. if (!error) {
  242. const parts = stdout.toString().split(/\n\s*\n/);
  243. for (let i = 0; i < parts.length; i++) {
  244. const usb = parseWindowsUsb(parts[i].split('\n'), i);
  245. if (usb) {
  246. result.push(usb);
  247. }
  248. }
  249. }
  250. if (callback) {
  251. callback(result);
  252. }
  253. resolve(result);
  254. });
  255. // util.powerShell("gwmi Win32_USBControllerDevice |\%{[wmi]($_.Dependent)}").then(data => {
  256. // const parts = data.toString().split(/\n\s*\n/);
  257. // for (let i = 0; i < parts.length; i++) {
  258. // const usb = parseWindowsUsb(parts[i].split('\n'), i)
  259. // if (usb) {
  260. // result.push(usb)
  261. // }
  262. // }
  263. // if (callback) {
  264. // callback(result);
  265. // }
  266. // resolve(result);
  267. // });
  268. }
  269. if (_sunos || _freebsd || _openbsd || _netbsd) {
  270. resolve(null);
  271. }
  272. });
  273. });
  274. }
  275. exports.usb = usb;