You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-13Lines changed: 14 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
#Arduino MIDI Library v4.2
2
2
3
3
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.
5
5
6
6
Download the latest version [here](https://github.com/FortySevenEffects/arduino_midi_library/releases/latest).
7
7
8
8
### 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).
10
10
* Simple and fast way to send and receive every kind of MIDI message (including all System messages, SysEx, Clock, etc..).
11
11
* OMNI input reading (read all channels).
12
12
* Software Thru, with message filtering.
@@ -21,7 +21,7 @@ Download the latest version [here](https://github.com/FortySevenEffects/arduino_
21
21
* 11/06/2014 : Version 4.2 released. Bug fix for SysEx, overridable template settings.
* 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).
25
25
* 06/05/2011 : Version 3.1 released. Added [callback](http://playground.arduino.cc/Main/MIDILibraryCallbacks) support.
26
26
* 06/03/2011 : Version 3.0 released. Project is now hosted on [SourceForge](http://sourceforge.net/projects/arduinomidilib).
27
27
* 14/12/2009 : Version 2.5 released.
@@ -36,41 +36,42 @@ Download the latest version [here](https://github.com/FortySevenEffects/arduino_
36
36
37
37
### What do I need to do?
38
38
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.
41
41
* Include the library in your sketch using the menu in the IDE, or type `#include <MIDI.h>`
42
42
* Create the MIDI instance using `MIDI_CREATE_DEFAULT_INSTANCE();` or take a look at the documentation for custom serial port, settings etc..
43
43
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).
45
46
46
47
47
-
##Reference
48
+
##Documentation
48
49
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/)).
50
51
51
52
### Using MIDI.begin
52
53
53
54
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).
54
55
55
56
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).
59
60
60
61
61
62
62
63
### MIDI Thru
63
64
64
65
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.
65
66
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.
67
68
68
69
Thru is enabled by default, you can turn it off using appropriate methods.
69
70
70
71
71
72
### Hardware
72
73
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).
0 commit comments