- PyDFUUtil provides for easy access to the devices that supports DFU interface over host machine's Universal Serial Bus (USB) system for Python 3.
- PyDFUUtil is an open realisation of original dfu-util and thin wrapper over libusb (uses PyUsb library as a backend).
Warning
The current status of the project is BETA version. Use it for your own risk
Important
Current version implements but not tested with real dfuse devices!
Tip
Searching for contributors for testing the library
- Since PyDFUUtil uses the libusb library it has similar dependencies for using libusb
- PyDFUUtil primarily tested on Linux and Windows, but also can work on each platform where PyUsb library are available, including MacOS
PyDFUUtil is generally installed through pip
# the latest official release
python -m pip install pydfuutil
# install a specific version (e.g. 0.0.1b1)
python -m pip install pydfuutil==0.0.1b1
pydfuutil -h
# or
python -m pydfuutil -h
####### usage:
usage: pydfuutil [-h] [-V] [-v] [-l] [-e] [-E <seconds>]
[-d <vid>:<pid>[,<vid_dfu>:<pid_dfu>]] [-n <dnum>] [-p <bus-port. ... .port>]
[-c <config_nr>] [-i <intf_nr>] [-S <serial_str>[,<serial_str_dfu>]]
[-a <alt>] [-t <size>] [-U <file>] [-Z <bytes>] [-D <file>] [-R] [-w]
[-s <address><:...>]
Python implementation of DFU-Util tools
options:
-h, --help show this help message and exit
-V, --version Print the version number
-v, --verbose Print verbose debug statements
-l, --list List the currently attached DFU capable USB devices
-e, --detach Detach the currently attached DFU capable USB devices
-E <seconds>, --detach-delay <seconds>
Time to wait before reopening a device after detach
-d <vid>:<pid>[,<vid_dfu>:<pid_dfu>], --device <vid>:<pid>[,<vid_dfu>:<pid_dfu>]
Specify Vendor/Product ID(s) of DFU device
-n <dnum>, --devnum <dnum>
Match given device number (devnum from --list)
-p <bus-port. ... .port>, --path <bus-port. ... .port>
Specify path to DFU device
-c <config_nr>, --cfg <config_nr>
Specify the Configuration of DFU device
-i <intf_nr>, --intf <intf_nr>
Specify the DFU Interface number
-S <serial_str>[,<serial_str_dfu>], --serial <serial_str>[,<serial_str_dfu>]
Specify Serial String of DFU device
-a <alt>, --alt <alt>
Specify the Altsetting of the DFU Interface
-t <size>, --transfer-size <size>
Specify the number of bytes per USB Transfer
-U <file>, --upload <file>
Read firmware from device into <file>
-Z <bytes>, --upload-size <bytes>
Read firmware from device into <file>
-D <file>, --download <file>
Read firmware from device into <file>
-R, --reset Issue USB Reset signalling once we`re finished
-w, --wait Wait for device to appear
-s <address><:...>, --dfuse-address <address><:...>
ST DfuSe mode string, specifying target
address for raw file download or upload
(not applicable for DfuSe file (.dfu) downloads).
Add more DfuSe options separated with ':'
leave
Leave DFU mode (jump to application)
mass-erase
Erase the whole device (requires "force")
unprotect
Erase read protected device (requires "force")
will-reset
Expect device to reset (e.g. option bytes write)
force
You really know what you are doing!
<length>
Length of firmware to upload from devicepydfuutil-suffix -h
# or
python -m pydfuutil.suffix -h
####### usage:
usage: dfu-suffix [-h] [-V] (-c | -a | -D) [-p <productID>] [-v <vendorID>] [-d <deviceID>] [-s <address>] [-T] <file>
positional arguments:
<file> Target filename
options:
-h, --help Print this help message
-V, --version Print the version number
-c, --check Check DFU suffix of <file>
-a, --add Add DFU suffix to <file>
-D, --delete Delete DFU suffix from <file>
-p <productID>, --pid <productID>
Add product ID into DFU suffix in <file>
-v <vendorID>, --vid <vendorID>
Add vendor ID into DFU suffix in <file>
-d <deviceID>, --did <deviceID>
Add device ID into DFU suffix in <file>
-s <address>, --stellaris-address <address>
Specify lmdfu address for LMDFU_ADD
-T, --stellaris Set lmdfu mode to LMDFU_CHECKpydfuutil-prefix -h
# or
python -m pydfuutil.prefix -h
####### usage:
usage: pydfuutil-prefix [-h] [-V] (-c | -D | -a) [-s <address>] [-T]
[-L]
<file>
positional arguments:
<file> Target filename
options:
-h, --help show this help message and exit
-V, --version Print the version number
-c, --check Check DFU suffix of <file>
-D, --delete Delete DFU suffix from <file>
-a, --add Add DFU suffix to <file>
In combination with -a:
-s <address>, --stellaris-address <address>
Add TI Stellaris address prefix to <file>
In combination with -a or -D or -c:
-T, --stellaris Act on TI Stellaris address prefix of <file>
In combination with -a or -D or -c:
-L, --lpc-prefix Use NXP LPC DFU prefix formatpydfuutil-lsusb -h
# or
python -m pydfuutil.lsusb -h
####### usage:
usage: pydfuutil-prefix [-v] [-s [[bus]:][devnum]]
[-d vendor:[product]] [-D device] [-t] [-V]
[-h]
options:
-v, --verbose Increase verbosity (show descriptors)
-s [[bus]:][devnum] Show only devices with specified device and/or
bus numbers (in decimal)
-d vendor:[product] Show only devices with the specified vendor
and product ID numbers (in hexadecimal)
-D device Selects which device lsusb will examine by
UNIX-like path simulate
-t, --tree Simulate UNIX-like physical USB device
hierarchy
-V, --version Print the version number
-h, --help Show this help message and exit- dfu
- dfu_file
- dfu_load
- portable
- quirks
- suffix
- usb_dfu
- lmdfu
- dfuse_mem
- dfuse
- dfu-util
- Update sources to latest original version "dfu-util-0.11"
- To report a bug or propose a new feature, use our issue tracker. But please search the database before opening a new issue.
Dfu-util - Device Firmware Upgrade Utilities
Dfu-util is the host side implementation of the DFU 1.0 and DFU 1.1 specification of the USB forum.
DFU is intended to download and upload firmware to devices connected over USB. It ranges from small devices like micro-controller boards up to mobile phones. With dfu-util you are able to download firmware to your device or upload firmware from it.
dfu-util has been tested with Openmoko Neo1973 and Freerunner and many other devices.
Important
THE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
- On systems that still default to Python 2, replace python with python3
- Project is in develop, it fulls issues not according to original dfu-util!