#include <MIDI_Interfaces/DebugMIDI_Interface.hpp>
A class for debug MIDI outputs sending human-readable MIDI messages over a HardwareSerial port.
Definition at line 122 of file DebugMIDI_Interface.hpp.
|
void | enable () |
| Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
|
|
void | disable () |
| Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
|
|
bool | isEnabled () const |
| Check if this updatable is enabled.
|
|
void | moveDown () |
| Move down this element in the list.
|
|
static void | enable (UpdatableCRTP *element) |
| Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
|
|
static void | enable (UpdatableCRTP &element) |
| Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
|
|
static void | enable (U(&array)[N]) |
| Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
|
|
static void | disable (UpdatableCRTP *element) |
| Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
|
|
static void | disable (UpdatableCRTP &element) |
| Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
|
|
static void | disable (U(&array)[N]) |
| Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
|
|
|
void | send (ChannelMessage message) |
| Send a MIDI Channel Voice message.
|
|
void | sendChannelMessage (MIDIMessageType m, Channel c, uint8_t d1, uint8_t d2, Cable cable=Cable_1) |
| Send a 3-byte MIDI Channel Voice message.
|
|
void | sendChannelMessage (MIDIMessageType m, Channel c, uint8_t d1, Cable cable=Cable_1) |
| Send a 2-byte MIDI Channel Voice message.
|
|
void | sendNoteOn (MIDIAddress address, uint8_t velocity) |
| Send a MIDI Note On event.
|
|
void | sendNoteOff (MIDIAddress address, uint8_t velocity) |
| Send a MIDI Note Off event.
|
|
void | sendKeyPressure (MIDIAddress address, uint8_t pressure) |
| Send a MIDI Key Pressure event.
|
|
void | sendControlChange (MIDIAddress address, uint8_t value) |
| Send a MIDI Control Change event.
|
|
void | sendProgramChange (MIDIAddress address) |
| Send a MIDI Program Change event.
|
|
void | sendProgramChange (MIDIChannelCable address, uint8_t value) |
| Send a MIDI Program Change event.
|
|
void | sendChannelPressure (MIDIChannelCable address, uint8_t pressure) |
| Send a MIDI Channel Pressure event.
|
|
void | sendPitchBend (MIDIChannelCable address, uint16_t value) |
| Send a MIDI Pitch Bend event.
|
|
|
void | send (SysCommonMessage message) |
| Send a MIDI System Common message.
|
|
void | sendSysCommon (MIDIMessageType m, Cable cable=Cable_1) |
| Send a MIDI System Common message.
|
|
void | sendSysCommon (MIDIMessageType m, uint8_t data1, Cable cable=Cable_1) |
| Send a MIDI System Common message.
|
|
void | sendSysCommon (MIDIMessageType m, uint8_t data1, uint8_t data2, Cable cable=Cable_1) |
| Send a MIDI System Common message.
|
|
void | sendMTCQuarterFrame (uint8_t data, Cable cable=Cable_1) |
| Send a MIDI Time Code Quarter Frame.
|
|
void | sendMTCQuarterFrame (uint8_t messageType, uint8_t values, Cable cable=Cable_1) |
| Send a MIDI Time Code Quarter Frame.
|
|
void | sendSongPositionPointer (uint16_t spp, Cable cable=Cable_1) |
| Send a MIDI Song Position Pointer message.
|
|
void | sendSongSelect (uint8_t song, Cable cable=Cable_1) |
| Send a MIDI Song Select message.
|
|
void | sendTuneRequest (Cable cable=Cable_1) |
| Send a MIDI Tune Request.
|
|
|
void | sendNow () |
| Causes all buffered messages to be sent immediately.
|
|
|
const unsigned long | baud |
|
const char * | prefix = nullptr |
|
◆ HardwareSerialDebugMIDI_Output() [1/2]
Construct a new Debug MIDI Output on the given HardwareSerial interface with the given baud rate.
- Parameters
-
serial | The HardwareSerial interface. |
baud | The baud rate for the serial interface. |
prefix | An optional string to print before each message. |
Definition at line 136 of file DebugMIDI_Interface.hpp.
◆ HardwareSerialDebugMIDI_Output() [2/2]
◆ begin()
|
inlineoverridevirtualinherited |
◆ beginAll()
◆ enable() [1/4]
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 96 of file Updatable.hpp.
◆ enable() [2/4]
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 125 of file Updatable.hpp.
◆ enable() [3/4]
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 127 of file Updatable.hpp.
◆ enable() [4/4]
static void enable |
( |
U(&) | array[N] | ) |
|
|
inlinestaticinherited |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 130 of file Updatable.hpp.
◆ disable() [1/4]
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 106 of file Updatable.hpp.
◆ disable() [2/4]
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 136 of file Updatable.hpp.
◆ disable() [3/4]
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 138 of file Updatable.hpp.
◆ disable() [4/4]
static void disable |
( |
U(&) | array[N] | ) |
|
|
inlinestaticinherited |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 141 of file Updatable.hpp.
◆ isEnabled()
Check if this updatable is enabled.
- Note
- Assumes that the updatable is not added to a different linked list by the user.
Definition at line 120 of file Updatable.hpp.
◆ moveDown()
Move down this element in the list.
Definition at line 147 of file Updatable.hpp.
◆ getStream()
Print & getStream |
( |
| ) |
const |
|
inlineinherited |
◆ sendChannelMessageImpl() [1/2]
◆ sendChannelMessageImpl() [2/2]
◆ sendSysCommonImpl() [1/2]
◆ sendSysCommonImpl() [2/2]
◆ sendSysExImpl() [1/2]
◆ sendSysExImpl() [2/2]
◆ sendRealTimeImpl() [1/2]
◆ sendRealTimeImpl() [2/2]
◆ sendNowImpl() [1/2]
◆ sendNowImpl() [2/2]
void sendNowImpl |
( |
Print & | | ) |
|
|
inlineprotectedinherited |
◆ sinkMIDIfromPipe() [1/4]
|
inlineoverrideprotectedvirtualinherited |
◆ sinkMIDIfromPipe() [2/4]
|
inlineoverrideprotectedvirtualinherited |
◆ sinkMIDIfromPipe() [3/4]
|
inlineoverrideprotectedvirtualinherited |
◆ sinkMIDIfromPipe() [4/4]
|
inlineoverrideprotectedvirtualinherited |
◆ setPrefix()
void setPrefix |
( |
const char * | prefix | ) |
|
|
inlineinherited |
◆ getPrefix()
const char * getPrefix |
( |
| ) |
const |
|
inlineinherited |
◆ send() [1/4]
Send a MIDI Channel Voice message.
◆ send() [2/4]
Send a MIDI System Common message.
◆ send() [3/4]
Send a MIDI System Exclusive message.
◆ send() [4/4]
Send a MIDI Real-Time message.
◆ sendChannelMessage() [1/2]
Send a 3-byte MIDI Channel Voice message.
- Parameters
-
m | MIDI message type. [0x80, 0xE0] |
c | The MIDI channel. [1, 16] |
d1 | The first data byte. [0, 127] |
d2 | The second data byte. [0, 127] |
cable | The MIDI Cable Number. [Cable_1, Cable_16] |
◆ sendChannelMessage() [2/2]
Send a 2-byte MIDI Channel Voice message.
- Parameters
-
m | MIDI message type. [0x80, 0xE0] |
c | The MIDI channel. [1, 16] |
d1 | The first data byte. [0, 127] |
cable | The MIDI Cable Number. [1, 16] |
◆ sendNoteOn()
void sendNoteOn |
( |
MIDIAddress | address, |
|
|
uint8_t | velocity ) |
|
inherited |
Send a MIDI Note On event.
◆ sendNoteOff()
void sendNoteOff |
( |
MIDIAddress | address, |
|
|
uint8_t | velocity ) |
|
inherited |
Send a MIDI Note Off event.
◆ sendKeyPressure()
void sendKeyPressure |
( |
MIDIAddress | address, |
|
|
uint8_t | pressure ) |
|
inherited |
Send a MIDI Key Pressure event.
◆ sendControlChange()
void sendControlChange |
( |
MIDIAddress | address, |
|
|
uint8_t | value ) |
|
inherited |
Send a MIDI Control Change event.
◆ sendProgramChange() [1/2]
Send a MIDI Program Change event.
◆ sendProgramChange() [2/2]
Send a MIDI Program Change event.
◆ sendChannelPressure()
Send a MIDI Channel Pressure event.
◆ sendPitchBend()
Send a MIDI Pitch Bend event.
◆ sendSysCommon() [1/3]
Send a MIDI System Common message.
◆ sendSysCommon() [2/3]
Send a MIDI System Common message.
◆ sendSysCommon() [3/3]
Send a MIDI System Common message.
◆ sendMTCQuarterFrame() [1/2]
void sendMTCQuarterFrame |
( |
uint8_t | data, |
|
|
Cable | cable = Cable_1 ) |
|
inherited |
Send a MIDI Time Code Quarter Frame.
◆ sendMTCQuarterFrame() [2/2]
void sendMTCQuarterFrame |
( |
uint8_t | messageType, |
|
|
uint8_t | values, |
|
|
Cable | cable = Cable_1 ) |
|
inherited |
Send a MIDI Time Code Quarter Frame.
◆ sendSongPositionPointer()
void sendSongPositionPointer |
( |
uint16_t | spp, |
|
|
Cable | cable = Cable_1 ) |
|
inherited |
Send a MIDI Song Position Pointer message.
◆ sendSongSelect()
Send a MIDI Song Select message.
◆ sendTuneRequest()
Send a MIDI Tune Request.
◆ sendSysEx() [1/2]
void sendSysEx |
( |
const uint8_t(&) | sysexdata[N], |
|
|
Cable | cable = Cable_1 ) |
|
inherited |
Send a MIDI System Exclusive message.
◆ sendSysEx() [2/2]
void sendSysEx |
( |
const uint8_t * | data, |
|
|
uint16_t | length, |
|
|
Cable | cable = Cable_1 ) |
|
inherited |
Send a MIDI System Exclusive message.
◆ sendRealTime() [1/2]
Send a MIDI Real-Time message.
◆ sendRealTime() [2/2]
Send a MIDI Real-Time message.
◆ sendTimingClock()
Send a MIDI Timing Clock message.
◆ sendStart()
Send a MIDI Start message.
◆ sendContinue()
Send a MIDI Continue message.
◆ sendStop()
Send a MIDI Stop message.
◆ sendActiveSensing()
Send a MIDI Active Sensing message.
◆ sendSystemReset()
Send a MIDI System Reset message.
◆ sendNow()
Causes all buffered messages to be sent immediately.
- Note
- Doesn't necessarily wait until all data has been sent, it just triggers the transmission, so everything will be transmitted as soon as possible.
◆ sendKP()
Send a MIDI Key Pressure event.
◆ sendCC()
Send a MIDI Control Change event.
◆ sendPC() [1/2]
Send a MIDI Program Change event.
◆ sendPC() [2/2]
Send a MIDI Program Change event.
◆ sendCP()
Send a MIDI Channel Pressure event.
◆ sendPB()
Send a MIDI Pitch Bend event.
◆ connectSourcePipe()
Fully connect a source pipe to this sink.
Definition at line 17 of file MIDI_Pipes.cpp.
◆ disconnectSourcePipes()
void disconnectSourcePipes |
( |
| ) |
|
|
inherited |
Disconnect all source pipes that sink to this sink (recursively).
Definition at line 26 of file MIDI_Pipes.cpp.
◆ disconnect() [1/2]
Disconnect the given source from this sink.
Leaves other sources connected. Returns true if the source was found and disconnected, false if the given source was not a direct or indirect source to this sink.
Definition at line 41 of file MIDI_Pipes.cpp.
◆ disconnect() [2/2]
◆ hasSourcePipe()
bool hasSourcePipe |
( |
| ) |
const |
|
inlineinherited |
Check if this sink is connected to a source pipe.
Definition at line 121 of file MIDI_Pipes.hpp.
◆ getSourcePipe()
Get a pointer to the pipe this sink is connected to, or nullptr
if not connected.
Definition at line 124 of file MIDI_Pipes.hpp.
◆ stallDownstream()
|
inlineprivatevirtualinherited |
◆ unstallDownstream()
|
inlineprivatevirtualinherited |
◆ getFinalSink()
|
inlineprivatevirtualinherited |
◆ disconnectSourcePipesShallow()
void disconnectSourcePipesShallow |
( |
| ) |
|
|
privateinherited |
Disconnect only the first pipe connected to this sink.
Leaves the other pipes connected to the original pipe, which doesn't have a sink anymore when this function finishes. Used to disconnect a MIDI_Pipe while preserving the connections of its “through” inputs.
Definition at line 34 of file MIDI_Pipes.cpp.
◆ swap()
◆ baud
◆ updatables
◆ next
◆ previous
◆ stream
◆ MIDI_Sender< StreamDebugMIDI_Output >
◆ prefix
const char* prefix = nullptr |
|
privateinherited |
◆ sourcePipe
The documentation for this class was generated from the following file: