usb 2.0.0-alpha.2 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (258) hide show
  1. package/.gitmodules +1 -1
  2. package/CHANGELOG.md +100 -0
  3. package/README.md +573 -0
  4. package/binding.gyp +12 -2
  5. package/dist/index.d.ts +4 -4
  6. package/dist/index.js +14 -8
  7. package/dist/index.js.map +1 -1
  8. package/dist/usb/bindings.d.ts +13 -0
  9. package/dist/usb/bindings.js +2 -1
  10. package/dist/usb/bindings.js.map +1 -1
  11. package/dist/usb/index.js +86 -2
  12. package/dist/usb/index.js.map +1 -1
  13. package/dist/usb/interface.js.map +1 -1
  14. package/dist/webusb/index.d.ts +32 -19
  15. package/dist/webusb/index.js +163 -67
  16. package/dist/webusb/index.js.map +1 -1
  17. package/dist/webusb/webusb-device.d.ts +1 -1
  18. package/dist/webusb/webusb-device.js +27 -15
  19. package/dist/webusb/webusb-device.js.map +1 -1
  20. package/libusb/.private/pre-commit.sh +7 -1
  21. package/libusb/.travis.yml +49 -0
  22. package/libusb/AUTHORS +44 -3
  23. package/libusb/Brewfile +4 -0
  24. package/libusb/ChangeLog +74 -2
  25. package/libusb/README.md +32 -0
  26. package/libusb/TODO +1 -1
  27. package/libusb/Xcode/common.xcconfig +12 -0
  28. package/libusb/Xcode/config.h +25 -0
  29. package/libusb/Xcode/libusb.xcodeproj/project.pbxproj +959 -1
  30. package/libusb/android/README +4 -2
  31. package/libusb/android/config.h +75 -0
  32. package/libusb/appveyor.yml +41 -0
  33. package/libusb/appveyor_cygwin.bat +11 -0
  34. package/libusb/appveyor_minGW.bat +19 -0
  35. package/libusb/autogen.sh +1 -1
  36. package/libusb/bootstrap.sh +3 -16
  37. package/libusb/configure.ac +108 -80
  38. package/libusb/doc/doxygen.cfg.in +1785 -739
  39. package/libusb/examples/Makefile.am +1 -1
  40. package/libusb/examples/dpfp.c +3 -1
  41. package/libusb/examples/dpfp_threaded.c +23 -10
  42. package/libusb/examples/ezusb.c +3 -3
  43. package/libusb/examples/ezusb.h +2 -2
  44. package/libusb/examples/fxload.c +31 -9
  45. package/libusb/examples/hotplugtest.c +35 -7
  46. package/libusb/examples/listdevs.c +3 -1
  47. package/libusb/examples/sam3u_benchmark.c +3 -3
  48. package/libusb/examples/testlibusb.c +277 -0
  49. package/libusb/examples/xusb.c +40 -34
  50. package/libusb/libusb/Makefile.am +49 -23
  51. package/libusb/libusb/core.c +855 -457
  52. package/libusb/libusb/descriptor.c +72 -78
  53. package/libusb/libusb/hotplug.c +122 -76
  54. package/libusb/libusb/hotplug.h +42 -25
  55. package/libusb/libusb/io.c +625 -390
  56. package/libusb/libusb/libusb-1.0.def +12 -0
  57. package/libusb/libusb/libusb.h +218 -150
  58. package/libusb/libusb/libusbi.h +346 -176
  59. package/libusb/libusb/os/darwin_usb.c +604 -319
  60. package/libusb/libusb/os/darwin_usb.h +61 -20
  61. package/libusb/libusb/os/haiku_pollfs.cpp +367 -0
  62. package/libusb/libusb/os/haiku_usb.h +113 -0
  63. package/libusb/libusb/os/haiku_usb_backend.cpp +533 -0
  64. package/libusb/libusb/os/haiku_usb_raw.cpp +267 -0
  65. package/libusb/libusb/os/haiku_usb_raw.h +188 -0
  66. package/libusb/libusb/os/linux_netlink.c +186 -146
  67. package/libusb/libusb/os/linux_udev.c +36 -14
  68. package/libusb/libusb/os/linux_usbfs.c +426 -225
  69. package/libusb/libusb/os/linux_usbfs.h +5 -3
  70. package/libusb/libusb/os/netbsd_usb.c +21 -77
  71. package/libusb/libusb/os/openbsd_usb.c +32 -115
  72. package/libusb/libusb/os/poll_posix.c +38 -5
  73. package/libusb/libusb/os/poll_posix.h +3 -0
  74. package/libusb/libusb/os/poll_windows.c +277 -626
  75. package/libusb/libusb/os/poll_windows.h +11 -44
  76. package/libusb/libusb/os/sunos_usb.c +1695 -0
  77. package/libusb/libusb/os/sunos_usb.h +80 -0
  78. package/libusb/libusb/os/threads_posix.c +24 -26
  79. package/libusb/libusb/os/threads_posix.h +73 -21
  80. package/libusb/libusb/os/threads_windows.c +71 -157
  81. package/libusb/libusb/os/threads_windows.h +68 -44
  82. package/libusb/libusb/os/wince_usb.c +276 -420
  83. package/libusb/libusb/os/wince_usb.h +23 -28
  84. package/libusb/libusb/os/windows_common.h +78 -58
  85. package/libusb/libusb/os/windows_nt_common.c +1010 -0
  86. package/libusb/libusb/os/windows_nt_common.h +110 -0
  87. package/libusb/libusb/os/windows_nt_shared_types.h +147 -0
  88. package/libusb/libusb/os/windows_usbdk.c +830 -0
  89. package/libusb/libusb/os/windows_usbdk.h +103 -0
  90. package/libusb/libusb/os/windows_winusb.c +4391 -0
  91. package/libusb/libusb/os/windows_winusb.h +783 -0
  92. package/libusb/libusb/strerror.c +41 -7
  93. package/libusb/libusb/sync.c +41 -13
  94. package/libusb/libusb/version.h +1 -1
  95. package/libusb/libusb/version_nano.h +1 -1
  96. package/libusb/libusb-1.0.pc.in +1 -1
  97. package/libusb/msvc/appveyor.bat +27 -0
  98. package/libusb/msvc/config.h +5 -4
  99. package/libusb/msvc/ddk_build.cmd +87 -43
  100. package/libusb/msvc/fxload_2010.vcxproj +24 -104
  101. package/libusb/msvc/fxload_2012.vcxproj +24 -107
  102. package/libusb/msvc/fxload_2013.vcxproj +24 -107
  103. package/libusb/msvc/fxload_2015.vcxproj +91 -0
  104. package/libusb/msvc/fxload_2017.vcxproj +114 -0
  105. package/libusb/msvc/fxload_sources +1 -1
  106. package/libusb/msvc/getopt_2010.vcxproj +16 -75
  107. package/libusb/msvc/getopt_2012.vcxproj +16 -79
  108. package/libusb/msvc/getopt_2013.vcxproj +16 -79
  109. package/libusb/msvc/getopt_2015.vcxproj +73 -0
  110. package/libusb/msvc/getopt_2017.vcxproj +98 -0
  111. package/libusb/msvc/getopt_sources +6 -2
  112. package/libusb/msvc/hotplugtest_2010.vcxproj +18 -99
  113. package/libusb/msvc/hotplugtest_2012.vcxproj +18 -102
  114. package/libusb/msvc/hotplugtest_2013.vcxproj +18 -102
  115. package/libusb/msvc/hotplugtest_2015.vcxproj +83 -0
  116. package/libusb/msvc/hotplugtest_2017.vcxproj +106 -0
  117. package/libusb/msvc/hotplugtest_sources +1 -1
  118. package/libusb/msvc/libusb_2005.sln +20 -20
  119. package/libusb/msvc/libusb_2010.sln +57 -46
  120. package/libusb/msvc/libusb_2012.sln +57 -46
  121. package/libusb/msvc/libusb_2013.sln +57 -50
  122. package/libusb/msvc/libusb_2015.sln +59 -52
  123. package/libusb/msvc/libusb_2017.sln +186 -0
  124. package/libusb/msvc/libusb_dll.dsp +2 -2
  125. package/libusb/msvc/libusb_dll_2005.vcproj +30 -2
  126. package/libusb/msvc/libusb_dll_2010.vcxproj +26 -90
  127. package/libusb/msvc/libusb_dll_2012.vcxproj +28 -96
  128. package/libusb/msvc/libusb_dll_2013.vcxproj +28 -96
  129. package/libusb/msvc/libusb_dll_2015.vcxproj +107 -0
  130. package/libusb/msvc/libusb_dll_2017.vcxproj +134 -0
  131. package/libusb/msvc/libusb_dll_wince.vcproj +9 -1
  132. package/libusb/msvc/libusb_sources +10 -5
  133. package/libusb/msvc/libusb_static.dsp +2 -2
  134. package/libusb/msvc/libusb_static_2005.vcproj +32 -4
  135. package/libusb/msvc/libusb_static_2010.vcxproj +24 -83
  136. package/libusb/msvc/libusb_static_2012.vcxproj +25 -87
  137. package/libusb/msvc/libusb_static_2013.vcxproj +25 -87
  138. package/libusb/msvc/libusb_static_2015.vcxproj +98 -0
  139. package/libusb/msvc/libusb_static_2017.vcxproj +117 -0
  140. package/libusb/msvc/libusb_static_wince.vcproj +20 -26
  141. package/libusb/msvc/libusb_wince.sln +88 -88
  142. package/libusb/msvc/listdevs_2010.vcxproj +16 -99
  143. package/libusb/msvc/listdevs_2012.vcxproj +16 -102
  144. package/libusb/msvc/listdevs_2013.vcxproj +16 -102
  145. package/libusb/msvc/listdevs_2015.vcxproj +83 -0
  146. package/libusb/msvc/listdevs_2017.vcxproj +106 -0
  147. package/libusb/msvc/listdevs_sources +2 -1
  148. package/libusb/msvc/stress_2010.vcxproj +20 -101
  149. package/libusb/msvc/stress_2012.vcxproj +20 -104
  150. package/libusb/msvc/stress_2013.vcxproj +20 -104
  151. package/libusb/msvc/stress_2015.vcxproj +87 -0
  152. package/libusb/msvc/stress_2017.vcxproj +110 -0
  153. package/libusb/msvc/stress_sources +21 -0
  154. package/libusb/msvc/testlibusb_2010.vcxproj +82 -0
  155. package/libusb/msvc/testlibusb_2012.vcxproj +83 -0
  156. package/libusb/msvc/testlibusb_2013.vcxproj +83 -0
  157. package/libusb/msvc/testlibusb_2015.vcxproj +83 -0
  158. package/libusb/msvc/testlibusb_2017.vcxproj +106 -0
  159. package/libusb/msvc/testlibusb_sources +20 -0
  160. package/libusb/msvc/xusb_2010.vcxproj +17 -98
  161. package/libusb/msvc/xusb_2012.vcxproj +17 -101
  162. package/libusb/msvc/xusb_2013.vcxproj +17 -101
  163. package/libusb/msvc/xusb_2015.vcxproj +83 -0
  164. package/libusb/msvc/xusb_2017.vcxproj +106 -0
  165. package/libusb/msvc/xusb_sources +1 -1
  166. package/libusb/tests/stress.c +2 -2
  167. package/libusb/tests/testlib.c +0 -4
  168. package/libusb/travis-autogen.sh +39 -0
  169. package/libusb.gypi +21 -2
  170. package/package.json +18 -13
  171. package/prebuilds/android-arm/node.napi.node +0 -0
  172. package/prebuilds/android-arm64/node.napi.node +0 -0
  173. package/prebuilds/darwin-x64+arm64/node.napi.node +0 -0
  174. package/prebuilds/linux-arm/node.napi.node +0 -0
  175. package/prebuilds/linux-arm64/node.napi.node +0 -0
  176. package/prebuilds/linux-ia32/node.napi.node +0 -0
  177. package/prebuilds/linux-x64/node.napi.node +0 -0
  178. package/prebuilds/win32-ia32/node.napi.node +0 -0
  179. package/prebuilds/win32-x64/node.napi.node +0 -0
  180. package/src/device.cc +7 -7
  181. package/src/node_usb.cc +43 -1
  182. package/src/node_usb.h +1 -0
  183. package/src/uv_async_queue.h +33 -25
  184. package/test/usb.coffee +6 -0
  185. package/tsc/index.ts +13 -7
  186. package/tsc/usb/bindings.ts +19 -1
  187. package/tsc/usb/index.ts +67 -19
  188. package/tsc/usb/interface.ts +2 -2
  189. package/tsc/webusb/index.ts +197 -74
  190. package/tsc/webusb/webusb-device.ts +30 -17
  191. package/.github/workflows/prebuild.yml +0 -48
  192. package/Readme.md +0 -339
  193. package/dist/webusb/typed-event-target.d.ts +0 -11
  194. package/dist/webusb/typed-event-target.js +0 -21
  195. package/dist/webusb/typed-event-target.js.map +0 -1
  196. package/docs/assets/css/main.css +0 -2660
  197. package/docs/assets/images/icons.png +0 -0
  198. package/docs/assets/images/icons@2x.png +0 -0
  199. package/docs/assets/images/widgets.png +0 -0
  200. package/docs/assets/images/widgets@2x.png +0 -0
  201. package/docs/assets/js/main.js +0 -248
  202. package/docs/assets/js/search.js +0 -1
  203. package/docs/classes/usb_bindings.device.html +0 -1338
  204. package/docs/classes/usb_bindings.libusbexception.html +0 -234
  205. package/docs/classes/usb_bindings.transfer.html +0 -344
  206. package/docs/classes/usb_capability.capability.html +0 -297
  207. package/docs/classes/usb_device.extendeddevice.html +0 -766
  208. package/docs/classes/usb_endpoint.endpoint.html +0 -472
  209. package/docs/classes/usb_endpoint.inendpoint.html +0 -766
  210. package/docs/classes/usb_endpoint.outendpoint.html +0 -582
  211. package/docs/classes/usb_interface.interface.html +0 -648
  212. package/docs/classes/webusb.webusb-1.html +0 -615
  213. package/docs/classes/webusb_mutex.mutex.html +0 -270
  214. package/docs/classes/webusb_typed_event_target.typedeventtarget.html +0 -443
  215. package/docs/classes/webusb_webusb_device.webusbdevice.html +0 -904
  216. package/docs/index.html +0 -500
  217. package/docs/interfaces/usb.deviceevents.html +0 -242
  218. package/docs/interfaces/usb_descriptors.bosdescriptor.html +0 -293
  219. package/docs/interfaces/usb_descriptors.capabilitydescriptor.html +0 -274
  220. package/docs/interfaces/usb_descriptors.configdescriptor.html +0 -388
  221. package/docs/interfaces/usb_descriptors.devicedescriptor.html +0 -464
  222. package/docs/interfaces/usb_descriptors.endpointdescriptor.html +0 -370
  223. package/docs/interfaces/usb_descriptors.interfacedescriptor.html +0 -407
  224. package/docs/interfaces/webusb.usboptions.html +0 -226
  225. package/docs/modules/index.html +0 -304
  226. package/docs/modules/usb.html +0 -173
  227. package/docs/modules/usb_bindings.html +0 -2248
  228. package/docs/modules/usb_capability.html +0 -156
  229. package/docs/modules/usb_descriptors.html +0 -176
  230. package/docs/modules/usb_device.html +0 -156
  231. package/docs/modules/usb_endpoint.html +0 -164
  232. package/docs/modules/usb_interface.html +0 -156
  233. package/docs/modules/webusb.html +0 -165
  234. package/docs/modules/webusb_mutex.html +0 -156
  235. package/docs/modules/webusb_typed_event_target.html +0 -156
  236. package/docs/modules/webusb_webusb_device.html +0 -156
  237. package/docs/modules.html +0 -156
  238. package/libusb/INSTALL +0 -234
  239. package/libusb/README +0 -28
  240. package/libusb/libusb/os/windows_usb.c +0 -5347
  241. package/libusb/libusb/os/windows_usb.h +0 -971
  242. package/libusb/msvc/fxload_2010.vcxproj.filters +0 -25
  243. package/libusb/msvc/fxload_2012.vcxproj.filters +0 -25
  244. package/libusb/msvc/getopt_2010.vcxproj.filters +0 -26
  245. package/libusb/msvc/getopt_2012.vcxproj.filters +0 -26
  246. package/libusb/msvc/hotplugtest_2010.vcxproj.filters +0 -14
  247. package/libusb/msvc/hotplugtest_2012.vcxproj.filters +0 -14
  248. package/libusb/msvc/libusb_dll_2010.vcxproj.filters +0 -81
  249. package/libusb/msvc/libusb_dll_2012.vcxproj.filters +0 -84
  250. package/libusb/msvc/libusb_static_2010.vcxproj.filters +0 -74
  251. package/libusb/msvc/libusb_static_2012.vcxproj.filters +0 -74
  252. package/libusb/msvc/listdevs_2010.vcxproj.filters +0 -14
  253. package/libusb/msvc/listdevs_2012.vcxproj.filters +0 -14
  254. package/libusb/msvc/stress_2010.vcxproj.filters +0 -25
  255. package/libusb/msvc/stress_2012.vcxproj.filters +0 -25
  256. package/libusb/msvc/xusb_2010.vcxproj.filters +0 -14
  257. package/libusb/msvc/xusb_2012.vcxproj.filters +0 -14
  258. package/tsc/webusb/typed-event-target.ts +0 -23
