blob: 83b7e8b55ae91b767724cda9f1171e7f34e9f86b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
|
Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-usb-descriptor/badge/?version=latest
:target: http://adafruit-usb-descriptor.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image :: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
The `adafruit_usb_descriptor` library provides Python classes that make it
easier to generate a binary USB descriptor. It can be used in place of a series
of C macros.
Dependencies
=============
This library has no external dependencies. It only uses Python `struct`.
Usage Example
=============
A current usage example that generates descriptors for use with [TinyUSB](https://github.com/hathach/tinyusb) can be found `here <https://github.com/adafruit/circuitpython/blob/master/tools/gen_usb_descriptor.py>`_ in CircuitPython.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/usb_descriptor/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
API Reference
=============
.. toctree::
:maxdepth: 2
api
|
