OrcBoard Community Reference

Documentation

The OrcBoard and OrcPad are extensively and fairly meticulously documented in the OrcBoard Manual. The most up-to-date manual can be built from the svn tree. Last night's automatic build made this manual:

OrcManual (PDF)

User API (Java)

Subversion Repository

Install a subversion client and you will have access to all of the source code, documentation, schematics, etc. The subversion repository is here: svn://orcboard.org/home/svn/orc. To check out the tree, type:

% svn co svn://orcboard.org/home/svn/orc

You can also browse the tree now.

Everything is provided under the terms of the GNU Public License version 2. Informally, this means you can download the code and do whatever you want with it, but if you distribute the code to anyone else (even in binary form), you must make your source code available. If you don't distribute your code to anyone else, you don't have any responsibilities under this license, though we always appreciate enhancements and bug fixes!

Other documentation

Odometry Tutorial (PDF), written by Edwin Olson (eolson@mit.edu). Here's a tutorial on Odometry, including a friendly derivation and a sample dataset to play with. Also included is some basic information on encoders and motor physics (in particular: how to model velocity as a function of current). The dataset is here.

Soldering Tutorial (PDF), written by Edwin Olson (eolson@mit.edu). A guide to soldering thru-hole and surface mount parts at home, using ordinary soldering tools.


Home FAQ Documentation Downloads Forums

Report problems to Edwin Olson, eolson@mit.edu. Last modified: May 03 2006 16:22:51.