|
WPILibC++
2020.3.2
|
Luminary Micro / Vex Robotics Jaguar Speed Controller with PWM control. More...
#include <Jaguar.h>
Public Member Functions | |
| Jaguar (int channel) | |
| Constructor for a Jaguar connected via PWM. More... | |
| Jaguar (Jaguar &&)=default | |
| Jaguar & | operator= (Jaguar &&)=default |
Public Member Functions inherited from frc::PWMSpeedController | |
| PWMSpeedController (PWMSpeedController &&)=default | |
| PWMSpeedController & | operator= (PWMSpeedController &&)=default |
| void | Set (double value) override |
| Set the PWM value. More... | |
| double | Get () const override |
| Get the recently set value of the PWM. More... | |
| void | SetInverted (bool isInverted) override |
| Common interface for inverting direction of a speed controller. More... | |
| bool | GetInverted () const override |
| Common interface for returning the inversion state of a speed controller. More... | |
| void | Disable () override |
| Common interface for disabling a motor. | |
| void | StopMotor () override |
| Common interface to stop the motor until Set is called again. | |
| void | PIDWrite (double output) override |
| Write out the PID value as seen in the PIDOutput base object. More... | |
Public Member Functions inherited from frc::PWM | |
| PWM (int channel) | |
| Allocate a PWM given a channel number. More... | |
| ~PWM () override | |
| Free the PWM channel. More... | |
| PWM (PWM &&)=default | |
| PWM & | operator= (PWM &&)=default |
| void | StopMotor () override |
| void | GetDescription (wpi::raw_ostream &desc) const override |
| virtual void | SetRaw (uint16_t value) |
| Set the PWM value directly to the hardware. More... | |
| virtual uint16_t | GetRaw () const |
| Get the PWM value directly from the hardware. More... | |
| virtual void | SetPosition (double pos) |
| Set the PWM value based on a position. More... | |
| virtual double | GetPosition () const |
| Get the PWM value in terms of a position. More... | |
| virtual void | SetSpeed (double speed) |
| Set the PWM value based on a speed. More... | |
| virtual double | GetSpeed () const |
| Get the PWM value in terms of speed. More... | |
| virtual void | SetDisabled () |
| Temporarily disables the PWM output. More... | |
| void | SetPeriodMultiplier (PeriodMultiplier mult) |
| Slow down the PWM signal for old devices. More... | |
| void | SetZeroLatch () |
| void | EnableDeadbandElimination (bool eliminateDeadband) |
| Optionally eliminate the deadband from a speed controller. More... | |
| void | SetBounds (double max, double deadbandMax, double center, double deadbandMin, double min) |
| Set the bounds on the PWM pulse widths. More... | |
| void | SetRawBounds (int max, int deadbandMax, int center, int deadbandMin, int min) |
| Set the bounds on the PWM values. More... | |
| void | GetRawBounds (int32_t *max, int32_t *deadbandMax, int32_t *center, int32_t *deadbandMin, int32_t *min) |
| Get the bounds on the PWM values. More... | |
| int | GetChannel () const |
Public Member Functions inherited from frc::MotorSafety | |
| MotorSafety (MotorSafety &&rhs) | |
| MotorSafety & | operator= (MotorSafety &&rhs) |
| void | Feed () |
| Feed the motor safety object. More... | |
| void | SetExpiration (double expirationTime) |
| Set the expiration time for the corresponding motor safety object. More... | |
| double | GetExpiration () const |
| Retrieve the timeout value for the corresponding motor safety object. More... | |
| bool | IsAlive () const |
| Determine if the motor is still operating or has timed out. More... | |
| void | SetSafetyEnabled (bool enabled) |
| Enable/disable motor safety for this device. More... | |
| bool | IsSafetyEnabled () const |
| Return the state of the motor safety enabled flag. More... | |
| void | Check () |
| Check if this motor has exceeded its timeout. More... | |
Public Member Functions inherited from frc::ErrorBase | |
| ErrorBase (const ErrorBase &)=default | |
| ErrorBase & | operator= (const ErrorBase &)=default |
| ErrorBase (ErrorBase &&)=default | |
| ErrorBase & | operator= (ErrorBase &&)=default |
| virtual Error & | GetError () |
| Retrieve the current error. More... | |
| virtual const Error & | GetError () const |
| Retrieve the current error. More... | |
| virtual void | ClearError () const |
| Clear the current error information associated with this sensor. | |
| virtual void | SetErrnoError (const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const |
| Set error information associated with a C library call that set an error to the "errno" global variable. More... | |
| virtual void | SetImaqError (int success, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const |
| Set the current error information associated from the nivision Imaq API. More... | |
| virtual void | SetError (Error::Code code, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const |
| Set the current error information associated with this sensor. More... | |
| virtual void | SetErrorRange (Error::Code code, int32_t minRange, int32_t maxRange, int32_t requestedValue, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const |
| Set the current error information associated with this sensor. More... | |
| virtual void | SetWPIError (const wpi::Twine &errorMessage, Error::Code code, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const |
| Set the current error information associated with this sensor. More... | |
| virtual void | CloneError (const ErrorBase &rhs) const |
| virtual bool | StatusIsFatal () const |
| Check if the current error code represents a fatal error. More... | |
| void | ClearGlobalErrors () |
| Clear global errors. | |
Public Member Functions inherited from frc::SendableHelper< PWM > | |
| SendableHelper (const SendableHelper &rhs)=default | |
| SendableHelper (SendableHelper &&rhs) | |
| SendableHelper & | operator= (const SendableHelper &rhs)=default |
| SendableHelper & | operator= (SendableHelper &&rhs) |
| std::string | GetName () const |
| Gets the name of this Sendable object. More... | |
| void | SetName (const wpi::Twine &name) |
| Sets the name of this Sendable object. More... | |
| void | SetName (const wpi::Twine &subsystem, const wpi::Twine &name) |
| Sets both the subsystem name and device name of this Sendable object. More... | |
| std::string | GetSubsystem () const |
| Gets the subsystem name of this Sendable object. More... | |
| void | SetSubsystem (const wpi::Twine &subsystem) |
| Sets the subsystem name of this Sendable object. More... | |
Public Member Functions inherited from frc::SpeedController | |
| virtual void | SetVoltage (units::volt_t output) |
| Sets the voltage output of the SpeedController. More... | |
Additional Inherited Members | |
Public Types inherited from frc::PWM | |
| enum | PeriodMultiplier { kPeriodMultiplier_1X = 1, kPeriodMultiplier_2X = 2, kPeriodMultiplier_4X = 4 } |
| Represents the amount to multiply the minimum servo-pulse pwm period by. More... | |
Static Public Member Functions inherited from frc::MotorSafety | |
| static void | CheckMotors () |
| Check the motors to see if any have timed out. More... | |
Static Public Member Functions inherited from frc::ErrorBase | |
| static void | SetGlobalError (Error::Code code, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) |
| static void | SetGlobalWPIError (const wpi::Twine &errorMessage, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) |
| static Error | GetGlobalError () |
| Retrieve the last global error. | |
| static std::vector< Error > | GetGlobalErrors () |
| Retrieve all global errors. | |
Protected Member Functions inherited from frc::PWMSpeedController | |
| PWMSpeedController (int channel) | |
| Constructor for a PWM Speed Controller connected via PWM. More... | |
| void | InitSendable (SendableBuilder &builder) override |
| Initializes this Sendable object. More... | |
Protected Member Functions inherited from frc::PWM | |
| void | InitSendable (SendableBuilder &builder) override |
| Initializes this Sendable object. More... | |
Protected Member Functions inherited from frc::SendableHelper< PWM > | |
| void | SetName (const wpi::Twine &moduleType, int channel) |
| Sets the name of the sensor with a channel number. More... | |
| void | SetName (const wpi::Twine &moduleType, int moduleNumber, int channel) |
| Sets the name of the sensor with a module and channel number. More... | |
| void | AddChild (std::shared_ptr< Sendable > child) |
| Add a child component. More... | |
| void | AddChild (void *child) |
| Add a child component. More... | |
Protected Attributes inherited from frc::ErrorBase | |
| Error | m_error |
Luminary Micro / Vex Robotics Jaguar Speed Controller with PWM control.
Note that the Jaguar 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 Jaguar User Manual available from Vex.
|
explicit |