Skip to content

Commit 0e9e505

Browse files
committed
doc: Note the importance of Running Status being disabled for USB
1 parent 67a13be commit 0e9e505

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

doc/usb-midi.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Using the library for MIDI through USB
2+
3+
Some boards have "native" USB functionality, which means they can directly
4+
connect to a computer and appear as a USB MIDI device.
5+
6+
Here are the officially supported boards:
7+
8+
- Arduino Leonardo
9+
- Arduino Due
10+
11+
## Pre-requisites
12+
13+
To use USB MIDI to send messages to the computer, you must disable Running
14+
Status in the settings. This is because the USB transport is stateless and has
15+
no knowledge of the last message's running status.
16+
The setting is off by default, so if you use custom settings, keep that in mind.

src/midi_Settings.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ struct DefaultSettings
5050
{
5151
/*! Running status enables short messages when sending multiple values
5252
of the same type and channel.\n
53+
Must be disabled to send USB MIDI messages to a computer
5354
Warning: does not work with some hardware, enable with caution.
5455
*/
5556
static const bool UseRunningStatus = false;

0 commit comments

Comments
 (0)