buttplug 3.2.2 → 4.0.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 (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 +577 -577
  7. package/LICENSE +27 -27
  8. package/README.md +97 -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 +227 -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 +118 -228
  33. package/dist/main/src/core/Messages.js +51 -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 +118 -227
  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 +209 -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/variables/SYSTEM_MESSAGE_ID.html DELETED
@@ -1,104 +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>SYSTEM_MESSAGE_ID | 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="SYSTEM_MESSAGE_ID.html">SYSTEM_MESSAGE_ID</a></li></ul>
17
- <h1>Variable SYSTEM_MESSAGE_ID<code class="tsd-tag ts-flagConst">Const</code> </h1></div>
18
- <div class="tsd-signature">SYSTEM_<wbr/>MESSAGE_<wbr/>ID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">0</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources">
19
- <ul>
20
- <li>Defined in <a href="https://github.com/buttplugio/buttplug-js/blob/d899bf9/src/core/Messages.ts#L15">src/core/Messages.ts:15</a></li></ul></aside></div>
21
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
22
- <div class="tsd-navigation settings">
23
- <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
24
- <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>
25
- <div class="tsd-accordion-details">
26
- <div class="tsd-filter-visibility">
27
- <h4 class="uppercase">Member Visibility</h4><form>
28
- <ul id="tsd-filter-options">
29
- <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>
30
- <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>
31
- <div class="tsd-theme-toggle">
32
- <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>
33
- <nav class="tsd-navigation primary">
34
- <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
35
- <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>
36
- <div class="tsd-accordion-details">
37
- <ul>
38
- <li><a href="../modules.html">buttplug</a>
39
- <ul></ul></li></ul></div></details></nav>
40
- <nav class="tsd-navigation secondary menu-sticky">
41
- <ul>
42
- <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>
43
- <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>
44
- <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>
45
- <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>
46
- <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>
47
- <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>
48
- <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>
49
- <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>
50
- <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>
51
- <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>
52
- <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>
53
- <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>
54
- <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>
55
- <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>
56
- <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>
57
- <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>
58
- <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>
59
- <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>
60
- <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>
61
- <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>
62
- <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>
63
- <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>
64
- <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>
65
- <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>
66
- <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>
67
- <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>
68
- <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>
69
- <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>
70
- <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>
71
- <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>
72
- <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>
73
- <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>
74
- <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>
75
- <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>
76
- <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>
77
- <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>
78
- <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>
79
- <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>
80
- <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>
81
- <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>
82
- <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>
83
- <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>
84
- <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>
85
- <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>
86
- <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>
87
- <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>
88
- <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>
89
- <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>
90
- <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>
91
- <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>
92
- <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>
93
- <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>
94
- <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>
95
- <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>
96
- <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>
97
- <li class="tsd-kind-variable"><a href="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>
98
- <li class="tsd-kind-variable"><a href="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>
99
- <li class="tsd-kind-variable"><a href="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>
100
- <li class="current tsd-kind-variable"><a href="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>
101
- <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>
102
- <div class="container tsd-generator">
103
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
104
- <div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/src/client/Client.ts DELETED
@@ -1,276 +0,0 @@
1
- /*!
2
- * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
3
- * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
4
- * project root for full license information.
5
- *
6
- * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
7
- */
8
-
9
- 'use strict';
10
-
11
- import { ButtplugLogger } from '../core/Logging';
12
- import { EventEmitter } from 'eventemitter3';
13
- import { ButtplugClientDevice } from './ButtplugClientDevice';
14
- import { IButtplugClientConnector } from './IButtplugClientConnector';
15
- import { ButtplugMessageSorter } from '../utils/ButtplugMessageSorter';
16
-
17
- import * as Messages from '../core/Messages';
18
- import {
19
- ButtplugDeviceError,
20
- ButtplugError,
21
- ButtplugInitError,
22
- ButtplugMessageError,
23
- } from '../core/Exceptions';
24
- import { ButtplugClientConnectorException } from './ButtplugClientConnectorException';
25
- import { getMessageClassFromMessage } from '../core/MessageUtils';
26
-
27
- export class ButtplugClient extends EventEmitter {
28
- protected _pingTimer: NodeJS.Timeout | null = null;
29
- protected _connector: IButtplugClientConnector | null = null;
30
- protected _devices: Map<number, ButtplugClientDevice> = new Map();
31
- protected _clientName: string;
32
- protected _logger = ButtplugLogger.Logger;
33
- protected _isScanning = false;
34
- private _sorter: ButtplugMessageSorter = new ButtplugMessageSorter(true);
35
-
36
- constructor(clientName = 'Generic Buttplug Client') {
37
- super();
38
- this._clientName = clientName;
39
- this._logger.Debug(`ButtplugClient: Client ${clientName} created.`);
40
- }
41
-
42
- public get connected(): boolean {
43
- return this._connector !== null && this._connector.Connected;
44
- }
45
-
46
- public get devices(): ButtplugClientDevice[] {
47
- // While this function doesn't actually send a message, if we don't have a
48
- // connector, we shouldn't have devices.
49
- this.checkConnector();
50
- const devices: ButtplugClientDevice[] = [];
51
- this._devices.forEach((d) => {
52
- devices.push(d);
53
- });
54
- return devices;
55
- }
56
-
57
- public get isScanning(): boolean {
58
- return this._isScanning;
59
- }
60
-
61
- public connect = async (connector: IButtplugClientConnector) => {
62
- this._logger.Info(
63
- `ButtplugClient: Connecting using ${connector.constructor.name}`
64
- );
65
- await connector.connect();
66
- this._connector = connector;
67
- this._connector.addListener('message', this.parseMessages);
68
- this._connector.addListener('disconnect', this.disconnectHandler);
69
- await this.initializeConnection();
70
- };
71
-
72
- public disconnect = async () => {
73
- this._logger.Debug('ButtplugClient: Disconnect called');
74
- this.checkConnector();
75
- await this.shutdownConnection();
76
- await this._connector!.disconnect();
77
- };
78
-
79
- public startScanning = async () => {
80
- this._logger.Debug('ButtplugClient: StartScanning called');
81
- this._isScanning = true;
82
- await this.sendMsgExpectOk(new Messages.StartScanning());
83
- };
84
-
85
- public stopScanning = async () => {
86
- this._logger.Debug('ButtplugClient: StopScanning called');
87
- this._isScanning = false;
88
- await this.sendMsgExpectOk(new Messages.StopScanning());
89
- };
90
-
91
- public stopAllDevices = async () => {
92
- this._logger.Debug('ButtplugClient: StopAllDevices');
93
- await this.sendMsgExpectOk(new Messages.StopAllDevices());
94
- };
95
-
96
- private async sendDeviceMessage(
97
- device: ButtplugClientDevice,
98
- deviceMsg: Messages.ButtplugDeviceMessage
99
- ): Promise<Messages.ButtplugMessage> {
100
- this.checkConnector();
101
- const dev = this._devices.get(device.index);
102
- if (dev === undefined) {
103
- throw ButtplugError.LogAndError(
104
- ButtplugDeviceError,
105
- this._logger,
106
- `Device ${device.index} not available.`
107
- );
108
- }
109
- deviceMsg.DeviceIndex = device.index;
110
- return await this.sendMessage(deviceMsg);
111
- }
112
-
113
- protected disconnectHandler = () => {
114
- this._logger.Info('ButtplugClient: Disconnect event receieved.');
115
- this.emit('disconnect');
116
- };
117
-
118
- protected parseMessages = (msgs: Messages.ButtplugMessage[]) => {
119
- const leftoverMsgs = this._sorter.ParseIncomingMessages(msgs);
120
- for (const x of leftoverMsgs) {
121
- switch (getMessageClassFromMessage(x)) {
122
- case Messages.DeviceAdded: {
123
- const addedMsg = x as Messages.DeviceAdded;
124
- const addedDevice = ButtplugClientDevice.fromMsg(
125
- addedMsg,
126
- this.sendDeviceMessageClosure
127
- );
128
- this._devices.set(addedMsg.DeviceIndex, addedDevice);
129
- this.emit('deviceadded', addedDevice);
130
- break;
131
- }
132
- case Messages.DeviceRemoved: {
133
- const removedMsg = x as Messages.DeviceRemoved;
134
- if (this._devices.has(removedMsg.DeviceIndex)) {
135
- const removedDevice = this._devices.get(removedMsg.DeviceIndex);
136
- removedDevice?.emitDisconnected();
137
- this._devices.delete(removedMsg.DeviceIndex);
138
- this.emit('deviceremoved', removedDevice);
139
- }
140
- break;
141
- }
142
- case Messages.ScanningFinished:
143
- this._isScanning = false;
144
- this.emit('scanningfinished', x);
145
- break;
146
- }
147
- }
148
- };
149
-
150
- protected initializeConnection = async (): Promise<boolean> => {
151
- this.checkConnector();
152
- const msg = await this.sendMessage(
153
- new Messages.RequestServerInfo(
154
- this._clientName,
155
- Messages.MESSAGE_SPEC_VERSION
156
- )
157
- );
158
- switch (getMessageClassFromMessage(msg)) {
159
- case Messages.ServerInfo: {
160
- const serverinfo = msg as Messages.ServerInfo;
161
- this._logger.Info(
162
- `ButtplugClient: Connected to Server ${serverinfo.ServerName}`
163
- );
164
- // TODO: maybe store server name, do something with message template version?
165
- const ping = serverinfo.MaxPingTime;
166
- if (serverinfo.MessageVersion < Messages.MESSAGE_SPEC_VERSION) {
167
- // Disconnect and throw an exception explaining the version mismatch problem.
168
- await this._connector!.disconnect();
169
- throw ButtplugError.LogAndError(
170
- ButtplugInitError,
171
- this._logger,
172
- `Server protocol version ${serverinfo.MessageVersion} is older than client protocol version ${Messages.MESSAGE_SPEC_VERSION}. Please update server.`
173
- );
174
- }
175
- if (ping > 0) {
176
- /*
177
- this._pingTimer = setInterval(async () => {
178
- // If we've disconnected, stop trying to ping the server.
179
- if (!this.Connected) {
180
- await this.ShutdownConnection();
181
- return;
182
- }
183
- await this.SendMessage(new Messages.Ping());
184
- } , Math.round(ping / 2));
185
- */
186
- }
187
- await this.requestDeviceList();
188
- return true;
189
- }
190
- case Messages.Error: {
191
- // Disconnect and throw an exception with the error message we got back.
192
- // This will usually only error out if we have a version mismatch that the
193
- // server has detected.
194
- await this._connector!.disconnect();
195
- const err = msg as Messages.Error;
196
- throw ButtplugError.LogAndError(
197
- ButtplugInitError,
198
- this._logger,
199
- `Cannot connect to server. ${err.ErrorMessage}`
200
- );
201
- }
202
- }
203
- return false;
204
- };
205
-
206
- protected requestDeviceList = async () => {
207
- this.checkConnector();
208
- this._logger.Debug('ButtplugClient: ReceiveDeviceList called');
209
- const deviceList = (await this.sendMessage(
210
- new Messages.RequestDeviceList()
211
- )) as Messages.DeviceList;
212
- deviceList.Devices.forEach((d) => {
213
- if (!this._devices.has(d.DeviceIndex)) {
214
- const device = ButtplugClientDevice.fromMsg(
215
- d,
216
- this.sendDeviceMessageClosure
217
- );
218
- this._logger.Debug(`ButtplugClient: Adding Device: ${device}`);
219
- this._devices.set(d.DeviceIndex, device);
220
- this.emit('deviceadded', device);
221
- } else {
222
- this._logger.Debug(`ButtplugClient: Device already added: ${d}`);
223
- }
224
- });
225
- };
226
-
227
- protected shutdownConnection = async () => {
228
- await this.stopAllDevices();
229
- if (this._pingTimer !== null) {
230
- clearInterval(this._pingTimer);
231
- this._pingTimer = null;
232
- }
233
- };
234
-
235
- protected async sendMessage(
236
- msg: Messages.ButtplugMessage
237
- ): Promise<Messages.ButtplugMessage> {
238
- this.checkConnector();
239
- const p = this._sorter.PrepareOutgoingMessage(msg);
240
- await this._connector!.send(msg);
241
- return await p;
242
- }
243
-
244
- protected checkConnector() {
245
- if (!this.connected) {
246
- throw new ButtplugClientConnectorException(
247
- 'ButtplugClient not connected'
248
- );
249
- }
250
- }
251
-
252
- protected sendMsgExpectOk = async (
253
- msg: Messages.ButtplugMessage
254
- ): Promise<void> => {
255
- const response = await this.sendMessage(msg);
256
- switch (getMessageClassFromMessage(response)) {
257
- case Messages.Ok:
258
- return;
259
- case Messages.Error:
260
- throw ButtplugError.FromError(response as Messages.Error);
261
- default:
262
- throw ButtplugError.LogAndError(
263
- ButtplugMessageError,
264
- this._logger,
265
- `Message type ${getMessageClassFromMessage(response)!.constructor} not handled by SendMsgExpectOk`
266
- );
267
- }
268
- };
269
-
270
- protected sendDeviceMessageClosure = async (
271
- device: ButtplugClientDevice,
272
- msg: Messages.ButtplugDeviceMessage
273
- ): Promise<Messages.ButtplugMessage> => {
274
- return await this.sendDeviceMessage(device, msg);
275
- };
276
- }
package/src/core/MessageUtils.ts DELETED
@@ -1,48 +0,0 @@
1
- /*!
2
- * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
3
- * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
4
- * project root for full license information.
5
- *
6
- * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
7
- */
8
-
9
- 'use strict';
10
- import { plainToInstance } from 'class-transformer';
11
- import * as Messages from './Messages';
12
-
13
- function getMessageClass(
14
- type: string
15
- ): (new (...args: unknown[]) => Messages.ButtplugMessage) | null {
16
- for (const value of Object.values(Messages)) {
17
- if (typeof value === 'function' && 'Name' in value && value.Name === type) {
18
- return value;
19
- }
20
- }
21
- return null;
22
- }
23
-
24
- export function getMessageClassFromMessage(
25
- msg: Messages.ButtplugMessage
26
- ): (new (...args: unknown[]) => Messages.ButtplugMessage) | null {
27
- // Making the bold assumption all message classes have the Name static. Should define a
28
- // requirement for this in the abstract class.
29
- return getMessageClass(Object.getPrototypeOf(msg).constructor.Name);
30
- }
31
-
32
- export function fromJSON(str): Messages.ButtplugMessage[] {
33
- const msgarray: object[] = JSON.parse(str);
34
- const msgs: Messages.ButtplugMessage[] = [];
35
- for (const x of Array.from(msgarray)) {
36
- const type = Object.getOwnPropertyNames(x)[0];
37
- const cls = getMessageClass(type);
38
- if (cls) {
39
- const msg = plainToInstance<Messages.ButtplugMessage, unknown>(
40
- cls,
41
- x[type]
42
- );
43
- msg.update();
44
- msgs.push(msg);
45
- }
46
- }
47
- return msgs;
48
- }