-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
75 lines (49 loc) · 4.5 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# FRC-2022
[](https://repl.it/github/jhs-viking-robotics/FRC-2022)
Team 7221 code for the 2022 FRC season. This project can be found on GitHub at [JHS-Viking-Robotics/FRC-2022](https://github.com/JHS-Viking-Robotics/FRC-2022). You can also find the 2021 code for Heimdall on the ```main-heimdall-2021``` branch.
New to this project? Head on over to our [Java-Hello-World tutorial](https://github.com/JHS-Viking-Robotics/Java-Hello-World) and return back here once you feel comfortable with Java. Then check out the [Getting Started](#getting-started) section for some quick tips, and happy hacking!
## Contents
- [Quick Setup](#quick-setup)
- [Getting Started](#getting-started)
- [Hardware Setup](#hardware-setup)
- [Deploying To RoboRIO](#deploying-to-roborio)
- [Controls Layout](#controls-layout)
- [Style Guide](#style-guide)
- [Other Notes](#other-notes)
- [Feature Requests And Bug Reporting](#feature-requests-and-bug-reporting)
- [Learn More About The Team](#learn-more-about-the-team)
## Quick Setup
Using a computer set up as a Driver Station, pull this repository from GitHub using the instructions on the big green ```Code``` button. Connect the computer to the robot with a USB or Ethernet cable. In VS Code, press ```Ctrl + Shift + P``` to bring up the command palette, type ```WPILib: Deploy Robot Code```, and hit enter. Now you should be able to drive the robot using the Driver Station.
## Getting Started
The following sections contain useful information if you want to deploy or develop this code.
### Hardware Setup
Our robot follows the following conventions. All devices are updated with the latest firmware, and are always connected pos <--> pos and grd <--> grd (inversion is only handled in the code). You can find pictures of the robot [on our website](https://www.jhsvikingrobotics.com/this-year-s-robots). We are using RevRobotics [SparkMAX Motor Controllers](https://www.revrobotics.com/rev-11-2158/) and [NEO Brushless Motors](https://www.revrobotics.com/rev-21-1650/)
Subsystem | Motor(s) | Controller(s) | Sensor(s)
:-:|:-:|:-:|:-:
Drivetrain | 4 x NEO | 4 x SparkMAX | 4 x Internal
Shooter | 2 x NEO | 2 x SparkMAX | (not used)
Intake | 1 x NEO | 1 x SparkMAX | (not used)
Lift | 1 x NEO | 1 x SparkMAX | (not used)
We also have a [CTRE PCM](https://store.ctr-electronics.com/pneumatic-control-module/) which manages the "trigger" piston on our shooter system. All the equipment is standard KOP stuff.
### Deploying To RoboRIO
To deploy the code to the RoboRIO, pull this repository from GitHub using the instructions on the big green ```Code``` button. Choose the tag on the ```main``` branch depending on which version you need, or leave it alone to use the latest version. Code on the ```development``` branch is under testing and not necessarily functional.
### Controls Layout
During testing, each subsystem will manage its own tab on the ```Shuffleboard```. For competition code, these tabs will not be available so the buttons don't accidentally get triggered. The following is the current controls layout:
Action | Button | Notes
:-:|:-:|:-:
Enable/Disable FOD | Dashboard | Field Oriented Driving (FOD) makes all movements act relative to the field rather than the robot
Drive Slide | Left Stick | Drives the robot forward/backward/left/right Mecanum style
Drive Rotation | Right Stick | Rotates the robot clockwise/counter-clockwise
Toggle Shooter | X Button | Toggles the Shooter motors on/off
Fire Shooter | Y Button | Fires the Shooter piston and automatically retracts it
Run Intake | Bumpers | Run the intake while either bumper is help
Raise Lift | Secondary Controller Y Button | Raise the Lift when held
Lower Lift | Secondary Controller A Button | Lower the Lift when held
### Style Guide
We do not yet have a strict style guide. Generally we expect new commits to follow the same styling as the rest of the code.
All methods, members, and code blocks should have javadocs and comments to make them easily understandable to other developers.
For pull requests and commit messages, check out the [Team 7221 Docs](https://jhs-viking-robotics.github.io/Java-Hello-World/) for templates and guidelines.
## Feature Requests And Bug Reporting
Find something broken, or see something you don't like? Open a Bug Report or a Feature Request using the provided templates. We'll do our best to help out!
## Learn More About The Team
Interested in sponsoring us or getting to know our team? Check out [our website](https://www.jhsvikingrobotics.com/)!