Package swervelib.encoders

Class SparkMaxAnalogEncoderSwerve

java.lang.Object

swervelib.encoders.SwerveAbsoluteEncoder

swervelib.encoders.SparkMaxAnalogEncoderSwerve

All Implemented Interfaces:

AutoCloseable

public class SparkMaxAnalogEncoderSwerve
extends SwerveAbsoluteEncoder

SparkMax absolute encoder, attached through the data port analog pin.

Field Summary

Fields

Modifier and Type	Field	Description
SparkAnalogSensor	encoder	The SparkAnalogSensor representing the duty cycle encoder attached to the SparkMax analog port.

Fields inherited from class swervelib.encoders.SwerveAbsoluteEncoder

maximumRetries, readingError

Constructor Summary

Constructors

Constructor	Description
SparkMaxAnalogEncoderSwerve(SwerveMotor motor, double maxVoltage)	Create the SparkMaxAnalogEncoderSwerve object as a analog sensor from the SparkMax motor data port analog pin.

Method Summary

Modifier and Type	Method	Description
void	clearStickyFaults()	Clear sticky faults on the encoder.
void	close()
void	configure(boolean inverted)	Configure the absolute encoder to read from [0, 360) per second.
void	factoryDefault()	Reset the encoder to factory defaults.
Object	getAbsoluteEncoder()	Get the instantiated absolute encoder Object.
double	getAbsolutePosition()	Get the absolute position of the encoder.
double	getVelocity()	Get the velocity in degrees/sec.
boolean	setAbsoluteEncoderOffset(double offset)	Sets the Absolute Encoder offset at the Encoder Level.
void	setConversionFactor(double conversionFactor)	Set the conversion factor of the SparkMaxAnalogEncoderSwerve.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

encoder

public SparkAnalogSensor encoder

The SparkAnalogSensor representing the duty cycle encoder attached to the SparkMax analog port.

Constructor Details

SparkMaxAnalogEncoderSwerve

public SparkMaxAnalogEncoderSwerve(SwerveMotor motor,
 double maxVoltage)

Create the SparkMaxAnalogEncoderSwerve object as a analog sensor from the SparkMax motor data port analog pin.

Parameters:

motor - Motor to create the encoder from.

maxVoltage - Maximum voltage for analog input reading.

Method Details

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in class SwerveAbsoluteEncoder

setConversionFactor

public void setConversionFactor(double conversionFactor)

Set the conversion factor of the SparkMaxAnalogEncoderSwerve.

Parameters:

conversionFactor - Position conversion factor from ticks to unit.

factoryDefault

public void factoryDefault()

Reset the encoder to factory defaults.

Specified by:

factoryDefault in class SwerveAbsoluteEncoder

clearStickyFaults

public void clearStickyFaults()

Clear sticky faults on the encoder.

Specified by:

clearStickyFaults in class SwerveAbsoluteEncoder

configure

public void configure(boolean inverted)

Configure the absolute encoder to read from [0, 360) per second.

Specified by:

configure in class SwerveAbsoluteEncoder

Parameters:

inverted - Whether the encoder is inverted.

getAbsolutePosition

public double getAbsolutePosition()

Get the absolute position of the encoder.

Specified by:

getAbsolutePosition in class SwerveAbsoluteEncoder

Returns:

Absolute position in degrees from [0, 360).

getAbsoluteEncoder

public Object getAbsoluteEncoder()

Get the instantiated absolute encoder Object.

Specified by:

getAbsoluteEncoder in class SwerveAbsoluteEncoder

Returns:

Absolute encoder object.

setAbsoluteEncoderOffset

public boolean setAbsoluteEncoderOffset(double offset)

Sets the Absolute Encoder offset at the Encoder Level.

Specified by:

setAbsoluteEncoderOffset in class SwerveAbsoluteEncoder

Parameters:

offset - the offset the Absolute Encoder uses as the zero point.

Returns:

if setting Absolute Encoder Offset was successful or not.

getVelocity

public double getVelocity()

Get the velocity in degrees/sec.

Specified by:

getVelocity in class SwerveAbsoluteEncoder

Returns:

velocity in degrees/sec.