WPILibC++  2020.3.2-60-g3011ebe
frc::SwerveDriveKinematics< NumModules > Class Template Reference

Helper class that converts a chassis velocity (dx, dy, and dtheta components) into individual module states (speed and angle). More...

#include <SwerveDriveKinematics.h>

Public Member Functions

template<typename... Wheels>
 SwerveDriveKinematics (Translation2d wheel, Wheels &&... wheels)
 Constructs a swerve drive kinematics object. More...
 
 SwerveDriveKinematics (const SwerveDriveKinematics &)=default
 
std::array< SwerveModuleState, NumModules > ToSwerveModuleStates (const ChassisSpeeds &chassisSpeeds, const Translation2d &centerOfRotation=Translation2d()) const
 Performs inverse kinematics to return the module states from a desired chassis velocity. More...
 
template<typename... ModuleStates>
ChassisSpeeds ToChassisSpeeds (ModuleStates &&... wheelStates) const
 Performs forward kinematics to return the resulting chassis state from the given module states. More...
 
ChassisSpeeds ToChassisSpeeds (std::array< SwerveModuleState, NumModules > moduleStates) const
 Performs forward kinematics to return the resulting chassis state from the given module states. More...
 

Static Public Member Functions

static void NormalizeWheelSpeeds (std::array< SwerveModuleState, NumModules > *moduleStates, units::meters_per_second_t attainableMaxSpeed)
 Normalizes the wheel speeds using some max attainable speed. More...
 

Detailed Description

template<size_t NumModules>
class frc::SwerveDriveKinematics< NumModules >

Helper class that converts a chassis velocity (dx, dy, and dtheta components) into individual module states (speed and angle).

The inverse kinematics (converting from a desired chassis velocity to individual module states) uses the relative locations of the modules with respect to the center of rotation. The center of rotation for inverse kinematics is also variable. This means that you can set your set your center of rotation in a corner of the robot to perform special evasion manuevers.

Forward kinematics (converting an array of module states into the overall chassis motion) is performs the exact opposite of what inverse kinematics does. Since this is an overdetermined system (more equations than variables), we use a least-squares approximation.

The inverse kinematics: [moduleStates] = [moduleLocations] * [chassisSpeeds] We take the Moore-Penrose pseudoinverse of [moduleLocations] and then multiply by [moduleStates] to get our chassis speeds.

Forward kinematics is also used for odometry – determining the position of the robot on the field using encoders and a gyro.

Constructor & Destructor Documentation

◆ SwerveDriveKinematics()

template<size_t NumModules>
template<typename... Wheels>
frc::SwerveDriveKinematics< NumModules >::SwerveDriveKinematics ( Translation2d  wheel,
Wheels &&...  wheels 
)
inlineexplicit

Constructs a swerve drive kinematics object.

This takes in a variable number of wheel locations as Translation2ds. The order in which you pass in the wheel locations is the same order that you will recieve the module states when performing inverse kinematics. It is also expected that you pass in the module states in the same order when calling the forward kinematics methods.

Parameters
wheelsThe locations of the wheels relative to the physical center of the robot.

Member Function Documentation

◆ NormalizeWheelSpeeds()

template<size_t NumModules>
void frc::SwerveDriveKinematics< NumModules >::NormalizeWheelSpeeds ( std::array< SwerveModuleState, NumModules > *  moduleStates,
units::meters_per_second_t  attainableMaxSpeed 
)
static

Normalizes the wheel speeds using some max attainable speed.

Sometimes, after inverse kinematics, the requested speed from a/several modules may be above the max attainable speed for the driving motor on that module. To fix this issue, one can "normalize" all the wheel speeds to make sure that all requested module speeds are below the absolute threshold, while maintaining the ratio of speeds between modules.

Parameters
moduleStatesReference to array of module states. The array will be mutated with the normalized speeds!
attainableMaxSpeedThe absolute max speed that a module can reach.

◆ ToChassisSpeeds() [1/2]

template<size_t NumModules>
template<typename... ModuleStates>
ChassisSpeeds frc::SwerveDriveKinematics< NumModules >::ToChassisSpeeds ( ModuleStates &&...  wheelStates) const

Performs forward kinematics to return the resulting chassis state from the given module states.

This method is often used for odometry – determining the robot's position on the field using data from the real-world speed and angle of each module on the robot.

Parameters
wheelStatesThe state of the modules (as a SwerveModuleState type) as measured from respective encoders and gyros. The order of the swerve module states should be same as passed into the constructor of this class.
Returns
The resulting chassis speed.

◆ ToChassisSpeeds() [2/2]

template<size_t NumModules>
ChassisSpeeds frc::SwerveDriveKinematics< NumModules >::ToChassisSpeeds ( std::array< SwerveModuleState, NumModules >  moduleStates) const

Performs forward kinematics to return the resulting chassis state from the given module states.

This method is often used for odometry – determining the robot's position on the field using data from the real-world speed and angle of each module on the robot.

Parameters
moduleStatesThe state of the modules as an std::array of type SwerveModuleState, NumModules long as measured from respective encoders and gyros. The order of the swerve module states should be same as passed into the constructor of this class.
Returns
The resulting chassis speed.

◆ ToSwerveModuleStates()

template<size_t NumModules>
std::array< SwerveModuleState, NumModules > frc::SwerveDriveKinematics< NumModules >::ToSwerveModuleStates ( const ChassisSpeeds chassisSpeeds,
const Translation2d centerOfRotation = Translation2d() 
) const

Performs inverse kinematics to return the module states from a desired chassis velocity.

This method is often used to convert joystick values into module speeds and angles.

This function also supports variable centers of rotation. During normal operations, the center of rotation is usually the same as the physical center of the robot; therefore, the argument is defaulted to that use case. However, if you wish to change the center of rotation for evasive manuevers, vision alignment, or for any other use case, you can do so.

Parameters
chassisSpeedsThe desired chassis speed.
centerOfRotationThe center of rotation. For example, if you set the center of rotation at one corner of the robot and provide a chassis speed that only has a dtheta component, the robot will rotate around that corner.
Returns
An array containing the module states. Use caution because these module states are not normalized. Sometimes, a user input may cause one of the module speeds to go above the attainable max velocity. Use the <NormalizeWheelSpeeds> function to rectify this issue. In addition, you can leverage the power of C++17 to directly assign the module states to variables:
auto [fl, fr, bl, br] = kinematics.ToSwerveModuleStates(chassisSpeeds);

The documentation for this class was generated from the following files: