Work in progress. This library and its docs are new and still changing, and some parts are not yet tested on a real robot. Something wrong or unclear?Tell us (a GitHub issue).
FTC-Helper-Lib docs
Shortcuts for programming an FTC robot in Java. These pages match release v0.15.0.
New here? Quick start: a driving robot in 30 minutes, or step by step: Add the library to a project, then the main track: Lesson 1: The robot in five files (./gradlew :sim:newRobot writes the five files from your robot configuration).
Start here
Section titled “Start here”- Quick start: a driving robot in 30 minutes
- Add the library to a project
- Lesson 1: The robot in five files
- The button menu: every way a button can work
- The autonomous builder: the complete guide
- Reference: search every class and method
Tutorials: main track (start here)
Section titled “Tutorials: main track (start here)”Do these in order. One robot, built up lesson by lesson.
- Lesson 1: The robot in five files
- Lesson 2: Drive
- Check the hardware (Tutorial 19)
- Lesson 3: Buttons (Controls.java)
- Lesson 4: An intake, a lift and a claw
- Lesson 5: Actions: several parts together
- Lesson 6: Your first autonomous
- Lesson 7: A shooter, a camera and a turret
- Lesson 8: Odometry: where am I on the field?
- Lesson 9: Paths with Pedro Pathing (optional)
All the ways a button can work (tap, hold, double-tap, pairs, buzzes): The button menu: every way a button can work.
Tutorials: under the hood
Section titled “Tutorials: under the hood”The same things built by hand, with the library’s building blocks. Do them to learn how it works.
- Tutorial 01: OpMode basics with the library
- Tutorial 02: Motors and servos
- Tutorial 03: Buttons
- Tutorial 04: Drive a mecanum robot
- Tutorial 05: Drive a standard (tank) robot
- Tutorial 06: A fast, clear loop
- Tutorial 07: PID: hold a lift at a height
- Tutorial 08: A lift that cannot hurt itself
- Tutorial 09: Your first autonomous
- Tutorial 10: Autonomous with mechanisms
- Tutorial 11: Driver assists
- Tutorial 12: Organize a whole robot
- Tutorial 13: Test your code without a robot
- Tutorial 14: Mechanism helpers
- Tutorial 15: Telemetry, profiles and tuning
- Tutorial 16: Easy autonomous
- Tutorial 17: Launcher
- Tutorial 18: Vision aiming (webcam or Limelight 3A)
- Tutorial 19: Testing procedures
- Tutorial 20: Easy TeleOp
- Tutorial 21: Find your numbers
For teams
Section titled “For teams”- Quick start: a driving robot in 30 minutes
- Add the library to a robot project
- Keep the library up to date
- Starter kit: a whole robot program in 30 minutes · the older six-file starter kit (EasyTeleOp, EasyAuto)
- Coming from last season’s code
- Signs and units
- Troubleshooting
Guides
Section titled “Guides”- How it all fits together
- The autonomous builder: the complete guide
- The button menu: every way a button can work
- Easy autonomous modes · make autonomous modes the older way (EasyAuto)
- What runs every loop
- Example: drive, slow mode, and an intake that starts on
- Extending the library
- Finding your numbers (the finders)
- A new season: what to do
- Non-blocking code: keep the loop running
- Parts catalog: motors, servos, wheels and rollers
- Profiles: practice vs competition
- Your robot in the simulator: the robot-file skill
- The simulator: a pretend Control Hub and Driver Hub
- The four BIOBUZZ starter bots as test robots
- Testing procedures
- Tuning while the robot runs
- Use only what you need
Modules
Section titled “Modules”Every class and every function, one page per module. To look one thing up, search the reference.
- Auto module
- Control module
- Core module
- Drive module
- Finders module
- Gamepad module
- Hardware module
- Launcher module
- Match module
- Mechanism module
- Odometry module
- Pedro module (Pedro Pathing)
- Robot module (the robot in five files)
- Safety module
- Telemetry module
- TeleOp module
- Testing module
- Tuning module
- Util module
- Vision module
Contributing to the library
Section titled “Contributing to the library”For people who change the library itself, not for robot code.