Skip to content

Commit ddec0fd

Browse files
noam987Rocky14683
andauthored
Update README.md (#100)
* Update README.md * Update README.md * Update README.md --------- Co-authored-by: THERocky <[email protected]>
1 parent 380743c commit ddec0fd

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,10 @@
44
VOSS is a [PROS](https://pros.cs.purdue.edu/) library that makes writing autonomous code for VEX robots a piece of cake.
55

66
## Installing VOSS
7-
1. Download the most recent [template](https://github.com/purduesigbots/VOSS/releases/tag/0.1.2)
7+
1. Open a PROS terminal via the VSCode extention and run `pros c add-depot VOSS https://pros.cs.purdue.edu/v5/_static/beta/voss-depot.json`
88

9-
2. Run this command from terminal `pros c fetch [email protected]`
10-
11-
3. `cd` into your pros project directory in your terminal
9+
2. `cd` into your pros project directory in your terminal
10+
3. run `pros c info-project`, your kernel version MUST be 4.0.7. If it is not, create a new 4.0.7 project by `cd` into the directory you want to make your project, and run `pros c n PROJECT_NAME -ea`.
1211

1312
4. Apply the library to the project `pros c apply VOSS`
1413

@@ -51,7 +50,7 @@ auto ec = voss::controller::ExitConditions::new_conditions()
5150
* **Track width**
5251
- `.with_track_width(double track_width_distance)`
5352
* **Left right TPI** (ratio of encoder rotations to 1 inch of linear movement)
54-
- `.with_left_right_tip(double tpi_value)`
53+
- `.with_left_right_tpi(double tpi_value)`
5554
3. Call it to build --> `.build()`
5655
```cpp
5756
auto odom = voss::localizer::TrackingWheelLocalizerBuilder::new_builder()
@@ -75,7 +74,7 @@ void initialize() {
7574
3. Divide the amount you moved the robot by the measured movement value from the odometry
7675
* adjustment factor = robot actual move amount/odometry measured amount
7776
4. Set the new tpi value to the current tpi value multiplied by the value you got from step 3
78-
* new tip = old tpi x adjustment factor
77+
* new tpi = old tpi x adjustment factor
7978

8079
### The basics of PID (Proportional Integral Derivative controllers)
8180
* **Linear error** = Linear distance from desired position to current position (inches)
@@ -205,6 +204,11 @@ auto arc = voss::controller::ArcPIDControllerBuilder(odom)
205204
* We will be creating a differential drive chassis in global scope
206205
* Call `DiffChassis(std::initializer_list<int8_t> left_motors, std::initializer_list<int8_t> right_motors, controller_ptr default_controller, ec_ptr ec, double slew_step, pros::motor_brake_mode_e brakeMode)`
207206
```cpp
207+
#define LEFT_MOTORS \
208+
{ -4, -1, -21, 8, 13 }
209+
#define RIGHT_MOTORS \
210+
{ 10, 3, 9, -7, -15 }
211+
208212
auto chassis = voss::chassis::DiffChassis(LEFT_MOTORS, RIGHT_MOTORS, pid, ec, 8, pros::E_MOTOR_BRAKE_COAST);
209213
//we recommend using the pid controller as default controller
210214
```

0 commit comments

Comments
 (0)