Package io.github.blackspherefollower.buttplug4j.client

Class ButtplugClientDeviceFeature

java.lang.Object

io.github.blackspherefollower.buttplug4j.client.ButtplugClientDeviceFeature

public final class ButtplugClientDeviceFeature
extends Object

ButtplugClientDeviceFeature.

Constructor Summary

Constructors

Constructor	Description
ButtplugClientDeviceFeature(ButtplugClientDevice device, DeviceFeature feature)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getDescription()	Get feature description.
int	getFeatureIndex()	Get feature index.
HashMap<ButtplugInput,DeviceFeature.InputDescriptor>	getInput()	Get inputs.
HashMap<ButtplugOutput,DeviceFeature.OutputDescriptor>	getOutput()	Get outputs.
boolean	hasBattery()	Check if battery is supported.
boolean	hasConstrict()	Check if constrict is supported.
int	hashCode()
boolean	hasHwPositionWithDuration()	Check if HW position with duration is supported.
boolean	hasInput(ButtplugInput inputType)	Check if input is supported.
boolean	hasLed()	Check if LED is supported.
boolean	hasOscillate()	Check if oscillate is supported.
boolean	hasOutput(ButtplugOutput type)	Check if output is supported.
boolean	hasPosition()	Check if position is supported.
boolean	hasRotate()	Check if rotate is supported.
boolean	hasRSSI()	Check if RSSI is supported.
boolean	hasSpray()	Check if spray is supported.
boolean	hasTemperature()	Check if temperature is supported.
boolean	hasVibrate()	Check if vibrate is supported.
int	readBattery()	Read battery level.
int	readRSSI()	Read RSSI level.
Future<ButtplugMessage>	runConstrict(int constrict)	Run constrict.
Future<ButtplugMessage>	runConstrictFloat(float constrict)	Run constrict.
Future<ButtplugMessage>	runHwPositionWithDuration(int position, int duration)	Run HW position with duration.
Future<ButtplugMessage>	runHwPositionWithDurationFloat(float position, int duration)	Run HW position with duration.
Future<ButtplugMessage>	runLed(int led)	Run LED.
Future<ButtplugMessage>	runLedFloat(float led)	Run LED.
Future<ButtplugMessage>	runOscillate(int oscillate)	Run oscillate.
Future<ButtplugMessage>	runOscillateFloat(float oscillate)	Run oscillate.
Future<ButtplugMessage>	runPosition(int position)	Run position.
Future<ButtplugMessage>	runPositionFloat(float position)	Run position.
Future<ButtplugMessage>	runRotate(int rotate)	Run rotate.
Future<ButtplugMessage>	runRotateFloat(float rotate)	Run rotate.
Future<ButtplugMessage>	runSpray(int spray)	Run spray.
Future<ButtplugMessage>	runSprayFloat(float spray)	Run spray.
Future<ButtplugMessage>	runTemperature(int temperature)	Run temperature.
Future<ButtplugMessage>	runTemperatureFloat(float temperature)	Run temperature.
Future<ButtplugMessage>	runVibrate(int vibrate)	Run vibrate.
Future<ButtplugMessage>	runVibrateFloat(float vibrate)	Run vibrate.

Methods inherited from class java.lang.Object

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

Constructor Details

ButtplugClientDeviceFeature

public ButtplugClientDeviceFeature(ButtplugClientDevice device,
 DeviceFeature feature)

Constructor.

Parameters:

device - parent device

feature - protocol feature

Method Details

getOutput

public HashMap<ButtplugOutput,DeviceFeature.OutputDescriptor> getOutput()

Get outputs.

Returns:

outputs

getInput

public HashMap<ButtplugInput,DeviceFeature.InputDescriptor> getInput()

Get inputs.

Returns:

inputs

getFeatureIndex

public int getFeatureIndex()

Get feature index.

Returns:

feature index

getDescription

public String getDescription()

Get feature description.

Returns:

description

hasOutput

public boolean hasOutput(ButtplugOutput type)

Check if output is supported.

Parameters:

type - output type

Returns:

true if supported

hasVibrate

public boolean hasVibrate()

Check if vibrate is supported.

Returns:

true if supported

runVibrate

public Future<ButtplugMessage> runVibrate(int vibrate)
                                   throws ButtplugDeviceFeatureException

Run vibrate.

Parameters:

vibrate - step count

Returns:

future

Throws:

ButtplugDeviceFeatureException - if error occurs

runVibrateFloat

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

Run vibrate.

Parameters:

vibrate - float value (0.0 to 1.0)

Returns:

future

Throws:

ButtplugDeviceFeatureException - if error occurs

hasRotate

public boolean hasRotate()

Check if rotate is supported.

Returns:

true if supported

runRotate

public Future<ButtplugMessage> runRotate(int rotate)
                                  throws ButtplugDeviceFeatureException

Run rotate.

Parameters:

rotate - step count

Returns:

future

