mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-07-04 03:11:43 +00:00
Remove comments and small things from repo that mention roboRIO (#9020)
The RoboRIO classes need to be fixed up, those are huge.
This commit is contained in:
@@ -55,7 +55,7 @@ public class CANAPIJNI extends JNIWrapper {
|
||||
*
|
||||
* <p>This ID is 10 bits.
|
||||
*
|
||||
* <p>The RoboRIO will automatically repeat the packet at the specified interval
|
||||
* <p>The Systemcore will automatically repeat the packet at the specified interval
|
||||
*
|
||||
* @param handle the CAN handle
|
||||
* @param apiId the ID to write (0-1023)
|
||||
@@ -105,7 +105,7 @@ public class CANAPIJNI extends JNIWrapper {
|
||||
*
|
||||
* <p>This ID is 10 bits.
|
||||
*
|
||||
* <p>The RoboRIO will automatically repeat the packet at the specified interval
|
||||
* <p>The Systemcore will automatically repeat the packet at the specified interval
|
||||
*
|
||||
* @param handle the CAN handle
|
||||
* @param apiId the ID to write (0-1023)
|
||||
|
||||
@@ -32,15 +32,15 @@ public final class HALUtil extends JNIWrapper {
|
||||
public static final int RUNTIME_SIMULATION = 1;
|
||||
|
||||
/**
|
||||
* Returns the roboRIO serial number.
|
||||
* Returns the Systemcore serial number.
|
||||
*
|
||||
* @return The roboRIO serial number.
|
||||
* @return The Systemcore serial number.
|
||||
* @see "HAL_GetSerialNumber"
|
||||
*/
|
||||
public static native String getSerialNumber();
|
||||
|
||||
/**
|
||||
* Returns the comments from the roboRIO web interface.
|
||||
* Returns the comments from the Systemcore web interface.
|
||||
*
|
||||
* @return The comments string.
|
||||
* @see "HAL_GetComments"
|
||||
|
||||
@@ -11,7 +11,7 @@ package org.wpilib.hardware.hal;
|
||||
*/
|
||||
public class PowerJNI extends JNIWrapper {
|
||||
/**
|
||||
* Gets the roboRIO input voltage.
|
||||
* Gets the Systemcore input voltage.
|
||||
*
|
||||
* @return the input voltage (volts)
|
||||
* @see "HAL_GetVinVoltage"
|
||||
@@ -61,9 +61,7 @@ public class PowerJNI extends JNIWrapper {
|
||||
public static native void resetUserCurrentFaults();
|
||||
|
||||
/**
|
||||
* Set the voltage the roboRIO will brownout and disable all outputs.
|
||||
*
|
||||
* <p>Note that this only does anything on the roboRIO 2. On the roboRIO it is a no-op.
|
||||
* Set the voltage the Systemcore will brownout and disable all outputs.
|
||||
*
|
||||
* @param voltage The brownout voltage
|
||||
* @see "HAL_SetBrownoutVoltage"
|
||||
|
||||
@@ -26,7 +26,7 @@ public class SerialPortJNI extends JNIWrapper {
|
||||
* Initializes a serial port with a direct name.
|
||||
*
|
||||
* <p>This name is the /dev name for a specific port. Note these are not always consistent between
|
||||
* roboRIO reboots.
|
||||
* Systemcore reboots.
|
||||
*
|
||||
* @param port the serial port to initialize
|
||||
* @param portName the dev port name
|
||||
|
||||
@@ -57,14 +57,15 @@ const char* HAL_GetLastError(HAL_Status* status);
|
||||
const char* HAL_GetErrorMessage(int32_t code);
|
||||
|
||||
/**
|
||||
* Returns the roboRIO serial number.
|
||||
* Returns the Systemcore serial number.
|
||||
*
|
||||
* @param[out] serialNumber The roboRIO serial number. Free with WPI_FreeString
|
||||
* @param[out] serialNumber The Systemcore serial number. Free with
|
||||
* WPI_FreeString
|
||||
*/
|
||||
void HAL_GetSerialNumber(struct WPI_String* serialNumber);
|
||||
|
||||
/**
|
||||
* Returns the comments from the roboRIO web interface.
|
||||
* Returns the comments from the Systemcore web interface.
|
||||
*
|
||||
* @param[out] comments The comments string. Free with WPI_FreeString
|
||||
*/
|
||||
|
||||
@@ -19,7 +19,7 @@ extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* Gets the roboRIO input voltage.
|
||||
* Gets the Systemcore input voltage.
|
||||
*
|
||||
* @param[out] status the error code, or 0 for success
|
||||
* @return the input voltage (volts)
|
||||
@@ -81,10 +81,7 @@ void HAL_ResetUserCurrentFaults(int32_t* status);
|
||||
double HAL_GetBrownoutVoltage(int32_t* status);
|
||||
|
||||
/**
|
||||
* Set the voltage the roboRIO will brownout and disable all outputs.
|
||||
*
|
||||
* Note that this only does anything on the roboRIO 2.
|
||||
* On the roboRIO it is a no-op.
|
||||
* Set the voltage the Systemcore will brownout and disable all outputs.
|
||||
*
|
||||
* @param[in] voltage The brownout voltage
|
||||
* @param[out] status the error code, or 0 for success
|
||||
|
||||
@@ -42,7 +42,7 @@ HAL_SerialPortHandle HAL_InitializeSerialPort(HAL_SerialPort port,
|
||||
* Initializes a serial port with a direct name.
|
||||
*
|
||||
* This name is the /dev name for a specific port.
|
||||
* Note these are not always consistent between roboRIO reboots.
|
||||
* Note these are not always consistent between Systemcore reboots.
|
||||
*
|
||||
* @param[in] port the serial port to initialize
|
||||
* @param[in] portName the dev port name
|
||||
|
||||
@@ -115,7 +115,7 @@ static inline bool isHandleType(HAL_Handle handle, HAL_HandleEnum handleType) {
|
||||
/**
|
||||
* Get if the version of the handle is correct.
|
||||
*
|
||||
* Do not use on the roboRIO, used specifically for the sim to handle resets.
|
||||
* Do not use on the Systemcore, used specifically for the sim to handle resets.
|
||||
*
|
||||
* @param handle the handle
|
||||
* @param version the handle version to check
|
||||
@@ -128,7 +128,7 @@ static inline bool isHandleCorrectVersion(HAL_Handle handle, int16_t version) {
|
||||
/**
|
||||
* Get if the handle is a correct type and version.
|
||||
*
|
||||
* Note the version is not checked on the roboRIO.
|
||||
* Note the version is not checked on the Systemcore.
|
||||
*
|
||||
* @param handle the handle
|
||||
* @param enumType the type to check
|
||||
@@ -161,7 +161,7 @@ inline int16_t getHandleTypedIndex(HAL_Handle handle, HAL_HandleEnum enumType,
|
||||
/**
|
||||
* Create a handle for a specific index, type and version.
|
||||
*
|
||||
* Note the version is not checked on the roboRIO.
|
||||
* Note the version is not checked on the Systemcore.
|
||||
*
|
||||
* @param index the index
|
||||
* @param handleType the handle type
|
||||
|
||||
Reference in New Issue
Block a user