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

Made documentation for RobotDriveBase::SetDeadband() clearer (#953)

Browse Source 
It now mentions that the deadband is applied to the drive inputs.
This commit is contained in:
Tyler Veness
2018-03-03 01:57:59 -08:00
committed by Peter Johnson
parent 67de595c85
commit 7bb3e4efc3
2 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
wpilibc/src/main/native/cpp/Drive/RobotDriveBase.cpp
View File

@@ -21,9 +21,11 @@ using namespace frc;
RobotDriveBase::RobotDriveBase() { m_safetyHelper.SetSafetyEnabled(true); }
/**
* Change the default value for deadband scaling. The default value is
* 0.02. Values smaller then the deadband are set to 0, while values
* larger then the deadband are scaled from 0.0 to 1.0. See ApplyDeadband().
* Sets the deadband applied to the drive inputs (e.g., joystick values).
*
* The default value is 0.02. Inputs smaller than the deadband are set to 0.0
* while inputs larger than the deadband are scaled from 0.0 to 1.0. See
* ApplyDeadband().
*
* @param deadband The deadband to set.
*/