FIRST robotics projects are made in Visual Studio Code, with the wpilib extension. Look up "wpilib" in the extensions tab of vs-code once it is installed. Use wpilib commands to build and deploy the code.
- Run
doxygento update the docs (how to install doxygen is in the "Adding documentation" section). - Create a branch:
git branch *name*(replace "*name*" with what changes you intend to make). - Track all of your new changes:
git add . - Commit the changes:
git commit -m "*changes*"(replace "*changes*" with what changes you made) - Push the commit to the repository:
git push
The documentation pages and visuals are created by doxygen. The doxygen configuration is almost completely default, its file is "Doxygen" learn more about doxygen
When updating code, comments, or anything that should be in documentation, run
doxygen
before commiting. Install Doxygen on mac with Brew: brew install doxygen
If you want to change the doxygen configuration, use the doxygen gui, doxywizard. Make sure you save the outputted doxygen config in the Doxygen file.
The "heart" of the robot is the roborio, which uses wpilib for instructions. There are a couple base robot templates, but we are using the TimedRobot.
If you want to understand wpilib, start here. After that, you will need the Java library documentation.
Then, learn about our drivebase code.
Motors/motor controllers and other components of the robot will need other java libraries, and have other docs aswell.
We are using Rev Robotics SparkMax and ctre Phoenix Talon and Victor motor controllers (links are to their libraries).
The robot also uses a NavX Gyro. The gyro can get lots of information about the robot's orientation, position, etc.
When adding a new component, look up instructions on how to install it, and then update this doc with its library's documenation.