npm - buttplug - Versions diffs - 1.0.17 → 3.0.0-alpha.1 - Mend

buttplug 1.0.17 → 3.0.0-alpha.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 (119) hide show

package/.eslintrc +13 -0
package/.github/FUNDING.yml +5 -0
package/.github/ISSUE_TEMPLATE/bug_report.md +17 -0
package/.jscsrc +3 -0
package/.jshintrc +6 -0
package/.yarnrc.yml +1 -0
package/CHANGELOG.md +377 -24
package/CODE_OF_CONDUCT.md +166 -0
package/CONTRIBUTING.md +169 -0
package/LICENSE +27 -0
package/README.md +23 -126
package/azure-pipelines.yml +19 -0
package/dist/main/src/client/ButtplugBrowserWebsocketClientConnector.d.ts +19 -0
package/dist/main/src/client/ButtplugBrowserWebsocketClientConnector.js +58 -0
package/dist/main/src/client/ButtplugBrowserWebsocketClientConnector.js.map +1 -0
package/dist/main/src/client/ButtplugClientConnectorException.d.ts +11 -0
package/dist/main/src/client/ButtplugClientConnectorException.js +42 -0
package/dist/main/src/client/ButtplugClientConnectorException.js.map +1 -0
package/dist/main/src/client/ButtplugClientDevice.d.ts +62 -0
package/dist/main/src/client/ButtplugClientDevice.js +299 -0
package/dist/main/src/client/ButtplugClientDevice.js.map +1 -0
package/dist/main/src/client/Client.d.ts +42 -0
package/dist/main/src/client/Client.js +237 -0
package/dist/main/src/client/Client.js.map +1 -0
package/dist/main/src/client/IButtplugClientConnector.d.ts +17 -0
package/dist/main/src/client/IButtplugClientConnector.js +10 -0
package/dist/main/src/client/IButtplugClientConnector.js.map +1 -0
package/dist/main/src/core/Exceptions.d.ts +36 -0
package/dist/main/src/core/Exceptions.js +107 -0
package/dist/main/src/core/Exceptions.js.map +1 -0
package/dist/main/src/core/Logging.d.ts +113 -0
package/dist/main/src/core/Logging.js +170 -0
package/dist/main/src/core/Logging.js.map +1 -0
package/dist/main/src/core/MessageUtils.d.ts +9 -0
package/dist/main/src/core/MessageUtils.js +52 -0
package/dist/main/src/core/MessageUtils.js.map +1 -0
package/dist/main/src/core/Messages.d.ts +260 -0
package/dist/main/src/core/Messages.js +412 -0
package/dist/main/src/core/Messages.js.map +1 -0
package/dist/main/src/index.d.ts +17 -0
package/dist/main/src/index.js +34 -0
package/dist/main/src/index.js.map +1 -0
package/dist/main/src/utils/ButtplugBrowserWebsocketConnector.d.ts +22 -0
package/dist/main/src/utils/ButtplugBrowserWebsocketConnector.js +92 -0
package/dist/main/src/utils/ButtplugBrowserWebsocketConnector.js.map +1 -0
package/dist/main/src/utils/ButtplugMessageSorter.d.ts +16 -0
package/dist/main/src/utils/ButtplugMessageSorter.js +79 -0
package/dist/main/src/utils/ButtplugMessageSorter.js.map +1 -0
package/dist/main/src/utils/Utils.d.ts +1 -0
package/dist/main/src/utils/Utils.js +8 -0
package/dist/main/src/utils/Utils.js.map +1 -0
package/dist/web/buttplug.js +6087 -16541
package/dist/web/buttplug.min.js +2 -45
package/dist/web/buttplug.min.js.LICENSE.txt +31 -0
package/dist/web/buttplug.min.js.map +1 -1
package/dist/web/index.html +10 -0
package/jest-puppeteer.config.js +5 -0
package/package.json +93 -44
package/rollup.config.js +55 -0
package/src/client/ButtplugBrowserWebsocketClientConnector.ts +56 -0
package/src/client/ButtplugClientConnectorException.ts +16 -0
package/src/client/ButtplugClientDevice.ts +255 -0
package/src/client/Client.ts +233 -0
package/src/client/IButtplugClientConnector.ts +18 -0
package/src/core/Exceptions.ts +98 -0
package/src/core/Logging.ts +194 -0
package/src/core/MessageUtils.ts +26 -0
package/src/core/Messages.ts +421 -0
package/src/core/index.d.ts +4 -0
package/src/index.ts +18 -0
package/src/utils/ButtplugBrowserWebsocketConnector.ts +90 -0
package/src/utils/ButtplugMessageSorter.ts +54 -0
package/src/utils/Utils.ts +3 -0
package/tsconfig.json +6 -5
package/tslint.json +27 -0
package/typedoc.js +9 -0
package/util/convert_device_config.js +6 -0
package/.netlify/state.json +0 -3
package/LICENSE.md +0 -29
package/dist/module/buttplug-rs-ffi/buttplug_rs_ffi.d.ts +0 -41
package/dist/module/buttplug-rs-ffi/buttplug_rs_ffi.js +0 -2
package/dist/module/buttplug-rs-ffi/buttplug_rs_ffi_bg.js +0 -6
package/dist/module/buttplug-rs-ffi/buttplug_rs_ffi_bg.wasm +0 -0
package/dist/module/buttplug-rs-ffi/buttplug_rs_ffi_bg.wasm.d.ts +0 -18
package/dist/module/buttplug-rs-ffi/buttplug_rs_ffi_bg_node.js +0 -799
package/dist/module/buttplug-rs-ffi/buttplug_rs_ffi_bg_web.js +0 -788
package/dist/module/buttplug_ffi.d.ts +0 -3898
package/dist/module/buttplug_ffi.js +0 -10541
package/dist/module/client.d.ts +0 -30
package/dist/module/client.js +0 -126
package/dist/module/client.js.map +0 -1
package/dist/module/connectors.d.ts +0 -13
package/dist/module/connectors.js +0 -26
package/dist/module/connectors.js.map +0 -1
package/dist/module/device.d.ts +0 -85
package/dist/module/device.js +0 -217
package/dist/module/device.js.map +0 -1
package/dist/module/errors.d.ts +0 -25
package/dist/module/errors.js +0 -60
package/dist/module/errors.js.map +0 -1
package/dist/module/ffi.d.ts +0 -25
package/dist/module/ffi.js +0 -243
package/dist/module/ffi.js.map +0 -1
package/dist/module/index.d.ts +0 -15
package/dist/module/index.js +0 -16
package/dist/module/index.js.map +0 -1
package/dist/module/sorter.d.ts +0 -15
package/dist/module/sorter.js +0 -43
package/dist/module/sorter.js.map +0 -1
package/dist/module/web_index.d.ts +0 -8
package/dist/module/web_index.js +0 -12
package/dist/module/web_index.js.map +0 -1
package/dist/web/0.buttplug.js +0 -1389
package/dist/web/1.buttplug.min.js +0 -2
package/dist/web/1.buttplug.min.js.map +0 -1
package/dist/web/b0219b34bc18e1ad0240.module.wasm +0 -0
package/dist/web/e5566a8b6a3fda978549.module.wasm +0 -0
package/index.html +0 -25
package/webpack.base.cjs +0 -107

