WPILibC++
unspecified
|
A safe version of the PWM class. More...
#include <SafePWM.h>
Public Member Functions | |
SafePWM (int channel) | |
Constructor for a SafePWM object taking a channel number. More... | |
void | SetExpiration (double timeout) |
Set the expiration time for the PWM object. More... | |
double | GetExpiration () const |
Return the expiration time for the PWM object. More... | |
bool | IsAlive () const |
Check if the PWM object is currently alive or stopped due to a timeout. More... | |
void | StopMotor () |
Stop the motor associated with this PWM object. More... | |
bool | IsSafetyEnabled () const |
Check if motor safety is enabled for this object. More... | |
void | SetSafetyEnabled (bool enabled) |
Enable/disable motor safety for this device. More... | |
void | GetDescription (llvm::raw_ostream &desc) const |
virtual void | SetSpeed (double speed) |
Feed the MotorSafety timer when setting the speed. More... | |
![]() | |
PWM (int channel) | |
Allocate a PWM given a channel number. More... | |
virtual | ~PWM () |
Free the PWM channel. More... | |
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 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 |
![]() | |
SensorBase (const SensorBase &)=delete | |
SensorBase & | operator= (const SensorBase &)=delete |
![]() | |
ErrorBase (const ErrorBase &)=delete | |
ErrorBase & | operator= (const ErrorBase &)=delete |
virtual Error & | GetError () |
Retrieve the current error. More... | |
virtual const Error & | GetError () const |
virtual void | SetErrnoError (llvm::StringRef contextMessage, llvm::StringRef filename, llvm::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, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber) const |
Set the current error information associated from the nivision Imaq API. More... | |
virtual void | SetError (Error::Code code, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::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, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber) const |
Set the current error information associated with this sensor. More... | |
virtual void | SetWPIError (llvm::StringRef errorMessage, Error::Code code, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber) const |
Set the current error information associated with this sensor. More... | |
virtual void | CloneError (const ErrorBase &rhs) const |
virtual void | ClearError () const |
Clear the current error information associated with this sensor. | |
virtual bool | StatusIsFatal () const |
Check if the current error code represents a fatal error. More... | |
Additional Inherited Members | |
![]() | |
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 int | GetDefaultSolenoidModule () |
static bool | CheckSolenoidModule (int moduleNumber) |
Check that the solenoid module number is valid. More... | |
static bool | CheckDigitalChannel (int channel) |
Check that the digital channel number is valid. More... | |
static bool | CheckRelayChannel (int channel) |
Check that the relay channel number is valid. More... | |
static bool | CheckPWMChannel (int channel) |
Check that the digital channel number is valid. More... | |
static bool | CheckAnalogInputChannel (int channel) |
Check that the analog input number is value. More... | |
static bool | CheckAnalogOutputChannel (int channel) |
Check that the analog output number is valid. More... | |
static bool | CheckSolenoidChannel (int channel) |
Verify that the solenoid channel number is within limits. More... | |
static bool | CheckPDPChannel (int channel) |
Verify that the power distribution channel number is within limits. More... | |
![]() | |
static void | SetGlobalError (Error::Code code, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber) |
static void | SetGlobalWPIError (llvm::StringRef errorMessage, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber) |
static Error & | GetGlobalError () |
Retrieve the current global error. | |
![]() | |
static const int | kDigitalChannels = HAL_GetNumDigitalChannels() |
static const int | kAnalogInputs = HAL_GetNumAnalogInputs() |
static const int | kAnalogOutputs |
static const int | kSolenoidChannels = HAL_GetNumSolenoidChannels() |
static const int | kSolenoidModules = HAL_GetNumPCMModules() |
static const int | kPwmChannels = HAL_GetNumPWMChannels() |
static const int | kRelayChannels = HAL_GetNumRelayHeaders() |
static const int | kPDPChannels = HAL_GetNumPDPChannels() |
![]() | |
void | UpdateTable () override |
Update the table for this sendable object with the latest values. | |
void | StartLiveWindowMode () override |
Start having this sendable object automatically respond to value changes reflect the value on the table. | |
void | StopLiveWindowMode () override |
Stop having this sendable object automatically respond to value changes. | |
std::string | GetSmartDashboardType () const override |
void | InitTable (std::shared_ptr< nt::NetworkTable > subTable) override |
Initializes a table for this sendable object. More... | |
![]() | |
nt::NetworkTableEntry | m_valueEntry |
NT_EntryListener | m_valueListener = 0 |
![]() | |
Error | m_error |
![]() | |
static std::mutex | _globalErrorMutex |
static Error | _globalError |
A safe version of the PWM class.
It is safe because it implements the MotorSafety interface that provides timeouts in the event that the motor value is not updated before the expiration time. This delegates the actual work to a MotorSafetyHelper object that is used for all objects that implement MotorSafety.
|
explicit |
|
virtual |
Return the expiration time for the PWM object.
Implements frc::MotorSafety.
|
virtual |
Check if the PWM object is currently alive or stopped due to a timeout.
Implements frc::MotorSafety.
|
virtual |
Check if motor safety is enabled for this object.
Implements frc::MotorSafety.
|
virtual |
Set the expiration time for the PWM object.
timeout | The timeout (in seconds) for this motor object |
Implements frc::MotorSafety.
|
virtual |
Enable/disable motor safety for this device.
Turn on and off the motor safety option for this PWM object.
enabled | True if motor safety is enforced for this object |
Implements frc::MotorSafety.
|
virtual |
Feed the MotorSafety timer when setting the speed.
This method is called by the subclass motor whenever it updates its speed, thereby reseting the timeout value.
speed | Value to pass to the PWM class |
Reimplemented from frc::PWM.
|
virtual |
Stop the motor associated with this PWM object.
This is called by the MotorSafetyHelper object when it has a timeout for this PWM and needs to stop it from running.
Implements frc::MotorSafety.