CTRE_Phoenix 5.20.2
com.ctre.phoenix.sensors.WPI_CANCoder Class Reference

Inherits com.ctre.phoenix.sensors.CANCoder, Sendable, and AutoCloseable.

Public Member Functions

 WPI_CANCoder (int deviceNumber, String canbus)
 
 WPI_CANCoder (int deviceNumber)
 
void close ()
 
void initSendable (SendableBuilder builder)
 
- Public Member Functions inherited from com.ctre.phoenix.sensors.CANCoder
 CANCoder (int deviceNumber, String canbus)
 
 CANCoder (int deviceNumber)
 
ErrorCode DestroyObject ()
 
int getDeviceID ()
 
CANCoderSimCollection getSimCollection ()
 
double getPosition ()
 
ErrorCode setPosition (double newPosition, int timeoutMs)
 
ErrorCode setPosition (double newPosition)
 
ErrorCode setPositionToAbsolute (int timeoutMs)
 
ErrorCode setPositionToAbsolute ()
 
double getVelocity ()
 
double getAbsolutePosition ()
 
ErrorCode configVelocityMeasurementPeriod (SensorVelocityMeasPeriod period, int timeoutMs)
 
ErrorCode configVelocityMeasurementPeriod (SensorVelocityMeasPeriod period)
 
ErrorCode configVelocityMeasurementWindow (int windowSize, int timeoutMs)
 
ErrorCode configVelocityMeasurementWindow (int windowSize)
 
ErrorCode configAbsoluteSensorRange (AbsoluteSensorRange absoluteSensorRange, int timeoutMs)
 
ErrorCode configAbsoluteSensorRange (AbsoluteSensorRange absoluteSensorRange)
 
ErrorCode configMagnetOffset (double offsetDegrees, int timeoutMs)
 
ErrorCode configMagnetOffset (double offsetDegrees)
 
ErrorCode configSensorInitializationStrategy (SensorInitializationStrategy initializationStrategy, int timeoutMs)
 
ErrorCode configSensorInitializationStrategy (SensorInitializationStrategy initializationStrategy)
 
ErrorCode configFeedbackCoefficient (double sensorCoefficient, String unitString, SensorTimeBase sensorTimeBase, int timeoutMs)
 
ErrorCode configFeedbackCoefficient (double sensorCoefficient, String unitString, SensorTimeBase sensorTimeBase)
 
double getBusVoltage ()
 
MagnetFieldStrength getMagnetFieldStrength ()
 
ErrorCode configSensorDirection (boolean bSensorDirection, int timeoutMs)
 
ErrorCode configSensorDirection (boolean bSensorDirection)
 
ErrorCode getLastError ()
 
String getLastUnitString ()
 
double getLastTimestamp ()
 
ErrorCode configSetCustomParam (int newValue, int paramIndex, int timeoutMs)
 
ErrorCode configSetCustomParam (int newValue, int paramIndex)
 
int configGetCustomParam (int paramIndex, int timeoutMs)
 
int configGetCustomParam (int paramIndex)
 
ErrorCode configSetParameter (ParamEnum param, double value, int subValue, int ordinal, int timeoutMs)
 
ErrorCode configSetParameter (ParamEnum param, double value, int subValue, int ordinal)
 
double configGetParameter (ParamEnum param, int ordinal, int timeoutMs)
 
double configGetParameter (ParamEnum param, int ordinal)
 
ErrorCode setStatusFramePeriod (CANCoderStatusFrame statusFrame, int periodMs, int timeoutMs)
 
ErrorCode setStatusFramePeriod (CANCoderStatusFrame statusFrame, int periodMs)
 
int getStatusFramePeriod (CANCoderStatusFrame frame, int timeoutMs)
 
int getStatusFramePeriod (CANCoderStatusFrame frame)
 
int getFirmwareVersion ()
 
boolean hasResetOccurred ()
 
ErrorCode getFaults (CANCoderFaults toFill)
 
ErrorCode getStickyFaults (CANCoderStickyFaults toFill)
 
ErrorCode clearStickyFaults (int timeoutMs)
 
ErrorCode clearStickyFaults ()
 
SensorVelocityMeasPeriod configGetVelocityMeasurementPeriod (int timeoutMs)
 
SensorVelocityMeasPeriod configGetVelocityMeasurementPeriod ()
 
int configGetVelocityMeasurementWindow (int timeoutMs)
 
int configGetVelocityMeasurementWindow ()
 
AbsoluteSensorRange configGetAbsoluteSensorRange (int timeoutMs)
 
AbsoluteSensorRange configGetAbsoluteSensorRange ()
 
double configGetMagnetOffset (int timeoutMs)
 
double configGetMagnetOffset ()
 
boolean configGetSensorDirection (int timeoutMs)
 
boolean configGetSensorDirection ()
 
SensorInitializationStrategy configGetSensorInitializationStrategy (int timeoutMs)
 
SensorInitializationStrategy configGetSensorInitializationStrategy ()
 
double configGetFeedbackCoefficient (int timeoutMs)
 
double configGetFeedbackCoefficient ()
 
String configGetFeedbackUnitString (int timeoutMs)
 
String configGetFeedbackUnitString ()
 
SensorTimeBase configGetFeedbackTimeBase (int timeoutMs)
 
SensorTimeBase configGetFeedbackTimeBase ()
 
ErrorCode configAllSettings (CANCoderConfiguration allConfigs, int timeoutMs)
 
ErrorCode configAllSettings (CANCoderConfiguration allConfigs)
 
void getAllConfigs (CANCoderConfiguration allConfigs, int timeoutMs)
 
void getAllConfigs (CANCoderConfiguration allConfigs)
 
ErrorCode configFactoryDefault (int timeoutMs)
 
ErrorCode configFactoryDefault ()
 

Constructor & Destructor Documentation

◆ WPI_CANCoder() [1/2]

com.ctre.phoenix.sensors.WPI_CANCoder.WPI_CANCoder ( int  deviceNumber,
String  canbus 
)
inline

Constructor for CANCoder

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

◆ WPI_CANCoder() [2/2]

com.ctre.phoenix.sensors.WPI_CANCoder.WPI_CANCoder ( int  deviceNumber)
inline

Constructor for CANCoder

Parameters
deviceNumberdevice ID of CANCoder

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