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

[wpilib] Update GetMatchTime docs and units (#5232)

Browse Source
This commit is contained in:
Thad House
2023-08-03 21:45:26 -07:00
committed by GitHub
parent 6db2c42966
commit d83a6edc20
7 changed files with 45 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
wpilibj/src/main/java/edu/wpi/first/wpilibj/DriverStation.java
View File

@@ -1183,8 +1183,17 @@ public final class DriverStation {
* Return the approximate match time. The FMS does not send an official match time to the robots,
* but does send an approximate match time. The value will count down the time remaining in the
* current period (auto or teleop). Warning: This is not an official time (so it cannot be used to
* dispute ref calls or guarantee that a function will trigger before the match ends) The Practice
* Match function of the DS approximates the behavior seen on the field.
* dispute ref calls or guarantee that a function will trigger before the match ends).
*
* <p>When connected to the real field, this number only changes in full integer increments, and
* always counts down.
*
* <p>When the DS is in practice mode, this number is a floating point number, and counts down.
*
* <p>When the DS is in teleop or autonomous mode, this number is a floating point number, and
* counts up.
*
* <p>Simulation matches DS behavior without an FMS connected.
*
* @return Time remaining in current match period (auto or teleop) in seconds
*/