buttplug 3.2.1 → 4.0.0

package/src/client/ButtplugClientDeviceCommand.ts

@@ -0,0 +1,112 @@
+import { ButtplugDeviceError } from "../core/Exceptions";
+import { OutputType } from "../core/Messages";
+
+class PercentOrSteps {
+  private _percent: number | undefined;
+  private _steps: number | undefined;
+
+  public get percent() {
+    return this._percent;
+  }
+
+  public get steps() {
+    return this._steps;
+  }
+
+  public static createSteps(s: number): PercentOrSteps {
+    let v = new PercentOrSteps;
+    v._steps = s;
+    return v;
+  }
+
+  public static createPercent(p: number): PercentOrSteps {
+    if (p < 0 || p > 1.0) {
+      throw new ButtplugDeviceError(`Percent value ${p} is not in the range 0.0 <= x <= 1.0`);
+    }      
+
+    let v = new PercentOrSteps;
+    v._percent = p;
+    return v;
+  }
+}
+
+export class DeviceOutputCommand {
+  public constructor( 
+    private _outputType: OutputType,
+    private _value: PercentOrSteps,
+    private _duration?: number,
+  )
+  {}
+
+  public get outputType() {
+    return this._outputType;
+  }
+
+  public get value() {
+    return this._value;
+  }
+
+  public get duration() {
+    return this._duration;
+  }
+}
+
+export class DeviceOutputValueConstructor {
+  public constructor(
+    private _outputType: OutputType) 
+  {}
+
+  public steps(steps: number): DeviceOutputCommand {
+    return new DeviceOutputCommand(this._outputType, PercentOrSteps.createSteps(steps), undefined);
+  }
+
+  public percent(percent: number): DeviceOutputCommand {
+    return new DeviceOutputCommand(this._outputType, PercentOrSteps.createPercent(percent), undefined);
+  }
+}
+
+export class DeviceOutputPositionWithDurationConstructor {
+  public steps(steps: number, duration: number): DeviceOutputCommand {
+    return new DeviceOutputCommand(OutputType.Position, PercentOrSteps.createSteps(steps), duration);
+  }
+
+  public percent(percent: number, duration: number): DeviceOutputCommand {
+    return new DeviceOutputCommand(OutputType.HwPositionWithDuration, PercentOrSteps.createPercent(percent), duration);
+  }
+}
+
+export class DeviceOutput {
+  private constructor() {}
+
+  public static get Vibrate() {
+    return new DeviceOutputValueConstructor(OutputType.Vibrate);
+  }
+  public static get Rotate() {
+    return new DeviceOutputValueConstructor(OutputType.Rotate);
+  }
+  public static get Oscillate() {
+    return new DeviceOutputValueConstructor(OutputType.Oscillate);
+  }
+  public static get Constrict() {
+    return new DeviceOutputValueConstructor(OutputType.Constrict);
+  }
+  public static get Inflate() {
+    return new DeviceOutputValueConstructor(OutputType.Inflate);
+  }
+  public static get Temperature() {
+    return new DeviceOutputValueConstructor(OutputType.Temperature);
+  }
+  public static get Led() {
+    return new DeviceOutputValueConstructor(OutputType.Led);
+  }
+  public static get Spray() {
+    return new DeviceOutputValueConstructor(OutputType.Spray);
+  }
+  public static get Position() {
+    return new DeviceOutputValueConstructor(OutputType.Position);
+  }
+  public static get PositionWithDuration() {
+    return new DeviceOutputPositionWithDurationConstructor();
+  }
+}
+

package/src/client/ButtplugClientDeviceFeature.ts

