Skip to content

Commit

Permalink
Update name from canandcoder to canandmag
Browse files Browse the repository at this point in the history
Signed-off-by: thenetworkgrinch <thenetworkgrinch@users.noreply.github.com>
  • Loading branch information
thenetworkgrinch committed Aug 25, 2024
1 parent fc5973d commit c7970ca
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 16 deletions.
16 changes: 8 additions & 8 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -339,8 +339,8 @@ <h1 class="d-inline display-6">Front Left Module</h1>
<option value="sparkmax_analog">Attached (to SparkMAX Analog Pin)</option>
<option value="sparkmax_analog">Attached (to SparkMAX Analog Pin)</option>
<option value="cancoder">CANCoder</option>
<option value="canandcoder">CANandCoder (attached to SparkMAX)</option>
<option value="canandcoder_can">CANandCoder (CAN)</option>
<option value="canandmag">CANandMag (attached to SparkMAX)</option>
<option value="canandmag_can">CANandMag (CAN)</option>
<option value="ma3">MA3</option>
<option value="ctre_mag">CTRE Mag</option>
<option value="rev_hex">REV Hex</option>
Expand Down Expand Up @@ -551,8 +551,8 @@ <h1 class="d-inline display-6">Front Right Module</h1>
<option value="attached">Attached (to SparkMAX)</option>
<option value="sparkmax_analog">Attached (to SparkMAX Analog Pin)</option>
<option value="cancoder">CANCoder</option>
<option value="canandcoder">CANandCoder (attached to SparkMAX)</option>
<option value="canandcoder_can">CANandCoder (CAN)</option>
<option value="canandmag">CANandMag (attached to SparkMAX)</option>
<option value="canandmag_can">CANandMag (CAN)</option>
<option value="ma3">MA3</option>
<option value="ctre_mag">CTRE Mag</option>
<option value="rev_hex">REV Hex</option>
Expand Down Expand Up @@ -761,8 +761,8 @@ <h1 class="d-inline display-6">Back Left Module</h1>
<option value="attached">Attached (to SparkMAX)</option>
<option value="sparkmax_analog">Attached (to SparkMAX Analog Pin)</option>
<option value="cancoder">CANCoder</option>
<option value="canandcoder">CANandCoder (attached to SparkMAX)</option>
<option value="canandcoder_can">CANandCoder (CAN)</option>
<option value="canandmag">CANandMag (attached to SparkMAX)</option>
<option value="canandmag_can">CANandMag (CAN)</option>
<option value="ma3">MA3</option>
<option value="ctre_mag">CTRE Mag</option>
<option value="rev_hex">REV Hex</option>
Expand Down Expand Up @@ -975,8 +975,8 @@ <h1 class="d-inline display-6">Back Right Module</h1>
<option value="attached">Attached (to SparkMAX)</option>
<option value="sparkmax_analog">Attached (to SparkMAX Analog Pin)</option>
<option value="cancoder">CANCoder</option>
<option value="canandcoder">CANandCoder (attached to SparkMAX)</option>
<option value="canandcoder_can">CANandCoder (CAN)</option>
<option value="canandmag">CANandMag (attached to SparkMAX)</option>
<option value="canandmag_can">CANandMag (CAN)</option>
<option value="ma3">MA3</option>
<option value="ctre_mag">CTRE Mag</option>
<option value="rev_hex">REV Hex</option>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@
/**
* HELIUM {@link Canandmag} from ReduxRobotics absolute encoder, attached through the CAN bus.
*/
public class CanAndCoderSwerve extends SwerveAbsoluteEncoder
public class CanAndMagSwerve extends SwerveAbsoluteEncoder
{

/**
* The {@link Canandmag} representing the CANandCoder on the CAN bus.
* The {@link Canandmag} representing the CANandMag on the CAN bus.
*/
public Canandmag encoder;

/**
* Create the {@link Canandmag}
*
* @param canid The CAN ID whenever the CANandCoder is operating on the CANBus.
* @param canid The CAN ID whenever the CANandMag is operating on the CANBus.
*/
public CanAndCoderSwerve(int canid)
public CanAndMagSwerve(int canid)
{
encoder = new Canandmag(canid);
}
Expand All @@ -44,7 +44,7 @@ public void clearStickyFaults()
}

/**
* Configure the Canandcoder to read from [0, 360) per second.
* Configure the CANandMag to read from [0, 360) per second.
*
* @param inverted Whether the encoder is inverted.
*/
Expand Down Expand Up @@ -77,7 +77,7 @@ public Object getAbsoluteEncoder()
}

/**
* Cannot set the offset of the Canandcoder.
* Cannot set the offset of the CANandMag.
*
* @param offset the offset the Absolute Encoder uses as the zero point.
* @return true if setting the zero point succeeded, false otherwise
Expand Down
6 changes: 4 additions & 2 deletions src/main/java/swervelib/parser/json/DeviceJson.java
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
import edu.wpi.first.wpilibj.SerialPort.Port;
import swervelib.encoders.AnalogAbsoluteEncoderSwerve;
import swervelib.encoders.CANCoderSwerve;
import swervelib.encoders.CanAndCoderSwerve;
import swervelib.encoders.CanAndMagSwerve;
import swervelib.encoders.PWMDutyCycleEncoderSwerve;
import swervelib.encoders.SparkMaxAnalogEncoderSwerve;
import swervelib.encoders.SparkMaxEncoderSwerve;
Expand Down Expand Up @@ -69,12 +69,14 @@ public SwerveAbsoluteEncoder createEncoder(SwerveMotor motor)
return null;
case "integrated":
case "attached":
case "canandmag":
case "canandcoder":
return new SparkMaxEncoderSwerve(motor, 360);
case "sparkmax_analog":
return new SparkMaxAnalogEncoderSwerve(motor, 3.3);
case "canandcoder_can":
return new CanAndCoderSwerve(id);
case "canandmag_can":
return new CanAndMagSwerve(id);
case "ctre_mag":
case "rev_hex":
case "throughbore":
Expand Down

0 comments on commit c7970ca

Please sign in to comment.