Home

Please contribute to the documentation effort! Everyone is encouraged to edit this wiki!

Getting started

Keep in mind that the code itself is quite well documented. Every module, class and method has a Sphinx-style docstring, inline documentation is provided where appropriate and variable names are chosen to be easy to understand. Running scripts/build_docs.sh will generate HTML documentation from the Sphinx docstrings, in much the same style as the official Python documentation.

Quick Index

• Getting started
• Quick-start on bot control
• Using the Bot
• Dev Environment Setup
• Installing Packages
• BBB Setup
• BBB Wiring
• 3.3V Voltage Regulator
• Charging Batteries
• ZMQ Version Guide
• Strategies
• Pilot

See the Pages tab for a full index of all pages, including ones that are historical and/or sparse.