62 lines
2.7 KiB
Markdown
62 lines
2.7 KiB
Markdown
# Arduino MIDI Library
|
|
|
|
[](https://travis-ci.org/FortySevenEffects/arduino_midi_library)
|
|
[](https://coveralls.io/github/FortySevenEffects/arduino_midi_library)
|
|
[](https://github.com/FortySevenEffects/arduino_midi_library/releases/latest)
|
|
[](LICENSE)
|
|
|
|
This library enables MIDI I/O communications on the Arduino serial ports.
|
|
|
|
### Features
|
|
* Compatible with all Arduino boards (and clones with an AVR processor).
|
|
* Simple and fast way to send and receive every kind of MIDI message (including all System messages, SysEx, Clock, etc..).
|
|
* OMNI input reading (read all channels).
|
|
* Software Thru, with message filtering.
|
|
* [Callbacks](http://playground.arduino.cc/Main/MIDILibraryCallbacks) to handle input messages more easily.
|
|
* Last received message is saved until a new one arrives.
|
|
* Configurable: [overridable template-based settings](https://github.com/FortySevenEffects/arduino_midi_library/wiki/Using-custom-Settings).
|
|
* Create more than one MIDI port for mergers/splitters applications.
|
|
* Use any serial port, hardware or software.
|
|
|
|
### Getting Started
|
|
|
|
1. Use Arduino's Library Manager to install the library.
|
|
2. Start coding:
|
|
```c++
|
|
#include <MIDI.h>
|
|
|
|
// Created and binds the MIDI interface to the default hardware Serial port
|
|
MIDI_CREATE_DEFAULT_INSTANCE();
|
|
|
|
void setup()
|
|
{
|
|
MIDI.begin(MIDI_CHANNEL_OMNI); // Listen to all incoming messages
|
|
}
|
|
|
|
void loop()
|
|
{
|
|
// Send note 42 with velocity 127 on channel 1
|
|
MIDI.sendNoteOn(42, 127, 1);
|
|
|
|
// Read incoming messages
|
|
MIDI.read();
|
|
}
|
|
```
|
|
|
|
3. Read the [documentation](#documentation) or watch the awesome video tutorials from [Notes & Volts](https://www.youtube.com/playlist?list=PL4_gPbvyebyH2xfPXePHtx8gK5zPBrVkg).
|
|
|
|
## Documentation
|
|
|
|
- [Doxygen Extended Documentation](http://arduinomidilib.fortyseveneffects.com) ([Mirror](http://fortyseveneffects.github.io/arduino_midi_library/)).
|
|
- [GitHub wiki](https://github.com/FortySevenEffects/arduino_midi_library/wiki).
|
|
|
|
## Contact
|
|
|
|
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).
|
|
|
|
You can also get informations about bug fixes and updates on my twitter account: [@fortysevenfx](http://twitter.com/fortysevenfx).
|
|
|
|
## License
|
|
|
|
MIT © 2016 [Francois Best](http://fortyseveneffects.com)
|