README.md 1.16 KB
Newer Older
Will Roscoe's avatar
Will Roscoe committed
![travis](https://travis-ci.org/wroscoe/donkey.svg?branch=dev)
Will Roscoe's avatar
Will Roscoe committed

Will Roscoe's avatar
Will Roscoe committed
# Donkey: a self driving library and control platform for small scale DIY 
vehicles. 
Will Roscoe's avatar
Will Roscoe committed

Will Roscoe's avatar
Will Roscoe committed
Donkey is minimalist and modular self driving library written in Python. It is 
developed for hobbiests with a focus on allowing fast experimentation and easy 
community contributions.  
Will Roscoe's avatar
Will Roscoe committed

Will Roscoe's avatar
Will Roscoe committed
#### Build the standard Donkey2 (http://www.donkeycar.com) ($200 + 2 hours)
Will Roscoe's avatar
Will Roscoe committed

#### Use Donkey if you want to:
Will Roscoe's avatar
Will Roscoe committed
* Make an RC car drive its self.
* Compete in self driving races like [DIY Robocars](diyrobocars.com)
Will Roscoe's avatar
Will Roscoe committed
* Use existing autopilots to drive your car.
Will Roscoe's avatar
Will Roscoe committed
* Use community datasets to create, improve and test autopilots that other 
people can use.  
Will Roscoe's avatar
Will Roscoe committed

Will Roscoe's avatar
Will Roscoe committed
#### Features:
Will Roscoe's avatar
Will Roscoe committed
* Data logging of image, steering angle, & throttle outputs. 
Will Roscoe's avatar
Will Roscoe committed
* Web based car controls.
Will Roscoe's avatar
Will Roscoe committed
* Community contributed driving data and autopilots.
* Hardware CAD designs for optional upgrades.


Will Roscoe's avatar
Will Roscoe committed
### Getting started. 
After building and calibrating the standard Donkey2 you can drive your car 
with your phone by running the following via ssh on the cars Raspberry Pi. 
Will Roscoe's avatar
Will Roscoe committed
```
python examples/donkey2.py
```
Now you can control your car by going to `<ip_address_of_your_pi>:8887/drive`