added some class comments

This commit is contained in:
HFocus
2019-07-07 11:14:24 -06:00
parent 6fa5c986a6
commit 6cbf6a9b5d
7 changed files with 22 additions and 16 deletions
@@ -1,12 +1,10 @@
package org.usfirst.frc4388.robot;
/**
* A list of constants used by the rest of the robot code. This include physics
* constants as well as constants determined through calibrations.
* constants as well as constants determined through calibrations. Most late stage ajustments
* ideally should be made here.
*/
public class Constants {
public static double kLooperDt = 0.01;
public static double kDriveWheelDiameterInches = 6.04;
@@ -1,6 +1,3 @@
package org.usfirst.frc4388.robot;
import buttons.XBoxTriggerButton;
@@ -28,7 +25,10 @@ import edu.wpi.first.wpilibj.smartdashboard.SmartDashboard;
import jaci.pathfinder.Pathfinder;
/**
* Maps controler buttons to specific commands. Any controller will work but we
* use Xbox One controllers for our naming scheme.
*/
public class OI
{
private static OI instance;
@@ -1,4 +1,3 @@
package org.usfirst.frc4388.robot;
import edu.wpi.first.wpilibj.IterativeRobot;
@@ -24,6 +23,10 @@ import org.usfirst.frc4388.robot.subsystems.Drive;
import org.usfirst.frc4388.robot.subsystems.Drive.DriveControlMode;;
/**
* Initialises all the subsystems and directs which processes to
* run during autonomous and periodic modes
*/
public class Robot extends TimedRobot
{
@@ -1,7 +1,8 @@
package org.usfirst.frc4388.robot;
/**
* Defines each input/output id on the robot.
*/
public class RobotMap {
// USB Port IDs
public static final int DRIVER_JOYSTICK_1_USB_ID = 0;
@@ -1,4 +1,5 @@
package org.usfirst.frc4388.robot.subsystems;
import java.util.ArrayList;
import org.usfirst.frc4388.robot.Constants;
@@ -37,6 +38,10 @@ import edu.wpi.first.wpilibj.command.Subsystem;
import edu.wpi.first.wpilibj.smartdashboard.SmartDashboard;
import edu.wpi.first.wpilibj.Timer;
/**
* Controls a single joint arm. Uses a joystick to change a MM or PID target position for the arm,
* and uses the d-pad on the opperator controller to move the arm and wrist to preset positions.
*/
public class Arm extends Subsystem implements ControlLoopable
{
private static Arm instance;
@@ -12,10 +12,8 @@ import com.ctre.phoenix.motorcontrol.can.WPI_TalonSRX;
import com.ctre.phoenix.motorcontrol.ControlMode;
import com.ctre.phoenix.motorcontrol.FeedbackDevice;
/**
*
* Configuires the commands for a wheel based ball intake.
*/
public class BallIntake extends Subsystem {
@@ -32,9 +32,10 @@ import com.ctre.phoenix.motorcontrol.NeutralMode;
import com.ctre.phoenix.motorcontrol.SensorCollection;
import com.ctre.phoenix.motorcontrol.can.WPI_TalonSRX;
/**
*
* Controls an extending leg based climber. Buttons control the flipping of the
* rachets and the safety switch that keeps the legs from moving unexpectedly.
* The right trigger controls the speed of the climb.
*/
public class Climber extends Subsystem{