Package xbot.common.injection.electrical_contract

Interface XSwerveDriveElectricalContract

public interface XSwerveDriveElectricalContract
This interface defines the base electrical contract for robots implementing swerve drive.

  • Method Details

    • isDriveReady

      boolean isDriveReady()
      Returns true if the drive is ready to be used.
      Returns:
      True if the drive is ready to be used.

    • areCanCodersReady

      boolean areCanCodersReady()
      Returns true if the steering encoders are ready to be used.
      Returns:
      True if the steering encoders are ready to be used.

    • getDriveMotor

      CANMotorControllerInfo getDriveMotor(SwerveInstance swerveInstance)
      Returns the DeviceInfo for the drive motor for the given SwerveInstance.
      Parameters:
      swerveInstance - The swerve instance.
      Returns:
      The DeviceInfo for the drive motor for the given SwerveInstance.

    • getSteeringMotor

      CANMotorControllerInfo getSteeringMotor(SwerveInstance swerveInstance)
      Returns the DeviceInfo for the steering motor for the given SwerveInstance.
      Parameters:
      swerveInstance - The swerve instance.
      Returns:
      The DeviceInfo for the steering motor for the given SwerveInstance.

    • getSteeringEncoder

      DeviceInfo getSteeringEncoder(SwerveInstance swerveInstance)
      Returns the DeviceInfo for the steering encoder for the given SwerveInstance.
      Parameters:
      swerveInstance - The swerve instance.
      Returns:
      The DeviceInfo for the steering encoder for the given SwerveInstance.

    • getSwerveModuleOffsets

      Translation2d getSwerveModuleOffsets(SwerveInstance swerveInstance)
      Returns the offset from the center of the robot as a Translation2d for the given SwerveInstance.
      Parameters:
      swerveInstance - The swerve instance.
      Returns:
      The offset from the center of the robot as a Translation2d for the given SwerveInstance, in inches.

    • getDriveWheelDiameter

      default Distance getDriveWheelDiameter()
      Returns the diameter of the drive wheels.
      Returns:
      The diameter of the drive wheels.

    • getDriveGearRatio

      double getDriveGearRatio()
      Returns the gear ratio for the drive motors.
      Returns:
      The gear ratio for the drive motors.

    • getSteeringGearRatio

      double getSteeringGearRatio()
      Returns the gear ratio for the steering motors.
      Returns:
      The gear ratio for the steering motors.