diff --git a/wpilibc/src/main/native/include/interfaces/Gyro.h b/wpilibc/src/main/native/include/interfaces/Gyro.h index 11ba3f6aee..507b61d0de 100644 --- a/wpilibc/src/main/native/include/interfaces/Gyro.h +++ b/wpilibc/src/main/native/include/interfaces/Gyro.h @@ -42,6 +42,10 @@ class Gyro { * allows algorithms that wouldn't want to see a discontinuity in the gyro * output as it sweeps past from 360 to 0 on the second time around. * + * The angle is expected to increase as the gyro turns clockwise when looked + * at from the top. It needs to follow NED axis conventions in order to work + * properly with dependent control loops. + * * @return the current heading of the robot in degrees. This heading is based * on integration of the returned rate from the gyro. */ @@ -52,6 +56,10 @@ class Gyro { * * The rate is based on the most recent reading of the gyro analog value. * + * The rate is expected to be positive as the gyro turns clockwise when looked + * at from the top. It needs to follow NED axis conventions in order to work + * properly with dependent control loops. + * * @return the current rate in degrees per second */ virtual double GetRate() const = 0; diff --git a/wpilibj/src/main/java/edu/wpi/first/wpilibj/interfaces/Gyro.java b/wpilibj/src/main/java/edu/wpi/first/wpilibj/interfaces/Gyro.java index a752d6ed72..a8b2ab63d8 100644 --- a/wpilibj/src/main/java/edu/wpi/first/wpilibj/interfaces/Gyro.java +++ b/wpilibj/src/main/java/edu/wpi/first/wpilibj/interfaces/Gyro.java @@ -34,6 +34,10 @@ public interface Gyro extends AutoCloseable { * from 360 to 361 degrees. This allows algorithms that wouldn't want to see a discontinuity in * the gyro output as it sweeps past from 360 to 0 on the second time around. * + *

The angle is expected to increase as the gyro turns clockwise when looked + * at from the top. It needs to follow NED axis conventions in order to work + * properly with dependent control loops. + * *

This heading is based on integration of the returned rate from the gyro. * * @return the current heading of the robot in degrees. @@ -45,6 +49,10 @@ public interface Gyro extends AutoCloseable { * *

The rate is based on the most recent reading of the gyro analog value * + *

The rate is expected to be positive as the gyro turns clockwise when looked + * at from the top. It needs to follow NED axis conventions in order to work + * properly with dependent control loops. + * * @return the current rate in degrees per second */ double getRate();