-
Notifications
You must be signed in to change notification settings - Fork 0
Subsystem Wrapper #54
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
src/main/java/org/trigon/hardware/subsystems/elevator/ElevatorConfiguration.java
Outdated
Show resolved
Hide resolved
src/main/java/org/trigon/hardware/subsystems/flywheel/SimpleMotorConfiguration.java
Outdated
Show resolved
Hide resolved
src/main/java/org/trigon/hardware/subsystems/flywheel/SimpleMotorSubsystem.java
Outdated
Show resolved
Hide resolved
src/main/java/org/trigon/hardware/subsystems/flywheel/SimpleMotorSubsystem.java
Show resolved
Hide resolved
src/main/java/org/trigon/hardware/subsystems/flywheel/SimpleMotorSubsystem.java
Outdated
Show resolved
Hide resolved
src/main/java/org/trigon/hardware/subsystems/flywheel/SimpleMotorSubsystem.java
Outdated
Show resolved
Hide resolved
src/main/java/org/trigon/hardware/subsystems/flywheel/SimpleMotorSubsystem.java
Outdated
Show resolved
Hide resolved
There was a problem hiding this 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
src/main/java/org/trigon/hardware/subsystems/flywheel/SimpleMotorSubsystem.java
Outdated
Show resolved
Hide resolved
src/main/java/org/trigon/hardware/subsystems/flywheel/SimpleMotorSubsystem.java
Show resolved
Hide resolved
src/main/java/org/trigon/hardware/subsystems/flywheel/SimpleMotorSubsystem.java
Outdated
Show resolved
Hide resolved
src/main/java/org/trigon/hardware/subsystems/flywheel/SimpleMotorSubsystem.java
Outdated
Show resolved
Hide resolved
src/main/java/org/trigon/hardware/subsystems/flywheel/SimpleMotorSubsystem.java
Outdated
Show resolved
Hide resolved
src/main/java/org/trigon/hardware/subsystems/flywheel/SimpleMotorSubsystem.java
Outdated
Show resolved
Hide resolved
src/main/java/org/trigon/hardware/subsystems/flywheel/SimpleMotorConfiguration.java
Outdated
Show resolved
Hide resolved
src/main/java/org/trigon/hardware/subsystems/flywheel/SimpleMotorSubsystem.java
Outdated
Show resolved
Hide resolved
src/main/java/org/trigon/hardware/subsystems/flywheel/SimpleMotorSubsystem.java
Outdated
Show resolved
Hide resolved
src/main/java/org/trigon/hardware/subsystems/flywheel/SimpleMotorSubsystem.java
Outdated
Show resolved
Hide resolved
src/main/java/org/trigon/hardware/subsystems/flywheel/SimpleMotorSubsystem.java
Outdated
Show resolved
Hide resolved
src/main/java/org/trigon/hardware/subsystems/flywheel/SimpleMotorSubsystem.java
Outdated
Show resolved
Hide resolved
Approved by me as long as you've tested everything |
src/main/java/org/trigon/hardware/subsystems/arm/ArmConfiguration.java
Outdated
Show resolved
Hide resolved
src/main/java/org/trigon/hardware/subsystems/elevator/ElevatorSubsystem.java
Show resolved
Hide resolved
src/main/java/org/trigon/hardware/subsystems/elevator/ElevatorSubsystem.java
Show resolved
Hide resolved
There was a problem hiding this 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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple things:
- You forgot to add in javadocs for the actual subsystems themselves
- 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
/** | ||
* 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; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Units?
/** | ||
* Visual offset for display in Mechanism2D. | ||
*/ | ||
public double visualizationOffset = 1; |
There was a problem hiding this comment.
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
/** | ||
* Acceptable angular tolerance for reaching the target. | ||
*/ | ||
public Rotation2d angleTolerance = Rotation2d.kZero; |
There was a problem hiding this comment.
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; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* The type and number of motors used in the simulation. | |
* The type and number of motors used for the simulation. |
/** | ||
* 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 { |
There was a problem hiding this comment.
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
/** | ||
* Acceptable position error in meters. | ||
*/ | ||
public double positionToleranceMeters = 1; |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For what?
/** | ||
* should the motor control mode be Voltage as opposed to Velocity. | ||
*/ | ||
public boolean shouldUseVoltageControl = false; |
There was a problem hiding this comment.
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
No description provided.