Skip to content

Commit c7d2ced

Browse files
author
Francois Best
committed
Readme edits, removed arduino-playground (no longer used).
1 parent 352e3d1 commit c7d2ced

File tree

2 files changed

+14
-99
lines changed

2 files changed

+14
-99
lines changed

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
#Arduino MIDI Library v4.2
22

33
This library enables MIDI I/O communications on the Arduino serial ports.
4-
The purpose of this library is not to make a big synthetizer out of an Arduino board, the application remains yours. However, it will help you interfacing it with other MIDI devices.
4+
The purpose of this library is not to make a big synthesizer out of an Arduino board, the application remains yours. However, it will help you interfacing it with other MIDI devices.
55

66
Download the latest version [here](https://github.com/FortySevenEffects/arduino_midi_library/releases/latest).
77

88
### Features
9-
* Compatible with all Arduino boards (and clones with an AVR processor)
9+
* Compatible with all Arduino boards (and clones with an AVR processor).
1010
* Simple and fast way to send and receive every kind of MIDI message (including all System messages, SysEx, Clock, etc..).
1111
* OMNI input reading (read all channels).
1212
* Software Thru, with message filtering.
@@ -21,7 +21,7 @@ Download the latest version [here](https://github.com/FortySevenEffects/arduino_
2121
* 11/06/2014 : Version 4.2 released. Bug fix for SysEx, overridable template settings.
2222
* 16/04/2014 : Version 4.1 released. Bug fixes regarding running status.
2323
* 13/02/2014 : Version 4.0 released. Moved to GitHub, added multiple instances & software serial support, and a few bug fixes.
24-
* 29/01/2012 : Version 3.2 released. Release notes are [here](http://sourceforge.net/news/?group_id=265194)
24+
* 29/01/2012 : Version 3.2 released. Release notes are [here](http://sourceforge.net/news/?group_id=265194).
2525
* 06/05/2011 : Version 3.1 released. Added [callback](http://playground.arduino.cc/Main/MIDILibraryCallbacks) support.
2626
* 06/03/2011 : Version 3.0 released. Project is now hosted on [SourceForge](http://sourceforge.net/projects/arduinomidilib).
2727
* 14/12/2009 : Version 2.5 released.
@@ -36,41 +36,42 @@ Download the latest version [here](https://github.com/FortySevenEffects/arduino_
3636

3737
### What do I need to do?
3838

39-
* Download the library ([link](https://github.com/FortySevenEffects/arduino_midi_library/releases/latest))
40-
* Follow the installation instructions there: http://arduino.cc/en/Guide/Libraries
39+
* Download the library ([link](https://github.com/FortySevenEffects/arduino_midi_library/releases/latest)).
40+
* Follow the installation instructions - http://arduino.cc/en/Guide/Libraries.
4141
* Include the library in your sketch using the menu in the IDE, or type `#include <MIDI.h>`
4242
* Create the MIDI instance using `MIDI_CREATE_DEFAULT_INSTANCE();` or take a look at the documentation for custom serial port, settings etc..
4343

44-
You are now ready to use the library. Look at the reference page to learn how to use it, or the examples given. Just don't forget to enable the I/O communications with MIDI.begin...
44+
You are now ready to use the library. Look at the documentation to learn how to use it, or checkout the examples installed with the Library.
45+
You can also watch the awesome video tutorials from [Notes & Volts](https://www.youtube.com/playlist?list=PL4_gPbvyebyH2xfPXePHtx8gK5zPBrVkg).
4546

4647

47-
##Reference
48+
##Documentation
4849

49-
See the extended reference [here](http://arduinomidilib.fortyseveneffects.com) ([Mirror](http://fortyseveneffects.github.io/arduino_midi_library/)).
50+
See the extended documentation [here](http://arduinomidilib.fortyseveneffects.com) ([Mirror](http://fortyseveneffects.github.io/arduino_midi_library/)).
5051

5152
### Using MIDI.begin
5253

5354
In the `setup()` function of the Arduino, you must call the `MIDI.begin()` method. If you don't give any argument to this method, the input channel for MIDI in will be set to 1 (channels are going from 1 to 16, plus `MIDI_CHANNEL_OMNI to listen to all channels at the same time).
5455

5556
This method will:
56-
* Start the serial port at the MIDI baudrate (31250)
57-
* Set the input channel at the argument given (if any, else 1)
58-
* Enable Soft Thru, without filtering (everything at the input is sent back)
57+
* Start the serial port at the MIDI baudrate (31250).
58+
* Set the input channel at the argument given (if any, else 1).
59+
* Enable Soft Thru, without filtering (everything at the input is sent back).
5960

6061

6162

6263
### MIDI Thru
6364

6465
The MIDI Thru allows you to redirect your incoming messages to the MIDI output. It replaces the need of a MIDI Thru connector, as it copies every valid incoming message from the input. For good performance, you might want to call read() in a fast loop, for low latency.
6566

66-
Incoming unread bytes/messages are kept in the Arduino serial buffer, in order not to flood it, check regularily with MIDI.read. See the reference for Thru explanations.
67+
Incoming unread bytes/messages are kept in the Arduino serial buffer, in order not to flood it, check regularily with MIDI.read. See the documentation for Thru explanations.
6768

6869
Thru is enabled by default, you can turn it off using appropriate methods.
6970

7071

7172
### Hardware
7273

73-
Take a look at [the MIDI.org schematic](http://www.midi.org/techspecs/electrispec.php)
74+
Take a look at [the MIDI.org schematic](http://www.midi.org/techspecs/electrispec.php).
7475

7576

7677
## Contact

arduino-playground.md

Lines changed: 0 additions & 86 deletions
This file was deleted.

0 commit comments

Comments
 (0)