wh1ter0se/PowerUp-2018

View on GitHub
wpilib18/java/current/javadoc/edu/wpi/first/wpilibj/package-summary.html

Summary

Maintainability
Test Coverage
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Sat Oct 28 05:22:56 EDT 2017 -->
<title>edu.wpi.first.wpilibj (Documentation - Release API)</title>
<meta name="date" content="2017-10-28">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="edu.wpi.first.wpilibj (Documentation - Release API)";
        }
    }
    catch(err) {
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../edu/wpi/first/networktables/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../edu/wpi/first/wpilibj/buttons/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?edu/wpi/first/wpilibj/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<a name="skip.navbar.top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;edu.wpi.first.wpilibj</h1>
<div class="docSummary">
<div class="block">The WPI Robotics library (WPILibJ) is a set of Java classes that interfaces to the hardware in the
FRC control system and your robot.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/CANSpeedController.html" title="interface in edu.wpi.first.wpilibj">CANSpeedController</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/CANSpeedController.ControlMode.html" title="interface in edu.wpi.first.wpilibj">CANSpeedController.ControlMode</a></td>
<td class="colLast">
<div class="block">Mode determines how the motor is controlled, used internally.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/CounterBase.html" title="interface in edu.wpi.first.wpilibj">CounterBase</a></td>
<td class="colLast">
<div class="block">Interface for counting the number of ticks on a digital input channel.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/HLUsageReporting.Interface.html" title="interface in edu.wpi.first.wpilibj">HLUsageReporting.Interface</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/MotorSafety.html" title="interface in edu.wpi.first.wpilibj">MotorSafety</a></td>
<td class="colLast">
<div class="block">Shuts off motors when their outputs aren't updated often enough.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/NamedSendable.html" title="interface in edu.wpi.first.wpilibj">NamedSendable</a></td>
<td class="colLast">
<div class="block">The interface for sendable objects that gives the sendable a default name in the Smart
 Dashboard.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/PIDController.Tolerance.html" title="interface in edu.wpi.first.wpilibj">PIDController.Tolerance</a></td>
<td class="colLast">
<div class="block">Tolerance is the type of tolerance used to specify if the PID controller is on target.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/PIDInterface.html" title="interface in edu.wpi.first.wpilibj">PIDInterface</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/PIDOutput.html" title="interface in edu.wpi.first.wpilibj">PIDOutput</a></td>
<td class="colLast">
<div class="block">This interface allows PIDController to write it's results to its output.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/PIDSource.html" title="interface in edu.wpi.first.wpilibj">PIDSource</a></td>
<td class="colLast">
<div class="block">This interface allows for PIDController to automatically read from this object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Sendable.html" title="interface in edu.wpi.first.wpilibj">Sendable</a></td>
<td class="colLast">
<div class="block">The base interface for objects that can be sent over the network through network tables.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/SpeedController.html" title="interface in edu.wpi.first.wpilibj">SpeedController</a></td>
<td class="colLast">
<div class="block">Interface for speed controlling devices.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Timer.Interface.html" title="interface in edu.wpi.first.wpilibj">Timer.Interface</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Timer.StaticInterface.html" title="interface in edu.wpi.first.wpilibj">Timer.StaticInterface</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/AccumulatorResult.html" title="class in edu.wpi.first.wpilibj">AccumulatorResult</a></td>
<td class="colLast">
<div class="block">Structure for holding the values stored in an accumulator.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/ADXL345_I2C.html" title="class in edu.wpi.first.wpilibj">ADXL345_I2C</a></td>
<td class="colLast">
<div class="block">ADXL345 I2C Accelerometer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/ADXL345_I2C.AllAxes.html" title="class in edu.wpi.first.wpilibj">ADXL345_I2C.AllAxes</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/ADXL345_SPI.html" title="class in edu.wpi.first.wpilibj">ADXL345_SPI</a></td>
<td class="colLast">
<div class="block">ADXL345 SPI Accelerometer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/ADXL345_SPI.AllAxes.html" title="class in edu.wpi.first.wpilibj">ADXL345_SPI.AllAxes</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/ADXL362.html" title="class in edu.wpi.first.wpilibj">ADXL362</a></td>
<td class="colLast">
<div class="block">ADXL362 SPI Accelerometer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/ADXL362.AllAxes.html" title="class in edu.wpi.first.wpilibj">ADXL362.AllAxes</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/ADXRS450_Gyro.html" title="class in edu.wpi.first.wpilibj">ADXRS450_Gyro</a></td>
<td class="colLast">
<div class="block">Use a rate gyro to return the robots heading relative to a starting position.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/AnalogAccelerometer.html" title="class in edu.wpi.first.wpilibj">AnalogAccelerometer</a></td>
<td class="colLast">
<div class="block">Handle operation of an analog accelerometer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/AnalogGyro.html" title="class in edu.wpi.first.wpilibj">AnalogGyro</a></td>
<td class="colLast">
<div class="block">Use a rate gyro to return the robots heading relative to a starting position.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/AnalogInput.html" title="class in edu.wpi.first.wpilibj">AnalogInput</a></td>
<td class="colLast">
<div class="block">Analog channel class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/AnalogOutput.html" title="class in edu.wpi.first.wpilibj">AnalogOutput</a></td>
<td class="colLast">
<div class="block">Analog output class.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/AnalogPotentiometer.html" title="class in edu.wpi.first.wpilibj">AnalogPotentiometer</a></td>
<td class="colLast">
<div class="block">Class for reading analog potentiometers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/AnalogTrigger.html" title="class in edu.wpi.first.wpilibj">AnalogTrigger</a></td>
<td class="colLast">
<div class="block">Class for creating and configuring Analog Triggers.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/AnalogTriggerOutput.html" title="class in edu.wpi.first.wpilibj">AnalogTriggerOutput</a></td>
<td class="colLast">
<div class="block">Class to represent a specific output from an analog trigger.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/BuiltInAccelerometer.html" title="class in edu.wpi.first.wpilibj">BuiltInAccelerometer</a></td>
<td class="colLast">
<div class="block">Built-in accelerometer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/CameraServer.html" title="class in edu.wpi.first.wpilibj">CameraServer</a></td>
<td class="colLast">
<div class="block">Singleton class for creating and keeping camera servers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/CircularBuffer.html" title="class in edu.wpi.first.wpilibj">CircularBuffer</a></td>
<td class="colLast">
<div class="block">This is a simple circular buffer so we don't need to "bucket brigade" copy old values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Compressor.html" title="class in edu.wpi.first.wpilibj">Compressor</a></td>
<td class="colLast">
<div class="block">Class for operating a compressor connected to a PCM (Pneumatic Control Module).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/ControllerPower.html" title="class in edu.wpi.first.wpilibj">ControllerPower</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Counter.html" title="class in edu.wpi.first.wpilibj">Counter</a></td>
<td class="colLast">
<div class="block">Class for counting the number of ticks on a digital input channel.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/DigitalGlitchFilter.html" title="class in edu.wpi.first.wpilibj">DigitalGlitchFilter</a></td>
<td class="colLast">
<div class="block">Class to enable glitch filtering on a set of digital inputs.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/DigitalInput.html" title="class in edu.wpi.first.wpilibj">DigitalInput</a></td>
<td class="colLast">
<div class="block">Class to read a digital input.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/DigitalOutput.html" title="class in edu.wpi.first.wpilibj">DigitalOutput</a></td>
<td class="colLast">
<div class="block">Class to write digital outputs.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/DigitalSource.html" title="class in edu.wpi.first.wpilibj">DigitalSource</a></td>
<td class="colLast">
<div class="block">DigitalSource Interface.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/DoubleSolenoid.html" title="class in edu.wpi.first.wpilibj">DoubleSolenoid</a></td>
<td class="colLast">
<div class="block">DoubleSolenoid class for running 2 channels of high voltage Digital Output on the PCM.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/DriverStation.html" title="class in edu.wpi.first.wpilibj">DriverStation</a></td>
<td class="colLast">
<div class="block">Provide access to the network communication data to / from the Driver Station.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Encoder.html" title="class in edu.wpi.first.wpilibj">Encoder</a></td>
<td class="colLast">
<div class="block">Class to read quadrature encoders.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/GamepadBase.html" title="class in edu.wpi.first.wpilibj">GamepadBase</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">Inherit directly from GenericHID instead.</span></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/GearTooth.html" title="class in edu.wpi.first.wpilibj">GearTooth</a></td>
<td class="colLast">
<div class="block">Alias for counter class.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/GenericHID.html" title="class in edu.wpi.first.wpilibj">GenericHID</a></td>
<td class="colLast">
<div class="block">GenericHID Interface.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/GyroBase.html" title="class in edu.wpi.first.wpilibj">GyroBase</a></td>
<td class="colLast">
<div class="block">GyroBase is the common base class for Gyro implementations such as AnalogGyro.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/HLUsageReporting.html" title="class in edu.wpi.first.wpilibj">HLUsageReporting</a></td>
<td class="colLast">
<div class="block">Support for high level usage reporting.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/HLUsageReporting.Null.html" title="class in edu.wpi.first.wpilibj">HLUsageReporting.Null</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/I2C.html" title="class in edu.wpi.first.wpilibj">I2C</a></td>
<td class="colLast">
<div class="block">I2C bus interface class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/InterruptableSensorBase.html" title="class in edu.wpi.first.wpilibj">InterruptableSensorBase</a></td>
<td class="colLast">
<div class="block">Base for sensors to be used with interrupts.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/InterruptHandlerFunction.html" title="class in edu.wpi.first.wpilibj">InterruptHandlerFunction</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">It is recommended that you use this class in conjunction with classes from <code>java.util.concurrent.atomic</code> as these objects are all thread safe.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/IterativeRobot.html" title="class in edu.wpi.first.wpilibj">IterativeRobot</a></td>
<td class="colLast">
<div class="block">IterativeRobot implements the IterativeRobotBase robot program framework.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/IterativeRobotBase.html" title="class in edu.wpi.first.wpilibj">IterativeRobotBase</a></td>
<td class="colLast">
<div class="block">IterativeRobotBase implements a specific type of robot program framework, extending the RobotBase
 class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Jaguar.html" title="class in edu.wpi.first.wpilibj">Jaguar</a></td>
<td class="colLast">
<div class="block">Texas Instruments / Vex Robotics Jaguar Speed Controller as a PWM device.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Joystick.html" title="class in edu.wpi.first.wpilibj">Joystick</a></td>
<td class="colLast">
<div class="block">Handle input from standard Joysticks connected to the Driver Station.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/JoystickBase.html" title="class in edu.wpi.first.wpilibj">JoystickBase</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">Inherit directly from GenericHID instead.</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/MotorSafetyHelper.html" title="class in edu.wpi.first.wpilibj">MotorSafetyHelper</a></td>
<td class="colLast">
<div class="block">The MotorSafetyHelper object is constructed for every object that wants to implement the Motor
 Safety protocol.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Notifier.html" title="class in edu.wpi.first.wpilibj">Notifier</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/PIDController.html" title="class in edu.wpi.first.wpilibj">PIDController</a></td>
<td class="colLast">
<div class="block">Class implements a PID Control Loop.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/PowerDistributionPanel.html" title="class in edu.wpi.first.wpilibj">PowerDistributionPanel</a></td>
<td class="colLast">
<div class="block">Class for getting voltage, current, temperature, power and energy from the Power Distribution
 Panel over CAN.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Preferences.html" title="class in edu.wpi.first.wpilibj">Preferences</a></td>
<td class="colLast">
<div class="block">The preferences class provides a relatively simple way to save important values to the roboRIO to
 access the next time the roboRIO is booted.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/PWM.html" title="class in edu.wpi.first.wpilibj">PWM</a></td>
<td class="colLast">
<div class="block">Class implements the PWM generation in the FPGA.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/PWMConfigDataResult.html" title="class in edu.wpi.first.wpilibj">PWMConfigDataResult</a></td>
<td class="colLast">
<div class="block">Structure for holding the config data result for PWM.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/PWMSpeedController.html" title="class in edu.wpi.first.wpilibj">PWMSpeedController</a></td>
<td class="colLast">
<div class="block">Common base class for all PWM Speed Controllers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/PWMTalonSRX.html" title="class in edu.wpi.first.wpilibj">PWMTalonSRX</a></td>
<td class="colLast">
<div class="block">Cross the Road Electronics (CTRE) Talon SRX Speed Controller with PWM control.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Relay.html" title="class in edu.wpi.first.wpilibj">Relay</a></td>
<td class="colLast">
<div class="block">Class for VEX Robotics Spike style relay outputs.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Resource.html" title="class in edu.wpi.first.wpilibj">Resource</a></td>
<td class="colLast">
<div class="block">Track resources in the program.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/RobotBase.html" title="class in edu.wpi.first.wpilibj">RobotBase</a></td>
<td class="colLast">
<div class="block">Implement a Robot Program framework.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/RobotDrive.html" title="class in edu.wpi.first.wpilibj">RobotDrive</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">Use DifferentialDrive or MecanumDrive classes instead.</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/RobotState.html" title="class in edu.wpi.first.wpilibj">RobotState</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/SafePWM.html" title="class in edu.wpi.first.wpilibj">SafePWM</a></td>
<td class="colLast">
<div class="block">Manages a PWM object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/SampleRobot.html" title="class in edu.wpi.first.wpilibj">SampleRobot</a></td>
<td class="colLast">
<div class="block">A simple robot base class that knows the standard FRC competition states (disabled, autonomous,
 or operator controlled).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/SD540.html" title="class in edu.wpi.first.wpilibj">SD540</a></td>
<td class="colLast">
<div class="block">Mindsensors SD540 Speed Controller.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/SensorBase.html" title="class in edu.wpi.first.wpilibj">SensorBase</a></td>
<td class="colLast">
<div class="block">Base class for all sensors.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/SerialPort.html" title="class in edu.wpi.first.wpilibj">SerialPort</a></td>
<td class="colLast">
<div class="block">Driver for the RS-232 serial port on the roboRIO.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Servo.html" title="class in edu.wpi.first.wpilibj">Servo</a></td>
<td class="colLast">
<div class="block">Standard hobby style servo.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Solenoid.html" title="class in edu.wpi.first.wpilibj">Solenoid</a></td>
<td class="colLast">
<div class="block">Solenoid class for running high voltage Digital Output on the PCM.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/SolenoidBase.html" title="class in edu.wpi.first.wpilibj">SolenoidBase</a></td>
<td class="colLast">
<div class="block">SolenoidBase class is the common base class for the <a href="../../../../edu/wpi/first/wpilibj/Solenoid.html" title="class in edu.wpi.first.wpilibj"><code>Solenoid</code></a> and <a href="../../../../edu/wpi/first/wpilibj/DoubleSolenoid.html" title="class in edu.wpi.first.wpilibj"><code>DoubleSolenoid</code></a>
 classes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Spark.html" title="class in edu.wpi.first.wpilibj">Spark</a></td>
<td class="colLast">
<div class="block">REV Robotics SPARK Speed Controller.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/SpeedControllerGroup.html" title="class in edu.wpi.first.wpilibj">SpeedControllerGroup</a></td>
<td class="colLast">
<div class="block">Allows multiple <a href="../../../../edu/wpi/first/wpilibj/SpeedController.html" title="interface in edu.wpi.first.wpilibj"><code>SpeedController</code></a> objects to be linked together.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/SPI.html" title="class in edu.wpi.first.wpilibj">SPI</a></td>
<td class="colLast">
<div class="block">Represents a SPI bus port.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Talon.html" title="class in edu.wpi.first.wpilibj">Talon</a></td>
<td class="colLast">
<div class="block">Cross the Road Electronics (CTRE) Talon and Talon SR Speed Controller.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Threads.html" title="class in edu.wpi.first.wpilibj">Threads</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/TimedRobot.html" title="class in edu.wpi.first.wpilibj">TimedRobot</a></td>
<td class="colLast">
<div class="block">TimedRobot implements the IterativeRobotBase robot program framework.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Timer.html" title="class in edu.wpi.first.wpilibj">Timer</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Ultrasonic.html" title="class in edu.wpi.first.wpilibj">Ultrasonic</a></td>
<td class="colLast">
<div class="block">Ultrasonic rangefinder class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Utility.html" title="class in edu.wpi.first.wpilibj">Utility</a></td>
<td class="colLast">
<div class="block">Contains global utility functions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Victor.html" title="class in edu.wpi.first.wpilibj">Victor</a></td>
<td class="colLast">
<div class="block">VEX Robotics Victor 888 Speed Controller The Vex Robotics Victor 884 Speed Controller can also
 be used with this class but may need to be calibrated per the Victor 884 user manual.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/VictorSP.html" title="class in edu.wpi.first.wpilibj">VictorSP</a></td>
<td class="colLast">
<div class="block">VEX Robotics Victor SP Speed Controller.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/XboxController.html" title="class in edu.wpi.first.wpilibj">XboxController</a></td>
<td class="colLast">
<div class="block">Handle input from Xbox 360 or Xbox One controllers connected to the Driver Station.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/ADXL345_I2C.Axes.html" title="enum in edu.wpi.first.wpilibj">ADXL345_I2C.Axes</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/ADXL345_SPI.Axes.html" title="enum in edu.wpi.first.wpilibj">ADXL345_SPI.Axes</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/ADXL362.Axes.html" title="enum in edu.wpi.first.wpilibj">ADXL362.Axes</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/AnalogTriggerOutput.AnalogTriggerType.html" title="enum in edu.wpi.first.wpilibj">AnalogTriggerOutput.AnalogTriggerType</a></td>
<td class="colLast">
<div class="block">Defines the state in which the AnalogTrigger triggers.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Counter.Mode.html" title="enum in edu.wpi.first.wpilibj">Counter.Mode</a></td>
<td class="colLast">
<div class="block">Mode determines how and what the counter counts.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/CounterBase.EncodingType.html" title="enum in edu.wpi.first.wpilibj">CounterBase.EncodingType</a></td>
<td class="colLast">
<div class="block">The number of edges for the counterbase to increment or decrement on.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/DoubleSolenoid.Value.html" title="enum in edu.wpi.first.wpilibj">DoubleSolenoid.Value</a></td>
<td class="colLast">
<div class="block">Possible values for a DoubleSolenoid.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/DriverStation.Alliance.html" title="enum in edu.wpi.first.wpilibj">DriverStation.Alliance</a></td>
<td class="colLast">
<div class="block">The robot alliance that the robot is a part of.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Encoder.IndexingType.html" title="enum in edu.wpi.first.wpilibj">Encoder.IndexingType</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/GenericHID.Hand.html" title="enum in edu.wpi.first.wpilibj">GenericHID.Hand</a></td>
<td class="colLast">
<div class="block">Which hand the Human Interface Device is associated with.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/GenericHID.HIDType.html" title="enum in edu.wpi.first.wpilibj">GenericHID.HIDType</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/GenericHID.RumbleType.html" title="enum in edu.wpi.first.wpilibj">GenericHID.RumbleType</a></td>
<td class="colLast">
<div class="block">Represents a rumble output on the JoyStick.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/I2C.Port.html" title="enum in edu.wpi.first.wpilibj">I2C.Port</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/InterruptableSensorBase.WaitResult.html" title="enum in edu.wpi.first.wpilibj">InterruptableSensorBase.WaitResult</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Joystick.AxisType.html" title="enum in edu.wpi.first.wpilibj">Joystick.AxisType</a></td>
<td class="colLast">
<div class="block">Represents an analog axis on a joystick.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Joystick.ButtonType.html" title="enum in edu.wpi.first.wpilibj">Joystick.ButtonType</a></td>
<td class="colLast">
<div class="block">Represents a digital button on a joystick.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/PIDSourceType.html" title="enum in edu.wpi.first.wpilibj">PIDSourceType</a></td>
<td class="colLast">
<div class="block">A description for the type of output value to provide to a PIDController.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/PWM.PeriodMultiplier.html" title="enum in edu.wpi.first.wpilibj">PWM.PeriodMultiplier</a></td>
<td class="colLast">
<div class="block">Represents the amount to multiply the minimum servo-pulse pwm period by.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Relay.Direction.html" title="enum in edu.wpi.first.wpilibj">Relay.Direction</a></td>
<td class="colLast">
<div class="block">The Direction(s) that a relay is configured to operate in.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Relay.Value.html" title="enum in edu.wpi.first.wpilibj">Relay.Value</a></td>
<td class="colLast">
<div class="block">The state to drive a Relay to.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/RobotDrive.MotorType.html" title="enum in edu.wpi.first.wpilibj">RobotDrive.MotorType</a></td>
<td class="colLast">
<div class="block">The location of a motor on the robot for the purpose of driving.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/SerialPort.FlowControl.html" title="enum in edu.wpi.first.wpilibj">SerialPort.FlowControl</a></td>
<td class="colLast">
<div class="block">Represents what type of flow control to use for serial communication.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/SerialPort.Parity.html" title="enum in edu.wpi.first.wpilibj">SerialPort.Parity</a></td>
<td class="colLast">
<div class="block">Represents the parity to use for serial communications.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/SerialPort.Port.html" title="enum in edu.wpi.first.wpilibj">SerialPort.Port</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/SerialPort.StopBits.html" title="enum in edu.wpi.first.wpilibj">SerialPort.StopBits</a></td>
<td class="colLast">
<div class="block">Represents the number of stop bits to use for Serial Communication.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/SerialPort.WriteBufferMode.html" title="enum in edu.wpi.first.wpilibj">SerialPort.WriteBufferMode</a></td>
<td class="colLast">
<div class="block">Represents which type of buffer mode to use when writing to a serial m_port.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/SPI.Port.html" title="enum in edu.wpi.first.wpilibj">SPI.Port</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../edu/wpi/first/wpilibj/Ultrasonic.Unit.html" title="enum in edu.wpi.first.wpilibj">Ultrasonic.Unit</a></td>
<td class="colLast">
<div class="block">The units to return when PIDGet is called.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
</table>
</li>
</ul>
<a name="package.description">
<!--   -->
</a>
<h2 title="Package edu.wpi.first.wpilibj Description">Package edu.wpi.first.wpilibj Description</h2>
<div class="block">The WPI Robotics library (WPILibJ) is a set of Java classes that interfaces to the hardware in the
FRC control system and your robot. There are classes to handle sensors, motors, the driver
station, and a number of other utility functions like timing and field management.
The library is designed to:
<ul>
    <li>Deal with all the low level interfacing to these components so you can concentrate on
        solving this year's "robot problem". This is a philosophical decision to let you focus
        on the higher-level design of your robot rather than deal with the details of the
        processor and the operating system.
    </li>
    <li>Understand everything at all levels by making the full source code of the library
        available. You can study (and modify) the algorithms used by the gyro class for
        oversampling and integration of the input signal or just ask the class for the current
        robot heading. You can work at any level.
    </li>
</ul></div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../edu/wpi/first/networktables/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../edu/wpi/first/wpilibj/buttons/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?edu/wpi/first/wpilibj/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<a name="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>