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

Merge "Updated some comments that mention the cRIO"

Browse Source
This commit is contained in:
Jonathan Leitschuh (WPI)
2014-08-05 10:18:25 -07:00
committed by Gerrit Code Review
parent ed08ab2989 9ff420547a
commit 765198f5f5
8 changed files with 49 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
wpilibc/wpilibC++/include/Preferences.h
View File

@@ -16,10 +16,10 @@
/**
* The preferences class provides a relatively simple way to save important values to
* the cRIO to access the next time the cRIO is booted.
* the RoboRIO to access the next time the RoboRIO is booted.
*
* <p>This class loads and saves from a file
* inside the cRIO. The user can not access the file directly, but may modify values at specific
* inside the RoboRIO. The user can not access the file directly, but may modify values at specific
* fields which will then be saved to the file when {@link Preferences#Save() Save()} is called.</p>
*
* <p>This class is thread safe.</p>

7
wpilibc/wpilibC++/include/SerialPort.h
View File

@@ -9,12 +9,12 @@
#include "HAL/HAL.hpp"
/**
* Driver for the RS-232 serial port on the cRIO.
*
* Driver for the RS-232 serial port on the RoboRIO.
*
* The current implementation uses the VISA formatted I/O mode. This means that
* all traffic goes through the fomatted buffers. This allows the intermingled
* use of Printf(), Scanf(), and the raw buffer accessors Read() and Write().
*
*
* More information can be found in the NI-VISA User Manual here:
* http://www.ni.com/pdf/manuals/370423a.pdf
* and the NI-VISA Programmer's Reference Manual here:
@@ -53,4 +53,3 @@ private:
DISALLOW_COPY_AND_ASSIGN(SerialPort);
};

4
wpilibc/wpilibC++/lib/Preferences.cpp
View File

@@ -308,10 +308,10 @@ void Preferences::PutLong(const char *key, int64_t value)
}
/**
* Saves the preferences to a file on the cRIO.
* Saves the preferences to a file on the RoboRIO.
*
* <p>This should <b>NOT</b> be called often.
* Too many writes can damage the cRIO's flash memory.
* Too many writes can damage the RoboRIO's flash memory.
* While it is ok to save once or twice a match, this should never
* be called every run of {@link IterativeRobot#TeleopPeriodic()}, etc.</p>
*

57
wpilibc/wpilibC++/lib/SerialPort.cpp
View File

@@ -14,8 +14,8 @@
/**
* Create an instance of a Serial Port class.
*
* @param baudRate The baud rate to configure the serial port. The cRIO-9074 supports up to 230400 Baud.
*
* @param baudRate The baud rate to configure the serial port.
* @param dataBits The number of data bits per transfer. Valid values are between 5 and 8 bits.
* @param parity Select the type of parity checking to use.
* @param stopBits The number of stop bits to use as defined by the enum StopBits.
@@ -75,7 +75,7 @@ SerialPort::~SerialPort()
/**
* Set the type of flow control to enable on this port.
*
*
* By default, flow control is disabled.
*/
void SerialPort::SetFlowControl(SerialPort::FlowControl flowControl)
@@ -89,18 +89,18 @@ void SerialPort::SetFlowControl(SerialPort::FlowControl flowControl)
/**
* Enable termination and specify the termination character.
*
*
* Termination is currently only implemented for receive.
* When the the terminator is recieved, the Read() or Scanf() will return
* fewer bytes than requested, stopping after the terminator.
*
*
* @param terminator The character to use for termination.
*/
void SerialPort::EnableTermination(char terminator)
{
if (!m_consoleModeEnabled)
{
viSetAttribute(m_portHandle, VI_ATTR_TERMCHAR_EN, VI_TRUE);
viSetAttribute(m_portHandle, VI_ATTR_TERMCHAR_EN, VI_TRUE);
viSetAttribute(m_portHandle, VI_ATTR_TERMCHAR, terminator);
viSetAttribute(m_portHandle, VI_ATTR_ASRL_END_IN, VI_ASRL_END_TERMCHAR);
}
@@ -113,14 +113,14 @@ void SerialPort::DisableTermination()
{
if (!m_consoleModeEnabled)
{
viSetAttribute(m_portHandle, VI_ATTR_TERMCHAR_EN, VI_FALSE);
viSetAttribute(m_portHandle, VI_ATTR_TERMCHAR_EN, VI_FALSE);
viSetAttribute(m_portHandle, VI_ATTR_ASRL_END_IN, VI_ASRL_END_NONE);
}
}
/**
* Get the number of bytes currently available to read from the serial port.
*
*
* @return The number of bytes available to read.
*/
int32_t SerialPort::GetBytesReceived()
@@ -136,9 +136,9 @@ int32_t SerialPort::GetBytesReceived()
/**
* Output formatted text to the serial port.
*
*
* @bug All pointer-based parameters seem to return an error.
*
*
* @param writeFmt A string that defines the format of the output.
*/
void SerialPort::Printf(const char *writeFmt, ...)
@@ -155,9 +155,9 @@ void SerialPort::Printf(const char *writeFmt, ...)
/**
* Input formatted text from the serial port.
*
*
* @bug All pointer-based parameters seem to return an error.
*
*
* @param readFmt A string that defines the format of the input.
*/
void SerialPort::Scanf(const char *readFmt, ...)
@@ -174,11 +174,11 @@ void SerialPort::Scanf(const char *readFmt, ...)
/**
* Read raw bytes out of the buffer.
*
*
* @param buffer Pointer to the buffer to store the bytes in.
* @param count The maximum number of bytes to read.
* @return The number of bytes actually read into the buffer.
*/
*/
uint32_t SerialPort::Read(char *buffer, int32_t count)
{
uint32_t retCount = 0;
@@ -200,11 +200,11 @@ uint32_t SerialPort::Read(char *buffer, int32_t count)
/**
* Write raw bytes to the buffer.
*
*
* @param buffer Pointer to the buffer to read the bytes from.
* @param count The maximum number of bytes to write.
* @return The number of bytes actually written into the port.
*/
*/
uint32_t SerialPort::Write(const char *buffer, int32_t count)
{
uint32_t retCount = 0;
@@ -218,10 +218,10 @@ uint32_t SerialPort::Write(const char *buffer, int32_t count)
/**
* Configure the timeout of the serial port.
*
*
* This defines the timeout for transactions with the hardware.
* It will affect reads and very large writes.
*
*
* @param timeout The number of seconds to to wait for I/O.
*/
void SerialPort::SetTimeout(float timeout)
@@ -235,14 +235,14 @@ void SerialPort::SetTimeout(float timeout)
/**
* Specify the size of the input buffer.
*
*
* Specify the amount of data that can be stored before data
* from the device is returned to Read or Scanf. If you want
* data that is recieved to be returned immediately, set this to 1.
*
*
* It the buffer is not filled before the read timeout expires, all
* data that has been received so far will be returned.
*
*
* @param size The read buffer size.
*/
void SerialPort::SetReadBufferSize(uint32_t size)
@@ -256,10 +256,10 @@ void SerialPort::SetReadBufferSize(uint32_t size)
/**
* Specify the size of the output buffer.
*
*
* Specify the amount of data that can be stored before being
* transmitted to the device.
*
*
* @param size The write buffer size.
*/
void SerialPort::SetWriteBufferSize(uint32_t size)
@@ -273,13 +273,13 @@ void SerialPort::SetWriteBufferSize(uint32_t size)
/**
* Specify the flushing behavior of the output buffer.
*
*
* When set to kFlushOnAccess, data is synchronously written to the serial port
* after each call to either Printf() or Write().
*
*
* When set to kFlushWhenFull, data will only be written to the serial port when
* the buffer is full or when Flush() is called.
*
*
* @param mode The write buffer mode.
*/
void SerialPort::SetWriteBufferMode(SerialPort::WriteBufferMode mode)
@@ -293,7 +293,7 @@ void SerialPort::SetWriteBufferMode(SerialPort::WriteBufferMode mode)
/**
* Force the output buffer to be written to the port.
*
*
* This is used when SetWriteBufferMode() is set to kFlushWhenFull to force a
* flush before the buffer is full.
*/
@@ -308,7 +308,7 @@ void SerialPort::Flush()
/**
* Reset the serial port driver to a known state.
*
*
* Empty the transmit and receive buffers in the device and formatted I/O.
*/
void SerialPort::Reset()
@@ -329,4 +329,3 @@ void SerialPort::Reset()
// ((SerialPort*) userHandle)->_internalHandler(vi, eventType, event);
// return VI_SUCCESS;
//}

16
wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/Preferences.java
View File

@@ -23,9 +23,9 @@ import edu.wpi.first.wpilibj.tables.ITableListener;
/**
* The preferences class provides a relatively simple way to save important
* values to the cRIO to access the next time the cRIO is booted.
* values to the RoboRIO to access the next time the RoboRIO is booted.
*
* <p>This class loads and saves from a file inside the cRIO. The user can not
* <p>This class loads and saves from a file inside the RoboRIO. The user can not
* access the file directly, but may modify values at specific fields which will
* then be saved to the file when {@link Preferences#save() save()} is
* called.</p>
@@ -457,10 +457,10 @@ public class Preferences {
}
/**
* Saves the preferences to a file on the cRIO.
* Saves the preferences to a file on the RoboRIO.
*
* <p>This should <b>NOT</b> be called often. Too many writes can damage the
* cRIO's flash memory. While it is ok to save once or twice a match, this
* RoboRIO's flash memory. While it is ok to save once or twice a match, this
* should never be called every run of
* {@link IterativeRobot#teleopPeriodic()}.</p>
*
@@ -499,9 +499,9 @@ public class Preferences {
if (file.exists())
file.delete();
file.createNewFile();
output = new FileOutputStream(file);
for (int i = 0; i < keys.size(); i++) {
@@ -585,8 +585,8 @@ public class Preferences {
Comment comment = null;
File file = null;
FileInputStream input = null;
try {

1
wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/SensorBase.java
View File

@@ -76,7 +76,6 @@ public abstract class SensorBase { // TODO: Refactor
/**
* Verify that the solenoid module is correct.
* Module numbers are 1 or 2 (they are no longer real cRIO slots).
*
* @param moduleNumber The solenoid module module number to check.
*/

10
wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/SerialPort.java
View File

@@ -12,7 +12,7 @@ import edu.wpi.first.wpilibj.visa.Visa;
import edu.wpi.first.wpilibj.visa.VisaException;
/**
* Driver for the RS-232 serial port on the cRIO.
* Driver for the RS-232 serial port on the RoboRIO.
*
* The current implementation uses the VISA formatted I/O mode. This means that
* all traffic goes through the formatted buffers. This allows the intermingled
@@ -161,7 +161,7 @@ public class SerialPort {
/**
* Create an instance of a Serial Port class.
*
* @param baudRate The baud rate to configure the serial port. The cRIO-9074 supports up to 230400 Baud.
* @param baudRate The baud rate to configure the serial port.
* @param dataBits The number of data bits per transfer. Valid values are between 5 and 8 bits.
* @param parity Select the type of parity checking to use.
* @param stopBits The number of stop bits to use as defined by the enum StopBits.
@@ -203,7 +203,7 @@ public class SerialPort {
/**
* Create an instance of a Serial Port class. Defaults to one stop bit.
*
* @param baudRate The baud rate to configure the serial port. The cRIO-9074 supports up to 230400 Baud.
* @param baudRate The baud rate to configure the serial port.
* @param dataBits The number of data bits per transfer. Valid values are between 5 and 8 bits.
* @param parity Select the type of parity checking to use.
*/
@@ -215,7 +215,7 @@ public class SerialPort {
* Create an instance of a Serial Port class. Defaults to no parity and one
* stop bit.
*
* @param baudRate The baud rate to configure the serial port. The cRIO-9074 supports up to 230400 Baud.
* @param baudRate The baud rate to configure the serial port.
* @param dataBits The number of data bits per transfer. Valid values are between 5 and 8 bits.
*/
public SerialPort(final int baudRate, final int dataBits) throws VisaException {
@@ -226,7 +226,7 @@ public class SerialPort {
* Create an instance of a Serial Port class. Defaults to 8 databits,
* no parity, and one stop bit.
*
* @param baudRate The baud rate to configure the serial port. The cRIO-9074 supports up to 230400 Baud.
* @param baudRate The baud rate to configure the serial port.
*/
public SerialPort(final int baudRate) throws VisaException {
this(baudRate, 8, Parity.kNone, StopBits.kOne);

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

@@ -1153,7 +1153,7 @@ public class NIVision {
}
/**
* Set true to be able to create files on cRio
* Set true to be able to create files on RoboRIO
* @param val true allows files to be created
*/
public static void setWriteFileAllowed(boolean val) {