edu.wpi.first.wpilibj

Class XboxController

java.lang.Object

edu.wpi.first.wpilibj.GenericHID

edu.wpi.first.wpilibj.GamepadBase

edu.wpi.first.wpilibj.XboxController

public class XboxController
extends GamepadBase

Handle input from Xbox 360 or Xbox One controllers connected to the Driver Station.

This class handles Xbox input that comes from the Driver Station. Each time a value is requested the most recent value is returend. There is a single class instance for each controller and the mapping of ports to hardware buttons depends on the code in the Driver Station.

Nested Class Summary

Nested classes/interfaces inherited from class edu.wpi.first.wpilibj.GenericHID

GenericHID.Hand, GenericHID.HIDType, GenericHID.RumbleType

Constructor Summary

Constructors

Constructor and Description
XboxController(int port) Construct an instance of a joystick.

Method Summary

Modifier and Type	Method and Description
boolean	getAButton() Read the value of the A button on the controller.
boolean	getBackButton() Read the value of the back button on the controller.
boolean	getBButton() Read the value of the B button on the controller.
boolean	getBumper(GenericHID.Hand hand) Read the value of the bumper button on the controller.
java.lang.String	getName() Get the name of the HID.
int	getPOV(int pov) Get the angle in degrees of a POV on the HID.
int	getPOVCount() For the current HID, return the number of POVs.
double	getRawAxis(int axis) Get the value of the axis.
boolean	getRawButton(int button) Get the button value (starting at button 1).
boolean	getStartButton() Read the value of the start button on the controller.
boolean	getStickButton(GenericHID.Hand hand) Read the value of the stick button on the controller.
boolean	getTop(GenericHID.Hand hand) This is not supported for the XboxController.
boolean	getTrigger(GenericHID.Hand hand) This is not supported for the XboxController.
double	getTriggerAxis(GenericHID.Hand hand) Get the trigger axis value of the controller.
GenericHID.HIDType	getType() Get the type of the HID.
double	getX(GenericHID.Hand hand) Get the X axis value of the controller.
boolean	getXButton() Read the value of the X button on the controller.
double	getY(GenericHID.Hand hand) Get the Y axis value of the controller.
boolean	getYButton() Read the value of the Y button on the controller.
void	setOutput(int outputNumber, boolean value) Set a single HID output value for the HID.
void	setOutputs(int value) Set all HID output values for the HID.
void	setRumble(GenericHID.RumbleType type, double value) Set the rumble output for the HID.

Methods inherited from class edu.wpi.first.wpilibj.GamepadBase

getBumper, getStickButton

Methods inherited from class edu.wpi.first.wpilibj.GenericHID

getPort, getPOV, getX, getY

Methods inherited from class java.lang.Object

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

Constructor Detail

XboxController

public XboxController(int port)

Construct an instance of a joystick. The joystick index is the USB port on the drivers station.

Parameters:

port - The port on the Driver Station that the joystick is plugged into.

Method Detail

getX

public double getX(GenericHID.Hand hand)

Get the X axis value of the controller.

Specified by:

getX in class GenericHID

Parameters:

hand - Side of controller whose value should be returned.

Returns:

The X axis value of the controller.

getY

public double getY(GenericHID.Hand hand)

Get the Y axis value of the controller.

Specified by:

getY in class GenericHID

Parameters:

hand - Side of controller whose value should be returned.

Returns:

The Y axis value of the controller.

getRawAxis

public double getRawAxis(int axis)

Get the value of the axis.

Specified by:

getRawAxis in class GamepadBase

Parameters:

axis - The axis to read, starting at 0.

Returns:

The value of the axis.

getBumper

public boolean getBumper(GenericHID.Hand hand)

Read the value of the bumper button on the controller.

Specified by:

getBumper in class GamepadBase

Parameters:

hand - Side of controller whose value should be returned.

Returns:

The state of the button.

getTrigger

public boolean getTrigger(GenericHID.Hand hand)

This is not supported for the XboxController. This method is only here to complete the GenericHID interface.

Parameters:

hand - This parameter is ignored for the Joystick class and is only here to complete the GenericHID interface.

Returns:

The state of the trigger (always false)

getTop

public boolean getTop(GenericHID.Hand hand)

This is not supported for the XboxController. This method is only here to complete the GenericHID interface.

Parameters:

hand - This parameter is ignored for the Joystick class and is only here to complete the GenericHID interface.

Returns:

The state of the top button (always false)

getRawButton

public boolean getRawButton(int button)

Get the button value (starting at button 1).

The appropriate button is returned as a boolean value.

Specified by:

getRawButton in class GamepadBase

Parameters:

button - The button number to be read (starting at 1).

Returns:

The state of the button.

getTriggerAxis

public double getTriggerAxis(GenericHID.Hand hand)

Get the trigger axis value of the controller.

Parameters:

hand - Side of controller whose value should be returned.

Returns:

The trigger axis value of the controller.

getAButton

public boolean getAButton()

Read the value of the A button on the controller.

Returns:

The state of the button.

getBButton

public boolean getBButton()

Read the value of the B button on the controller.

Returns:

The state of the button.

getXButton

public boolean getXButton()

Read the value of the X button on the controller.

Returns:

The state of the button.

getYButton

public boolean getYButton()

Read the value of the Y button on the controller.

Returns:

The state of the button.

getStickButton

public boolean getStickButton(GenericHID.Hand hand)

Read the value of the stick button on the controller.

Specified by:

getStickButton in class GamepadBase

Parameters:

hand - Side of controller whose value should be returned.

Returns:

The state of the button.

getBackButton

public boolean getBackButton()

Read the value of the back button on the controller.

Returns:

The state of the button.

getStartButton

public boolean getStartButton()

Read the value of the start button on the controller.

Returns:

The state of the button.

getPOV

public int getPOV(int pov)

Description copied from class: GenericHID

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).

Specified by:

getPOV in class GamepadBase

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.

getPOVCount

public int getPOVCount()

Description copied from class: GenericHID

For the current HID, return the number of POVs.

Specified by:

getPOVCount in class GamepadBase

getType

public GenericHID.HIDType getType()

Description copied from class: GenericHID

Get the type of the HID.

Specified by:

getType in class GamepadBase

Returns:

the type of the HID.

getName

public java.lang.String getName()

Description copied from class: GenericHID

Get the name of the HID.

Specified by:

getName in class GamepadBase

Returns:

the name of the HID.

setOutput

public void setOutput(int outputNumber,
                      boolean value)

Description copied from class: GenericHID

Set a single HID output value for the HID.

Specified by:

setOutput in class GamepadBase

Parameters:

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

value - The value to set the output to

setOutputs

public void setOutputs(int value)

Description copied from class: GenericHID

Set all HID output values for the HID.

Specified by:

setOutputs in class GamepadBase

Parameters:

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

setRumble

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

Description copied from class: GenericHID

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

Specified by:

setRumble in class GamepadBase

Parameters:

type - Which rumble value to set

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