-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Explicitly make the flywheel an example subsystem
renamed: src/main/java/frc/robot/subsystems/flywheel/Flywheel.java -> src/main/java/frc/robot/subsystems/flywheel_example/Flywheel.java renamed: src/main/java/frc/robot/subsystems/flywheel/FlywheelIO.java -> src/main/java/frc/robot/subsystems/flywheel_example/FlywheelIO.java renamed: src/main/java/frc/robot/subsystems/flywheel/FlywheelIOSim.java -> src/main/java/frc/robot/subsystems/flywheel_example/FlywheelIOSim.java renamed: src/main/java/frc/robot/subsystems/flywheel/FlywheelIOSparkMax.java -> src/main/java/frc/robot/subsystems/flywheel_example/FlywheelIOSparkMax.java renamed: src/main/java/frc/robot/subsystems/flywheel/FlywheelIOTalonFX.java -> src/main/java/frc/robot/subsystems/flywheel_example/FlywheelIOTalonFX.java new file: src/main/java/frc/robot/subsystems/flywheel_example/README
- Loading branch information
Showing
6 changed files
with
38 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
33 changes: 33 additions & 0 deletions
33
src/main/java/frc/robot/subsystems/flywheel_example/README
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| This directory contains an example generic flywheel subsystem, as distributed | ||
| with AdvantageKit. The structure of the subsystem directory is: | ||
|
|
||
| * Flywheel.java | ||
| The base subsystem definitions and outward-facing (public) hardware- | ||
| agnostic functions for interacting with the subsystem. The idea is | ||
| that any of the hardware-specific (i.e. motor controller API calls) | ||
| functionality is insulated from the rest of the robot code within | ||
| the library-specific modules in this directory. | ||
|
|
||
| * FlywheelIO.java | ||
| The base subsystem I/O (input/output) interface that contains the | ||
| structure and class varibales needed by the library-specific modules. | ||
|
|
||
| * FlywheelIOSim.java | ||
| Simulated flywheel module, for use with robot simulations, does not | ||
| control actual hardware. | ||
|
|
||
| * FlywheelIOSparkMax.java | ||
| An example implementation of a flywheel using Rev SparkMax motor | ||
| controllers (and their associated library APIs). | ||
|
|
||
| * FlywheelIOTalonFX.java | ||
| An example implementation of a flywheel using CTRE TalonFX motor | ||
| controllers (and their associated library APIs). | ||
|
|
||
| -------------------- | ||
| When creating a new mechanism subsystem, consider using this generic framework | ||
| for public vs. private functions and API calls to make your code more modular | ||
| and reusable from year to year. Additionally, the I/O framework given here | ||
| interfaces with AdvantageKit's logging to allow for replay of inputs and | ||
| testing of code changes in simulation. | ||
|
|