Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add some docs #5

Merged
merged 3 commits into from
Jan 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!--- Provide a general summary of the issue in the Title above -->

## Description
<!--- Provide a more detailed introduction to the issue itself, and why you consider it to be a bug -->

## Expected Behavior
<!--- Tell us what should happen -->

## Actual Behavior
<!--- Tell us what happens instead -->

## Possible Fix
<!--- Not obligatory, but suggest a fix or reason for the bug -->

## Steps to Reproduce
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
<!--- reproduce this bug. Include code to reproduce, if relevant -->
1.
1.
1.
1.

## Context
<!--- How has this bug affected you? What were you trying to accomplish? -->
20 changes: 20 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Description

Please include a summary of the changes -- include relevant motivation and context.

## Type of change
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Bugfix (non-breaking change which fixes an issue, add DEF # above in description)
- [ ] Environment change (changes to developer environment or CI configuration)
- [ ] Documentation Update (if none of the other choices apply)

# How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Please also list any relevant details for your test configuration. Identify any new potential hazards or risks introduced.

# Author Checklist:
- [ ] I have performed a self-review of my code
- [ ] I have added 1-2 reviewers
- [ ] I have @mentioned relevant non-reviewers as an FYI
- [ ] I have included a detailed description of my changes and their motivations
46 changes: 38 additions & 8 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,20 +36,50 @@ todo: add picture of robot cad

The motors that move the robot chassis around the field.

* Actuators:
* todo
* todo

* Sensors:
* todo
* Motors
* 4x - Falcon500 swere modules (2 Falcon500s per module)
* Sensors
* Pigeon IMU for measuring robot heading and pitch

### Intake
Picks up game pieces off the ground. Hands them off to the hopper

* Motors
* `tbd`x Falcon 500
* Velocity closed loop control

* Sensors
* `tbd`

### Shooter
Motors at the front of the shooter assembly that allow game pieces to be fired out of the robot.

### Intake
* Motors
* `tbd`x - Falcon 500
* Velocity closed loop control

### Hopper
Brings in game pieces from the intake. Stores them until the shooter is ready to be fired.

* Motors
* `tbd`x - Falcon 500
* `tbd` - Velocity closed loop control

### Linear Lift

Moves the shooter assembly vertically to differnt heights

* Motors
* `tbd`x - Falcon 500
* Motion Magic - position closed loop control

### Shoulder

### Lift / Climber
Rotates the shooter assembly to change pitch angle

* Motors
* `tbd`x - Falcon 500
* Motion Magic - position closed loop control

## Getting Started

Expand Down
12 changes: 6 additions & 6 deletions vendordeps/photonlib.json
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
{
"fileName": "photonlib.json",
"name": "photonlib",
"version": "v2024.1.2",
"version": "v2024.1.4",
"uuid": "515fe07e-bfc6-11fa-b3de-0242ac130004",
"frcYear": "2024",
"mavenUrls": [
"https://maven.photonvision.org/repository/internal",
"https://maven.photonvision.org/repository/snapshots"
],
"jsonUrl": "https://maven.photonvision.org/repository/internal/org/photonvision/PhotonLib-json/1.0/PhotonLib-json-1.0.json",
"jsonUrl": "https://maven.photonvision.org/repository/internal/org/photonvision/photonlib-json/1.0/photonlib-json-1.0.json",
"jniDependencies": [],
"cppDependencies": [
{
"groupId": "org.photonvision",
"artifactId": "photonlib-cpp",
"version": "v2024.1.2",
"version": "v2024.1.4",
"libName": "photonlib",
"headerClassifier": "headers",
"sharedLibrary": true,
Expand All @@ -29,7 +29,7 @@
{
"groupId": "org.photonvision",
"artifactId": "photontargeting-cpp",
"version": "v2024.1.2",
"version": "v2024.1.4",
"libName": "photontargeting",
"headerClassifier": "headers",
"sharedLibrary": true,
Expand All @@ -46,12 +46,12 @@
{
"groupId": "org.photonvision",
"artifactId": "photonlib-java",
"version": "v2024.1.2"
"version": "v2024.1.4"
},
{
"groupId": "org.photonvision",
"artifactId": "photontargeting-java",
"version": "v2024.1.2"
"version": "v2024.1.4"
}
]
}