Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-usb-host-midi/badge/?version=latest
:target: https://docs.circuitpython.org/projects/usb-host-midi/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_USB_Host_MIDI/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_USB_Host_MIDI/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
CircuitPython USB host driver for MIDI devices
Dependencies
=============
This driver 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
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-usb-host-midi/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-usb-host-midi
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-usb-host-midi
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-usb-host-midi
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 adafruit_usb_host_midi
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
import adafruit_midi
import adafruit_usb_host_midi
print("Looking for midi device")
raw_midi = None
while raw_midi is None:
for device in usb.core.find(find_all=True):
try:
raw_midi = adafruit_usb_host_midi.MIDI(device)
print("Found", hex(device.idVendor), hex(device.idProduct))
except ValueError:
continue
midi_device = adafruit_midi.MIDI(midi_in=raw_midi, in_channel=0)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/usb-host-midi/en/latest/>`_.
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/adafruit/Adafruit_CircuitPython_USB_Host_MIDI/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-usb-host-midi",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, usb-host-midi, midi",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/ac/db/84f5c65bb98cb6de6c35cecce6c868f51ba833b86871849fca5bef515a82/adafruit_circuitpython_usb_host_midi-0.8.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-usb-host-midi/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/usb-host-midi/en/latest/\n :alt: Documentation Status\n\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_USB_Host_MIDI/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_USB_Host_MIDI/actions\n :alt: Build Status\n\n\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\nCircuitPython USB host driver for MIDI devices\n\n\nDependencies\n=============\nThis driver 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\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-usb-host-midi/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-usb-host-midi\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-usb-host-midi\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 .venv/bin/activate\n pip3 install adafruit-circuitpython-usb-host-midi\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 adafruit_usb_host_midi\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 adafruit_midi\n import adafruit_usb_host_midi\n\n print(\"Looking for midi device\")\n raw_midi = None\n while raw_midi is None:\n for device in usb.core.find(find_all=True):\n try:\n raw_midi = adafruit_usb_host_midi.MIDI(device)\n print(\"Found\", hex(device.idVendor), hex(device.idProduct))\n except ValueError:\n continue\n\n midi_device = adafruit_midi.MIDI(midi_in=raw_midi, in_channel=0)\n\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/usb-host-midi/en/latest/>`_.\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/adafruit/Adafruit_CircuitPython_USB_Host_MIDI/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython USB host driver for MIDI devices",
"version": "0.8.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_USB_Host_MIDI"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" usb-host-midi",
" midi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e61d16ca59f3343f174920088955808e2c69116a1b02004c5d6c45821cfdb990",
"md5": "2355a7fe74fc7cb8ad969524abf1094e",
"sha256": "491a7d51038600a1a47ed081340e54dded8aa16dd96e84eca8f179b4c781f7c2"
},
"downloads": -1,
"filename": "adafruit_circuitpython_usb_host_midi-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2355a7fe74fc7cb8ad969524abf1094e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5438,
"upload_time": "2024-10-21T18:08:17",
"upload_time_iso_8601": "2024-10-21T18:08:17.471527Z",
"url": "https://files.pythonhosted.org/packages/e6/1d/16ca59f3343f174920088955808e2c69116a1b02004c5d6c45821cfdb990/adafruit_circuitpython_usb_host_midi-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "acdb84f5c65bb98cb6de6c35cecce6c868f51ba833b86871849fca5bef515a82",
"md5": "19b959556072f0d375da168d0626b60d",
"sha256": "2ca74c1e43ff8f34ee34e56b00766a16f8668780576b692cd0b1b2c6bad7daa3"
},
"downloads": -1,
"filename": "adafruit_circuitpython_usb_host_midi-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "19b959556072f0d375da168d0626b60d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27472,
"upload_time": "2024-10-21T18:08:19",
"upload_time_iso_8601": "2024-10-21T18:08:19.571072Z",
"url": "https://files.pythonhosted.org/packages/ac/db/84f5c65bb98cb6de6c35cecce6c868f51ba833b86871849fca5bef515a82/adafruit_circuitpython_usb_host_midi-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-21 18:08:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_USB_Host_MIDI",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-usb-host-midi"
}
JSON
