Skip to main content

USB Firmware Compilation

Firmware Compilation Notes and Operation Guide​

Important Notes​

📌 Important Prerequisites
  1. Network Connection: Ensure the host machine (Raspberry Pi, etc.) is connected to the network.
  2. Access Method: You must log in to the host machine via SSH over the network. Using serial port tools is prohibited.
  3. User Permissions: Use the correct user account for operations based on the host machine's system type.
  4. Input Method: Ensure the keyboard input method is set to Half-width mode (English mode).

SSH Login and User Switching​

SSH Login to Host Machine​

Use an SSH tool (such as MobaXterm, PuTTY, etc.) to log in to the host machine over the network: View Detailed SSH Connection Tutorial

Switch User Based on System Type​

Applicable Systems:

  • Official Raspberry Pi OS
  • Other systems with Klipper installed

User Permission Requirements:

  • Do not use the root user for any operations.
  • You must switch to a standard user for operations.

Switch Command:

  • Other systems (replace <username> with your username)

    su <username>
💡 Tip

Standard users typically have the necessary compilation permissions. Using the root user may cause permission issues.

Firmware Compilation Instructions​

1. Keyboard Operation Guide​

  • In the Klipper firmware configuration page, you can only use the following shortcut keys for operation.
  • You cannot use the mouse directly!
KeyFunction Description
↑ ↓ Arrow KeysMove the cursor up/down to select menu items.
Enter or SpaceConfirm selection/check menu items or enter submenus.
ESCReturn to the previous menu level.
QExit the Klipper firmware configuration page.
YPress Y to save the configuration if prompted when exiting.

Show Hidden Options​

⚠️ Show Hidden Options

If there are few options on the configuration page, first check:

[ ] Enable extra low-level configuration options

This option is used to display some hidden configuration options.

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 menu Micro-controller Architecture and select STMicroelectronics STM32, then press Enter.

    Loading...

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

    Loading...

  • Select Bootloader offset, choose: 32KiB bootloader.

    Loading...

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

    Loading...
  • Press the Q key, and Save configuration will appear. Then 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. It 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, as long as out/klipper.bin appears, it indicates success. 
    Linking out/klipper.elf
    Creating bin file out/klipper.bin

Firmware Flashing​

tip

Execute the following command to flash the firmware

fly-flash -d auto -h -f /data/klipper/out/klipper.bin
Loading...
Loading...

Searching for USB ID​

  1. Open your browser, enter the IP address of the host computer in the address bar. For example, if my host IP is 192.168.101.179, just type it and press Enter.
Loading...
  1. Open the host's WEB interface. In the left sidebar configuration options, find:
  • For fluidd: {…}, click to enter, then find printer.cfg
Loading...
  • For mainsail: Machine, click to enter, then find printer.cfg
Loading...
  1. Click printer.cfg to enter, then click DEVICES in the top right corner.
Loading...
Loading...
  1. Click SERIAL, then refresh.
  • Refreshing in fluidd
Loading...
  • Refreshing in mainsail
Loading...
  1. Copy the ID. Click where the arrow points to copy.
  • In fluidd, check if ttyAMC exists, and ensure Path by ID exists. This is the USB ID.
Loading...
  • In mainsail, check if ttyAMC exists, and ensure Path by ID exists. This is the USB ID.
Loading...

Filling in the USB ID​

dangerous

Please note, the ID below cannot be used!!!!

serial: /dev/serial/by-id/usb-1a86_USB_Serial-if00-port0
  1. Close DEVICES and fill in the ID.
Important Notes
  • In the configuration file, change:
[mcu] 
serial: /tmp/klipper_host_mcu

to:

[mcu host] 
serial: /tmp/klipper_host_mcu
  • Add:
[mcu]
serial: <Replace this with the ID you just queried>
  • Find [MCU] in fluidd
Loading...
  • Find [MCU] in mainsail
Loading...
  1. Fill the ID into the configuration.
tip
  • After filling in the ID, click SAVE & RESTART in the top right corner.
Loading...
Loading...
  1. If Klipper prompts ADC out of range, this is normal. Connect the heated bed and thermistor to the mainboard, configure the thermistor pins for the hotend and heated bed, then save and restart.
dangerous

Note: All IDs appearing in this document are examples. The actual ID for each mainboard is different. Please fill in the ID you actually obtained.

Loading...