Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-22 01:11:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

[docs] Fix docs for SysID routine (#6164)

Browse Source
This commit is contained in:
Eli Barnett
2024-01-06 01:05:09 -05:00
committed by GitHub
parent 0a46a3a618
commit a2e4d0b15d
4 changed files with 298 additions and 220 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/sysid/SysIdRoutine.java
View File

@@ -151,10 +151,11 @@ public class SysIdRoutine extends SysIdRoutineLog {
*
* @param drive Sends the SysId-specified drive signal to the mechanism motors during test
* routines.
* @param log Returns measured data (voltages, positions, velocities) of the mechanism motors
* during test routines. To return data, call `recordFrame` on the supplied
* `SysIdRoutineLog` instance. Multiple motors can return data within a single `log`
* callback by calling `recordFrame` multiple times.
* @param log Returns measured data of the mechanism motors during test routines. To return
* data, call `motor(string motorName)` on the supplied `SysIdRoutineLog` instance, and then
* call one or more of the chainable logging handles (e.g. `voltage`) on the returned
* `MotorLog`. Multiple motors can be logged in a single callback by calling `motor`
* multiple times.
* @param subsystem The subsystem containing the motor(s) that is (or are) being characterized.
* Will be declared as a requirement for the returned test commands.
* @param name The name of the mechanism being tested. Will be appended to the log entry title
@@ -178,10 +179,11 @@ public class SysIdRoutine extends SysIdRoutineLog {
*
* @param drive Sends the SysId-specified drive signal to the mechanism motors during test
* routines.
* @param log Returns measured data (voltages, positions, velocities) of the mechanism motors
* during test routines. To return data, call `recordFrame` on the supplied
* `SysIdRoutineLog` instance. Multiple motors can return data within a single `log`
* callback by calling `recordFrame` multiple times.
* @param log Returns measured data of the mechanism motors during test routines. To return
* data, call `motor(string motorName)` on the supplied `SysIdRoutineLog` instance, and then
* call one or more of the chainable logging handles (e.g. `voltage`) on the returned
* `MotorLog`. Multiple motors can be logged in a single callback by calling `motor`
* multiple times.
* @param subsystem The subsystem containing the motor(s) that is (or are) being characterized.
* Will be declared as a requirement for the returned test commands. The subsystem's `name`
* will be appended to the log entry title for the routine's test state, e.g.