Skip to main content

USB Firmware Flashing

Start Flashing​

Firmware Compilation Quick Guide​

Notes​

  • Network: Ensure the host machine (Raspberry Pi, etc.) is connected to the network.
  • Login Method: Must use SSH to log in via the network; disable serial port.
  • Input Method: Keep the keyboard in English half-width mode.

SSH Login and User Switching​

Use tools like MobaXterm, PuTTY, etc., to SSH into the host machine.

Switching Users:​

  • Standard Systems (Raspberry Pi official system, etc.)
    Do not use root. Switch to a regular user: 
    su <username>
  • FLY Host Machine (FlyOS-FAST system)
    Only supports logging in as the root user (password: mellow).

Firmware Compilation Operation Guide​

In the Klipper firmware configuration interface, only keyboard operations are supported; mouse usage is not possible.

KeyFunction
↑ / ↓Move the cursor up/down to select menu items
Enter / SpaceConfirm selection, toggle options, or enter submenus
ESCReturn to the previous menu
QExit the configuration interface
YWhen exiting, press Y if prompted to save the configuration

Below is an introduction on how to compile the firmware:

  • After connecting via SSH, enter the following command and press the Enter key:

    cd ~/klipper && rm -rf ~/klipper/.config && rm -rf ~/klipper/out && make menuconfig

  • Here, rm -rf ~/klipper/.config && rm -rf ~/klipper/out deletes the previous compilation data and firmware, while make menuconfig compiles the firmware. After execution, the following interface should appear:

    Loading...

  • Select Enable extra low-level configuration options and press the Enter key.

    Loading...

  • Navigate to the Micro-controller Architecture menu, then select STMicroelectronics STM32 and press the Enter key.

    Loading...

  • Go to the Processor model menu and select STM32H723, then press Enter.

    Loading...

  • Select Bootloader offset and choose: 128KiB bootloader.

    Loading...

  • Select Clock Reference (8 MHz crystal) and choose: 25 MHz crystal.

    Loading...

  • For Communication interface, select: USB (on PA11/PA12).

    Loading...
  • Select GPIO pins to set at microcontroller startup, input: !PA15 Please note that ! is uppercase
    Loading...
  • Press the Q key. When Save configuration appears, press the Y key.
    Loading...
  • The configuration should now be saved, and you will return to the command line interface.
  • Enter the following command to start the compilation. This process may take some time.
make -j4
Loading...
  • If the following content is output at the end, the compilation is successful.
  • Due to Klipper version differences, the appearance of out/klipper.bin alone indicates success. 
    Linking out/klipper.elf
    Creating bin file out/klipper.bin

Confirm Entry into Flashing Mode​

  • After connecting the tool board to the host computer using a USB cable, the LED on the main board will blink.
Warning
  • If the LED does not blink, please re-flash the Katapult firmware: Flash Katapult Firmware
  • If the LED does not blink, after flashing the Katapult firmware, proceed to the next step.

Flash the Firmware​

Start Flashing​

  • Non-FLY official host computers require Katapult installation
  • Install Katapult

Get the Board ID​

Execute the following command to search for the device ID. Under normal circumstances, an ID similar to the one shown in the image below should be displayed (Note: Each board has a different ID):

ls /dev/serial/by-id/*

If the searched ID contains usb-katapult_stm32xxxxxxxx, it indicates you can proceed to the next step.

Loading...

Flash the Firmware​

⚠️ Preparations
  • Ensure the firmware file has been compiled.
  • Replace <Your Board ID> in the commands below with the actual ID queried in the previous step.
  • For regular host computers, use the following code: 
    ~/klippy-env/bin/python ~/katapult/scripts/flashtool.py -d <Your Board ID>
  • For FLY host computers, use the following code: 
    python3 ~/katapult/scripts/flashtool.py -d <Your Board ID>

Flashing Process Reference:

Loading...

Successful Flashing Reference:

Loading...

Firmware Update​

USB Firmware Update Steps​

  1. Query the Board ID
ls /dev/serial/by-id/*
Identification Key

In the image below, /dev/serial/by-id/usb-katapult_rp2040_E662549553642032-if00 is the board ID.

Loading...
  1. Update the Firmware
cd ~/klipper/ && make flash FLASH_DEVICE=<Your Board ID>
Note
  • Replace <Your Board ID> with the actual queried ID.
Loading...

Solutions for Flashing the Wrong Firmware​

Method 1: Quickly Enter Flashing Mode​

  1. Power off the board.
  2. After powering on again, quickly double-click the RESET button.
  3. Re-enter flashing mode.

Method 2: Re-flash the Katapult Firmware​

Click to View Katapult Firmware Flashing Guide

Confirm Firmware Startup​

  • If the firmware starts normally, the LED will light up.
    Loading...
Loading...