Skip to content

Commit 616b01a

Browse files
committed
Fixed additional markdown formatting errors.
1 parent 04d3b64 commit 616b01a

File tree

8 files changed

+95
-95
lines changed

8 files changed

+95
-95
lines changed

docs/programming/autonomous.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@ In this section we will be going over:
2929

3030
## Creating a basic Autonomous Command
3131

32-
!!! summary ""
32+
!!! abstract ""
3333
**1)** Create a new command called **AutoCommand** using the `create new class/command` feature in Vscode.
3434

3535

36-
!!! summary ""
36+
!!! abstract ""
3737
**2)** Before the constructor create a **double** called **distance**
3838
```java
3939
private Double distance;
@@ -49,33 +49,33 @@ In this section we will be going over:
4949

5050
- This will be used to control how long the robot will move for.
5151

52-
!!! summary ""
52+
!!! abstract ""
5353
**3)** In the **AutoCommand** constructor add a **DriveSubsystem** parameter called **driveSubsystem**
5454

55-
!!! summary ""
55+
!!! abstract ""
5656
**4)** Inside type:
5757

5858
```java
5959
distance = inches;
6060
```
6161

62-
!!! summary ""
62+
!!! abstract ""
6363
**5)** In **initialize** add our **resetDriveEncoder** method
6464

6565
- We want to reset the encoder before we drive so that it counts the distance from zero
6666

67-
!!! summary ""
67+
!!! abstract ""
6868
**6)** In **execute** add our **arcadeDrive** method and change the **moveSpeed** parameter to a **RobotPreference** named **driveDistanceSpeed** and **rotateSpeed** to 0.0
6969

7070
- We only want to drive the robot forward; a **RobotPreference** will help us tune the drive speed
7171

72-
!!! summary ""
72+
!!! abstract ""
7373
**7)** In **isFinished** type:
7474

7575
```java
7676
return Robot.m_drivetrain.getDriveEncoderDistance() == distance;
7777
```
78-
!!! summary ""
78+
!!! abstract ""
7979
**8)** In **end** stop the **Drivetrain** and call **end** in **interrupted**
8080

8181
??? Example
@@ -137,10 +137,10 @@ In this section we will be going over:
137137

138138
- We will create an **Autonomous command group** with the **DriveDistance** command and the **ShooterPitchUp** command
139139

140-
!!! summary ""
140+
!!! abstract ""
141141
**1)** Create a new **Command Group** named **Autonomous**
142142

143-
!!! summary ""
143+
!!! abstract ""
144144
**2)** In the constructor type
145145

146146
```java
@@ -155,30 +155,30 @@ In this section we will be going over:
155155
- In order to add timing in between our **commands** in our **command groups** we will need to create a **DoDelay** command
156156
- Unlike regular **delays** the **DoDelay** command will not stall our robot, but wait a certain amount of time before running a command
157157

158-
!!! summary ""
158+
!!! abstract ""
159159
**1)** Create a new command called **DoDelay**
160160

161-
!!! summary ""
161+
!!! abstract ""
162162
**2)** Before the constructor add two private **doubles** called **expireTime** and **timeout**
163163

164-
!!! summary ""
164+
!!! abstract ""
165165
**3)** In the constructor add a **double** called **seconds** in the parameter
166166

167-
!!! summary ""
167+
!!! abstract ""
168168
**4)** Inside the constructor set **timeout** equal to **seconds**
169169

170-
!!! summary ""
170+
!!! abstract ""
171171
**5)** Create a protected **void** method called **startTimer**
172172

173-
!!! summary ""
173+
!!! abstract ""
174174
**6)** Inside set **expireTime** equal to **timeSinceInitialized** + **timeout**
175175

176176
- This will let the robot know how much time will have passed since the command was initialized when it finishes
177177

178-
!!! summary ""
178+
!!! abstract ""
179179
**7)** In **initialized** add our **startTimer** method
180180

181-
!!! summary ""
181+
!!! abstract ""
182182
**8)** In **isFinished** return **timeSinceInitialized** is greater or equal to **expireTime**
183183

184184
??? Example
@@ -237,7 +237,7 @@ In this section we will be going over:
237237

238238
## Adding the DoDelay Command to Autonomous.java
239239

240-
!!! summary ""
240+
!!! abstract ""
241241
- Add our **DoDelay** command in between **DriveDistance** and **ShooterPitchUp** with a **RobotPreference** called **autoDelay**
242242

243243
??? Example

docs/programming/deploying.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ To deploy code, first make sure your computer is connected to the robot in **ON
2727
!!! note
2828
Make sure your team number in **wpilib_preferences.json** in the **.wpilib** folder is set to the same team number your roboRIO was programmed for (it should be the number you set when creating the project and you will NOT need to check this every time as it should not change by itself).
2929

30-
!!! summary “”
30+
!!! abstract “”
3131
**1)** Select the **W icon** from the tab bar or use the shortcut by holding down **Ctrl+Shift+P** at the same time. (Replace ctrl with cmd on macOS)
3232

