com.acmerobotics.roadrunner.kinematics

Class TankKinematics

com.acmerobotics.roadrunner.kinematics.TankKinematics

public class TankKinematics

Tank drive kinematic equations based upon the unicycle model. All wheel positions and velocities are given in (left, right) tuples. Robot poses are specified in a coordinate system with positive x pointing forward, positive y pointing left, and positive heading measured counter-clockwise from the x-axis.

This page gives a motivated derivation.

See Also:

This page

Field Summary

Fields

Modifier and Type	Field and Description
static TankKinematics	INSTANCE Tank drive kinematic equations based upon the unicycle model. All wheel positions and velocities are given in (left, right) tuples. Robot poses are specified in a coordinate system with positive x pointing forward, positive y pointing left, and positive heading measured counter-clockwise from the x-axis.

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.lang.Double>	robotToWheelAccelerations(Pose2d robotAccel, double trackWidth) Computes the wheel accelerations corresponding to robotAccel given trackWidth.
static java.util.List<java.lang.Double>	robotToWheelVelocities(Pose2d robotVel, double trackWidth) Computes the wheel velocities corresponding to robotVel given trackWidth.
static Pose2d	wheelToRobotVelocities(java.util.List<java.lang.Double> wheelVelocities, double trackWidth) Computes the robot velocity corresponding to wheelVelocities and the given drive parameters.

Field Detail

INSTANCE

public static TankKinematics INSTANCE

Tank drive kinematic equations based upon the unicycle model. All wheel positions and velocities are given in (left, right) tuples. Robot poses are specified in a coordinate system with positive x pointing forward, positive y pointing left, and positive heading measured counter-clockwise from the x-axis.

This page gives a motivated derivation.

See Also:

This page

Method Detail

robotToWheelVelocities

@JvmStatic
 @NotNull
public static java.util.List<java.lang.Double> robotToWheelVelocities(@NotNull
                                                                                           Pose2d robotVel,
                                                                                           double trackWidth)

Computes the wheel velocities corresponding to robotVel given trackWidth.

Parameters:

robotVel - velocity of the robot in its reference frame

trackWidth - lateral distance between pairs of wheels on different sides of the robot

See Also:

robotVel, trackWidth

robotToWheelAccelerations

@JvmStatic
 @NotNull
public static java.util.List<java.lang.Double> robotToWheelAccelerations(@NotNull
                                                                                              Pose2d robotAccel,
                                                                                              double trackWidth)

Computes the wheel accelerations corresponding to robotAccel given trackWidth.

Parameters:

robotAccel - velocity of the robot in its reference frame

trackWidth - lateral distance between pairs of wheels on different sides of the robot

See Also:

robotAccel, trackWidth

wheelToRobotVelocities

@JvmStatic
 @NotNull
public static Pose2d wheelToRobotVelocities(@NotNull
                                                                 java.util.List<java.lang.Double> wheelVelocities,
                                                                 double trackWidth)

Computes the robot velocity corresponding to wheelVelocities and the given drive parameters.

Parameters:

wheelVelocities - wheel velocities (or wheel position deltas)

trackWidth - lateral distance between pairs of wheels on different sides of the robot

See Also:

wheelVelocities