From b8269b607b45903aa223fad070e0c0caee087ea6 Mon Sep 17 00:00:00 2001 From: Will Xu Date: Tue, 8 Aug 2023 20:02:42 -0400 Subject: [PATCH] Clarify Rotation Sensor Angle/Position Docs --- v5/api/c/rotation.rst | 8 ++++++-- v5/api/cpp/rotation.rst | 8 ++++++-- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/v5/api/c/rotation.rst b/v5/api/c/rotation.rst index 0e2b3958..45121dd4 100644 --- a/v5/api/c/rotation.rst +++ b/v5/api/c/rotation.rst @@ -149,7 +149,9 @@ Analogous to `pros::Rotation::reset_position <../cpp/rotation.html#reset-positio rotation_get_position --------------------- -Get the Rotation Sensor's current position in centidegrees +Get the Rotation Sensor's current angle in centidegrees (0-36000). This means the absolute position +of the sensor in relation to its position when initialized or reset. The value will continue to increment or decrement +as the sensor rotates past 36000 centidegrees. This function uses the following values of ``errno`` when an error state is reached: @@ -234,7 +236,9 @@ Analogous to `pros::Rotation::get_velocity <../cpp/rotation.html#get-velocity>`_ rotation_get_angle ------------------ -Get the Rotation Sensor's current angle in centidegrees (0-36000) +Get the Rotation Sensor's current position in centidegrees. This means the absolute position +of the sensor in relation to its position when initialized or reset. The value is continuous, +meaning it will wrap around to zero after it passes 36000 centidegrees. This function uses the following values of ``errno`` when an error state is reached: diff --git a/v5/api/cpp/rotation.rst b/v5/api/cpp/rotation.rst index f29b1d40..97b44478 100644 --- a/v5/api/cpp/rotation.rst +++ b/v5/api/cpp/rotation.rst @@ -241,7 +241,9 @@ This function uses the following values of ``errno`` when an error state is reac get_position ~~~~~~~~~~~~ -Get the Rotation Sensor's current position in centidegrees +Get the Rotation Sensor's current angle in centidegrees (0-36000). This means the absolute position +of the sensor in relation to its position when initialized or reset. The value will continue to increment or decrement +as the sensor rotates past 36000 centidegrees. This function uses the following values of ``errno`` when an error state is reached: @@ -323,7 +325,9 @@ This function uses the following values of ``errno`` when an error state is reac get_angle ~~~~~~~~~ -Get the Rotation Sensor's current angle in centidegrees (0-36000) +Get the Rotation Sensor's current position in centidegrees. This means the absolute position +of the sensor in relation to its position when initialized or reset. The value is continuous, +meaning it will wrap around to zero after it passes 36000 centidegrees. This function uses the following values of ``errno`` when an error state is reached: