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). + *
When connected to the real field, this number only changes in full integer increments, and + * always counts down. * - *
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). + *
When the DS is in practice mode, this number is a floating point number, and counts down. * - *
The Practice Match function of the DS approximates the behavior seen on the field. + *
When the DS is in teleop or autonomous mode, this number returns -1.0. + * + *
Simulation matches DS behavior without an FMS connected. * * @return time remaining in current match period (auto or teleop) * @see "HAL_GetMatchTime" diff --git a/hal/src/main/native/include/hal/DriverStation.h b/hal/src/main/native/include/hal/DriverStation.h index 59270afae1..4fe5dcdcda 100644 --- a/hal/src/main/native/include/hal/DriverStation.h +++ b/hal/src/main/native/include/hal/DriverStation.h @@ -187,8 +187,7 @@ int32_t HAL_SetJoystickOutputs(int32_t joystickNum, int64_t outputs, *
When the DS is in practice mode, this number is a floating point number, * and counts down. * - *
When the DS is in teleop or autonomous mode, this number is a floating - * point number, and counts up. + *
When the DS is in teleop or autonomous mode, this number returns -1.0. * *
Simulation matches DS behavior without an FMS connected. * diff --git a/wpilibc/src/main/native/include/frc/DriverStation.h b/wpilibc/src/main/native/include/frc/DriverStation.h index b9b683f11b..97c4885270 100644 --- a/wpilibc/src/main/native/include/frc/DriverStation.h +++ b/wpilibc/src/main/native/include/frc/DriverStation.h @@ -339,8 +339,7 @@ class DriverStation final { *
When the DS is in practice mode, this number is a floating point number, * and counts down. * - *
When the DS is in teleop or autonomous mode, this number is a floating - * point number, and counts up. + *
When the DS is in teleop or autonomous mode, this number returns -1.0. * *
Simulation matches DS behavior without an FMS connected. * diff --git a/wpilibc/src/main/native/include/frc/Timer.h b/wpilibc/src/main/native/include/frc/Timer.h index b3bbfd3539..f058b4a578 100644 --- a/wpilibc/src/main/native/include/frc/Timer.h +++ b/wpilibc/src/main/native/include/frc/Timer.h @@ -139,19 +139,23 @@ class Timer { static units::second_t GetFPGATimestamp(); /** - * 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). - * + * 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. + *
When connected to the real field, this number only changes in full + * integer increments, and always counts down. * - * @return Time remaining in current match period (auto or teleop) + *
When the DS is in practice mode, this number is a floating point number, + * and counts down. + * + *
When the DS is in teleop or autonomous mode, this number returns -1.0. + * + *
Simulation matches DS behavior without an FMS connected. + * + * @return Time remaining in current match period (auto or teleop) in seconds */ static units::second_t GetMatchTime(); diff --git a/wpilibj/src/main/java/edu/wpi/first/wpilibj/DriverStation.java b/wpilibj/src/main/java/edu/wpi/first/wpilibj/DriverStation.java index befa01636c..607713abfe 100644 --- a/wpilibj/src/main/java/edu/wpi/first/wpilibj/DriverStation.java +++ b/wpilibj/src/main/java/edu/wpi/first/wpilibj/DriverStation.java @@ -1182,8 +1182,7 @@ public final class DriverStation { * *
When the DS is in practice mode, this number is a floating point number, and counts down. * - *
When the DS is in teleop or autonomous mode, this number is a floating point number, and - * counts up. + *
When the DS is in teleop or autonomous mode, this number returns -1.0. * *
Simulation matches DS behavior without an FMS connected. * diff --git a/wpilibj/src/main/java/edu/wpi/first/wpilibj/Timer.java b/wpilibj/src/main/java/edu/wpi/first/wpilibj/Timer.java index af55a43208..8f26a7a42b 100644 --- a/wpilibj/src/main/java/edu/wpi/first/wpilibj/Timer.java +++ b/wpilibj/src/main/java/edu/wpi/first/wpilibj/Timer.java @@ -40,8 +40,16 @@ public class Timer { * 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). + * + *
When connected to the real field, this number only changes in full integer increments, and + * always counts down. + * + *
When the DS is in practice mode, this number is a floating point number, and counts down. + * + *
When the DS is in teleop or autonomous mode, this number returns -1.0. + * + *
Simulation matches DS behavior without an FMS connected. * * @return Time remaining in current match period (auto or teleop) in seconds */