Skip to content

Commit 3d06d8f

Browse files
author
Francois Best
committed
Updated readme.
[skip ci]
1 parent 2b31380 commit 3d06d8f

File tree

2 files changed

+38
-55
lines changed

2 files changed

+38
-55
lines changed

README.md

Lines changed: 27 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@
66
[![License](https://img.shields.io/github/license/FortySevenEffects/arduino_midi_library.svg?maxAge=3600)](LICENSE)
77

88
This library enables MIDI I/O communications on the Arduino serial ports.
9-
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.
10-
11-
Download the latest version [here](https://github.com/FortySevenEffects/arduino_midi_library/releases/latest).
129

1310
### Features
1411
* Compatible with all Arduino boards (and clones with an AVR processor).
@@ -17,73 +14,48 @@ Download the latest version [here](https://github.com/FortySevenEffects/arduino_
1714
* Software Thru, with message filtering.
1815
* [Callbacks](http://playground.arduino.cc/Main/MIDILibraryCallbacks) to handle input messages more easily.
1916
* Last received message is saved until a new one arrives.
20-
* Configurable: [overridable template-based settings](http://arduinomidilib.fortyseveneffects.com/a00013.html#details).
17+
* Configurable: [overridable template-based settings](https://github.com/FortySevenEffects/arduino_midi_library/wiki/Using-custom-Settings).
2118
* Create more than one MIDI port for mergers/splitters applications.
2219
* Use any serial port, hardware or software.
2320

21+
### Getting Started
2422

25-
#### Changelog
26-
* 11/06/2014 : Version 4.2 released. Bug fix for SysEx, overridable template settings.
27-
* 16/04/2014 : Version 4.1 released. Bug fixes regarding running status.
28-
* 13/02/2014 : Version 4.0 released. Moved to GitHub, added multiple instances & software serial support, and a few bug fixes.
29-
* 29/01/2012 : Version 3.2 released. Release notes are [here](http://sourceforge.net/news/?group_id=265194).
30-
* 06/05/2011 : Version 3.1 released. Added [callback](http://playground.arduino.cc/Main/MIDILibraryCallbacks) support.
31-
* 06/03/2011 : Version 3.0 released. Project is now hosted on [SourceForge](http://sourceforge.net/projects/arduinomidilib).
32-
* 14/12/2009 : Version 2.5 released.
33-
* 28/07/2009 : Version 2.0 released.
34-
* 28/03/2009 : Simplified version of MIDI.begin, Fast mode is now on by default.
35-
* 08/03/2009 : Thru method operational. Added some features to enable thru.
36-
37-
38-
39-
**__Warning: this library requires Arduino 1.0 or more recent versions.__**
40-
41-
42-
### What do I need to do?
43-
44-
* Download the library ([link](https://github.com/FortySevenEffects/arduino_midi_library/releases/latest)).
45-
* Follow the installation instructions - http://arduino.cc/en/Guide/Libraries.
46-
* Include the library in your sketch using the menu in the IDE, or type `#include <MIDI.h>`
47-
* Create the MIDI instance using `MIDI_CREATE_DEFAULT_INSTANCE();` or take a look at the documentation for custom serial port, settings etc..
48-
49-
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.
50-
You can also watch the awesome video tutorials from [Notes & Volts](https://www.youtube.com/playlist?list=PL4_gPbvyebyH2xfPXePHtx8gK5zPBrVkg).
51-
23+
1. Use Arduino's Library Manager to install the library.
24+
2. Start coding:
25+
```c++
26+
#include <MIDI.h>
5227

53-
##Documentation
28+
// Created and binds the MIDI interface to the default hardware Serial port
29+
MIDI_CREATE_DEFAULT_INSTANCE();
5430

55-
See the extended documentation [here](http://arduinomidilib.fortyseveneffects.com) ([Mirror](http://fortyseveneffects.github.io/arduino_midi_library/)).
31+
void setup()
32+
{
33+
MIDI.begin(MIDI_CHANNEL_OMNI); // Listen to all incoming messages
34+
}
5635

57-
### Using MIDI.begin
36+
void loop()
37+
{
38+
// Send note 42 with velocity 127 on channel 1
39+
MIDI.sendNoteOn(42, 127, 1);
5840

59-
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).
41+
// Read incoming messages
42+
MIDI.read();
43+
}
44+
```
6045

61-
This method will:
62-
* Start the serial port at the MIDI baudrate (31250).
63-
* Set the input channel at the argument given (if any, else 1).
64-
* Enable Soft Thru, without filtering (everything at the input is sent back).
46+
3. Read the [documentation](#documentation) or watch the awesome video tutorials from [Notes & Volts](https://www.youtube.com/playlist?list=PL4_gPbvyebyH2xfPXePHtx8gK5zPBrVkg).
6547

48+
## Documentation
6649

67-
68-
### MIDI Thru
69-
70-
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.
71-
72-
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.
73-
74-
Thru is enabled by default, you can turn it off using appropriate methods.
75-
76-
77-
### Hardware
78-
79-
Take a look at [the MIDI.org schematic](http://www.midi.org/techspecs/electrispec.php).
80-
50+
- [Doxygen Extended Documentation](http://arduinomidilib.fortyseveneffects.com) ([Mirror](http://fortyseveneffects.github.io/arduino_midi_library/)).
51+
- [GitHub wiki](https://github.com/FortySevenEffects/arduino_midi_library/wiki).
8152

8253
## Contact
83-
if you have any comment or support request to make, feel free to contact me: francois.best@fortyseveneffects.com
54+
55+
To report a bug, contribute, discuss on usage, or simply request support, please [create an issue here](https://github.com/FortySevenEffects/arduino_midi_library/issues/new).
8456

8557
You can also get informations about bug fixes and updates on my twitter account: [@fortysevenfx](http://twitter.com/fortysevenfx).
8658

8759
## License
8860

89-
MIT © 2015 [Francois Best](http://fortyseveneffects.com)
61+
MIT © 2016 [Francois Best](http://fortyseveneffects.com)

ReleaseNotes.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
#### Changelog
2+
* 11/06/2014 : Version 4.2 released. Bug fix for SysEx, overridable template settings.
3+
* 16/04/2014 : Version 4.1 released. Bug fixes regarding running status.
4+
* 13/02/2014 : Version 4.0 released. Moved to GitHub, added multiple instances & software serial support, and a few bug fixes.
5+
* 29/01/2012 : Version 3.2 released. Release notes are [here](http://sourceforge.net/news/?group_id=265194).
6+
* 06/05/2011 : Version 3.1 released. Added [callback](http://playground.arduino.cc/Main/MIDILibraryCallbacks) support.
7+
* 06/03/2011 : Version 3.0 released. Project is now hosted on [SourceForge](http://sourceforge.net/projects/arduinomidilib).
8+
* 14/12/2009 : Version 2.5 released.
9+
* 28/07/2009 : Version 2.0 released.
10+
* 28/03/2009 : Simplified version of MIDI.begin, Fast mode is now on by default.
11+
* 08/03/2009 : Thru method operational. Added some features to enable thru.

0 commit comments

Comments
 (0)