@@ -0,0 +1,138 @@
+import { ButtplugDeviceError, ButtplugError, ButtplugMessageError } from "../core/Exceptions";
+import * as Messages from "../core/Messages";
+import { DeviceOutputCommand } from "./ButtplugClientDeviceCommand";
+
+export class ButtplugClientDeviceFeature {
+
+  constructor(
+    private _deviceIndex: number,
+    private _deviceName: string,
+    private _feature: Messages.DeviceFeature,
+    private _sendClosure: (
+      msg: Messages.ButtplugMessage
+    ) => Promise<Messages.ButtplugMessage>) {
+  }
+
+  protected send = async (msg: Messages.ButtplugMessage): Promise<Messages.ButtplugMessage> => {
+    return await this._sendClosure(msg);
+  }
+
+  protected sendMsgExpectOk = async (
+    msg: Messages.ButtplugMessage
+  ): Promise<void> => {
+    const response = await this.send(msg);
+    if (response.Ok !== undefined) {
+      return;
+    } else if (response.Error !== undefined) {
+      throw ButtplugError.FromError(response as Messages.Error);
+    } else {
+      throw new ButtplugMessageError("Expected Ok or Error, and didn't get either!");
+    }
+  };
+
+  protected isOutputValid(type: Messages.OutputType) {
+    if (this._feature.Output !== undefined && !this._feature.Output.hasOwnProperty(type)) {
+      throw new ButtplugDeviceError(`Feature index ${this._feature.FeatureIndex} does not support type ${type} for device ${this._deviceName}`);
+    }
+  }
+
+  protected isInputValid(type: Messages.InputType) {
+    if (this._feature.Input !== undefined && !this._feature.Input.hasOwnProperty(type)) {
+      throw new ButtplugDeviceError(`Feature index ${this._feature.FeatureIndex} does not support type ${type} for device ${this._deviceName}`);
+    }
+  }
+
+  protected async sendOutputCmd(command: DeviceOutputCommand): Promise<void> {
+    // Make sure the requested feature is valid
+    this.isOutputValid(command.outputType);
+    if (command.value === undefined) {
+      throw new ButtplugDeviceError(`${command.outputType} requires value defined`);
+    }
+
+    let type = command.outputType;
+    let duration: undefined | number = undefined;
+    if (type == Messages.OutputType.HwPositionWithDuration) {
+      if (command.duration === undefined) {
+        throw new ButtplugDeviceError("PositionWithDuration requires duration defined");
+      }
+      duration = command.duration;
+    } 
+    let value: number;
+    let p = command.value;
+    if (p.percent === undefined) {
+      // TODO Check step limits here
+      value = command.value.steps!;
+    } else {
+      value = Math.ceil(this._feature.Output[type]!.Value![1] * p.percent);
+    }
+    let newCommand: Messages.DeviceFeatureOutput = { Value: value, Duration: duration };
+    let outCommand = {};
+    outCommand[type.toString()] = newCommand;
+
+    let cmd: Messages.ButtplugMessage = {
+      OutputCmd: {
+        Id: 1,
+        DeviceIndex: this._deviceIndex, 
+        FeatureIndex: this._feature.FeatureIndex, 
+        Command: outCommand 
+      }
+    };
+    await this.sendMsgExpectOk(cmd);
+  }
+
+  public hasOutput(type: Messages.OutputType): boolean {
+    if (this._feature.Output !== undefined) {
+      return this._feature.Output.hasOwnProperty(type.toString());
+    }
+    return false;
+  }
+
+  public hasInput(type: Messages.InputType): boolean {
+    if (this._feature.Input !== undefined) {
+      return this._feature.Input.hasOwnProperty(type.toString());
+    }
+    return false;
+  }
+
+
+  public async runOutput(cmd: DeviceOutputCommand): Promise<void> {
+    if (this._feature.Output !== undefined && this._feature.Output.hasOwnProperty(cmd.outputType.toString())) {
+      return this.sendOutputCmd(cmd);
+    }
+    throw new ButtplugDeviceError(`Output type ${cmd.outputType} not supported by feature.`);
+  }
+
+  public async runInput(inputType: Messages.InputType, inputCommand: Messages.InputCommandType): Promise<Messages.InputReading | undefined> {
+    // Make sure the requested feature is valid
+    this.isInputValid(inputType);
+    let inputAttributes = this._feature.Input[inputType];
+    console.log(this._feature.Input);
+    if ((inputCommand === Messages.InputCommandType.Unsubscribe && !inputAttributes.Command.includes(Messages.InputCommandType.Subscribe)) && !inputAttributes.Command.includes(inputCommand)) {
+      throw new ButtplugDeviceError(`${inputType} does not support command ${inputCommand}`);
+    }
+
+    let cmd: Messages.ButtplugMessage = {
+      InputCmd: {
+        Id: 1,
+        DeviceIndex: this._deviceIndex, 
+        FeatureIndex: this._feature.FeatureIndex, 
+        Type: inputType,
+        Command: inputCommand,
+      }
+    };
+    if (inputCommand == Messages.InputCommandType.Read) {
+      const response = await this.send(cmd);
+      if (response.InputReading !== undefined) {
+        return response.InputReading;
+      } else if (response.Error !== undefined) {
+        throw ButtplugError.FromError(response as Messages.Error);
+      } else {
+        throw new ButtplugMessageError("Expected InputReading or Error, and didn't get either!");
+      }
+    } else {
+      console.log(`Sending subscribe message: ${JSON.stringify(cmd)}`);
+      await this.sendMsgExpectOk(cmd);
+      console.log("Got back ok?");
+    }
+  }
+}

