Home

Welcome to the 13330 wiki, here you can find a few things that will help you understand. The five classes that we are using in our Project and some documentation guidelines.

The 5 Classes

Auto: Autonomous is the first section of a round. This year, our auto will at some point entail a way to move the gold cube, place the team marker, and park in the crater.

TeleOp: TeleOp this year will entail a way to activate most/all of the motors/servos on our robot with a controller operated by our driver, this year, the mechanisms include a hanging mechanism, a collection/scoring mechanism for blocks/balls, and a driving mechanism.

Robot: This class contains a few complicated methods that allow us to drive the robot efficiently, along with angle correction, or PID, which allows the robot to continue going straight in Autonomous meanwhile not having to clog up the other classes with a method that makes the rest of the code more difficult to read. We reference this class in both auto and teleop.

Console: Similarly to Robot, this class contains methods and objects that we use in auto and teleop, but for different purposes. The Console class gives Telemetry output to the robot controller phone and displays some other things. The console class frees up space in our code, improving the readability of auto and teleop by removing the definition of multiple methods from them.

Hardware: The Hardware class initiates most of the variables we are using, including motors, IMUs and encoders.

Documentation Guidelines

Proper documentation is one of the most important things in software engineering. This year we have worked hard to make our code as readable as possible. In order to make the code easier to understand, we have added comments before each method to assist the reader in understanding what it does.