3333
![](../assets/images/deploying/w_icon.png)
3434

35-
!!! summary “”
35+
!!! abstract “”
3636
**2)** Type and hit enter or select: WPILib: Deploy Robot Code
3737

3838
![](../assets/images/deploying/deploy_command.png)

docs/programming/new_project.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,36 +15,36 @@ Before we can start programing a robot, we must create a new project in Visual S
1515

1616
## Creating a New Project
1717

18-
!!! summary ""
18+
!!! abstract ""
1919
**1)** Select the **W icon** from the tab bar or use the shortcut by holding down **Ctrl+Shift+P** at the same time. (Replace ctrl with command on macOS)
2020

2121
![](../assets/images/new_project/project/step_1.png)
2222

23-
!!! summary ""
23+
!!! abstract ""
2424
**2)** Type and hit enter or select **WPILib: Create a new project**
2525

2626
![](../assets/images/new_project/project/step_2.png)
2727

28-
!!! summary ""
28+
!!! abstract ""
2929
**3)** Click **Select a Project Type** and choose **Template**
3030
**4)** Click **Select a Language** and choose **Java**
3131
**5)** Click **Select a project base** and choose **Command Robot**
3232

3333
![](../assets/images/new_project/project/step_3.png)
3434

35-
!!! summary ""
35+
!!! abstract ""
3636
**6)** Click **Select a new project folder** and choose where on your computer you would like to store the program
3737

3838
![](../assets/images/new_project/project/step_4.png)
3939

40-
!!! summary ""
40+
!!! abstract ""
4141
**7)** **Enter a project name** in the text field labeled as such
4242
**8)** **Enter your team number** in the text field labeled as such
4343
**9)** Select **Generate Project**
4444

4545
![](../assets/images/new_project/project/step_5.png)
4646

47-
!!! summary ""
47+
!!! abstract ""
4848
**10)** When prompted **“Would you like to open the folder?”**, select **Yes (Current Window)**
4949

5050
![](../assets/images/new_project/project/step_6.png)
@@ -82,24 +82,24 @@ Newly created projects have many files within them. We only care about the conte
8282

8383
## Creating a New Subsystem
8484

85-
!!! summary ""
85+
!!! abstract ""
8686
**1)** Click on the **src** folder to expand it.
8787
**2)** Do the same for **java** then **subsystems**
8888

8989
![](../assets/images/new_project/subsystem/step_1.png)
9090

91-
!!! summary ""
91+
!!! abstract ""
9292
**3)** Right click on **subsystems** and select **Create a new class/ command.**
9393

9494
![](../assets/images/new_project/subsystem/step_2.png)
9595

96-
!!! summary ""
96+
!!! abstract ""
9797
**4)** Select **Subsystem (New)** and type your **DesiredSubsystemName** (i.e. **Drivetrain**) for the name and hit enter on your keyboard.
9898

9999
![](../assets/images/new_project/subsystem/step_3.png)
100100
![](../assets/images/new_project/subsystem/step_4.png)
101101

102-
!!! summary ""
102+
!!! abstract ""
103103
**5)** Click on the newly created **DesiredSubsystemName.java** (or **Drivetrain.java** if you named it that)
104104

105105
![](../assets/images/new_project/subsystem/step_5.png)
@@ -113,7 +113,7 @@ Newly created projects have many files within them. We only care about the conte
113113

114114
!!! danger "***We must do this for EVERY subsystem we create***"
115115

116-
!!! summary ""
116+
!!! abstract ""
117117
**1)** In RobotContainer.java we will create a new **public** **global** **constant** variable of type `DesiredSubsystemName` (i.e. `Drivetrain`):
118118
`public static final m_desiredSubsystemName = new DesiredSubsystemName();`
119119
(i.e. `public static final m_drivetrain = new Drivetrain();`)
@@ -156,24 +156,24 @@ Newly created subsystems are empty with the exception of the periodic.
156156

157157
## Creating a New Command
158158

159-
!!! summary ""
159+
!!! abstract ""
160160
**1)** Click on the **src** folder to expand it (if it isn't already).
161161
**2)** Do the same for **commands**
162162

163163
![](../assets/images/new_project/command/step_1.png)
164164

165-
!!! summary ""
165+
!!! abstract ""
166166
**3)** Right click on **commands** and select **Create a new class/ command.**
167167

168168
![](../assets/images/new_project/command/step_2.png)
169169

170-
!!! summary ""
170+
!!! abstract ""
171171
**4)** Select **Command (New)** and type **DesiredCommandName** (i.e. DriveArcade) for the name and hit enter on your keyboard.
172172

173173
![](../assets/images/new_project/command/step_3.png)
174174
![](../assets/images/new_project/command/step_4.png)
175175

176-
!!! summary ""
176+
!!! abstract ""
177177
**5)** Click on the newly created **DesiredCommandName.java** (or **DriveArcade.java** if you named it that)
178178

