Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-07-02 02:51:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clean up misc documentation

Browse Source 
Change-Id: Ib0a4a7a389fb657d78d8b8bce4fcaeed67c3693d
This commit is contained in:
Joe Ross
2014-12-29 15:10:41 -08:00
parent 2d15b6b03e
commit d165f57e6e
5 changed files with 12 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
wpilibc/wpilibC++Devices/include/PWM.h
View File

@@ -17,7 +17,7 @@
* Changes are immediately sent to the FPGA, and the update occurs at the next
* FPGA cycle. There is no delay.
*
* As of revision 0.1.10 of the FPGA, the FPGA interprets the 0-255 values as follows:
* As of revision 0.1.10 of the FPGA, the FPGA interprets the 0-2000 values as follows:
* - 2000 = maximum pulse width
* - 1999 to 1001 = linear scaling from "full forward" to "center"
* - 1000 = center value

8
wpilibc/wpilibC++Devices/src/Gyro.cpp
View File

@@ -71,9 +71,10 @@ void Gyro::InitGyro()
}
/**
* Gyro constructor using the channel number.
* Gyro constructor using the Analog Input channel number.
*
* @param channel The analog channel the gyro is connected to. 0-3 are on-board, 4-7 are on the MXP.
* @param channel The analog channel the gyro is connected to. Gyros
can only be used on on-board Analog Inputs 0-1.
*/
Gyro::Gyro(int32_t channel)
{
@@ -85,7 +86,8 @@ Gyro::Gyro(int32_t channel)
/**
* Gyro constructor with a precreated AnalogInput object.
* Use this constructor when the analog channel needs to be shared.
* This object will not clean up the AnalogInput object when using this constructor
* This object will not clean up the AnalogInput object when using this constructor.
* Gyros can only be used on on-board channels 0-1.
* @param channel A pointer to the AnalogInput object that the gyro is connected to.
*/
Gyro::Gyro(AnalogInput *channel)

3
wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/DriverStation.java
View File

@@ -194,10 +194,9 @@ public class DriverStation implements RobotState.Interface {
}
/**
* Reports errors telated to unplugged joysticks
* Reports errors related to unplugged joysticks
* Throttles the errors so that they don't overwhelm the DS
*/
private void reportJoystickUnpluggedError(String message) {
double currentTime = Timer.getFPGATimestamp();
if (currentTime > m_nextMessageTime) {

6
wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/Gyro.java
View File

@@ -85,7 +85,8 @@ public class Gyro extends SensorBase implements PIDSource, LiveWindowSendable {
* Gyro constructor using the channel number
*
* @param channel
* The analog channel the gyro is connected to. 0-3 are on-board 4-7 are on the MXP port.
* The analog channel the gyro is connected to. Gyros can only
be used on on-board channels 0-1.
*/
public Gyro(int channel) {
this(new AnalogInput(channel));
@@ -97,7 +98,8 @@ public class Gyro extends SensorBase implements PIDSource, LiveWindowSendable {
* constructor when the analog channel needs to be shared.
*
* @param channel
* The AnalogInput object that the gyro is connected to.
* The AnalogInput object that the gyro is connected to. Gyros
can only be used on on-board channels 0-1.
*/
public Gyro(AnalogInput channel) {
m_analog = channel;

2
wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/PWM.java
View File

@@ -29,7 +29,7 @@ import edu.wpi.first.wpilibj.hal.HALUtil;
* Changes are immediately sent to the FPGA, and the update occurs at the next
* FPGA cycle. There is no delay.
*
* As of revision 0.1.10 of the FPGA, the FPGA interprets the 0-255 values as follows:
* As of revision 0.1.10 of the FPGA, the FPGA interprets the 0-2000 values as follows:
* - 2000 = maximum pulse width
* - 1999 to 1001 = linear scaling from "full forward" to "center"
* - 1000 = center value