Getting Started

Hello and welcome to robobuggy! We are super glad to have you join our team this page is meant to be a jumping off point about how to get up to speed on the project!

Getting Connected

• Become a member of the robotics club https://roboticsclub.org/
• Join our facebook group https://www.facebook.com/groups/616400365084662/
• Subscribe to https://lists.andrew.cmu.edu/mailman/listinfo/rc-robobuggy
• If you are interested in software subscribe to https://lists.andrew.cmu.edu/mailman/listinfo/rc-robobuggy-software
• If you are interested in Mechanical subscribe to https://lists.andrew.cmu.edu/mailman/listinfo/rc-robobuggy-mechanical
• Get someone to add you to the group me
• make an account on git hub and subscribe to this repository
• Get someone to add you to the teams google drive

Tools we use

Mechanical

SolidWorks Roboclub shop tools

Electrical

Software

Getting started with GIT

Git is version control software that allows for users to track changes that they or others make. It also allows for multiple people to contribute to software development at the same time.

to get a copy of the repo you need to clone it do this by opening a terminal window and navigating to where you want to store the robobuggy software then type 'git clone https://github.com/CMU-Robotics-Club/RoboBuggy.git'

You make changes to a file, you stage the file for a commit by typing `git add '. You can do this for several files. Once you are at a reasonable point to save your work you can commit your changes by typing 'git commit' Enter a description of what was in the commit in the text prompt that appears. Then you can get other peoples changes by typing 'git pull'. You can share your changes by typing 'git push'

You should learn at a high level how git works by playing and completing: http://pcottle.github.io/learnGitBranching/ It can be frustrating at times, but it is worth it to complete. You can use undo to undo something in the tutorial (this is not a real bash command)

If you ever have a question about git try using google, http://git-scm.com/ or ask one of the more senior members. When in doubt do not use -f before asking someone It can really mess things up.

Getting started with eclipse

1. Download the latest version of Eclipse from here
2. Download the appropriate Java 8 JDK for your system from here. In theory everything will work from Linux as well, but you're likely better off just using Windows.
3. Clone the Robobuggy repo into a directory of your choosing
4. Open Eclipse, and hit Import -> General -> Exiting Project into Workspace
5. Navigate to the cloned Robobuggy repo for project root
6. "Alice" is the only necessary project - other projects you're welcome to add as necessary for your tasks.
7. Start coding!

What is Travis CI

TODO

What is a MakeFile

TODO

What programing languages do you use

You can use pretty much what ever you want. We mostly use Java and C, with a little C++, python, bash scripts and Matlab

System Overview

The sensors which we currently have: 
   * Encoder
   * Potentiometer
   * Inertial Measurement Unit
   * GPS
   * voltage Sensor
   * Camera

The system has two actuators: 
   * Front wheel servo
   * Pneumatic Breaks

The control system is separated into two parts high level which runs on a surface pro 2 and low level which runs on an Arduino mega

Useful links

CMU Buggy Alumni Website http://cmubuggy.org/ TODO