diff options
| author | bzztbomb <skinny@knowhere.net> | 2011-04-05 19:57:16 -0700 |
|---|---|---|
| committer | bzztbomb <skinny@knowhere.net> | 2011-04-05 19:57:16 -0700 |
| commit | 73e16950d73578900d54f3470b57402a9e908c30 (patch) | |
| tree | 4e24dd9b04bd432139c3ed61866459ac77e4024a /readme.markdown | |
| parent | 6827a350052baf3999cfa336411f5ec89bb9e769 (diff) | |
Public firmware release.
Diffstat (limited to 'readme.markdown')
| -rw-r--r-- | readme.markdown | 24 |
1 files changed, 17 insertions, 7 deletions
diff --git a/readme.markdown b/readme.markdown index 5eea2ca..e9f10f1 100644 --- a/readme.markdown +++ b/readme.markdown @@ -1,7 +1,17 @@ -# Intro
-
-This branch of the WiSheildOSC code is focused on support The Missing Link. http://www.youtube.com/watch?v=YarIPK-gwbw&feature=player_embedded this branch will focus on ease of use for that device and will likely strip away all unneeded code/examples (and change the uIP stack)
-
-# Todo
-
-* Add /midi extended message support.
\ No newline at end of file +# Intro + +This is the bootloader and firmware for the AVR chip used with The Missing Link (http://wifimidi.com/). It is Copyright 2011 Jabrudian Industries LLC. + +# License + +This code is licensed under GPL 3, see COPYING for more information. + +# Getting the code onto the device + +See bootloader/README for more details on compiling and using the bootloader. There is a Makefile setup for use with avrdude and a AVRMKII ISP programmer in bootloader/avr_code. The target is program. + +To compile/burn the main firmware, first make sure that the uploader program under bootloader/uploader has been compiled. Then go to the MissingLink directory and type make program. + +# General overview + +The AVR chip communicates to two other modules. One is a WIFI module and the other is an USB MIDI module. The WIFI module is controlled via SPI. The USB MIDI module is controlled via I2C. OSC packets are received via UDP and processed by the uIP/WiShield TCP/IP stack and code in udpapp.cpp. This is then fed to the OSC library (http://recotana.com). From here the message is dispatched to the code that responds to it (MissingLink.cpp). For a normal OSC->MIDI message, handleTouchOSCMidi (HandleMidi.cpp) is called and uses code from Parse.cpp to parse the OSC address and send data to MIDI. For MIDI input, the avrmidi library (http://www.x37v.info) is used to parse incoming midi and routed out to the appropiate destination. Finally, I2C support is provided by the twi/arduino library and user code is at the bottom of HandleMidi.cpp. (More to come here..)
\ No newline at end of file |