WPILibC++  2019.3.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
frc::Servo Class Reference

Standard hobby style servo. More...

#include <Servo.h>

Inheritance diagram for frc::Servo:
frc::PWM frc::MotorSafety frc::SendableBase frc::ErrorBase frc::Sendable

Public Member Functions

 Servo (int channel)
 
 Servo (Servo &&)=default
 
Servooperator= (Servo &&)=default
 
void Set (double value)
 Set the servo position. More...
 
void SetOffline ()
 Set the servo to offline. More...
 
double Get () const
 Get the servo position. More...
 
void SetAngle (double angle)
 Set the servo angle. More...
 
double GetAngle () const
 Get the servo angle. More...
 
double GetMaxAngle () const
 Get the maximum angle of the servo. More...
 
double GetMinAngle () const
 Get the minimum angle of the servo. More...
 
void InitSendable (SendableBuilder &builder) override
 Initializes this Sendable 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 &&rhs)
 
PWMoperator= (PWM &&rhs)
 
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)
 
MotorSafetyoperator= (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 (ErrorBase &&)=default
 
ErrorBaseoperator= (ErrorBase &&)=default
 
virtual ErrorGetError ()
 Retrieve the current error. More...
 
virtual const ErrorGetError () 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...
 
- Public Member Functions inherited from frc::SendableBase
 SendableBase (bool addLiveWindow=true)
 Creates an instance of the sensor base. More...
 
 SendableBase (SendableBase &&rhs)
 
SendableBaseoperator= (SendableBase &&rhs)
 
std::string GetName () const final
 Gets the name of this Sendable object. More...
 
void SetName (const wpi::Twine &name) final
 Sets the name of this Sendable object. More...
 
std::string GetSubsystem () const final
 Gets the subsystem name of this Sendable object. More...
 
void SetSubsystem (const wpi::Twine &subsystem) final
 Sets the subsystem name of this Sendable object. More...
 
- Public Member Functions inherited from frc::Sendable
 Sendable (Sendable &&)=default
 
Sendableoperator= (Sendable &&)=default
 
void SetName (const wpi::Twine &subsystem, const wpi::Twine &name)
 Sets both the subsystem name and device name of this Sendable object. 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 const ErrorGetGlobalError ()
 Retrieve the current global error.
 
- Protected Member Functions inherited from frc::PWM
void InitSendable (SendableBuilder &builder) override
 Initializes this Sendable object. More...
 
- Protected Member Functions inherited from frc::SendableBase
void AddChild (std::shared_ptr< Sendable > child)
 Add a child component. More...
 
void AddChild (void *child)
 Add a child component. More...
 
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...
 
- Protected Attributes inherited from frc::ErrorBase
Error m_error
 

Detailed Description

Standard hobby style servo.

The range parameters default to the appropriate values for the Hitec HS-322HD servo provided in the FIRST Kit of Parts in 2008.

Constructor & Destructor Documentation

frc::Servo::Servo ( int  channel)
explicit
Parameters
channelThe PWM channel to which the servo is attached. 0-9 are on-board, 10-19 are on the MXP port

Member Function Documentation

double frc::Servo::Get ( ) const

Get the servo position.

Servo values range from 0.0 to 1.0 corresponding to the range of full left to full right.

Returns
Position from 0.0 to 1.0.
double frc::Servo::GetAngle ( ) const

Get the servo angle.

Assume that the servo angle is linear with respect to the PWM value (big assumption, need to test).

Returns
The angle in degrees to which the servo is set.
double frc::Servo::GetMaxAngle ( ) const

Get the maximum angle of the servo.

Returns
The maximum angle of the servo in degrees.
double frc::Servo::GetMinAngle ( ) const

Get the minimum angle of the servo.

Returns
The minimum angle of the servo in degrees.
void frc::Servo::InitSendable ( SendableBuilder builder)
overridevirtual

Initializes this Sendable object.

Parameters
buildersendable builder

Implements frc::Sendable.

void frc::Servo::Set ( double  value)

Set the servo position.

Servo values range from 0.0 to 1.0 corresponding to the range of full left to full right.

Parameters
valuePosition from 0.0 to 1.0.
void frc::Servo::SetAngle ( double  angle)

Set the servo angle.

Assume that the servo angle is linear with respect to the PWM value (big assumption, need to test).

Servo angles that are out of the supported range of the servo simply "saturate" in that direction. In other words, if the servo has a range of (X degrees to Y degrees) than angles of less than X result in an angle of X being set and angles of more than Y degrees result in an angle of Y being set.

Parameters
degreesThe angle in degrees to set the servo.
void frc::Servo::SetOffline ( )

Set the servo to offline.

Set the servo raw value to 0 (undriven)


The documentation for this class was generated from the following file: