Package swervelib.motors

Class SparkMaxBrushedMotorSwerve

java.lang.Object
swervelib.motors.SwerveMotor
swervelib.motors.SparkMaxBrushedMotorSwerve
All Implemented Interfaces:
AutoCloseable
public class SparkMaxBrushedMotorSwerve extends SwerveMotor
Brushed motor control with SparkMax.

  • Field Details

  • Constructor Details

    • SparkMaxBrushedMotorSwerve

      public SparkMaxBrushedMotorSwerve(SparkMax motor, boolean isDriveMotor, SparkMaxBrushedMotorSwerve.Type encoderType, int countsPerRevolution, boolean useDataPortQuadEncoder, DCMotor motorType)
      Initialize the swerve motor.
      Parameters:
      motor - The SwerveMotor as a SparkMax object.
      isDriveMotor - Is the motor being initialized a drive motor?
      encoderType - SparkMaxBrushedMotorSwerve.Type of encoder to use for the SparkMax device.
      countsPerRevolution - The number of encoder pulses for the SparkMaxBrushedMotorSwerve.Type encoder per revolution.
      useDataPortQuadEncoder - Use the encoder attached to the data port of the spark max for a quadrature encoder.
      motorType - DCMotor which the SparkMax is attached to.

    • SparkMaxBrushedMotorSwerve

      public SparkMaxBrushedMotorSwerve(int id, boolean isDriveMotor, SparkMaxBrushedMotorSwerve.Type encoderType, int countsPerRevolution, boolean useDataPortQuadEncoder, DCMotor motorType)
      Initialize the SwerveMotor as a SparkMax connected to a Brushless Motor.
      Parameters:
      id - CAN ID of the SparkMax.
      isDriveMotor - Is the motor being initialized a drive motor?
      encoderType - SparkMaxBrushedMotorSwerve.Type of encoder to use for the SparkMax device.
      countsPerRevolution - The number of encoder pulses for the SparkMaxBrushedMotorSwerve.Type encoder per revolution.
      useDataPortQuadEncoder - Use the encoder attached to the data port of the spark max for a quadrature encoder.
      motorType - Motor type controlled by the SparkMax motor controller.

  • Method Details

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in class SwerveMotor

    • getConfig

      public SparkMaxConfig getConfig()
      Get the current configuration of the SparkMax
      Returns:
      SparkMaxConfig

    • updateConfig

      public void updateConfig(SparkMaxConfig cfgGiven)
      Update the config for the SparkMax
      Parameters:
      cfgGiven - Given SparkMaxConfig which should have minimal modifications.

    • setVoltageCompensation

      public void setVoltageCompensation(double nominalVoltage)
      Set the voltage compensation for the swerve module motor.
      Specified by:
      setVoltageCompensation in class SwerveMotor
      Parameters:
      nominalVoltage - Nominal voltage for operation to output to.

    • setCurrentLimit

      public void setCurrentLimit(int currentLimit)
      Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with voltage compensation. This is useful to protect the motor from current spikes.
      Specified by:
      setCurrentLimit in class SwerveMotor
      Parameters:
      currentLimit - Current limit in AMPS at free speed.

    • setLoopRampRate

      public void setLoopRampRate(double rampRate)
      Set the maximum rate the open/closed loop output can change by.
      Specified by:
      setLoopRampRate in class SwerveMotor
      Parameters:
      rampRate - Time in seconds to go from 0 to full throttle.

    • getMotor

      public Object getMotor()
      Get the motor object from the module.
      Specified by:
      getMotor in class SwerveMotor
      Returns:
      Motor object.

    • getSimMotor

      public DCMotor getSimMotor()
      Get the DCMotor of the motor class.
      Specified by:
      getSimMotor in class SwerveMotor
      Returns:
      DCMotor of this type.

    • usingExternalFeedbackSensor

      public boolean usingExternalFeedbackSensor()
      Queries whether the absolute encoder is directly attached to the motor controller.
      Specified by:
      usingExternalFeedbackSensor in class SwerveMotor
      Returns:
      connected absolute encoder state.

    • factoryDefaults

      public void factoryDefaults()
      Configure the factory defaults.
      Specified by:
      factoryDefaults in class SwerveMotor

    • clearStickyFaults

      public void clearStickyFaults()
      Clear the sticky faults on the motor controller.
      Specified by:
      clearStickyFaults in class SwerveMotor

    • setAbsoluteEncoder

      public SwerveMotor setAbsoluteEncoder(SwerveAbsoluteEncoder encoder)
      Set the absolute encoder to be a compatible absolute encoder.
      Specified by:
      setAbsoluteEncoder in class SwerveMotor
      Parameters:
      encoder - The encoder to use.
      Returns:
      The SwerveMotor for easy instantiation.

    • configureIntegratedEncoder

      public void configureIntegratedEncoder(double positionConversionFactor)
      Configure the integrated encoder for the swerve module. Sets the conversion factors for position and velocity.
      Specified by:
      configureIntegratedEncoder in class SwerveMotor
      Parameters:
      positionConversionFactor - The conversion factor to apply.

    • configurePIDF

      public void configurePIDF(PIDFConfig config)
      Configure the PIDF values for the closed loop controller.
      Specified by:
      configurePIDF in class SwerveMotor
      Parameters:
      config - Configuration class holding the PIDF values.

    • configurePIDWrapping

      public void configurePIDWrapping(double minInput, double maxInput)
      Configure the PID wrapping for the position closed loop controller.
      Specified by:
      configurePIDWrapping in class SwerveMotor
      Parameters:
      minInput - Minimum PID input.
      maxInput - Maximum PID input.

    • disablePIDWrapping

      public void disablePIDWrapping()
      Disable PID Wrapping on the motor.
      Specified by:
      disablePIDWrapping in class SwerveMotor

    • setMotorBrake

      public void setMotorBrake(boolean isBrakeMode)
      Set the idle mode.
      Specified by:
      setMotorBrake in class SwerveMotor
      Parameters:
      isBrakeMode - Set the brake mode.

    • setInverted

      public void setInverted(boolean inverted)
      Set the motor to be inverted.
      Specified by:
      setInverted in class SwerveMotor
      Parameters:
      inverted - State of inversion.

    • burnFlash

      public void burnFlash()
      Save the configurations from flash to EEPROM.
      Specified by:
      burnFlash in class SwerveMotor

    • set

      public void set(double percentOutput)
      Set the percentage output.
      Specified by:
      set in class SwerveMotor
      Parameters:
      percentOutput - percent out for the motor controller.

    • setReference

      public void setReference(double setpoint, double feedforward)
      Set the closed loop PID controller reference point.
      Specified by:
      setReference in class SwerveMotor
      Parameters:
      setpoint - Setpoint in MPS or Angle in degrees.
      feedforward - Feedforward in volt-meter-per-second or kV.

    • setReference

      public void setReference(double setpoint, double feedforward, double position)
      Set the closed loop PID controller reference point.
      Specified by:
      setReference in class SwerveMotor
      Parameters:
      setpoint - Setpoint in meters per second or angle in degrees.
      feedforward - Feedforward in volt-meter-per-second or kV.
      position - Only used on the angle motor, the position of the motor in degrees.

    • getVoltage

      public double getVoltage()
      Get the voltage output of the motor controller.
      Specified by:
      getVoltage in class SwerveMotor
      Returns:
      Voltage output.

    • setVoltage

      public void setVoltage(double voltage)
      Set the voltage of the motor.
      Specified by:
      setVoltage in class SwerveMotor
      Parameters:
      voltage - Voltage to set.

    • getAppliedOutput

      public double getAppliedOutput()
      Get the applied dutycycle output.
      Specified by:
      getAppliedOutput in class SwerveMotor
      Returns:
      Applied dutycycle output to the motor.

    • getVelocity

      public double getVelocity()
      Get the velocity of the integrated encoder.
      Specified by:
      getVelocity in class SwerveMotor
      Returns:
      velocity

    • getPosition

      public double getPosition()
      Get the position of the integrated encoder.
      Specified by:
      getPosition in class SwerveMotor
      Returns:
      Position

    • setPosition

      public void setPosition(double position)
      Set the integrated encoder position.
      Specified by:
      setPosition in class SwerveMotor
      Parameters:
      position - Integrated encoder position.