From bba215c139607588b2a13384c32d51f299e09b84 Mon Sep 17 00:00:00 2001 From: willitcode <91231142+willitcode@users.noreply.github.com> Date: Mon, 26 Feb 2024 21:53:37 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20javadoc=20from=20@=20frc937/ro?= =?UTF-8?q?bot2024@c859e82bef55149fb8bf019ec636a3d57dad366b=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- javadoc/allclasses-index.html | 22 +- javadoc/constant-values.html | 17 ++ javadoc/frc/robot/Constants.Climber.html | 211 ++++++++++++++++ javadoc/frc/robot/Constants.html | 31 ++- javadoc/frc/robot/RobotContainer.html | 58 +++-- javadoc/frc/robot/commands/ClimbDown.html | 231 ++++++++++++++++++ javadoc/frc/robot/commands/ClimbUp.html | 231 ++++++++++++++++++ .../frc/robot/commands/package-summary.html | 8 + javadoc/frc/robot/commands/package-tree.html | 2 + javadoc/frc/robot/package-summary.html | 46 ++-- javadoc/frc/robot/package-tree.html | 1 + javadoc/frc/robot/subsystems/Climber.html | 209 ++++++++++++++++ .../frc/robot/subsystems/package-summary.html | 18 +- .../frc/robot/subsystems/package-tree.html | 1 + javadoc/index-all.html | 76 ++++++ javadoc/member-search-index.js | 2 +- javadoc/overview-tree.html | 4 + javadoc/type-search-index.js | 2 +- 18 files changed, 1101 insertions(+), 69 deletions(-) create mode 100644 javadoc/frc/robot/Constants.Climber.html create mode 100644 javadoc/frc/robot/commands/ClimbDown.html create mode 100644 javadoc/frc/robot/commands/ClimbUp.html create mode 100644 javadoc/frc/robot/subsystems/Climber.html diff --git a/javadoc/allclasses-index.html b/javadoc/allclasses-index.html index 1bad490d..61f8d6a5 100644 --- a/javadoc/allclasses-index.html +++ b/javadoc/allclasses-index.html @@ -62,15 +62,31 @@

All Classes and Interfaces<
Aims with the limelight towards an object.
-
Constants
+
ClimbDown
+
Climbs the robot down until the command is stopped.
+
+
Climber
+
+
The subsystem for the climber.
+
+
ClimbUp
+
+
Climbs the robot up until the command is stopped.
+
+
Constants
+
The Constants class provides a convenient place for teams to hold robot-wide numerical or boolean constants.
-
Constants.Auto
-
+
Constants.Auto
+
Holds constants specfically related to autonomous.
+
Constants.Climber
+
+
The constants for the climber.
+
Constants.Controllers
Constants that are relating to the controllers.
diff --git a/javadoc/constant-values.html b/javadoc/constant-values.html index d2cd613c..dbddfc16 100644 --- a/javadoc/constant-values.html +++ b/javadoc/constant-values.html @@ -70,6 +70,23 @@

