You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/INSTALL.md
+23-10Lines changed: 23 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,17 +13,24 @@ already have a GitHub account where you will store your 2026 FRC robot code.
13
13
14
14
### Creating a 2026 FRC project from the Az-RBSI Template
15
15
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.
17
18
18
19
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.
23
24
24
25
The latest release of Az-RBSI is in the `main` (default) branch, so it is
25
26
recommended to **not** select the "Include all branches" checkbox.
26
27
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
Copy file name to clipboardExpand all lines: doc/RBSI-GSG.md
+19-8Lines changed: 19 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,10 +41,16 @@ modifications to extant RBSI code will be done to files within the
41
41
42
42
### Tuning constants for optimal performance
43
43
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.
46
49
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)
47
52
53
+
Similar tuning can be done with subsystem components (flywheel, intake, etc.).
48
54
49
55
5. Power monitoring by subsystem is included in the Az-RBSI. In order to
50
56
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
55
61
instantiation](
56
62
https://github.com/AZ-First/Az-RBSI/blob/38f6391cb70c4caa90502710f591682815064677/src/main/java/frc/robot/RobotContainer.java#L154-L157) in the `RobotContainer.java` file.
57
63
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`.
0 commit comments