package/src/client/ButtplugNodeWebsocketClientConnector.ts

@@ -1,17 +1,17 @@
-/*!
- * 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 { ButtplugBrowserWebsocketClientConnector } from './ButtplugBrowserWebsocketClientConnector';
-import { WebSocket as NodeWebSocket } from 'ws';
-
-export class ButtplugNodeWebsocketClientConnector extends ButtplugBrowserWebsocketClientConnector {
-  protected _websocketConstructor =
-    NodeWebSocket as unknown as typeof WebSocket;
-}
+/*!
+ * 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 { ButtplugBrowserWebsocketClientConnector } from './ButtplugBrowserWebsocketClientConnector';
+import { WebSocket as NodeWebSocket } from 'ws';
+
+export class ButtplugNodeWebsocketClientConnector extends ButtplugBrowserWebsocketClientConnector {
+  protected _websocketConstructor =
+    NodeWebSocket as unknown as typeof WebSocket;
+}

package/src/client/IButtplugClientConnector.ts

@@ -1,18 +1,18 @@
-/*!
- * 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 { ButtplugMessage } from '../core/Messages';
-import { EventEmitter } from 'eventemitter3';
-
-export interface IButtplugClientConnector extends EventEmitter {
-  connect: () => Promise<void>;
-  disconnect: () => Promise<void>;
-  initialize: () => Promise<void>;
-  send: (msg: ButtplugMessage) => void;
-  readonly Connected: boolean;
-}
+/*!
+ * 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 { ButtplugMessage } from '../core/Messages';
+import { EventEmitter } from 'eventemitter3';
+
+export interface IButtplugClientConnector extends EventEmitter {
+  connect: () => Promise<void>;
+  disconnect: () => Promise<void>;
+  initialize: () => Promise<void>;
+  send: (msg: ButtplugMessage) => void;
+  readonly Connected: boolean;
+}

package/src/core/Exceptions.ts

@@ -1,101 +1,107 @@
-/*!
- * 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 './Messages';
-import { ButtplugLogger } from './Logging';
-
-export class ButtplugError extends Error {
-  public get ErrorClass(): Messages.ErrorClass {
-    return this.errorClass;
-  }
-
-  public get InnerError(): Error | undefined {
-    return this.innerError;
-  }
-
-  public get Id(): number | undefined {
-    return this.messageId;
-  }
-
-  public get ErrorMessage(): Messages.ButtplugMessage {
-    return new Messages.Error(this.message, this.ErrorClass, this.Id);
-  }
-
-  public static LogAndError<T extends ButtplugError>(
-    constructor: new (str: string, num: number) => T,
-    logger: ButtplugLogger,
-    message: string,
-    id: number = Messages.SYSTEM_MESSAGE_ID
-  ): T {
-    logger.Error(message);
-    return new constructor(message, id);
-  }
-
-  public static FromError(error: Messages.Error) {
-    switch (error.ErrorCode) {
-      case Messages.ErrorClass.ERROR_DEVICE:
-        return new ButtplugDeviceError(error.ErrorMessage, error.Id);
-      case Messages.ErrorClass.ERROR_INIT:
-        return new ButtplugInitError(error.ErrorMessage, error.Id);
-      case Messages.ErrorClass.ERROR_UNKNOWN:
-        return new ButtplugUnknownError(error.ErrorMessage, error.Id);
-      case Messages.ErrorClass.ERROR_PING:
-        return new ButtplugPingError(error.ErrorMessage, error.Id);
-      case Messages.ErrorClass.ERROR_MSG:
-        return new ButtplugMessageError(error.ErrorMessage, error.Id);
-      default:
-        throw new Error(`Message type ${error.ErrorCode} not handled`);
-    }
-  }
-
-  public errorClass: Messages.ErrorClass = Messages.ErrorClass.ERROR_UNKNOWN;
-  public innerError: Error | undefined;
-  public messageId: number | undefined;
-
-  protected constructor(
-    message: string,
-    errorClass: Messages.ErrorClass,
-    id: number = Messages.SYSTEM_MESSAGE_ID,
-    inner?: Error
-  ) {
-    super(message);
-    this.errorClass = errorClass;
-    this.innerError = inner;
-    this.messageId = id;
-  }
-}
-
-export class ButtplugInitError extends ButtplugError {
-  public constructor(message: string, id: number = Messages.SYSTEM_MESSAGE_ID) {
-    super(message, Messages.ErrorClass.ERROR_INIT, id);
-  }
-}
-
-export class ButtplugDeviceError extends ButtplugError {
-  public constructor(message: string, id: number = Messages.SYSTEM_MESSAGE_ID) {
-    super(message, Messages.ErrorClass.ERROR_DEVICE, id);
-  }
-}
-
-export class ButtplugMessageError extends ButtplugError {
-  public constructor(message: string, id: number = Messages.SYSTEM_MESSAGE_ID) {
-    super(message, Messages.ErrorClass.ERROR_MSG, id);
-  }
-}
-
-export class ButtplugPingError extends ButtplugError {
-  public constructor(message: string, id: number = Messages.SYSTEM_MESSAGE_ID) {
-    super(message, Messages.ErrorClass.ERROR_PING, id);
-  }
-}
-
-export class ButtplugUnknownError extends ButtplugError {
-  public constructor(message: string, id: number = Messages.SYSTEM_MESSAGE_ID) {
-    super(message, Messages.ErrorClass.ERROR_UNKNOWN, id);
-  }
-}
+/*!
+ * 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 './Messages';
+import { ButtplugLogger } from './Logging';
+
+export class ButtplugError extends Error {
+  public get ErrorClass(): Messages.ErrorClass {
+    return this.errorClass;
+  }
+
+  public get InnerError(): Error | undefined {
+    return this.innerError;
+  }
+
+  public get Id(): number | undefined {
+    return this.messageId;
+  }
+
+  public get ErrorMessage(): Messages.ButtplugMessage {
+    return {
+      Error: {
+        Id: this.Id,
+        ErrorCode: this.ErrorClass,
+        ErrorMessage: this.message
+      }
+    } 
+  }
+
+  public static LogAndError<T extends ButtplugError>(
+    constructor: new (str: string, num: number) => T,
+    logger: ButtplugLogger,
+    message: string,
+    id: number = Messages.SYSTEM_MESSAGE_ID
+  ): T {
+    logger.Error(message);
+    return new constructor(message, id);
+  }
+
+  public static FromError(error: Messages.Error) {
+    switch (error.ErrorCode) {
+      case Messages.ErrorClass.ERROR_DEVICE:
+        return new ButtplugDeviceError(error.ErrorMessage, error.Id);
+      case Messages.ErrorClass.ERROR_INIT:
+        return new ButtplugInitError(error.ErrorMessage, error.Id);
+      case Messages.ErrorClass.ERROR_UNKNOWN:
+        return new ButtplugUnknownError(error.ErrorMessage, error.Id);
+      case Messages.ErrorClass.ERROR_PING:
+        return new ButtplugPingError(error.ErrorMessage, error.Id);
+      case Messages.ErrorClass.ERROR_MSG:
+        return new ButtplugMessageError(error.ErrorMessage, error.Id);
+      default:
+        throw new Error(`Message type ${error.ErrorCode} not handled`);
+    }
+  }
+
+  public errorClass: Messages.ErrorClass = Messages.ErrorClass.ERROR_UNKNOWN;
+  public innerError: Error | undefined;
+  public messageId: number | undefined;
+
+  protected constructor(
+    message: string,
+    errorClass: Messages.ErrorClass,
+    id: number = Messages.SYSTEM_MESSAGE_ID,
+    inner?: Error
+  ) {
+    super(message);
+    this.errorClass = errorClass;
+    this.innerError = inner;
+    this.messageId = id;
+  }
+}
+
+export class ButtplugInitError extends ButtplugError {
+  public constructor(message: string, id: number = Messages.SYSTEM_MESSAGE_ID) {
+    super(message, Messages.ErrorClass.ERROR_INIT, id);
+  }
+}
+
+export class ButtplugDeviceError extends ButtplugError {
+  public constructor(message: string, id: number = Messages.SYSTEM_MESSAGE_ID) {
+    super(message, Messages.ErrorClass.ERROR_DEVICE, id);
+  }
+}
+
+export class ButtplugMessageError extends ButtplugError {
+  public constructor(message: string, id: number = Messages.SYSTEM_MESSAGE_ID) {
+    super(message, Messages.ErrorClass.ERROR_MSG, id);
+  }
+}
+
+export class ButtplugPingError extends ButtplugError {
+  public constructor(message: string, id: number = Messages.SYSTEM_MESSAGE_ID) {
+    super(message, Messages.ErrorClass.ERROR_PING, id);
+  }
+}
+
+export class ButtplugUnknownError extends ButtplugError {
+  public constructor(message: string, id: number = Messages.SYSTEM_MESSAGE_ID) {
+    super(message, Messages.ErrorClass.ERROR_UNKNOWN, id);
+  }
+}