edu.wpi.first.wpilibj

Class GenericHID

java.lang.Object

edu.wpi.first.wpilibj.GenericHID

Direct Known Subclasses:

GamepadBase, JoystickBase

public abstract class GenericHID
extends java.lang.Object

GenericHID Interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenericHID.Hand Which hand the Human Interface Device is associated with.
static class	GenericHID.HIDType
static class	GenericHID.RumbleType Represents a rumble output on the JoyStick.

Constructor Summary

Constructors

Constructor and Description
GenericHID(int port)

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getName() Get the name of the HID.
int	getPort() Get the port number of the HID.
int	getPOV()
abstract int	getPOV(int pov) Get the angle in degrees of a POV on the HID.
abstract int	getPOVCount() For the current HID, return the number of POVs.
abstract double	getRawAxis(int which) Get the raw axis.
abstract boolean	getRawButton(int button) Is the given button pressed.
abstract GenericHID.HIDType	getType() Get the type of the HID.
double	getX() Get the x position of the HID.
abstract double	getX(GenericHID.Hand hand) Get the x position of HID.
double	getY() Get the y position of the HID.
abstract double	getY(GenericHID.Hand hand) Get the y position of the HID.
abstract void	setOutput(int outputNumber, boolean value) Set a single HID output value for the HID.
abstract void	setOutputs(int value) Set all HID output values for the HID.
abstract void	setRumble(GenericHID.RumbleType type, double value) Set the rumble output for the HID.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericHID

public GenericHID(int port)

Method Detail

getX

public final double getX()

Get the x position of the HID.

Returns:

the x position of the HID

getX

public abstract double getX(GenericHID.Hand hand)

Get the x position of HID.

Parameters:

hand - which hand, left or right

Returns:

the x position

getY

public final double getY()

Get the y position of the HID.

Returns:

the y position

getY

public abstract double getY(GenericHID.Hand hand)

Get the y position of the HID.

Parameters:

hand - which hand, left or right

Returns:

the y position

getRawAxis

public abstract double getRawAxis(int which)

Get the raw axis.

Parameters:

which - index of the axis

Returns:

the raw value of the selected axis

getRawButton

public abstract boolean getRawButton(int button)

Is the given button pressed.

Parameters:

button - which button number

Returns:

true if the button is pressed

getPOV

public abstract int getPOV(int pov)

Get the angle in degrees of a POV on the HID.

The POV angles start at 0 in the up direction, and increase clockwise (eg right is 90, upper-left is 315).

Parameters:

pov - The index of the POV to read (starting at 0)

Returns:

the angle of the POV in degrees, or -1 if the POV is not pressed.

getPOV

public int getPOV()

getPOVCount

public abstract int getPOVCount()

For the current HID, return the number of POVs.

getPort

public int getPort()

Get the port number of the HID.

Returns:

The port number of the HID.

getType

public abstract GenericHID.HIDType getType()

Get the type of the HID.

Returns:

the type of the HID.

getName

public abstract java.lang.String getName()

Get the name of the HID.

Returns:

the name of the HID.

setOutput

public abstract void setOutput(int outputNumber,
                               boolean value)

Set a single HID output value for the HID.

Parameters:

outputNumber - The index of the output to set (1-32)

value - The value to set the output to

setOutputs

public abstract void setOutputs(int value)

Set all HID output values for the HID.

Parameters:

value - The 32 bit output value (1 bit for each output)

setRumble

public abstract void setRumble(GenericHID.RumbleType type,
                               double value)

Set the rumble output for the HID. The DS currently supports 2 rumble values, left rumble and right rumble.

Parameters:

type - Which rumble value to set

value - The normalized value (0 to 1) to set the rumble to