Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-usb-host-descriptors/badge/?version=latest
:target: https://docs.circuitpython.org/projects/usb-host-descriptors/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_Descriptors/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_USB_Host_Descriptors/actions
:alt: Build Status
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Code Style: Ruff
Helpers for getting USB descriptors
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython 9+ <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-descriptors/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-usb-host-descriptors
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-usb-host-descriptors
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 adafruit-circuitpython-usb-host-descriptors
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_descriptors
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
Print basic information about a device and its first (and usually only) configuration.
.. code-block:: python
# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
# SPDX-FileCopyrightText: Copyright (c) 2023 Scott Shawcroft for Adafruit Industries
#
# SPDX-License-Identifier: Unlicense
import time
import usb.core
import adafruit_usb_host_descriptors
DIR_IN = 0x80
while True:
print("searching for devices")
for device in usb.core.find(find_all=True):
print("pid", hex(device.idProduct))
print("vid", hex(device.idVendor))
print("man", device.manufacturer)
print("product", device.product)
print("serial", device.serial_number)
print("config[0]:")
config_descriptor = adafruit_usb_host_descriptors.get_configuration_descriptor(
device, 0
)
i = 0
while i < len(config_descriptor):
descriptor_len = config_descriptor[i]
descriptor_type = config_descriptor[i + 1]
if descriptor_type == adafruit_usb_host_descriptors.DESC_CONFIGURATION:
config_value = config_descriptor[i + 5]
print(f" value {config_value:d}")
elif descriptor_type == adafruit_usb_host_descriptors.DESC_INTERFACE:
interface_number = config_descriptor[i + 2]
interface_class = config_descriptor[i + 5]
interface_subclass = config_descriptor[i + 6]
print(f" interface[{interface_number:d}]")
print(
f" class {interface_class:02x} subclass {interface_subclass:02x}"
)
elif descriptor_type == adafruit_usb_host_descriptors.DESC_ENDPOINT:
endpoint_address = config_descriptor[i + 2]
if endpoint_address & DIR_IN:
print(f" IN {endpoint_address:02x}")
else:
print(f" OUT {endpoint_address:02x}")
i += descriptor_len
print()
time.sleep(5)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/usb-host-descriptors/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_Descriptors/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-descriptors",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, usb-host-descriptors, usb",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/24/f9/88a6dbc005cfbfa2d0c22f8bc758f0d59d37139b25f6cd5b6e965fa2cffa/adafruit_circuitpython_usb_host_descriptors-0.3.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-usb-host-descriptors/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/usb-host-descriptors/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_Descriptors/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_USB_Host_Descriptors/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Code Style: Ruff\n\nHelpers for getting USB descriptors\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython 9+ <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\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-descriptors/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-usb-host-descriptors\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-descriptors\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 adafruit-circuitpython-usb-host-descriptors\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_descriptors\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\nPrint basic information about a device and its first (and usually only) configuration.\n\n.. code-block:: python\n\n # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries\n # SPDX-FileCopyrightText: Copyright (c) 2023 Scott Shawcroft for Adafruit Industries\n #\n # SPDX-License-Identifier: Unlicense\n\n import time\n import usb.core\n\n import adafruit_usb_host_descriptors\n\n DIR_IN = 0x80\n\n while True:\n print(\"searching for devices\")\n for device in usb.core.find(find_all=True):\n print(\"pid\", hex(device.idProduct))\n print(\"vid\", hex(device.idVendor))\n print(\"man\", device.manufacturer)\n print(\"product\", device.product)\n print(\"serial\", device.serial_number)\n print(\"config[0]:\")\n config_descriptor = adafruit_usb_host_descriptors.get_configuration_descriptor(\n device, 0\n )\n\n i = 0\n while i < len(config_descriptor):\n descriptor_len = config_descriptor[i]\n descriptor_type = config_descriptor[i + 1]\n if descriptor_type == adafruit_usb_host_descriptors.DESC_CONFIGURATION:\n config_value = config_descriptor[i + 5]\n print(f\" value {config_value:d}\")\n elif descriptor_type == adafruit_usb_host_descriptors.DESC_INTERFACE:\n interface_number = config_descriptor[i + 2]\n interface_class = config_descriptor[i + 5]\n interface_subclass = config_descriptor[i + 6]\n print(f\" interface[{interface_number:d}]\")\n print(\n f\" class {interface_class:02x} subclass {interface_subclass:02x}\"\n )\n elif descriptor_type == adafruit_usb_host_descriptors.DESC_ENDPOINT:\n endpoint_address = config_descriptor[i + 2]\n if endpoint_address & DIR_IN:\n print(f\" IN {endpoint_address:02x}\")\n else:\n print(f\" OUT {endpoint_address:02x}\")\n i += descriptor_len\n print()\n time.sleep(5)\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/usb-host-descriptors/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_Descriptors/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Helpers for getting USB descriptors",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_USB_Host_Descriptors"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" usb-host-descriptors",
" usb"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "273a7da4f8aced158ebca069039ba5b49ae575dff9fc62fa548ed8c3a16c9f1a",
"md5": "a829612701a9ca14a7eb25b7520490e6",
"sha256": "7c61d1e6baee16a1b5e0592c852b7c26bd13cd716dc90927f11fc8d1848c57d1"
},
"downloads": -1,
"filename": "adafruit_circuitpython_usb_host_descriptors-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a829612701a9ca14a7eb25b7520490e6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5793,
"upload_time": "2025-04-24T23:39:25",
"upload_time_iso_8601": "2025-04-24T23:39:25.236530Z",
"url": "https://files.pythonhosted.org/packages/27/3a/7da4f8aced158ebca069039ba5b49ae575dff9fc62fa548ed8c3a16c9f1a/adafruit_circuitpython_usb_host_descriptors-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "24f988a6dbc005cfbfa2d0c22f8bc758f0d59d37139b25f6cd5b6e965fa2cffa",
"md5": "e7f763b8c1dd365c30201cb2521809a0",
"sha256": "f5c69286f5bd46503217a09cf16d98b43c100e63a5c723e5e3b26265ad3b7d20"
},
"downloads": -1,
"filename": "adafruit_circuitpython_usb_host_descriptors-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "e7f763b8c1dd365c30201cb2521809a0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26230,
"upload_time": "2025-04-24T23:39:26",
"upload_time_iso_8601": "2025-04-24T23:39:26.529476Z",
"url": "https://files.pythonhosted.org/packages/24/f9/88a6dbc005cfbfa2d0c22f8bc758f0d59d37139b25f6cd5b6e965fa2cffa/adafruit_circuitpython_usb_host_descriptors-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-04-24 23:39:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_USB_Host_Descriptors",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
}
],
"lcname": "adafruit-circuitpython-usb-host-descriptors"
}
JSON
