Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
tannewt Merge pull request #9 from kevinjwalters/master
Implementation of a parser for MIDI events (messages) and alternative send interface
Latest commit 5a7dc9d Apr 9, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
adafruit_midi Removing old TODO, polishing docs for MIDIMessage.register_message_ty… Apr 8, 2019
docs Removing default values in MIDI constructor for midi_in and midi_out … Apr 6, 2019
examples workaround for Travis pylint issue with false no-… Apr 7, 2019
tests Giving NoteOn and NoteOff some default velocity values as this is use… Apr 8, 2019
.gitignore Initial release. Jan 25, 2019
.pylintrc Initial release. Jan 25, 2019
.readthedocs.yml Initial release. Jan 25, 2019
.travis.yml Going back to previous .travis.yml as it has broken. #3 Apr 2, 2019 Initial release. Jan 25, 2019
LICENSE Initial release. Jan 25, 2019
README.rst Removing default values in MIDI constructor for midi_in and midi_out … Apr 6, 2019
requirements.txt Update requirements.txt Jan 25, 2019



Documentation Status Discord Build Status

A CircuitPython helper for encoding/decoding MIDI packets over a MIDI or UART connection.


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 .env
source .env/bin/activate
pip3 install adafruit-circuitpython-midi

Usage Example

import time
import random
import usb_midi
import adafruit_midi

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.note_on(44, 120)
    midi.note_off(44, 120)
    midi.control_change(3, 44)


Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Building locally

Zip release files

To build this library locally you'll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-midi --library_location .

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.

You can’t perform that action at this time.