frc.robot.*

  • +
    frc.robot.Constants.Climber
    +
    +
    Modifier and Type
    +
    Constant Field
    +
    Value
    +
    public static final boolean
    +
    CLIMBER_INVERTED
    +
    false
    +
    public static final int
    +
    CLIMBER_MOTOR_ID
    +
    13
    +
    public static final double
    +
    CLIMBER_MOTOR_SPEED
    +
    0.5
    +
    +
    • +
  • frc.robot.Constants.Controllers
    Modifier and Type
    diff --git a/javadoc/frc/robot/Constants.Climber.html b/javadoc/frc/robot/Constants.Climber.html new file mode 100644 index 00000000..e97fd939 --- /dev/null +++ b/javadoc/frc/robot/Constants.Climber.html @@ -0,0 +1,211 @@ + + + + +Constants.Climber (robot2024 API) + + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package frc.robot
    +

    Class Constants.Climber

    +
    +
    java.lang.Object +
    frc.robot.Constants.Climber
    +
    +
    +
    +
    Enclosing class:
    +
    Constants
    +
    +
    +
    public static class Constants.Climber +extends Object
    +
    The constants for the climber.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Field Details

      +
        +
      • +
        +

        CLIMBER_MOTOR_ID

        +
        public static final int CLIMBER_MOTOR_ID
        +
        The motor id for the climber
        +
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      • +
        +

        CLIMBER_MOTOR_SPEED

        +
        public static final double CLIMBER_MOTOR_SPEED
        +
        The speed the climber will climb.
        +
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      • +
        +

        CLIMBER_INVERTED

        +
        public static final boolean CLIMBER_INVERTED
        +
        Whether or not the climber is inverted.
        +
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        Climber

        +
        public Climber()
        +
        +
        • +
      +
      +
      • +
    +
    + +
    +
    +
    + + diff --git a/javadoc/frc/robot/Constants.html b/javadoc/frc/robot/Constants.html index b6cebaba..0124b9fe 100644 --- a/javadoc/frc/robot/Constants.html +++ b/javadoc/frc/robot/Constants.html @@ -97,38 +97,43 @@

    Nested Class Summary

    Holds constants specfically related to autonomous.
    static class 
    -
    Constants.Controllers
    +
    Constants.Climber
    -
    Constants that are relating to the controllers.
    +
    The constants for the climber.
    static class 
    -
    Constants.Drive
    +
    Constants.Controllers
    -
    Constants for the Drivetrain
    +
    Constants that are relating to the controllers.
    static class 
    -
    Constants.Intake
    +
    Constants.Drive
    -
    Constants for the Intake System
    +
    Constants for the Drivetrain
    static class 
    -
    Constants.Limelight
    +
    Constants.Intake
    -
    Holds contstants for the Limelights.
    +
    Constants for the Intake System
    static class 
    -
    Constants.Mailbox
    +
    Constants.Limelight
    -
    Constants for the Mailbox system
    +
    Holds contstants for the Limelights.
    static class 
    -
    Constants.MailboxBelts
    +
    Constants.Mailbox
    -
    Constants for the Belts system.
    +
    Constants for the Mailbox system
    static class 
    -
    Constants.MailboxPneumatics
    +
    Constants.MailboxBelts
    +
    Constants for the Belts system.
    +
    +
    static class 
    +
    Constants.MailboxPneumatics
    +
    Constants for the Pneumatics system.
    • diff --git a/javadoc/frc/robot/RobotContainer.html b/javadoc/frc/robot/RobotContainer.html index 5f599579..d8bfdee2 100644 --- a/javadoc/frc/robot/RobotContainer.html +++ b/javadoc/frc/robot/RobotContainer.html @@ -89,44 +89,49 @@

    Field Summary

    Modifier and Type
    Field
    Description
    -
    static Drive
    -
    drive
    +
    static Climber
    +
    climber
    -
    Singleton instance of Drive for the whole robot.
    +
    Singleton instance of Climber for the whole robot.
    -
    static edu.wpi.first.wpilibj2.command.button.CommandXboxController
    -
    driverController
    +
    static Drive
    +
    drive
    -
    Xbox controller for the driver.
    +
    Singleton instance of Drive for the whole robot.
    -
    static Intake
    -
    intake
    +
    static edu.wpi.first.wpilibj2.command.button.CommandXboxController
    +
    driverController
    -
    Singleton instance of Intake for the whole robot.
    +
    Xbox controller for the driver.
    -
    static Limelight
    -
    limelight
    +
    static Intake
    +
    intake
    -
    Singleton instance of Limelight for aiming.
    +
    Singleton instance of Intake for the whole robot.
    -
    static Mailbox
    -
    mailbox
    +
    static Limelight
    +
    limelight
    -
    Singleton instance of Mailbox for the whole robot.
    +
    Singleton instance of Limelight for aiming.
    -
    static MailboxBelts
    -
    mailboxBelts
    +
    static Mailbox
    +
    mailbox
    -
    Singleton instance of MailboxBelts for the whole robot.
    +
    Singleton instance of Mailbox for the whole robot.
    -
    static MailboxPneumatics
    -
    mailboxPneumatics
    +
    static MailboxBelts
    +
    mailboxBelts
    -
    Singleton instance of MailboxPneumatics for the whole robot.
    +
    Singleton instance of MailboxBelts for the whole robot.
    -
    static UrMom
    -
    urMom
    +
    static MailboxPneumatics
    +
    mailboxPneumatics
    +
    Singleton instance of MailboxPneumatics for the whole robot.
    +
    +
    static UrMom
    +
    urMom
    +
    Singleton instance of UrMom for the whole robot.
    @@ -270,6 +275,13 @@

    urMom

  • +
    +

    climber

    +
    public static Climber climber
    +
    Singleton instance of Climber for the whole robot.
    +
    +
    • +

  • driverController

    public static edu.wpi.first.wpilibj2.command.button.CommandXboxController driverController
    diff --git a/javadoc/frc/robot/commands/ClimbDown.html b/javadoc/frc/robot/commands/ClimbDown.html new file mode 100644 index 00000000..c027640a --- /dev/null +++ b/javadoc/frc/robot/commands/ClimbDown.html @@ -0,0 +1,231 @@ + + + + +ClimbDown (robot2024 API) + + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package frc.robot.commands
    +

    Class ClimbDown

    +
    +
    java.lang.Object +
    edu.wpi.first.wpilibj2.command.Command +
    frc.robot.commands.ClimbDown
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    edu.wpi.first.util.sendable.Sendable
    +
    +
    +
    public class ClimbDown +extends edu.wpi.first.wpilibj2.command.Command
    +
    Climbs the robot down until the command is stopped.
    +
    +
    +
      + +
    • +
      +

      Nested Class Summary

      +
      +

      Nested classes/interfaces inherited from class edu.wpi.first.wpilibj2.command.Command

      +edu.wpi.first.wpilibj2.command.Command.InterruptionBehavior
      +
      +
      • + +
    • +
      +

      Field Summary

      +
      +

      Fields inherited from class edu.wpi.first.wpilibj2.command.Command

      +m_requirements
      +
      +
      • + +
    • +
      +

      Constructor Summary

      +
      Constructors
      +
      +
      Constructor
      +
      Description
      +
      ClimbDown()
      +
      +
      Creates a new ClimbDown
      +
      +
      +
      +
      • + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      void
      +
      end(boolean interrupted)
      +
       
      +
      void
      +
      execute()
      +
       
      +
      void
      +
      initialize()
      +
       
      +
      boolean
      +
      isFinished()
      +
       
      +
      +
      +
      +
      +

      Methods inherited from class edu.wpi.first.wpilibj2.command.Command

      +addRequirements, alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, finallyDo, finallyDo, getInterruptionBehavior, getName, getRequirements, getSubsystem, handleInterrupt, hasRequirement, ignoringDisable, initSendable, isScheduled, onlyIf, onlyWhile, raceWith, repeatedly, runsWhenDisabled, schedule, setName, setSubsystem, unless, until, withInterruptBehavior, withName, withTimeout
      +
      +

      Methods inherited from class java.lang.Object

      +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        ClimbDown

        +
        public ClimbDown()
        +
        Creates a new ClimbDown
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        initialize

        +
        public void initialize()
        +
        +
        Overrides:
        +
        initialize in class edu.wpi.first.wpilibj2.command.Command
        +
        +
        +
        • +
      • +
        +

        execute

        +
        public void execute()
        +
        +
        Overrides:
        +
        execute in class edu.wpi.first.wpilibj2.command.Command
        +
        +
        +
        • +
      • +
        +

        end

        +
        public void end(boolean interrupted)
        +
        +
        Overrides:
        +
        end in class edu.wpi.first.wpilibj2.command.Command
        +
        +
        +
        • +
      • +
        +

        isFinished

        +
        public boolean isFinished()
        +
        +
        Overrides:
        +
        isFinished in class edu.wpi.first.wpilibj2.command.Command
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    +
    +
    + + diff --git a/javadoc/frc/robot/commands/ClimbUp.html b/javadoc/frc/robot/commands/ClimbUp.html new file mode 100644 index 00000000..e3121c4f --- /dev/null +++ b/javadoc/frc/robot/commands/ClimbUp.html @@ -0,0 +1,231 @@ + + + + +ClimbUp (robot2024 API) + + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package frc.robot.commands
    +

    Class ClimbUp

    +
    +
    java.lang.Object +
    edu.wpi.first.wpilibj2.command.Command +
    frc.robot.commands.ClimbUp
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    edu.wpi.first.util.sendable.Sendable
    +
    +
    +
    public class ClimbUp +extends edu.wpi.first.wpilibj2.command.Command
    +
    Climbs the robot up until the command is stopped.
    +
    +
    +
      + +
    • +
      +

      Nested Class Summary

      +
      +

      Nested classes/interfaces inherited from class edu.wpi.first.wpilibj2.command.Command

      +edu.wpi.first.wpilibj2.command.Command.InterruptionBehavior
      +
      +
      • + +
    • +
      +

      Field Summary

      +
      +

      Fields inherited from class edu.wpi.first.wpilibj2.command.Command

      +m_requirements
      +
      +
      • + +
    • +
      +

      Constructor Summary

      +
      Constructors
      +
      +
      Constructor
      +
      Description
      +
      ClimbUp()
      +
      +
      Creates a new ClimbUp.
      +
      +
      +
      +
      • + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      void
      +
      end(boolean interrupted)
      +
       
      +
      void
      +
      execute()
      +
       
      +
      void
      +
      initialize()
      +
       
      +
      boolean
      +
      isFinished()
      +
       
      +
      +
      +
      +
      +

      Methods inherited from class edu.wpi.first.wpilibj2.command.Command

      +addRequirements, alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, finallyDo, finallyDo, getInterruptionBehavior, getName, getRequirements, getSubsystem, handleInterrupt, hasRequirement, ignoringDisable, initSendable, isScheduled, onlyIf, onlyWhile, raceWith, repeatedly, runsWhenDisabled, schedule, setName, setSubsystem, unless, until, withInterruptBehavior, withName, withTimeout
      +
      +

      Methods inherited from class java.lang.Object

      +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        ClimbUp

        +
        public ClimbUp()
        +
        Creates a new ClimbUp.
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        initialize

        +
        public void initialize()
        +
        +
        Overrides:
        +
        initialize in class edu.wpi.first.wpilibj2.command.Command
        +
        +
        +
        • +
      • +
        +

        execute

        +
        public void execute()
        +
        +
        Overrides:
        +
        execute in class edu.wpi.first.wpilibj2.command.Command
        +
        +
        +
        • +
      • +
        +

        end

        +
        public void end(boolean interrupted)
        +
        +
        Overrides:
        +
        end in class edu.wpi.first.wpilibj2.command.Command
        +
        +
        +
        • +
      • +
        +

        isFinished

        +
        public boolean isFinished()
        +
        +
        Overrides:
        +
        isFinished in class edu.wpi.first.wpilibj2.command.Command
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    +
    +
    + + diff --git a/javadoc/frc/robot/commands/package-summary.html b/javadoc/frc/robot/commands/package-summary.html index 851ff30a..d699ad3a 100644 --- a/javadoc/frc/robot/commands/package-summary.html +++ b/javadoc/frc/robot/commands/package-summary.html @@ -94,6 +94,14 @@

    Package frc.robot.commands<
    Aims with the limelight towards an object.
    +
    ClimbDown
    +
    +
    Climbs the robot down until the command is stopped.
    +
    +
    ClimbUp
    +
    +
    Climbs the robot up until the command is stopped.
    +
    DeployUrMom
    Prints "your mom"
    diff --git a/javadoc/frc/robot/commands/package-tree.html b/javadoc/frc/robot/commands/package-tree.html index 6c6fd389..9a3c8bc6 100644 --- a/javadoc/frc/robot/commands/package-tree.html +++ b/javadoc/frc/robot/commands/package-tree.html @@ -61,6 +61,8 @@

    Class Hierarchy

  • edu.wpi.first.wpilibj2.command.Command (implements edu.wpi.first.util.sendable.Sendable)

    • diff --git a/javadoc/frc/robot/package-tree.html b/javadoc/frc/robot/package-tree.html index 6ec29d56..70f54bb9 100644 --- a/javadoc/frc/robot/package-tree.html +++ b/javadoc/frc/robot/package-tree.html @@ -60,6 +60,7 @@

    Class Hierarchy