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.


Adafruit publishes a wide range of writing and video content, including interviews and reporting on the maker market and the wider technology world. Our standards page is intended as a guide to best practices that Adafruit uses, as well as an outline of the ethical standards Adafruit aspires to. While Adafruit is not an independent journalistic institution, Adafruit strives to be a fair, informative, and positive voice within the community – check it out here: adafruit.com/editorialstandards

Join Adafruit on Mastodon

Adafruit is on Mastodon, join in! adafruit.com/mastodon

Stop breadboarding and soldering – start making immediately! Adafruit’s Circuit Playground is jam-packed with LEDs, sensors, buttons, alligator clip pads and more. Build projects with Circuit Playground in a few minutes with the drag-and-drop MakeCode programming site, learn computer science using the CS Discoveries class on code.org, jump into CircuitPython to learn Python and hardware together, TinyGO, or even use the Arduino IDE. Circuit Playground Express is the newest and best Circuit Playground board, with support for CircuitPython, MakeCode, and Arduino. It has a powerful processor, 10 NeoPixels, mini speaker, InfraRed receive and transmit, two buttons, a switch, 14 alligator clip pads, and lots of sensors: capacitive touch, IR proximity, temperature, light, motion and sound. A whole wide world of electronics and coding is waiting for you, and it fits in the palm of your hand.

Have an amazing project to share? The Electronics Show and Tell is every Wednesday at 7pm ET! To join, head over to YouTube and check out the show’s live chat – we’ll post the link there.

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

Join over 36,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


Maker Business — Making sure the CHIPS act isn’t just crumbs

Wearables — Our little secret to weather-proofing your projects

Electronics — Meaningful gains

Python for Microcontrollers — Python on Microcontrollers Newsletter: New Thonny and Git Versions, Plenty of Projects and More! #CircuitPython #Python #micropython @ThePSF @Raspberry_Pi

Adafruit IoT Monthly — Guardian Robot, Weather-wise Umbrella Stand, and more!

Microsoft MakeCode — MakeCode Thank You!

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

New Products – Adafruit Industries – Makers, hackers, artists, designers and engineers! — JP’s Product Pick of the Week 6/6/23 ADS1x15 16-bit and 12-bit ADC Breakouts @adafruit @johnedgarpark #adafruit #newproductpick

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.