From edcf6c8e9175b53a134d830255041fa758e5e357 Mon Sep 17 00:00:00 2001 From: sciencewhiz Date: Wed, 15 Feb 2023 20:25:12 -0800 Subject: [PATCH] [wpilib] PneumaticHub: Document range of enableCompressorAnalog (NFC) (#5099) --- wpilibc/src/main/native/include/frc/PneumaticHub.h | 10 ++++++---- .../main/java/edu/wpi/first/wpilibj/PneumaticHub.java | 9 +++++---- 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/wpilibc/src/main/native/include/frc/PneumaticHub.h b/wpilibc/src/main/native/include/frc/PneumaticHub.h index f876b7afc9b..b69b3d5cd11 100644 --- a/wpilibc/src/main/native/include/frc/PneumaticHub.h +++ b/wpilibc/src/main/native/include/frc/PneumaticHub.h @@ -46,9 +46,10 @@ class PneumaticHub : public PneumaticsBase { * and will turn off when the pressure reaches {@code maxPressure}. * * @param minPressure The minimum pressure. The compressor will turn on when - * the pressure drops below this value. + * the pressure drops below this value. Range 0 - 120 PSI. * @param maxPressure The maximum pressure. The compressor will turn off when - * the pressure reaches this value. + * the pressure reaches this value. Range 0 - 120 PSI. Must be larger then + * minPressure. */ void EnableCompressorAnalog( units::pounds_per_square_inch_t minPressure, @@ -74,10 +75,11 @@ class PneumaticHub : public PneumaticsBase { * * @param minPressure The minimum pressure. The compressor will turn on when * the pressure drops below this value and the pressure switch indicates that - * the system is not full. + * the system is not full. Range 0 - 120 PSI. * @param maxPressure The maximum pressure. The compressor will turn off when * the pressure reaches this value or the pressure switch is disconnected or - * indicates that the system is full. + * indicates that the system is full. Range 0 - 120 PSI. Must be larger then + * minPressure. */ void EnableCompressorHybrid( units::pounds_per_square_inch_t minPressure, diff --git a/wpilibj/src/main/java/edu/wpi/first/wpilibj/PneumaticHub.java b/wpilibj/src/main/java/edu/wpi/first/wpilibj/PneumaticHub.java index ff49b4ab51c..7b675f596ab 100644 --- a/wpilibj/src/main/java/edu/wpi/first/wpilibj/PneumaticHub.java +++ b/wpilibj/src/main/java/edu/wpi/first/wpilibj/PneumaticHub.java @@ -277,9 +277,9 @@ public void enableCompressorDigital() { * below {@code minPressure} and will turn off when the pressure reaches {@code maxPressure}. * * @param minPressure The minimum pressure in PSI. The compressor will turn on when the pressure - * drops below this value. + * drops below this value. Range 0-120 PSI. * @param maxPressure The maximum pressure in PSI. The compressor will turn off when the pressure - * reaches this value. + * reaches this value. Range 0-120 PSI. Must be larger then minPressure. */ @Override public void enableCompressorAnalog(double minPressure, double maxPressure) { @@ -320,10 +320,11 @@ public void enableCompressorAnalog(double minPressure, double maxPressure) { * * * @param minPressure The minimum pressure in PSI. The compressor will turn on when the pressure - * drops below this value and the pressure switch indicates that the system is not full. + * drops below this value and the pressure switch indicates that the system is not full. Range + * 0-120 PSI. * @param maxPressure The maximum pressure in PSI. The compressor will turn off when the pressure * reaches this value or the pressure switch is disconnected or indicates that the system is - * full. + * full. Range 0-120 PSI. Must be larger then minPressure. */ @Override public void enableCompressorHybrid(double minPressure, double maxPressure) {