Skip to content

Commit

Permalink
Alert QoL + Docs updates (#1111)
Browse files Browse the repository at this point in the history
Co-authored-by: Jade <[email protected]>
Co-authored-by: Tyler Veness <[email protected]>
Co-authored-by: shueja <[email protected]>
  • Loading branch information
4 people authored Jan 6, 2025
1 parent 2431e29 commit a947ef2
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/choreolib/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,11 @@ In general, trajectory followers accept trajectory "samples" that represent the

1. For more information about differential drive kinematics, see [WPILib's documentation](https://docs.wpilib.org/en/stable/docs/software/kinematics-and-odometry/differential-drive-kinematics.html). In this example, we assume you have created an instance of `DifferentialDriveKinematics`, named `kinematics`.

## Choreo-Specific Alerts
Choreo primarily uses the WPILib Alerts API to provide users with internal warnings, errors or information. These alerts can be found under the SmartDashboard/ChoreoAlert section within networktables.

To visualize these alerts in a dashboard such as AdvantageScope simply drag the ChoreoAlert group outwards onto the "discrete fields" section in advantagescope or the main dashboard panel.

## Next Steps

<div class="grid cards" markdown>
Expand Down

0 comments on commit a947ef2

Please sign in to comment.