package/dist/web/index.html ADDED Viewed

@@ -0,0 +1,10 @@
+<html>
+  <head>
+    <script type="text/javascript" src="buttplug.min.js" defer></script>
+  </head>
+  <body>
+    <script>
+    </script>
+    <h1 class="title">I'm a test page!</h1>
+  </body>
+</html>

package/jest-puppeteer.config.js ADDED Viewed

@@ -0,0 +1,5 @@
+module.exports = {
+  launch: {
+    args: ['--no-sandbox', '--disable-setuid-sandbox'],
+  },
+};

package/package.json CHANGED Viewed

@@ -1,60 +1,109 @@
 {
   "name": "buttplug",
-  "collaborators": [
-    "Nonpolynomial, LLC <kyle@nonpolynomial.com>"
-  ],
-  "description": "Buttplug WASM library for web applications (Node/Web). Does not work for native node at the moment.",
-  "version": "1.0.17",
-  "license": "BSD-3-Clause",
-  "homepage": "https://buttplug.io",
+  "version": "3.0.0-alpha.1",
+  "description": "Buttplug Client Implementation for Typescript/Javascript",
+  "homepage": "https://github.com/buttplugio/buttplug-js/",
   "repository": {
     "type": "git",
-    "url": "https://github.com/buttplugio/buttplug-rs-ffi"
+    "url": "git+https://github.com/buttplugio/buttplug-js.git"
   },
+  "author": "Nonpolynomial Labs, LLC",
+  "keywords": [
+    "teledildonics",
+    "hardware"
+  ],
+  "license": "BSD-3-Clause",
   "bugs": {
-    "url": "https://github.com/buttplugio/buttplug-rs-ffi/issues"
+    "url": "https://github.com/buttplugio/buttplug-js/issues"
   },
+  "main": "./dist/main/src/index.js",
+  "types": "./dist/main/src/index.d.ts",
   "scripts": {
-    "dev": "webpack-dev-server --hot --config webpack.base.cjs --env development",
-    "build:publish": "rimraf dist && yarn build:rust && yarn build:webpack && yarn build:webpack:production",
-    "build:rust": "rimraf src/buttplug-rs-ffi && cd ../ffi && cross-env RUSTFLAGS=\"--cfg=web_sys_unstable_apis\" wasm-pack build -d../js/src/buttplug-rs-ffi --release -- --features wasm --no-default-features && cd ../js && node scripts/modularize.cjs wasm-pack && rimraf src/buttplug-rs-ffi/.gitignore src/buttplug-rs-ffi/package.json src/buttplug-rs-ffi/README.md",
-    "build:main": "tsc -p tsconfig.json && copyfiles -u 1 \"src/**/*.js\" dist/module && copyfiles -u 1 \"src/**/*.d.ts\" dist/module && copyfiles -u 1 \"src/**/*.wasm\" dist/module",
-    "build:proto": "pbjs -t static-module -w es6 -o src/buttplug_ffi.js ../protobuf_schemas/buttplug_rs_ffi.proto && node scripts/modularize.cjs pbjs && pbjs -t static-module ../protobuf_schemas/buttplug_rs_ffi.proto | pbts -o src/buttplug_ffi.d.ts -",
-    "build:webpack": "yarn build:main && webpack --progress --config webpack.base.cjs --env development",
-    "build:webpack:production": "webpack --progress --config webpack.base.cjs --env production"
+    "build": "trash dist dist-bundle && yarn build:all",
+    "build:all": "yarn build:main && yarn build:web && yarn build:web:release",
+    "build:main": "tsc -p tsconfig.json",
+    "build:doc": "typedoc --options typedoc.js --out doc .",
+    "build:rollup": "rollup -c",
+    "tslint": "tslint --project tsconfig.json --outputAbsolutePaths -c ../../tslint.json \"src/**/*.ts\" \"tests/**/*.ts\"",
+    "tslint:fix": "tslint --project tsconfig.json --outputAbsolutePaths -c ../../tslint.json --fix semicolon,comma,no-var-keyword,ordered-imports \"src/**/*.ts\" \"tests/**/*.ts\"",
+    "build:web": "webpack --config=build/webpack.base.js",
+    "build:web:release": "webpack --progress --hide-modules --config=build/webpack.production.js",
+    "build:analyze": "webpack --hide-modules --config=build/webpack.analyzer.js",
+    "pretest": "yarn build:main",
+    "test": "jest tests/*",
+    "web-test": "jest web-tests/test-web-library.ts",
+    "web-test-ci": "jest --runInBand web-tests/test-web-library.ts"
   },
-  "sideEffects": "false",
-  "type": "module",
-  "main": "./dist/module/index.js",
-  "exports": {
-    "node": "./dist/module/index.js",
-    "browser": "./dist/web/buttplug.min.js"
-  },
-  "imports": {
-    "#buttplug_rs_ffi_bg": {
-      "node": "./dist/module/buttplug-rs-ffi/buttplug_rs_ffi_bg_node.js"
-    }
-  },
-  "types": "./dist/module/index.d.ts",
   "dependencies": {
-    "protobufjs": "^6.11.2",
-    "websocket": "^1.0.34"
+    "class-transformer": "^0.5.1",
+    "reflect-metadata": "^0.1.13"
   },
   "devDependencies": {
+    "@types/commander": "^2.12.2",
+    "@types/expect-puppeteer": "^5.0.2",
+    "@types/jest": "^29.2.4",
+    "@types/jest-environment-puppeteer": "^5.0.3",
+    "@types/node": "^18.11.18",
+    "@types/uuid-parse": "^1.0.0",
+    "@types/ws": "^8.5.3",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
-    "fork-ts-checker-webpack-plugin": "^6.5.0",
-    "html-loader": "^3.0.1",
-    "rimraf": "^3.0.2",
-    "ts-loader": "^9",
-    "ts-node": "^10.4.0",
-    "ts-proto": "^1.93.1",
-    "typescript": "^4.5.2",
-    "uglify-js": "^3.14.4",
-    "webpack": "^4",
-    "webpack-cli": "^3",
-    "webpack-dev-server": "^3.11.2",
-    "webpack-merge": "^5.8.0",
-    "yarn": "^1.22.17"
+    "fork-ts-checker-webpack-plugin": "^7.2.14",
+    "jest": "^29.3.1",
+    "jest-puppeteer": "^6.2.0",
+    "mock-socket": "^9.1.5",
+    "pkg": "^5.8.0",
+    "puppeteer": "^19.4.1",
+    "rollup": "^3.8.1",
+    "rollup-plugin-auto-external": "^2.0.0",
+    "rollup-plugin-commonjs": "^10.1.0",
+    "rollup-plugin-html": "^0.2.1",
+    "rollup-plugin-json": "^4.0.0",
+    "rollup-plugin-node-builtins": "^2.1.2",
+    "rollup-plugin-node-globals": "^1.4.0",
+    "rollup-plugin-node-resolve": "^5.2.0",
+    "rollup-plugin-postcss": "^4.0.2",
+    "rollup-plugin-postcss-modules": "^2.1.0",
+    "rollup-plugin-terser": "^5.3.0",
+    "rollup-plugin-typescript2": "^0.34.1",
+    "selfsigned": "^2.1.1",
+    "style-loader": "^3.3.1",
+    "terser": "^4.x",
+    "terser-webpack-plugin": "^4.x",
+    "tmp": "^0.2.1",
+    "trash": "^8.1.0",
+    "trash-cli": "^5.0.0",
+    "ts-jest": "^29.0.3",
+    "ts-loader": "^8.x",
+    "ts-node": "^10.9.1",
+    "tslib": "^2.4.1",
+    "tslint": "^6.1.0",
+    "typedoc": "^0.23.23",
+    "typescript": "^4.9.4",
+    "url-loader": "^4.1.1",
+    "webpack": "^4.42.1",
+    "webpack-bundle-analyzer": "^3.6.1",
+    "webpack-cli": "^3.3.11",
+    "webpack-merge": "^4.2.2",
+    "yarn": "^1.22.19"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "ts",
+      "js",
+      "json"
+    ],
+    "transform": {
+      "^.+\\.ts$": "ts-jest"
+    },
+    "testMatch": [
+      "<rootDir>/tests/**/test-*.ts",
+      "<rootDir>/web-tests/**/test-*.ts"
+    ],
+    "coverageDirectory": "./coverage/",
+    "coverageReporters": [
+      "json"
+    ],
+    "collectCoverage": true
   }
 }

