mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-28 02:11:43 +00:00
8f1f64ffb6
Also update copyright to include "and other WPILib contributors" and clarify license referral language to not be restricted to FIRST teams.
94 lines
2.3 KiB
C++
94 lines
2.3 KiB
C++
// Copyright (c) FIRST and other WPILib contributors.
|
|
// Open Source Software; you can modify and/or share it under the terms of
|
|
// the WPILib BSD license file in the root directory of this project.
|
|
|
|
#pragma once
|
|
|
|
#include <memory>
|
|
|
|
#include <wpi/ArrayRef.h>
|
|
#include <wpi/raw_ostream.h>
|
|
|
|
#include "frc/MotorSafety.h"
|
|
|
|
namespace frc {
|
|
|
|
class SpeedController;
|
|
|
|
/**
|
|
* Common base class for drive platforms.
|
|
*/
|
|
class RobotDriveBase : public MotorSafety {
|
|
public:
|
|
/**
|
|
* The location of a motor on the robot for the purpose of driving.
|
|
*/
|
|
enum MotorType {
|
|
kFrontLeft = 0,
|
|
kFrontRight = 1,
|
|
kRearLeft = 2,
|
|
kRearRight = 3,
|
|
kLeft = 0,
|
|
kRight = 1,
|
|
kBack = 2
|
|
};
|
|
|
|
RobotDriveBase();
|
|
~RobotDriveBase() override = default;
|
|
|
|
RobotDriveBase(RobotDriveBase&&) = default;
|
|
RobotDriveBase& operator=(RobotDriveBase&&) = default;
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
void SetDeadband(double deadband);
|
|
|
|
/**
|
|
* Configure the scaling factor for using RobotDrive with motor controllers in
|
|
* a mode other than PercentVbus or to limit the maximum output.
|
|
*
|
|
* @param maxOutput Multiplied with the output percentage computed by the
|
|
* drive functions.
|
|
*/
|
|
void SetMaxOutput(double maxOutput);
|
|
|
|
/**
|
|
* Feed the motor safety object. Resets the timer that will stop the motors if
|
|
* it completes.
|
|
*
|
|
* @see MotorSafetyHelper::Feed()
|
|
*/
|
|
void FeedWatchdog();
|
|
|
|
void StopMotor() override = 0;
|
|
void GetDescription(wpi::raw_ostream& desc) const override = 0;
|
|
|
|
protected:
|
|
/**
|
|
* Returns 0.0 if the given value is within the specified range around zero.
|
|
* The remaining range between the deadband and 1.0 is scaled from 0.0 to 1.0.
|
|
*
|
|
* @param value value to clip
|
|
* @param deadband range around zero
|
|
*/
|
|
double ApplyDeadband(double number, double deadband);
|
|
|
|
/**
|
|
* Normalize all wheel speeds if the magnitude of any wheel is greater than
|
|
* 1.0.
|
|
*/
|
|
void Normalize(wpi::MutableArrayRef<double> wheelSpeeds);
|
|
|
|
double m_deadband = 0.02;
|
|
double m_maxOutput = 1.0;
|
|
};
|
|
|
|
} // namespace frc
|