Standardize documentation of Speed Controllers bounds (#2043)

Some were in constructor docs, some in init function docs, and some
inline in code. Move them all to class docs.
This commit is contained in:
sciencewhiz
2019-11-09 09:14:53 -08:00
committed by Peter Johnson
parent 9bcff37b93
commit 94843adb8f
30 changed files with 296 additions and 244 deletions

View File

@@ -14,19 +14,6 @@
using namespace frc;
Talon::Talon(int channel) : PWMSpeedController(channel) {
/* Note that the Talon uses the following bounds for PWM values. These values
* should work reasonably well for most controllers, but if users experience
* issues such as asymmetric behavior around the deadband or inability to
* saturate the controller in either direction, calibration is recommended.
* The calibration procedure can be found in the Talon User Manual available
* from CTRE.
*
* 2.037ms = full "forward"
* 1.539ms = the "high end" of the deadband range
* 1.513ms = center of the deadband range (off)
* 1.487ms = the "low end" of the deadband range
* 0.989ms = full "reverse"
*/
SetBounds(2.037, 1.539, 1.513, 1.487, .989);
SetPeriodMultiplier(kPeriodMultiplier_1X);
SetSpeed(0.0);