buttplug 3.2.2 → 4.0.1

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 (179) hide show
  1. package/.eslintrc.js +25 -25
  2. package/.jscsrc +2 -2
  3. package/.jshintrc +5 -5
  4. package/.prettierrc.json +3 -3
  5. package/.yarnrc.yml +5 -5
  6. package/CHANGELOG.md +591 -577
  7. package/LICENSE +27 -27
  8. package/README.md +105 -97
  9. package/dist/main/src/client/ButtplugBrowserWebsocketClientConnector.js +6 -9
  10. package/dist/main/src/client/ButtplugBrowserWebsocketClientConnector.js.map +1 -1
  11. package/dist/main/src/client/{Client.d.ts → ButtplugClient.d.ts} +3 -4
  12. package/dist/main/src/client/ButtplugClient.js +232 -0
  13. package/dist/main/src/client/ButtplugClient.js.map +1 -0
  14. package/dist/main/src/client/ButtplugClientConnectorException.js +17 -7
  15. package/dist/main/src/client/ButtplugClientConnectorException.js.map +1 -1
  16. package/dist/main/src/client/ButtplugClientDevice.d.ts +13 -28
  17. package/dist/main/src/client/ButtplugClientDevice.js +105 -247
  18. package/dist/main/src/client/ButtplugClientDevice.js.map +1 -1
  19. package/dist/main/src/client/ButtplugClientDeviceCommand.d.ts +42 -0
  20. package/dist/main/src/client/ButtplugClientDeviceCommand.js +105 -0
  21. package/dist/main/src/client/ButtplugClientDeviceCommand.js.map +1 -0
  22. package/dist/main/src/client/ButtplugClientDeviceFeature.d.ts +18 -0
  23. package/dist/main/src/client/ButtplugClientDeviceFeature.js +166 -0
  24. package/dist/main/src/client/ButtplugClientDeviceFeature.js.map +1 -0
  25. package/dist/main/src/client/ButtplugNodeWebsocketClientConnector.d.ts +1 -8
  26. package/dist/main/src/client/ButtplugNodeWebsocketClientConnector.js +1 -4
  27. package/dist/main/src/client/ButtplugNodeWebsocketClientConnector.js.map +1 -1
  28. package/dist/main/src/core/Exceptions.js +27 -9
  29. package/dist/main/src/core/Exceptions.js.map +1 -1
  30. package/dist/main/src/core/Logging.js +12 -6
  31. package/dist/main/src/core/Logging.js.map +1 -1
  32. package/dist/main/src/core/Messages.d.ts +119 -230
  33. package/dist/main/src/core/Messages.js +50 -404
  34. package/dist/main/src/core/Messages.js.map +1 -1
  35. package/dist/main/src/index.d.ts +2 -2
  36. package/dist/main/src/index.js +4 -2
  37. package/dist/main/src/index.js.map +1 -1
  38. package/dist/main/src/utils/ButtplugBrowserWebsocketConnector.js +40 -52
  39. package/dist/main/src/utils/ButtplugBrowserWebsocketConnector.js.map +1 -1
  40. package/dist/main/src/utils/ButtplugMessageSorter.js +27 -15
  41. package/dist/main/src/utils/ButtplugMessageSorter.js.map +1 -1
  42. package/dist/main/src/utils/Utils.js +1 -2
  43. package/dist/main/src/utils/Utils.js.map +1 -1
  44. package/dist/web/buttplug.js +1 -38
  45. package/dist/web/buttplug.mjs +595 -1984
  46. package/dist/web/client/ButtplugBrowserWebsocketClientConnector.d.ts +0 -7
  47. package/dist/web/client/{Client.d.ts → ButtplugClient.d.ts} +3 -11
  48. package/dist/web/client/ButtplugClientConnectorException.d.ts +0 -7
  49. package/dist/web/client/ButtplugClientDevice.d.ts +14 -29
  50. package/dist/web/client/ButtplugClientDeviceCommand.d.ts +42 -0
  51. package/dist/web/client/ButtplugClientDeviceFeature.d.ts +18 -0
  52. package/dist/web/client/ButtplugNodeWebsocketClientConnector.d.ts +1 -15
  53. package/dist/web/client/IButtplugClientConnector.d.ts +0 -7
  54. package/dist/web/core/Exceptions.d.ts +1 -1
  55. package/dist/web/core/Logging.d.ts +0 -7
  56. package/dist/web/core/Messages.d.ts +119 -229
  57. package/dist/web/index.d.ts +2 -2
  58. package/dist/web/utils/ButtplugBrowserWebsocketConnector.d.ts +0 -7
  59. package/examples/node/SYNC_MANIFEST.md +105 -0
  60. package/examples/node/application-example.ts +213 -0
  61. package/examples/node/async-example.ts +124 -0
  62. package/examples/node/connection-example.ts +76 -0
  63. package/examples/node/device-control-example.ts +131 -0
  64. package/examples/node/device-enumeration-example.ts +86 -0
  65. package/examples/node/device-info-example.ts +131 -0
  66. package/examples/node/errors-example.ts +166 -0
  67. package/examples/node/package-lock.json +281 -0
  68. package/examples/node/package.json +25 -0
  69. package/examples/node/remote-connector-example.ts +84 -0
  70. package/examples/node/tsconfig.json +14 -0
  71. package/examples/web/application-example.js +197 -0
  72. package/examples/web/async-example.js +90 -0
  73. package/examples/web/device-control-example.js +87 -0
  74. package/examples/web/device-enumeration-example.js +49 -0
  75. package/examples/web/device-info-example.js +100 -0
  76. package/examples/web/errors-example.js +110 -0
  77. package/examples/web/index.html +55 -0
  78. package/examples/web/logging.js +42 -0
  79. package/examples/web/ping-timeout-example.js +59 -0
  80. package/examples/web/remote-connector-example.js +68 -0
  81. package/node-test.js +24 -0
  82. package/node-test.ts +23 -5
  83. package/package.json +85 -87
  84. package/src/client/ButtplugBrowserWebsocketClientConnector.ts +25 -25
  85. package/src/client/ButtplugClient.ts +242 -0
  86. package/src/client/ButtplugClientConnectorException.ts +16 -16
  87. package/src/client/ButtplugClientDevice.ts +178 -401
  88. package/src/client/ButtplugClientDeviceCommand.ts +112 -0
  89. package/src/client/ButtplugClientDeviceFeature.ts +138 -0
  90. package/src/client/ButtplugNodeWebsocketClientConnector.ts +17 -17
  91. package/src/client/IButtplugClientConnector.ts +18 -18
  92. package/src/core/Exceptions.ts +107 -101
  93. package/src/core/Logging.ts +197 -197
  94. package/src/core/Messages.ts +205 -480
  95. package/src/core/index.d.ts +4 -4
  96. package/src/index.ts +21 -19
  97. package/src/utils/ButtplugBrowserWebsocketConnector.ts +89 -89
  98. package/src/utils/ButtplugMessageSorter.ts +66 -65
  99. package/src/utils/Utils.ts +3 -3
  100. package/tsconfig.json +22 -22
  101. package/tsfmt.json +14 -14
  102. package/tslint.json +27 -27
  103. package/typedocconfig.js +6 -6
  104. package/vite.config.ts +26 -26
  105. package/dist/main/src/client/Client.js +0 -242
  106. package/dist/main/src/client/Client.js.map +0 -1
  107. package/dist/main/src/core/MessageUtils.d.ts +0 -10
  108. package/dist/main/src/core/MessageUtils.js +0 -65
  109. package/dist/main/src/core/MessageUtils.js.map +0 -1
  110. package/dist/web/core/MessageUtils.d.ts +0 -10
  111. package/doc/.nojekyll +0 -1
  112. package/doc/assets/highlight.css +0 -22
  113. package/doc/assets/main.js +0 -58
  114. package/doc/assets/search.js +0 -1
  115. package/doc/assets/style.css +0 -1280
  116. package/doc/classes/ButtplugBrowserWebsocketClientConnector.html +0 -234
  117. package/doc/classes/ButtplugClient.html +0 -331
  118. package/doc/classes/ButtplugClientConnectorException.html +0 -216
  119. package/doc/classes/ButtplugClientDevice.html +0 -489
  120. package/doc/classes/ButtplugDeviceError.html +0 -218
  121. package/doc/classes/ButtplugDeviceMessage.html +0 -165
  122. package/doc/classes/ButtplugError.html +0 -220
  123. package/doc/classes/ButtplugInitError.html +0 -218
  124. package/doc/classes/ButtplugLogger.html +0 -288
  125. package/doc/classes/ButtplugMessage.html +0 -147
  126. package/doc/classes/ButtplugMessageError.html +0 -218
  127. package/doc/classes/ButtplugMessageSorter.html +0 -128
  128. package/doc/classes/ButtplugNodeWebsocketClientConnector.html +0 -239
  129. package/doc/classes/ButtplugPingError.html +0 -218
  130. package/doc/classes/ButtplugSystemMessage.html +0 -150
  131. package/doc/classes/ButtplugUnknownError.html +0 -218
  132. package/doc/classes/DeviceAdded.html +0 -186
  133. package/doc/classes/DeviceInfo.html +0 -114
  134. package/doc/classes/DeviceList.html +0 -160
  135. package/doc/classes/DeviceRemoved.html +0 -158
  136. package/doc/classes/Error.html +0 -179
  137. package/doc/classes/GenericDeviceMessageAttributes.html +0 -107
  138. package/doc/classes/GenericMessageSubcommand.html +0 -90
  139. package/doc/classes/LinearCmd.html +0 -187
  140. package/doc/classes/LogMessage.html +0 -134
  141. package/doc/classes/MessageAttributes.html +0 -160
  142. package/doc/classes/Ok.html +0 -151
  143. package/doc/classes/Ping.html +0 -151
  144. package/doc/classes/RawDeviceMessageAttributes.html +0 -86
  145. package/doc/classes/RawReadCmd.html +0 -188
  146. package/doc/classes/RawReading.html +0 -179
  147. package/doc/classes/RawSubscribeCmd.html +0 -170
  148. package/doc/classes/RawUnsubscribeCmd.html +0 -170
  149. package/doc/classes/RawWriteCmd.html +0 -188
  150. package/doc/classes/RequestDeviceList.html +0 -151
  151. package/doc/classes/RequestServerInfo.html +0 -169
  152. package/doc/classes/RotateCmd.html +0 -187
  153. package/doc/classes/RotateSubcommand.html +0 -108
  154. package/doc/classes/ScalarCmd.html +0 -170
  155. package/doc/classes/ScalarSubcommand.html +0 -108
  156. package/doc/classes/ScanningFinished.html +0 -146
  157. package/doc/classes/SensorDeviceMessageAttributes.html +0 -107
  158. package/doc/classes/SensorReadCmd.html +0 -179
  159. package/doc/classes/SensorReading.html +0 -188
  160. package/doc/classes/ServerInfo.html +0 -178
  161. package/doc/classes/StartScanning.html +0 -151
  162. package/doc/classes/StopAllDevices.html +0 -151
  163. package/doc/classes/StopDeviceCmd.html +0 -161
  164. package/doc/classes/StopScanning.html +0 -151
  165. package/doc/classes/VectorSubcommand.html +0 -108
  166. package/doc/enums/ActuatorType.html +0 -104
  167. package/doc/enums/ButtplugLogLevel.html +0 -97
  168. package/doc/enums/ErrorClass.html +0 -90
  169. package/doc/enums/SensorType.html +0 -90
  170. package/doc/functions/FromJSON.html +0 -113
  171. package/doc/index.html +0 -184
  172. package/doc/interfaces/IButtplugClientConnector.html +0 -137
  173. package/doc/modules.html +0 -176
  174. package/doc/variables/DEFAULT_MESSAGE_ID.html +0 -104
  175. package/doc/variables/MAX_ID.html +0 -104
  176. package/doc/variables/MESSAGE_SPEC_VERSION.html +0 -104
  177. package/doc/variables/SYSTEM_MESSAGE_ID.html +0 -104
  178. package/src/client/Client.ts +0 -276
  179. package/src/core/MessageUtils.ts +0 -48
