doc: Note the importance of Running Status being disabled for USB

This commit is contained in:
Francois Best 2018-11-04 14:17:30 +01:00
parent 67a13be6c6
commit 0e9e505543
2 changed files with 17 additions and 0 deletions

16
doc/usb-midi.md Normal file
View File

@ -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.

View File

@ -50,6 +50,7 @@ struct DefaultSettings
{ {
/*! Running status enables short messages when sending multiple values /*! Running status enables short messages when sending multiple values
of the same type and channel.\n 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. Warning: does not work with some hardware, enable with caution.
*/ */
static const bool UseRunningStatus = false; static const bool UseRunningStatus = false;