Skip to main content

USB Firmware Flashing

Connect to the Host​

Core Connection Limitation

The Fly-D8 mainboard can only communicate with the host for Klipper via the Type-C USB interface.

Loading...

Firmware Compilation Quick Guide​

Important Notes​

  • Network: Ensure the host machine (Raspberry Pi, etc.) is connected to the network.
  • Login Method: Must log in via SSH over the network; serial port login is disabled.
  • 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 cannot be used.

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

Start Firmware Compilation​

The following describes how to compile the firmware:

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

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

  • Among these, rm -rf ~/klipper/.config && rm -rf ~/klipper/out deletes previous compilation data and firmware.

  • make menuconfig is for compiling the firmware. After execution, the following interface should appear:

    Loading...

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

    Loading...

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

    Loading...

  • Navigate to the Processor model menu, select STM32F407, and press Enter.

    Loading...

  • Select Bootloader offset, and choose: 32KiB bootloader.

    Loading...

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

    Loading...
  • Press the Q key. When Save configuration appears, press the Y key.
    Loading...
  • The configuration should now be saved, and you will exit back to the command line interface.
  • Enter the following command to start compilation. This will take some time.
make -j4
Loading...
  • If the following content is output at the end, the compilation is successful.
  • Due to Klipper version differences, as long as out/klipper.bin appears, it indicates success. 
    Linking out/klipper.elf
    Creating bin file out/klipper.bin

Enter Flashing Mode​

  • After connecting the mainboard to the host using a Type-C data cable, double-click the RST button. At this point, the LED on the mainboard will flash.
Warning
  • If the LED does not flash, please re-flash the katapult firmware: Flash Katapult Firmware
  • If the LED does not flash, after flashing the katapult firmware, proceed to the next step.
Loading...
  • Please ensure that the host machine can connect to the network normally and ensure that the data cable connecting the lower-level machine to the host machine has data transmission function.
  • After SSH connecting to the host machine, input lsusb and press Enter. If the information circled in the following picture appears, you can proceed to the next step.
    • If there is no feedback at all, this is a system problem of the host machine, and we are unable to help. You need to replace with a confirmed normal system or replace the host machine.
    • If the prompt says there is no lsusb command, you can execute the following command to install it: 
      sudo apt-get install usbutils
      Loading...
  • 1d50:6177 belongs to the device you will use this time.
    • Some host machines may not fully display or fail to display due to system problems.
    • If the lsusb command can display the device but does not show 1d50:6177, please try replacing the data cable and connecting the mainboard to another USB port on the host machine.
  • If you have executed the above steps before and successfully burned the Klipper firmware, and the mainboard is running normally, but you just want to update the Klipper firmware, please directly check the Firmware Update section in the right menu bar of this page.
Notice

You must query the 1d50:6177 device before proceeding to the next step.

Flash the Firmware​

Start Flashing​

  • Non-FLY official host computers need to install Katapult
  • Install Katapult

Get the Board ID​

Execute the following command to search for the device ID. Normally, 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 means 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 obtained in the previous step.
  • For regular host computers, use the code below: 
    ~/klippy-env/bin/python ~/katapult/scripts/flashtool.py -d <Your Board ID>
  • For FLY host computers, use the code below: 
    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/*
Key Points for Identification

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 ID obtained from the query.
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
Loading...