io.github.robolib.module.hid

Class Joystick

java.lang.Object

io.github.robolib.module.hid.GenericHID

io.github.robolib.module.hid.Joystick

All Implemented Interfaces:

HIDModule, Module

Direct Known Subclasses:

XBoxController

public class Joystick
extends GenericHID

The RoboLibJ main Joystick.

Author:

noriah

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Joystick.JoystickAxis The Class JoystickAxis.
protected class	Joystick.JoystickButton The Class JoystickButton.
static class	Joystick.JSID The Enum JSID.
static class	Joystick.RumbleSide Rumble control enum

Field Summary

Fields

Modifier and Type	Field and Description
static int	kNumJoysticks The Constant kNumJoysticks.
private static short[][]	m_joystickAxes The m_joystick axes.
private static int[]	m_joystickButtons The m_joystick buttons.
private static byte[]	m_joystickButtonsCount The m_joystick buttons count.
private static short[][]	m_joystickPOVs The m_joystick po vs.
private short	m_leftRumble
private static double	m_nextComplainTime
private int	m_outputs The m_outputs.
private Joystick.JSID	m_port The m_port.
private byte	m_portByte The m_portByte.
private short	m_rightRumble

Fields inherited from class io.github.robolib.module.hid.GenericHID

m_axes, m_btns, m_numAxes, m_numBtns

Constructor Summary

Constructors

Constructor and Description
Joystick(Joystick.JSID port, int numAxes, int numBtns) Instantiates a new joystick.

Method Summary

Modifier and Type	Method and Description
protected static void	checkStick(int stick) Check stick.
protected static void	complainJoystickMissing(java.lang.String msg)
void	disableModule() Disable the module
void	enableModule() Enable the module
boolean	getModuleEnabled()
int	getPOV(int pov)
Joystick	getStick(Joystick.JSID port, int numAxes, int numBtns)
protected static double	getStickAxis(Joystick.JSID stick, int axis) Gets the stick axis.
protected static boolean	getStickButton(Joystick.JSID stick, int button) Gets the stick button.
Joystick.JSID	getStickPort() Get the Port JSID that this Joystick is on
protected static int	getStickPOV(Joystick.JSID stick, int pov) Gets the stick pov.
static void	setJoystickData(int stick, short[] axes, short[] povs, int buttons, byte numBtns) Sets the joystick data.
void	setOutput(int outputNumber, boolean value)
void	setOutputs(int value)
void	setRumble(Joystick.RumbleSide type, float value) Set the rumble output for the joystick.

Methods inherited from class io.github.robolib.module.hid.GenericHID

addAxisButton, addButton, checkAxis, checkButton, getAxis, getButton, getRawAxis, getRawButton, setAxis, setAxisDeadband, setAxisInverted, setButton

Methods inherited from class java.lang.Object

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

Field Detail

kNumJoysticks

public static final int kNumJoysticks

The Constant kNumJoysticks.

See Also:

Constant Field Values

m_joystickAxes

private static short[][] m_joystickAxes

The m_joystick axes.

m_joystickPOVs

private static short[][] m_joystickPOVs

The m_joystick po vs.

m_joystickButtons

private static int[] m_joystickButtons

The m_joystick buttons.

m_joystickButtonsCount

private static byte[] m_joystickButtonsCount

The m_joystick buttons count.

m_nextComplainTime

private static double m_nextComplainTime

m_port

private final Joystick.JSID m_port

The m_port.

m_portByte

private final byte m_portByte

The m_portByte.

m_outputs

private int m_outputs

The m_outputs.

m_leftRumble

private short m_leftRumble

m_rightRumble

private short m_rightRumble

Constructor Detail

Joystick

public Joystick(Joystick.JSID port,
                int numAxes,
                int numBtns)

Instantiates a new joystick.

Parameters:

port - the port

numAxes - the num axes

numBtns - the num btns

Method Detail

setJoystickData

public static final void setJoystickData(int stick,
                                         short[] axes,
                                         short[] povs,
                                         int buttons,
                                         byte numBtns)

Sets the joystick data. THIS SHOULD ONLY BE CALLED BY THE DRIVESTATION CLASS!!! TEAMS SHOULD NOT BE CALLING THIS!!!

Parameters:

stick - the stick

axes - the axes

povs - the povs

buttons - the buttons

numBtns - the num btns

complainJoystickMissing

protected static final void complainJoystickMissing(java.lang.String msg)

getStickAxis

protected static final double getStickAxis(Joystick.JSID stick,
                                           int axis)

Gets the stick axis.

Parameters:

stick - the stick

axis - the axis

Returns:

the stick axis

getStickButton

protected static final boolean getStickButton(Joystick.JSID stick,
                                              int button)

Gets the stick button.

Parameters:

stick - the stick

button - the button

Returns:

the stick button

getStickPOV

protected static final int getStickPOV(Joystick.JSID stick,
                                       int pov)

Gets the stick pov.

Parameters:

stick - the stick

pov - the pov

Returns:

the stick pov

checkStick

protected static void checkStick(int stick)

Check stick.

Parameters:

stick - the stick

getStick

public Joystick getStick(Joystick.JSID port,
                         int numAxes,
                         int numBtns)

getPOV

public final int getPOV(int pov)

Overrides:

getPOV in class GenericHID

Returns:

the pov value

getStickPort

public final Joystick.JSID getStickPort()

Get the Port JSID that this Joystick is on

Returns:

the stick this joystick is on

setRumble

public final void setRumble(Joystick.RumbleSide type,
                            float value)

Set the rumble output for the joystick. 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

setOutput

public final void setOutput(int outputNumber,
                            boolean value)

setOutputs

public final void setOutputs(int value)

enableModule

public void enableModule()

Enable the module

disableModule

public void disableModule()

Disable the module

getModuleEnabled

public boolean getModuleEnabled()