buttplug 3.1.0 → 3.2.0

package/.eslintrc.js

@@ -5,16 +5,21 @@ module.exports = {
     node: true,
   },
   extends: [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "./node_modules/gts",
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    './node_modules/gts',
   ],
   overrides: [],
-  parser: "@typescript-eslint/parser",
+  parser: '@typescript-eslint/parser',
   parserOptions: {
-    ecmaVersion: "latest",
-    sourceType: "module",
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint'],
+  rules: {
+    'node/no-unsupported-features/es-syntax': [
+      'error',
+      { ignores: ['modules'] },
+    ],
   },
-  plugins: ["@typescript-eslint"],
-  rules: {},
 };

package/CHANGELOG.md

@@ -1,3 +1,27 @@
+# v3.2.0 (2023/09/23)
+
+## Features
+
+- Web package building now uses vite instead of webpack
+  - Long live vite. May I never have to fucking deal with webpack ever again.
+
+## Bugfixes
+
+- Cleaned up naming conventions
+- Changed connector interface (this is technically a breaking change but afaik no one else
+  implements their own connector)
+- Fix linear attribute enumeration
+
+# v3.1.1 (2023/02/18)
+
+## Bugfixes
+
+- Replace events with eventemitter3
+  - API Compatible and easier for building across web/node
+- Remove blob reading from websocket connectors
+  - We never use binary messages on websockets, and the extra filereader dep for node was
+    causing issues with web builds.
+
 # v3.1.0 (2023/02/11)
 
 ## Features

package/README.md

