Added installation instructions to Readme

README.md

@@ -12,10 +12,96 @@ Main program to control the motors and servos of the robot. Features include:
 
 ## Raspberry Pi Web Server (web_interface)
 The web interface is programmed in Python and uses *Flask* to generate a server. The Raspberry Pi is connected via USB to the Arduino micro-controller. The main features are:
-1. A javascript joystick, with which the movement of the robot can easily be controller.
+1. A JavaScript joystick, with which the movement of the robot can easily be controller.
 1. A list of sounds which can be played.
 1. A list of movement animations which can be performed by the robot.
 1. Settings page, where motor parameters, sound volume, and video options can be modified.
 1. A simple login page to prevent everyone from having access to the controls (note: this is not a full access control system, please don't use this web interface on untrusted/public networks)
 
-![](/images/wall-e_webinterface1.jpg) *Image of the robot webinterface*
+![](/images/wall-e_webinterface1.jpg) *Image of the web interface and robot*
+
+
+
+## Setup Instructions
+
+### Arduino
+
+**Basic Installation**
+1. Ensure that the wiring of the electronics matches the diagram shown below.
+1. Download/clone the folder "wall-e" from the GitHub repository.
+1. Open *wall-e.ino* in the Arduino IDE; the files *MotorController.hpp*, *Queue.hpp* and *setupTimers.h* should automatically open on separate tabs of the IDE as well.
+1. Install the *Adafruit_PWMServoDriver.h* library
+	1.1 Go to Sketch -> Include Library -> Manage Libraries...
+	1.1 Search for  *Adafruit Servo*.
+	1.1 Install the latest version of the library.
+1. Connect to the computer to the micro-controller with a USB cable. Ensure that the correct *Board* and *Port* are selected in the *Tools* menu.
+1. Upload the sketch to the micro-controller.
+
+**Testing the Main Program**
+1. Once the sketch has been uploaded to the Arduino, power on the 12V battery while the micro-controller is still connected to the computer.
+1. Open the *Serial Monitor* (button in top-right of Arduino IDE).
+1. To control the movement of the robot, send the characters 'w', 'a', 's' or 'd' to move forward, left, back or right respectively. Send 'q' to stop all movement.
+1. To move the head, send the characters 'j', 'l', 'i' or 'k' to tilt the head left or right and the eyes upwards or downwards. 
+1. Only move on to using the Raspberry Pi if all these functions are working correctly!
+
+**Servo Motor Calibration**
+Coming soon!
+
+![](/images/wall-e_wiring_diagram.jpg) *Diagram showing the wiring of the robot's electronic components*
+
+
+### Raspberry Pi Web Server
+
+**Basic Installation**
+1. Setup the Raspberry Pi to run the latest version of Raspbian/NOOBS. The setup instructions can be found on the [Raspberry Pi website](https://www.raspberrypi.org/documentation/installation/installing-images/)
+1. Open the command line terminal on the Raspberry Pi.
+1. Ensure that the package list has been updated (this may take some time): `sudo apt-get update`
+1. Install *Flask* - this is a Python framework used to create webservers:
+    1.1 Ensure that pip is installed: `sudo apt-get install python-pip`
+    1.1 Install Flask and its dependencies: `sudo pip install flask`
+1. Clone repository into the home directory of the Raspberry Pi:
+    ```bash
+    cd ~
+    git clone https://github.com/chillibasket/walle-replica.git
+    ``` 
+1. Generate a secret key - this is used to save session data:
+    1.1 Generate a random string as the key: `python -c 'import os; print(os.urandom(16))'`
+    1.1 Copy the string which appears in the terminal.
+    1.1 Open *app.py*: `nano ~/walle-replica/webinterface/app.py`
+    1.1 Paste the string on line 19, where is says *put_secret_key_here*.
+    1.1 Press `CTRL + O` to save and `CTRL + X` to exit the nano editor
+1. Connect to the Arduino/micro-controller:
+    1.1 Plug the Arduino/micro-controller into the USB port of the Raspberry Pi.
+    1.1 Use the following command to list the connected USB devices. Record the name of the device you want to connect to:
+    ```shell
+	result=$(python <<EOF
+	import serial.tools.list_ports
+	ports = serial.tools.list_ports.comports()
+	for p in ports:
+		print(p)
+	EOF
+	)
+	python3 -c $result
+    ```
+    1.1 Once again open *app.py*: `nano ~/walle-replica/webinterface/app.py`
+    1.1 Paste the name of the micro-controller into line 94, where is says *ttyACM0*.
+1. Set the web server password:    
+    1.1 On line 181 of *app.py* where is says *put_password_here*, insert the password you want to use for the web interface.
+    1.1 Press `CTRL + O` to save and `CTRL + X` to exit the nano editor.
+
+**Using the Web Server**
+1. To start the server: `python3 ~/walle-replica/webinterface/app.py`
+1. To stop the server press: `CTRL + C`
+
+**Adding a Camera Stream**
+1. Install *mjpg-streamer* - this is used to stream the video to the webserver. A good description of the installation procedure is described [here](https://github.com/cncjs/cncjs/wiki/Setup-Guide:-Raspberry-Pi-%7C-MJPEG-Streamer-Install-&-Setup-&-FFMpeg-Recording)
+1. Create the file: `/home/pi/mjpg-streamer.sh` as described in the Setup Guide.
+
+**Automatically start Server on Boot**
+Coming soon!
+
+**Adding new Sounds**
+1. Make sure that the is of file type `*.ogg`. Most music/sound editors should be able to convert the sound file to this format.
+1. Change the file name so that it has the following format: `[file name]_[length in milliseconds].ogg`. For example: `eva_1200.ogg`
+1. Upload the sound file to Raspberry Pi in the following folder: `~\walle-replica\web_interface\static\sounds\`
+1. The files should appear in the web interface when you reload the page. If the files do not appear, you may need to start the web server with elevated priviledges: `sudo python3 ~/walle-replica/webinterface/app.py`