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 <https://github.com/adafruit/circuitpython>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/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 <https://pypi.org/project/circuitpython-tmidi/>`_.
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 <https://circuitpython-tmidi.readthedocs.io/>`_.
For information on building library documentation, please check out
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/todbot/CircuitPython_TMIDI/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "circuitpython-tmidi",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, tmidi, midi",
"author": null,
"author_email": "Tod Kurt <tod@todbot.com>",
"download_url": "https://files.pythonhosted.org/packages/74/ce/c900228c6e37922e8afb8ea7faa0629f1d3e2ff9d6a6a63138ca732c92d8/circuitpython_tmidi-1.0.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/circuitpython-tmidi/badge/?version=latest\n :target: https://circuitpython-tmidi.readthedocs.io/\n :alt: Documentation Status\n.. image:: https://img.shields.io/discord/327254708534116352.svg\n :target: https://adafru.it/discord\n :alt: Discord\n.. image:: https://github.com/todbot/CircuitPython_TMIDI/workflows/Build%20CI/badge.svg\n :target: https://github.com/todbot/CircuitPython_TMIDI/actions\n :alt: Build Status\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nMIDI library for CircuitPython\n\n\nDependencies\n=============\nThis library depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\nInstalling from PyPI\n=====================\n.. note:: This library is not available on PyPI yet. Install documentation is included\n as a standard element. Stay tuned for PyPI availability!\n\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/circuitpython-tmidi/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install circuitpython-tmidi\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install circuitpython-tmidi\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .env/bin/activate\n pip3 install circuitpython-tmidi\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install tmidi\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import usb_midi\n import tmidi\n\n midi_usb = tmidi.MIDI(midi_in=usb_midi.ports[0], midi_out=usb_midi.ports[1])\n\n def send_midi_panic(channel=1):\n msg = tmidi.Message(tmidi.NOTE_OFF, channel-1) # channels are 0-indexed\n for notenum in range(128):\n msg.note = notenum\n msg.velocity = 0\n midi_usb.send(msg)\n time.sleep(0.01)\n }\n\n send_midi_panic()\n\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://circuitpython-tmidi.readthedocs.io/>`_.\n\nFor information on building library documentation, please check out\n`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/todbot/CircuitPython_TMIDI/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "MIDI library for CircuitPython",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/todbot/CircuitPython_TMIDI"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" tmidi",
" midi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2f1d540d6ecd5e83d4d090e7365e9b3559dba572fb4d833e864115875d7f5a5e",
"md5": "67a9c1b58487bfd3243599721ad9bdea",
"sha256": "9b2bfcddae337637910f3b12609b154b34280fd3fcff4b890449a54fccb79097"
},
"downloads": -1,
"filename": "circuitpython_tmidi-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "67a9c1b58487bfd3243599721ad9bdea",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7513,
"upload_time": "2024-09-18T20:48:23",
"upload_time_iso_8601": "2024-09-18T20:48:23.135642Z",
"url": "https://files.pythonhosted.org/packages/2f/1d/540d6ecd5e83d4d090e7365e9b3559dba572fb4d833e864115875d7f5a5e/circuitpython_tmidi-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "74cec900228c6e37922e8afb8ea7faa0629f1d3e2ff9d6a6a63138ca732c92d8",
"md5": "428d936559f47236df400b2e1550ec0a",
"sha256": "b20b8218e1b2dc49d2ea98b63885da7e29e23e588466a56a9ea64f49283511b1"
},
"downloads": -1,
"filename": "circuitpython_tmidi-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "428d936559f47236df400b2e1550ec0a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30477,
"upload_time": "2024-09-18T20:48:24",
"upload_time_iso_8601": "2024-09-18T20:48:24.697344Z",
"url": "https://files.pythonhosted.org/packages/74/ce/c900228c6e37922e8afb8ea7faa0629f1d3e2ff9d6a6a63138ca732c92d8/circuitpython_tmidi-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-18 20:48:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "todbot",
"github_project": "CircuitPython_TMIDI",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
}
],
"lcname": "circuitpython-tmidi"
}
JSON
