Skip to content

Commit 93872ef

Browse files
some more changes
1 parent dd570d1 commit 93872ef

4 files changed

Lines changed: 6 additions & 6 deletions

File tree

docs/section-3/basic-control.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Now that we know the electronics on the robot, how do we actually control them? This section will provide a general overview, so if you want more details look in their respective javadocs and documentation.
22

33
## Motor Controllers/Motors
4-
Typical motor controllers that you will be using are Spark Maxes and Talon SRXs. Their respective class names are `SparkMax` and `WPI_TalonSRX`. There are other types of motor controllers. If you wish to know more about other motors, you can always look at their documentation. The information provided here should be present in all motor controllers.
4+
Typical motor controllers that you will be using are Spark Maxes and Spark Flexes. Their respective class names are `SparkMax` and SparkFlex`. There are other types of motor controllers. If you wish to know more about other motors, you can always look at their documentation. The information provided here should be present in all motor controllers.
55

66
### Creation
77

@@ -15,7 +15,7 @@ SparkMax motor = new SparkMax([insert port number], MotorType.kBrushless);
1515

1616
The two motor types: `kBrushless` and `kBrushed` require the controller to power the motors in different ways, and you can end up destroying the motor by using the wrong motor type. The easiest way to tell the difference is that brushless motors use three wires while brushed motors use two. Most of the motors we will use with SparkMaxes are brushless.
1717

18-
Lib199 is a repository which contains many methods and objects we reuse over many projects and years. Now let's use lib199's MotorControllerFactory methodto create the SparkMax
18+
Lib199 is a repository which contains many methods and objects we reuse over many projects and years. Now let's use lib199's MotorControllerFactory method to create the SparkMax
1919

2020
``` Java
2121
SparkMax motor = MotorControllerFactory.createSparkMax([motor id], MotorConfig.NEO);
@@ -52,7 +52,7 @@ Generally most motors will have the following methods. You can always go to thei
5252
### Debugging/Updating
5353
- Motors have LED lights signifying their current status. You can find them on their website.
5454

55-
- [SparkMax](https://docs.revrobotics.com/sparkmax/status-led)
55+
- [SparkMax](https://docs.revrobotics.com/brushless/spark-max/status-led)
5656
- [SparkFlex](https://docs.revrobotics.com/brushless/spark-flex/status-led)
5757

5858
- Other than javadocs, these websites provide more information on installation of motor controller (Senac's job)

docs/section-3/subsystems-and-commands.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Subsystems are where much of the logic of the code is stored. In each subsystem,
6363
Commands are sections of code that define general actions taken by the robot. Usually, they don’t contain detailed code about the function of the robot’s mechanical parts, such as how far a motor turns or its direction (these finer details are usually placed in subsystems, which commands then reference to give function to each of the robot’s mechanical components). Instead, commands code for actions taken by the robot’s mechanisms. Examples of these actions could include lifting an arm or turning wheels that intake a game piece. Command classes also have methods `initialize()`, `execute()`, `end()`, and `isFinished()` that serve as a base foundation (More details are in WPILib's article). Each command also have subsystem requirements. This is to avoid scheduling commands that may interfere with each other. For example, one command may want a motor to turn right, while another command wants the motor to turn left. Adding requirements make sure that only one command is using a subsystem at a time. You can add requirements by using the `addRequirements()`.
6464

6565
### Lib
66-
The `lib` folder is where we would store the complex calculations, wrappers, or other things that do not directly interact with the robot, but are rather called on by commands or subsystems to assist in their execution. Stuff in this folder would be valuable code that we would actually want to keep and develop on from one year to another, such as drivetrain characterization, motion profiling, or swerve drive code. We usually don't include a folder decicated to Lib in our projects, but rather ue the lib199 repository.
66+
The `lib` folder is where we would store the complex calculations, wrappers, or other things that do not directly interact with the robot, but are rather called on by commands or subsystems to assist in their execution. Stuff in this folder would be valuable code that we would actually want to keep and develop on from one year to another, such as drivetrain characterization, motion profiling, or swerve drive code. We usually don't include a folder decicated to Lib in our projects, but rather use the lib199 repository.
6767

6868
Most of this code is stored in the repository [lib199](https://github.com/DeepBlueRobotics/lib199) which is included in the gradle build to our main robot code. This makes it easy to include in new robot projects and other codebases. The `lib` folder is accessed through gradle build configurations, so you have to directly go the lib199 repo to see the code. It will not be in your project.
6969

docs/section-4/auton.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@ More requirements for autonomous:
1515

1616
- it must use a command group (look in the documentation if you forgot what that is) to run the autonomous period, with one command for moving and the other for spinning
1717
- it can only use the encoder values to tell the command whether or not you have traveled far enough
18-
- it should not overshoot by a wide margin, but as long as it goes around 2 feet it's acceptable
18+
- it should not overshoot or undershoot by a wide margin, but as long as it goes around 2 feet it's acceptable
1919

2020
Good luck! Again, once you're done, check in with a veteran programmer and then run your code on a robot!

docs/section-5/delegation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Bugs or features which have to be worked on/implemented should have an issue ope
44
[Read more about Github Issues here](https://guides.github.com/features/issues/)
55

66
## Shadowing Team Members
7-
Programming team members who are not fully ready to work independently during build season should shadow a more experienced member. Experienced members who have a shadowing programmer should explain and talk about their code as they write it, and should try to teach the shadow as much as they can.
7+
Programming team members who are not fully ready to work independently during build season should shadow a more experienced member. Experienced members who have a shadowing programmer should explain and talk about their code as they write it and try to teach the shadow as much as they can.
88

99
## Build Season Schedule
1010

0 commit comments

Comments
 (0)