Skip to content

Latest commit

 

History

History
68 lines (56 loc) · 2.97 KB

File metadata and controls

68 lines (56 loc) · 2.97 KB

Az-RBSI Documentation

This directory contains the project-level documentation for the Az-RBSI robot code template.

Use this page as the documentation map. The root README is the project front door; this page is the working table of contents.

Table Of Contents

Page Use It For
INSTALL.md Creating a project, setting team number, generating Phoenix Tuner X constants, and first setup tasks.
RBSI-GSG.md First robot-code changes after installation.
RBSI-Constants.md Understanding Constants.java and the tuning order for a new robot.
RBSI-Drive.md Phoenix/YAGSL drivetrain setup, odometry, drive tuning, and characterization.
RBSI-Vision.md PhotonVision/Limelight setup, camera transforms, filtering, simulation, and troubleshooting.
RBSI-Autonomous.md Manual autos, PathPlanner, Choreo, Autopilot, match lifecycle, and pose reset rules.
RBSI-SysId.md Running SysId routines and applying flywheel characterization results.
RBSI-PoseBuffer.md Design reference for time-aligned odometry and vision fusion.
RBSI-AdvantageScope.md Standard AdvantageScope layout tabs and how to add mechanism power/timing plots.

New User Bring-Up Path

  1. Install the project.
  2. Make first code changes.
  3. Select robot, swerve, vision, and auto modes.
  4. Generate or configure drivetrain constants.
  5. Verify odometry before vision.
  6. Configure cameras and vision filtering.
  7. Bring up a short autonomous path.
  8. Open the standard AdvantageScope layout.
  9. Run SysId for mechanisms and update gains.

Experienced User Navigation

Recommended Reading Order

For a new team:

  1. INSTALL.md
  2. RBSI-GSG.md
  3. RBSI-Constants.md
  4. RBSI-Drive.md
  5. RBSI-Vision.md
  6. RBSI-Autonomous.md
  7. RBSI-SysId.md
  8. RBSI-AdvantageScope.md
  9. RBSI-PoseBuffer.md

For troubleshooting during the season, start with the symptom-specific page, then follow links back to constants and bring-up checklists.