package/docs/classes/usb_device.extendeddevice.html DELETED
@@ -1,766 +0,0 @@
1
- <!doctype html>
2
- <html class="default no-js">
3
- <head>
4
- <meta charset="utf-8">
5
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>ExtendedDevice | Node USB</title>
7
- <meta name="description" content="Documentation for Node USB">
8
- <meta name="viewport" content="width=device-width, initial-scale=1">
9
- <link rel="stylesheet" href="../assets/css/main.css">
10
- <script async src="../assets/js/search.js" id="search-script"></script>
11
- </head>
12
- <body>
13
- <header>
14
- <div class="tsd-page-toolbar">
15
- <div class="container">
16
- <div class="table-wrap">
17
- <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
- <div class="field">
19
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
- <input id="tsd-search-field" type="text" />
21
- </div>
22
- <ul class="results">
23
- <li class="state loading">Preparing search index...</li>
24
- <li class="state failure">The search index is not available</li>
25
- </ul>
26
- <a href="../index.html" class="title">Node USB</a>
27
- </div>
28
- <div class="table-cell" id="tsd-widgets">
29
- <div id="tsd-filter">
30
- <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
- <div class="tsd-filter-group">
32
- <div class="tsd-select" id="tsd-filter-visibility">
33
- <span class="tsd-select-label">All</span>
34
- <ul class="tsd-select-list">
35
- <li data-value="public">Public</li>
36
- <li data-value="protected">Public/Protected</li>
37
- <li data-value="private" class="selected">All</li>
38
- </ul>
39
- </div>
40
- <input type="checkbox" id="tsd-filter-inherited" checked />
41
- <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
- </div>
43
- </div>
44
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
45
- </div>
46
- </div>
47
- </div>
48
- </div>
49
- <div class="tsd-page-title">
50
- <div class="container">
51
- <ul class="tsd-breadcrumb">
52
- <li>
53
- <a href="../modules.html">Node USB</a>
54
- </li>
55
- <li>
56
- <a href="../modules/usb_device.html">usb/device</a>
57
- </li>
58
- <li>
59
- <a href="usb_device.extendeddevice.html">ExtendedDevice</a>
60
- </li>
61
- </ul>
62
- <h1>Class ExtendedDevice</h1>
63
- </div>
64
- </div>
65
- </header>
66
- <div class="container container-main">
67
- <div class="row">
68
- <div class="col-8 col-content">
69
- <section class="tsd-panel tsd-hierarchy">
70
- <h3>Hierarchy</h3>
71
- <ul class="tsd-hierarchy">
72
- <li>
73
- <span class="target">ExtendedDevice</span>
74
- <ul class="tsd-hierarchy">
75
- <li>
76
- <a href="usb_bindings.device.html" class="tsd-signature-type" data-tsd-kind="Class">Device</a>
77
- </li>
78
- </ul>
79
- </li>
80
- </ul>
81
- </section>
82
- <section class="tsd-panel-group tsd-index-group">
83
- <h2>Index</h2>
84
- <section class="tsd-panel tsd-index-panel">
85
- <div class="tsd-index-content">
86
- <section class="tsd-index-section ">
87
- <h3>Constructors</h3>
88
- <ul class="tsd-index-list">
89
- <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="usb_device.extendeddevice.html#constructor" class="tsd-kind-icon">constructor</a></li>
90
- </ul>
91
- </section>
92
- <section class="tsd-index-section ">
93
- <h3>Properties</h3>
94
- <ul class="tsd-index-list">
95
- <li class="tsd-kind-property tsd-parent-kind-class"><a href="usb_device.extendeddevice.html#interfaces" class="tsd-kind-icon">interfaces</a></li>
96
- </ul>
97
- </section>
98
- <section class="tsd-index-section ">
99
- <h3>Accessors</h3>
100
- <ul class="tsd-index-list">
101
- <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="usb_device.extendeddevice.html#allconfigdescriptors" class="tsd-kind-icon">all<wbr>Config<wbr>Descriptors</a></li>
102
- <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="usb_device.extendeddevice.html#configdescriptor" class="tsd-kind-icon">config<wbr>Descriptor</a></li>
103
- <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="usb_device.extendeddevice.html#parent" class="tsd-kind-icon">parent</a></li>
104
- <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="usb_device.extendeddevice.html#timeout" class="tsd-kind-icon">timeout</a></li>
105
- </ul>
106
- </section>
107
- <section class="tsd-index-section ">
108
- <h3>Methods</h3>
109
- <ul class="tsd-index-list">
110
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="usb_device.extendeddevice.html#close" class="tsd-kind-icon">close</a></li>
111
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="usb_device.extendeddevice.html#controltransfer" class="tsd-kind-icon">control<wbr>Transfer</a></li>
112
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="usb_device.extendeddevice.html#getbosdescriptor" class="tsd-kind-icon">get<wbr>Bos<wbr>Descriptor</a></li>
113
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="usb_device.extendeddevice.html#getcapabilities" class="tsd-kind-icon">get<wbr>Capabilities</a></li>
114
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="usb_device.extendeddevice.html#getstringdescriptor" class="tsd-kind-icon">get<wbr>String<wbr>Descriptor</a></li>
115
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="usb_device.extendeddevice.html#interface" class="tsd-kind-icon">interface</a></li>
116
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="usb_device.extendeddevice.html#open" class="tsd-kind-icon">open</a></li>
117
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="usb_device.extendeddevice.html#setconfiguration" class="tsd-kind-icon">set<wbr>Configuration</a></li>
118
- </ul>
119
- </section>
120
- </div>
121
- </section>
122
- </section>
123
- <section class="tsd-panel-group tsd-member-group ">
124
- <h2>Constructors</h2>
125
- <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
126
- <a name="constructor" class="tsd-anchor"></a>
127
- <h3>constructor</h3>
128
- <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
129
- <li class="tsd-signature tsd-kind-icon">new <wbr>Extended<wbr>Device<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="usb_device.extendeddevice.html" class="tsd-signature-type" data-tsd-kind="Class">ExtendedDevice</a></li>
130
- </ul>
131
- <ul class="tsd-descriptions">
132
- <li class="tsd-description">
133
- <aside class="tsd-sources">
134
- </aside>
135
- <h4 class="tsd-returns-title">Returns <a href="usb_device.extendeddevice.html" class="tsd-signature-type" data-tsd-kind="Class">ExtendedDevice</a></h4>
136
- </li>
137
- </ul>
138
- </section>
139
- </section>
140
- <section class="tsd-panel-group tsd-member-group ">
141
- <h2>Properties</h2>
142
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
143
- <a name="interfaces" class="tsd-anchor"></a>
144
- <h3>interfaces</h3>
145
- <div class="tsd-signature tsd-kind-icon">interfaces<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="usb_interface.interface.html" class="tsd-signature-type" data-tsd-kind="Class">Interface</a><span class="tsd-signature-symbol">[]</span></div>
146
- <aside class="tsd-sources">
147
- <ul>
148
- <li>Defined in <a href="https://github.com/tessel/node-usb/blob/639b0a3/tsc/usb/device.ts#L13">tsc/usb/device.ts:13</a></li>
149
- </ul>
150
- </aside>
151
- <div class="tsd-comment tsd-typography">
152
- <div class="lead">
153
- <p>List of Interface objects for the interfaces of the default configuration of the device.</p>
154
- </div>
155
- </div>
156
- </section>
157
- </section>
158
- <section class="tsd-panel-group tsd-member-group ">
159
- <h2>Accessors</h2>
160
- <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
161
- <a name="allconfigdescriptors" class="tsd-anchor"></a>
162
- <h3>all<wbr>Config<wbr>Descriptors</h3>
163
- <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
164
- <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> allConfigDescriptors<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/usb_descriptors.configdescriptor.html" class="tsd-signature-type" data-tsd-kind="Interface">ConfigDescriptor</a><span class="tsd-signature-symbol">[]</span></li>
165
- </ul>
166
- <ul class="tsd-descriptions">
167
- <li class="tsd-description">
168
- <aside class="tsd-sources">
169
- <ul>
170
- <li>Defined in <a href="https://github.com/tessel/node-usb/blob/639b0a3/tsc/usb/device.ts#L44">tsc/usb/device.ts:44</a></li>
171
- </ul>
172
- </aside>
173
- <div class="tsd-comment tsd-typography">
174
- <div class="lead">
175
- <p>Contains all config descriptors of the device (same structure as .configDescriptor above)</p>
176
- </div>
177
- </div>
178
- <h4 class="tsd-returns-title">Returns <a href="../interfaces/usb_descriptors.configdescriptor.html" class="tsd-signature-type" data-tsd-kind="Interface">ConfigDescriptor</a><span class="tsd-signature-symbol">[]</span></h4>
179
- </li>
180
- </ul>
181
- </section>
182
- <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
183
- <a name="configdescriptor" class="tsd-anchor"></a>
184
- <h3>config<wbr>Descriptor</h3>
185
- <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
186
- <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> configDescriptor<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/usb_descriptors.configdescriptor.html" class="tsd-signature-type" data-tsd-kind="Interface">ConfigDescriptor</a></li>
187
- </ul>
188
- <ul class="tsd-descriptions">
189
- <li class="tsd-description">
190
- <aside class="tsd-sources">
191
- <ul>
192
- <li>Defined in <a href="https://github.com/tessel/node-usb/blob/639b0a3/tsc/usb/device.ts#L29">tsc/usb/device.ts:29</a></li>
193
- </ul>
194
- </aside>
195
- <div class="tsd-comment tsd-typography">
196
- <div class="lead">
197
- <p>Object with properties for the fields of the active configuration descriptor.</p>
198
- </div>
199
- </div>
200
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/usb_descriptors.configdescriptor.html" class="tsd-signature-type" data-tsd-kind="Interface">ConfigDescriptor</a></h4>
201
- </li>
202
- </ul>
203
- </section>
204
- <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
205
- <a name="parent" class="tsd-anchor"></a>
206
- <h3>parent</h3>
207
- <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
208
- <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> parent<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="usb_bindings.device.html" class="tsd-signature-type" data-tsd-kind="Class">Device</a></li>
209
- </ul>
210
- <ul class="tsd-descriptions">
211
- <li class="tsd-description">
212
- <aside class="tsd-sources">
213
- <ul>
214
- <li>Defined in <a href="https://github.com/tessel/node-usb/blob/639b0a3/tsc/usb/device.ts#L59">tsc/usb/device.ts:59</a></li>
215
- </ul>
216
- </aside>
217
- <div class="tsd-comment tsd-typography">
218
- <div class="lead">
219
- <p>Contains the parent of the device, such as a hub. If there is no parent this property is set to <code>null</code>.</p>
220
- </div>
221
- </div>
222
- <h4 class="tsd-returns-title">Returns <a href="usb_bindings.device.html" class="tsd-signature-type" data-tsd-kind="Class">Device</a></h4>
223
- </li>
224
- </ul>
225
- </section>
226
- <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
227
- <a name="timeout" class="tsd-anchor"></a>
228
- <h3>timeout</h3>
229
- <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
230
- <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> timeout<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
231
- <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> timeout<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
232
- </ul>
233
- <ul class="tsd-descriptions">
234
- <li class="tsd-description">
235
- <aside class="tsd-sources">
236
- <ul>
237
- <li>Defined in <a href="https://github.com/tessel/node-usb/blob/639b0a3/tsc/usb/device.ts#L19">tsc/usb/device.ts:19</a></li>
238
- </ul>
239
- </aside>
240
- <div class="tsd-comment tsd-typography">
241
- <div class="lead">
242
- <p>Timeout in milliseconds to use for control transfers.</p>
243
- </div>
244
- </div>
245
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
246
- </li>
247
- <li class="tsd-description">
248
- <aside class="tsd-sources">
249
- <ul>
250
- <li>Defined in <a href="https://github.com/tessel/node-usb/blob/639b0a3/tsc/usb/device.ts#L22">tsc/usb/device.ts:22</a></li>
251
- </ul>
252
- </aside>
253
- <div class="tsd-comment tsd-typography">
254
- <div class="lead">
255
- <p>Timeout in milliseconds to use for control transfers.</p>
256
- </div>
257
- </div>
258
- <h4 class="tsd-parameters-title">Parameters</h4>
259
- <ul class="tsd-parameters">
260
- <li>
261
- <h5>value: <span class="tsd-signature-type">number</span></h5>
262
- </li>
263
- </ul>
264
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
265
- </li>
266
- </ul>
267
- </section>
268
- </section>
269
- <section class="tsd-panel-group tsd-member-group ">
270
- <h2>Methods</h2>
271
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
272
- <a name="close" class="tsd-anchor"></a>
273
- <h3>close</h3>
274
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
275
- <li class="tsd-signature tsd-kind-icon">close<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
276
- </ul>
277
- <ul class="tsd-descriptions">
278
- <li class="tsd-description">
279
- <aside class="tsd-sources">
280
- <ul>
281
- <li>Defined in <a href="https://github.com/tessel/node-usb/blob/639b0a3/tsc/usb/device.ts#L84">tsc/usb/device.ts:84</a></li>
282
- </ul>
283
- </aside>
284
- <div class="tsd-comment tsd-typography">
285
- <div class="lead">
286
- <p>Close the device.</p>
287
- </div>
288
- <p>The device must be open to use this method.</p>
289
- </div>
290
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
291
- </li>
292
- </ul>
293
- </section>
294
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
295
- <a name="controltransfer" class="tsd-anchor"></a>
296
- <h3>control<wbr>Transfer</h3>
297
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
298
- <li class="tsd-signature tsd-kind-icon">control<wbr>Transfer<span class="tsd-signature-symbol">(</span>bmRequestType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, bRequest<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, wValue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, wIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, data_or_length<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="usb_bindings.libusbexception.html" class="tsd-signature-type" data-tsd-kind="Class">LibUSBException</a>, buffer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="usb_bindings.device.html" class="tsd-signature-type" data-tsd-kind="Class">Device</a></li>
299
- </ul>
300
- <ul class="tsd-descriptions">
301
- <li class="tsd-description">
302
- <aside class="tsd-sources">
303
- <ul>
304
- <li>Defined in <a href="https://github.com/tessel/node-usb/blob/639b0a3/tsc/usb/device.ts#L127">tsc/usb/device.ts:127</a></li>
305
- </ul>
306
- </aside>
307
- <div class="tsd-comment tsd-typography">
308
- <div class="lead">
309
- <p>Perform a control transfer with <code>libusb_control_transfer</code>.</p>
310
- </div>
311
- <p>Parameter <code>data_or_length</code> can be an integer length for an IN transfer, or a <code>Buffer</code> for an OUT transfer. The type must match the direction specified in the MSB of bmRequestType.</p>
312
- <p>The <code>data</code> parameter of the callback is actual transferred for OUT transfers, or will be passed a Buffer for IN transfers.</p>
313
- <p>The device must be open to use this method.</p>
314
- </div>
315
- <h4 class="tsd-parameters-title">Parameters</h4>
316
- <ul class="tsd-parameters">
317
- <li>
318
- <h5>bmRequestType: <span class="tsd-signature-type">number</span></h5>
319
- </li>
320
- <li>
321
- <h5>bRequest: <span class="tsd-signature-type">number</span></h5>
322
- </li>
323
- <li>
324
- <h5>wValue: <span class="tsd-signature-type">number</span></h5>
325
- </li>
326
- <li>
327
- <h5>wIndex: <span class="tsd-signature-type">number</span></h5>
328
- </li>
329
- <li>
330
- <h5>data_or_length: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span></h5>
331
- </li>
332
- <li>
333
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="usb_bindings.libusbexception.html" class="tsd-signature-type" data-tsd-kind="Class">LibUSBException</a>, buffer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
334
- <div class="tsd-comment tsd-typography">
335
- </div>
336
- <ul class="tsd-parameters">
337
- <li class="tsd-parameter-signature">
338
- <ul class="tsd-signatures tsd-kind-type-literal">
339
- <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="usb_bindings.libusbexception.html" class="tsd-signature-type" data-tsd-kind="Class">LibUSBException</a>, buffer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
340
- </ul>
341
- <ul class="tsd-descriptions">
342
- <li class="tsd-description">
343
- <h4 class="tsd-parameters-title">Parameters</h4>
344
- <ul class="tsd-parameters">
345
- <li>
346
- <h5>error: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="usb_bindings.libusbexception.html" class="tsd-signature-type" data-tsd-kind="Class">LibUSBException</a></h5>
347
- </li>
348
- <li>
349
- <h5>buffer: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span></h5>
350
- </li>
351
- </ul>
352
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
353
- </li>
354
- </ul>
355
- </li>
356
- </ul>
357
- </li>
358
- </ul>
359
- <h4 class="tsd-returns-title">Returns <a href="usb_bindings.device.html" class="tsd-signature-type" data-tsd-kind="Class">Device</a></h4>
360
- </li>
361
- </ul>
362
- </section>
363
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
364
- <a name="getbosdescriptor" class="tsd-anchor"></a>
365
- <h3>get<wbr>Bos<wbr>Descriptor</h3>
366
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
367
- <li class="tsd-signature tsd-kind-icon">get<wbr>Bos<wbr>Descriptor<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><a href="usb_bindings.libusbexception.html" class="tsd-signature-type" data-tsd-kind="Class">LibUSBException</a>, descriptor<span class="tsd-signature-symbol">?: </span><a href="../interfaces/usb_descriptors.bosdescriptor.html" class="tsd-signature-type" data-tsd-kind="Interface">BosDescriptor</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
368
- </ul>
369
- <ul class="tsd-descriptions">
370
- <li class="tsd-description">
371
- <aside class="tsd-sources">
372
- <ul>
373
- <li>Defined in <a href="https://github.com/tessel/node-usb/blob/639b0a3/tsc/usb/device.ts#L229">tsc/usb/device.ts:229</a></li>
374
- </ul>
375
- </aside>
376
- <div class="tsd-comment tsd-typography">
377
- <div class="lead">
378
- <p>Perform a control transfer to retrieve an object with properties for the fields of the Binary Object Store descriptor.</p>
379
- </div>
380
- <p>The device must be open to use this method.</p>
381
- </div>
382
- <h4 class="tsd-parameters-title">Parameters</h4>
383
- <ul class="tsd-parameters">
384
- <li>
385
- <h5>callback: <span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><a href="usb_bindings.libusbexception.html" class="tsd-signature-type" data-tsd-kind="Class">LibUSBException</a>, descriptor<span class="tsd-signature-symbol">?: </span><a href="../interfaces/usb_descriptors.bosdescriptor.html" class="tsd-signature-type" data-tsd-kind="Interface">BosDescriptor</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
386
- <div class="tsd-comment tsd-typography">
387
- </div>
388
- <ul class="tsd-parameters">
389
- <li class="tsd-parameter-signature">
390
- <ul class="tsd-signatures tsd-kind-type-literal">
391
- <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><a href="usb_bindings.libusbexception.html" class="tsd-signature-type" data-tsd-kind="Class">LibUSBException</a>, descriptor<span class="tsd-signature-symbol">?: </span><a href="../interfaces/usb_descriptors.bosdescriptor.html" class="tsd-signature-type" data-tsd-kind="Interface">BosDescriptor</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
392
- </ul>
393
- <ul class="tsd-descriptions">
394
- <li class="tsd-description">
395
- <h4 class="tsd-parameters-title">Parameters</h4>
396
- <ul class="tsd-parameters">
397
- <li>
398
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> error: <a href="usb_bindings.libusbexception.html" class="tsd-signature-type" data-tsd-kind="Class">LibUSBException</a></h5>
399
- </li>
400
- <li>
401
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> descriptor: <a href="../interfaces/usb_descriptors.bosdescriptor.html" class="tsd-signature-type" data-tsd-kind="Interface">BosDescriptor</a></h5>
402
- </li>
403
- </ul>
404
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
405
- </li>
406
- </ul>
407
- </li>
408
- </ul>
409
- </li>
410
- </ul>
411
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
412
- </li>
413
- </ul>
414
- </section>
415
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
416
- <a name="getcapabilities" class="tsd-anchor"></a>
417
- <h3>get<wbr>Capabilities</h3>
418
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
419
- <li class="tsd-signature tsd-kind-icon">get<wbr>Capabilities<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="usb_bindings.libusbexception.html" class="tsd-signature-type" data-tsd-kind="Class">LibUSBException</a>, capabilities<span class="tsd-signature-symbol">?: </span><a href="usb_capability.capability.html" class="tsd-signature-type" data-tsd-kind="Class">Capability</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
420
- </ul>
421
- <ul class="tsd-descriptions">
422
- <li class="tsd-description">
423
- <aside class="tsd-sources">
424
- <ul>
425
- <li>Defined in <a href="https://github.com/tessel/node-usb/blob/639b0a3/tsc/usb/device.ts#L311">tsc/usb/device.ts:311</a></li>
426
- </ul>
427
- </aside>
428
- <div class="tsd-comment tsd-typography">
429
- <div class="lead">
430
- <p>Retrieve a list of Capability objects for the Binary Object Store capabilities of the device.</p>
431
- </div>
432
- <p>The device must be open to use this method.</p>
433
- </div>
434
- <h4 class="tsd-parameters-title">Parameters</h4>
435
- <ul class="tsd-parameters">
436
- <li>
437
- <h5>callback: <span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="usb_bindings.libusbexception.html" class="tsd-signature-type" data-tsd-kind="Class">LibUSBException</a>, capabilities<span class="tsd-signature-symbol">?: </span><a href="usb_capability.capability.html" class="tsd-signature-type" data-tsd-kind="Class">Capability</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
438
- <div class="tsd-comment tsd-typography">
439
- </div>
440
- <ul class="tsd-parameters">
441
- <li class="tsd-parameter-signature">
442
- <ul class="tsd-signatures tsd-kind-type-literal">
443
- <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="usb_bindings.libusbexception.html" class="tsd-signature-type" data-tsd-kind="Class">LibUSBException</a>, capabilities<span class="tsd-signature-symbol">?: </span><a href="usb_capability.capability.html" class="tsd-signature-type" data-tsd-kind="Class">Capability</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
444
- </ul>
445
- <ul class="tsd-descriptions">
446
- <li class="tsd-description">
447
- <h4 class="tsd-parameters-title">Parameters</h4>
448
- <ul class="tsd-parameters">
449
- <li>
450
- <h5>error: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="usb_bindings.libusbexception.html" class="tsd-signature-type" data-tsd-kind="Class">LibUSBException</a></h5>
451
- </li>
452
- <li>
453
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> capabilities: <a href="usb_capability.capability.html" class="tsd-signature-type" data-tsd-kind="Class">Capability</a><span class="tsd-signature-symbol">[]</span></h5>
454
- </li>
455
- </ul>
456
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
457
- </li>
458
- </ul>
459
- </li>
460
- </ul>
461
- </li>
462
- </ul>
463
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
464
- </li>
465
- </ul>
466
- </section>
467
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
468
- <a name="getstringdescriptor" class="tsd-anchor"></a>
469
- <h3>get<wbr>String<wbr>Descriptor</h3>
470
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
471
- <li class="tsd-signature tsd-kind-icon">get<wbr>String<wbr>Descriptor<span class="tsd-signature-symbol">(</span>desc_index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><a href="usb_bindings.libusbexception.html" class="tsd-signature-type" data-tsd-kind="Class">LibUSBException</a>, value<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
472
- </ul>
473
- <ul class="tsd-descriptions">
474
- <li class="tsd-description">
475
- <aside class="tsd-sources">
476
- <ul>
477
- <li>Defined in <a href="https://github.com/tessel/node-usb/blob/639b0a3/tsc/usb/device.ts#L205">tsc/usb/device.ts:205</a></li>
478
- </ul>
479
- </aside>
480
- <div class="tsd-comment tsd-typography">
481
- <div class="lead">
482
- <p>Perform a control transfer to retrieve a string descriptor</p>
483
- </div>
484
- <p>The device must be open to use this method.</p>
485
- </div>
486
- <h4 class="tsd-parameters-title">Parameters</h4>
487
- <ul class="tsd-parameters">
488
- <li>
489
- <h5>desc_index: <span class="tsd-signature-type">number</span></h5>
490
- </li>
491
- <li>
492
- <h5>callback: <span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><a href="usb_bindings.libusbexception.html" class="tsd-signature-type" data-tsd-kind="Class">LibUSBException</a>, value<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
493
- <div class="tsd-comment tsd-typography">
494
- </div>
495
- <ul class="tsd-parameters">
496
- <li class="tsd-parameter-signature">
497
- <ul class="tsd-signatures tsd-kind-type-literal">
498
- <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><a href="usb_bindings.libusbexception.html" class="tsd-signature-type" data-tsd-kind="Class">LibUSBException</a>, value<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
499
- </ul>
500
- <ul class="tsd-descriptions">
501
- <li class="tsd-description">
502
- <h4 class="tsd-parameters-title">Parameters</h4>
503
- <ul class="tsd-parameters">
504
- <li>
505
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> error: <a href="usb_bindings.libusbexception.html" class="tsd-signature-type" data-tsd-kind="Class">LibUSBException</a></h5>
506
- </li>
507
- <li>
508
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> value: <span class="tsd-signature-type">string</span></h5>
509
- </li>
510
- </ul>
511
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
512
- </li>
513
- </ul>
514
- </li>
515
- </ul>
516
- </li>
517
- </ul>
518
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
519
- </li>
520
- </ul>
521
- </section>
522
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
523
- <a name="interface" class="tsd-anchor"></a>
524
- <h3>interface</h3>
525
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
526
- <li class="tsd-signature tsd-kind-icon">interface<span class="tsd-signature-symbol">(</span>addr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="usb_interface.interface.html" class="tsd-signature-type" data-tsd-kind="Class">Interface</a></li>
527
- </ul>
528
- <ul class="tsd-descriptions">
529
- <li class="tsd-description">
530
- <aside class="tsd-sources">
531
- <ul>
532
- <li>Defined in <a href="https://github.com/tessel/node-usb/blob/639b0a3/tsc/usb/device.ts#L183">tsc/usb/device.ts:183</a></li>
533
- </ul>
534
- </aside>
535
- <div class="tsd-comment tsd-typography">
536
- <div class="lead">
537
- <p>Return the interface with the specified interface number.</p>
538
- </div>
539
- <p>The device must be open to use this method.</p>
540
- </div>
541
- <h4 class="tsd-parameters-title">Parameters</h4>
542
- <ul class="tsd-parameters">
543
- <li>
544
- <h5>addr: <span class="tsd-signature-type">number</span></h5>
545
- <div class="tsd-comment tsd-typography">
546
- </div>
547
- </li>
548
- </ul>
549
- <h4 class="tsd-returns-title">Returns <a href="usb_interface.interface.html" class="tsd-signature-type" data-tsd-kind="Class">Interface</a></h4>
550
- </li>
551
- </ul>
552
- </section>
553
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
554
- <a name="open" class="tsd-anchor"></a>
555
- <h3>open</h3>
556
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
557
- <li class="tsd-signature tsd-kind-icon">open<span class="tsd-signature-symbol">(</span>defaultConfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
558
- </ul>
559
- <ul class="tsd-descriptions">
560
- <li class="tsd-description">
561
- <aside class="tsd-sources">
562
- <ul>
563
- <li>Defined in <a href="https://github.com/tessel/node-usb/blob/639b0a3/tsc/usb/device.ts#L67">tsc/usb/device.ts:67</a></li>
564
- </ul>
565
- </aside>
566
- <div class="tsd-comment tsd-typography">
567
- <div class="lead">
568
- <p>Open the device.</p>
569
- </div>
570
- </div>
571
- <h4 class="tsd-parameters-title">Parameters</h4>
572
- <ul class="tsd-parameters">
573
- <li>
574
- <h5>defaultConfig: <span class="tsd-signature-type">boolean</span></h5>
575
- <div class="tsd-comment tsd-typography">
576
- </div>
577
- </li>
578
- </ul>
579
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
580
- </li>
581
- </ul>
582
- </section>
583
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
584
- <a name="setconfiguration" class="tsd-anchor"></a>
585
- <h3>set<wbr>Configuration</h3>
586
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
587
- <li class="tsd-signature tsd-kind-icon">set<wbr>Configuration<span class="tsd-signature-symbol">(</span>desired<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="usb_bindings.libusbexception.html" class="tsd-signature-type" data-tsd-kind="Class">LibUSBException</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
588
- </ul>
589
- <ul class="tsd-descriptions">
590
- <li class="tsd-description">
591
- <aside class="tsd-sources">
592
- <ul>
593
- <li>Defined in <a href="https://github.com/tessel/node-usb/blob/639b0a3/tsc/usb/device.ts#L97">tsc/usb/device.ts:97</a></li>
594
- </ul>
595
- </aside>
596
- <div class="tsd-comment tsd-typography">
597
- <div class="lead">
598
- <p>Set the device configuration to something other than the default (0). To use this, first call <code>.open(false)</code> (which tells it not to auto configure),
599
- then before claiming an interface, call this method.</p>
600
- </div>
601
- <p>The device must be open to use this method.</p>
602
- </div>
603
- <h4 class="tsd-parameters-title">Parameters</h4>
604
- <ul class="tsd-parameters">
605
- <li>
606
- <h5>desired: <span class="tsd-signature-type">number</span></h5>
607
- </li>
608
- <li>
609
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="usb_bindings.libusbexception.html" class="tsd-signature-type" data-tsd-kind="Class">LibUSBException</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
610
- <div class="tsd-comment tsd-typography">
611
- </div>
612
- <ul class="tsd-parameters">
613
- <li class="tsd-parameter-signature">
614
- <ul class="tsd-signatures tsd-kind-type-literal">
615
- <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="usb_bindings.libusbexception.html" class="tsd-signature-type" data-tsd-kind="Class">LibUSBException</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
616
- </ul>
617
- <ul class="tsd-descriptions">
618
- <li class="tsd-description">
619
- <h4 class="tsd-parameters-title">Parameters</h4>
620
- <ul class="tsd-parameters">
621
- <li>
622
- <h5>error: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="usb_bindings.libusbexception.html" class="tsd-signature-type" data-tsd-kind="Class">LibUSBException</a></h5>
623
- </li>
624
- </ul>
625
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
626
- </li>
627
- </ul>
628
- </li>
629
- </ul>
630
- </li>
631
- </ul>
632
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
633
- </li>
634
- </ul>
635
- </section>
636
- </section>
637
- </div>
638
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
639
- <nav class="tsd-navigation primary">
640
- <ul>
641
- <li class=" ">
642
- <a href="../modules.html">Exports</a>
643
- </li>
644
- <li class=" tsd-kind-module">
645
- <a href="../modules/index.html">index</a>
646
- </li>
647
- <li class=" tsd-kind-module">
648
- <a href="../modules/usb.html">usb</a>
649
- </li>
650
- <li class=" tsd-kind-module">
651
- <a href="../modules/usb_bindings.html">usb/bindings</a>
652
- </li>
653
- <li class=" tsd-kind-module">
654
- <a href="../modules/usb_capability.html">usb/capability</a>
655
- </li>
656
- <li class=" tsd-kind-module">
657
- <a href="../modules/usb_descriptors.html">usb/descriptors</a>
658
- </li>
659
- <li class="current tsd-kind-module">
660
- <a href="../modules/usb_device.html">usb/device</a>
661
- </li>
662
- <li class=" tsd-kind-module">
663
- <a href="../modules/usb_endpoint.html">usb/endpoint</a>
664
- </li>
665
- <li class=" tsd-kind-module">
666
- <a href="../modules/usb_interface.html">usb/interface</a>
667
- </li>
668
- <li class=" tsd-kind-module">
669
- <a href="../modules/webusb.html">webusb</a>
670
- </li>
671
- <li class=" tsd-kind-module">
672
- <a href="../modules/webusb_mutex.html">webusb/mutex</a>
673
- </li>
674
- <li class=" tsd-kind-module">
675
- <a href="../modules/webusb_typed_event_target.html">webusb/typed-<wbr>event-<wbr>target</a>
676
- </li>
677
- <li class=" tsd-kind-module">
678
- <a href="../modules/webusb_webusb_device.html">webusb/webusb-<wbr>device</a>
679
- </li>
680
- </ul>
681
- </nav>
682
- <nav class="tsd-navigation secondary menu-sticky">
683
- <ul class="before-current">
684
- </ul>
685
- <ul class="current">
686
- <li class="current tsd-kind-class tsd-parent-kind-module">
687
- <a href="usb_device.extendeddevice.html" class="tsd-kind-icon">Extended<wbr>Device</a>
688
- <ul>
689
- <li class=" tsd-kind-constructor tsd-parent-kind-class">
690
- <a href="usb_device.extendeddevice.html#constructor" class="tsd-kind-icon">constructor</a>
691
- </li>
692
- <li class=" tsd-kind-property tsd-parent-kind-class">
693
- <a href="usb_device.extendeddevice.html#interfaces" class="tsd-kind-icon">interfaces</a>
694
- </li>
695
- <li class=" tsd-kind-get-signature tsd-parent-kind-class">
696
- <a href="usb_device.extendeddevice.html#allconfigdescriptors" class="tsd-kind-icon">all<wbr>Config<wbr>Descriptors</a>
697
- </li>
698
- <li class=" tsd-kind-get-signature tsd-parent-kind-class">
699
- <a href="usb_device.extendeddevice.html#configdescriptor" class="tsd-kind-icon">config<wbr>Descriptor</a>
700
- </li>
701
- <li class=" tsd-kind-get-signature tsd-parent-kind-class">
702
- <a href="usb_device.extendeddevice.html#parent" class="tsd-kind-icon">parent</a>
703
- </li>
704
- <li class=" tsd-kind-accessor tsd-parent-kind-class">
705
- <a href="usb_device.extendeddevice.html#timeout" class="tsd-kind-icon">timeout</a>
706
- </li>
707
- <li class=" tsd-kind-method tsd-parent-kind-class">
708
- <a href="usb_device.extendeddevice.html#close" class="tsd-kind-icon">close</a>
709
- </li>
710
- <li class=" tsd-kind-method tsd-parent-kind-class">
711
- <a href="usb_device.extendeddevice.html#controltransfer" class="tsd-kind-icon">control<wbr>Transfer</a>
712
- </li>
713
- <li class=" tsd-kind-method tsd-parent-kind-class">
714
- <a href="usb_device.extendeddevice.html#getbosdescriptor" class="tsd-kind-icon">get<wbr>Bos<wbr>Descriptor</a>
715
- </li>
716
- <li class=" tsd-kind-method tsd-parent-kind-class">
717
- <a href="usb_device.extendeddevice.html#getcapabilities" class="tsd-kind-icon">get<wbr>Capabilities</a>
718
- </li>
719
- <li class=" tsd-kind-method tsd-parent-kind-class">
720
- <a href="usb_device.extendeddevice.html#getstringdescriptor" class="tsd-kind-icon">get<wbr>String<wbr>Descriptor</a>
721
- </li>
722
- <li class=" tsd-kind-method tsd-parent-kind-class">
723
- <a href="usb_device.extendeddevice.html#interface" class="tsd-kind-icon">interface</a>
724
- </li>
725
- <li class=" tsd-kind-method tsd-parent-kind-class">
726
- <a href="usb_device.extendeddevice.html#open" class="tsd-kind-icon">open</a>
727
- </li>
728
- <li class=" tsd-kind-method tsd-parent-kind-class">
729
- <a href="usb_device.extendeddevice.html#setconfiguration" class="tsd-kind-icon">set<wbr>Configuration</a>
730
- </li>
731
- </ul>
732
- </li>
733
- </ul>
734
- <ul class="after-current">
735
- </ul>
736
- </nav>
737
- </div>
738
- </div>
739
- </div>
740
- <footer>
741
- <div class="container">
742
- <h2>Legend</h2>
743
- <div class="tsd-legend-group">
744
- <ul class="tsd-legend">
745
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
746
- <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
747
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
748
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
749
- <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
750
- <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
751
- </ul>
752
- <ul class="tsd-legend">
753
- <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
754
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
755
- <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
756
- </ul>
757
- <ul class="tsd-legend">
758
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
759
- </ul>
760
- </div>
761
- </div>
762
- </footer>
763
- <div class="overlay"></div>
764
- <script src="../assets/js/main.js"></script>
765
- </body>
766
- </html>