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

[docs] Fix brownout docs (NFC) (#3638)

Browse Source
This commit is contained in:
sciencewhiz
2021-10-14 07:28:21 -07:00
committed by GitHub
parent 67df469c58
commit 05e5feac41
3 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
hal/src/main/native/include/hal/Power.h
View File

@@ -117,19 +117,19 @@ HAL_Bool HAL_GetUserActive3V3(int32_t* status);
int32_t HAL_GetUserCurrentFaults3V3(int32_t* status);
/**
* Get the current brownout voltage seting.
*
* Note that this only does anything on the roboRIO 2.
* On the roboRIO it is a no-op.
* Get the current brownout voltage setting.
*
* @return The brownout voltage
*/
double HAL_GetBrownoutVoltage(int32_t* status);
/**
* Set the voltage the roborio will brownout and disable all outputs.
* Set the voltage the roboRIO will brownout and disable all outputs.
*
* @param brownoutVoltage The brownout voltage
* Note that this only does anything on the roboRIO 2.
* On the roboRIO it is a no-op.
*
* @param voltage The brownout voltage
*/
void HAL_SetBrownoutVoltage(double voltage, int32_t* status);

4
wpilibc/src/main/native/include/frc/RobotController.h
View File

@@ -189,14 +189,14 @@ class RobotController {
static int GetFaultCount6V();
/**
* Get the current brownout voltage seting.
* Get the current brownout voltage setting.
*
* @return The brownout voltage
*/
static units::volt_t GetBrownoutVoltage();
/**
* Set the voltage the roborio will brownout and disable all outputs.
* 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.

4
wpilibj/src/main/java/edu/wpi/first/wpilibj/RobotController.java
View File

@@ -214,7 +214,7 @@ public final class RobotController {
}
/**
* Get the current brownout voltage seting.
* Get the current brownout voltage setting.
*
* @return The brownout voltage
*/
@@ -223,7 +223,7 @@ public final class RobotController {
}
/**
* Set the voltage the roborio will brownout and disable all outputs.
* 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.
*