Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-23 01:21:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adds/Formats the CANJaguar.set() Javadocs

Browse Source 
Change-Id: I7e8735d9de336ba906b319b01eff4b2e88fb2a26
This commit is contained in:
Jonathan Leitschuh
2014-06-27 11:24:51 -04:00
parent 130485d760
commit 4de246876a
1 changed files with 21 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
wpilibj/wpilibJava/src/main/java/edu/wpi/first/wpilibj/CANJaguar.java
View File

@@ -245,15 +245,15 @@ public class CANJaguar implements MotorSafety, PIDOutput, SpeedController, LiveW
}
/**
* set the output set-point value.
*
* The scale and the units depend on the mode the Jaguar is in.
* In PercentVbus Mode, the outputValue is from -1.0 to 1.0 (same as PWM Jaguar).
* In Voltage Mode, the outputValue is in Volts.
* In Current Mode, the outputValue is in Amps.
* In Speed Mode, the outputValue is in Rotations/Minute.
* Sets the output set-point value.
*
* The scale and the units depend on the mode the Jaguar is in.<br>
* In PercentVbus Mode, the outputValue is from -1.0 to 1.0 (same as PWMJaguar).<br>
* In Voltage Mode, the outputValue is in Volts. <br>
* In Current Mode, the outputValue is in Amps. In Speed Mode, the outputValue is in
* Rotations/Minute.<br>
* In Position Mode, the outputValue is in Rotations.
*
*
* @param outputValue The set-point to sent to the motor controller.
* @param syncGroup The update group to add this set() to, pending UpdateSyncGroup(). If 0, update immediately.
*/
@@ -306,6 +306,19 @@ public class CANJaguar implements MotorSafety, PIDOutput, SpeedController, LiveW
verify();
}
/**
* Sets the output set-point value.
*
* The scale and the units depend on the mode the Jaguar is in.<br>
* In PercentVbus Mode, the outputValue is from -1.0 to 1.0 (same as PWMJaguar).<br>
* In Voltage Mode, the outputValue is in Volts. <br>
* In Current Mode, the outputValue is in Amps. In Speed Mode, the outputValue is in
* Rotations/Minute.<br>
* In Position Mode, the outputValue is in Rotations.
*
* @param value
* The set-point to sent to the motor controller.
*/
public void set(double value) {
set(value, (byte)0);
}