Generate USB descriptors with Python!

USB descriptors are used by a USB device to describe its properties such as id, name, manufacturer, serial number and functionality. In CircuitPython, we used to rely on a bunch of C macros from the Advanced Software Framework from MicroChip to generate a descriptor for each board at compile time. C macros, however, aren’t a great tool for generating this because some descriptors reference others. (Specifically name, manufacturer and serial number are stored as indexes with matching string descriptors.) This makes maintaining descriptors a bit of a challenge. So, instead of continuing to use these C macros, we’ve switched to a small Python library we’ve created to generate the descriptor byte array instead.

With this new USB descriptor library for Python, one can use all of Python’s goodness to set up the descriptors as desired and then convert them to bytes. Once the descriptors are converted to bytes, normal Python file writing can be used to generate a file to hold them. Currently, we have a script that generates a C file.

Lastly, since the new library is Python and only uses the struct module, we hope to run the library on CircuitPython itself! That way we can change the descriptor dynamically on boot! We’ll be able to choose between HID, MIDI and other things dynamically.

To find out more about the Python USB Descriptor library check it out on GitHub and visit our Discord channel.


Have an amazing project to share? The Electronics Show and Tell is every Wednesday at 7:30pm ET! To join, head over to YouTube and check out the show’s live chat and our Discord!

Join us every Wednesday night at 8pm ET for Ask an Engineer!

Join over 38,000+ makers on Adafruit’s Discord channels and be part of the community! http://adafru.it/discord

CircuitPython – The easiest way to program microcontrollers – CircuitPython.org


New Products – Adafruit Industries – Makers, hackers, artists, designers and engineers! — New Products 11/15/2024 Featuring Adafruit bq25185 USB / DC / Solar Charger with 3.3V Buck Board! (Video)

Python for Microcontrollers – Adafruit Daily — Python on Microcontrollers Newsletter: A New Arduino MicroPython Package Manager, How-Tos and Much More! #CircuitPython #Python #micropython @ThePSF @Raspberry_Pi

EYE on NPI – Adafruit Daily — EYE on NPI Maxim’s Himalaya uSLIC Step-Down Power Module #EyeOnNPI @maximintegrated @digikey

Adafruit IoT Monthly — The 2024 Recap Issue!

Maker Business – Adafruit Daily — Apple to build another chip at TSMC Arizona

Electronics – Adafruit Daily — SMT Tip – Stop moving around!

Get the only spam-free daily newsletter about wearables, running a "maker business", electronic tips and more! Subscribe at AdafruitDaily.com !


No Comments

No comments yet.

Sorry, the comment form is closed at this time.