FRC Checkmate

FRC Checkmate is a lightweight, flexible system testing framework for FRC robots, built on top of WPILib.

đŸ”— Check out the code at github.com/logandhillon/frc-checkmate.

To install FRC Checkmate into your FRC robot’s codebase, see Installation.

It provides a consistent way to verify subsystems, sensors, and robot logic both on the robot and in simulation.

FRC Checkmate allows teams to define repeatable system-level tests for critical robot functions.

Tests can be executed automatically or manually via Shuffleboard widgets, and each test provides a clear pass/fail result with an optional message.

The framework is designed to:

  • Catch hardware or configuration issues before matches.
  • Standardize subsystem testing across codebases.
  • Allow quick diagnosis through on-dashboard feedback.

Quick Example

void main() {
    // register gyro calibration test
    Checkmate.register(
            "Gyro calibration", () -> {
                Gyro gyro = new Gyro();
                return gyro.isCalibrated()
                       ? TestResult.success("Gyro calibrated successfully")
                       : TestResult.fail("Gyro failed to calibrate");
            });
}

For more examples, see Examples.

FRC Checkmate was developed by Logan Dhillon on FRC Team 5409 Chargers.


This site uses Just the Docs, a documentation theme for Jekyll.