package/doc/functions/FromJSON.html DELETED
@@ -1,113 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FromJSON | buttplug</title><meta name="description" content="Documentation for buttplug"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
- <div class="tsd-toolbar-contents container">
3
- <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
- <div class="field">
6
- <div id="tsd-toolbar-links"></div></div>
7
- <ul class="results">
8
- <li class="state loading">Preparing search index...</li>
9
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">buttplug</a></div>
10
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11
- <div class="container container-main">
12
- <div class="col-8 col-content">
13
- <div class="tsd-page-title">
14
- <ul class="tsd-breadcrumb">
15
- <li><a href="../modules.html">buttplug</a></li>
16
- <li><a href="FromJSON.html">FromJSON</a></li></ul>
17
- <h1>Function FromJSON</h1></div>
18
- <section class="tsd-panel">
19
- <ul class="tsd-signatures tsd-kind-function">
20
- <li class="tsd-signature tsd-anchor-link" id="FromJSON">FromJSON<span class="tsd-signature-symbol">(</span>str<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/ButtplugMessage.html" class="tsd-signature-type" data-tsd-kind="Class">ButtplugMessage</a><span class="tsd-signature-symbol">[]</span><a href="#FromJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></li>
21
- <li class="tsd-description">
22
- <div class="tsd-parameters">
23
- <h4 class="tsd-parameters-title">Parameters</h4>
24
- <ul class="tsd-parameter-list">
25
- <li>
26
- <h5>str: <span class="tsd-signature-type">any</span></h5></li></ul></div>
27
- <h4 class="tsd-returns-title">Returns <a href="../classes/ButtplugMessage.html" class="tsd-signature-type" data-tsd-kind="Class">ButtplugMessage</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
28
- <ul>
29
- <li>Defined in <a href="https://github.com/buttplugio/buttplug-js/blob/d899bf9/src/core/MessageUtils.ts#L24">src/core/MessageUtils.ts:24</a></li></ul></aside></li></ul></section></div>
30
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
31
- <div class="tsd-navigation settings">
32
- <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
33
- <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
34
- <div class="tsd-accordion-details">
35
- <div class="tsd-filter-visibility">
36
- <h4 class="uppercase">Member Visibility</h4><form>
37
- <ul id="tsd-filter-options">
38
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
39
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div>
40
- <div class="tsd-theme-toggle">
41
- <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
42
- <nav class="tsd-navigation primary">
43
- <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
44
- <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
45
- <div class="tsd-accordion-details">
46
- <ul>
47
- <li><a href="../modules.html">buttplug</a>
48
- <ul></ul></li></ul></div></details></nav>
49
- <nav class="tsd-navigation secondary menu-sticky">
50
- <ul>
51
- <li class="tsd-kind-enum"><a href="../enums/ActuatorType.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-8-path"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)" id="icon-8-text"></path></svg>Actuator<wbr/>Type</a></li>
52
- <li class="tsd-kind-enum"><a href="../enums/ButtplugLogLevel.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8-path"></use><use href="#icon-8-text"></use></svg>Buttplug<wbr/>Log<wbr/>Level</a></li>
53
- <li class="tsd-kind-enum"><a href="../enums/ErrorClass.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8-path"></use><use href="#icon-8-text"></use></svg>Error<wbr/>Class</a></li>
54
- <li class="tsd-kind-enum"><a href="../enums/SensorType.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8-path"></use><use href="#icon-8-text"></use></svg>Sensor<wbr/>Type</a></li>
55
- <li class="tsd-kind-class"><a href="../classes/ButtplugBrowserWebsocketClientConnector.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg>Buttplug<wbr/>Browser<wbr/>Websocket<wbr/>Client<wbr/>Connector</a></li>
56
- <li class="tsd-kind-class"><a href="../classes/ButtplugClient.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Client</a></li>
57
- <li class="tsd-kind-class"><a href="../classes/ButtplugClientConnectorException.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Client<wbr/>Connector<wbr/>Exception</a></li>
58
- <li class="tsd-kind-class"><a href="../classes/ButtplugClientDevice.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Client<wbr/>Device</a></li>
59
- <li class="tsd-kind-class"><a href="../classes/ButtplugDeviceError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Device<wbr/>Error</a></li>
60
- <li class="tsd-kind-class"><a href="../classes/ButtplugDeviceMessage.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Device<wbr/>Message</a></li>
61
- <li class="tsd-kind-class"><a href="../classes/ButtplugError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Error</a></li>
62
- <li class="tsd-kind-class"><a href="../classes/ButtplugInitError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Init<wbr/>Error</a></li>
63
- <li class="tsd-kind-class"><a href="../classes/ButtplugLogger.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Logger</a></li>
64
- <li class="tsd-kind-class"><a href="../classes/ButtplugMessage.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Message</a></li>
65
- <li class="tsd-kind-class"><a href="../classes/ButtplugMessageError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Message<wbr/>Error</a></li>
66
- <li class="tsd-kind-class"><a href="../classes/ButtplugMessageSorter.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Message<wbr/>Sorter</a></li>
67
- <li class="tsd-kind-class"><a href="../classes/ButtplugNodeWebsocketClientConnector.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Node<wbr/>Websocket<wbr/>Client<wbr/>Connector</a></li>
68
- <li class="tsd-kind-class"><a href="../classes/ButtplugPingError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Ping<wbr/>Error</a></li>
69
- <li class="tsd-kind-class"><a href="../classes/ButtplugSystemMessage.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>System<wbr/>Message</a></li>
70
- <li class="tsd-kind-class"><a href="../classes/ButtplugUnknownError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Unknown<wbr/>Error</a></li>
71
- <li class="tsd-kind-class"><a href="../classes/DeviceAdded.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Device<wbr/>Added</a></li>
72
- <li class="tsd-kind-class"><a href="../classes/DeviceInfo.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Device<wbr/>Info</a></li>
73
- <li class="tsd-kind-class"><a href="../classes/DeviceList.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Device<wbr/>List</a></li>
74
- <li class="tsd-kind-class"><a href="../classes/DeviceRemoved.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Device<wbr/>Removed</a></li>
75
- <li class="tsd-kind-class"><a href="../classes/Error.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Error</a></li>
76
- <li class="tsd-kind-class"><a href="../classes/GenericDeviceMessageAttributes.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Generic<wbr/>Device<wbr/>Message<wbr/>Attributes</a></li>
77
- <li class="tsd-kind-class"><a href="../classes/GenericMessageSubcommand.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Generic<wbr/>Message<wbr/>Subcommand</a></li>
78
- <li class="tsd-kind-class"><a href="../classes/LinearCmd.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Linear<wbr/>Cmd</a></li>
79
- <li class="tsd-kind-class"><a href="../classes/LogMessage.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Log<wbr/>Message</a></li>
80
- <li class="tsd-kind-class"><a href="../classes/MessageAttributes.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Message<wbr/>Attributes</a></li>
81
- <li class="tsd-kind-class"><a href="../classes/Ok.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Ok</a></li>
82
- <li class="tsd-kind-class"><a href="../classes/Ping.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Ping</a></li>
83
- <li class="tsd-kind-class"><a href="../classes/RawDeviceMessageAttributes.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Raw<wbr/>Device<wbr/>Message<wbr/>Attributes</a></li>
84
- <li class="tsd-kind-class"><a href="../classes/RawReadCmd.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Raw<wbr/>Read<wbr/>Cmd</a></li>
85
- <li class="tsd-kind-class"><a href="../classes/RawReading.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Raw<wbr/>Reading</a></li>
86
- <li class="tsd-kind-class"><a href="../classes/RawSubscribeCmd.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Raw<wbr/>Subscribe<wbr/>Cmd</a></li>
87
- <li class="tsd-kind-class"><a href="../classes/RawUnsubscribeCmd.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Raw<wbr/>Unsubscribe<wbr/>Cmd</a></li>
88
- <li class="tsd-kind-class"><a href="../classes/RawWriteCmd.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Raw<wbr/>Write<wbr/>Cmd</a></li>
89
- <li class="tsd-kind-class"><a href="../classes/RequestDeviceList.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Request<wbr/>Device<wbr/>List</a></li>
90
- <li class="tsd-kind-class"><a href="../classes/RequestServerInfo.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Request<wbr/>Server<wbr/>Info</a></li>
91
- <li class="tsd-kind-class"><a href="../classes/RotateCmd.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Rotate<wbr/>Cmd</a></li>
92
- <li class="tsd-kind-class"><a href="../classes/RotateSubcommand.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Rotate<wbr/>Subcommand</a></li>
93
- <li class="tsd-kind-class"><a href="../classes/ScalarCmd.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Scalar<wbr/>Cmd</a></li>
94
- <li class="tsd-kind-class"><a href="../classes/ScalarSubcommand.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Scalar<wbr/>Subcommand</a></li>
95
- <li class="tsd-kind-class"><a href="../classes/ScanningFinished.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Scanning<wbr/>Finished</a></li>
96
- <li class="tsd-kind-class"><a href="../classes/SensorDeviceMessageAttributes.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Sensor<wbr/>Device<wbr/>Message<wbr/>Attributes</a></li>
97
- <li class="tsd-kind-class"><a href="../classes/SensorReadCmd.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Sensor<wbr/>Read<wbr/>Cmd</a></li>
98
- <li class="tsd-kind-class"><a href="../classes/SensorReading.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Sensor<wbr/>Reading</a></li>
99
- <li class="tsd-kind-class"><a href="../classes/ServerInfo.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Server<wbr/>Info</a></li>
100
- <li class="tsd-kind-class"><a href="../classes/StartScanning.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Start<wbr/>Scanning</a></li>
101
- <li class="tsd-kind-class"><a href="../classes/StopAllDevices.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Stop<wbr/>All<wbr/>Devices</a></li>
102
- <li class="tsd-kind-class"><a href="../classes/StopDeviceCmd.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Stop<wbr/>Device<wbr/>Cmd</a></li>
103
- <li class="tsd-kind-class"><a href="../classes/StopScanning.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Stop<wbr/>Scanning</a></li>
104
- <li class="tsd-kind-class"><a href="../classes/VectorSubcommand.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Vector<wbr/>Subcommand</a></li>
105
- <li class="tsd-kind-interface"><a href="../interfaces/IButtplugClientConnector.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg>IButtplug<wbr/>Client<wbr/>Connector</a></li>
106
- <li class="tsd-kind-variable"><a href="../variables/DEFAULT_MESSAGE_ID.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg>DEFAULT_<wbr/>MESSAGE_<wbr/>ID</a></li>
107
- <li class="tsd-kind-variable"><a href="../variables/MAX_ID.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>MAX_<wbr/>ID</a></li>
108
- <li class="tsd-kind-variable"><a href="../variables/MESSAGE_SPEC_VERSION.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>MESSAGE_<wbr/>SPEC_<wbr/>VERSION</a></li>
109
- <li class="tsd-kind-variable"><a href="../variables/SYSTEM_MESSAGE_ID.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>SYSTEM_<wbr/>MESSAGE_<wbr/>ID</a></li>
110
- <li class="current tsd-kind-function"><a href="FromJSON.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg>FromJSON</a></li></ul></nav></div></div>
111
- <div class="container tsd-generator">
112
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
113
- <div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/doc/index.html DELETED
@@ -1,184 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>buttplug</title><meta name="description" content="Documentation for buttplug"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
- <div class="tsd-toolbar-contents container">
3
- <div class="table-cell" id="tsd-search" data-base=".">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
- <div class="field">
6
- <div id="tsd-toolbar-links"></div></div>
7
- <ul class="results">
8
- <li class="state loading">Preparing search index...</li>
9
- <li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">buttplug</a></div>
10
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11
- <div class="container container-main">
12
- <div class="col-8 col-content">
13
- <div class="tsd-page-title">
14
- <h2>buttplug</h2></div>
15
- <div class="tsd-panel tsd-typography">
16
- <a href="#buttplug-typescriptjs-client-implementation" id="buttplug-typescriptjs-client-implementation" style="color: inherit; text-decoration: none;">
17
- <h1>Buttplug Typescript/JS Client Implementation</h1>
18
- </a>
19
- <p><a href="https://www.patreon.com/qdot"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button"></a>
20
- <a href="https://www.github.com/sponsors/qdot"><img src="https://img.shields.io/badge/github-donate-ff69b4.svg" alt="Github donate button"></a></p>
21
- <p><a href="https://discuss.buttplug.io"><img src="https://img.shields.io/badge/discourse-forum-blue.svg" alt="Discourse Forum"></a>
22
- <a href="https://discord.buttplug.io"><img src="https://img.shields.io/discord/353303527587708932.svg?logo=discord" alt="Discord"></a>
23
- <a href="https://twitter.com/buttplugio"><img src="https://img.shields.io/twitter/follow/buttplugio.svg?style=social&logo=twitter" alt="Twitter"></a></p>
24
- <p>This repo houses are pure .Net version of the Buttplug Typescript/Javascript Client, implementing
25
- the Version 3 Buttplug Spec. It is expected to run from a browser against either <a href="https://intiface.com/central">Intiface Central
26
- (GUI)</a> or <a href="https://github.com/intiface/intiface-engine">Initface Engine
27
- (CLI)</a>. No Rust FFI bindings are required.</p>
28
-
29
- <a href="#what-happened-why-is-buttplug-js-back" id="what-happened-why-is-buttplug-js-back" style="color: inherit; text-decoration: none;">
30
- <h2>What happened? Why is buttplug-js back?</h2>
31
- </a>
32
- <p>For those of you that have been around a while, you may remember that this used to be the main
33
- Typescript/Javascript implementation. From 2017 to 2020, it was a reference version of the Buttplug
34
- Intimate Haptics Control Standard. </p>
35
- <p>Then I rewrote everything in Rust because I like Rust more and it&#39;s far easier for me to port across
36
- platforms. This repo was archived ~2 years ago in preference to seating the C# client <em>and</em> server
37
- on top of the <a href="https://github.com/buttplugio/buttplug">Rust implementation of Buttplug</a>, as part of
38
- the <a href="https://github.com/buttplugio/buttplug-rs-ffi">Rust FFI Project</a>.</p>
39
- <p>That project ended up being a partial failure.</p>
40
- <p>While the FFI system is handy for languages where it is very difficult to rebuild some parts of the
41
- library (C/C++/Java/etc...), for managed langauges like Javascript and C#, requiring both the client
42
- and server to use the FFI was overkill, and caused many extremely difficult-to-debug issues. With
43
- that in mind, the Typescript implementation in this repo is being turned into a Client only. The
44
- WASM server and Embedded Connector will stay in the FFI repo, but will be another NPM package that
45
- will be optional.</p>
46
-
47
- <a href="#contributing" id="contributing" style="color: inherit; text-decoration: none;">
48
- <h2>Contributing</h2>
49
- </a>
50
- <p>If you have issues or feature requests, <a href="issues/">please feel free to file an issue on this repo</a>.</p>
51
- <p>We are not looking for code contributions or pull requests at this time, and will not accept pull
52
- requests that do not have a matching issue where the matter was previously discussed. Pull requests
53
- should only be submitted after talking to <a href="https://github.com/qdot">qdot</a> via issues on this repo
54
- (or on <a href="https://discuss.buttplug.io">discourse</a> or <a href="https://discord.buttplug.io">discord</a> if you
55
- would like to stay anonymous and out of recorded info on the repo) before submitting PRs. Random PRs
56
- without matching issues and discussion are likely to be closed without merging. and receiving
57
- approval to develop code based on an issue. Any random or non-issue pull requests will most likely
58
- be closed without merging.</p>
59
- <p>If you&#39;d like to contribute in a non-technical way, we need money to keep up with supporting the
60
- latest and greatest hardware. We have multiple ways to donate!</p>
61
- <ul>
62
- <li><a href="https://patreon.com/qdot">Patreon</a></li>
63
- <li><a href="https://github.com/sponsors/qdot">Github Sponsors</a></li>
64
- <li><a href="https://ko-fi.com/qdot76367">Ko-Fi</a></li>
65
- </ul>
66
-
67
- <a href="#license" id="license" style="color: inherit; text-decoration: none;">
68
- <h2>License</h2>
69
- </a>
70
- <p>This project is BSD 3-Clause licensed.</p>
71
- <pre><code class="language-text">
72
- Copyright (c) 2016-2023, Nonpolynomial, LLC
73
- All rights reserved.
74
-
75
- Redistribution and use in source and binary forms, with or without
76
- modification, are permitted provided that the following conditions are met:
77
-
78
- * Redistributions of source code must retain the above copyright notice, this
79
- list of conditions and the following disclaimer.
80
-
81
- * Redistributions in binary form must reproduce the above copyright notice,
82
- this list of conditions and the following disclaimer in the documentation
83
- and/or other materials provided with the distribution.
84
-
85
- * Neither the name of buttplug nor the names of its
86
- contributors may be used to endorse or promote products derived from
87
- this software without specific prior written permission.
88
-
89
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS &quot;AS IS&quot;
90
- AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
91
- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
92
- DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
93
- FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
94
- DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
95
- SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
96
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
97
- OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
98
- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
99
- </code></pre>
100
- </div></div>
101
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
102
- <div class="tsd-navigation settings">
103
- <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
104
- <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
105
- <div class="tsd-accordion-details">
106
- <div class="tsd-filter-visibility">
107
- <h4 class="uppercase">Member Visibility</h4><form>
108
- <ul id="tsd-filter-options">
109
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
110
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div>
111
- <div class="tsd-theme-toggle">
112
- <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
113
- <nav class="tsd-navigation primary">
114
- <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
115
- <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
116
- <div class="tsd-accordion-details">
117
- <ul>
118
- <li class="current selected"><a href="modules.html">buttplug</a>
119
- <ul></ul></li></ul></div></details></nav>
120
- <nav class="tsd-navigation secondary menu-sticky">
121
- <ul>
122
- <li class="tsd-kind-enum"><a href="enums/ActuatorType.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-8-path"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)" id="icon-8-text"></path></svg>Actuator<wbr/>Type</a></li>
123
- <li class="tsd-kind-enum"><a href="enums/ButtplugLogLevel.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8-path"></use><use href="#icon-8-text"></use></svg>Buttplug<wbr/>Log<wbr/>Level</a></li>
124
- <li class="tsd-kind-enum"><a href="enums/ErrorClass.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8-path"></use><use href="#icon-8-text"></use></svg>Error<wbr/>Class</a></li>
125
- <li class="tsd-kind-enum"><a href="enums/SensorType.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8-path"></use><use href="#icon-8-text"></use></svg>Sensor<wbr/>Type</a></li>
126
- <li class="tsd-kind-class"><a href="classes/ButtplugBrowserWebsocketClientConnector.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg>Buttplug<wbr/>Browser<wbr/>Websocket<wbr/>Client<wbr/>Connector</a></li>
127
- <li class="tsd-kind-class"><a href="classes/ButtplugClient.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Client</a></li>
128
- <li class="tsd-kind-class"><a href="classes/ButtplugClientConnectorException.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Client<wbr/>Connector<wbr/>Exception</a></li>
129
- <li class="tsd-kind-class"><a href="classes/ButtplugClientDevice.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Client<wbr/>Device</a></li>
130
- <li class="tsd-kind-class"><a href="classes/ButtplugDeviceError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Device<wbr/>Error</a></li>
131
- <li class="tsd-kind-class"><a href="classes/ButtplugDeviceMessage.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Device<wbr/>Message</a></li>
132
- <li class="tsd-kind-class"><a href="classes/ButtplugError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Error</a></li>
133
- <li class="tsd-kind-class"><a href="classes/ButtplugInitError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Init<wbr/>Error</a></li>
134
- <li class="tsd-kind-class"><a href="classes/ButtplugLogger.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Logger</a></li>
135
- <li class="tsd-kind-class"><a href="classes/ButtplugMessage.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Message</a></li>
136
- <li class="tsd-kind-class"><a href="classes/ButtplugMessageError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Message<wbr/>Error</a></li>
137
- <li class="tsd-kind-class"><a href="classes/ButtplugMessageSorter.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Message<wbr/>Sorter</a></li>
138
- <li class="tsd-kind-class"><a href="classes/ButtplugNodeWebsocketClientConnector.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Node<wbr/>Websocket<wbr/>Client<wbr/>Connector</a></li>
139
- <li class="tsd-kind-class"><a href="classes/ButtplugPingError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Ping<wbr/>Error</a></li>
140
- <li class="tsd-kind-class"><a href="classes/ButtplugSystemMessage.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>System<wbr/>Message</a></li>
141
- <li class="tsd-kind-class"><a href="classes/ButtplugUnknownError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Buttplug<wbr/>Unknown<wbr/>Error</a></li>
142
- <li class="tsd-kind-class"><a href="classes/DeviceAdded.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Device<wbr/>Added</a></li>
143
- <li class="tsd-kind-class"><a href="classes/DeviceInfo.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Device<wbr/>Info</a></li>
144
- <li class="tsd-kind-class"><a href="classes/DeviceList.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Device<wbr/>List</a></li>
145
- <li class="tsd-kind-class"><a href="classes/DeviceRemoved.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Device<wbr/>Removed</a></li>
146
- <li class="tsd-kind-class"><a href="classes/Error.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Error</a></li>
147
- <li class="tsd-kind-class"><a href="classes/GenericDeviceMessageAttributes.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Generic<wbr/>Device<wbr/>Message<wbr/>Attributes</a></li>
148
- <li class="tsd-kind-class"><a href="classes/GenericMessageSubcommand.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Generic<wbr/>Message<wbr/>Subcommand</a></li>
149
- <li class="tsd-kind-class"><a href="classes/LinearCmd.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Linear<wbr/>Cmd</a></li>
150
- <li class="tsd-kind-class"><a href="classes/LogMessage.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Log<wbr/>Message</a></li>
151
- <li class="tsd-kind-class"><a href="classes/MessageAttributes.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Message<wbr/>Attributes</a></li>
152
- <li class="tsd-kind-class"><a href="classes/Ok.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Ok</a></li>
153
- <li class="tsd-kind-class"><a href="classes/Ping.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Ping</a></li>
154
- <li class="tsd-kind-class"><a href="classes/RawDeviceMessageAttributes.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Raw<wbr/>Device<wbr/>Message<wbr/>Attributes</a></li>
155
- <li class="tsd-kind-class"><a href="classes/RawReadCmd.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Raw<wbr/>Read<wbr/>Cmd</a></li>
156
- <li class="tsd-kind-class"><a href="classes/RawReading.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Raw<wbr/>Reading</a></li>
157
- <li class="tsd-kind-class"><a href="classes/RawSubscribeCmd.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Raw<wbr/>Subscribe<wbr/>Cmd</a></li>
158
- <li class="tsd-kind-class"><a href="classes/RawUnsubscribeCmd.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Raw<wbr/>Unsubscribe<wbr/>Cmd</a></li>
159
- <li class="tsd-kind-class"><a href="classes/RawWriteCmd.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Raw<wbr/>Write<wbr/>Cmd</a></li>
160
- <li class="tsd-kind-class"><a href="classes/RequestDeviceList.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Request<wbr/>Device<wbr/>List</a></li>
161
- <li class="tsd-kind-class"><a href="classes/RequestServerInfo.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Request<wbr/>Server<wbr/>Info</a></li>
162
- <li class="tsd-kind-class"><a href="classes/RotateCmd.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Rotate<wbr/>Cmd</a></li>
163
- <li class="tsd-kind-class"><a href="classes/RotateSubcommand.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Rotate<wbr/>Subcommand</a></li>
164
- <li class="tsd-kind-class"><a href="classes/ScalarCmd.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Scalar<wbr/>Cmd</a></li>
165
- <li class="tsd-kind-class"><a href="classes/ScalarSubcommand.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Scalar<wbr/>Subcommand</a></li>
166
- <li class="tsd-kind-class"><a href="classes/ScanningFinished.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Scanning<wbr/>Finished</a></li>
167
- <li class="tsd-kind-class"><a href="classes/SensorDeviceMessageAttributes.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Sensor<wbr/>Device<wbr/>Message<wbr/>Attributes</a></li>
168
- <li class="tsd-kind-class"><a href="classes/SensorReadCmd.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Sensor<wbr/>Read<wbr/>Cmd</a></li>
169
- <li class="tsd-kind-class"><a href="classes/SensorReading.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Sensor<wbr/>Reading</a></li>
170
- <li class="tsd-kind-class"><a href="classes/ServerInfo.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Server<wbr/>Info</a></li>
171
- <li class="tsd-kind-class"><a href="classes/StartScanning.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Start<wbr/>Scanning</a></li>
172
- <li class="tsd-kind-class"><a href="classes/StopAllDevices.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Stop<wbr/>All<wbr/>Devices</a></li>
173
- <li class="tsd-kind-class"><a href="classes/StopDeviceCmd.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Stop<wbr/>Device<wbr/>Cmd</a></li>
174
- <li class="tsd-kind-class"><a href="classes/StopScanning.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Stop<wbr/>Scanning</a></li>
175
- <li class="tsd-kind-class"><a href="classes/VectorSubcommand.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Vector<wbr/>Subcommand</a></li>
176
- <li class="tsd-kind-interface"><a href="interfaces/IButtplugClientConnector.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg>IButtplug<wbr/>Client<wbr/>Connector</a></li>
177
- <li class="tsd-kind-variable"><a href="variables/DEFAULT_MESSAGE_ID.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg>DEFAULT_<wbr/>MESSAGE_<wbr/>ID</a></li>
178
- <li class="tsd-kind-variable"><a href="variables/MAX_ID.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>MAX_<wbr/>ID</a></li>
179
- <li class="tsd-kind-variable"><a href="variables/MESSAGE_SPEC_VERSION.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>MESSAGE_<wbr/>SPEC_<wbr/>VERSION</a></li>
180
- <li class="tsd-kind-variable"><a href="variables/SYSTEM_MESSAGE_ID.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>SYSTEM_<wbr/>MESSAGE_<wbr/>ID</a></li>
181
- <li class="tsd-kind-function"><a href="functions/FromJSON.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg>FromJSON</a></li></ul></nav></div></div>
182
- <div class="container tsd-generator">
183
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
184
- <div class="overlay"></div><script src="assets/main.js"></script></body></html>