.. WPILib Documentation master file, created by sphinx-quickstart on Fri Apr 5 23:28:43 2019. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. .. include:: .. meta:: :google-site-verification: POR_nG8b56eXGxmUIutST7jcA_Vl58ypSdJTzJ1g0zg # FIRST Control System Welcome to the *FIRST*\ |reg| Control System Documentation! This site contains everything you need to know for programming a competition robot using WPILib! Community translations can be found in a variety of languages in the menu towards the bottom-right of the screen. .. grid:: 1 2 2 2 :gutter: 3 .. grid-item-card:: :class-header: sd-bg-success sd-text-white **Returning Teams** ^^^ If you are a returning team, please check out the overview of changes for 2027, known issues, and quick start guide for updating. +++ .. button-ref:: /docs/yearly-overview/yearly-changelog :color: primary :shadow: :align: center :expand: :class: mb-1 :outline: Changelog .. button-ref:: /docs/yearly-overview/known-issues :color: primary :shadow: :align: center :expand: :outline: Known Issues .. button-ref:: /docs/yearly-overview/returning-quickstart :color: primary :shadow: :align: center :expand: :outline: Quick Start .. grid-item-card:: :class-header: sd-bg-info sd-text-white **New Teams** ^^^ The Zero-to-Robot tutorial will guide you through preparation, wiring, and programming a basic robot! +++ .. button-ref:: /docs/zero-to-robot/introduction :color: primary :shadow: :align: center :expand: :outline: Go to Zero-to-Robot .. grid:: 1 2 2 2 :gutter: 3 .. grid-item-card:: :class-header: sd-bg-info sd-text-white **Hardware Overview** ^^^ An overview of the hardware components available to teams. +++ .. button-ref:: /docs/controls-overviews/control-system-hardware :color: primary :align: center :expand: :outline: Go to Hardware Overview .. grid-item-card:: :class-header: sd-bg-info sd-text-white **Software Overview** ^^^ An overview of the software components and tools available to teams. +++ .. button-ref:: /docs/controls-overviews/control-system-software :color: primary :shadow: :align: center :expand: :outline: Go to Software Overview .. grid:: 1 2 3 3 :gutter: 3 .. grid-item-card:: :class-header: sd-bg-info sd-text-white **Programming Basics** ^^^ Documentation that is useful throughout a team's programming process. +++ .. button-ref:: stubs/programming-basics-stub :color: primary :shadow: :align: center :expand: :outline: View articles .. grid-item-card:: :class-header: sd-bg-info sd-text-white **Advanced Programming** ^^^ Documentation that is suited toward veteran teams. This includes content such as Path Planning and Kinematics. +++ .. button-ref:: stubs/advanced-programming-stub :color: primary :shadow: :align: center :expand: :outline: View articles .. grid-item-card:: :class-header: sd-bg-info sd-text-white **Hardware** ^^^ Hardware tutorials and content available for teams. +++ .. button-ref:: stubs/hardware-stub :color: primary :shadow: :align: center :expand: :outline: View articles .. grid-item-card:: :class-header: sd-bg-info sd-text-white **Romi and XRP Robots** ^^^ The Romi and XRP robots are low-cost platforms for practicing WPILib programming. +++ .. button-ref:: docs/romi-robot/index :color: primary :shadow: :align: center :expand: :outline: View Romi articles .. button-ref:: docs/xrp-robot/index :color: primary :shadow: :align: center :expand: :outline: View XRP articles .. grid-item-card:: :class-header: sd-bg-info sd-text-white **API Documentation** ^^^ Java, C++, and Python class documentation. .. button-link:: https://github.wpilib.org/allwpilib/docs/beta/java/index.html :color: primary :shadow: :align: center :expand: :outline: Java .. button-link:: https://github.wpilib.org/allwpilib/docs/beta/cpp/index.html :color: primary :shadow: :align: center :expand: :outline: C++ .. button-link:: https://robotpy.readthedocs.io/projects/robotpy/en/stable/ :color: primary :shadow: :align: center :expand: :outline: Python .. grid-item-card:: :class-header: sd-bg-info sd-text-white **Software Tools** ^^^ Essential tooling such as FIRST Driver Station, Dashboards, roboRIO Imaging Tool and more. +++ .. button-ref:: stubs/software-tools-stub :color: primary :shadow: :align: center :expand: :outline: View articles .. grid-item-card:: :class-header: sd-bg-info sd-text-white **Example Projects** ^^^ This section showcases the available example projects that teams can reference in VS Code. +++ .. button-ref:: docs/software/examples-tutorials/wpilib-examples :color: primary :shadow: :align: center :expand: :outline: View articles .. grid-item-card:: :class-header: sd-bg-info sd-text-white **Status Light Quick Reference** ^^^ Quick reference guide for the status lights on a variety of FRC hardware. +++ .. button-ref:: docs/hardware/hardware-basics/status-lights-ref :color: primary :shadow: :align: center :expand: :outline: View article .. grid-item-card:: :class-header: sd-bg-info sd-text-white **3rd Party libraries** ^^^ Tutorial on adding 3rd party libraries such as CTRE and REV to your robot project. +++ .. button-ref:: docs/software/vscode-overview/3rd-party-libraries :color: primary :shadow: :align: center :expand: :outline: View article .. toctree:: :maxdepth: 1 :titlesonly: :caption: Zero to Robot :hidden: docs/zero-to-robot/introduction docs/zero-to-robot/step-1/index docs/zero-to-robot/step-2/index docs/zero-to-robot/step-3/index docs/zero-to-robot/step-4/index .. toctree:: :maxdepth: 1 :caption: Control System Overviews :hidden: docs/controls-overviews/control-system-hardware docs/controls-overviews/control-system-software .. toctree:: :maxdepth: 1 :caption: Programming Basics :hidden: docs/software/what-is-wpilib docs/yearly-overview/index docs/software/vscode-overview/index docs/software/dashboards/index docs/software/telemetry/index docs/software/python/index docs/software/hardware-apis/index docs/software/can-devices/index docs/software/basic-programming/index docs/software/support/support-resources docs/software/frc-glossary .. toctree:: :maxdepth: 1 :caption: API Docs :hidden: WPILib Java API Docs WPILib C++ API Docs WPILib Python API Docs .. toctree:: :maxdepth: 1 :caption: Software Tools :hidden: docs/software/driverstation/index docs/software/wpilib-tools/robot-simulation/index docs/software/wpilib-tools/outlineviewer/index docs/software/wpilib-tools/wpical/index .. toctree:: :maxdepth: 1 :caption: Advanced Programming :hidden: docs/software/vision-processing/index docs/software/commandbased/index docs/software/kinematics-and-odometry/index docs/software/networktables/index docs/software/pathplanning/index docs/software/systemcore-info/index docs/software/advanced-gradlerio/index docs/software/advanced-controls/index docs/software/convenience-features/index .. toctree:: :maxdepth: 1 :caption: Examples and Tutorials :hidden: docs/software/examples-tutorials/wpilib-examples docs/software/examples-tutorials/third-party-examples .. toctree:: :maxdepth: 1 :caption: Hardware :hidden: docs/hardware/hardware-basics/index docs/hardware/hardware-tutorials/index docs/hardware/sensors/index .. toctree:: :maxdepth: 1 :caption: Romi and XRP Support :hidden: docs/romi-robot/index docs/xrp-robot/index .. toctree:: :maxdepth: 1 :caption: Robot Networking :hidden: docs/networking/networking-introduction/index docs/networking/networking-utilities/index .. toctree:: :maxdepth: 1 :caption: Contributing :hidden: docs/contributing/wpilib-docs/index docs/contributing/wpilib/index .. toctree:: :maxdepth: 1 :caption: Legal :hidden: docs/legal/privacy-policy .. toctree:: :maxdepth: 1 :caption: Issues :hidden: Report a Documentation Issue