Personal Mirror
Go to file
Francois Best ae2bd6aa47 chore: Need Debug to generate coverage 2021-08-10 09:44:57 +02:00
.github chore: Need Debug to generate coverage 2021-08-10 09:44:57 +02:00
.vscode chore: Config 2021-08-06 09:35:54 +02:00
builder chore: Inline install script (reduce indirections) 2021-08-10 09:13:27 +02:00
doc Minor fix (line 65) 2021-08-01 20:00:28 +02:00
examples doc: Update example 2020-04-24 07:10:02 +02:00
external chore: Update Google Test & remove USBMIDI 2020-04-17 08:15:01 +02:00
res Update library manager screenshot 2020-09-16 16:39:29 +02:00
src chore: Allow copying Messages 2021-08-06 09:35:54 +02:00
test Update unit-tests_MidiInput.cpp 2020-04-20 14:31:51 +02:00
.editorconfig chore: Add VSCode config files & editor settings 2018-10-11 10:32:26 +02:00
.gitignore Added support for Active Sensing and SysEx command segments (v4.4.0) (#138) 2020-04-08 10:36:10 +02:00
.gitmodules chore: Update Google Test & remove USBMIDI 2020-04-17 08:15:01 +02:00
.travis.yml chore: Remove Google test coverage 2020-04-20 16:47:36 +02:00
CMakeLists.txt Moved stuff to builder. Added code coverage. 2016-10-08 02:36:15 +02:00
CONTRIBUTING.md docs: Contributions 2020-04-20 17:30:03 +02:00
LICENSE Added badges and license file. 2016-10-03 12:04:44 -07:00
README.md doc: Update contributors 2021-08-01 20:02:40 +02:00
ReleaseNotes.md doc: Add AppleMIDI & release notes 2020-04-20 17:33:46 +02:00
keywords.txt Added support for Active Sensing and SysEx command segments (v4.4.0) (#138) 2020-04-08 10:36:10 +02:00
library.json chore: Release 5.0.2 2020-04-28 07:31:42 +02:00
library.properties chore: Release 5.0.2 2020-04-28 07:31:42 +02:00

README.md

Arduino MIDI Library

Build Status Coveralls GitHub release License

This library adds MIDI I/O communications to an Arduino board.

Features

  • New : MIDI over USB, Bluetooth, IP & AppleMIDI (see Transports).
  • New : Active Sensing support
  • 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 to handle input messages more easily.
  • Last received message is saved until a new one arrives.
  • Configurable: overridable template-based settings.
  • Create more than one MIDI interface for mergers/splitters applications.
  • Use any serial port, hardware or software.

Getting Started

  1. Use the Arduino Library Manager to install the library. Type "MIDI I/Os for Arduino" in the Arduino IDE Library Manager

  2. Start coding:

#include <MIDI.h>

// Create and bind 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();
}
  1. Read the documentation or watch the awesome video tutorials from Notes & Volts.

Documentation

USB Migration (4.x to 5.x)

All USB related code has been moved into a separate repository Arduino-USB-MIDI, USB MIDI Device support with MIDIUSB, still using this library to do all the MIDI heavy-lifting.

Migration has been made as easy as possible: only the declaration of the MIDI object has been modified, the rest of your code remains identical.

4.3.1 code:

#include <MIDI.h>
#include <midi_UsbTransport.h>

static const unsigned sUsbTransportBufferSize = 16;
typedef midi::UsbTransport<sUsbTransportBufferSize> UsbTransport;

UsbTransport sUsbTransport;

MIDI_CREATE_INSTANCE(UsbTransport, sUsbTransport, MIDI);

// ...

now becomes in 5.x:

#include <USB-MIDI.h>
USBMIDI_CREATE_DEFAULT_INSTANCE();

// ...

Start with the NoteOnOffEverySec example that is based on the original MidiUSB sketch. Note the only difference is in the declaration.

The USB-MIDI Arduino library depends on this library and the MIDIUSB library.

USB-MIDI uses the latest Arduino IDE depends feature in the library.properties file installing all the dependencies automatically when installing from the IDE.

Other Transport mechanisms

Version 5 of this library, allows for other Transport layers than the original MIDI 1.0 Electrical Specification (hardware serial).

All these Transport layers use this library for all the underlying MIDI work, making it easy to switch transport protocols or making transport protocol bridges.

Differences between Serial & other transports

  • Software Thru is enabled by default on Serial, but not on other transports.

Contact & Contribution

To report a bug, contribute, discuss on usage, or request support, please discuss it here.

You can also contact me on Twitter: @fortysevenfx.

Contributors

Special thanks to all who have contributed to this open-source project !

You want to help ? Check out the contribution guidelines.

License

MIT © 2009 - present Francois Best