@@ -7,41 +7,40 @@
 [![Discord](https://img.shields.io/discord/353303527587708932.svg?logo=discord)](https://discord.buttplug.io)
 [![Twitter](https://img.shields.io/twitter/follow/buttplugio.svg?style=social&logo=twitter)](https://twitter.com/buttplugio)
 
-This repo houses are pure .Net version of the Buttplug Typescript/Javascript Client, implementing
-the Version 3 Buttplug Spec. It is expected to run from a browser against either [Intiface Central
-(GUI)](https://intiface.com/central) or [Initface Engine
-(CLI)](https://github.com/intiface/intiface-engine). No Rust FFI bindings are required.
+A implementation of the Buttplug Client in Typescript/Javascript, implementing the Version 3
+Buttplug Spec. It is expected to run from a browser against either [Intiface Central
+(GUI)](https://intiface.com/central), [Initface Engine
+(CLI)](https://github.com/intiface/intiface-engine), or [the Buttplug WASM Server](https://github.com/buttplugio/buttplug-js).
 
+## Compilation information
 
-## Using buttplug-js with Node
+buttplug-js builds to 3 different types of library:
 
-buttplug-js works with both pure web builds, as well as node applications. To use buttplug-js with node, use the `ButtplugNodeWebsocketClientConnector` class instead of the `ButtplugBrowserWebsocketClientConnector` class. That should be the only change needed, all of the API stays the same. See the Documentation section for more info.
+- CommonJS for node
+- UMD and ES Modules for the web
 
-## Documentation
+For node, simply include the package as you would any other package.
 
-Documentation on how to use Buttplug in general, as well as examples for buttplug-js, can be found in the [Buttplug Developer Guide](https://docs.buttplug.io/docs/dev-guide).
+For inclusion in web projects, the UMD project can be found at dist/web/buttplug.js, and the es6 module at dist/web/buttplug.mjs.
 
-API documentation for buttplug-js can be found at https://buttplugio.github.io/buttplug-js.
+## Using buttplug-js with Node
 
-## What happened? Why is buttplug-js back?
+buttplug-js works with both pure web builds, as well as node applications. To use buttplug-js with
+node, use the `ButtplugNodeWebsocketClientConnector` class instead of the
+`ButtplugBrowserWebsocketClientConnector` class. That should be the only change needed, all of the
+API stays the same. See the Documentation section for more info.
 
-For those of you that have been around a while, you may remember that this used to be the main
-Typescript/Javascript implementation. From 2017 to 2020, it was a reference version of the Buttplug
-Intimate Haptics Control Standard. 
+(The WASM Server *does not work* with pure node applications. It requires a browser environment in order to run. See the WASM project README for more info.)
 
-Then I rewrote everything in Rust because I like Rust more and it's far easier for me to port across
-platforms. This repo was archived ~2 years ago in preference to seating the C# client *and* server
-on top of the [Rust implementation of Buttplug](https://github.com/buttplugio/buttplug), as part of
-the [Rust FFI Project](https://github.com/buttplugio/buttplug-rs-ffi).
+## Documentation and Examples
+
+Documentation on how to use Buttplug in general, as well as examples for buttplug-js, can be found in the [Buttplug Developer Guide](https://docs.buttplug.io/docs/dev-guide).
+
+API documentation for buttplug-js can be found at https://buttplugio.github.io/buttplug-js.
 
-That project ended up being a partial failure.
+If you would like to see a demo of using Buttplug in a pure web context, check out the following glitch project, which shows how to pull the Buttplug libraries from a CDN and use them in a pure HTML/JS context without node:
 
-While the FFI system is handy for languages where it is very difficult to rebuild some parts of the
-library (C/C++/Java/etc...), for managed langauges like Javascript and C#, requiring both the client
-and server to use the FFI was overkill, and caused many extremely difficult-to-debug issues. With
-that in mind, the Typescript implementation in this repo is being turned into a Client only. The
-WASM server and Embedded Connector will stay in the FFI repo, but will be another NPM package that
-will be optional.
+https://glitch.com/edit/#!/how-to-buttplug
 
 ## Contributing
 
@@ -69,7 +68,7 @@ This project is BSD 3-Clause licensed.
 
 ```text
 
-Copyright (c) 2016-2023, Nonpolynomial, LLC
+Copyright (c) 2016-2023, Nonpolynomial Labs, LLC
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

package/dist/main/src/client/ButtplugBrowserWebsocketClientConnector.d.ts

@@ -1,16 +1,13 @@
-/*!
- * 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 { IButtplugClientConnector } from './IButtplugClientConnector';
-import { ButtplugMessage } from '../core/Messages';
-import { ButtplugBrowserWebsocketConnector } from '../utils/ButtplugBrowserWebsocketConnector';
-export declare class ButtplugBrowserWebsocketClientConnector extends ButtplugBrowserWebsocketConnector implements IButtplugClientConnector {
-    private _sorter;
-    Send: (msg: ButtplugMessage) => Promise<ButtplugMessage>;
-    protected ParseIncomingMessage: (event: MessageEvent) => void;
-    protected OnReaderLoad(event: Event): void;
-}
+/*!
+ * 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 { IButtplugClientConnector } from './IButtplugClientConnector';
+import { ButtplugMessage } from '../core/Messages';
+import { ButtplugBrowserWebsocketConnector } from '../utils/ButtplugBrowserWebsocketConnector';
+export declare class ButtplugBrowserWebsocketClientConnector extends ButtplugBrowserWebsocketConnector implements IButtplugClientConnector {
+    send: (msg: ButtplugMessage) => void;
+}

package/dist/main/src/client/ButtplugBrowserWebsocketClientConnector.js

@@ -1,58 +1,24 @@
-/*!
- * 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';
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ButtplugBrowserWebsocketClientConnector = void 0;
-const MessageUtils_1 = require("../core/MessageUtils");
-const ButtplugMessageSorter_1 = require("../utils/ButtplugMessageSorter");
-const ButtplugBrowserWebsocketConnector_1 = require("../utils/ButtplugBrowserWebsocketConnector");
-class ButtplugBrowserWebsocketClientConnector extends ButtplugBrowserWebsocketConnector_1.ButtplugBrowserWebsocketConnector {
-    constructor() {
-        super(...arguments);
-        this._sorter = new ButtplugMessageSorter_1.ButtplugMessageSorter(true);
-        this.Send = (msg) => __awaiter(this, void 0, void 0, function* () {
-            if (!this.Connected) {
-                throw new Error('ButtplugClient not connected');
-            }
-            const p = this._sorter.PrepareOutgoingMessage(msg);
-            this.SendMessage(msg);
-            return yield p;
-        });
-        this.ParseIncomingMessage = (event) => {
-            var _a;
-            if (typeof event.data === 'string') {
-                const msgs = (0, MessageUtils_1.FromJSON)(event.data);
-                const emitMsgs = this._sorter.ParseIncomingMessages(msgs);
-                this.emit('message', emitMsgs);
-            }
-            else if (event.data instanceof Blob) {
-                const reader = new ((_a = this._filereaderConstructor) !== null && _a !== void 0 ? _a : FileReader)();
-                reader.addEventListener('load', (ev) => {
-                    this.OnReaderLoad(ev);
-                });
-                reader.readAsText(event.data);
-            }
-        };
-    }
-    OnReaderLoad(event) {
-        const msgs = (0, MessageUtils_1.FromJSON)(event.target.result);
-        const emitMsgs = this._sorter.ParseIncomingMessages(msgs);
-        this.emit('message', emitMsgs);
-    }
-}
-exports.ButtplugBrowserWebsocketClientConnector = ButtplugBrowserWebsocketClientConnector;
+/*!
+ * 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';
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ButtplugBrowserWebsocketClientConnector = void 0;
+const ButtplugBrowserWebsocketConnector_1 = require("../utils/ButtplugBrowserWebsocketConnector");
+class ButtplugBrowserWebsocketClientConnector extends ButtplugBrowserWebsocketConnector_1.ButtplugBrowserWebsocketConnector {
+    constructor() {
+        super(...arguments);
+        this.send = (msg) => {
+            if (!this.Connected) {
+                throw new Error('ButtplugClient not connected');
+            }
+            this.sendMessage(msg);
+        };
+    }
+}
+exports.ButtplugBrowserWebsocketClientConnector = ButtplugBrowserWebsocketClientConnector;
 //# sourceMappingURL=ButtplugBrowserWebsocketClientConnector.js.map

package/dist/main/src/client/ButtplugBrowserWebsocketClientConnector.js.map

@@ -1 +1 @@
-{"version":3,"file":"ButtplugBrowserWebsocketClientConnector.js","sourceRoot":"","sources":["../../../../src/client/ButtplugBrowserWebsocketClientConnector.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,YAAY,CAAC;;;;;;;;;;;;AAIb,uDAAgD;AAChD,0EAAuE;AACvE,kGAA+F;AAE/F,MAAa,uCACX,SAAQ,qEAAiC;IAD3C;;QAIU,YAAO,GAA0B,IAAI,6CAAqB,CAAC,IAAI,CAAC,CAAC;QAElE,SAAI,GAAG,CAAO,GAAoB,EAA4B,EAAE;YACrE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;gBACnB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;aACjD;YACD,MAAM,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;YACnD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;YACtB,OAAO,MAAM,CAAC,CAAC;QACjB,CAAC,CAAA,CAAC;QAEQ,yBAAoB,GAAG,CAAC,KAAmB,EAAE,EAAE;;YACvD,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;gBAClC,MAAM,IAAI,GAAG,IAAA,uBAAQ,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAClC,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;gBAC1D,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;aAChC;iBAAM,IAAI,KAAK,CAAC,IAAI,YAAY,IAAI,EAAE;gBACrC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAA,IAAI,CAAC,sBAAsB,mCAAI,UAAU,CAAC,EAAE,CAAC;gBACjE,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE;oBACrC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;gBACxB,CAAC,CAAC,CAAC;gBACH,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;aAC/B;QACH,CAAC,CAAC;IAOJ,CAAC;IALW,YAAY,CAAC,KAAY;QACjC,MAAM,IAAI,GAAG,IAAA,uBAAQ,EAAE,KAAK,CAAC,MAAqB,CAAC,MAAM,CAAC,CAAC;QAC3D,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAC1D,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACjC,CAAC;CACF;AAlCD,0FAkCC"}
+{"version":3,"file":"ButtplugBrowserWebsocketClientConnector.js","sourceRoot":"","sources":["../../../../src/client/ButtplugBrowserWebsocketClientConnector.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,YAAY,CAAC;;;AAIb,kGAA+F;AAE/F,MAAa,uCACX,SAAQ,qEAAiC;IAD3C;;QAIS,SAAI,GAAG,CAAC,GAAoB,EAAQ,EAAE;YAC3C,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;gBACnB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;aACjD;YACD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC,CAAC;IACJ,CAAC;CAAA;AAVD,0FAUC"}

package/dist/main/src/client/ButtplugClientConnectorException.d.ts

@@ -1,11 +1,11 @@
-/*!
- * 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 { ButtplugError } from '../core/Exceptions';
-export declare class ButtplugClientConnectorException extends ButtplugError {
-    constructor(message: string);
-}
+/*!
+ * 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 { ButtplugError } from '../core/Exceptions';
+export declare class ButtplugClientConnectorException extends ButtplugError {
+    constructor(message: string);
+}

package/dist/main/src/client/ButtplugClientConnectorException.js

@@ -1,42 +1,42 @@
-"use strict";
-/*!
- * 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.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ButtplugClientConnectorException = void 0;
-const Exceptions_1 = require("../core/Exceptions");
-const Messages = __importStar(require("../core/Messages"));
-class ButtplugClientConnectorException extends Exceptions_1.ButtplugError {
-    constructor(message) {
-        super(message, Messages.ErrorClass.ERROR_UNKNOWN);
-    }
-}
-exports.ButtplugClientConnectorException = ButtplugClientConnectorException;
+"use strict";
+/*!
+ * 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.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ButtplugClientConnectorException = void 0;
+const Exceptions_1 = require("../core/Exceptions");
+const Messages = __importStar(require("../core/Messages"));
+class ButtplugClientConnectorException extends Exceptions_1.ButtplugError {
+    constructor(message) {
+        super(message, Messages.ErrorClass.ERROR_UNKNOWN);
+    }
+}
+exports.ButtplugClientConnectorException = ButtplugClientConnectorException;
 //# sourceMappingURL=ButtplugClientConnectorException.js.map

package/dist/main/src/client/ButtplugClientDevice.d.ts

@@ -1,68 +1,67 @@
-/*!
- * 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.
- */
-/// <reference types="node" />
-import * as Messages from '../core/Messages';
-import { EventEmitter } from 'events';
-/**
- * Represents an abstract device, capable of taking certain kinds of messages.
- */
-export declare class ButtplugClientDevice extends EventEmitter {
-    private _deviceInfo;
-    private _sendClosure;
-    /**
-     * Return the name of the device.
-     */
-    get name(): string;
-    /**
-     * Return the user set name of the device.
-     */
-    get displayName(): string | undefined;
-    /**
-     * Return the index of the device.
-     */
-    get index(): number;
-    /**
-     * Return the index of the device.
-     */
-    get messageTimingGap(): number | undefined;
-    /**
-     * Return a list of message types the device accepts.
-     */
-    get messageAttributes(): Messages.MessageAttributes;
-    static fromMsg(msg: Messages.DeviceInfo, sendClosure: (device: ButtplugClientDevice, msg: Messages.ButtplugDeviceMessage) => Promise<Messages.ButtplugMessage>): ButtplugClientDevice;
-    private allowedMsgs;
-    /**
-     * @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(_deviceInfo: Messages.DeviceInfo, _sendClosure: (device: ButtplugClientDevice, msg: Messages.ButtplugDeviceMessage) => Promise<Messages.ButtplugMessage>);
-    send(msg: Messages.ButtplugDeviceMessage): Promise<Messages.ButtplugMessage>;
-    sendExpectOk(msg: Messages.ButtplugDeviceMessage): Promise<void>;
-    scalar(scalar: Messages.ScalarSubcommand | Messages.ScalarSubcommand[]): Promise<void>;
-    private scalarCommandBuilder;
-    get vibrateAttributes(): Messages.GenericDeviceMessageAttributes[];
-    vibrate(speed: number | number[]): Promise<void>;
-    get oscillateAttributes(): Messages.GenericDeviceMessageAttributes[];
-    oscillate(speed: number | number[]): Promise<void>;
-    get rotateAttributes(): Messages.GenericDeviceMessageAttributes[];
-    rotate(values: number | [number, boolean][], clockwise?: boolean): Promise<void>;
-    get linearAttributes(): Messages.GenericDeviceMessageAttributes[];
-    linear(values: number | [number, number][], duration?: number): Promise<void>;
-    sensorRead(sensorIndex: number, sensorType: Messages.SensorType): Promise<number[]>;
-    get hasBattery(): boolean;
-    battery(): Promise<number>;
-    get hasRssi(): boolean;
-    rssi(): Promise<number>;
-    rawRead(endpoint: string, expectedLength: number, timeout: number): Promise<Uint8Array>;
-    rawWrite(endpoint: string, data: Uint8Array, writeWithResponse: boolean): Promise<void>;
-    rawSubscribe(endpoint: string): Promise<void>;
-    rawUnsubscribe(endpoint: string): Promise<void>;
-    stop(): Promise<void>;
-    emitDisconnected(): void;
-}
+/*!
+ * 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 * as Messages from '../core/Messages';
+import { EventEmitter } from 'eventemitter3';
+/**
+ * Represents an abstract device, capable of taking certain kinds of messages.
+ */
+export declare class ButtplugClientDevice extends EventEmitter {
+    private _deviceInfo;
+    private _sendClosure;
+    /**
+     * Return the name of the device.
+     */
+    get name(): string;
+    /**
+     * Return the user set name of the device.
+     */
+    get displayName(): string | undefined;
+    /**
+     * Return the index of the device.
+     */
+    get index(): number;
+    /**
+     * Return the index of the device.
+     */
+    get messageTimingGap(): number | undefined;
+    /**
+     * Return a list of message types the device accepts.
+     */
+    get messageAttributes(): Messages.MessageAttributes;
+    static fromMsg(msg: Messages.DeviceInfo, sendClosure: (device: ButtplugClientDevice, msg: Messages.ButtplugDeviceMessage) => Promise<Messages.ButtplugMessage>): ButtplugClientDevice;
+    private allowedMsgs;
+    /**
+     * @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(_deviceInfo: Messages.DeviceInfo, _sendClosure: (device: ButtplugClientDevice, msg: Messages.ButtplugDeviceMessage) => Promise<Messages.ButtplugMessage>);
+    send(msg: Messages.ButtplugDeviceMessage): Promise<Messages.ButtplugMessage>;
+    sendExpectOk(msg: Messages.ButtplugDeviceMessage): Promise<void>;
+    scalar(scalar: Messages.ScalarSubcommand | Messages.ScalarSubcommand[]): Promise<void>;
+    private scalarCommandBuilder;
+    get vibrateAttributes(): Messages.GenericDeviceMessageAttributes[];
+    vibrate(speed: number | number[]): Promise<void>;
+    get oscillateAttributes(): Messages.GenericDeviceMessageAttributes[];
+    oscillate(speed: number | number[]): Promise<void>;
+    get rotateAttributes(): Messages.GenericDeviceMessageAttributes[];
+    rotate(values: number | [number, boolean][], clockwise?: boolean): Promise<void>;
+    get linearAttributes(): Messages.GenericDeviceMessageAttributes[];
+    linear(values: number | [number, number][], duration?: number): Promise<void>;
+    sensorRead(sensorIndex: number, sensorType: Messages.SensorType): Promise<number[]>;
+    get hasBattery(): boolean;
+    battery(): Promise<number>;
+    get hasRssi(): boolean;
+    rssi(): Promise<number>;
+    rawRead(endpoint: string, expectedLength: number, timeout: number): Promise<Uint8Array>;
+    rawWrite(endpoint: string, data: Uint8Array, writeWithResponse: boolean): Promise<void>;
+    rawSubscribe(endpoint: string): Promise<void>;
+    rawUnsubscribe(endpoint: string): Promise<void>;
+    stop(): Promise<void>;
+    emitDisconnected(): void;
+}