Introduction¶
A CircuitPython helper for encoding/decoding MIDI packets over a MIDI or UART connection.
Dependencies¶
This driver depends on:
Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.
Installing from PyPI¶
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:
pip3 install adafruit-circuitpython-midi
To install system-wide (this may be required in some cases):
sudo pip3 install adafruit-circuitpython-midi
To install in a virtual environment in your current project:
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-midi
Usage Example¶
import time
import random
import usb_midi
import adafruit_midi
from adafruit_midi.note_on import NoteOn
from adafruit_midi.note_off import NoteOff
from adafruit_midi.pitch_bend import PitchBend
from adafruit_midi.control_change import ControlChange
midi = adafruit_midi.MIDI(midi_out=usb_midi.ports[1], out_channel=0)
print("Midi test")
print("Default output MIDI channel:", midi.out_channel + 1)
while True:
midi.send(NoteOn(44, 120)) # G sharp 2nd octave
time.sleep(0.25)
a_pitch_bend = PitchBend(random.randint(0, 16383))
midi.send(a_pitch_bend)
time.sleep(0.25)
midi.send([NoteOff("G#2", 120),
ControlChange(3, 44)])
time.sleep(0.5)
Documentation¶
API documentation for this library can be found on Read the Docs.
For information on building library documentation, please check out this guide.
Contributing¶
Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.
Table of Contents¶
Examples
API Reference
adafruit_midi
MIDI
adafruit_midi.channel_pressure
ChannelPressure
adafruit_midi.control_change
ControlChange
adafruit_midi.control_change_values
adafruit_midi.midi_continue
Continue
adafruit_midi.midi_message
MIDIBadEvent
MIDIMessage
MIDIUnknownEvent
channel_filter()
note_parser()
adafruit_midi.mtc_quarter_frame
MtcQuarterFrame
adafruit_midi.note_off
NoteOff
adafruit_midi.note_on
NoteOn
adafruit_midi.pitch_bend
PitchBend
adafruit_midi.polyphonic_key_pressure
PolyphonicKeyPressure
adafruit_midi.program_change
ProgramChange
adafruit_midi.start
Start
adafruit_midi.stop
Stop
adafruit_midi.system_exclusive
SystemExclusive
adafruit_midi.timing_clock
TimingClock