Skip to content

Commit 21649f3

Browse files
authored
Pull develop into main for RC2 (#115)
2 parents ad74215 + e5b546b commit 21649f3

27 files changed

+1676
-289
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Arizona's Reference Build and Software Implementation for FRC Robots (read: "A-Z
99

1010
## Installation
1111

12-
Installation instructions are found in the [INSTALL.md](INSTALL.md) file, and the [Getting
13-
Started Guide](RBSI-GSG.md) includes the steps you'll need to do before taking your robot
12+
Installation instructions are found in the [INSTALL.md](doc/INSTALL.md) file, and the [Getting
13+
Started Guide](doc/RBSI-GSG.md) includes the steps you'll need to do before taking your robot
1414
out for a spin. See the [Releases Page](https://github.com/AZ-First/Az-RBSI/releases) for
1515
details on the latest release, including restrictions and cautions.
1616

@@ -29,7 +29,7 @@ The purpose of Az-RBSI is to help Arizona FRC teams with:
2929
## Design Philosophy
3030

3131
The Az-RBSI is centered around a "Reference Build" robot that allows for teams
32-
to communicate quickly and effectivly with each other about gameplay strategy
32+
to communicate quickly and effectively with each other about gameplay strategy
3333
and troubleshooting. Additionally, the consolidation around a standard robot
3434
design allows for easier swapping of spare parts and programming modules.
3535

@@ -44,11 +44,11 @@ effective logging for troubleshooting.
4444

4545
* [WPILib](https://docs.wpilib.org/en/stable/index.html) -- FIRST basic libraries
4646
* [AdvantageKit](
47-
https://github.com/Mechanical-Advantage/AdvantageKit/blob/main/docs/WHAT-IS-ADVANTAGEKIT.md)
47+
https://docs.advantagekit.org/getting-start ed/what-is-advantagekit/)
4848
-- Logging
4949
* [CTRE Phoenix6](
5050
https://v6.docs.ctr-electronics.com/en/stable/docs/api-reference/mechanisms/swerve/swerve-overview.html)
51-
/ [YAGSL](https://yagsl.gitbook.io/yagsl) -- Swerve drive library
51+
/ [YAGSL](https://docs.yagsl.com/) -- Swerve drive library
5252
* [PathPlanner](https://pathplanner.dev/home.html) / [Choreo](
5353
https://sleipnirgroup.github.io/Choreo/) -- Autonomous path planning
5454
* [PhotonVision](https://docs.photonvision.org/en/latest/) / [Limelight](

build.gradle

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
plugins {
22
id "java"
3-
id "edu.wpi.first.GradleRIO" version "2026.1.1"
3+
id "edu.wpi.first.GradleRIO" version "2026.2.1"
44
id "com.peterabeles.gversion" version "1.10.3"
5-
id "com.diffplug.spotless" version "8.0.+"
6-
id "io.freefair.lombok" version "9.1.+"
7-
id "com.google.protobuf" version "0.9.+"
5+
id "com.diffplug.spotless" version "8.1.0"
6+
id "io.freefair.lombok" version "9.2.0"
7+
id "com.google.protobuf" version "0.9.6"
88
}
99

1010
java {
@@ -64,7 +64,7 @@ def deployArtifact = deploy.targets.roborio.artifacts.frcJava
6464
wpi.java.debugJni = false
6565

6666
// Set this to true to enable desktop support.
67-
def includeDesktopSupport = false
67+
def includeDesktopSupport = true
6868

6969
// Defining my dependencies. In this case, WPILib (+ friends), and vendor libraries.
7070
// Also defines JUnit 5.

INSTALL.md renamed to doc/INSTALL.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,24 @@ already have a GitHub account where you will store your 2026 FRC robot code.
1313

1414
### Creating a 2026 FRC project from the Az-RBSI Template
1515

16-
From the [Az-RBSI GiuHub page](https://github.com/AZ-First/Az-RBSI/), click the "Use this template" button in the upper right corner of the page.
16+
From the [Az-RBSI GiuHub page](https://github.com/AZ-First/Az-RBSI/), click the
17+
"Use this template" button in the upper right corner of the page.
1718

1819
In the page that opens, select the Owner (most likely your team's account) and
19-
Repository name (*e.g.*, "FRC-2026" or "REBUILT Robot Code" or whatever your team's naming convention
20-
is) into which the create the new robot project. Optionally, include a
21-
description of the repository for your reference. Select "public" or "private"
22-
repository based on the usual practices of your team.
20+
Repository name (*e.g.*, "FRC-2026" or "REBUILT Robot Code" or whatever your
21+
team's naming convention is) into which the create the new robot project.
22+
Optionally, include a description of the repository for your reference. Select
23+
"public" or "private" repository based on the usual practices of your team.
2324

2425
The latest release of Az-RBSI is in the `main` (default) branch, so it is
2526
recommended to **not** select the "Include all branches" checkbox.
2627

28+
If you want to keep caught up on dependencies, you will need to ENABLE the
29+
Dependency Graph selection under the "Advanced Security" tab of the repository
30+
Settings.
31+
32+
<img src="dependency_enable.png" alt="Enable Dependency Graph" width="50%" />
33+
2734
--------
2835

2936
### Software Requirements
@@ -32,22 +39,22 @@ The Az-RBSI requires the [2026 WPILib Installer](
3239
https://github.com/wpilibsuite/allwpilib/releases) (VSCode and associated
3340
tools), 2026 firmware installed on all hardware (motors, encoders, power
3441
distribution, etc.), the [2026 NI FRC Game Tools](
35-
https://github.com/wpilibsuite/2026Beta)
42+
https://www.ni.com/en/support/downloads/drivers/download.frc-game-tools.html)
3643
(Driver Station and associated tools), and the [2026 CTRE Phoenix Tuner X](
3744
https://v6.docs.ctr-electronics.com/en/stable/docs/tuner/index.html). Take a
38-
moment to update all software and firmware before attempting to load your new
39-
robot project.
45+
moment to update all software and firmware to the latest versions before
46+
attempting to load your new robot project.
4047

4148
Please note that you need these _minimum_ versions of the following components:
4249

43-
* WPILib ` v2026.1.1-beta-1`
50+
* WPILib ` v2026.2.1`
4451
* RoboRIO image `FRC_roboRIO_2026_v1.2`
4552

4653
--------
4754

4855
### Setting up your new project
4956

50-
When your new robot code respository is created, it will have a single commit
57+
When your new robot code repository is created, it will have a single commit
5158
that contains the entire Az-RBSI template for the current release. (See the
5259
[Az-RBSI Releases page](https://github.com/AZ-First/Az-RBSI/releases) for more
5360
information about the latest release.)
@@ -101,6 +108,12 @@ method are encouraged to submit bug reports and code fixes to the [Az-RBSI
101108
repository](https://github.com/AZ-First/Az-RBSI).
102109

103110

111+
--------
112+
113+
### Getting Started with your Robot Code
114+
115+
See the Az-RBSI [Getting Started Guide](RBSI-GSG.md) for next steps.
116+
104117
--------
105118

106119
### Updating your project based on the latest released version of Az-RBSI

RBSI-GSG.md renamed to doc/RBSI-GSG.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,16 @@ modifications to extant RBSI code will be done to files within the
4141

4242
### Tuning constants for optimal performance
4343

44-
4. HHHH
45-
44+
4. Over the course of your robot project, you will need to tune PID parameters
45+
for both your drivebase and any mechanisms you build to play the game.
46+
AdvantageKit includes detailed instructions for how to tune the various
47+
portions of your drivetrain, and we **STRONGLY RECOMMEND** you work through
48+
these steps **BEFORE** running your robot.
4649

50+
* [Tuning for drivebase with CTRE components](https://docs.advantagekit.org/getting-started/template-projects/talonfx-swerve-template#tuning)
51+
* [Tuning for drivebase with REV components](https://docs.advantagekit.org/getting-started/template-projects/spark-swerve-template/#tuning)
4752

53+
Similar tuning can be done with subsystem components (flywheel, intake, etc.).
4854

4955
5. Power monitoring by subsystem is included in the Az-RBSI. In order to
5056
properly match subsystems to ports on your Power Distribution Module,
@@ -55,12 +61,17 @@ modifications to extant RBSI code will be done to files within the
5561
instantiation](
5662
https://github.com/AZ-First/Az-RBSI/blob/38f6391cb70c4caa90502710f591682815064677/src/main/java/frc/robot/RobotContainer.java#L154-L157) in the `RobotContainer.java` file.
5763

58-
6. All of the constants for needed for tuning your robot should be in the
59-
`Constants.java` file in the `src/main/java/frc/robot` directory. This file
60-
should be thoroughly edited to match the particulars of your robot. Be sure
61-
to work through each section of this file and include the proper values for
62-
your robot.
63-
64+
6. In the `Constants.java` file, the classes following `RobotDevices` contain
65+
individual containers for robot subsystems and interaction methods. The
66+
`OperatorConstants` class determines how the OPERATOR interacts with the
67+
robot. `DriveBaseConstants` and `FlywheelConstants` (and additional classes
68+
you add for your own mechanisms) contain human-scale conversions and limits
69+
for the subsystem (_e.g._, maximum speed, gear ratios, PID constants, etc.).
70+
`AutoConstants` contains the values needed for your autonomous period method
71+
of choice (currently supported are MANUAL -- you write your own code;
72+
PATHPLANNER, and CHOREO). The next two are related to robot vision, where
73+
the vision system constants are contained in `VisionConstants`, and the
74+
physical properties (location, FOV, etc.) of the cameras are in `Cameras`.
6475

6576
--------
6677

doc/dependency_enable.png

448 KB
Loading
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"tags": [],
3+
"field": {
4+
"length": 16.4592,
5+
"width": 8.2296
6+
}
7+
}

0 commit comments

Comments
 (0)