MCPcopy Index your code
hub / github.com/FTCLib/FTCLib

github.com/FTCLib/FTCLib @v2.1.1

Chat with this repo
repository ↗ · DeepWiki ↗ · release v2.1.1 ↗ · + Follow
1,414 symbols 3,307 edges 210 files 764 documented · 54%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

FTCLib

Logo produced by Xing from FTC Team 15303

Android CI | dev

Origin: https://github.com/FTCLib/FTCLib

Project led by Jackson Isenberg and the Alpharetta Robotics Club


FTCLib is a library designed to be the only library you'll need for FTC programming. The project was initially meant to be a port of WPILib, which is the standard programming library for FRC that almost all teams use. However, with FTC, there are a ton of libraries that not many people have heard about, especially rookie teams who are just starting. The goal of FTCLib is to improve the initial programming experience for new members as well as greatly enhance the efficiency of code for veterans.

Please read the documentation and the rest of the README before you get started with the library.

FTCLib documentation - https://ftclib.gitbook.io/ftclib

Installation

  1. Open up your FTC SDK Project in Android Studio.

  2. Go to your build.common.gradle file in your project.

    BuildCommonGradle

  3. Add the following to the repositories section at the bottom of the file.

groovy mavenCentral()

  1. Open the build.gradle file in your TeamCode module.

    TeamCodeGradle

  2. Go to the bottom of the file, and add the following.

    groovy dependencies { implementation 'org.ftclib.ftclib:core:2.1.1' // the following is optional if you want vision implementation 'org.ftclib.ftclib:vision:2.1.0' } 6. Because FTCLib makes use of advanced features, you need to increase the minSdkVersion to 24. Unfortunately, this means that ZTE Speed Phones are not supported in this release.

In build.common.gradle, change the minSdkVersion from 23 to 24:


    defaultConfig {
        applicationId 'com.qualcomm.ftcrobotcontroller'
        minSdkVersion 24
        targetSdkVersion 28
    }
  1. Ensure your Java version is set to 8. This should already be the case with the latest SDK. If not, you will need to change your Java version. Scroll down in build.common.gradle until you find the compileOptions block.
compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_7
    targetCompatibility JavaVersion.VERSION_1_7
}

Change the 7 to an 8 like so:

compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
}
  1. Perform a gradle sync to implement your changes.

    GradleSync

NOTE: If your module has a few dependencies, you might have an error related to multidex on building the project. This is caused by the project exceeding the limit for imports enforced by Android Studio. To solve this, add multiDexEnabled true to the below location inside the build.common.gradle file.


    defaultConfig {
        applicationId 'com.qualcomm.ftcrobotcontroller'
        minSdkVersion 24
        targetSdkVersion 28


        multiDexEnabled true
    }

Welcome to FTCLib!

Thank you for using the FTCLib library for your code! All of the people who worked on it have put a lot of effort into making FTCLib an amazing library. We thank you for putting our effort to work with your own projects. We hope you have great luck and success with your programming.

The mission of FTCLib is briefly summarized in the following quote made by Jackson from ARC Robotics, who started the library.

Our goal is to make programming easier and more efficient through effective classes and detailed examples of implementation.

Why Use FTCLib?

FTCLib is a non-profit, open source, community-driven library created solely with the intent of helping rookie teams learn programming easier and maximizing efficiency for veteran teams. By putting everything into one library, with enough documentation to build a rigorous learning experience, all teams can benefit from using FTCLib. It's fast, easy, efficient, and powerful. The idea is that this truly is the last library you will ever need.

FTCLib still has the ability to be used along with other libraries without conflict. If you still want to use other libraries alongside ours, go ahead. FTCLib's purpose is solely to improve everyone's programming experience in FTC.

Contributing

Since this is a community-driven, open source library, we are constantly looking for more content. If you feel there is something missing from our library, feel free to contribute! If you want to contribute to the project, be sure to read the CONTRIBUTING.md.

Please make sure to contact us if you have any other questions.

Extension points exported contracts — how you extend this code

TrajectoryConstraint (Interface)
An interface for defining user-defined velocity and acceleration constraints while generating trajectories. [10 implementers]
core/src/main/java/com/arcrobotics/ftclib/trajectory/constraint/TrajectoryConstraint.java
Command (Interface)
A state machine representing a complete action to be performed by the robot. Commands are run by the {@link CommandSche [4 …
core/src/main/java/com/arcrobotics/ftclib/command/Command.java
HardwareDevice (Interface)
(no doc) [9 implementers]
core/src/main/java/com/arcrobotics/ftclib/hardware/HardwareDevice.java
Waypoint (Interface)
A pure pursuit Waypoint is a point in which the robot traverses. Using Waypoints one can construct a pure pursuit path f [4 …
core/src/main/java/com/arcrobotics/ftclib/purepursuit/Waypoint.java
SensorDistance (Interface)
(no doc) [5 implementers]
core/src/main/java/com/arcrobotics/ftclib/hardware/SensorDistance.java

Core symbols most depended-on inside this repo

get
called by 129
core/src/main/java/com/arcrobotics/ftclib/util/InterpLUT.java
getTranslation
called by 77
core/src/main/java/com/arcrobotics/ftclib/geometry/Pose2d.java
getX
called by 75
core/src/main/java/com/arcrobotics/ftclib/geometry/Pose2d.java
getY
called by 75
core/src/main/java/com/arcrobotics/ftclib/geometry/Pose2d.java
getInstance
called by 66
core/src/main/java/com/arcrobotics/ftclib/command/CommandScheduler.java
add
called by 57
core/src/main/java/com/arcrobotics/ftclib/util/LUT.java
get
called by 50
core/src/main/java/com/arcrobotics/ftclib/command/button/Trigger.java
getRotation
called by 49
core/src/main/java/com/arcrobotics/ftclib/geometry/Pose2d.java

Shape

Method 1,160
Class 201
Function 26
Enum 15
Interface 12

Languages

Java96%
Kotlin4%

Modules by API surface

core/src/main/java/com/arcrobotics/ftclib/hardware/motors/Motor.java56 symbols
core/src/main/java/com/arcrobotics/ftclib/purepursuit/Path.java39 symbols
core/src/main/java/com/arcrobotics/ftclib/hardware/motors/MotorGroup.java26 symbols
core/src/main/java/com/arcrobotics/ftclib/controller/PIDFController.java24 symbols
core/src/main/java/com/arcrobotics/ftclib/command/CommandScheduler.java23 symbols
core/src/main/java/com/arcrobotics/ftclib/command/Command.java22 symbols
core/src/main/java/com/arcrobotics/ftclib/purepursuit/waypoints/GeneralWaypoint.java21 symbols
core/src/main/java/com/arcrobotics/ftclib/controller/wpilibcontroller/ProfiledPIDController.java21 symbols
core/src/main/java/com/arcrobotics/ftclib/geometry/Vector2d.java19 symbols
core/src/main/java/com/arcrobotics/ftclib/trajectory/Trajectory.java16 symbols
core/src/main/java/com/arcrobotics/ftclib/hardware/SimpleServo.java16 symbols
core/src/main/java/com/arcrobotics/ftclib/geometry/Pose2d.java16 symbols

For agents

$ claude mcp add FTCLib \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact