adding doc

farvardin · Sep 13, 2017 · 00bd728 · 00bd728
1 parent 624d1d0
commit 00bd728
Show file tree

Hide file tree

Showing 252 changed files with 1,674 additions and 37 deletions.
diff --git a/README.md b/README.md
@@ -6,6 +6,8 @@ The Garvuino is a PCB board for creating musics, sounds and chiptunes, either th
 
 ![](garvuino_pcb.png)
 
+![](garvuino01.jpg)
+
 It works with an Arduino Nano and an Atmega8 chip.
 
 ## Features 
@@ -39,7 +41,8 @@ From [various 1-bit engines](http://randomflux.info/1bit/viewforum.php?id=5) (on
 
 ### AVRAY 
 
- * http://picosong.com/HUGM/
+ * http://picosong.com/HUGM/ (Xenon / Spectrum)
+ * http://picosong.com/wseMn/ (Cauldron / Amstrad)
  * http://battleofthebits.org/arena/Entry/Underground+Water/26509/
  * https://www.youtube.com/watch?v=gzpGbokxwZ4
  * *more to come*
@@ -60,24 +63,24 @@ From [various 1-bit engines](http://randomflux.info/1bit/viewforum.php?id=5) (on
 
 ## Bill of Materials 
 
-    Name						nb 	(optionnal part)
+    Name							nb 	(optionnal part)
     		
-    Garvuino PCB				1	
-    crystal 24 mhz				1	
-    arduino nano				1	
-    atmega8						1	
-    ceramic capacitor 820 pF	2	
-    electrolytic capac. 10 uF	2	
-    ceramic capacitor 100 nF	1		x
-    led 						1		x
-    DIN5 connector (midi)		1		x
-    1 kΩ Resistor				1		x
-    10 kΩ Resistor				2	
-    micro sd module				1	
-    sd module					1		x
-    momentary switch			1	
-    audio jack 3.5 mm (TRS)		1	
-    jumper						4	
+    Garvuino PCB					1	
+    crystal 24 mhz					1	
+    arduino nano					1	
+    atmega8							1	
+    ceramic capacitor 820 pF		2	
+    electrolytic capac. 10 uF		2	
+    ceramic capacitor 100 nF		1		x
+    led								1		x
+    DIN5 connector (midi)			1		x
+    1 kΩ Resistor					1		x
+    10 kΩ Resistor					2	
+    micro sd module					1	
+    sd module						1		x
+    momentary switch				1	
+    audio jack 3.5 mm (TRS)			1	
+    jumper							4	
 
 
 ## Atmega8 setup 
@@ -91,7 +94,7 @@ Connect it according to this schematic for the atmega8:
 Basically it's:
 
 | SD reader |Atmega|
-|--------|-------|
+|---------------|
 |MISO |pin 18: PB4|
 |MOSI |pin 17: PB3|
 |RESET |pin 01: PC6|

diff --git a/arduino_sketches/avray/avray_light_sensor/avray_light_sensor.ino b/arduino_sketches/avray/avray_light_sensor/avray_light_sensor.ino
diff --git a/arduino_sketches/avray/avray_light_sensor/noteList.cpp b/arduino_sketches/avray/avray_light_sensor/noteList.cpp
diff --git a/arduino_sketches/avray/avray_light_sensor/noteList.h b/arduino_sketches/avray/avray_light_sensor/noteList.h
diff --git a/arduino_sketches/avray/avray_light_sensor/pitches.h b/arduino_sketches/avray/avray_light_sensor/pitches.h
diff --git a/arduino_sketches/avray/avray_sd_sketch/avray_sd_sketch.ino b/arduino_sketches/avray/avray_sd_sketch/avray_sd_sketch.ino
diff --git a/arduino_sketches/beeper/arduino_octode/arduino_octode.ino b/arduino_sketches/beeper/arduino_octode/arduino_octode.ino
diff --git a/arduino_sketches/beeper/arduino_octode/arduino_octode.ino.standard.hex b/arduino_sketches/beeper/arduino_octode/arduino_octode.ino.standard.hex
diff --git a/arduino_sketches/beeper/arduino_octode/arduino_octode.ino.with_bootloader.standard.hex b/arduino_sketches/beeper/arduino_octode/arduino_octode.ino.with_bootloader.standard.hex
diff --git a/arduino_sketches/beeper/arduino_octode/arduino_octode.zip b/arduino_sketches/beeper/arduino_octode/arduino_octode.zip
diff --git a/arduino_sketches/beeper/arduino_octode/convert_arduino_octode.bat b/arduino_sketches/beeper/arduino_octode/convert_arduino_octode.bat
diff --git a/arduino_sketches/beeper/arduino_octode/convert_arduino_octode.py b/arduino_sketches/beeper/arduino_octode/convert_arduino_octode.py
diff --git a/arduino_sketches/beeper/arduino_octode/garvalf_octode-2015-05-18_hymn_dazbog.xm b/arduino_sketches/beeper/arduino_octode/garvalf_octode-2015-05-18_hymn_dazbog.xm
diff --git a/arduino_sketches/beeper/arduino_octode/garvalf_octodexl-2015-05-18_hymn_dazbog.xm b/arduino_sketches/beeper/arduino_octode/garvalf_octodexl-2015-05-18_hymn_dazbog.xm
diff --git a/arduino_sketches/beeper/arduino_octode/garvalf_rotor-octode-2014-10-22.xm b/arduino_sketches/beeper/arduino_octode/garvalf_rotor-octode-2014-10-22.xm
diff --git a/arduino_sketches/beeper/arduino_octode/music.h b/arduino_sketches/beeper/arduino_octode/music.h
diff --git a/arduino_sketches/beeper/arduino_octode/music.xm b/arduino_sketches/beeper/arduino_octode/music.xm
diff --git a/arduino_sketches/beeper/arduino_octode/music_dazbog.h b/arduino_sketches/beeper/arduino_octode/music_dazbog.h
diff --git a/arduino_sketches/beeper/arduino_octode/music_rotor.h b/arduino_sketches/beeper/arduino_octode/music_rotor.h
diff --git a/arduino_sketches/beeper/arduino_octode/music_shiru.h b/arduino_sketches/beeper/arduino_octode/music_shiru.h
diff --git a/arduino_sketches/beeper/arduino_octode/music_test.h b/arduino_sketches/beeper/arduino_octode/music_test.h
diff --git a/arduino_sketches/beeper/arduino_octode/music_test2.h b/arduino_sketches/beeper/arduino_octode/music_test2.h
diff --git a/arduino_sketches/beeper/arduino_octode/newdrum12500_1.wav b/arduino_sketches/beeper/arduino_octode/newdrum12500_1.wav
diff --git a/arduino_sketches/beeper/arduino_octode/test.xm b/arduino_sketches/beeper/arduino_octode/test.xm
diff --git a/arduino_sketches/beeper/arduino_octode/xmlib.py b/arduino_sketches/beeper/arduino_octode/xmlib.py
diff --git a/arduino_sketches/beeper/arduino_octode/xmlib.pyc b/arduino_sketches/beeper/arduino_octode/xmlib.pyc
diff --git a/arduino_sketches/beeper/arduino_phaser1/arduino_phaser1.ino b/arduino_sketches/beeper/arduino_phaser1/arduino_phaser1.ino
diff --git a/arduino_sketches/beeper/arduino_phaser1/arduino_phaser1.ino.standard.hex b/arduino_sketches/beeper/arduino_phaser1/arduino_phaser1.ino.standard.hex
diff --git a/arduino_sketches/beeper/arduino_phaser1/arduino_phaser1.ino.with_bootloader.standard.hex b/arduino_sketches/beeper/arduino_phaser1/arduino_phaser1.ino.with_bootloader.standard.hex
diff --git a/arduino_sketches/beeper/arduino_phaser1/bin2h.py b/arduino_sketches/beeper/arduino_phaser1/bin2h.py
diff --git a/arduino_sketches/beeper/arduino_phaser1/convert_music.bat b/arduino_sketches/beeper/arduino_phaser1/convert_music.bat
diff --git a/arduino_sketches/beeper/arduino_phaser1/drum_sample_data.h b/arduino_sketches/beeper/arduino_phaser1/drum_sample_data.h
diff --git a/arduino_sketches/beeper/arduino_phaser1/garvalf_phaser1.bin b/arduino_sketches/beeper/arduino_phaser1/garvalf_phaser1.bin
diff --git a/arduino_sketches/beeper/arduino_phaser1/music_data.bin b/arduino_sketches/beeper/arduino_phaser1/music_data.bin
diff --git a/arduino_sketches/beeper/arduino_phaser1/music_data.h b/arduino_sketches/beeper/arduino_phaser1/music_data.h
diff --git a/arduino_sketches/beeper/arduino_phaser1/music_data_garvalf.h b/arduino_sketches/beeper/arduino_phaser1/music_data_garvalf.h
diff --git a/arduino_sketches/beeper/arduino_phaser1/music_data_mister_beep.h b/arduino_sketches/beeper/arduino_phaser1/music_data_mister_beep.h
diff --git a/arduino_sketches/beeper/arduino_phaser1/music_mister_beep.bin b/arduino_sketches/beeper/arduino_phaser1/music_mister_beep.bin
diff --git a/arduino_sketches/beeper/arduino_qchan/arduino_qchan.ino b/arduino_sketches/beeper/arduino_qchan/arduino_qchan.ino
diff --git a/arduino_sketches/beeper/arduino_qchan/arduino_qchan.ino.standard.hex b/arduino_sketches/beeper/arduino_qchan/arduino_qchan.ino.standard.hex
diff --git a/arduino_sketches/beeper/arduino_qchan/arduino_qchan.ino.with_bootloader.standard.hex b/arduino_sketches/beeper/arduino_qchan/arduino_qchan.ino.with_bootloader.standard.hex
diff --git a/arduino_sketches/beeper/arduino_qchan/bin2h.py b/arduino_sketches/beeper/arduino_qchan/bin2h.py
diff --git a/arduino_sketches/beeper/arduino_qchan/convert_music.bat b/arduino_sketches/beeper/arduino_qchan/convert_music.bat
diff --git a/arduino_sketches/beeper/arduino_qchan/music_data.bin b/arduino_sketches/beeper/arduino_qchan/music_data.bin
diff --git a/arduino_sketches/beeper/arduino_qchan/music_data.h b/arduino_sketches/beeper/arduino_qchan/music_data.h
diff --git a/arduino_sketches/beeper/arduino_qchan/music_data_movie.h b/arduino_sketches/beeper/arduino_qchan/music_data_movie.h
diff --git a/arduino_sketches/beeper/arduino_qchan/music_data_movie1.bin b/arduino_sketches/beeper/arduino_qchan/music_data_movie1.bin
diff --git a/arduino_sketches/beeper/arduino_qchan/music_data_reveries.h b/arduino_sketches/beeper/arduino_qchan/music_data_reveries.h
diff --git a/arduino_sketches/beeper/arduino_qchan/music_data_vapeurs.h b/arduino_sketches/beeper/arduino_qchan/music_data_vapeurs.h
diff --git a/arduino_sketches/beeper/arduino_qchan/reveries.bin b/arduino_sketches/beeper/arduino_qchan/reveries.bin
diff --git a/arduino_sketches/beeper/arduino_qchan/vapeurs_alcool.bin b/arduino_sketches/beeper/arduino_qchan/vapeurs_alcool.bin
diff --git a/arduino_sketches/beeper/arduino_tritone/arduino_tritone.ino b/arduino_sketches/beeper/arduino_tritone/arduino_tritone.ino
diff --git a/arduino_sketches/beeper/arduino_tritone/arduino_tritone.ino.standard.hex b/arduino_sketches/beeper/arduino_tritone/arduino_tritone.ino.standard.hex
diff --git a/arduino_sketches/beeper/arduino_tritone/arduino_tritone.ino.with_bootloader.standard.hex b/arduino_sketches/beeper/arduino_tritone/arduino_tritone.ino.with_bootloader.standard.hex
diff --git a/arduino_sketches/beeper/arduino_tritone/bin2h.py b/arduino_sketches/beeper/arduino_tritone/bin2h.py
diff --git a/arduino_sketches/beeper/arduino_tritone/bourrasque_arduino.bin b/arduino_sketches/beeper/arduino_tritone/bourrasque_arduino.bin
diff --git a/arduino_sketches/beeper/arduino_tritone/convert_drums.bat b/arduino_sketches/beeper/arduino_tritone/convert_drums.bat
diff --git a/arduino_sketches/beeper/arduino_tritone/convert_drums.py b/arduino_sketches/beeper/arduino_tritone/convert_drums.py
diff --git a/arduino_sketches/beeper/arduino_tritone/convert_music.bat b/arduino_sketches/beeper/arduino_tritone/convert_music.bat
diff --git a/arduino_sketches/beeper/arduino_tritone/drum_sample_data.h b/arduino_sketches/beeper/arduino_tritone/drum_sample_data.h
diff --git a/arduino_sketches/beeper/arduino_tritone/incantation_arduino.bin b/arduino_sketches/beeper/arduino_tritone/incantation_arduino.bin
diff --git a/arduino_sketches/beeper/arduino_tritone/music_data.bin b/arduino_sketches/beeper/arduino_tritone/music_data.bin
diff --git a/arduino_sketches/beeper/arduino_tritone/music_data.h b/arduino_sketches/beeper/arduino_tritone/music_data.h
diff --git a/arduino_sketches/beeper/arduino_tritone/music_data_bourrasque.h b/arduino_sketches/beeper/arduino_tritone/music_data_bourrasque.h
diff --git a/arduino_sketches/beeper/arduino_tritone/music_data_incantation.h b/arduino_sketches/beeper/arduino_tritone/music_data_incantation.h
diff --git a/arduino_sketches/beeper/arduino_tritone/music_data_misterbeep.bin b/arduino_sketches/beeper/arduino_tritone/music_data_misterbeep.bin
diff --git a/arduino_sketches/beeper/arduino_tritone/music_data_misterbeep.h b/arduino_sketches/beeper/arduino_tritone/music_data_misterbeep.h
diff --git a/arduino_sketches/beeper/arduino_tritone/music_data_snakecharmer.h b/arduino_sketches/beeper/arduino_tritone/music_data_snakecharmer.h
diff --git a/arduino_sketches/beeper/arduino_tritone/music_data_souvenirs_tritone.h b/arduino_sketches/beeper/arduino_tritone/music_data_souvenirs_tritone.h
diff --git a/arduino_sketches/beeper/arduino_tritone/music_data_test.h b/arduino_sketches/beeper/arduino_tritone/music_data_test.h
diff --git a/arduino_sketches/beeper/arduino_tritone/music_data_test2.h b/arduino_sketches/beeper/arduino_tritone/music_data_test2.h
diff --git a/arduino_sketches/beeper/arduino_tritone/snake_charmer_arduino.bin b/arduino_sketches/beeper/arduino_tritone/snake_charmer_arduino.bin
diff --git a/arduino_sketches/beeper/arduino_tritone/souvenirs_tritone_arduino.bin b/arduino_sketches/beeper/arduino_tritone/souvenirs_tritone_arduino.bin
diff --git a/arduino_sketches/beeper/arduino_tritone/test_bourrasque_arduino.bin b/arduino_sketches/beeper/arduino_tritone/test_bourrasque_arduino.bin
diff --git a/arduino_sketches/beeper/arduino_tritone/test_bourrasques.bbsong b/arduino_sketches/beeper/arduino_tritone/test_bourrasques.bbsong
diff --git a/arduino_sketches/beeper/arduino_tritone/tritone_drums.wav b/arduino_sketches/beeper/arduino_tritone/tritone_drums.wav
diff --git a/arduino_sketches/mozzi/mozzi_midi/mozzi_midi.ino b/arduino_sketches/mozzi/mozzi_midi/mozzi_midi.ino
diff --git a/arduino_sketches/sid/sid_midi/noteList.cpp b/arduino_sketches/sid/sid_midi/noteList.cpp
diff --git a/arduino_sketches/sid/sid_midi/noteList.h b/arduino_sketches/sid/sid_midi/noteList.h
diff --git a/arduino_sketches/sid/sid_midi/pitches.h b/arduino_sketches/sid/sid_midi/pitches.h
diff --git a/arduino_sketches/sid/sid_midi/sid_midi.ino b/arduino_sketches/sid/sid_midi/sid_midi.ino
diff --git a/atmega8/amstrad_6128_audio_out.png b/atmega8/amstrad_6128_audio_out.png
diff --git a/atmega8/atmega8_burn.fzz b/atmega8/atmega8_burn.fzz
diff --git a/atmega8/atmega8_burn_bb.pdf b/atmega8/atmega8_burn_bb.pdf
diff --git a/atmega8/atmega8_burn_bb.png b/atmega8/atmega8_burn_bb.png
diff --git a/atmega8/atmega8_schematic.png b/atmega8/atmega8_schematic.png
diff --git a/atmega8/avray/AY_Emul_247_2ch_m8_ay.hex b/atmega8/avray/AY_Emul_247_2ch_m8_ay.hex
diff --git a/atmega8/avray/AY_Emul_247_2ch_m8_ym.hex b/atmega8/avray/AY_Emul_247_2ch_m8_ym.hex
diff --git a/atmega8/avray/Conf_serial_24MHz_1Mhz.hex b/atmega8/avray/Conf_serial_24MHz_1Mhz.hex
diff --git a/atmega8/avray/Conf_serial_24MHz_1_75Mhz.hex b/atmega8/avray/Conf_serial_24MHz_1_75Mhz.hex
diff --git a/atmega8/avray/Conf_serial_24MHz_2Mhz.hex b/atmega8/avray/Conf_serial_24MHz_2Mhz.hex
diff --git a/atmega8/avray/GPLv3.txt b/atmega8/avray/GPLv3.txt
diff --git a/atmega8/avray/GPLv3_rus.txt b/atmega8/avray/GPLv3_rus.txt
diff --git a/atmega8/avray/avray_readme.txt b/atmega8/avray/avray_readme.txt
diff --git a/atmega8/avray/ay_serial_24mhz_calculs.txt b/atmega8/avray/ay_serial_24mhz_calculs.txt
diff --git a/atmega8/avray/source_AY_Emul_247.asm b/atmega8/avray/source_AY_Emul_247.asm
diff --git a/breadboard/garvuino_09g_breadboard_only.fzz b/breadboard/garvuino_09g_breadboard_only.fzz
diff --git a/breadboard/garvuino_09g_breadboard_only_bb.jpg b/breadboard/garvuino_09g_breadboard_only_bb.jpg
diff --git a/breadboard/garvuino_09g_breadboard_only_bb.pdf b/breadboard/garvuino_09g_breadboard_only_bb.pdf
diff --git a/doc/garvuino_manual.md b/doc/garvuino_manual.md
@@ -0,0 +1,25 @@
+Garvuino Manual
+Garvalf
+2017-09-13
+
+
+# Garvuino 
+
+Thank you for your interest in Garvuino! The Garvuino is a PCB board for creating musics, sounds and chiptunes, either through programmation, soundtracker or live recording (midi).
+
+It's open-source hardware, so you can modify, hack, have fun with it without restriction.
+
+## Assembly the board 
+
+If you got the board through a kit, soldering it should be pretty simple as there are only basic components. 
+
+If you have no clue about how to solder, this guide might be of some use for you: https://www.makerspaces.com/how-to-solder/
+
+Solder the resistors and capacitors first for example, then the jumpers, socket, led, switch, crystal and audio jack. In any case, the sd card reader should be soldered after all of this, but it's also adviced to solder the midi DIN5 connecter last, otherwise you might find it difficult to solder the sd card reader.
+
+There is a little error on the version 1.09 / 2017-08 of the PCB board, which I've fixed with a wire.
+
+## Flashing the board 
+
+This board is supposed to work extensively with the Arduino IDE (http://arduino.cc/). You must download it and use it for developping, changing sounds and engines. The only exception is if you only intend to use the board as a AY player, then you can just change the tunes on the SD card.
+
diff --git a/doc/garvuino_manual.pdf b/doc/garvuino_manual.pdf