https://github.com/todbot/circuitpython_tmidi

MIDI library for CircuitPython, inherits from Winterbloom_SmolMIDI
https://github.com/todbot/circuitpython_tmidi

circuitpython midi usb

Last synced: 3 months ago
JSON representation

MIDI library for CircuitPython, inherits from Winterbloom_SmolMIDI

• Host: GitHub
• URL: https://github.com/todbot/circuitpython_tmidi
• Owner: todbot
• License: mit
• Created: 2024-05-08T20:17:47.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-09-18T20:47:57.000Z (4 months ago)
• Last Synced: 2024-10-11T05:21:21.848Z (3 months ago)
• Topics: circuitpython, midi, usb
• Language: Python
• Homepage:
• Size: 44.9 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Introduction

============

.. image:: https://readthedocs.org/projects/circuitpython-tmidi/badge/?version=latest

    :target: https://circuitpython-tmidi.readthedocs.io/

    :alt: Documentation Status

.. image:: https://img.shields.io/discord/327254708534116352.svg

    :target: https://adafru.it/discord

    :alt: Discord

.. image:: https://github.com/todbot/CircuitPython_TMIDI/workflows/Build%20CI/badge.svg

    :target: https://github.com/todbot/CircuitPython_TMIDI/actions

    :alt: Build Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :target: https://github.com/psf/black

    :alt: Code Style: Black

MIDI library for CircuitPython

Dependencies

=============

This library depends on:

* `Adafruit CircuitPython `_

Please ensure all dependencies are available on the CircuitPython filesystem.

This is easily achieved by downloading

`the Adafruit library and driver bundle `_

or individual libraries can be installed using

`circup `_.

Installing from PyPI

=====================

.. note:: This library is not available on PyPI yet. Install documentation is included

   as a standard element. Stay tuned for PyPI availability!

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from

PyPI `_.

To install for current user:

.. code-block:: shell

    pip3 install circuitpython-tmidi

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install circuitpython-tmidi

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name

    python3 -m venv .venv

    source .env/bin/activate

    pip3 install circuitpython-tmidi

Installing to a Connected CircuitPython Device with Circup

==========================================================

Make sure that you have ``circup`` installed in your Python environment.

Install it with the following command if necessary:

.. code-block:: shell

    pip3 install circup

With ``circup`` installed and your CircuitPython device connected use the

following command to install:

.. code-block:: shell

    circup install tmidi

Or the following command to update an existing version:

.. code-block:: shell

    circup update

Usage Example

=============

.. code-block:: python

    import usb_midi

    import tmidi

    midi_usb = tmidi.MIDI(midi_in=usb_midi.ports[0], midi_out=usb_midi.ports[1])

    def send_midi_panic(channel=1):

        msg = tmidi.Message(tmidi.NOTE_OFF, channel-1)  # channels are 0-indexed

        for notenum in range(128):

            msg.note = notenum

            msg.velocity = 0

            midi_usb.send(msg)

            time.sleep(0.01)

    }

    send_midi_panic()

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.