This repo hosts lab materials for ECE 346: Intelligent Robotic Systems at Princeton University.

ECE 346 students: please fork this repository and work within your own forked repo (see instructions below).

You might want to setup the Windows Linux Subsystem first by following this guide.

Install Git on your computer if you haven't done this before.

Before cloning this repo, you will also need to setup your Github SSH key. Refer to Generating a new SSH key and adding it to the ssh-agent and Adding a new SSH key to your Github account to generate and setup SSH key for your Github.

Once SSH key setup is done, create a clone of this repo locally. Important: --recurse-submodules option is neccessary to get all submodules!

git clone --recurse-submodules https://github.com/SafeRoboticsLab/ECE346.git 

One crucial component of ECE346 is ROS. Even though most of the computation will be handled on board our robots, it's still very useful to set up ROS on your computer for development, testing, and visualization. ROS used to only be available for Linux (at least painlessly). However, thanks to recent developments on RoboStack it can now run on Windows and Mac too. Here, we provide detailed instructions and a script to help you set up ROS on your favorite operating system.

You can simply click the fork button on the top of the page. However, we encourage each group to create a private fork to host your code, and make a local clone on your group's robot, by following these instructions. Please include your group number in the name of your repo.

We have a ROS cheat sheet for you! Check it out here.

Please check out our FAQ page for common questions.