Skip to content

Conversation

Strflightmight09
Copy link
Member

No description provided.

@ShmayaR ShmayaR requested a review from Nummun14 July 24, 2025 19:21
Copy link
Member Author

@Strflightmight09 Strflightmight09 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sure you also test it out to make sure it all works

@Strflightmight09
Copy link
Member Author

Approved by me as long as you've tested everything
In the meantime also review the rest of the PR and @Nummun14 and @noamgreen12 please review everything

Copy link

@Trigon5990 Trigon5990 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs a ton of jdocs. Make motor subsystem more abstract for this to work with it

Copy link
Member Author

@Strflightmight09 Strflightmight09 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple things:

  1. You forgot to add in javadocs for the actual subsystems themselves
  2. Each of the javadocs for the configs should be a full sentence, and should start with "the" in most cases and shouldn't be in point form

Comment on lines +15 to +28
/**
* Maximum velocity of the motor.
*/
public double maximumVelocity = 1;

/**
* Maximum acceleration of the motor.
*/
public double maximumAcceleration = 1;

/**
* Maximum jerk of the motor.
*/
public double maximumJerk = 1;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Units?

Comment on lines +51 to +54
/**
* Visual offset for display in Mechanism2D.
*/
public double visualizationOffset = 1;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs more than just a rewording, this needs an explanation

Comment on lines +66 to +69
/**
* Acceptable angular tolerance for reaching the target.
*/
public Rotation2d angleTolerance = Rotation2d.kZero;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for reaching the target isn't precise enough


public boolean shouldSimulateGravity = true;

public Color mechanismColor = Color.kBlue;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
public Color mechanismColor = Color.kBlue;
public Color mechanism2DColor = Color.kBlue;

Rn it sounds like the physical colour of the mechanism

public Color mechanismColor = Color.kBlue;

/**
* The type and number of motors used in the simulation.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* The type and number of motors used in the simulation.
* The type and number of motors used for the simulation.

Comment on lines +155 to +160
/**
* An interface for an arm state.
* getTargetAngle represents the target angle of the state.
* getSpeedScalar represents the speed scalar of the state.
*/
public interface ArmState {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You still don't explain what it's for

Comment on lines +8 to +11
/**
* Acceptable position error in meters.
*/
public double positionToleranceMeters = 1;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't consistent with how you described the arm one


public double gearRatio = 1;
/**
* Mass of the Elevator in kg.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Kilograms

*/
maximumDisplayableVelocity = 1,
/**
* The acceptable tolerance between the target velocity and current velocity.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For what?

Comment on lines +49 to +52
/**
* should the motor control mode be Voltage as opposed to Velocity.
*/
public boolean shouldUseVoltageControl = false;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Explain what each one is

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants