Skip to content
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

Intake #1

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Intake #1

wants to merge 11 commits into from

Conversation

GaiaZano05
Copy link

No description provided.

@GaiaZano05 GaiaZano05 self-assigned this Sep 3, 2021
@@ -16,4 +16,7 @@
* constants are needed, to reduce verbosity.
*/
public final class Constants {
public static final class Intake {
public static final double power = 0.8; // [%]
Copy link
Member

Choose a reason for hiding this comment

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

CAPITALIZE

Suggested change
public static final double power = 0.8; // [%]
public static final double POWER = 0.8; // [%]

public XboxController Xbox = new XboxController(1);
public JoystickButton a = new JoystickButton(Xbox, XboxController.Button.kA.value);
public JoystickButton b = new JoystickButton(Xbox, XboxController.Button.kB.value);
private Intake intake;
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
private Intake intake;
private final Intake intake = new Intake();

Comment on lines 8 to 10
/**
* Add&named motors in Intake.
*/
Copy link
Member

Choose a reason for hiding this comment

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

Add proper documentation!!! (everywhere)

/**
* Add motor inverted.
*/
public void TalonSRXSelenoid() {
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
public void TalonSRXSelenoid() {
public Intake() {


/**
* Set power for motor.
* @param power the speed times the torque.
Copy link
Member

Choose a reason for hiding this comment

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

Wrong units, it's just percentage


/**
* A check to see if piston is open or close.
* @return
Copy link
Member

@barel13 barel13 Sep 3, 2021

Choose a reason for hiding this comment

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

You should write what true mean (does it mean open or closed?)

Copy link
Member

Choose a reason for hiding this comment

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

A shorter solution will be renaming the function isPistonOpen or something similar.

@@ -0,0 +1,14 @@
package frc.robot.subsystems.intake;
Copy link
Member

@barel13 barel13 Sep 3, 2021

Choose a reason for hiding this comment

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

Ports should be in frc.robot package!!!!!!!!!!!!

Copy link
Contributor

Choose a reason for hiding this comment

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

🤢🤮

Copy link
Member

@katzuv katzuv Sep 11, 2021

Choose a reason for hiding this comment

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

  1. No need to shout 🙂
  2. IMO ports and constants should be stored in every subsystem's packages except global stuff like we did in 2019. When they are all in the same file you have a lot of merge conflicts.

Copy link
Contributor

@adamv17 adamv17 left a comment

Choose a reason for hiding this comment

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

Great job, there is really very little left to improve in this code. :)

* Set power for motor.
* @param power the speed times the torque.
*/
public void setMotorPower(double power) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Rename to setPower

Copy link
Member

Choose a reason for hiding this comment

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

I disagree, it might not be the proper naming, maybe powerWheels(...)?

Copy link
Contributor

Choose a reason for hiding this comment

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

Sure it's just repetitive to call the method setMotorPower

* Add motor inverted.
*/
public void TalonSRXSelenoid() {
this.motor.setInverted(Ports.Intake.IS_MOTOR_INVERTED);
Copy link
Contributor

Choose a reason for hiding this comment

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

"this" isn't necessary here

/**
* Add Commandy function;
*/
public class Commandy extends CommandBase {
Copy link
Contributor

Choose a reason for hiding this comment

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

Add a command that only opens and closes the intake

Copy link
Member

Choose a reason for hiding this comment

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

Agreed, and add another command that powers the wheels. Then, if needed, combine both commands in a command group.
Also, change the command's name because "commandy" is very not indicative.

Copy link
Member

@katzuv katzuv left a comment

Choose a reason for hiding this comment

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

Great job! 😁

@@ -0,0 +1,14 @@
package frc.robot.subsystems.intake;
Copy link
Member

@katzuv katzuv Sep 11, 2021

Choose a reason for hiding this comment

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

  1. No need to shout 🙂
  2. IMO ports and constants should be stored in every subsystem's packages except global stuff like we did in 2019. When they are all in the same file you have a lot of merge conflicts.

/**
* Add Commandy function;
*/
public class Commandy extends CommandBase {
Copy link
Member

Choose a reason for hiding this comment

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

Agreed, and add another command that powers the wheels. Then, if needed, combine both commands in a command group.
Also, change the command's name because "commandy" is very not indicative.

Comment on lines 60 to 62



Copy link
Member

Choose a reason for hiding this comment

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

No need for all those blank lines.

Comment on lines 50 to 54
if (isPistonEngaged()) {
setPistonMode(false);
} else {
setPistonMode(true);
}
Copy link
Member

Choose a reason for hiding this comment

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

You can shorten this code:

Suggested change
if (isPistonEngaged()) {
setPistonMode(false);
} else {
setPistonMode(true);
}
setPistonMode(!isPistonEngaged());


/**
* A check to see if piston is open or close.
* @return
Copy link
Member

Choose a reason for hiding this comment

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

A shorter solution will be renaming the function isPistonOpen or something similar.

*/
public class Intake extends SubsystemBase {
private TalonSRX motor = new TalonSRX(Ports.Intake.MOTOR);
private Solenoid piston = new Solenoid(Ports.Intake.SOLENOID);
Copy link
Member

@katzuv katzuv Sep 11, 2021

Choose a reason for hiding this comment

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

Better to call it "retractor" or something similar, to explain what the piston's purpose is. Make sure you change the name everywhere, for example, change every function name that has "piston" inside it.
Also, "piston" is a hardware component, making it an implementation detail. Thus, users of the subsystem (i.e. commands) do not care about it, they care only about what the subsystem does, not about how it does that. Therefore, "piston" shouldn't be exposed outside of this class. This is also why you declared it private.
Please let me know if the explanation wasn't clear.

*/
public class Intake extends SubsystemBase {
private TalonSRX motor = new TalonSRX(Ports.Intake.MOTOR);
private Solenoid piston = new Solenoid(Ports.Intake.SOLENOID);
Copy link
Member

Choose a reason for hiding this comment

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

Better to call this "retractor" or something similar, so that it's clear what is the piston's purpose.

* A check to see if piston is open or close, true= open, false= close.
* @return
*/
public boolean isPistonEngaged() {
Copy link
Member

Choose a reason for hiding this comment

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

As written above, it's better to name this function isRetracted or something similar. That way, the function's purpose is clear. Make sure you do the renaming everywhere else appropriate in this class.
Also, the piston is a hardware component, which means it is an implementation detail. Thus, it shouldn't be exposed to external users of the class, such as commands. Users of the class care about what it does, not how it does it.
Please reach out if the explanation above is not clear 🙂

Comment on lines 56 to 63

}

}




Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
}
}
}
}

No need for all these blank lines 🙂


@Override
public void initialize() {
super.initialize();
Copy link
Member

@katzuv katzuv Sep 12, 2021

Choose a reason for hiding this comment

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

No need for this call to super's methods and also the ones in the methods following. As you can see in WPILib's source code, these methods are empty in the parent class, so these calls do nothing (source code taken from here):

public interface Command {
  /** The initial subroutine of a command. Called once when the command is initially scheduled. */
  default void initialize() {}


  /** The main body of a command. Called repeatedly while the command is scheduled. */
  default void execute() {}


  /**
   * The action to take when the command ends. Called when either the command finishes normally, or
   * when it interrupted/canceled.
   *
   * <p>Do not schedule commands here that share requirements with this command. Use {@link
   * #andThen(Command...)} instead.
   *
   * @param interrupted whether the command was interrupted/canceled
   */
  default void end(boolean interrupted) {}


  /**
   * Whether the command has finished. Once a command finishes, the scheduler will call its end()
   * method and un-schedule it.
   *
   * @return whether the command has finished.
   */
  default boolean isFinished() {
    return false;
  }

@katzuv
Copy link
Member

katzuv commented Sep 12, 2021

Just a small comment – every commit should document a single change. so 42689a0 should have been split into four different commits.

@katzuv katzuv mentioned this pull request Sep 12, 2021

/**
* Set percentage for motor.
* @param power the speed times the torque.
Copy link
Member

Choose a reason for hiding this comment

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

The units are simply %

Comment on lines 26 to 28
public XboxController Xbox = new XboxController(1);
public JoystickButton a = new JoystickButton(Xbox, XboxController.Button.kA.value);
public JoystickButton b = new JoystickButton(Xbox, XboxController.Button.kB.value);
Copy link
Member

Choose a reason for hiding this comment

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

(Also, make them private)


private Intake intake;

public ToggleIntake(Intake intake) {
Copy link
Member

Choose a reason for hiding this comment

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

The should also move to specific state, not only toggle.

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.

5 participants