Component: MIDI (Comms: System)

Author	Matrix Ltd.
Version	2.0
Category	Comms: System

MIDI component

Low level routines for controlling or interacting with a standard MIDI interface.

Detailed description

No detailed description exists yet for this component

Examples

Basic example to play a series of notes getting higher in pitch and then going down in pitch. This repeats in a loop and each time the loop repeats the instrument is changed. The current note and instrument are displayed on the LCD. MIDI Test File

The MIDI component during simulation has functionality to allow it to work with MIDI synthesizers installed on your PC.

To select your software or hardware synthesizer select from the property selector.

If you don't have a MIDI interface installed then IP MIDI seems to be a good option that works well.

Once installed the MIDI output should play through your computer speakers.

The console window can be used to view the MIDI data as it is sent out and received.

The MIDI component during embedded operation will communicate using a UART serial channel. An EB021 MIDI E-block is available to allow standard MIDI cables to be connected up to a system.

Downloadable macro reference

	SendMIDI
Sends a MIDI packet consisting of up to three bytes of information,
- BYTE	Status
MIDI Status Byte - Used for commands such as NoteOn, NoteOff etc.
- BYTE	Data1
MIDI Data Byte - Used as a parameter specific to the specified command
- BYTE	Data2
MIDI Data Byte - Used as a parameter specific to the specified command
- VOID	Return

	SendPitchChange
Sends out a pitch change command on the specified channel.
- BYTE	Channel
Channel to send the pitch change to
- UINT	Pitch_Change
New pitch value to use, Default 0x2000
- VOID	Return

	SendNoteOff
Sends a note off command using the channel, note and velocity specified.
- BYTE	Channel
- BYTE	Note
- BYTE	Velocity
- VOID	Return

	SendControl
Sends a control command using the channel, controller and value specified.
- BYTE	Channel
- BYTE	Controller
- BYTE	Value
- VOID	Return

	SendNoteOn
Sends a note on command using the channel, note and velocity specified.
- BYTE	Channel
- BYTE	Note
- BYTE	Velocity
- VOID	Return

	ReceiveMIDI
Waits for the time specified in the timeout parameter for an incoming MIDI message. Returns 0 to indicate a timeout, otherwise returns the first value from the MIDI message.
- BYTE	Timeout
- BYTE	Return

	SendPolyPressure
Sends a note press with an associated polyphonic pressure value.
- BYTE	Channel
- BYTE	Note
- BYTE	Pressure
- VOID	Return

	ReadData
- BYTE	Idx
- BYTE	Return

	SendPatch
- BYTE	Channel
- BYTE	Instrument
- VOID	Return

	SendChannelPressure
- BYTE	Channel
- BYTE	Pressure
- VOID	Return

	Initialise
Initialises the MIDI component and sets up the UART.
- VOID	Return

	CommsBaud
Sets the Baud rate of the alt communications channel
- BYTE	Baud
Range: 0-7 : 0=1200 / 7=115200
- VOID	Return

	LCDOptions
Controls some of the LCD options
- BYTE	Foreground
Range: 0-1
- BYTE	Background
Range: 0-1
- BYTE	Transparent
Range: 0-1
- VOID	Return

	LCDVerbose
Controls the Verbose mode. When enabled the LCD automatically displays an account of the incoming API commands and parameters. When switched off the LCD is free for the user to control as required.
- BYTE	Mode
Range: 0-1 : 0=Off or User Mode / 1=API Verbose Mode
- VOID	Return

	ReadDigitalInput
Reads a single digital input.
- BYTE	Channel
- BYTE	Return

	PWMConfig
Sets the PWM configuration. Channel = 0 - 1 : 0 = EN_AB, A, B / 1 = EN_CD, C, D Period = 0 - 65535 Scaler = 0 - 3 : 0=1:1 1=1:8 2=1:64 3=1:256
- BYTE	Channel
Range 0-1
- UINT	Period
Range: 0-65535
- BYTE	Scaler
Range: 0-3
- VOID	Return

	PWMEnable
Allows pulse width modulated transistor outputs to be switched on or off. Bit 0 = Enable AB Bit 1 = A / Bit 2 = B Bit 3 = C / Bit 4 = D Bit 5 = Enable CD
- BYTE	EnableMask
Range 0-63 or 0b00000 to 0b111111
- VOID	Return

	PWMDuty
Sets a single PWM channel duty. Channel = 0 - 5 : 0=EN_AB, 1=A, 2=B, 3=C, 4=D, 5=EN_CD Duty = 0 - 65535
- BYTE	Channel
Range 0-5
- UINT	Duty
- VOID	Return

	LCDCursor
Sets the cursor position for the MIAC display
- BYTE	X
Range: 0-21
- BYTE	Y
Range: 0-4
- VOID	Return

	WriteTran
Allows a single transistor output to be switched on or off.
- BYTE	Channel
Range 1-4
- BYTE	Value
0 = Off, 1 = On
- VOID	Return

	Initialise
- VOID	Return

	LCDClear
Clears the MIAC display
- VOID	Return

Property reference

	Properties
	Connections
	Channel
UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller.
	Baud Options
Baud rate option selector
	Baud Rate
	Use TX
Selects if the Transmit pin is used by the component. Yes: The TX pin is active and used to transmit data for the UART. No: The TX pin is disabled and free to be used as general I/O.
	TX
Pin to be used for Transmit data
	Use RX
Selects if the Receive pin is used by the component. Yes: The RX pin is active and used to receive data for the UART. No: The RX pin is disabled and free to be used as general I/O.
	RX
Pin to be used for Receive data
	Use Flow Control
Flow Control (Handshake) enable or disable. On: Two I/O pins are used to control the flow of data in and out of the device. Off: Flow control is disabled.
	RTS
Pin to be used for Request To Send handshake function Output from target micro to inform remote device we are ready to receive data. Low = Ready to receive data High = Not ready to receive data
	CTS
Pin to be used for Clear To Send handshake function. Input to target micro to inform when the remote device is ready to transmit data. Low = Ready to transmit data High = Not ready to transmit data
	Simulations
	Label
	MIDI Output
Decides if we are using special MIDI output or standard Serial/API Output. Yes: We send the simulation data via a MIDI interface. No: We send the simulation data via the standard COM/API interface.
	MIDI Port
	Scope Traces
Selects if the scope traces are automatically added to the data recorder window or not. Simulation - draws an approximation of the UART data onto the scope trace. ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD.
	Console Data
Selects if the console data is automatically generated or not
	Console Columns
Number of characters that can be displayed on a single line of the console.
	Data Source
Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port Injector - Routes the communication data via a data injector component on the Panel.