Package io.github.blackspherefollower.buttplug4j.client

Class ButtplugClientDevice

java.lang.Object

io.github.blackspherefollower.buttplug4j.client.ButtplugClientDevice

public final class ButtplugClientDevice
extends Object

ButtplugClientDevice.

Constructor Summary

Constructors

Constructor	Description
ButtplugClientDevice(ButtplugClient bpClient, Device device)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Map<Integer,ButtplugClientDeviceFeature>	getDeviceFeatures()	Get the device features.
int	getDeviceIndex()	Get the device index.
String	getDisplayName()	Get the device display name.
Integer	getMessageTimingGap()	Get the device message timing gap.
String	getName()	Get the device name.
int	hashCode()
boolean	hasInput(ButtplugInput inputType)	Check if the device has a specific input type.
boolean	hasOutput(ButtplugOutput outputType)	Check if the device has a specific output type.
int	readBattery()	Read the battery level.
int	readRSSI()	Read the RSSI.
List<Future<ButtplugMessage>>	runConstrictFloat(float constrict)	Run constrict.
List<Future<ButtplugMessage>>	runHwPositionWithDurationFloat(float position, int duration)	Run HW position with duration.
Future<ButtplugMessage>	runInput(int featureIndex, ButtplugInput inputType, InputCommandType inputCommand)	Run an input command.
Future<ButtplugMessage>	runInputRead(int featureIndex, ButtplugInput inputType)	Read an input.
Future<ButtplugMessage>	runInputSubscribe(int featureIndex, ButtplugInput inputType)	Subscribe to an input.
Future<ButtplugMessage>	runInputUnsubscribe(int featureIndex, ButtplugInput inputType)	Unsubscribe from an input.
List<Future<ButtplugMessage>>	runLedFloat(float led)	Run LED.
List<Future<ButtplugMessage>>	runOscillateFloat(float oscillate)	Run oscillate.
Future<ButtplugMessage>	runOutput(int featureIndex, OutputCmd.IOutputCommand outputCommand)	Run an output command.
List<Future<ButtplugMessage>>	runPositionFloat(float position)	Run position.
List<Future<ButtplugMessage>>	runRotateFloat(float rotate)	Run rotate.
List<Future<ButtplugMessage>>	runSprayFloat(float spray)	Run spray.
List<Future<ButtplugMessage>>	runTemperatureFloat(float temperature)	Run temperature.
List<Future<ButtplugMessage>>	runVibrateFloat(float vibrate)	Run vibrate.
Future<ButtplugMessage>	sendStopDeviceCmd()	Send a stop device command.
Future<ButtplugMessage>	sendStopDeviceCmd(boolean inputs, boolean outputs)	Send a stop device command.
Future<ButtplugMessage>	sendStopDeviceCmd(int featureIndex)	Send a stop device command for a specific feature.
Future<ButtplugMessage>	sendStopDeviceCmd(int featureIndex, boolean inputs, boolean outputs)	Send a stop device command for a specific feature.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ButtplugClientDevice

public ButtplugClientDevice(ButtplugClient bpClient,
 Device device)

Constructor.

Parameters:

bpClient - client

device - device

Method Details

sendStopDeviceCmd

public Future<ButtplugMessage> sendStopDeviceCmd()

Send a stop device command.

Returns:

future

sendStopDeviceCmd

public Future<ButtplugMessage> sendStopDeviceCmd(boolean inputs,
 boolean outputs)

Send a stop device command.

Parameters:

inputs - stop inputs

outputs - stop outputs

Returns:

future

sendStopDeviceCmd

public Future<ButtplugMessage> sendStopDeviceCmd(int featureIndex)

Send a stop device command for a specific feature.

Parameters:

featureIndex - feature index

Returns:

future

sendStopDeviceCmd

public Future<ButtplugMessage> sendStopDeviceCmd(int featureIndex,
 boolean inputs,
 boolean outputs)

Send a stop device command for a specific feature.

Parameters:

featureIndex - feature index

inputs - stop inputs

outputs - stop outputs

Returns:

future

getDeviceIndex

public int getDeviceIndex()

Get the device index.

Returns:

device index

getName

public String getName()

Get the device name.

Returns:

device name

getDisplayName

public String getDisplayName()

Get the device display name.

Returns:

device display name

getMessageTimingGap

public Integer getMessageTimingGap()

Get the device message timing gap.

Returns:

device message timing gap

getDeviceFeatures

public Map<Integer,ButtplugClientDeviceFeature> getDeviceFeatures()

Get the device features.

Returns:

device features

hasOutput

public boolean hasOutput(ButtplugOutput outputType)

Check if the device has a specific output type.

Parameters:

