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

[wpilib] Replace Speed controller comments with motor controller (NFC) (#3551)

Browse Source 
Makes comments consistent with #3302
This commit is contained in:
sciencewhiz
2021-09-08 22:09:08 -07:00
committed by GitHub
parent 7810f665f1
commit 5a4f75c9f8
10 changed files with 19 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
wpilibc/src/main/native/include/frc/PWM.h
View File

@@ -122,7 +122,7 @@ class PWM : public wpi::Sendable, public wpi::SendableHelper<PWM> {
/**
* Set the PWM value based on a speed.
*
* This is intended to be used by speed controllers.
* This is intended to be used by motor controllers.
*
* @pre SetMaxPositivePwm() called.
* @pre SetMinPositivePwm() called.
@@ -130,14 +130,14 @@ class PWM : public wpi::Sendable, public wpi::SendableHelper<PWM> {
* @pre SetMaxNegativePwm() called.
* @pre SetMinNegativePwm() called.
*
* @param speed The speed to set the speed controller between -1.0 and 1.0.
* @param speed The speed to set the motor controller between -1.0 and 1.0.
*/
virtual void SetSpeed(double speed);
/**
* Get the PWM value in terms of speed.
*
* This is intended to be used by speed controllers.
* This is intended to be used by motor controllers.
*
* @pre SetMaxPositivePwm() called.
* @pre SetMinPositivePwm() called.
@@ -164,7 +164,7 @@ class PWM : public wpi::Sendable, public wpi::SendableHelper<PWM> {
void SetZeroLatch();
/**
* Optionally eliminate the deadband from a speed controller.
* Optionally eliminate the deadband from a motor controller.
*
* @param eliminateDeadband If true, set the motor curve on the speed
* controller to eliminate the deadband in the middle

4
wpilibc/src/main/native/include/frc/drive/MecanumDrive.h
View File

@@ -60,8 +60,8 @@ class SpeedController;
* with SetDeadband().
*
* RobotDrive porting guide:
* <br>In MecanumDrive, the right side speed controllers are automatically
* inverted, while in RobotDrive, no speed controllers are automatically
* <br>In MecanumDrive, the right side motor controllers are automatically
* inverted, while in RobotDrive, no motor controllers are automatically
* inverted.
* <br>DriveCartesian(double, double, double, double) is equivalent to
* RobotDrive's MecanumDrive_Cartesian(double, double, double, double)

2
wpilibc/src/main/native/include/frc/shuffleboard/BuiltInWidgets.h
View File

@@ -201,7 +201,7 @@ enum class BuiltInWidgets {
kEncoder,
/**
* Displays a MotorController.
* The speed controller will be controllable from the dashboard when test mode
* The motor controller will be controllable from the dashboard when test mode
* is enabled, but will otherwise be view-only. <br>Supported types: <ul>
* <li>PWMMotorController</li>
* <li>DMC60</li>

2
wpilibc/src/main/native/include/frc/shuffleboard/Shuffleboard.h
View File

@@ -96,7 +96,7 @@ class Shuffleboard final {
static void SelectTab(std::string_view title);
/**
* Enables user control of widgets containing actuators: speed controllers,
* Enables user control of widgets containing actuators: motor controllers,
* relays, etc. This should only be used when the robot is in test mode.
* IterativeRobotBase and SampleRobot are both configured to call this method
* when entering test mode; most users should not need to use this method