Merge branch 'master' of https://github.com/DeepBlueRobotics/RobotCode2018

Author: nelly-yy

Robot2018/src/org/usfirst/frc/team199/Robot2018/Robot.java

@@ -1,3 +1,9 @@
+/*----------------------------------------------------------------------------*/
+/* Copyright (c) 2017-2018 FIRST. All Rights Reserved.                        */
+/* Open Source Software - may be modified and shared by FRC teams. The code   */
+/* must be accompanied by the FIRST BSD license file in the root directory of */
+/* the project.                                                               */
+/*----------------------------------------------------------------------------*/
 
 package org.usfirst.frc.team199.Robot2018;
 
@@ -41,13 +47,13 @@ public class Robot extends TimedRobot {
 	public static Listener listen;
 
 	public static OI oi;
-	
+
 	public static Map<String, ArrayList<String[]>> autoScripts;
 
 	Command autonomousCommand;
 	SendableChooser<Position> posChooser = new SendableChooser<Position>();
 	Map<String, SendableChooser<Strategy>> stratChoosers = new HashMap<String, SendableChooser<Strategy>>();
-	String[] fmsPossibilities = {"LL", "LR", "RL", "RR"};
+	String[] fmsPossibilities = { "LL", "LR", "RL", "RR" };
 
 	public static double getConst(String key, double def) {
 		if (!SmartDashboard.containsKey("Const/" + key)) {
@@ -64,8 +70,8 @@ public static boolean getBool(String key, boolean def) {
 	}
 
 	/**
-	 * This function is run when the robot is first started up and should be used
-	 * for any initialization code.
+	 * This function is run when the robot is first started up and should be
+	 * used for any initialization code.
 	 */
 	@Override
 	public void robotInit() {
@@ -76,13 +82,13 @@ public void robotInit() {
 		lift = new Lift();
 		dt = new Drivetrain();
 		oi = new OI();
-		
+
 		// auto position chooser
 		for (Position p : Position.values()) {
 			posChooser.addObject(p.getSDName(), p);
 		}
 		SmartDashboard.putData("Starting Position", posChooser);
-		
+
 		// auto strategy choosers
 		for (String input : fmsPossibilities) {
 			SendableChooser<Strategy> chooser = new SendableChooser<Strategy>();
@@ -92,20 +98,21 @@ public void robotInit() {
 			SmartDashboard.putData(input, chooser);
 			stratChoosers.put(input, chooser);
 		}
-		
+
 		// auto delay chooser
 		SmartDashboard.putNumber("Auto Delay", 0);
-		
-		// parse scripts from Preferences, which maintains values throughout reboots
+
+		// parse scripts from Preferences, which maintains values throughout
+		// reboots
 		autoScripts = AutoUtils.parseScriptFile(Preferences.getInstance().getString("autoscripts", ""));
 
 		listen = new Listener();
 	}
 
 	/**
-	 * This function is called once each time the robot enters Disabled mode. You
-	 * can use it to reset any subsystem information you want to clear when the
-	 * robot is disabled.
+	 * This function is called once each time the robot enters Disabled mode.
+	 * You can use it to reset any subsystem information you want to clear when
+	 * the robot is disabled.
 	 */
 	@Override
 	public void disabledInit() {
@@ -118,7 +125,7 @@ public void disabledPeriodic() {
 	}
 
 	/**
-	 * This function is called once during the start of autonomous in order to 
+	 * This function is called once during the start of autonomous in order to
 	 * grab values from SmartDashboard and the FMS and call the Autonomous
 	 * command with those values.
 	 */
@@ -127,14 +134,14 @@ public void autonomousInit() {
 		String fmsInput = DriverStation.getInstance().getGameSpecificMessage();
 		Position startPos = posChooser.getSelected();
 		double autoDelay = SmartDashboard.getNumber("Auto Delay", 0);
-		
+
 		Map<String, Strategy> strategies = new HashMap<String, Strategy>();
 		for (Map.Entry<String, SendableChooser<Strategy>> entry : stratChoosers.entrySet()) {
-		    String key = entry.getKey();
-		    SendableChooser<Strategy> chooser = entry.getValue();
-		    strategies.put(key, chooser.getSelected());
+			String key = entry.getKey();
+			SendableChooser<Strategy> chooser = entry.getValue();
+			strategies.put(key, chooser.getSelected());
 		}
-		
+
 		Autonomous auto = new Autonomous(startPos, strategies, autoDelay, fmsInput, false);
 		auto.start();
 	}

Robot2018/src/org/usfirst/frc/team199/Robot2018/RobotMap.java

@@ -73,11 +73,20 @@ public class RobotMap {
 	 *            the TalonSRX to configure
 	 */
 	private void configSRX(WPI_TalonSRX mc) {
+		// stuff cole said to put
 		int kTimeout = (int) Robot.getConst("kTimeoutMs", 10);
 		mc.configNominalOutputForward(0, kTimeout);
 		mc.configNominalOutputReverse(0, kTimeout);
 		mc.configPeakOutputForward(1, kTimeout);
 		mc.configPeakOutputReverse(-1, kTimeout);
+
+		// current limiting stuff cole said to put
+		mc.configPeakCurrentLimit(0, 0);
+		mc.configPeakCurrentDuration(0, 0);
+		// 40 amps is the amp limit of a CIM. also, the PDP has 40 amp circuit breakers,
+		// so if we went above 40, the motors would stop completely.
+		mc.configContinuousCurrentLimit(40, 0);
+		mc.enableCurrentLimit(true);
 	}
 
 	/**
@@ -88,6 +97,7 @@ private void configSRX(WPI_TalonSRX mc) {
 	 *            the VictorSPX to configure
 	 */
 	private void configSPX(WPI_VictorSPX mc) {
+		// stuff cole said to put
 		int kTimeout = (int) Robot.getConst("kTimeoutMs", 10);
 		mc.configNominalOutputForward(0, kTimeout);
 		mc.configNominalOutputReverse(0, kTimeout);

Robot2018/src/org/usfirst/frc/team199/Robot2018/commands/PIDMove.java

@@ -9,26 +9,43 @@
 import edu.wpi.first.wpilibj.command.Command;
 
 /**
- *
+ * Drives the robot a certain target distance using PID. Implements PIDOutput in
+ * order to keep move PID centralized in this command.
  */
 public class PIDMove extends Command implements PIDOutput {
 
 	private double target;
 	private DrivetrainInterface dt;
 	private PIDController moveController;
 
+	/**
+	 * Constructs this command with a new PIDController. Sets all of the
+	 * controller's PID constants based on SD prefs. Sets the controller's PIDSource
+	 * to the encoder average object and sets its PIDOutput to this command which
+	 * implements PIDOutput's pidWrite() method.
+	 * 
+	 * @param targ
+	 *            the target distance (in inches) to move to
+	 * @param dt
+	 *            the Drivetrain (for actual code) or a DrivetrainInterface (for
+	 *            testing)
+	 * @param avg
+	 *            the PIDSourceAverage of the DT's two Encoders
+	 */
 	public PIDMove(double targ, DrivetrainInterface dt, PIDSourceAverage avg) {
 		// Use requires() here to declare subsystem dependencies
-		// eg. requires(chassis);
+		requires(Robot.dt);
 		target = targ;
 		this.dt = dt;
-		requires(Robot.dt);
 		double kf = 1 / (dt.getCurrentMaxSpeed() * Robot.getConst("Default PID Update Time", 0.05));
 		moveController = new PIDController(Robot.getConst("MovekP", 1), Robot.getConst("MovekI", 0),
 				Robot.getConst("MovekD", 0), kf, avg, this);
 	}
 
-	// Called just before this Command runs the first time
+	/**
+	 * Called just before this Command runs the first time. Resets the distance
+	 * encoders, sets the moveController's settings, and then enables it.
+	 */
 	@Override
 	public void initialize() {
 		dt.resetDistEncs();
@@ -42,33 +59,57 @@ public void initialize() {
 		moveController.enable();
 	}
 
-	// Called repeatedly when this Command is scheduled to run
+	/**
+	 * Called repeatedly when this Command is scheduled to run. This method is empty
+	 * bc the moveController runs on a different thread as soon as it is enabled in
+	 * initialize().
+	 */
 	@Override
 	protected void execute() {
-		// This method is empty bc the moveController runs on a different thread as soon
-		// as it is enabled.
 	}
 
-	// Make this return true when this Command no longer needs to run execute()
+	/**
+	 * Tells this command to terminate when the moveController has reached its
+	 * target.
+	 * 
+	 * @return true if the robot has moved the correct distance, false if not
+	 */
 	@Override
 	protected boolean isFinished() {
 		return moveController.onTarget();
 	}
 
-	// Called once after isFinished returns true
+	/**
+	 * Called once after isFinished returns true. Disables and frees the
+	 * moveController, essentially turning it "off" and "deleting" the thread it was
+	 * running on.
+	 */
 	@Override
 	protected void end() {
 		moveController.disable();
 		moveController.free();
 	}
 
-	// Called when another command which requires one or more of the same
-	// subsystems is scheduled to run
+	/**
+	 * Called when another command which requires one or more of the same subsystems
+	 * is scheduled to run. Disables and frees the moveController, essentially
+	 * turning it "off" and "deleting" the thread it was running on.
+	 */
 	@Override
 	protected void interrupted() {
 		end();
 	}
 
+	/**
+	 * Implementation of PIDOutput's pidWrite method. Sends the moveController's
+	 * output speed to the motors as the drive/forward speed in DifferentialDrive's
+	 * arcadeDrive method.
+	 * 
+	 * @param output
+	 *            the output drive/forward speed [-1, 1], calculated by the move
+	 *            PIDController, to pass in as the drive/forward speed in
+	 *            arcadeDrive()
+	 */
 	@Override
 	public void pidWrite(double output) {
 		dt.arcadeDrive(output, 0);

Robot2018/src/org/usfirst/frc/team199/Robot2018/commands/PIDTurn.java

@@ -10,20 +10,35 @@
 import edu.wpi.first.wpilibj.command.Command;
 
 /**
- *
+ * Turns the robot to a certain target bearing using PID. Implements PIDOutput
+ * in order to keep turn PID centralized in this command.
  */
 public class PIDTurn extends Command implements PIDOutput {
 
-	double target;
-	DrivetrainInterface dt;
+	private double target;
+	private DrivetrainInterface dt;
 	private PIDController turnController;
 
+	/**
+	 * Constructs this command with a new PIDController. Sets all of the
+	 * controller's PID constants based on SD prefs. Sets the controller's PIDSource
+	 * to the AHRS (gyro) object and sets its PIDOutput to this command which
+	 * implements PIDOutput's pidWrite() method.
+	 * 
+	 * @param targ
+	 *            the target bearing (in degrees) to turn to (so negative if turning
+	 *            left, positive if turning right)
+	 * @param dt
+	 *            the Drivetrain (for actual code) or a DrivetrainInterface (for
+	 *            testing)
+	 * @param ahrs
+	 *            the AHRS (gyro)
+	 */
 	public PIDTurn(double targ, DrivetrainInterface dt, AHRS ahrs) {
 		// Use requires() here to declare subsystem dependencies
-		// eg. requires(chassis);
+		requires(Robot.dt);
 		target = targ;
 		this.dt = dt;
-		requires(Robot.dt);
 		// calculates the maximum turning speed in degrees/sec based on the max linear
 		// speed in inches/s and the distance (inches) between sides of the DT
 		double maxTurnSpeed = dt.getCurrentMaxSpeed() * 360
@@ -33,7 +48,10 @@ public PIDTurn(double targ, DrivetrainInterface dt, AHRS ahrs) {
 				Robot.getConst("TurnkD", 0), kf, ahrs, this);
 	}
 
-	// Called just before this Command runs the first time
+	/**
+	 * Called just before this Command runs the first time. Resets the gyro, sets
+	 * the turnController's settings, and then enables it.
+	 */
 	@Override
 	protected void initialize() {
 		dt.resetAHRS();
@@ -48,33 +66,57 @@ protected void initialize() {
 		turnController.enable();
 	}
 
-	// Called repeatedly when this Command is scheduled to run
+	/**
+	 * Called repeatedly when this Command is scheduled to run. This method is empty
+	 * bc the turnController runs on a different thread as soon as it is enabled in
+	 * initialize().
+	 */
 	@Override
 	protected void execute() {
-		// This method is empty bc the moveController runs on a different thread as soon
-		// as it is enabled.
 	}
 
-	// Make this return true when this Command no longer needs to run execute()
+	/**
+	 * Tells this command to terminate when the turnController has reached its
+	 * target.
+	 * 
+	 * @return true if the robot has turned to the correct target bearing, false if
+	 *         not
+	 */
 	@Override
 	protected boolean isFinished() {
 		return turnController.onTarget();
 	}
 
-	// Called once after isFinished returns true
+	/**
+	 * Called once after isFinished returns true. Disables and frees the
+	 * turnController, essentially turning it "off" and "deleting" the thread it was
+	 * running on.
+	 */
 	@Override
 	protected void end() {
 		turnController.disable();
 		turnController.free();
 	}
 
-	// Called when another command which requires one or more of the same
-	// subsystems is scheduled to run
+	/**
+	 * Called when another command which requires one or more of the same subsystems
+	 * is scheduled to run. Disables and frees the turnController, essentially
+	 * turning it "off" and "deleting" the thread it was running on.
+	 */
 	@Override
 	protected void interrupted() {
 		end();
 	}
 
+	/**
+	 * Implementation of PIDOutput's pidWrite method. Sends the turnController's
+	 * output speed to the motors as the turn speed in DifferentialDrive's
+	 * arcadeDrive method.
+	 * 
+	 * @param output
+	 *            the output turn speed [-1, 1], calculated by the turn
+	 *            PIDController, to pass in as the turn speed in arcadeDrive()
+	 */
 	@Override
 	public void pidWrite(double output) {
 		dt.arcadeDrive(0, output);

Robot2018/test/org/usfirst/frc/team199/Robot2018/ParseScriptFileTest.java

@@ -108,9 +108,10 @@ void test8() {
 	@Test
 	void test9() {
 		String input = "RRxx:\n"
-				+ "moveto (42,56) 45\n"
+				+ "moveto (42,56) 45 # Trailing comment should not break anything \n"
 				+ "scale\n"
-				+ "move 46\n"
+				+ "#move 10\n" // For testing that commented lines are ignored
+				+ "move 46\n" 
 				+ "LRxx:\n"
 				+ "intake\n"
 				+ "turn (32,5)\n";