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

[docs] Add warning about using user button to docs (NFC) (#6129)

Browse Source
This commit is contained in:
sciencewhiz
2024-01-01 11:53:21 -08:00
committed by GitHub
parent ec3cb3dcba
commit 7d3e4ddba9
4 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
hal/src/main/native/include/hal/HALBase.h
View File

@@ -110,6 +110,10 @@ HAL_RuntimeType HAL_GetRuntimeType(void);
/**
* Gets the state of the "USER" button on the roboRIO.
*
* @warning the User Button is used to stop user programs from automatically
* loading if it is held for more then 5 seconds. Because of this, it's not
* recommended to be used by teams for any other purpose.
*
* @param[out] status the error code, or 0 for success
* @return true if the button is currently pressed down
*/