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

Standardize documentation of Speed Controllers bounds (#2043)

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

19
wpilibc/src/main/native/include/frc/PWMSparkMax.h
View File

@@ -12,14 +12,27 @@
namespace frc {
/**
* REV Robotics SparkMax Speed Controller.
* REV Robotics SPARK MAX Speed Controller.
*
* Note that the SPARK MAX 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 SPARK MAX User
* Manual available from REV Robotics.
*
* \li 2.003ms = full "forward"
* \li 1.550ms = the "high end" of the deadband range
* \li 1.500ms = center of the deadband range (off)
* \li 1.460ms = the "low end" of the deadband range
* \li 0.999ms = full "reverse"
*/
class PWMSparkMax : public PWMSpeedController {
public:
/**
* Constructor for a SparkMax.
* Constructor for a SPARK MAX.
*
* @param channel The PWM channel that the Spark is attached to. 0-9 are
* @param channel The PWM channel that the SPARK MAX is attached to. 0-9 are
* on-board, 10-19 are on the MXP port
*/
explicit PWMSparkMax(int channel);