ECE4160/5160-MAE 4190/5190: Fast Robots course, offered at Cornell University in Spring 2025
This project is maintained by FastRobotsCornell
Follow these directions to setup and use your simulation environment. You will learn how to control your virtual robot and use the live plotting tool.
The simulation environment consists of three components:
The simulator contains a wheeled robot equipped with laser range finder(s), similar to the physical robot and its ToF sensors. The simulated world is defined in a .yaml configuration file.
Odometry is the use of data from onboard sensors to estimate change in position over time. The relative changes recorded by the sensors (typically IMU and/or wheel encoders) are integrated over time to get a pose estimate of the robot. It is used in robotics by mobile robots to estimate their position relative to a starting location. This method is sensitive to errors due to the integration of velocity measurements over time to give position estimates.
The virtual robot provides simulated IMU data that mimics a typical real robot and this data is integrated over time to give you the odometry pose estimate. (In your real robot, we know that accelerometer data is too noisy to estimate forward motion, but you can consider using the gyroscope to estimate turns, and doing forward motion open loop. More on this in future labs!)
In robotics, ground truth is the most accurate measurement available. New methods, algorithms and sensors are often quantified by comparing them to a ground truth measurement. Ground truth can come either directly from a simulator, or from a much more accurate (and expensive) sensor.
For the virtual robot, ground truth is the exact position of your virtual robot within the simulator.
The virtual robot has a (simulated) constant speed controller and odometry pose estimation built in. It essentially mimics an idealized version of the real robot.
The 2D plotting tool is a lightweight process that allows for live asynchronous plotting of multiple scatter plots using Python. The Python API to plot points is described in the Jupyter notebook. It allows you to plot the odometry and ground truth poses. It also allows you to plot the map (as line segments) and robot belief in future labs. Play around with the various GUI buttons to familiarize yourself with the tool; you want to be more familiar with the tools before you get into the future labs.
You will be programming the controller in Python to perform various functions on your virtual robot. We provide you with a Python API which, among other things, provides a minimal control interface for the robot in the simulator. It allows you to:
python -m pip install numpy pygame pyqt6 pyqtgraph pyyaml ipywidgets colorama
Replace
python
withpython3
ifpython3
points to the latest version.
python -m tkinter
to make sure that tkinter is set up correctly. If the Tkinter module isn’t
installed, run
pip install tk
and try
python -m tkinter
again.cp310-macosx_11_0_arm64
.Note: The python version must match the wheel exactly (newer versions don’t work) or else you will get a message of the type: ERROR:<wheel file> is not a supported wheel on this platform.
Another Note: If you have multiple version of python, you should call the specific version using the command “py -3.x” (windows) or “python3.x” (Mac/Linux) instead of “python3. So calling python 3.10 is now “py -3.10”.
Replace <wheel file> with the name of the wheel file in your project directory.
pip install <wheel file>
Remember that WSL can access your Windows
C:\
drive as/mnt/c
.
python
and then run the following code in the python interpreter:
import Box2D; print(Box2D.__version__)
Follow the instructions here IF AND ONLY IF Box2D was NOT successfully installed in the previous section.