179179
![](../assets/images/new_project/command/step_5.png)

docs/programming/pneumatics.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ See [Creating a New Subsystem](new_project.md#creating-a-new-subsystem){target=_
3939

4040
### What will be added to the Shooter subsystem
4141

42-
!!! summary ""
42+
!!! abstract ""
4343
**1)**
4444

4545
- Create a new Shooter subsystem.
@@ -50,7 +50,7 @@ See [Creating a New Subsystem](new_project.md#creating-a-new-subsystem){target=_
5050
- Port 1 and Port 2 refer to Forward control and Reverse control ports on the PCM.
5151
- Like all ports we use, we will store this in the RobotMap.
5252

53-
!!! summary ""
53+
!!! abstract ""
5454
**2)** Create your DoubleSolenoid named pitchSolenoid now using the same technique used to create a talon but replacing Talon with DoubleSolenoid. (For single solenoids just use Solenoid).
5555

5656
??? Example
@@ -104,10 +104,10 @@ See [Creating a New Subsystem](new_project.md#creating-a-new-subsystem){target=_
104104

105105
### Creating Pitch Up/Down Methods
106106

107-
!!! summary ""
107+
!!! abstract ""
108108
**1)** Create a public void method called pitchUp.
109109

110-
!!! summary ""
110+
!!! abstract ""
111111
**2)** Inside type:
112112

113113
```java
@@ -118,7 +118,7 @@ See [Creating a New Subsystem](new_project.md#creating-a-new-subsystem){target=_
118118
!!! note
119119
if you wanted multiple solenoids to deploy at the same time also have them do .set(Value.kForward);
120120

121-
!!! summary ""
121+
!!! abstract ""
122122
**3)** Do the same for the **pitchDown** method but change **kForward** to **kReverse**.
123123

124124
??? Example
@@ -144,18 +144,18 @@ See [Creating a New Subsystem](new_project.md#creating-a-new-subsystem){target=_
144144
- **InstantCommands** work the same as regular commands but hide everything except for initialize(). (InstantCommand extends Command)
145145
- Internally, they set isFinished to return always true so execute never runs.
146146

147-
!!! summary ""
147+
!!! abstract ""
148148
**1)** Create a new **InstantCommand** called **ShooterUp**
149149

150150
- Alternatively: Create a regular **Command** and set **isFinished** to **true**
151151

152-
!!! summary ""
152+
!!! abstract ""
153153
**2)** In the constructor adds requires(Robot.m_shooter)
154154

155-
!!! summary ""
155+
!!! abstract ""
156156
**3)** In initialize() add our newly created method **pitchUp** method
157157

158-
!!! summary ""
158+
!!! abstract ""
159159
**4)** Repeat steps for **ShooterDown** command but change **pitchUp* to **pitchDown**
160160

161161
??? Example
@@ -229,13 +229,13 @@ See [Creating a New Subsystem](new_project.md#creating-a-new-subsystem){target=_
229229
- Now that we have created our ShooterUp and ShooterDown commands we need a way to run them.
230230
- Lets map them to buttons on our controller!
231231

232-
!!! summary ""
232+
!!! abstract ""
233233
**1)** Open OI.java
234234

235-
!!! summary ""
235+
!!! abstract ""
236236
**2)** Under our created joystick we will create Button variables and assign them to a button on our joystick
237237

238-
!!! summary ""
238+
!!! abstract ""
239239
**3)** Type:
240240

241241
```java
@@ -244,7 +244,7 @@ See [Creating a New Subsystem](new_project.md#creating-a-new-subsystem){target=_
244244

245245
- This creates a new Button named D1 (D representing driverController and 1 representing the button number) and sets it as a JoystickButton on the controller ‘driverController’ and button value 1 (this can be found in the Driverstation software).
246246

247-
!!! summary ""
247+
!!! abstract ""
248248
**4)** Do this for the rest of the buttons on your controller.
249249

250250
??? Example
@@ -282,10 +282,10 @@ See [Creating a New Subsystem](new_project.md#creating-a-new-subsystem){target=_
282282

283283
- Now that we have created the buttons in the code we can map certain commands to them.
284284

285-
!!! summary ""
285+
!!! abstract ""
286286
**1)** Create a constructor for OI
287287

288-
!!! summary ""
288+
!!! abstract ""
289289
**2)** In the constructor type:
290290

291291
```java
@@ -295,7 +295,7 @@ See [Creating a New Subsystem](new_project.md#creating-a-new-subsystem){target=_
295295
- This means **when** the button D1 is **pressed** it runs the ShooterUp command and deploys our pneumatic piston.
296296
- There are other types of activations for buttons besides **whenPressed** like: **whenRelease, whileHeld, etc**.
297297

298-
!!! summary ""
298+
!!! abstract ""
299299
**3)** Create a whenPressed button for ShooterDown as well
300300

301301
??? Example

0 commit comments

Comments
 (0)