A small library for firmware updates over USB with devices that support the DFU and DfuSe protocols. Specifically, pyfu-usb supports listing DFU capable devices and downloading binary files to them.
Compared to dfu-util
dfu-util is the popular host side tool for interacting with DFU/DfuSe devices. pyfu-usb has only a small sliver the functionality contained in dfu-util: Listing and downloading binary files. The reason you would use pyfu-usb over dfu-util is if you have a Python project that needs firmware update capabilities and don't want an external (non-Python) dependency.
Compared to pydfu.py
pydfu.py is a tool in the OpenMV project that solves the exact problem described above, but it is only for DfuSe devices (e.g. STM32) and also hard codes a number of parameters including device address and max transfer size. It also appears to only work with .dfu files, which require an extra conversion step. Since binary files can be directly generated by many embedded toolchains using them is simpler, although less portable.
The code in this package originates from pydfu.py and the OpenMV license agreement has been copied into the repository. Along with refactoring the code and adding support for "classic" DFU devices, several modernizations were added:
- Colored logs and progress bar with
rich - Using
logginginstead ofprintfor output messages - Consistent style with
blackand linting withpylint
Even though this package may appear pure Python, by relying on pyusb we rely on libusb being installed. See the pyusb docs for more details on platform support.
Install with pip:
pip install pyfu-usbList connected DFU devices:
pyfu-usb --listDownload a file to a DfuSe capable device, specifying a start address in hex:
pyfu-usb --download <filename> -a <start_address>Download a file to a DFU capable device:
pyfu-usb --download <filename>Use the --device argument to specify the vid:pid of the device in hex if multiple are connected. See the examples directory for more detailed examples.
The Makefile contains workflow helpers for the development environment.
To setup the virtual environment:
make setupTo activate the virtual environment:
source .venv/bin/activateTo run pre-commit hooks (style, linting):
make pre_commitTo run unit tests:
make testTo build the wheel:
make wheelTo view code coverage metrics:
make coverageTo delete generated files:
make cleanPlease see the documentation prior to contributing.
Licensed under the MIT license.