Code Monkey home page Code Monkey logo

2023drivebase-1's Introduction

2023 Drive Base

Contributing

The enviroment

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.

How to add your amazing changes!

  1. Run doxygen to update the docs (how to install doxygen is in the "Adding documentation" section).
  2. Create a branch: git branch *name* (replace "*name*" with what changes you intend to make).
  3. Track all of your new changes: git add .
  4. Commit the changes: git commit -m "*changes*" (replace "*changes*" with what changes you made)
  5. Push the commit to the repository: git push

New to github?

Documentation

Adding documentation

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.

How the drive base works

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 and components

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.

2023drivebase-1's People

Contributors

xoth42 avatar crypt1cg avatar slee23 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.