package/rollup.config.js ADDED Viewed

@@ -0,0 +1,55 @@
+import typescript from 'rollup-plugin-typescript2';
+import nodeResolve from 'rollup-plugin-node-resolve';
+import json from 'rollup-plugin-json';
+import { terser } from 'rollup-plugin-terser';
+import commonjs from 'rollup-plugin-commonjs';
+import nodeBuiltins from 'rollup-plugin-node-builtins';
+import nodeGlobals from 'rollup-plugin-node-globals';
+// Generate our base config object out of a function return, so we don't have to
+// worry about doing copies/clones.
+function configGen() {
+  return {
+    input: 'src/index.ts',
+    output: {
+      file: 'dist/web/buttplug.js',
+      format: 'iife',
+      name: "Buttplug"
+    },
+    plugins: [
+      nodeResolve({
+        jsnext: true,
+        main: true,
+        extensions: [ '.ts', '.js', '.json' ],
+        browser: true
+      }),
+      typescript({ tsconfigOverride: { compilerOptions: { module: "ES2015" } } }),
+      json(),
+      nodeBuiltins(),
+      nodeGlobals(),
+      commonjs({
+        // non-CommonJS modules will be ignored, but you can also
+        // specifically include/exclude files
+        include: ['../../node_modules/**', './node_modules/**'],  // Default: undefined
+      }),
+    ]
+  };
+}
+let config = configGen();
+let configProduction = configGen();
+configProduction.output.file = 'dist/web/buttplug.min.js';
+configProduction.plugins.push(terser({
+  sourcemap: true,
+  mangle: {
+    keep_classnames: true,
+    keep_fnames: true
+  },
+  compress: {
+    keep_fnames: true,
+    keep_classnames: true,
+  }
+}));
+module.exports = [config, configProduction];

