#include <MIDI_Interfaces/DebugMIDI_Interface.hpp>

Detailed Description

A class for debug MIDI outputs sending human-readable MIDI messages over the USB CDC connection.

Boards without a native USB connection (UNO, MEGA, Nano ...) use HardwareSerial0 for USB communication.

Definition at line 154 of file DebugMIDI_Interface.hpp.

Inheritance diagram for USBDebugMIDI_Output:

Collaboration diagram for USBDebugMIDI_Output:

Enabling and disabling updatables
void	enable ()
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

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.

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.

bool	isEnabled () const
	Check if this updatable is enabled.

void	moveDown ()
	Move down this element in the list.

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

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.

Sending MIDI Channel Voice messages
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.

Sending MIDI System Common messages
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.

Sending MIDI System Exclusive messages
void	send (SysExMessage message)
	Send a MIDI System Exclusive message.

void	sendSysEx (const uint8_t(&sysexdata)[N], Cable cable=Cable_1)
	Send a MIDI System Exclusive message.

void	sendSysEx (const uint8_t *data, uint16_t length, Cable cable=Cable_1)
	Send a MIDI System Exclusive message.

Sending MIDI Real-Time messages
void	send (RealTimeMessage message)
	Send a MIDI Real-Time message.

void	sendRealTime (MIDIMessageType rt, Cable cable=Cable_1)
	Send a MIDI Real-Time message.

void	sendRealTime (uint8_t rt, Cable cable=Cable_1)
	Send a MIDI Real-Time message.

void	sendTimingClock (Cable cable=Cable_1)
	Send a MIDI Timing Clock message.

void	sendStart (Cable cable=Cable_1)
	Send a MIDI Start message.

void	sendContinue (Cable cable=Cable_1)
	Send a MIDI Continue message.

void	sendStop (Cable cable=Cable_1)
	Send a MIDI Stop message.

void	sendActiveSensing (Cable cable=Cable_1)
	Send a MIDI Active Sensing message.

void	sendSystemReset (Cable cable=Cable_1)
	Send a MIDI System Reset message.

Flushing the MIDI send buffer
void	sendNow ()
	Causes all buffered messages to be sent immediately.

Deprecated
void	sendKP (MIDIAddress address, uint8_t pressure)
	Send a MIDI Key Pressure event.

void	sendCC (MIDIAddress address, uint8_t value)
	Send a MIDI Control Change event.

void	sendPC (MIDIAddress address)
	Send a MIDI Program Change event.

void	sendPC (MIDIChannelCable address, uint8_t value)
	Send a MIDI Program Change event.

void	sendCP (MIDIChannelCable address, uint8_t pressure)
	Send a MIDI Channel Pressure event.

void	sendPB (MIDIChannelCable address, uint16_t value)
	Send a MIDI Pitch Bend event.

Connecting and disconnecting MIDI Pipes
void	connectSourcePipe (MIDI_Pipe *source)
	Fully connect a source pipe to this sink.

void	disconnectSourcePipes ()
	Disconnect all source pipes that sink to this sink (recursively).

bool	disconnect (TrueMIDI_Source &source)
	Disconnect the given source from this sink.

bool	disconnect (MIDI_Pipe &)=delete

bool	hasSourcePipe () const
	Check if this sink is connected to a source pipe.

MIDI_Pipe *	getSourcePipe () const
	Get a pointer to the pipe this sink is connected to, or `nullptr` if not connected.

Public Member Functions
	USBDebugMIDI_Output (unsigned long baud=AH::defaultBaudRate, const char *prefix=nullptr)
	Construct a USBDebugMIDI_Output with the given baud rate.

	USBDebugMIDI_Output (const char *prefix)

void	begin () override
	Start the Serial interface at the predefined baud rate.

Print &	getStream () const

void	setPrefix (const char *prefix)
	Set the prefix to be printed before each message.

const char *	getPrefix () const

Static Public Member Functions
static void	beginAll ()

static void	swap (MIDI_Sink &a, MIDI_Sink &b)

Protected Member Functions
void	sendChannelMessageImpl (ChannelMessage)

void	sendChannelMessageImpl (Print &, ChannelMessage)

void	sendSysCommonImpl (SysCommonMessage)

void	sendSysCommonImpl (Print &, SysCommonMessage)

void	sendSysExImpl (SysExMessage)

void	sendSysExImpl (Print &, SysExMessage)

void	sendRealTimeImpl (RealTimeMessage)

void	sendRealTimeImpl (Print &, RealTimeMessage)

void	sendNowImpl ()

void	sendNowImpl (Print &)

void	sinkMIDIfromPipe (ChannelMessage m) override
	Accept an incoming MIDI Channel message.

void	sinkMIDIfromPipe (SysExMessage m) override
	Accept an incoming MIDI System Exclusive message.

void	sinkMIDIfromPipe (SysCommonMessage m) override
	Accept an incoming MIDI System Common message.

void	sinkMIDIfromPipe (RealTimeMessage m) override
	Accept an incoming MIDI Real-Time message.

Protected Attributes
Node *	next = nullptr

Node *	previous = nullptr

Print &	stream

friend	MIDI_Sender< StreamDebugMIDI_Output >

MIDI_Pipe *	sourcePipe = nullptr

Static Protected Attributes
static DoublyLinkedList< MIDIOutputOnly >	updatables

static DoublyLinkedList< MIDIOutputOnly >	updatables

Private Member Functions
virtual void	stallDownstream (MIDIStaller , MIDI_Source )
	Base case for recursive stall function.

virtual void	unstallDownstream (MIDIStaller , MIDI_Source )
	Base case for recursive un-stall function.

virtual MIDI_Sink *	getFinalSink ()
	Base case for recursive function.

void	disconnectSourcePipesShallow ()
	Disconnect only the first pipe connected to this sink.

Private Attributes
const unsigned long	baud

const char *	prefix = nullptr

Constructor & Destructor Documentation

◆ USBDebugMIDI_Output() [1/2]

USBDebugMIDI_Output	(	unsigned long	baud = AH::defaultBaudRate,
		const char *	prefix = nullptr )

inline

Construct a USBDebugMIDI_Output with the given baud rate.

Parameters

baud	The baud rate to start the USB Serial connection with.
prefix	An optional string to print before each message.

Definition at line 164 of file DebugMIDI_Interface.hpp.

◆ USBDebugMIDI_Output() [2/2]

USBDebugMIDI_Output ( const char * prefix )

inline

See also: USBDebugMIDI_Output(unsigned long,const char *)

Definition at line 168 of file DebugMIDI_Interface.hpp.

Member Function Documentation

◆ begin()

void begin ( )

inlineoverridevirtualinherited

Start the Serial interface at the predefined baud rate.

Implements MIDIOutputOnly.

Definition at line 110 of file DebugMIDI_Interface.hpp.

◆ beginAll()

static void beginAll ( )

inlinestaticinherited

Definition at line 72 of file DebugMIDI_Interface.hpp.

◆ enable() [1/8]

void enable ( )

inlineinherited

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/8]

static void enable ( UpdatableCRTP< MIDIOutputOnly > * element )

inlinestaticinherited

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/8]

static void enable ( UpdatableCRTP< MIDIOutputOnly > & element )

inlinestaticinherited

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/8]

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.

◆ enable() [5/8]

void enable ( )

inlineinherited

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() [6/8]

static void enable ( UpdatableCRTP< MIDIOutputOnly > * element )

inlinestaticinherited

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() [7/8]

static void enable ( UpdatableCRTP< MIDIOutputOnly > & element )

inlinestaticinherited

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() [8/8]

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.