Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Empty file.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Empty file added Docs/3_Specifics/3.3_Swerve.md
Empty file.
File renamed without changes.
File renamed without changes.
30 changes: 0 additions & 30 deletions Docs/Specifics/PathPlanner.md

This file was deleted.

Binary file removed Docs/Specifics/image.png
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ public class Robot extends LoggedRobot {
private RobotContainer m_robotContainer;

@Override
@SuppressWarnings("resource")
public void robotInit() {
Logger.recordMetadata("ProjectName", "KitbotExample"); // Set a metadata value

Expand Down
1 change: 1 addition & 0 deletions Examples/KitbotDemoSim/src/main/java/frc/robot/Robot.java
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ public class Robot extends LoggedRobot {
private RobotContainer m_robotContainer;

@Override
@SuppressWarnings("resource")
public void robotInit() {
Logger.recordMetadata("ProjectName", "KitbotExample"); // Set a metadata value

Expand Down
41 changes: 24 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This material is _not_ made to comprehensively teach everything you need to know
We believe that the best way to learn what is needed to be successful on the team is to work hands-on on real projects, not be taught by a rigid curriculum (if the classroom was the best way, we would be doing that instead of building robots, after all).
To that end, these materials exist primarily to soften the learning curve and provide reference material.

If you feel that this material is going too slow, you may skip or skim through the material.
You should progress through these in order, but if you feel that this material is going too slow, you may skip or skim through the material.
However, understand that the material marked as required is done so for a reason, and try to make sure you understand it before skipping ahead, as you may be referred back to the material if you have questions that it covers later.

If you feel that this material is too fast or too much, talk to your lead or a mentor.
Expand All @@ -23,38 +23,45 @@ Each link down below corresponds to one "course" in the team training system.
Each page will have a brief description of the topic and may include links to other resources.
At the end of each page, there will be one or two exercises to complete.
Once you complete them, show a lead or mentor to get checked off as having completed that course and move on to the next one as suggested on the page.
The order that these need to be completed roughly matches the order on this page.
Everything through [Architecture](#architecture) including simulation is required, but pages after it do provide useful information.
Controls in particular contain techniques used in most mechanisms on the robot.
Everything through **3.1 PID and Feedforward Control Intro** is required, but pages after it do provide useful information.

The Examples folder contains full code for the kitbot demos.

The Stage-3-Writeups folder contains various writeups from team members about specific subjects, particularly offseason projects and other "research".
We encourage you to browse through these, and to ask a lead if you'd like to learn more!

## Docs

### General Programming

- [**JIN** - Java Basics](Docs/General/Java.md)
- [**GIT** - Git Basics](Docs/General/BasicGit.md)
- [**GWF** - Team Git Workflow](Docs/General/GitWorkflow.md)
- [1.1 Java Basics](Docs/1_General/1.1_Java.md)
- [1.2 Git Basics](Docs/1_General/1.2_BasicGit.md)
- [1.3 Team Git Workflow](Docs/1_General/1.3_GitWorkflow.md)

### Architecture

- [**FPI** - WPILib / Intro to FRC Programming](Docs/Architecture/WPILib.md)
- [**ARC** - Team Architecture / Command Based](Docs/Architecture/CommandBased.md)
- [**AKT** - AdvantageKit and Logging](Docs/Architecture/AdvantageKit.md)
- [**SIM** - Simulation](Docs/Architecture/Simulation.md)
- [2.1 WPILib / Intro to FRC Programming](Docs/2_Architecture/2.1_WPILib.md)
- [2.2 Electrical Intro](Docs/2_Architecture/2.2_ElectronicsCrashCourse.md)
- [2.3-2.5 Command Based](Docs/2_Architecture/2.3_CommandBased.md)
- [2.6-2.7 AdvantageKit and Logging](Docs/2_Architecture/2.6_AdvantageKit.md)
- [2.8-2.9 Simulation](Docs/2_Architecture/2.8_Simulation.md)
- [2.10 Overall architecture(??)](Docs/2_Architecture/2.10_Superstructure.md)

### Controls

- [**PID** - PID and Feedforward Control Intro](Docs/Specifics/ControlsIntro.md)
- [3.1 PID and Feedforward Control Intro](Docs/3_Specifics/3.1_ControlsIntro.md)
- [3.2 Motion Profiling](Docs/3_Specifics/3.2_MotionProfiling.md)

### Libraries and Tooling
### Swerve

This section is a work in progress, due to changes in how we do auto paths and vision in the 2023 offseason.
- [3.3 Swerve](Docs/3_Specifics/3.3_Swerve.md)

- [**AUT** - PathPlanner and Auto](Docs/Specifics/PathPlanner.md)
### Libraries and Tooling

- [**PVN** - PhotonVision and Vision](Docs/Specifics/Vision.md)
- [3.4 Choreo and Auto](Docs/3_Specifics/3.4_Choreo.md)
- [3.5 PhotonVision and Vision](Docs/3_Specifics/3.5_Vision.md)

### See Also

- [Training Docs Template](Template.md)
- [Further Reading](Docs/General/ReadingList.md)
- [Further Reading](Docs/1_General/1.4_ReadingList.md)