diff --git a/README.md b/README.md index 381e737..fe29d35 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,33 @@ Spydian Summary --- -This python project is the controlling software for the Spydian remote controlled car. +This python project is the controlling software for the Spyder remote controlled car. The car can be controlled with a (XBOX) Joystick and consists of a raspberry pi as core unit, several sensors (Gyroscope, Ultrasonic, Camera) and a relay for switching lights and motors on and off. The controlling part is achived by using pygame to get direct access to the controller events. The software itself is splitted into several libraries for handling specific tasks. +Requirements +--- + +You need to build a basic Spyder setup yourself. This consists of a raspberry +pi as controlling unit, a gyroscope, a camera, two relays, an ultrasonic sensor and a temperature +sensor. Notice that you could manipulate the main program (`main.py`) to remove or add sensors. +The standard pins are: + +Sensor | Pins +------------|------- +Ultrasonic | 11, 7 +Motor-Relay | 16 +Light-Relay | 15 +Temperature | 11, 14 + +The light and the motor are switched on and off with the relay, because the raspberry pi +doesn't have enough energy to power all motors and lights. So use a seperate energy source +to power them. +If you are building your own setup it is recommended to only use the libraries and build the +main program yourself. + Install ---