Seich
/
arduino_midi_library
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Update links 

[skip ci]
This commit is contained in:
Francois Best 2018-10-11 11:45:46 +02:00
parent db0f65a46e
commit b9397337d2
1 changed files with 31 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
README.md
View File

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