From 0e9e505543b9e49c7a3e7d366905434933d96a38 Mon Sep 17 00:00:00 2001 From: Francois Best Date: Sun, 4 Nov 2018 14:17:30 +0100 Subject: [PATCH] doc: Note the importance of Running Status being disabled for USB --- doc/usb-midi.md | 16 ++++++++++++++++ src/midi_Settings.h | 1 + 2 files changed, 17 insertions(+) create mode 100644 doc/usb-midi.md diff --git a/doc/usb-midi.md b/doc/usb-midi.md new file mode 100644 index 0000000..0c19f68 --- /dev/null +++ b/doc/usb-midi.md @@ -0,0 +1,16 @@ +# Using the library for MIDI through USB + +Some boards have "native" USB functionality, which means they can directly +connect to a computer and appear as a USB MIDI device. + +Here are the officially supported boards: + +- Arduino Leonardo +- Arduino Due + +## Pre-requisites + +To use USB MIDI to send messages to the computer, you must disable Running +Status in the settings. This is because the USB transport is stateless and has +no knowledge of the last message's running status. +The setting is off by default, so if you use custom settings, keep that in mind. diff --git a/src/midi_Settings.h b/src/midi_Settings.h index 1951944..493a3b3 100644 --- a/src/midi_Settings.h +++ b/src/midi_Settings.h @@ -50,6 +50,7 @@ struct DefaultSettings { /*! Running status enables short messages when sending multiple values of the same type and channel.\n + Must be disabled to send USB MIDI messages to a computer Warning: does not work with some hardware, enable with caution. */ static const bool UseRunningStatus = false;