dfu-util.md

Flashing an STM32 board with dfu-util

MKS Rumba 32 boards, and other STM32 boards with DFU mode, can be flashed with dfu-util.

Table of Contents

1. Dfu-util Installation
   1. Linux (including Raspberry Pi)
   2. Sudo rights
      1. Configure Sudo
2. Bossac Configuration
   1. Required Settings
   2. Optional Settings

Dfu-util Installation

To flash a STM32-based DFU-mode board the tool dfu-util needs to be installed on the OctoPrint host.

Linux (includng Raspberry Pi)

Dfu-util can be installed on most systems using the package manager

sudo apt update
sudo apt install dfu-util

Locate the dfu-util binary using which:

pi@octopi:~ $ which dfu-util
/usr/bin/dfu-util
pi@octopi:~ $

Sudo rights

The plugin needs to be able to run the dfu-util utility with root privileges. You must be able to run sudo dfu-util at the command line without being prompted for a password.

If your system is configured to allow pi to run all sudo commands without a password (the default) then you do not need to do anything further.

Configure Sudo

If you need to enter a password when running sudo commands as pi you will need to create a new sudoers entry in order for the plugin to work correctly.

1. Run this command in an SSH prompt on your OctoPrint host to create a new sudo rule file:

   sudo nano /etc/sudoers.d/020_firmware_updater

2. Paste this line into the new file:

   pi ALL=NOPASSWD: /usr/bin/dfu-util

3. Save and close the file

Dfu-util Configuration

Required Settings

The only required setting is the path to the dfu-util binary.

Optional Settings

Option	Description
Flash command line	The command used to flash the firmware to the board.