Throws:

ButtplugDeviceFeatureException - if error occurs

runRotateFloat

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

Run rotate.

Parameters:

rotate - float value (0.0 to 1.0)

Returns:

future

Throws:

ButtplugDeviceFeatureException - if error occurs

hasConstrict

public boolean hasConstrict()

Check if constrict is supported.

Returns:

true if supported

runConstrict

public Future<ButtplugMessage> runConstrict(int constrict)
                                     throws ButtplugDeviceFeatureException

Run constrict.

Parameters:

constrict - step count

Returns:

future

Throws:

ButtplugDeviceFeatureException - if error occurs

runConstrictFloat

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

Run constrict.

Parameters:

constrict - float value (0.0 to 1.0)

Returns:

future

Throws:

ButtplugDeviceFeatureException - if error occurs

hasSpray

public boolean hasSpray()

Check if spray is supported.

Returns:

true if supported

runSpray

public Future<ButtplugMessage> runSpray(int spray)
                                 throws ButtplugDeviceFeatureException

Run spray.

Parameters:

spray - step count

Returns:

future

Throws:

ButtplugDeviceFeatureException - if error occurs

runSprayFloat

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

Run spray.

Parameters:

spray - float value (0.0 to 1.0)

Returns:

future

Throws:

ButtplugDeviceFeatureException - if error occurs

hasPosition

public boolean hasPosition()

Check if position is supported.

Returns:

true if supported

runPosition

public Future<ButtplugMessage> runPosition(int position)
                                    throws ButtplugDeviceFeatureException

Run position.

Parameters:

position - step count

Returns:

future

Throws:

ButtplugDeviceFeatureException - if error occurs

runPositionFloat

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

Run position.

Parameters:

position - float value (0.0 to 1.0)

Returns:

future

Throws:

ButtplugDeviceFeatureException - if error occurs

hasHwPositionWithDuration

public boolean hasHwPositionWithDuration()

Check if HW position with duration is supported.

Returns:

true if supported

runHwPositionWithDuration

public Future<ButtplugMessage> runHwPositionWithDuration(int position,
 int duration)
                                                  throws ButtplugDeviceFeatureException

Run HW position with duration.

Parameters:

position - step count

duration - duration in ms

Returns:

future

Throws:

ButtplugDeviceFeatureException - if error occurs

runHwPositionWithDurationFloat

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

Run HW position with duration.

Parameters:

position - float value (0.0 to 1.0)

duration - duration in ms

Returns:

future

Throws:

ButtplugDeviceFeatureException - if error occurs

hasLed

public boolean hasLed()

Check if LED is supported.

Returns:

true if supported

runLed

public Future<ButtplugMessage> runLed(int led)
                               throws ButtplugDeviceFeatureException

Run LED.

Parameters:

led - step count

Returns:

future

Throws:

ButtplugDeviceFeatureException - if error occurs

runLedFloat

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

Run LED.

Parameters:

led - float value (0.0 to 1.0)

Returns:

future

Throws:

ButtplugDeviceFeatureException - if error occurs

hasOscillate

public boolean hasOscillate()

Check if oscillate is supported.

Returns:

true if supported

runOscillate

public Future<ButtplugMessage> runOscillate(int oscillate)
                                     throws ButtplugDeviceFeatureException

Run oscillate.

Parameters:

oscillate - step count

Returns:

future

Throws:

ButtplugDeviceFeatureException - if error occurs

runOscillateFloat

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

Run oscillate.

Parameters:

oscillate - float value (0.0 to 1.0)

Returns:

future

Throws:

ButtplugDeviceFeatureException - if error occurs

hasTemperature

public boolean hasTemperature()

Check if temperature is supported.

Returns:

true if supported

runTemperature

public Future<ButtplugMessage> runTemperature(int temperature)
                                       throws ButtplugDeviceFeatureException

Run temperature.

Parameters:

temperature - step count

Returns:

future

Throws:

ButtplugDeviceFeatureException - if error occurs

runTemperatureFloat

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

Run temperature.

Parameters:

temperature - float value (0.0 to 1.0)

Returns:

future

Throws:

ButtplugDeviceFeatureException - if error occurs

hasBattery

public boolean hasBattery()

Check if battery is supported.

Returns:

true if supported

readBattery

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

Read battery level.

Returns:

battery level

Throws:

ButtplugException - if error occurs

ExecutionException - if error occurs

InterruptedException - if error occurs

TimeoutException - if error occurs

hasRSSI

public boolean hasRSSI()

Check if RSSI is supported.

Returns:

true if supported

readRSSI

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

Read RSSI level.

Returns:

RSSI level

Throws:

ButtplugException - if error occurs

ExecutionException - if error occurs

InterruptedException - if error occurs

TimeoutException - if error occurs

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hasInput

public boolean hasInput(ButtplugInput inputType)

Check if input is supported.

Parameters:

inputType - input type

Returns:

true if supported