Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-07-04 03:11:43 +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

17
wpilibc/src/main/native/include/frc/VictorSP.h
View File

@@ -1,5 +1,5 @@
/*----------------------------------------------------------------------------*/
/* Copyright (c) 2008-2018 FIRST. All Rights Reserved. */
/* Copyright (c) 2008-2019 FIRST. All Rights Reserved. */
/* Open Source Software - may be modified and shared by FRC teams. The code */
/* must be accompanied by the FIRST BSD license file in the root directory of */
/* the project. */
@@ -13,11 +13,24 @@ namespace frc {
/**
* Vex Robotics Victor SP Speed Controller.
*
* Note that the Victor SP 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 Victor SP User
* Manual available from Vex.
*
* \li 2.004ms = full "forward"
* \li 1.520ms = the "high end" of the deadband range
* \li 1.500ms = center of the deadband range (off)
* \li 1.480ms = the "low end" of the deadband range
* \li 0.997ms = full "reverse"
*/
class VictorSP : public PWMSpeedController {
public:
/**
* Constructor for a VictorSP.
* Constructor for a Victor SP.
*
* @param channel The PWM channel that the VictorSP is attached to. 0-9 are
* on-board, 10-19 are on the MXP port