Package ftclib.driverio

Class FtcGamepadRumble

java.lang.Object

trclib.driverio.TrcPriorityIndicator<FtcGamepadRumble.Pattern>

ftclib.driverio.FtcGamepadRumble

public class FtcGamepadRumble
extends TrcPriorityIndicator<FtcGamepadRumble.Pattern>

This class implements a platform dependent priority indicator device using gamepad rumble. It provides platform dependent methods that gets/sets the rumble pattern from/to the device.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FtcGamepadRumble.Pattern	This class contains information about a rumble pattern.

Field Summary

Fields

Modifier and Type	Field	Description
private FtcGamepadRumble.Pattern	currPattern
private final com.qualcomm.robotcore.hardware.Gamepad	gamepad

Fields inherited from class trclib.driverio.TrcPriorityIndicator

instanceName, tracer

Constructor Summary

Constructors

Constructor	Description
FtcGamepadRumble(String instanceName, com.qualcomm.robotcore.hardware.Gamepad gamepad)	Constructor: Create an instance of the object.

Method Summary

Modifier and Type	Method	Description
FtcGamepadRumble.Pattern	getPattern()	This method gets the current set LED pattern.
void	setBlips(int count)	This method rumble the gamepad for a certain number of "blips" using predetermined blip timing.
void	setPattern(FtcGamepadRumble.Pattern pattern)	This method sets the LED pattern to the physical Gobilda Light Indicator device.
void	setRumble(double leftRumble, double rightRumble, double duration)	This method rumble the gamepad at a fixed rumble power for a certain duration.

Methods inherited from class trclib.driverio.TrcPriorityIndicator

getPatternPriority, getPatternState, getPatternState, printPatternPriorityTable, reset, resetAllPatternStates, setPatternPriorities, setPatternState, setPatternState, setPatternState, setPatternState, setPatternState, setPatternState, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

gamepad

private final com.qualcomm.robotcore.hardware.Gamepad gamepad

currPattern

private FtcGamepadRumble.Pattern currPattern

Constructor Details

FtcGamepadRumble

public FtcGamepadRumble(String instanceName,
 com.qualcomm.robotcore.hardware.Gamepad gamepad)

Constructor: Create an instance of the object.

Parameters:

instanceName - specifies the instance name.

gamepad - specifies the gamepad for the rumble effect.

Method Details

setRumble

public void setRumble(double leftRumble,
 double rightRumble,
 double duration)

This method rumble the gamepad at a fixed rumble power for a certain duration. Calling this will displace any currently running rumble effect.

Parameters:

leftRumble - specifies rumble power for left rumble motor (0.0 - 1.0).

rightRumble - specifies rumble power for right rumble motor (0.0 - 1.0).

duration - specifies duration to rumble for in seconds, or -1 for continuous.

setBlips

public void setBlips(int count)

This method rumble the gamepad for a certain number of "blips" using predetermined blip timing. This will displace any currently running rumble effect.

Parameters:

count - specifies the number of rumble blips to perform.

getPattern

public FtcGamepadRumble.Pattern getPattern()

This method gets the current set LED pattern.

Specified by:

getPattern in class TrcPriorityIndicator<FtcGamepadRumble.Pattern>

Returns:

currently set LED pattern.

setPattern

public void setPattern(FtcGamepadRumble.Pattern pattern)

This method sets the LED pattern to the physical Gobilda Light Indicator device.

Specified by:

setPattern in class TrcPriorityIndicator<FtcGamepadRumble.Pattern>

Parameters:

pattern - specifies the color pattern.