In this project...
TODO
To test it, Term 2 Simulator need to be used. The latest version of main.cpp
used to run this project without the simulator can be found here.
If you are looking for Udacity's started code project, you can find it here.
- Udacity's Self Driving Car Simulator
cmake >= 3.5
make >= 4.1
(Linux / Mac),3.81
(Windows)gcc/g++ >= 5.4
(Linux / Mac),MinGW
(Windows)uWebSockets
commite94b6e1
. See the following section for installation instructions and additional details.Eigen
. This is already part of the repo so you shouldn't have to worry about it.Ipopt
andCppAD
. See the following section for installation instructions and additional details.
This repository includes two files that can be used to set up and intall uWebSocketIO:
install-mac.sh
for Mac.install-ubuntu
for either Linux or Windows 10 Bash on Ubuntu (please, make sure it is updated).
For Windows, Docker or VMware coulso also be used as explained in the course lectures. Details about enviroment setup can also be found there.
If you install from source, checkout to commit e94b6e1
, as some function signatures have changed in v0.14.x
:
git clone https://github.com/uWebSockets/uWebSockets
cd uWebSockets
git checkout e94b6e1
See this PR for more details.
Regarding Ipopt
and CppAD
, please refer to this document for installation instructions.
Once the install is complete, the main program can be built and run by doing the following from the project top directory:
- Create a build directory and navigate to it:
mkdir build && cd build
- Compile the project:
cmake .. && make
- Run it:
./MPC
Or, all together (from inside the build
directory): clear && cmake .. && make && ./MPC
Tips for setting up your environment can be found here.
Student describes their model in detail. This includes the state, actuators and update equations.
The kinematic model uses the following state and actuators variables, directly coming from the simulator or calculated:
STATE (INPUT):
x
: Vehicle's X position in the map's coordinate system. Sent by the simulator asx
.y
: Vehicle's Y position in the map's coordinate system. Sent by the simulator asy
.v
: Vehicle's current speed. Sent by the simulator asspeed
.cte
: Vehicle's cross-track error. Calculated usingptsx
andptsy
(sent by the emulator), as explained next.epsi
: Vehicle's orientation error Calculated usingptsx
andptsy
(sent by the emulator), as explained next.
In order to calculate the CTE and EPSI values (main.cpp:215-249
), the waypoints X and Y coordinates are transformed from the map's coordinate system to the vehicle's coordinate system and then a 3rd degree polynomial is fitted to them, resulting in:
const double CTE = coeffs[0]; // f(px) = f(0) = coeffs[0]
const double EPSI = -atan(coeffs[1]); // psi - f'(px) = 0 - f'(0) = coeffs[1]
It's worth mentioning that these values are also updated to account for the latency, as I will explain in the last point of this section.
ACTUATORS (OUTPUT):
d
: Vehicle's current steering angle.a
: Vehicle's current acceleration/throttle.
In order to find the optimal value for d
and a
, an objective function that combines the squared sum of the following terms will be minimized using Ipopt (MPC.cpp:90-118
):
REFERENCE STATE COST:
Costs associated to the difference between the desired optimal state and the estimated one. They get really large weights in comparison to the other terms:
- CTE: Cross-track error.
- EPSI: Orientation error.
- Speed difference, between the estimated speed and the reference/target speed.
CONTROL COST:
To minimize the use of actuators. Set to small weights as it is not a priority, in this case, to reduce the use of actuators.
- Delta: Steering angle.
- Delta change: To minimize the gap between sequential actuations to achieve temporal smoothness. Set to a relatively large value to follow a smoother trajectory around the track.
- Acceleration/throttle.
- Acceleration/throttle change: Again, to minimize the gap between sequential actuations to achieve temporal smoothness, but set to a smaller value, as we favor trajectory smoothness versus speed smoothness.
The weights assigned to each term have been manually tuned by trial and error.
Also, the following equations are used to calculate the state at timestep t
given the state at timestep t - 1
(MPC.cpp:165-189
):
x1 = x0 + v0 * cos(psi0) * dt
y1 = y0 + v0 * sin(psi0) * dt
psi1 = psi0 + v0/Lf * delta0 * dt
v1 = v0 + a0 * dt
cte1 = f(x0) - y0 + v0 * sin(epsi0) * dt
epsi1 = psi0 - f'(x0) - v0/Lf * delta0 * dt
Where Lf = 2.67
is the distance from the front wheels to the vehicle's center of gravity (CoG), as provided by Udacity. Also, note a sign has been changed in the last equation to make it work in the emulator.
Student discusses the reasoning behind the chosen N (timestep length) and dt (elapsed duration between timesteps) values. Additionally the student details the previous values tried.
I initially used N = 10
and dt = 0.1s
or dt = 100ms
, as these values have been suggested during the Q&A session and on the forums and worked good for me.
Later, I tried some different combinations, but even some of them could still keep the car on the road (for rxample, N = 15
and dt = 0.1s
), they were more erratic than the initial choice, at least with the weights I was already using.
In general, a smaller dt
is better as that would generate steps that are closer to each other (better resolution), but it also means we would need to increase N
to cover the same total timespan, which has some other implications. Also, as the latency is 100ms
, it doesn't make sense to use a dt
value smaller than that.
Increasing N
would increase the computational time and also the amount of memory required by our program to find the optimal solution, so that could introduce some additional delay in the system.
Lastly, increasing the time horizon (N * dt
) means the predicted path is longer. At higher speeds, this might make sense as some actions like reducing the speed before entering a turn could be better anticipated. However, if the path is too long, it might cover a portion of the track with more than a couple of turns, in which case the 3rd degree polynomial we are using might not be able to fit it properly.
A polynomial is fitted to waypoints. If the student preprocesses waypoints, the vehicle state, and/or actuators prior to the MPC procedure it is described.
Waypoints preprocessing already explained in the first point. State update to account for latency is explained in the next one.
The student implements Model Predictive Control that handles a 100 millisecond latency. Student provides details on how they deal with latency.
In order to account for the latency, the state is updated as follows (main.cpp:256-262
):
x = v * lag
y = 0 (as psi = 0 from the vehicle's coordinate system)
psi = -v * lag * delta / Lf
v = v + a * lag
cte = cte + v * sin(epsi) * lag
epsi = epsi - v * lag * delta / Lf
Also, a not too high target speed of 50 MPH has been set and an emergency breaking system has been implemented, which actuates the breaks at their maximum (throttle = -1
) if a combination of CTE and EPSI grows too much while going at speeds greater than 50 MPH. However, when using the default params, that code is never reached.
Lastly, the first 2 actuations are averaged to reduce noise and get a smoother behaviour.
Another option that hasn't been implemented that but could help keeping the car on the road at higher speeds would be to add a new cost factor speed * steering
that would make the car reduce its speed while turning.
There are a few points from my previous evaluation that I think are incorrect:
-
Latency handling is implemented correctly. However, there are some potential bugs in MPC implementation including sign of delta and velocity conversion for throttle which shouldn't be there.
In
Project: Model Predictive Control > 2. Tips and Tricks
they clearly point out that if delta is positive we rotate counter-clockwise, or turn left. In the simulator however, a positive value implies a right turn and a negative value implies a left turn. Therefore, there are two options to fix this: change the sign in the equation as I did or leave the equation unchanged and multiply the steering value by-1
before sending it to the simulator.Regarding the velocity conversion for throttle, when running with the default params (which are the ones provided for the evaluation), that's not used, as the conversion factor is set to
1
by default. Anyway, asthrottle
is used as acceleration inmain.cpp:260
to update the state to account for the latency (v = v + throttle * lag
), it also needs to be converted so that both units match.That conversion factor is also used in
MPC.cpp:286-287
to set the lower and upper limits for the acceleration, so the opposite conversion needs to be applied inmain.cpp:271
(double throttle_control = vars[2] / MPH_2_MS
) in order to send a value back to the emulator that is in the interval[-1, 1]
.These conversions might not be needed, and actually, as I pointed out, they are not used right now, or might be implemented differently, but the reasoning behind each of them is correct, so the comments pointing out they should be removed are incorrect.
-
I think the code is overly complicated with many if statements, constant and vectors, making it difficult for other to read. For example, what should argc be? As given by skeleton, we don't pass in any argument when executing the function, so you should make sure the default values are what you intend to submit.
I think that part of the code is not meant to be evaluated, the same way the changes I made to reduce the nesting in the WS handler are not evaluated either. You should focus on the
MPC.cpp
andMPC.h
files and the relevant part ofmain.cpp
(lines203
to359
, mainly). Anyway, I don't consider it to be complicated or hard to read, it's just a bunch of loops and ternaries getting a value from the command line arguments or from a vector/hardcoded constant of default values.argc
andargv
are how command line arguments are passed to C/C++. See https://stackoverflow.com/questions/3024197/what-does-int-argc-char-argv-meanLastly, the default values are already the ones that should be evaluated, there's no need for you to run the executable passing any params.
-
You shouldn't need this, when all equations are implemented correctly and with good cost weights, MPC will provide good result.
True. With more time to adjust the weights, the emergency breaking code is probably not required. Anyway, as you can see in the logs, that code is never executed when running with the default params.
-
Unfortunately it didn't complete the first lap this time and crashed after the bridge.
The current implementation of the project has been running, with the default params, for more than 4h uninterrupted without crashing both when I implemented and now, in order to try to verify the issue you are reporting. Therefore, I suspect your issue might be related to this, as I haven't use a VM to work on the projects:
VM Latency: Some students have reported differences in behavior using VM's ostensibly a result of latency. Please let us know if issues arise as a result of a VM environment.
- It's recommended to test the MPC on basic examples to see if your implementation behaves as desired. One possible example is the vehicle starting offset of a straight line (reference). If the MPC implementation is correct, after some number of timesteps (not too many) it should find and track the reference line.
- The
lake_track_waypoints.csv
file has the waypoints of the lake track. You could use this to fit polynomials and points and see of how well your model tracks curve. NOTE: This file might be not completely in sync with the simulator so your solution should NOT depend on it. - For visualization this C++ matplotlib wrapper could be helpful.)
- Tips for setting up your environment are available here
- VM Latency: Some students have reported differences in behavior using VM's ostensibly a result of latency. Please let us know if issues arise as a result of a VM environment.
We've purposefully kept editor configuration files out of this repo in order to keep it as simple and environment agnostic as possible. However, we recommend using the following settings:
- indent using spaces
- set tab width to 2 spaces (keeps the matrices in source code aligned)
Please (do your best to) stick to Google's C++ style guide.
Note: regardless of the changes you make, your project must be buildable using cmake and make!
More information is only accessible by people who are already enrolled in Term 2 of CarND. If you are enrolled, see the project page for instructions and the project rubric.
- You don't have to follow this directory structure, but if you do, your work will span all of the .cpp files here. Keep an eye out for TODOs.
Help your fellow students!
We decided to create Makefiles with cmake to keep this project as platform agnostic as possible. Similarly, we omitted IDE profiles in order to we ensure that students don't feel pressured to use one IDE or another.
However! I'd love to help people get up and running with their IDEs of choice. If you've created a profile for an IDE that you think other students would appreciate, we'd love to have you add the requisite profile files and instructions to ide_profiles/. For example if you wanted to add a VS Code profile, you'd add:
- /ide_profiles/vscode/.vscode
- /ide_profiles/vscode/README.md
The README should explain what the profile does, how to take advantage of it, and how to install it.
Frankly, I've never been involved in a project with multiple IDE profiles before. I believe the best way to handle this would be to keep them out of the repo root to avoid clutter. My expectation is that most profiles will include instructions to copy files to a new location to get picked up by the IDE, but that's just a guess.
One last note here: regardless of the IDE used, every submitted project must still be compilable with cmake and make./
This document describes the JSON object send back from the simulator command server.
Fields:
ptsx
(Array) - The global x positions of the waypoints.ptsy
(Array) - The global y positions of the waypoints. This corresponds to the z coordinate in Unity since y is the up-down direction.psi
(float) - The orientation of the vehicle in radians converted from the Unity format to the standard format expected in most mathemetical functions (more details below).psi_unity
(float) - The orientation of the vehicle in radians. This is an orientation commonly used in navigation.x
(float) - The global x position of the vehicle.y
(float) - The global y position of the vehicle.steering_angle
(float) - The current steering angle in radians.throttle
(float) - The current throttle value [-1, 1].speed
(float) - The current velocity in mph.
psi
// 90
//
// 180 0/360
//
// 270
psi_unity
// 0/360
//
// 270 90
//
// 180