Class ButtplugClientDevice

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

Hierarchy

EventEmitter
- ButtplugClientDevice

Constructors

constructor

new ButtplugClientDevice(_deviceInfo, _sendClosure): ButtplugClientDevice
Parameters
- _deviceInfo: DeviceInfo
- _sendClosure: ((device, msg) => Promise<ButtplugMessage>)
  - - (device, msg): Promise<ButtplugMessage>
    - Parameters
      device: ButtplugClientDevice
      msg: ButtplugDeviceMessage
      Returns Promise<ButtplugMessage>
Returns ButtplugClientDevice
Overrides EventEmitter.constructor
- Defined in src/client/ButtplugClientDevice.ts:79

Accessors

displayName

get displayName(): undefined | string
Return the user set name of the device.

Returns undefined | string
- Defined in src/client/ButtplugClientDevice.ts:33

hasBattery

get hasBattery(): boolean
Returns boolean
- Defined in src/client/ButtplugClientDevice.ts:261

hasRssi

get hasRssi(): boolean
Returns boolean
- Defined in src/client/ButtplugClientDevice.ts:285

index

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

Returns number
- Defined in src/client/ButtplugClientDevice.ts:40

linearAttributes

get linearAttributes(): GenericDeviceMessageAttributes[]
Returns GenericDeviceMessageAttributes[]
- Defined in src/client/ButtplugClientDevice.ts:212

messageAttributes

get messageAttributes(): MessageAttributes
Return a list of message types the device accepts.

Returns MessageAttributes
- Defined in src/client/ButtplugClientDevice.ts:54

messageTimingGap

get messageTimingGap(): undefined | number
Return the index of the device.

Returns undefined | number
- Defined in src/client/ButtplugClientDevice.ts:47

name

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

Returns string
- Defined in src/client/ButtplugClientDevice.ts:26

Methods

battery

battery(): Promise<number>
Returns Promise<number>
- Defined in src/client/ButtplugClientDevice.ts:268

emitDisconnected

emitDisconnected(): void
Returns void
- Defined in src/client/ButtplugClientDevice.ts:398

linear

linear(values, duration?): Promise<void>
Parameters
- values: number | [number, number][]
- Optional duration: number
Returns Promise<void>
- Defined in src/client/ButtplugClientDevice.ts:216

oscillate

oscillate(speed): Promise<void>
Parameters
- speed: number | number[]
Returns Promise<void>
- Defined in src/client/ButtplugClientDevice.ts:178

rawRead

rawRead(endpoint, expectedLength, timeout): Promise<Uint8Array>
Parameters
- endpoint: string
- expectedLength: number
- timeout: number
Returns Promise<Uint8Array>
- Defined in src/client/ButtplugClientDevice.ts:309

rawSubscribe

rawSubscribe(endpoint): Promise<void>
Parameters
- endpoint: string
Returns Promise<void>
- Defined in src/client/ButtplugClientDevice.ts:359

rawUnsubscribe

rawUnsubscribe(endpoint): Promise<void>
Parameters
- endpoint: string
Returns Promise<void>
- Defined in src/client/ButtplugClientDevice.ts:375

rawWrite

rawWrite(endpoint, data, writeWithResponse): Promise<void>
Parameters
- endpoint: string
- data: Uint8Array
- writeWithResponse: boolean
Returns Promise<void>
- Defined in src/client/ButtplugClientDevice.ts:339

rotate

rotate(values, clockwise?): Promise<void>
Parameters
- values: number | [number, boolean][]
- Optional clockwise: boolean
Returns Promise<void>
- Defined in src/client/ButtplugClientDevice.ts:186

rssi

rssi(): Promise<number>
Returns Promise<number>
- Defined in src/client/ButtplugClientDevice.ts:292

scalar

scalar(scalar): Promise<void>
Parameters
- scalar: ScalarSubcommand | ScalarSubcommand[]
Returns Promise<void>
- Defined in src/client/ButtplugClientDevice.ts:114

send

send(msg): Promise<ButtplugMessage>
Parameters
- msg: ButtplugDeviceMessage
Returns Promise<ButtplugMessage>
- Defined in src/client/ButtplugClientDevice.ts:90

sendExpectOk

sendExpectOk(msg): Promise<void>
Parameters
- msg: ButtplugDeviceMessage
Returns Promise<void>
- Defined in src/client/ButtplugClientDevice.ts:98

sensorRead

sensorRead(sensorIndex, sensorType): Promise<number[]>
Parameters
- sensorIndex: number
- sensorType: SensorType
Returns Promise<number[]>
- Defined in src/client/ButtplugClientDevice.ts:242

stop

stop(): Promise<void>
Returns Promise<void>
- Defined in src/client/ButtplugClientDevice.ts:394

vibrate

vibrate(speed): Promise<void>
Parameters
- speed: number | number[]
Returns Promise<void>
- Defined in src/client/ButtplugClientDevice.ts:166

`Static` fromMsg

fromMsg(msg, sendClosure): ButtplugClientDevice
Parameters
- msg: DeviceInfo
- sendClosure: ((device, msg) => Promise<ButtplugMessage>)
  - - (device, msg): Promise<ButtplugMessage>
    - Parameters
      device: ButtplugClientDevice
      msg: ButtplugDeviceMessage
      Returns Promise<ButtplugMessage>
Returns ButtplugClientDevice
- Defined in src/client/ButtplugClientDevice.ts:58

Class ButtplugClientDevice

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Parameters

Returns Promise<ButtplugMessage>

Returns ButtplugClientDevice

Accessors

displayName

Returns undefined | string

hasBattery

Returns boolean

hasRssi

Returns boolean

index

Returns number

linearAttributes

Returns GenericDeviceMessageAttributes[]

messageAttributes

Returns MessageAttributes

messageTimingGap

Returns undefined | number

name

Returns string

oscillateAttributes

Returns GenericDeviceMessageAttributes[]

rotateAttributes

Returns GenericDeviceMessageAttributes[]

vibrateAttributes

Returns GenericDeviceMessageAttributes[]

Methods

battery

Returns Promise<number>

emitDisconnected

Returns void

linear

Parameters

Returns Promise<void>

oscillate

Parameters

Returns Promise<void>

rawRead

Parameters

Returns Promise<Uint8Array>

rawSubscribe

Parameters

Returns Promise<void>

rawUnsubscribe

Parameters

Returns Promise<void>

rawWrite

Parameters

Returns Promise<void>

rotate

Parameters

Returns Promise<void>

rssi

Returns Promise<number>

scalar

Parameters

Returns Promise<void>

send

Parameters

Returns Promise<ButtplugMessage>

sendExpectOk

Parameters

Returns Promise<void>

sensorRead

Parameters

Returns Promise<number[]>

stop

Returns Promise<void>

vibrate

Parameters

Returns Promise<void>

`Static` fromMsg