Skip to content
This repository was archived by the owner on Jan 17, 2025. It is now read-only.
This repository was archived by the owner on Jan 17, 2025. It is now read-only.

Add further documentation for 2023-2024 code #12

@J-The-Fox

Description

@J-The-Fox

Overview

Add some further documentation to the 2023-2024 robot code. The main parts that lack documentation are the Swerve Drive parts

ex:

final static double maximumSpeed    = (6380 * 0.3191858136) / 60 / 3;
final static double maximumRotation = (maximumSpeed * 2 * Math.PI) / 2.7389195456 / 2;

or

swerveModuleState   = SwerveModuleState.optimize(swerveModuleState,Rotation2d.fromDegrees(turnMotor.getSelectedSensorPosition() / 11.3777778));
double maximumSpeed = (6380 * 0.3191858136) / 60 / 3;

final double desiredTurnPos = swerveModuleState.angle.getDegrees() * 11.3777778; // conversion from degrees to native encoder value

These parts are lacking in the documentation, main things I would like to document are the numbers, how we got them and why we are using them

Metadata

Metadata

Labels

WPILibIssue relating to WPILibdocumentationImprovements or additions to documentationenhancementNew feature or requestjavaIssue relating to Java

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions