CTRE_Phoenix 5.20.2
ctre::phoenix::sensors::WPI_CANCoder Class Reference

Inherits ctre::phoenix::sensors::CANCoder, wpi::Sendable, and wpi::SendableHelper< WPI_CANCoder >.

Public Member Functions

 WPI_CANCoder (int deviceNumber, std::string const &canbus="")
 
 WPI_CANCoder (WPI_CANCoder const &)=delete
 
WPI_CANCoderoperator= (WPI_CANCoder const &)=delete
 
void InitSendable (wpi::SendableBuilder &builder) override
 
- Public Member Functions inherited from ctre::phoenix::sensors::CANCoder
 CANCoder (int deviceNumber, std::string const &canbus="")
 
double GetPosition ()
 
double GetVelocity ()
 
ErrorCode SetPosition (double newPosition, int timeoutMs=0)
 
ErrorCode SetPositionToAbsolute (int timeoutMs=0)
 
double GetAbsolutePosition ()
 
ErrorCode ConfigVelocityMeasurementPeriod (SensorVelocityMeasPeriod period, int timeoutMs=0)
 
ErrorCode ConfigVelocityMeasurementWindow (int windowSize, int timeoutMs=0)
 
ErrorCode ConfigAbsoluteSensorRange (ctre::phoenix::sensors::AbsoluteSensorRange absoluteSensorRange, int timeoutMs=0)
 
ErrorCode ConfigMagnetOffset (double offsetDegrees, int timeoutMs=0)
 
ErrorCode ConfigSensorInitializationStrategy (ctre::phoenix::sensors::SensorInitializationStrategy initializationStrategy, int timeoutMs=0)
 
ErrorCode ConfigFeedbackCoefficient (double sensorCoefficient, const std::string &unitString, ctre::phoenix::sensors::SensorTimeBase sensortimeBase, int timeoutMs=0)
 
double GetBusVoltage ()
 
ctre::phoenix::sensors::MagnetFieldStrength GetMagnetFieldStrength ()
 
ErrorCode ConfigSensorDirection (bool bSensorDirection, int timeoutMs=0)
 
ErrorCode GetLastError ()
 
std::string GetLastUnitString ()
 
double GetLastTimestamp ()
 
ErrorCode ConfigSetCustomParam (int newValue, int paramIndex, int timeoutMs=0)
 
int ConfigGetCustomParam (int paramIndex, int timeoutMs=0)
 
ErrorCode ConfigSetParameter (ParamEnum param, double value, uint8_t subValue, int ordinal, int timeoutMs=0)
 
double ConfigGetParameter (ParamEnum param, int ordinal, int timeoutMs=0)
 
ErrorCode ConfigGetParameter (ParamEnum param, int32_t valueToSend, int32_t &valueReceived, uint8_t &subValue, int32_t ordinal, int32_t timeoutMs)
 
ErrorCode SetStatusFramePeriod (CANCoderStatusFrame statusFrame, uint8_t periodMs, int timeoutMs=0)
 
int GetStatusFramePeriod (CANCoderStatusFrame frame, int timeoutMs=0)
 
int GetFirmwareVersion ()
 
bool HasResetOccurred ()
 
ErrorCode GetFaults (CANCoderFaults &toFill)
 
ErrorCode GetStickyFaults (CANCoderStickyFaults &toFill)
 
ErrorCode ClearStickyFaults (int timeoutMs=0)
 
ctre::phoenix::ErrorCode ConfigAllSettings (const CANCoderConfiguration &allConfigs, int timeoutMs=50)
 
ErrorCode GetAllConfigs (CANCoderConfiguration &allConfigs, int timeoutMs=50)
 
ErrorCode ConfigFactoryDefault (int timeoutMs=50)
 
CANCoderSimCollectionGetSimCollection ()
 
- Public Member Functions inherited from ctre::phoenix::CANBusAddressable
 CANBusAddressable (int deviceNumber)
 
int GetDeviceNumber ()
 

Additional Inherited Members

- Static Public Member Functions inherited from ctre::phoenix::sensors::CANCoder
static void DestroyAllCANCoders ()
 

Constructor & Destructor Documentation

◆ WPI_CANCoder()

ctre::phoenix::sensors::WPI_CANCoder::WPI_CANCoder ( int  deviceNumber,
std::string const &  canbus = "" 
)

Construtor for CANCoder.

Parameters
deviceNumberCAN Device ID of the CANCoder.
canbusName of the CANbus; can be a CANivore device name or serial number. Pass in nothing or "rio" to use the roboRIO.

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