package/src/client/ButtplugBrowserWebsocketClientConnector.ts ADDED Viewed

@@ -0,0 +1,56 @@
+/*!
+ * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
+ * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
+ * project root for full license information.
+ *
+ * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
+ */
+"use strict";
+import { IButtplugClientConnector } from "./IButtplugClientConnector";
+import { ButtplugMessage } from "../core/Messages";
+import { FromJSON } from "../core/MessageUtils";
+import { ButtplugMessageSorter } from "../utils/ButtplugMessageSorter";
+import { ButtplugBrowserWebsocketConnector } from "../utils/ButtplugBrowserWebsocketConnector";
+export class ButtplugBrowserWebsocketClientConnector extends ButtplugBrowserWebsocketConnector implements IButtplugClientConnector {
+  private _sorter: ButtplugMessageSorter = new ButtplugMessageSorter(true);
+  protected _ws: WebSocket | undefined;
+  public constructor(_url: string) {
+    super(_url);
+  }
+  public get Connected(): boolean {
+    return this._ws !== undefined;
+  }
+  public Send = async (msg: ButtplugMessage): Promise<ButtplugMessage> => {
+    if (!this.Connected) {
+      throw new Error("ButtplugClient not connected");
+    }
+    const p = this._sorter.PrepareOutgoingMessage(msg);
+    this.SendMessage(msg);
+    return await p;
+  }
+  protected ParseIncomingMessage = (event: MessageEvent) => {
+    if (typeof (event.data) === "string") {
+      const msgs = FromJSON(event.data);
+      const emitMsgs = this._sorter.ParseIncomingMessages(msgs);
+      this.emit("message", emitMsgs);
+    } else if (event.data instanceof Blob) {
+      const reader = new FileReader();
+      reader.addEventListener("load", (ev) => { this.OnReaderLoad(ev); });
+      reader.readAsText(event.data);
+    }
+  }
+  protected OnReaderLoad(event: Event) {
+    const msgs = FromJSON((event.target as FileReader).result);
+    const emitMsgs = this._sorter.ParseIncomingMessages(msgs);
+    this.emit("message", emitMsgs);
+  }
+}

package/src/client/ButtplugClientConnectorException.ts ADDED Viewed

@@ -0,0 +1,16 @@
+/*!
+ * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
+ * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
+ * project root for full license information.
+ *
+ * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
+ */
+import { ButtplugException } from "../core/Exceptions";
+import * as Messages from "../core/Messages";
+export class ButtplugClientConnectorException extends ButtplugException {
+  public constructor(message: string) {
+    super(message, Messages.ErrorClass.ERROR_UNKNOWN);
+  }
+}

package/src/client/ButtplugClientDevice.ts ADDED Viewed

@@ -0,0 +1,255 @@
+/*!
+ * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
+ * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
+ * project root for full license information.
+ *
+ * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
+ */
+"use strict";
+import * as Messages from "../core/Messages";
+import { ButtplugDeviceException, ButtplugException, ButtplugMessageException } from "../core/Exceptions";
+import { EventEmitter } from "events";
+/**
+ * Represents an abstract device, capable of taking certain kinds of messages.
+ */
+export class ButtplugClientDevice extends EventEmitter {
+  /**
+   * Return the name of the device.
+   */
+  public get Name(): string {
+    return this._deviceInfo.DeviceName;
+  }
+  /**
+   * Return the user set name of the device.
+   */
+    public get DisplayName(): string | undefined {
+      return this._deviceInfo.DeviceDisplayName;
+    }
+  /**
+   * Return the index of the device.
+   */
+  public get Index(): number {
+    return this._deviceInfo.DeviceIndex;
+  }
+  /**
+   * Return the index of the device.
+   */
+  public get MessageTimingGap(): number | undefined {
+    return this._deviceInfo.DeviceMessageTimingGap;
+  }
+  /**
+   * Return a list of message types the device accepts.
+   */
+  public get AllowedMessages(): Messages.MessageAttributes {
+    return this._deviceInfo.DeviceMessages;
+  }
+  public static fromMsg(msg: Messages.DeviceInfo,
+                        sendClosure: (device: ButtplugClientDevice,
+                                      msg: Messages.ButtplugDeviceMessage) => Promise<Messages.ButtplugMessage>): ButtplugClientDevice {
+    return new ButtplugClientDevice(msg,
+                                    sendClosure);
+  }
+  // Map of messages and their attributes (feature count, etc...)
+  private allowedMsgs: Map<string, Messages.MessageAttributes> = new Map<string, Messages.MessageAttributes>();
+  /**
+   * @param _index Index of the device, as created by the device manager.
+   * @param _name Name of the device.
+   * @param allowedMsgs Buttplug messages the device can receive.
+   */
+  constructor(private _deviceInfo: Messages.DeviceInfo,
+              private _sendClosure: (device: ButtplugClientDevice,
+                                     msg: Messages.ButtplugDeviceMessage) => Promise<Messages.ButtplugMessage>) {
+    super();
+    _deviceInfo.DeviceMessages.update();
+  }
+  public async send(msg: Messages.ButtplugDeviceMessage): Promise<Messages.ButtplugMessage> {
+    // Assume we're getting the closure from ButtplugClient, which does all of
+    // the index/existence/connection/message checks for us.
+    return await this._sendClosure(this, msg);
+  }
+  public async sendExpectOk(msg: Messages.ButtplugDeviceMessage): Promise<void> {
+    const response = await this.send(msg);
+    switch (response.constructor) {
+      case Messages.Ok:
+        return;
+      case Messages.Error:
+        throw ButtplugException.FromError(response as Messages.Error);
+      default:
+        throw new ButtplugMessageException(`Message type ${response.constructor} not handled by SendMsgExpectOk`);
+    }
+  }
+  public async scalar(scalar: Messages.ScalarSubcommand | Messages.ScalarSubcommand[]): Promise<void> {
+    if (Array.isArray(scalar)) {
+      await this.sendExpectOk(new Messages.ScalarCmd(scalar, this.Index));
+    } else {
+      await this.sendExpectOk(new Messages.ScalarCmd([scalar], this.Index));
+    }
+  }
+  private async scalarCommandBuilder(speed: number | number[], actuator: Messages.ActuatorType) {
+    let scalarAttrs = this.AllowedMessages.ScalarCmd?.filter((x) => x.ActuatorType == actuator);
+    if (!scalarAttrs || scalarAttrs.length == 0) {
+      throw new ButtplugDeviceException(`Device ${this.Name} has no ${actuator} capabilities`);
+    }
+    let cmds: Messages.ScalarSubcommand[] = [];
+    if (typeof(speed) === "number") {
+      scalarAttrs.forEach((x) => cmds.push(new Messages.ScalarSubcommand(x.Index, speed, actuator)));
+    } else if (Array.isArray(speed)) {
+      if (speed.length > scalarAttrs.length) {
+        throw new ButtplugDeviceException(`${speed.length} commands send to a device with ${scalarAttrs.length} vibrators`);
+      }
+      scalarAttrs.forEach((x, i) => {
+        cmds.push(new Messages.ScalarSubcommand(x.Index, speed[i], actuator))
+      });
+    } else {
+      throw new ButtplugDeviceException(`${actuator} can only take numbers or arrays of numbers.`);
+    }
+    await this.scalar(cmds);
+  }
+  public async vibrate(speed: number | number[]): Promise<void> {
+    await this.scalarCommandBuilder(speed, Messages.ActuatorType.Vibrate);
+  }
+  public async oscillate(speed: number | number[]): Promise<void> {
+    await this.scalarCommandBuilder(speed, Messages.ActuatorType.Oscillate);
+  }
+  public async rotate(values: number | [number, boolean][], clockwise?: boolean): Promise<void> {
+    let rotateAttrs = this.AllowedMessages.RotateCmd;
+    if (!rotateAttrs || rotateAttrs.length == 0) {
+      throw new ButtplugDeviceException(`Device ${this.Name} has no Rotate capabilities`);
+    }
+    let msg: Messages.RotateCmd;
+    if (typeof(values) === "number") {
+      msg = Messages.RotateCmd.Create(this.Index,
+                                      new Array(rotateAttrs.length).fill([values, clockwise]));
+    } else if (Array.isArray(values)) {
+      msg = Messages.RotateCmd.Create(this.Index, values);
+    } else {
+      throw new ButtplugDeviceException(
+        "SendRotateCmd can only take a number and boolean, or an array of number/boolean tuples");
+    }
+    await this.sendExpectOk(msg);
+  }
+  public async linear(values: number | [number, number][], duration?: number): Promise<void> {
+    let linearAttrs = this.AllowedMessages.LinearCmd;
+    if (!linearAttrs || linearAttrs.length == 0) {
+      throw new ButtplugDeviceException(`Device ${this.Name} has no Linear capabilities`);
+    }
+    let msg: Messages.LinearCmd;
+    if (typeof(values) === "number") {
+      msg = Messages.LinearCmd.Create(this.Index,
+                                      new Array(linearAttrs.length).fill([values, duration]));
+    } else if (Array.isArray(values)) {
+      msg = Messages.LinearCmd.Create(this.Index, values);
+    } else {
+      throw new ButtplugDeviceException(
+        "SendLinearCmd can only take a number and number, or an array of number/number tuples");
+    }
+    await this.sendExpectOk(msg);
+  }
+  public async sensorRead(sensorIndex: number, sensorType: Messages.SensorType): Promise<number[]> {
+    let response = await this.send(new Messages.SensorReadCmd(this.Index, sensorIndex, sensorType));
+    switch (response.constructor) {
+      case Messages.SensorReading:
+        return (response as Messages.SensorReading).Data;
+      case Messages.Error:
+        throw ButtplugException.FromError(response as Messages.Error);
+      default:
+        throw new ButtplugMessageException(`Message type ${response.constructor} not handled by sensorRead`);
+    }
+  }
+  public async battery(): Promise<number> {
+    let batteryAttrs = this.AllowedMessages.SensorReadCmd?.filter((x) => x.SensorType == Messages.SensorType.Battery);
+    if (!batteryAttrs || batteryAttrs.length == 0) {
+      throw new ButtplugDeviceException(`Device ${this.Name} has no Battery capabilities`);
+    }
+    // Find the battery sensor, we'll need its index.
+    let result = await this.sensorRead(batteryAttrs[0].Index, Messages.SensorType.Battery);
+    return result[0] / 100.0;
+  }
+  public async rssi(): Promise<number> {
+    let rssiAttrs = this.AllowedMessages.SensorReadCmd?.filter((x) => x.SensorType == Messages.SensorType.RSSI);
+    if (!rssiAttrs || rssiAttrs.length == 0) {
+      throw new ButtplugDeviceException(`Device ${this.Name} has no RSSI capabilities`);
+    }
+    // Find the battery sensor, we'll need its index.
+    let result = await this.sensorRead(rssiAttrs[0].Index, Messages.SensorType.RSSI);
+    return result[0];
+  }
+  public async rawRead(endpoint: string, expectedLength: number, timeout: number): Promise<Uint8Array> {
+    if (!this.AllowedMessages.RawReadCmd) {
+      throw new ButtplugDeviceException(`Device ${this.Name} has no raw read capabilities`);
+    }
+    if (this.AllowedMessages.RawReadCmd.Endpoints.indexOf(endpoint) == -1) {
+      throw new ButtplugDeviceException(`Device ${this.Name} has no raw readable endpoint ${endpoint}`);
+    }
+    let response = await this.send(new Messages.RawReadCmd(this.Index, endpoint, expectedLength, timeout));
+    switch (response.constructor) {
+      case Messages.RawReading:
+        return new Uint8Array((response as Messages.RawReading).Data);
+      case Messages.Error:
+        throw ButtplugException.FromError(response as Messages.Error);
+      default:
+        throw new ButtplugMessageException(`Message type ${response.constructor} not handled by rawRead`);
+    }
+  }
+  public async rawWrite(endpoint: string, data: Uint8Array, writeWithResponse: boolean): Promise<void> {
+    if (!this.AllowedMessages.RawWriteCmd) {
+      throw new ButtplugDeviceException(`Device ${this.Name} has no raw write capabilities`);
+    }
+    if (this.AllowedMessages.RawWriteCmd.Endpoints.indexOf(endpoint) == -1) {
+      throw new ButtplugDeviceException(`Device ${this.Name} has no raw writable endpoint ${endpoint}`);
+    }
+    await this.sendExpectOk(new Messages.RawWriteCmd(this.Index, endpoint, data, writeWithResponse));
+  }
+  public async rawSubscribe(endpoint: string): Promise<void> {
+    if (!this.AllowedMessages.RawSubscribeCmd) {
+      throw new ButtplugDeviceException(`Device ${this.Name} has no raw subscribe capabilities`);
+    }
+    if (this.AllowedMessages.RawSubscribeCmd.Endpoints.indexOf(endpoint) == -1) {
+      throw new ButtplugDeviceException(`Device ${this.Name} has no raw subscribable endpoint ${endpoint}`);
+    }
+    await this.sendExpectOk(new Messages.RawSubscribeCmd(this.Index, endpoint));
+  }
+  public async rawUnsubscribe(endpoint: string): Promise<void> {
+    // This reuses raw subscribe's info.
+    if (!this.AllowedMessages.RawSubscribeCmd) {
+      throw new ButtplugDeviceException(`Device ${this.Name} has no raw unsubscribe capabilities`);
+    }
+    if (this.AllowedMessages.RawSubscribeCmd.Endpoints.indexOf(endpoint) == -1) {
+      throw new ButtplugDeviceException(`Device ${this.Name} has no raw unsubscribable endpoint ${endpoint}`);
+    }
+    await this.sendExpectOk(new Messages.RawUnsubscribeCmd(this.Index, endpoint));
+  }
+  public async stop(): Promise<void> {
+    await this.sendExpectOk(new Messages.StopDeviceCmd(this.Index));
+  }
+  public EmitDisconnected() {
+    this.emit("deviceremoved");
+  }
+}