Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ButtplugClientDevice

Represents an abstract device, capable of taking certain kinds of messages.

Hierarchy

  • ButtplugClientDevice

Index

Constructors

constructor

  • new ButtplugClientDevice(_index: number, _name: string, allowedMsgsObj: object, _sendClosure: function): ButtplugClientDevice

Accessors

AllowedMessages

  • get AllowedMessages(): string[]
  • Return a list of message types the device accepts.

    Returns string[]

Index

  • get Index(): number
  • Return the index of the device.

    Returns number

Name

  • get Name(): string
  • Return the name of the device.

    Returns string

Methods

CheckAllowedMessageType

  • CheckAllowedMessageType(aName: string): void
  • Parameters

    • aName: string

    Returns void

MessageAttributes

  • Return the message attributes related to the given message

    Parameters

    • messageName: string

    Returns MessageAttributes

SendFleshlightLaunchFW12Cmd

  • SendFleshlightLaunchFW12Cmd(aSpeed: number, aPosition: number): Promise<void>
  • Parameters

    • aSpeed: number
    • aPosition: number

    Returns Promise<void>

SendKiirooCmd

  • SendKiirooCmd(aPosition: number): Promise<void>
  • Parameters

    • aPosition: number

    Returns Promise<void>

SendLinearCmd

  • SendLinearCmd(aValues: number | Array<[number, number]>, aDuration?: undefined | number): Promise<void>
  • Parameters

    • aValues: number | Array<[number, number]>
    • Optional aDuration: undefined | number

    Returns Promise<void>

SendLovenseCmd

  • SendLovenseCmd(aDeviceCmd: string): Promise<void>
  • Parameters

    • aDeviceCmd: string

    Returns Promise<void>

SendMessageAsync

  • Parameters

    Returns Promise<void>

SendRotateCmd

  • SendRotateCmd(aValues: number | Array<[number, boolean]>, aClockwise?: undefined | false | true): Promise<void>
  • Parameters

    • aValues: number | Array<[number, boolean]>
    • Optional aClockwise: undefined | false | true

    Returns Promise<void>

SendStopDeviceCmd

  • SendStopDeviceCmd(): Promise<void>
  • Returns Promise<void>

SendVibrateCmd

  • SendVibrateCmd(aSpeed: number | number[]): Promise<void>
  • Parameters

    • aSpeed: number | number[]

    Returns Promise<void>

SendVorzeA10CycloneCmd

  • SendVorzeA10CycloneCmd(aSpeed: number, aClockwise: boolean): Promise<void>
  • Parameters

    • aSpeed: number
    • aClockwise: boolean

    Returns Promise<void>

Static fromMsg

Generated using TypeDoc