outputType - output type

Returns:

true if has output

runOutput

public Future<ButtplugMessage> runOutput(int featureIndex,
 OutputCmd.IOutputCommand outputCommand)

Run an output command.

Parameters:

featureIndex - feature index

outputCommand - command

Returns:

future

hasInput

public boolean hasInput(ButtplugInput inputType)

Check if the device has a specific input type.

Parameters:

inputType - input type

Returns:

true if has input

runInput

public Future<ButtplugMessage> runInput(int featureIndex,
 ButtplugInput inputType,
 InputCommandType inputCommand)

Run an input command.

Parameters:

featureIndex - feature index

inputType - input type

inputCommand - command

Returns:

future

runInputRead

public Future<ButtplugMessage> runInputRead(int featureIndex,
 ButtplugInput inputType)

Read an input.

Parameters:

featureIndex - feature index

inputType - input type

Returns:

future

runInputSubscribe

public Future<ButtplugMessage> runInputSubscribe(int featureIndex,
 ButtplugInput inputType)

Subscribe to an input.

Parameters:

featureIndex - feature index

inputType - input type

Returns:

future

runInputUnsubscribe

public Future<ButtplugMessage> runInputUnsubscribe(int featureIndex,
 ButtplugInput inputType)

Unsubscribe from an input.

Parameters:

featureIndex - feature index

inputType - input type

Returns:

future

readBattery

public int readBattery()
                throws ExecutionException,
InterruptedException,
TimeoutException,
ButtplugException

Read the battery level.

Returns:

battery level

Throws:

ExecutionException - if an error occurs

InterruptedException - if an error occurs

TimeoutException - if an error occurs

ButtplugException - if an error occurs

readRSSI

public int readRSSI()
             throws ExecutionException,
InterruptedException,
TimeoutException,
ButtplugException

Read the RSSI.

Returns:

RSSI

Throws:

ExecutionException - if an error occurs

InterruptedException - if an error occurs

TimeoutException - if an error occurs

ButtplugException - if an error occurs

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

runVibrateFloat

public List<Future<ButtplugMessage>> runVibrateFloat(float vibrate)
                                              throws ButtplugDeviceFeatureException

Run vibrate.

Parameters:

vibrate - vibrate value

Returns:

futures

Throws:

ButtplugDeviceFeatureException - if an error occurs

runRotateFloat

public List<Future<ButtplugMessage>> runRotateFloat(float rotate)
                                             throws ButtplugDeviceFeatureException

Run rotate.

Parameters:

rotate - rotate value

Returns:

futures

Throws:

ButtplugDeviceFeatureException - if an error occurs

runSprayFloat

public List<Future<ButtplugMessage>> runSprayFloat(float spray)
                                            throws ButtplugDeviceFeatureException

Run spray.

Parameters:

spray - spray value

Returns:

futures

Throws:

ButtplugDeviceFeatureException - if an error occurs

runOscillateFloat

public List<Future<ButtplugMessage>> runOscillateFloat(float oscillate)
                                                throws ButtplugDeviceFeatureException

Run oscillate.

Parameters:

oscillate - oscillate value

Returns:

futures

Throws:

ButtplugDeviceFeatureException - if an error occurs

runPositionFloat

public List<Future<ButtplugMessage>> runPositionFloat(float position)
                                               throws ButtplugDeviceFeatureException

Run position.

Parameters:

position - position value

Returns:

futures

Throws:

ButtplugDeviceFeatureException - if an error occurs

runLedFloat

public List<Future<ButtplugMessage>> runLedFloat(float led)
                                          throws ButtplugDeviceFeatureException

Run LED.

Parameters:

led - LED value

Returns:

futures

Throws:

ButtplugDeviceFeatureException - if an error occurs

runTemperatureFloat

public List<Future<ButtplugMessage>> runTemperatureFloat(float temperature)
                                                  throws ButtplugDeviceFeatureException

Run temperature.

Parameters:

temperature - temperature value

Returns:

futures

Throws:

ButtplugDeviceFeatureException - if an error occurs

runConstrictFloat

public List<Future<ButtplugMessage>> runConstrictFloat(float constrict)
                                                throws ButtplugDeviceFeatureException

Run constrict.

Parameters:

constrict - constrict value

Returns:

futures

Throws:

ButtplugDeviceFeatureException - if an error occurs

runHwPositionWithDurationFloat

public List<Future<ButtplugMessage>> runHwPositionWithDurationFloat(float position,
 int duration)
                                                             throws ButtplugDeviceFeatureException

Run HW position with duration.

Parameters:

position - position value

duration - duration

Returns:

futures

Throws:

ButtplugDeviceFeatureException - if an error occurs