Merge branch 'master' of github.com:NeilNjae/miniband
[miniband.git] / README.md
index 4bc2e7fabf9c18c813b9cacfd506998bf28f6abd..f3df51f30db72bee4f66db54eb2bfac843bd8460 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
 # Code Club - Mini Band Project
+Updated project for Code Club, using Arduino and Raspberry Pi
 
 <img src="http://farm9.staticflickr.com/8338/8256708023_4a941566e9.jpg" width="500" height="375" alt="photo (2)">
 
@@ -160,13 +161,19 @@ You will probably need a USB hub.
 ## Python glueware
 
 Download the music-maker-hander.py file from the repository. Run it with
- python music-maker-handler.py
   python music-maker-handler.py
 This program sets up a listener for each instrument. When it detects that an instrument has been played, it sends a couple of signals to Scratch.
+
 The first signal appears in Scratch as a sensor value and is the volume (for drums), pitch (for the guitar), or ignored (for the maracas).
+
 The second signal is a broadcast message that makes Scratch play the sound in the instrument.
 
+One problem we had was with how the operating sytem mapped the various Arduinos to devices. It seemed to be pretty arbitrary. In the end, we tracked the device names by running
+    tail -f /var/log/syslog
+in a separate terminal and watching what the devices were called when we plugged them in. We could then edit the various DEVICE parameters in to top of the Python script to fit. You could probably be cleverer by using some udev rules to fix the device names, but we didn't think of that (and didn't have enough time either).
 
 ## Scratch front end
 
 The Scratch file, music-maker, makes the sounds. It responds to the signals from the Python handler above by playing the appropriate sounds. It also does some visual feedback for the insturments. 
 
+Scratch on the Raspberry Pi is very slow, especially when it comes to updating the screen. Very often, Scratch would hang mid-way through a jamming session, only to start playing all the sounds after a short while. During the demos, people suggested that we minimise the Scratch window to reduce its workload.